DefaultXWikiStubContextProvider.java

/*
 * See the NOTICE file distributed with this work for additional
 * information regarding copyright ownership.
 *
 * This is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation; either version 2.1 of
 * the License, or (at your option) any later version.
 *
 * This software 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
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this software; if not, write to the Free
 * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
 * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
 */
package com.xpn.xwiki.internal;

import javax.inject.Inject;
import javax.inject.Provider;
import javax.inject.Singleton;

import org.slf4j.Logger;
import org.xwiki.component.annotation.Component;
import org.xwiki.model.reference.DocumentReference;

import com.xpn.xwiki.XWikiContext;
import com.xpn.xwiki.doc.XWikiDocument;
import com.xpn.xwiki.util.XWikiStubContextProvider;
import com.xpn.xwiki.web.XWikiServletRequest;
import com.xpn.xwiki.web.XWikiServletRequestStub;
import com.xpn.xwiki.web.XWikiServletResponse;
import com.xpn.xwiki.web.XWikiServletResponseStub;
import com.xpn.xwiki.web.XWikiURLFactory;

/**
 * Default implementation of XWikiStubContextProvider.
 *
 * @todo make DefaultXWikiStubContextProvider able to generate a stub context from scratch some way, it will need some
 *       refactor around XWiki class for this to be possible. The current limitation is that without a first request
 *       this provider is unusable.
 * @version $Id: 02413562ef4095c503f1c52968e8ce6678991577 $
 * @since 2.0M3
 */
@Component
@Singleton
public class DefaultXWikiStubContextProvider implements XWikiStubContextProvider
{
    /**
     * The logger to log.
     */
    @Inject
    private Logger logger;

    @Inject
    private Provider<DocumentReference> defaultDocumentReferenceProvider;

    /**
     * The initial stub XWikiContext.
     */
    private XWikiContext initialContext;

    @Override
    public void initialize(XWikiContext context)
    {
        XWikiContext newContext = context.clone();

        newContext.setCacheDuration(0);

        newContext.setUserReference(null);
        newContext.setLanguage(null);
        newContext.setWikiId(context.getMainXWiki());

        // Cleanup
        newContext.flushClassCache();

        // We are sure the context request is a real servlet request
        // So we force the dummy request with the current host
        if (newContext.getRequest() != null) {
            XWikiServletRequestStub initialRequest = new XWikiServletRequestStub();
            initialRequest.setHost(newContext.getRequest().getHeader("x-forwarded-host"));
            initialRequest.setScheme(newContext.getRequest().getScheme());
            XWikiServletRequest request = new XWikiServletRequest(initialRequest);
            newContext.setRequest(request);
        }

        // Get rid of the real response
        if (newContext.getResponse() != null) {
            XWikiServletResponseStub initialResponse = new XWikiServletResponseStub();
            // anything to keep ?
            XWikiServletResponse response = new XWikiServletResponse(initialResponse);
            newContext.setResponse(response);
        }

        // Set the URL Factory so that the URL Factory doesn't depend of the mode of the first action that entered
        // the system (Servlet, PDF, GWT, Portlet, etc).
        // We decide arbitrarily to use the Servlet URL Factory since it's the "standard" factory.
        if (newContext.getURLFactory() != null) {
            XWikiURLFactory urlf =
                newContext.getWiki().getURLFactoryService().createURLFactory(XWikiContext.MODE_SERVLET, context);
            newContext.setURLFactory(urlf);
        }

        this.initialContext = newContext;

        this.logger.debug("Stub context initialized.");
    }

    @Override
    public XWikiContext createStubContext()
    {
        XWikiContext stubContext;

        if (this.initialContext != null) {
            stubContext = this.initialContext.clone();

            // We make sure to not share the same Request instance with several threads
            if (this.initialContext.getRequest() != null) {
                XWikiServletRequestStub stubRequest = new XWikiServletRequestStub();
                stubRequest.setHost(this.initialContext.getRequest().getHeader("x-forwarded-host"));
                stubRequest.setScheme(this.initialContext.getRequest().getScheme());
                XWikiServletRequest request = new XWikiServletRequest(stubRequest);
                stubContext.setRequest(request);
            }

            // We make sure to not share the same Response instance with several threads
            if (this.initialContext.getResponse() != null) {
                XWikiServletResponseStub stubResponse = new XWikiServletResponseStub();
                XWikiServletResponse response = new XWikiServletResponse(stubResponse);
                stubContext.setResponse(response);
            }

            // We make sure to not share the same document instance with several threads
            stubContext.setDoc(new XWikiDocument(this.defaultDocumentReferenceProvider.get()));
        } else {
            stubContext = null;
        }

        return stubContext;
    }
}