001/*
002 * This library is part of OpenCms -
003 * the Open Source Content Management System
004 *
005 * Copyright (c) Alkacon Software GmbH & Co. KG (http://www.alkacon.com)
006 *
007 * This library is free software; you can redistribute it and/or
008 * modify it under the terms of the GNU Lesser General Public
009 * License as published by the Free Software Foundation; either
010 * version 2.1 of the License, or (at your option) any later version.
011 *
012 * This library is distributed in the hope that it will be useful,
013 * but WITHOUT ANY WARRANTY; without even the implied warranty of
014 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
015 * Lesser General Public License for more details.
016 *
017 * For further information about Alkacon Software GmbH & Co. KG, please see the
018 * company website: http://www.alkacon.com
019 *
020 * For further information about OpenCms, please see the
021 * project website: http://www.opencms.org
022 *
023 * You should have received a copy of the GNU Lesser General Public
024 * License along with this library; if not, write to the Free Software
025 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
026 */
027
028package org.opencms.scheduler.jobs;
029
030import org.opencms.file.CmsObject;
031import org.opencms.main.OpenCms;
032import org.opencms.scheduler.I_CmsScheduledJob;
033import org.opencms.util.CmsStringUtil;
034
035import java.util.Map;
036
037/**
038 * A scheduled OpenCms job to unsubscribe deleted resources.<p>
039 *
040 * Job parameters:<p>
041 * <dl>
042 * <dt><code>deleteddays={Number/Integer}</code></dt>
043 * <dd>Amount of days a resource has to be deleted to be unsubscribed (defaults to 30).</dd>
044 * </dl>
045 * <p>
046 *
047 * @since 8.0.0
048 */
049public class CmsUnsubscribeDeletedResourcesJob implements I_CmsScheduledJob {
050
051    /** Name of the parameter where to configure the amount of days a resource has to be expired before deletion. */
052    public static final String PARAM_DELETEDDAYS = "deleteddays";
053
054    /** Constant for calculation. */
055    private static final long MILLIS_PER_DAY = 24 * 60 * 60 * 1000;
056
057    /**
058     * @see org.opencms.scheduler.I_CmsScheduledJob#launch(org.opencms.file.CmsObject, java.util.Map)
059     */
060    public String launch(CmsObject cms, Map<String, String> parameters) throws Exception {
061
062        // read the parameter for the deleted days
063        int deletedDays = 30;
064        String deleteddaysParam = parameters.get(PARAM_DELETEDDAYS);
065        if (CmsStringUtil.isNotEmptyOrWhitespaceOnly(deleteddaysParam)) {
066            try {
067                deletedDays = Integer.parseInt(deleteddaysParam);
068            } catch (NumberFormatException nfe) {
069                // don't care
070            }
071        }
072        long deletedTo = System.currentTimeMillis() - (MILLIS_PER_DAY * deletedDays);
073        OpenCms.getSubscriptionManager().unsubscribeAllDeletedResources(cms, deletedTo);
074
075        return null;
076    }
077
078}