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, 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.ade.publish;
029
030import org.opencms.file.CmsObject;
031import org.opencms.file.CmsProject;
032import org.opencms.file.CmsResource;
033import org.opencms.main.CmsException;
034import org.opencms.main.OpenCms;
035
036/** Helper functions used to collect information for the publish dialog. */
037public final class CmsPublishListHelper {
038
039    /**
040     * Hide default constructor.
041     */
042    private CmsPublishListHelper() {
043
044        // Just to hide the public default contructor
045    }
046
047    /**
048     * Initializes a CmsObject based on the given one, but with adjusted project information and configured, such that release and expiration date are ignored.<p>
049     * @param cms the original CmsObject.
050     *
051     * @param online true if a CmsObject for the Online project should be returned
052     * @return the initialized CmsObject
053     *
054     * @throws CmsException if something goes wrong
055     */
056    public static CmsObject adjustCmsObject(CmsObject cms, boolean online) throws CmsException {
057
058        CmsObject result = OpenCms.initCmsObject(cms);
059        if (online) {
060            CmsProject onlineProject = cms.readProject(CmsProject.ONLINE_PROJECT_ID);
061            result.getRequestContext().setCurrentProject(onlineProject);
062        }
063        result.getRequestContext().setRequestTime(CmsResource.DATE_RELEASED_EXPIRED_IGNORE);
064        return result;
065    }
066}