001/*
002 * This library is part of OpenCms -
003 * the Open Source Content Management System
004 *
005 * Copyright (c) Alkacon Software GmbH & Co. KG (https://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, please see the
018 * company website: https://www.alkacon.com
019 *
020 * For further information about OpenCms, please see the
021 * project website: https://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.file.wrapper;
029
030import org.opencms.file.CmsObject;
031import org.opencms.file.CmsProperty;
032import org.opencms.file.CmsResource;
033import org.opencms.file.CmsResourceFilter;
034import org.opencms.file.CmsVfsResourceNotFoundException;
035import org.opencms.lock.CmsLock;
036import org.opencms.main.CmsException;
037import org.opencms.main.CmsIllegalArgumentException;
038
039import java.util.List;
040
041/**
042 * Resource wrapper which intercepts createResource calls and substitutes them with replaceResource if there is already a deleted file at the same path.<p>
043 *
044 * This is useful because when accessing a repository, users can neither see nor publish deleted files, and thus can not re-create a file of state "deleted".
045 */
046public class CmsResourceWrapperReplaceDeleted extends A_CmsResourceWrapper {
047
048    /**
049     * @see org.opencms.file.wrapper.A_CmsResourceWrapper#createResource(org.opencms.file.CmsObject, java.lang.String, int, byte[], java.util.List)
050     */
051    @Override
052    public CmsResource createResource(
053        CmsObject cms,
054        String resourcename,
055        int type,
056        byte[] content,
057        List<CmsProperty> properties)
058    throws CmsException, CmsIllegalArgumentException {
059
060        try {
061            CmsResource resource = cms.readResource(resourcename, CmsResourceFilter.ALL);
062            if (!resource.getState().isDeleted()) {
063                return null;
064            }
065            CmsLock lock = cms.getLock(resource);
066            if (lock.isUnlocked()) {
067                cms.lockResourceTemporary(resourcename);
068            }
069            cms.undeleteResource(resourcename, false);
070            cms.replaceResource(resourcename, type, content, properties);
071            CmsResource result = cms.readResource(resourcename);
072            return result;
073        } catch (CmsVfsResourceNotFoundException e) {
074            return null;
075        }
076
077    }
078
079    /**
080     * @see org.opencms.file.wrapper.I_CmsResourceWrapper#isWrappedResource(org.opencms.file.CmsObject, org.opencms.file.CmsResource)
081     */
082    public boolean isWrappedResource(CmsObject cms, CmsResource res) {
083
084        return false;
085    }
086
087}