<?php

/*
 Copyright 2008-2009 University of Toronto
 Licensed under the Educational Community License (ECL), Version 2.0 or the New
 BSD license. You may not use this file except in compliance with one these
 Licenses.
 You may obtain a copy of the ECL 2.0 License and BSD License at
 https://source.fluidproject.org/svn/LICENSE.txt
 */

/**
 * Processes a post from the customBuild Fluid Infusion component.
 *
 * @author Jacob Farber, Laurel Williams
 *
 * @version $Id$
 *
 */


//create a session and establish unique directory and file names based on the session id
session_start();

// TODO users will have to change this depending on their server setup
include_once ("config.php");

/**
 * Strips out all non-alphanumeric characters from the input string (except comma and spaces)
 *
 * @return A string with special characters removed
 * @param object $input The input string potentially containing special characters
 */
function stripSpecialChars($input)
{
    $input = preg_replace("/[^a-zA-Z0-9 ,]/s", "", $input);
    return $input;
}

/**
 * Ensures that the expected post variables have been posted and assigns them to the appropriate variables
 * 
 * @return true if it is successful, false otherwise
 */
function processPostVariables()
{
    global $minified, $includes, $excludes;
    if ( isset ($_POST["type"]) && isset ($_POST["include"]) && isset ($_POST["exclude"]))
    {
        if ($_POST["type"] == "source")
        {
            $minified = false;
        }
        $includes = stripSpecialChars($_POST["include"]);
        $excludes = stripSpecialChars($_POST["exclude"]);
        return true;
    }
    else
    {
        return false;
    }
}


/**
 * Builds the ant command.
 * See http://wiki.fluidproject.org/display/fluid/Custom+Build for details about
 * the command.
 *
 * @param object $incl Comma separated names representing the fluid modules to include
 * @param object $excl Comma separated names representing the fluid modules to exclude
 */
function buildAntCommand($incl, $excl)
{
    $unique_dir = session_id();

    $command = "cd ".BUILD_SCRIPT_PATH.
    $command .= " && ant customBuild";
    $command .= " -Dinclude=\"".$incl."\"";
    $command .= " -Dexclude=\"".$excl."\"";
    $command .= " -Dproducts=\"".OUTPUT_FILE_PATH_PRODUCTS.$unique_dir."\"";
    $command .= " -Dbuild=\"".OUTPUT_FILE_PATH_BUILD.$unique_dir."\"";
    $command .= " -Dmvn-settings-file=\"".MVN_SETTINGS_FILE."\"";

    return $command;
}

/**
 * Builds and executes the ant command.
 * See http://wiki.fluidproject.org/display/fluid/Custom+Build for details about
 * the command.
 *
 * @return true if the build is successful and false otherwise
 * @param object $includeString Comma separated module names representing the fluid modules to include
 * @param object $excludeString Comma separated module names representing the fluid modules to exclude
 */

function executeBuildScript($includeString, $excludeString)
{
    $antCommand = buildAntCommand($includeString, $excludeString);
    exec($antCommand, $output, $status);
    if (in_array("BUILD SUCCESSFUL", $output))
    {
        return true;
    }
    return false;
}

/**
 * Constructs a return response of type "archive/zip" and returns the appropriate minified or src
 *  version of the custom built package.
 *
 * @param object $min A boolean indicating that the user wants to download the
 * minified package (true) or src package (false)
 */
function deliverBuildFile($min)
{
    // TODO error checking in here

    //choose minified or src version
    $filename = ($min) ? MIN_FILE_NAME : SRC_FILE_NAME;
    $filepath = OUTPUT_FILE_PATH_PRODUCTS.session_id()."\\".$filename; //this will be a problem on unix
    $fp = fopen($filepath, "r");
    if ($fp == false)
    {
        return false;
    }
    $stats = fstat($fp);

    //deliver the file
    header("Content-Type: archive/zip");
    header("Content-Disposition: attachment; filename=$filename");
    header("Content-Length: $stats[size]");
    echo fpassthru($fp);
}

/**
 * Returns a 400 Bad Request Error with the html body containing the error string specified.
 * 
 * @param object $errString The error string to output.
 */
function returnError($errString) {
    header("HTTP/1.0 400 Bad Request");
    header("Status: 400");
    echo "<html><body><p>".$errString."</p></body></html>";
}


//process posted values
$minified = true; //default to minified
$includes = "";
$excludes = "";
$successPost = processPostVariables();
if (!$successPost)
{
    returnError("Cannot process input variables");
    exit (1);
}

$successExecute = executeBuildScript($includes, $excludes);
if (!$successExecute)
{
    returnError("Cannot execute build script");
    exit (1);
}

$successDeliver = deliverBuildFile($minified);
if (!$successDeliver)
{
    returnError("Cannot deliver file");
}


// TODO write tests for this code

?>