<?php
/**
 * solidworks.php
 *
 * This file contains the primary functions of the SolidWorks framework
 *
 * @package SolidWorks
 * @author John Diamond <hide@address.com>
 * @copyright John Diamond <hide@address.com>
 * @license http://www.opensource.org/licenses/gpl-license.php GNU Public License
 */

// Load the application configuration (including Page definitions)
require "configuration.php";

// Load support libraries
require "smarty_extensions.php";
require "security.php";

// Change the charset to UTF-8
header( "Content-type: text/html; charset=utf-8" );

// Open the session
session_start();

/**
 * SolidWorks (entry point)
 *
 * This function serves as the entry point for the entire application.  It opens
 * the session, loads the Page object, processes any forms, and invokes any actions
 * for the page.
 *
 * @package SolidWorks
 * @author John Diamond <hide@address.com>
 */
function solidworks( &$conf, $smarty ) {
	global $page; // Make the Page object available to smarty_extensions
	global $translations;

	// Make sure the client is logged in as a valid user before proceeding
	validate_client();

	// Load the user's language preference
	$language = isset( $_SESSION['client']['userdbo'] ) ?
			$_SESSION['client']['userdbo']->getLanguage() : null;
	if ( $language != null ) {
		TranslationParser::load( "language/" . $language );
		Translator::getTranslator()->setActiveLanguage( $language );
	}

	if ( $_SESSION['currentpage'] != $_GET['page'] ) {
		$_SESSION['lastpage'] = $_SESSION['currentpage'];
	}

	// Get a Page object for the page being requested
	$page = null;
	$page = get_page_object( $conf, $smarty );
	if ( $page == null ) {
		// Delete current session
		session_destroy();

		// Instantiate a generic page object
		$page = new Page;
	}

	// Make sure the client has access to this page
	if ( !$page->control_access() ) {
		// Access denied
		$page->setError( array( "type" => "ACCESS_DENIED" ) );
		$page->goback( 1 );
	}

	// Process any forms
	if ( $_SERVER['REQUEST_METHOD'] == "POST" ) {
		handle_post_request();
	}

	// Execute any action if present in the URL
	if ( isset( $_GET['action'] ) ) {
		$page->action( $_GET['action'] );
	}

	// Display
	display_page( $page );

	// Push page onto the navigation stack
	$_SESSION['navstack'][] = array( "page" => $page->getName(),
			"url" => $page->getURL() );
}

function display_page( $page ) {
	$conf = $page->conf;
	$smarty = $page->smarty;

	// Update page variables - they may need to be filled in with run-time info
	generate_location_stack( $conf );
	$page->setLocationStack( $conf['pages'][$page->getClassName()]['location_stack'] );
	$page->setTitle( $conf['pages'][$page->getClassName()]['title'] );
	$page->setUrl( $conf['pages'][$page->getClassName()]['url'] );

	// Set template variables
	$smarty->assign( "location", $page->getTitle() );
	$smarty->assign( "location_stack", $page->getLocationStack() );
	$smarty->assign( "company_name", $conf['company']['name'] );
	$smarty->assign( "client_ip", $_SERVER['REMOTE_ADDR'] );
	$smarty->assign( "content_template", $page->getTemplateFile() );
	$smarty->assign( "url", $page->getUrl() );
	$smarty->assign( "version", $conf['application_name'] );
	$smarty->assign( "machine", $_SERVER['SERVER_NAME'] );
	if ( isset( $_SESSION['client']['userdbo'] ) ) {
		$smarty->assign( "username", $_SESSION['client']['userdbo']->getUsername() );
	}

	// Invoke any javascript
	if ( isset( $_SESSION['jsFunction'] ) ) {
		$smarty->assign( "jsFunction", $_SESSION['jsFunction'] );
		unset( $_SESSION['jsFunction'] );
	}

	if ( intval( $_GET['no_headers'] ) == 1 ) {
		// Display without headers
		$smarty->display( $page->getTemplateFile() );
	}
	else {
		// Display with headers
		$smarty->display( Page::selectTemplateFile( $conf['main_template'] ) );
	}

	// Remove messages and errors from session
	$session = $page->getPageSession();
	unset( $session['errors'] );
	unset( $session['messages'] );
}

/**
 * Handle Post Request
 *
 * Process a POST form according to the rules defined in the application config
 * file.
 */
function handle_post_request() {
	global $page, $conf;

	// Reset form errors
	unset( $_SESSION[$page->getName()]['form_errors'] );

	// Verify a form name was included with POST data
	$form_name = $_GET['submit'];
	if ( !isset( $form_name ) ) {
		throw new SWException( "POST received with no form name supplied." );
	}

	// Validate the form
	if ( $page->processForm( $form_name ) ) {
		// No errors in form - go ahead and process
		try {
			$page->action( $form_name );
		}
		catch ( SWUserException $e ) {
			// User Exceptions are meant to be displayed on the page
			$page->exception( $e );
			$page->reload();
		}
	}
}

/**
 * Get Page Object
 *
 * Instantiates a Page object for the request page provided by the
 * 'page' parameter in the URL.
 *
 * @param array $conf Configuration data
 * @param object $smarty Smarty template object
 * @return Page A reference to the page object.  If the page parameter is invalid, null is returned.
 */
function &get_page_object( $conf, $smarty ) {
	if ( !isset( $_GET['page'] ) ) {
		// No page parameter is provided, set to home page
		$_GET['page'] = $conf['home_page'];
	}

	// Find the requested Page object
	$requested_page_name = $_GET['page'];
	$page_class = get_page_class( $requested_page_name );

	// Verify the requested page was found
	if ( $page_class == null ) {
		throw new SWException( "Could not find the requested page name: " .
				$requested_page_name );
	}

	// Instantiate an object for the requested page and return as a reference
	$page_obj = new $page_class;

	// Set the class name - workaround for PHP 5 get_class behavior.
	$page_obj->class_name = $page_class;
	$page_obj->load( $conf, $smarty );

	if ( $page_obj->isDisabled() ) {
		throw new SWException( "This page has been disabled" );
	}

	if ( method_exists( $page_obj, 'init' ) ) {
		// init() function takes on the role of a contructor for Page objects
		$page_obj->init();
	}

	// Remove any page data from the session of Pages other than this one
	foreach( $conf['pages'] as $page_class_name => $page_conf ) {
		if ( $page_conf['name'] != $requested_page_name ) {
			// Not data for this page - remove from session
			unset( $_SESSION[$page_conf['name']] );
		}
	}

	return $page_obj;
}

/**
 * Dump Session
 *
 * Prints $_SESSION inside 'pre' tags
 */
function dump_session() {
	echo "<pre>";
	print_r( $_SESSION );
	echo "</pre>";
}

?>