MgnlGroovyRescueApp

/**
 * This file Copyright (c) 2013 Magnolia International
 * Ltd.  (http://www.magnolia-cms.com). All rights reserved.
 *
 *
 * This file is dual-licensed under both the Magnolia
 * Network Agreement and the GNU General Public License.
 * You may elect to use one or the other of these licenses.
 *
 * This file is distributed in the hope that it will be
 * useful, but AS-IS and WITHOUT ANY WARRANTY; without even the
 * implied warranty of MERCHANTABILITY or FITNESS FOR A
 * PARTICULAR PURPOSE, TITLE, or NONINFRINGEMENT.
 * Redistribution, except as permitted by whichever of the GPL
 * or MNA you select, is prohibited.
 *
 * 1. For the GPL license (GPL), you can redistribute and/or
 * modify this file under the terms of the GNU General
 * Public License, Version 3, as published by the Free Software
 * Foundation.  You should have received a copy of the GNU
 * General Public License, Version 3 along with this program;
 * if not, write to the Free Software Foundation, Inc., 51
 * Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * 2. For the Magnolia Network Agreement (MNA), this file
 * and the accompanying materials are made available under the
 * terms of the MNA which accompanies this distribution, and
 * is available at http://www.magnolia-cms.com/mna.html
 *
 * Any modifications to this file must keep this entire header
 * intact.
 *
 */
package info.magnolia.module.groovy.rescue;

import info.magnolia.cms.core.SystemProperty;
import info.magnolia.cms.security.RescueSecuritySupport;
import info.magnolia.context.MgnlContext;
import info.magnolia.context.SingleJCRSessionSystemContext;
import info.magnolia.i18nsystem.SimpleTranslator;
import info.magnolia.module.groovy.terminal.Terminal;
import info.magnolia.objectfactory.Components;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import com.vaadin.annotations.Title;
import com.vaadin.server.VaadinRequest;
import com.vaadin.ui.CssLayout;
import com.vaadin.ui.UI;

/**
 * A special app which makes at your disposal the Magnolia's Groovy interactive console bypassing the
 * normal Magnolia's filters chain. This can be useful, for instance, to perform rescue operations on a corrupted Magnolia instance.
 * <strong>Warning:</strong> All operations are executed in system context, meaning that no security restrictions are enforced which
 * might expose your data to risk of irreversible damages if you are not aware of what you are doing. In other words, <strong>use it at your own risk</strong>. <br>
 * To use it, in your <code>web.xml</code> you must explicitly comment out the Magnolia filter chain part and add or uncomment the Vaadin servlet.
 * For a sample configuration, see the <code>web.xml</code> fragment below:
 *
 * <pre>
 *   [...]
 *   &lt;!--
 *   &lt;filter&gt;
 *     &lt;display-name&gt;Magnolia global filters&lt;/display-name&gt;
 *     &lt;filter-name&gt;magnoliaFilterChain&lt;/filter-name&gt;
 *     &lt;filter-class&gt;info.magnolia.cms.filters.MgnlMainFilter&lt;/filter-class&gt;
 *   &lt;/filter&gt;
 *   &lt;filter-mapping&gt;
 *     &lt;filter-name&gt;magnoliaFilterChain&lt;/filter-name&gt;
 *     &lt;url-pattern&gt;/*&lt;/url-pattern&gt;
 *     &lt;dispatcher&gt;REQUEST&lt;/dispatcher&gt;
 *     &lt;dispatcher&gt;FORWARD&lt;/dispatcher&gt;
 *     &lt;dispatcher&gt;ERROR&lt;/dispatcher&gt;
 *   &lt;/filter-mapping&gt;
 *   --&gt;
 *   &lt;servlet&gt;
 *     &lt;servlet-name&gt;Vaadin&lt;/servlet-name&gt;
 *     &lt;servlet-class&gt;com.vaadin.server.VaadinServlet&lt;/servlet-class&gt;
 *       &lt;init-param&gt;
 *        &lt;description&gt;Groovy Rescue App&lt;/description&gt;
 *        &lt;param-name&gt;UI&lt;/param-name&gt;
 *        &lt;param-value&gt;info.magnolia.module.groovy.rescue.MgnlGroovyRescueApp&lt;/param-value&gt;
 *       &lt;/init-param&gt;
 *   &lt;/servlet&gt;
 *   &lt;servlet-mapping&gt;
 *      &lt;servlet-name&gt;Vaadin&lt;/servlet-name&gt;
 *      &lt;url-pattern&gt;/*&lt;/url-pattern&gt;
 *   &lt;/servlet-mapping&gt;
 *  [...]
 * </pre>
 *
 * Once configured and having restarted the web container, you can access the console like this
 * http://server[:port]/contextname
 * <p>
 * If you need to restart the app, you can append the Vaadin <code>?restartApplication</code> to the URL.
 */

@Title("Magnolia Groovy Rescue App")
public class MgnlGroovyRescueApp extends UI {
    private static final long serialVersionUID = 222L;

    private static final Logger log = LoggerFactory.getLogger(MgnlGroovyRescueApp.class);

    private static final String SECURITY_SUPPORT = "info.magnolia.cms.security.SecuritySupport";

    private CssLayout layout = new CssLayout();

    @Override
    protected void init(VaadinRequest request) {
        log.info("Initializing MgnlGroovyRescueApp...");
        log.warn("Setting value of {} to {}", SECURITY_SUPPORT, RescueSecuritySupport.class.getName());
        // following call will implicitly register this implementation.
        Components.newInstance(RescueSecuritySupport.class);
        SystemProperty.setProperty(SECURITY_SUPPORT, RescueSecuritySupport.class.getName());

        MgnlContext.setInstance(new SingleJCRSessionSystemContext());

        layout.setSizeFull();
        layout.addComponent(new Terminal(Components.getComponent(SimpleTranslator.class), true));

        setContent(layout);
    }
}