improve(sitemap.xml): add a list of countries to make them indexable by search engines

Part of #1605

Author: php-coder

src/main/java/ru/mystamps/web/feature/country/ApiCountryService.java

@@ -24,6 +24,7 @@
 import org.springframework.http.ResponseEntity;
 import org.springframework.web.client.RestTemplate;
 import ru.mystamps.web.common.LinkEntityDto;
+import ru.mystamps.web.common.SitemapInfoDto;
 
 import java.util.Date;
 import java.util.List;
@@ -72,6 +73,11 @@ public List<LinkEntityDto> findAllAsLinkEntities(String lang) {
 		throw new UnsupportedOperationException();
 	}
 
+	@Override
+	public List<SitemapInfoDto> findAllForSitemap() {
+		throw new UnsupportedOperationException();
+	}
+	
 	@Override
 	public LinkEntityDto findOneAsLinkEntity(String slug, String lang) {
 		throw new UnsupportedOperationException();

src/main/java/ru/mystamps/web/feature/country/CountryDao.java

@@ -18,6 +18,7 @@
 package ru.mystamps.web.feature.country;
 
 import ru.mystamps.web.common.LinkEntityDto;
+import ru.mystamps.web.common.SitemapInfoDto;
 
 import java.util.Date;
 import java.util.List;
@@ -37,6 +38,7 @@ public interface CountryDao {
 	List<Integer> findIdsByNames(List<String> names);
 	List<Integer> findIdsByNamePattern(String pattern);
 	List<LinkEntityDto> findAllAsLinkEntities(String lang);
+	List<SitemapInfoDto> findAllForSitemap();
 	LinkEntityDto findOneAsLinkEntity(String slug, String lang);
 	String findCountryOfLastCreatedSeriesByUser(Integer userId);
 	String findPopularCountryInCollection(Integer userId);

src/main/java/ru/mystamps/web/feature/country/CountryService.java

@@ -18,6 +18,7 @@
 package ru.mystamps.web.feature.country;
 
 import ru.mystamps.web.common.LinkEntityDto;
+import ru.mystamps.web.common.SitemapInfoDto;
 
 import java.util.Date;
 import java.util.List;
@@ -29,7 +30,9 @@ public interface CountryService {
 	List<Integer> findIdsByNames(List<String> names);
 	List<Integer> findIdsWhenNameStartsWith(String name);
 	List<LinkEntityDto> findAllAsLinkEntities(String lang);
+	List<SitemapInfoDto> findAllForSitemap();
 	LinkEntityDto findOneAsLinkEntity(String slug, String lang);
+
 	long countAll();
 	long countCountriesOf(Integer collectionId);
 	long countBySlug(String slug);

src/main/java/ru/mystamps/web/feature/country/CountryServiceImpl.java

@@ -25,6 +25,7 @@
 import org.springframework.transaction.annotation.Transactional;
 import ru.mystamps.web.common.LinkEntityDto;
 import ru.mystamps.web.common.LocaleUtils;
+import ru.mystamps.web.common.SitemapInfoDto;
 import ru.mystamps.web.common.SlugUtils;
 import ru.mystamps.web.support.spring.security.HasAuthority;
 
@@ -116,6 +117,13 @@ public List<LinkEntityDto> findAllAsLinkEntities(String lang) {
 		return countryDao.findAllAsLinkEntities(lang);
 	}
 
+	// @todo #1605 CountryService.findAllForSitemap(): add unit test
+	@Override
+	@Transactional(readOnly = true)
+	public List<SitemapInfoDto> findAllForSitemap() {
+		return countryDao.findAllForSitemap();
+	}
+	
 	@Override
 	@Transactional(readOnly = true)
 	public LinkEntityDto findOneAsLinkEntity(String slug, String lang) {

src/main/java/ru/mystamps/web/feature/country/JdbcCountryDao.java

@@ -28,6 +28,7 @@
 import ru.mystamps.web.common.JdbcUtils;
 import ru.mystamps.web.common.LinkEntityDto;
 import ru.mystamps.web.common.RowMappers;
+import ru.mystamps.web.common.SitemapInfoDto;
 import ru.mystamps.web.support.spring.jdbc.MapStringIntegerResultSetExtractor;
 
 import java.util.Collections;
@@ -55,6 +56,7 @@ public class JdbcCountryDao implements CountryDao {
 	private final String findIdsByNamesSql;
 	private final String findIdsByNamePatternSql;
 	private final String findCountriesNamesWithSlugSql;
+	private final String findAllForSitemapSql;
 	private final String findCountryLinkEntityBySlugSql;
 	@SuppressWarnings("PMD.LongVariable")
 	private final String findFromLastCreatedSeriesByUserSql;
@@ -78,6 +80,7 @@ public JdbcCountryDao(Environment env, NamedParameterJdbcTemplate jdbcTemplate)
 		this.findIdsByNamesSql                  = env.getRequiredProperty("country.find_ids_by_names");
 		this.findIdsByNamePatternSql            = env.getRequiredProperty("country.find_ids_by_name_pattern");
 		this.findCountriesNamesWithSlugSql      = env.getRequiredProperty("country.find_all_countries_names_with_slug");
+		this.findAllForSitemapSql               = env.getRequiredProperty("country.find_all_for_sitemap");
 		this.findCountryLinkEntityBySlugSql     = env.getRequiredProperty("country.find_country_link_info_by_slug");
 		this.findFromLastCreatedSeriesByUserSql = env.getRequiredProperty("country.find_from_last_created_series_by_user");
 		this.findPopularCountryInCollectionSql  = env.getRequiredProperty("country.find_popular_country_from_user_collection");
@@ -212,6 +215,15 @@ public List<LinkEntityDto> findAllAsLinkEntities(String lang) {
 		);
 	}
 
+	@Override
+	public List<SitemapInfoDto> findAllForSitemap() {
+		return jdbcTemplate.query(
+			findAllForSitemapSql,
+			Collections.emptyMap(),
+			RowMappers::forSitemapInfoDto
+		);
+	}
+
 	@Override
 	public LinkEntityDto findOneAsLinkEntity(String slug, String lang) {
 		Map<String, Object> params = new HashMap<>();

src/main/java/ru/mystamps/web/feature/country/TogglzWithFallbackCountryService.java

@@ -21,6 +21,7 @@
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 import ru.mystamps.web.common.LinkEntityDto;
+import ru.mystamps.web.common.SitemapInfoDto;
 import ru.mystamps.web.support.togglz.Features;
 
 import java.util.Date;
@@ -79,6 +80,14 @@ public List<LinkEntityDto> findAllAsLinkEntities(String lang) {
 		);
 	}
 
+	@Override
+	public List<SitemapInfoDto> findAllForSitemap() {
+		return executeOneOf(
+			apiService::findAllForSitemap,
+			fallbackService::findAllForSitemap
+		);
+	}
+	
 	@Override
 	public LinkEntityDto findOneAsLinkEntity(String slug, String lang) {
 		return executeOneOf(

src/main/java/ru/mystamps/web/feature/site/SiteConfig.java

@@ -84,6 +84,7 @@ public SitemapController sitemapController() {
 			return new SitemapController(
 				categoryService,
 				collectionService,
+				countryService,
 				seriesService
 			);
 		}

src/main/java/ru/mystamps/web/feature/site/SitemapController.java

@@ -27,6 +27,7 @@
 import ru.mystamps.web.feature.category.CategoryService;
 import ru.mystamps.web.feature.collection.CollectionService;
 import ru.mystamps.web.feature.collection.CollectionUrl;
+import ru.mystamps.web.feature.country.CountryService;
 import ru.mystamps.web.feature.series.SeriesService;
 import ru.mystamps.web.feature.series.SeriesUrl;
 
@@ -53,6 +54,7 @@ public class SitemapController {
 
 	private final CategoryService categoryService;
 	private final CollectionService collectionService;
+	private final CountryService countryService;
 	private final SeriesService seriesService;
 
 	@GetMapping(SiteUrl.SITEMAP_XML)
@@ -85,6 +87,11 @@ public void generateSitemapXml(HttpServletResponse response) {
 				// CheckStyle: ignore LineLength for next 1 line
 				writer.print(createUrlEntry(dateFormatter, item, SeriesUrl.INFO_CATEGORY_PAGE, "{slug}"));
 			}
+
+			for (SitemapInfoDto item : countryService.findAllForSitemap()) {
+				// CheckStyle: ignore LineLength for next 1 line
+				writer.print(createUrlEntry(dateFormatter, item, SeriesUrl.INFO_COUNTRY_PAGE, "{slug}"));
+			}
 
 			writer.print("</urlset>\n");
 		} catch (IOException ex) {

src/main/resources/sql/country_dao_queries.properties

@@ -90,6 +90,12 @@ country.find_all_countries_names_with_slug = \
     FROM countries c \
 ORDER BY CASE WHEN 'ru' = :lang THEN COALESCE(c.name_ru, c.name) ELSE c.name END
 
+country.find_all_for_sitemap = \
+  SELECT slug AS id \
+       , updated_at \
+    FROM countries \
+ORDER BY updated_at DESC
+
 country.find_country_link_info_by_slug = \
   SELECT CASE WHEN 'ru' = :lang THEN COALESCE(c.name_ru, c.name) ELSE c.name END AS name \
      , c.slug \