org.mycore.frontend.servlets.MCRLockServlet Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of mycore-base Show documentation
There is a newer version: 2024.05
/*
 * This file is part of ***  M y C o R e  ***
 * See http://www.mycore.de/ for details.
 *
 * MyCoRe is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * MyCoRe 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 General Public License
 * along with MyCoRe.  If not, see .
 */

package org.mycore.frontend.servlets;

import java.net.URL;
import java.util.Map;
import java.util.Set;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.Logger;
import org.mycore.common.MCRSession;
import org.mycore.common.MCRSessionMgr;
import org.mycore.common.MCRSystemUserInformation;
import org.mycore.datamodel.metadata.MCRObjectID;
import org.mycore.frontend.support.MCRObjectIDLockTable;

/**
 * @author Thomas Scheffler (yagee)
 *
 */
public class MCRLockServlet extends MCRServlet {
    private static final String OBJECT_ID_KEY = MCRLockServlet.class.getCanonicalName() + ".MCRObjectID";

    private static final String ACTION_KEY = MCRLockServlet.class.getCanonicalName() + ".Action";

    enum Action {
        lock, unlock
    }

    private static final Logger LOGGER = LogManager.getLogger(MCRLockServlet.class);

    private static final String PARAM_ACTION = "action";

    private static final String PARAM_OBJECTID = "id";

    private static final String PARAM_REDIRECT = "url";

    @Override
    protected void think(MCRServletJob job) throws Exception {
        if (MCRSessionMgr.getCurrentSession().getUserInformation()
            .equals(MCRSystemUserInformation.getGuestInstance())) {
            job.getResponse().sendError(HttpServletResponse.SC_FORBIDDEN);
            return;
        }
        String urlValue = getProperty(job.getRequest(), PARAM_REDIRECT);
        if (urlValue == null) {
            LOGGER.debug("Redirect URL is undefined, trying referrer.");
            URL referer = getReferer(job.getRequest());
            urlValue = referer == null ? null : referer.toString();
        }
        if (urlValue == null) {
            job.getResponse().sendError(HttpServletResponse.SC_BAD_REQUEST,
                "You must provide parameter: " + PARAM_REDIRECT);
            return;
        }
        String actionValue = getProperty(job.getRequest(), PARAM_ACTION);
        String idValue = getProperty(job.getRequest(), PARAM_OBJECTID);
        if (idValue == null) {
            job.getResponse().sendError(HttpServletResponse.SC_BAD_REQUEST,
                "You must provide parameter: " + PARAM_OBJECTID);
            return;
        }
        Action action = null;
        try {
            action = actionValue != null ? Action.valueOf(actionValue) : Action.lock;
        } catch (IllegalArgumentException e) {
            job.getResponse().sendError(HttpServletResponse.SC_BAD_REQUEST,
                "Unsupported value for parameter " + PARAM_ACTION + ": " + actionValue);
            return;
        }
        MCRObjectID objectID = MCRObjectID.getInstance(idValue);
        switch (action) {
            case lock:
                MCRObjectIDLockTable.lock(objectID);
                break;

            case unlock:
                MCRObjectIDLockTable.unlock(objectID);
                break;
        }
        job.getRequest().setAttribute(OBJECT_ID_KEY, objectID);
        job.getRequest().setAttribute(ACTION_KEY, action);
    }

    @Override
    protected void render(MCRServletJob job, Exception ex) throws Exception {
        if (job.getResponse().isCommitted()) {
            LOGGER.info("Response allready committed");
            return;
        }
        if (ex != null) {
            throw ex;
        }
        HttpServletRequest req = job.getRequest();
        MCRObjectID objectId = (MCRObjectID) job.getRequest().getAttribute(OBJECT_ID_KEY);
        Action action = (Action) job.getRequest().getAttribute(ACTION_KEY);
        MCRSession lockingSession = MCRObjectIDLockTable.getLocker(objectId);
        if (MCRObjectIDLockTable.isLockedByCurrentSession(objectId) || action == Action.unlock) {
            String url = getProperty(job.getRequest(), PARAM_REDIRECT);
            if (url.startsWith("/")) {
                url = req.getContextPath() + url;
            }
            url = addQueryParameter(url, req);
            job.getResponse().sendRedirect(job.getResponse().encodeRedirectURL(url));
        } else {
            String errorI18N = getErrorI18N("error", "lockedBy", objectId.toString(), lockingSession
                .getUserInformation().getUserID());
            job.getResponse().sendError(HttpServletResponse.SC_CONFLICT, errorI18N);
        }
    }

    private String addQueryParameter(String url, HttpServletRequest req) {
        boolean hasQueryParameter = url.indexOf('?') != -1;
        StringBuilder sb = new StringBuilder(url);
        Set> entrySet = req.getParameterMap().entrySet();
        for (Map.Entry parameter : entrySet) {
            if (!(parameter.getKey().equals(PARAM_REDIRECT) || parameter.getKey().equals(PARAM_ACTION) || url
                .contains(parameter.getKey() + "="))) {
                for (String value : parameter.getValue()) {
                    if (hasQueryParameter) {
                        sb.append('&');
                    } else {
                        sb.append('?');
                        hasQueryParameter = true;
                    }
                    sb.append(parameter.getKey());
                    sb.append("=");
                    sb.append(value);
                }
            }
        }
        return sb.toString();
    }
}