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

Part of #1605

Author: php-coder

src/main/java/ru/mystamps/web/feature/category/ApiCategoryService.java

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

src/main/java/ru/mystamps/web/feature/category/CategoryDao.java

@@ -19,6 +19,7 @@
 
 import ru.mystamps.web.common.EntityWithParentDto;
 import ru.mystamps.web.common.LinkEntityDto;
+import ru.mystamps.web.common.SitemapInfoDto;
 
 import java.util.Date;
 import java.util.List;
@@ -38,6 +39,7 @@ public interface CategoryDao {
 	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);
 	List<EntityWithParentDto> findCategoriesWithParents(String lang);
 	String findCategoryOfLastCreatedSeriesByUser(Integer userId);

src/main/java/ru/mystamps/web/feature/category/CategoryService.java

@@ -19,6 +19,7 @@
 
 import ru.mystamps.web.common.EntityWithParentDto;
 import ru.mystamps.web.common.LinkEntityDto;
+import ru.mystamps.web.common.SitemapInfoDto;
 
 import java.util.Date;
 import java.util.List;
@@ -30,6 +31,7 @@ public interface CategoryService {
 	List<Integer> findIdsByNames(List<String> names);
 	List<Integer> findIdsWhenNameStartsWith(String name);
 	List<LinkEntityDto> findAllAsLinkEntities(String lang);
+	List<SitemapInfoDto> findAllForSitemap();
 	List<EntityWithParentDto> findCategoriesWithParents(String lang);
 	LinkEntityDto findOneAsLinkEntity(String slug, String lang);
 	long countAll();

src/main/java/ru/mystamps/web/feature/category/CategoryServiceImpl.java

@@ -26,6 +26,7 @@
 import ru.mystamps.web.common.EntityWithParentDto;
 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;
 
@@ -115,6 +116,13 @@ public List<Integer> findIdsWhenNameStartsWith(String name) {
 	public List<LinkEntityDto> findAllAsLinkEntities(String lang) {
 		return categoryDao.findAllAsLinkEntities(lang);
 	}
+
+	// @todo #1605 CategoryService.findAllForSitemap(): add unit test
+	@Override
+	@Transactional(readOnly = true)
+	public List<SitemapInfoDto> findAllForSitemap() {
+		return categoryDao.findAllForSitemap();
+	}
 
 	@Override
 	@Transactional(readOnly = true)

src/main/java/ru/mystamps/web/feature/category/JdbcCategoryDao.java

@@ -29,6 +29,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;
@@ -56,6 +57,7 @@ public class JdbcCategoryDao implements CategoryDao {
 	private final String findIdsByNamesSql;
 	private final String findIdsByNamePatternSql;
 	private final String findCategoriesNamesWithSlugSql;
+	private final String findAllForSitemapSql;
 	private final String findLinkEntityBySlugSql;
 	@SuppressWarnings("PMD.LongVariable")
 	private final String findCategoriesWithParentNamesSql;
@@ -77,6 +79,7 @@ public JdbcCategoryDao(Environment env, NamedParameterJdbcTemplate jdbcTemplate)
 		this.findIdsByNamesSql                  = env.getRequiredProperty("category.find_ids_by_names");
 		this.findIdsByNamePatternSql            = env.getRequiredProperty("category.find_ids_by_name_pattern");
 		this.findCategoriesNamesWithSlugSql     = env.getRequiredProperty("category.find_all_categories_names_with_slug");
+		this.findAllForSitemapSql               = env.getRequiredProperty("category.find_all_for_sitemap");
 		this.findLinkEntityBySlugSql            = env.getRequiredProperty("category.find_category_link_info_by_slug");
 		this.findCategoriesWithParentNamesSql   = env.getRequiredProperty("category.find_categories_with_parent_names");
 		this.findFromLastCreatedSeriesByUserSql = env.getRequiredProperty("category.find_from_last_created_series_by_user");
@@ -210,6 +213,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/category/TogglzWithFallbackCategoryService.java

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

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

@@ -82,6 +82,7 @@ public SiteController siteController() {
 		@Bean
 		public SitemapController sitemapController() {
 			return new SitemapController(
+				categoryService,
 				collectionService,
 				seriesService
 			);

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

@@ -24,6 +24,7 @@
 import org.springframework.stereotype.Controller;
 import org.springframework.web.bind.annotation.GetMapping;
 import ru.mystamps.web.common.SitemapInfoDto;
+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.series.SeriesService;
@@ -50,6 +51,7 @@ public class SitemapController {
 		+ SiteUrl.PUBLIC_URL + SiteUrl.INDEX_PAGE
 		+ "</loc></url>\n";
 
+	private final CategoryService categoryService;
 	private final CollectionService collectionService;
 	private final SeriesService seriesService;
 
@@ -78,6 +80,11 @@ public void generateSitemapXml(HttpServletResponse response) {
 				// CheckStyle: ignore LineLength for next 1 line
 				writer.print(createUrlEntry(dateFormatter, item, SeriesUrl.INFO_SERIES_PAGE, "{id}"));
 			}
+
+			for (SitemapInfoDto item : categoryService.findAllForSitemap()) {
+				// CheckStyle: ignore LineLength for next 1 line
+				writer.print(createUrlEntry(dateFormatter, item, SeriesUrl.INFO_CATEGORY_PAGE, "{slug}"));
+			}
 
 			writer.print("</urlset>\n");
 		} catch (IOException ex) {

src/main/resources/sql/category_dao_queries.properties

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