JdbcCollectionDao.java

/*
 * Copyright (C) 2009-2017 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.dao.impl;

import java.util.Collections;
import java.util.Date;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

import org.apache.commons.lang3.Validate;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import org.springframework.beans.factory.annotation.Value;
import org.springframework.dao.EmptyResultDataAccessException;
import org.springframework.jdbc.core.namedparam.MapSqlParameterSource;
import org.springframework.jdbc.core.namedparam.NamedParameterJdbcTemplate;
import org.springframework.jdbc.support.GeneratedKeyHolder;
import org.springframework.jdbc.support.KeyHolder;

import lombok.RequiredArgsConstructor;

import ru.mystamps.web.dao.CollectionDao;
import ru.mystamps.web.dao.dto.AddCollectionDbDto;
import ru.mystamps.web.dao.dto.CollectionInfoDto;
import ru.mystamps.web.dao.dto.LinkEntityDto;

@RequiredArgsConstructor
@SuppressWarnings("PMD.AvoidDuplicateLiterals")
public class JdbcCollectionDao implements CollectionDao {
	private static final Logger LOG = LoggerFactory.getLogger(JdbcCollectionDao.class);
	
	private final NamedParameterJdbcTemplate jdbcTemplate;
	
	@Value("${collection.find_last_created}")
	private String findLastCreatedCollectionsSql;
	
	@Value("${collection.count_collections_of_users}")
	private String countCollectionsOfUsersSql;
	
	@Value("${collection.count_updated_since}")
	private String countUpdatedSinceSql;
	
	@Value("${collection.create}")
	private String addCollectionSql;

	@Value("${collection.mark_as_modified}")
	private String markAsModifiedSql;
	
	@Value("${collection.is_series_in_collection}")
	private String isSeriesInUserCollectionSql;
	
	@Value("${collection.add_series_to_collection}")
	private String addSeriesToCollectionSql;
	
	@Value("${collection.remove_series_from_collection}")
	private String removeSeriesFromCollectionSql;
	
	@Value("${collection.find_info_by_slug}")
	private String findCollectionInfoBySlugSql;
	
	@Override
	public List<LinkEntityDto> findLastCreated(int quantity) {
		return jdbcTemplate.query(
			findLastCreatedCollectionsSql,
			Collections.singletonMap("quantity", quantity),
			RowMappers::forLinkEntityDto
		);
	}
	
	@Override
	public long countCollectionsOfUsers() {
		return jdbcTemplate.queryForObject(
			countCollectionsOfUsersSql,
			Collections.<String, Object>emptyMap(),
			Long.class
		);
	}
	
	@Override
	public long countUpdatedSince(Date date) {
		return jdbcTemplate.queryForObject(
			countUpdatedSinceSql,
			Collections.singletonMap("date", date),
			Long.class
		);
	}
	
	@Override
	public Integer add(AddCollectionDbDto collection) {
		Map<String, Object> params = new HashMap<>();
		params.put("user_id", collection.getOwnerId());
		params.put("slug", collection.getSlug());
		params.put("updated_at", collection.getUpdatedAt());
		params.put("updated_by", collection.getOwnerId());
		
		KeyHolder holder = new GeneratedKeyHolder();
		
		int affected = jdbcTemplate.update(
			addCollectionSql,
			new MapSqlParameterSource(params),
			holder
		);
		
		Validate.validState(
			affected == 1,
			"Unexpected number of affected rows after creation of collection of user #%d: %d",
			params.get("user_id"),
			affected
		);
		
		return Integer.valueOf(holder.getKey().intValue());
	}

	/**
	 * @author John Shkarin
	 * @author Slava Semushin
	 */
	@Override
	public void markAsModified(Integer userId, Date updatedAt) {
		Map<String, Object> params = new HashMap<>();
		params.put("user_id", userId);
		params.put("updated_at", updatedAt);
		params.put("updated_by", userId);

		int affected = jdbcTemplate.update(
			markAsModifiedSql,
			params
		);

		Validate.validState(
			affected == 1,
			"Unexpected number of affected rows after updating collection: %d",
			affected
		);
	}
	
	@Override
	public boolean isSeriesInUserCollection(Integer userId, Integer seriesId) {
		Map<String, Object> params = new HashMap<>();
		params.put("user_id", userId);
		params.put("series_id", seriesId);
		
		Long result = jdbcTemplate.queryForObject(isSeriesInUserCollectionSql, params, Long.class);
		Validate.validState(result != null, "Query returned null instead of long");
		
		return result > 0;
	}
	
	@Override
	public void addSeriesToUserCollection(Integer userId, Integer seriesId) {
		Map<String, Object> params = new HashMap<>();
		params.put("user_id", userId);
		params.put("series_id", seriesId);
		
		int affected = jdbcTemplate.update(addSeriesToCollectionSql, params);
		
		// CheckStyle: ignore LineLength for next 3 lines
		Validate.validState(
			affected == 1,
			"Unexpected number of affected rows after adding series #%d to collection of user #%d: %d",
			seriesId,
			userId,
			affected
		);
	}
	
	@SuppressWarnings("PMD.AvoidLiteralsInIfCondition")
	@Override
	public void removeSeriesFromUserCollection(Integer userId, Integer seriesId) {
		Map<String, Object> params = new HashMap<>();
		params.put("user_id", userId);
		params.put("series_id", seriesId);
		
		int affected = jdbcTemplate.update(removeSeriesFromCollectionSql, params);
		if (affected != 1) {
			// CheckStyle: ignore LineLength for next 2 lines
			LOG.warn(
				"Unexpected number of affected rows after removing series #{} from collection of user #{}: %{}",
				seriesId,
				userId,
				affected
			);
		}
	}
	
	@Override
	public CollectionInfoDto findCollectionInfoBySlug(String slug) {
		try {
			return jdbcTemplate.queryForObject(
				findCollectionInfoBySlugSql,
				Collections.singletonMap("slug", slug),
				RowMappers::forCollectionInfoDto
			);
		} catch (EmptyResultDataAccessException ignored) {
			return null;
		}
	}
	
}