com.bluexml.side.alfresco.repo.content.cleanup.TrashcanCleaner.java Source code

Introduction

Here is the source code for com.bluexml.side.alfresco.repo.content.cleanup.TrashcanCleaner.java

Source

/*
Copyright (C) 2007-20013  BlueXML - www.bluexml.com
    
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 Affero 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/>.
*/
package com.bluexml.side.alfresco.repo.content.cleanup;

import java.util.Date;
import java.util.List;

import javax.transaction.UserTransaction;

import org.alfresco.model.ContentModel;
import org.alfresco.repo.node.archive.NodeArchiveService;
import org.alfresco.service.cmr.repository.NodeRef;
import org.alfresco.service.cmr.repository.NodeService;
import org.alfresco.service.cmr.search.ResultSet;
import org.alfresco.service.cmr.search.SearchParameters;
import org.alfresco.service.cmr.search.SearchService;
import org.alfresco.service.transaction.TransactionService;
import org.alfresco.util.ISO8601DateFormat;
import org.alfresco.web.bean.repository.Repository;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;

public class TrashcanCleaner {
    private static Log logger = LogFactory.getLog(TrashcanCleaner.class);

    private NodeArchiveService nodeArchiveService;
    private NodeService nodeService;
    private SearchService searchService;
    private TransactionService transactionService;
    private int protectedDays = 7;

    /**
     * @param nodeArchiveService The nodeArchiveService to set.
     */
    public void setNodeArchiveService(NodeArchiveService nodeArchiveService) {
        this.nodeArchiveService = nodeArchiveService;
    }

    /**
     * @param nodeService the nodeService to set
     */
    public void setNodeService(NodeService nodeService) {
        this.nodeService = nodeService;
    }

    /**
     * @param searchService The searchService to set.
     */
    public void setSearchService(SearchService searchService) {
        this.searchService = searchService;
    }

    /**
     * @param transactionService the transactionService to set
     */
    public void setTransactionService(TransactionService transactionService) {
        this.transactionService = transactionService;
    }

    /**
     * @param protectedDays The protectedDays to set.
     */
    public void setProtectedDays(int protectedDays) {
        this.protectedDays = protectedDays;
        if (logger.isDebugEnabled()) {
            if (this.protectedDays > 0)
                logger.debug("Deleted items will be protected during " + protectedDays + " days");
            else
                logger.debug("Trashcan cleaner has been desactivated ('protectedDays' set to an incorrect value)");
        }
    }

    public int execute() {
        if (logger.isDebugEnabled())
            logger.debug("execute TrashcanCleaner");
        int nbDeleted = 0;
        if (this.protectedDays > 0) {
            Date fromDate = new Date(0);
            Date toDate = new Date(
                    new Date().getTime() - (1000L * 60L * 60L * 24L * Long.valueOf(this.protectedDays)));

            if (logger.isDebugEnabled())
                logger.debug("Date =" + toDate);

            if (toDate == null) {
                throw new RuntimeException("Error while building the query. - Date is null");
            }

            String strFromDate = ISO8601DateFormat.format(fromDate);
            String strToDate = ISO8601DateFormat.format(toDate);
            StringBuilder buf = new StringBuilder(128);
            buf.append("@").append(Repository.escapeQName(ContentModel.PROP_ARCHIVED_DATE)).append(":").append("[")
                    .append(strFromDate).append(" TO ").append(strToDate).append("] ");

            String query = buf.toString();

            SearchParameters sp = new SearchParameters();
            sp.setLanguage(SearchService.LANGUAGE_LUCENE);
            sp.setQuery(query);

            NodeRef archiveRootRef = this.nodeArchiveService.getStoreArchiveNode(Repository.getStoreRef());
            sp.addStore(archiveRootRef.getStoreRef());
            if (logger.isDebugEnabled()) {
                logger.debug("Trashcan cleaner query : ");
                logger.debug(query);
            }

            UserTransaction tx = null;
            ResultSet results = null;
            try {
                tx = this.transactionService.getNonPropagatingUserTransaction(false);
                tx.begin();

                results = this.searchService.query(sp);
                List<NodeRef> deletedItemsToPurge = results.getNodeRefs();
                if (logger.isInfoEnabled()) {
                    logger.info("Trashcan Cleaner is about to purge the following items :");
                    for (NodeRef item : deletedItemsToPurge) {
                        String itemName = (String) this.nodeService.getProperty(item, ContentModel.PROP_NAME);
                        logger.info(" - " + itemName);
                    }
                }
                this.nodeArchiveService.purgeArchivedNodes(deletedItemsToPurge);

                tx.commit();
                nbDeleted = deletedItemsToPurge.size();
            } catch (Throwable err) {
                if (logger.isWarnEnabled())
                    logger.warn("Error while cleaning the trashcan : " + err.getMessage());
                try {
                    if (tx != null) {
                        tx.rollback();
                    }
                } catch (Exception tex) {
                    if (logger.isWarnEnabled())
                        logger.warn("Error while during the rollback : " + tex.getMessage());
                }
            } finally {
                if (results != null) {
                    results.close();
                }
            }
        }
        return nbDeleted;
    }
}