ChangeLogInterceptor

package fr.ifremer.quadrige3.synchro.intercept.referential;

/*-
 * #%L
 * Quadrige3 Core :: Quadrige3 Synchro Core
 * $Id:$
 * $HeadURL:$
 * %%
 * Copyright (C) 2017 Ifremer
 * %%
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as published by
 * the Free Software Foundation, either version 3 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 Affero General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 * #L%
 */

import com.google.common.collect.ImmutableList;
import fr.ifremer.common.synchro.dao.SynchroTableDao;
import fr.ifremer.common.synchro.intercept.SynchroInterceptorBase;
import fr.ifremer.common.synchro.intercept.SynchroOperationRepository;
import fr.ifremer.common.synchro.meta.SynchroDatabaseMetadata;
import fr.ifremer.quadrige3.synchro.meta.referential.ReferentialSynchroTables;
import fr.ifremer.quadrige3.synchro.meta.system.RuleSynchroTables;
import fr.ifremer.quadrige3.synchro.service.referential.ReferentialSynchroDatabaseConfiguration;
import fr.ifremer.quadrige3.synchro.vo.SynchroChangesVO;
import org.apache.commons.collections4.CollectionUtils;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.hibernate.tool.hbm2ddl.TableMetadata;

import java.io.IOException;
import java.sql.SQLException;
import java.util.List;

/**
 * Listen all changes on main referential tables, and store changes onto a file (see
 * ReferentialSynchroContext.getChangeLogFile())
 *
 * @author Benoit Lavenier <benoit.lavenier@e-is.pro>
 * @since 1.0
 */
public class ChangeLogInterceptor extends AbstractReferentialInterceptor {

	private static final Log log = LogFactory.getLog(ChangeLogInterceptor.class);

	private static final boolean debug = log.isDebugEnabled();

	private static final List<String> includedTableNames = ImmutableList.<String> builder()
			.add(ReferentialSynchroTables.MONITORING_LOCATION.name())
			.add(ReferentialSynchroTables.REFERENCE_TAXON.name())
			.add(ReferentialSynchroTables.TAXON_GROUP.name())
			.add(ReferentialSynchroTables.PARAMETER.name())
			.add(ReferentialSynchroTables.MATRIX.name())
			.add(ReferentialSynchroTables.FRACTION.name())
			.add(ReferentialSynchroTables.METHOD.name())
			.add(ReferentialSynchroTables.UNIT.name())
			.add(ReferentialSynchroTables.ANALYSIS_INSTRUMENT.name())
			.add(ReferentialSynchroTables.SAMPLING_EQUIPMENT.name())
			.add(ReferentialSynchroTables.PROGRAMME.name())
			.add(ReferentialSynchroTables.STRATEGY.name())
			.add(ReferentialSynchroTables.MORATORIUM.name())
			.add(ReferentialSynchroTables.QUSER.name())
			.add(ReferentialSynchroTables.DEPARTMENT.name())
			.add(RuleSynchroTables.RULE_LIST.name())
			.build();

	private boolean isEnable = false;

	private SynchroChangesVO changeLog = null;

	/** {@inheritDoc} */
	@Override
	protected void init(ReferentialSynchroDatabaseConfiguration config) {
		super.init(config);
		isEnable = isChangeLogEnable(config);
		setEnableOnWrite(isEnable);
	}

	/** {@inheritDoc} */
	@Override
	public SynchroInterceptorBase clone() {
		ChangeLogInterceptor result = (ChangeLogInterceptor) super.clone();
		result.isEnable = isEnable;
		return result;
	}

	/** {@inheritDoc} */
	@Override
	public boolean doApply(SynchroDatabaseMetadata meta, TableMetadata table) {
		if (!isEnable
				|| CollectionUtils.isEmpty(includedTableNames)) {
			return false;
		}

		return includedTableNames.contains(table.getName().toUpperCase());
	}

	/** {@inheritDoc} */
	@Override
	protected void doOnWrite(Object[] data,
			List<Object> pk,
			SynchroTableDao sourceDao,
			SynchroTableDao targetDao,
			SynchroOperationRepository buffer,
			boolean insert) throws SQLException {
		String tableName = sourceDao.getTable().getName();

		// log changes
		if (pk == null) {
			pk = sourceDao.getPk(data);
		}

		if (changeLog == null) {
			changeLog = new SynchroChangesVO();
		}

		// Add this changes to result
		if (insert) {
			if (debug) {
				log.debug(String.format("[%s] detect insert - pk %s", tableName, pk));
			}

			changeLog.addInsert(tableName, pk);
		}
		else {
			if (debug) {
				log.debug(String.format("[%s] detect update - pk %s", tableName, pk));
			}

			changeLog.addUpdate(tableName, pk);
		}
	}

	/** {@inheritDoc} */
	@Override
	protected void doOnDelete(List<Object> pk, SynchroTableDao sourceDao, SynchroTableDao targetDao, SynchroOperationRepository buffer) {
		String tableName = sourceDao.getTable().getName();

		if (changeLog == null) {
			changeLog = new SynchroChangesVO();
		}

		if (debug) {
			log.debug(String.format("[%s] detect delete - pk %s", tableName, pk));
		}

		// Add this changes to result
		changeLog.addDelete(tableName, pk);
	}

	/** {@inheritDoc} */
	@Override
	protected void doClose() throws IOException {
		super.doClose();

		// Save result to file
		if (changeLog != null) {
			changeLog.writeToFile(getConfig().getChangeLogFile(), true /* append */);
		}
	}

	/* -- Internal methods -- */

	/**
	 * <p>
	 * isChangeLogEnable.
	 * </p>
	 *
	 * @param config
	 *            a {@link fr.ifremer.quadrige3.synchro.service.referential.ReferentialSynchroDatabaseConfiguration}
	 *            object.
	 * @return a boolean.
	 */
	protected boolean isChangeLogEnable(ReferentialSynchroDatabaseConfiguration config) {
		return config.getChangeLogFile() != null;
	}
}