com.threecrickets.prudence.util.PhpExecutionController.java Source code

Introduction

Here is the source code for com.threecrickets.prudence.util.PhpExecutionController.java

Source

/**
 * Copyright 2009-2016 Three Crickets LLC.
 * <p>
 * The contents of this file are subject to the terms of the LGPL version 3.0:
 * http://www.gnu.org/copyleft/lesser.html
 * <p>
 * Alternatively, you can obtain a royalty free commercial license with less
 * limitations, transferable or non-transferable, directly from Three Crickets
 * at http://threecrickets.com/
 */

package com.threecrickets.prudence.util;

import java.io.File;
import java.util.Collections;

import org.apache.commons.fileupload.FileItemFactory;
import org.apache.commons.fileupload.disk.DiskFileItemFactory;
import org.restlet.Request;

import com.threecrickets.prudence.internal.lazy.LazyInitializationCookie;
import com.threecrickets.prudence.internal.lazy.LazyInitializationFile;
import com.threecrickets.prudence.internal.lazy.LazyInitializationGet;
import com.threecrickets.prudence.internal.lazy.LazyInitializationPost;
import com.threecrickets.prudence.internal.lazy.LazyInitializationRequest;
import com.threecrickets.scripturian.ExecutionContext;
import com.threecrickets.scripturian.ExecutionController;
import com.threecrickets.scripturian.exception.ExecutionException;

/**
 * An execution controller that exposes PHP-style
 * <a href="http://www.php.net/manual/en/reserved.variables.php">predefined
 * variables</a> ("superglobals") to executables.
 * 
 * @author Tal Liron
 */
public class PhpExecutionController implements ExecutionController {
    //
    // Construction
    //

    /**
     * Construction with default system repository directory.
     */
    public PhpExecutionController() {
        this(new DiskFileItemFactory());
    }

    /**
     * Constructor.
     * 
     * @param fileItemFactory
     *        The file item factory
     */
    public PhpExecutionController(FileItemFactory fileItemFactory) {
        this.fileItemFactory = fileItemFactory;
    }

    /**
     * Constructor.
     * 
     * @param sizeThreshold
     *        The size in bytes beyond which files will be stored to disk
     * @param repositoryDirectory
     *        The directory in which to place uploaded files
     */
    public PhpExecutionController(int sizeThreshold, File repositoryDirectory) {
        this(new DiskFileItemFactory(sizeThreshold, repositoryDirectory));
    }

    //
    // ExecutionController
    //

    public void initialize(ExecutionContext executionContext) throws ExecutionException {
        Request request = Request.getCurrent();

        LazyInitializationGet exposedGet = new LazyInitializationGet(request);
        LazyInitializationFile exposedFile = new LazyInitializationFile(request, fileItemFactory);
        LazyInitializationPost exposedPost = new LazyInitializationPost(request, exposedFile);
        LazyInitializationCookie exposedCookie = new LazyInitializationCookie(request);
        LazyInitializationRequest exposedRequest = new LazyInitializationRequest(exposedGet, exposedPost,
                exposedCookie);

        // Note that our maps will only contain the last parameter in case of
        // duplicates. This is PHP's defined behavior.

        executionContext.getServices().put("_GET", Collections.unmodifiableMap(exposedGet));
        executionContext.getServices().put("_FILE", Collections.unmodifiableMap(exposedFile));
        executionContext.getServices().put("_POST", Collections.unmodifiableMap(exposedPost));
        executionContext.getServices().put("_COOKIE", Collections.unmodifiableMap(exposedCookie));
        executionContext.getServices().put("_REQUEST", Collections.unmodifiableMap(exposedRequest));
    }

    public void release(ExecutionContext executionContext) {
    }

    // //////////////////////////////////////////////////////////////////////////
    // Private

    /**
     * The file item factory.
     */
    private final FileItemFactory fileItemFactory;
}