001/*
002 *  Copyright 2025 Anyware Services
003 *
004 *  Licensed under the Apache License, Version 2.0 (the "License");
005 *  you may not use this file except in compliance with the License.
006 *  You may obtain a copy of the License at
007 *
008 *      http://www.apache.org/licenses/LICENSE-2.0
009 *
010 *  Unless required by applicable law or agreed to in writing, software
011 *  distributed under the License is distributed on an "AS IS" BASIS,
012 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 *  See the License for the specific language governing permissions and
014 *  limitations under the License.
015 */
016package org.ametys.runtime.maintenance;
017
018import java.util.Map;
019import java.util.Optional;
020
021import org.apache.avalon.framework.parameters.Parameters;
022import org.apache.cocoon.environment.ObjectModelHelper;
023import org.apache.cocoon.environment.Redirector;
024import org.apache.cocoon.environment.Response;
025import org.apache.cocoon.environment.SourceResolver;
026
027import org.ametys.runtime.exception.ExceptionAction;
028import org.ametys.runtime.exception.ServiceUnavailableException;
029import org.ametys.runtime.servlet.RuntimeServlet;
030
031/**
032 * Set the maintenance header and the maintenance message if needed.
033 */
034public class MaintenanceExceptionAction extends ExceptionAction
035{
036    @SuppressWarnings("unchecked")
037    @Override
038    public Map act(Redirector redirector, SourceResolver resolver, Map objectModel, String source, Parameters parameters) throws Exception
039    {
040        // Force the maintenance mode if needed
041        Throwable throwable = ObjectModelHelper.getThrowable(objectModel);
042        boolean forceMaintenanceMode = _forceMaintenanceMode(throwable);
043        if (forceMaintenanceMode)
044        {
045            Response response = ObjectModelHelper.getResponse(objectModel);
046            response.setHeader("X-Ametys-Maintenance", "");
047        }
048        
049        Map results = super.act(redirector, resolver, objectModel, source, parameters);
050        
051        // Set the maintenance comment
052        String comment = Optional.ofNullable(RuntimeServlet.getMaintenanceStatusForcedInformations()).map(s -> s.comment()).orElse("");
053        results.put("comment", comment);
054        
055        return results;
056    }
057    
058    private boolean _forceMaintenanceMode(Throwable throwable)
059    {
060        if (throwable == null)
061        {
062            return false;
063        }
064        else if (throwable instanceof ServiceUnavailableException sue)
065        {
066            return sue.forceMaintenanceMode();
067        }
068        
069        return _forceMaintenanceMode(throwable.getCause());
070    }
071}