chamilo / chamilo-lms

plugin/pens/chamilo_pens.php

Indentation +216 added lines, -216 removed lines

@@ -16,14 +16,14 @@ 
  * along with chamilo-pens.  If not, see <http://www.gnu.org/licenses/>.
  */
  
- /**
- * ChamiloPens
- * 
- * This file provides the ChamiloPens class
- * 
- * @author Guillaume Viguier-Just <guillaume@viguierjust.com>
- * @licence http://www.gnu.org/licenses/gpl.txt
- */
+    /**
+     * ChamiloPens
+     * 
+     * This file provides the ChamiloPens class
+     * 
+     * @author Guillaume Viguier-Just <guillaume@viguierjust.com>
+     * @licence http://www.gnu.org/licenses/gpl.txt
+     */
 
 require_once __DIR__ . '/../../main/inc/global.inc.php';
 require_once __DIR__ . '/lib/pens.php';
@@ -37,212 +37,212 @@ 
  * @licence http://www.gnu.org/licenses/gpl.txt
  */
 class ChamiloPens extends Plugin {
-	/**
-	 * Database table to be used
-	 */
-	const TABLE_NAME = "plugin_pens";
-	
-	/**
-	 * Id of the object
-	 * @var int
-	 */
-	protected $_id = null;
-	
-	/**
-	 * PENS Version to be used. Currently, the only valid value is 1.0.0. Required.
-	 * @var string
-	 */
-	protected $_pens_version = null;
-	
-	/**
-	 * Package type being used. The only valid values are aicc-pkg, scorm-pif, ims-qti. Required
-	 * @var string
-	 */
-	protected $_package_type = null;
-	
-	/**
-	 * Package type version. Required
-	 * @var string
-	 */
-	protected $_package_type_version = null;
-	
-	/**
-	 * Package format. The only valid values are zip, url, jar, war and xml. Required
-	 * @var string
-	 */
-	protected $_package_format = null;
-	
-	/**
-	 * Package id. Requires a valid URI according to RFC 2396. Required
-	 * @var string
-	 */
-	protected $_package_id = null;
-	
-	/**
-	 * Name or ID for client submitting the content package to the target system. Required.
-	 * @var string
-	 */
-	protected $_client = null;
-	
-	/**
-	 * Unstructured character string that may be used to transfer vendor-specific data such as processing hints or deployment information. Optional.
-	 * @var string
-	 */
-	protected $_vendor_data = null;
-	
-	/**
-	 * Package name
-	 * @var string
-	 */
-	protected $_package_name = null;
-	
-	/**
-	 * Date of creation
-	 * @var DateTime
-	 */
-	protected $_created_at = null;
-	
-	/**
-	 * Update date
-	 * @var DateTime
-	 */
-	protected $_updated_at = null;
-	
-	/**
-	 * Constructor. Takes a PENSRequest as an argument
-	 * 
-	 * @param PENSRequest Request
-	 */
-	public function __construct($request) {
-		if($request instanceof PENSRequest) {
-			$this->_id = 0;
-			$this->_pens_version = $request->getPensVersion();
-			$this->_package_type = $request->getPackageType();
-			$this->_package_type_version = $request->getPackageTypeVersion();
-			$this->_package_format = $request->getPackageFormat();
-			$this->_package_id = $request->getPackageId();
-			$this->_client = $request->getClient();
-			$this->_vendor_data = $request->getVendorData();
-			$this->_package_name = $request->getFilename();
-		} else if(is_array($request)) {
-			$this->_id = $request['id'];
-			$this->_pens_version = $request['pens_version'];
-			$this->_package_type = $request['package_type'];
-			$this->_package_type_version = $request['package_type_version'];
-			$this->_package_format = $request['package_format'];
-			$this->_package_id = $request['package_id'];
-			$this->_client = $request['client'];
-			$this->_vendor_data = $request['vendor_data'];
-			$this->_package_name = $request['package_name'];
-			$this->_created_at = new DateTime($request['created_at'], new DateTimeZone('UTC'));
-			if(!empty($request['updated_at'])) {
-				$this->_updated_at = new DateTime($request['updated_at'], new DateTimeZone('UTC'));
-			}
-		}
-	}
-	
-	/**
-	 * Saves the object in the DB
-	 */
-	public function save() {
-		$clean_package_type_version = Database::escape_string($this->_package_type_version);
-		$clean_package_id = Database::escape_string($this->_package_id);
-		$clean_client = Database::escape_string($this->_client);
-		$clean_vendor_data = Database::escape_string($this->_vendor_data);
-		$created_at = api_get_utc_datetime();
-		$table = Database::get_main_table(ChamiloPens::TABLE_NAME);
-		$sql_query = "INSERT INTO $table (pens_version, package_type, package_type_version, package_format, package_id, client, vendor_data, package_name, created_at) VALUES (" .
-			"'". $this->_pens_version. "', " .
-			"'".$this->_package_type. "', " .
-			"'".$clean_package_type_version. "', " .
-			"'".$this->_package_format. "', " .
-			"'".$clean_package_id. "', " .
-			"'".$clean_client."', " .
-			"'".$clean_vendor_data."', " .
-			"'".$this->_package_name."', " .
-			"'".$created_at."') ON DUPLICATE KEY UPDATE " .
-			"pens_version = VALUES(pens_version), ".
-			"package_type = VALUES(package_type), ".
-			"package_type_version = VALUES(package_type_version), ".
-			"package_format = VALUES(package_format), ".
-			"client = VALUES(client), ".
-			"vendor_data = VALUES(vendor_data), ".
-			"package_name = VALUES(package_name), ".
-			"updated_at = '".$created_at."';";
-		Database::query($sql_query);
-	}
-	
-	/**
-	 * Returns a ChamiloPens object, based on package id
-	 * 
-	 * @param string Package id
-	 */
-	public static function findByPackageId($package_id) {
-		$table = Database::get_main_table(ChamiloPens::TABLE_NAME);
-		$sql_query = "SELECT * FROM $table WHERE package_id = '".$package_id."';";
-		$results = Database::query($sql_query);
-		$number = Database::num_rows($results);
-		if($number == 1) {
-			$obj = Database::fetch_assoc($results);
-			return new ChamiloPens($obj);
-		} else {
-			return null;
-		}
-	}
-	
-	/**
-	 * Returns an array of all the objects of the DB
-	 * 
-	 * @return array Array of ChamiloPens objects
-	 */
-	public static function findAll() {
-		$table = Database::get_main_table(ChamiloPens::TABLE_NAME);
-		$sql_query = "SELECT * FROM $table ORDER BY created_at;";
-		$results = Database::query($sql_query);
-		$return = array();
-		while($assoc = Database::fetch_assoc($results)) {
-			$return[] = new ChamiloPens($assoc);
-		}
-		return $return;
-	}
-	
-	public function getId() {
-		return $this->_id;
-	}
-	
-	public function getPensVersion() {
-		return $this->_pens_version;
-	}
-	
-	public function getPackageType() {
-		return $this->_package_type;
-	}
-	
-	public function getPackageTypeVersion() {
-		return $this->_package_type_version;
-	}
-	
-	public function getPackageFormat() {
-		return $this->_package_format;
-	}
-	
-	public function getPackageId() {
-		return $this->_package_id;
-	}
-	
-	public function getClient() {
-		return $this->_client;
-	}
-	
-	public function getVendorData() {
-		return $this->_vendor_data;
-	}
-	
-	public function getPackageName() {
-		return $this->_package_name;
-	}
-	
-	public function getCreatedAt() {
-		return $this->_created_at;
-	}
+    /**
+     * Database table to be used
+     */
+    const TABLE_NAME = "plugin_pens";
+	
+    /**
+     * Id of the object
+     * @var int
+     */
+    protected $_id = null;
+	
+    /**
+     * PENS Version to be used. Currently, the only valid value is 1.0.0. Required.
+     * @var string
+     */
+    protected $_pens_version = null;
+	
+    /**
+     * Package type being used. The only valid values are aicc-pkg, scorm-pif, ims-qti. Required
+     * @var string
+     */
+    protected $_package_type = null;
+	
+    /**
+     * Package type version. Required
+     * @var string
+     */
+    protected $_package_type_version = null;
+	
+    /**
+     * Package format. The only valid values are zip, url, jar, war and xml. Required
+     * @var string
+     */
+    protected $_package_format = null;
+	
+    /**
+     * Package id. Requires a valid URI according to RFC 2396. Required
+     * @var string
+     */
+    protected $_package_id = null;
+	
+    /**
+     * Name or ID for client submitting the content package to the target system. Required.
+     * @var string
+     */
+    protected $_client = null;
+	
+    /**
+     * Unstructured character string that may be used to transfer vendor-specific data such as processing hints or deployment information. Optional.
+     * @var string
+     */
+    protected $_vendor_data = null;
+	
+    /**
+     * Package name
+     * @var string
+     */
+    protected $_package_name = null;
+	
+    /**
+     * Date of creation
+     * @var DateTime
+     */
+    protected $_created_at = null;
+	
+    /**
+     * Update date
+     * @var DateTime
+     */
+    protected $_updated_at = null;
+	
+    /**
+     * Constructor. Takes a PENSRequest as an argument
+     * 
+     * @param PENSRequest Request
+     */
+    public function __construct($request) {
+        if($request instanceof PENSRequest) {
+            $this->_id = 0;
+            $this->_pens_version = $request->getPensVersion();
+            $this->_package_type = $request->getPackageType();
+            $this->_package_type_version = $request->getPackageTypeVersion();
+            $this->_package_format = $request->getPackageFormat();
+            $this->_package_id = $request->getPackageId();
+            $this->_client = $request->getClient();
+            $this->_vendor_data = $request->getVendorData();
+            $this->_package_name = $request->getFilename();
+        } else if(is_array($request)) {
+            $this->_id = $request['id'];
+            $this->_pens_version = $request['pens_version'];
+            $this->_package_type = $request['package_type'];
+            $this->_package_type_version = $request['package_type_version'];
+            $this->_package_format = $request['package_format'];
+            $this->_package_id = $request['package_id'];
+            $this->_client = $request['client'];
+            $this->_vendor_data = $request['vendor_data'];
+            $this->_package_name = $request['package_name'];
+            $this->_created_at = new DateTime($request['created_at'], new DateTimeZone('UTC'));
+            if(!empty($request['updated_at'])) {
+                $this->_updated_at = new DateTime($request['updated_at'], new DateTimeZone('UTC'));
+            }
+        }
+    }
+	
+    /**
+     * Saves the object in the DB
+     */
+    public function save() {
+        $clean_package_type_version = Database::escape_string($this->_package_type_version);
+        $clean_package_id = Database::escape_string($this->_package_id);
+        $clean_client = Database::escape_string($this->_client);
+        $clean_vendor_data = Database::escape_string($this->_vendor_data);
+        $created_at = api_get_utc_datetime();
+        $table = Database::get_main_table(ChamiloPens::TABLE_NAME);
+        $sql_query = "INSERT INTO $table (pens_version, package_type, package_type_version, package_format, package_id, client, vendor_data, package_name, created_at) VALUES (" .
+            "'". $this->_pens_version. "', " .
+            "'".$this->_package_type. "', " .
+            "'".$clean_package_type_version. "', " .
+            "'".$this->_package_format. "', " .
+            "'".$clean_package_id. "', " .
+            "'".$clean_client."', " .
+            "'".$clean_vendor_data."', " .
+            "'".$this->_package_name."', " .
+            "'".$created_at."') ON DUPLICATE KEY UPDATE " .
+            "pens_version = VALUES(pens_version), ".
+            "package_type = VALUES(package_type), ".
+            "package_type_version = VALUES(package_type_version), ".
+            "package_format = VALUES(package_format), ".
+            "client = VALUES(client), ".
+            "vendor_data = VALUES(vendor_data), ".
+            "package_name = VALUES(package_name), ".
+            "updated_at = '".$created_at."';";
+        Database::query($sql_query);
+    }
+	
+    /**
+     * Returns a ChamiloPens object, based on package id
+     * 
+     * @param string Package id
+     */
+    public static function findByPackageId($package_id) {
+        $table = Database::get_main_table(ChamiloPens::TABLE_NAME);
+        $sql_query = "SELECT * FROM $table WHERE package_id = '".$package_id."';";
+        $results = Database::query($sql_query);
+        $number = Database::num_rows($results);
+        if($number == 1) {
+            $obj = Database::fetch_assoc($results);
+            return new ChamiloPens($obj);
+        } else {
+            return null;
+        }
+    }
+	
+    /**
+     * Returns an array of all the objects of the DB
+     * 
+     * @return array Array of ChamiloPens objects
+     */
+    public static function findAll() {
+        $table = Database::get_main_table(ChamiloPens::TABLE_NAME);
+        $sql_query = "SELECT * FROM $table ORDER BY created_at;";
+        $results = Database::query($sql_query);
+        $return = array();
+        while($assoc = Database::fetch_assoc($results)) {
+            $return[] = new ChamiloPens($assoc);
+        }
+        return $return;
+    }
+	
+    public function getId() {
+        return $this->_id;
+    }
+	
+    public function getPensVersion() {
+        return $this->_pens_version;
+    }
+	
+    public function getPackageType() {
+        return $this->_package_type;
+    }
+	
+    public function getPackageTypeVersion() {
+        return $this->_package_type_version;
+    }
+	
+    public function getPackageFormat() {
+        return $this->_package_format;
+    }
+	
+    public function getPackageId() {
+        return $this->_package_id;
+    }
+	
+    public function getClient() {
+        return $this->_client;
+    }
+	
+    public function getVendorData() {
+        return $this->_vendor_data;
+    }
+	
+    public function getPackageName() {
+        return $this->_package_name;
+    }
+	
+    public function getCreatedAt() {
+        return $this->_created_at;
+    }
 }

plugin/pens/lib/pens/pens_request_alert.php

Indentation +4 added lines, -4 removed lines

@@ -40,9 +40,9 @@
 
 class PENSRequestAlert extends PENSRequest {
 	
-	public function __construct($arguments) {
-		parent::__construct($arguments);
-		$this->setCommand("alert");
-	}
+    public function __construct($arguments) {
+        parent::__construct($arguments);
+        $this->setCommand("alert");
+    }
 
 }

plugin/pens/lib/pens/pens_controller.php

Indentation +27 added lines, -27 removed lines

@@ -16,15 +16,15 @@ 
  * along with php-pens.  If not, see <http://www.gnu.org/licenses/>.
  */
  
- /**
- * PENSController
- * 
- * Provides the PENSController class
- * 
- * @package PENS
- * @author Guillaume Viguier-Just <guillaume@viguierjust.com>
- * @licence http://www.gnu.org/licenses/gpl.txt
- */
+    /**
+     * PENSController
+     * 
+     * Provides the PENSController class
+     * 
+     * @package PENS
+     * @author Guillaume Viguier-Just <guillaume@viguierjust.com>
+     * @licence http://www.gnu.org/licenses/gpl.txt
+     */
 
 require_once(dirname(__FILE__)."/pens_request_factory.php");
 
@@ -39,24 +39,24 @@ 
  */
 abstract class PENSController {
 	
-	/**
-	 * Parses a request based on the values present in $_REQUEST
-	 * 
-	 * @return PENSRequest Request generated
-	 * @throws PENSException if the request could not be parsed
-	 */
-	protected function parseRequest() {
-		$request = PENSRequestFactory::createPENSRequest($_REQUEST);
-		return $request;
-	}
+    /**
+     * Parses a request based on the values present in $_REQUEST
+     * 
+     * @return PENSRequest Request generated
+     * @throws PENSException if the request could not be parsed
+     */
+    protected function parseRequest() {
+        $request = PENSRequestFactory::createPENSRequest($_REQUEST);
+        return $request;
+    }
 	
-	/**
-	 * Sends the HTTP Response to the client
-	 * 
-	 * @param PENSResponse Response to be sent
-	 */
-	protected function sendResponse($response) {
-		$response->send();
-	}
+    /**
+     * Sends the HTTP Response to the client
+     * 
+     * @param PENSResponse Response to be sent
+     */
+    protected function sendResponse($response) {
+        $response->send();
+    }
 	
 }

plugin/pens/lib/pens/pens_client.php

Indentation +73 added lines, -73 removed lines

@@ -16,15 +16,15 @@ 
  * along with php-pens.  If not, see <http://www.gnu.org/licenses/>.
  */
  
- /**
- * PENSClient
- * 
- * Provides the PENSClient class
- * 
- * @package PENS
- * @author Guillaume Viguier-Just <guillaume@viguierjust.com>
- * @licence http://www.gnu.org/licenses/gpl.txt
- */
+    /**
+     * PENSClient
+     * 
+     * Provides the PENSClient class
+     * 
+     * @package PENS
+     * @author Guillaume Viguier-Just <guillaume@viguierjust.com>
+     * @licence http://www.gnu.org/licenses/gpl.txt
+     */
  
 require_once(dirname(__FILE__)."/pens_controller.php");
 require_once(dirname(__FILE__)."/pens_request_handler.php");
@@ -39,75 +39,75 @@ 
  * @licence http://www.gnu.org/licenses/gpl.txt
  */
 class PENSClient extends PENSController {
-	/**
-	 * Instance of the PENSClient
-	 * @var PENSServer
-	 */
-	private static $_instance;
+    /**
+     * Instance of the PENSClient
+     * @var PENSServer
+     */
+    private static $_instance;
 	
-	/**
-	 * Request handler
-	 * @var PENSRequestHandler
-	 */
-	protected $_request_handler = null;
+    /**
+     * Request handler
+     * @var PENSRequestHandler
+     */
+    protected $_request_handler = null;
 	
-	/**
-	 * Private constructor
-	 */
-	private function __construct() {
-	}
+    /**
+     * Private constructor
+     */
+    private function __construct() {
+    }
 	
-	/**
-	 * Singleton method
-	 */
-	public static function singleton() {
-		if(!isset(self::$_instance)) {
-			$c = __CLASS__;
-			self::$_instance = new $c;
-		}
-		return self::$_instance;
-	}
+    /**
+     * Singleton method
+     */
+    public static function singleton() {
+        if(!isset(self::$_instance)) {
+            $c = __CLASS__;
+            self::$_instance = new $c;
+        }
+        return self::$_instance;
+    }
 	
-	/**
-	 * Prevent users to clone the instance
-	 */
-	public function __clone() {
-		trigger_error('Clone is not allowed', E_USER_ERROR);
-	}
+    /**
+     * Prevent users to clone the instance
+     */
+    public function __clone() {
+        trigger_error('Clone is not allowed', E_USER_ERROR);
+    }
 	
-	public function getRequestHandler() {
-		return $this->_request_handler;
-	}
+    public function getRequestHandler() {
+        return $this->_request_handler;
+    }
 	
-	/**
-	 * Sets the request handler. Does nothing if the argument is not an instance of PENSRequestHandler
-	 * 
-	 * @param PENSRequestHandler Request handler
-	 */
-	public function setRequestHandler($request_handler) {
-		if($request_handler instanceof PENSRequestHandler) {
-			$this->_request_handler = $request_handler;
-		}
-	}
+    /**
+     * Sets the request handler. Does nothing if the argument is not an instance of PENSRequestHandler
+     * 
+     * @param PENSRequestHandler Request handler
+     */
+    public function setRequestHandler($request_handler) {
+        if($request_handler instanceof PENSRequestHandler) {
+            $this->_request_handler = $request_handler;
+        }
+    }
 	
-	/**
-	 * Receives a request, calls the handler and displays the response
-	 */
-	public function receiveRequest() {
-		$request = null;
-		try {
-			$request = $this->parseRequest();
-			$command = $request->getCommand();
-			if($command == "alert" || $command == "receipt") {
-				if(!is_null($this->_request_handler)) {
-					// Call the handler
-					$this->_request_handler->processRequest($request, new PENSResponse($_REQUEST));
-				}
-				$this->sendResponse(new PENSResponse(0, $command." received and understood"));
-			}
-		} catch(PENSException $e) {
-			// If we could not parse the request, send the error
-			$this->sendResponse(new PENSResponse($e));
-		}
-	}
+    /**
+     * Receives a request, calls the handler and displays the response
+     */
+    public function receiveRequest() {
+        $request = null;
+        try {
+            $request = $this->parseRequest();
+            $command = $request->getCommand();
+            if($command == "alert" || $command == "receipt") {
+                if(!is_null($this->_request_handler)) {
+                    // Call the handler
+                    $this->_request_handler->processRequest($request, new PENSResponse($_REQUEST));
+                }
+                $this->sendResponse(new PENSResponse(0, $command." received and understood"));
+            }
+        } catch(PENSException $e) {
+            // If we could not parse the request, send the error
+            $this->sendResponse(new PENSResponse($e));
+        }
+    }
 }

plugin/pens/lib/pens/pens_request_collect.php

Indentation +4 added lines, -4 removed lines

@@ -40,9 +40,9 @@
 
 class PENSRequestCollect extends PENSRequest {
 	
-	public function __construct($arguments) {
-		parent::__construct($arguments);
-		$this->setCommand("collect");
-	}
+    public function __construct($arguments) {
+        parent::__construct($arguments);
+        $this->setCommand("collect");
+    }
 
 }

plugin/pens/lib/pens/pens_package_handler.php

Indentation +73 added lines, -73 removed lines

@@ -16,15 +16,15 @@ 
  * along with php-pens.  If not, see <http://www.gnu.org/licenses/>.
  */
  
- /**
- * PENSPackageHandler
- * 
- * Provides the PENSPackageHandler abstract class
- * 
- * @package PENS
- * @author Guillaume Viguier-Just <guillaume@viguierjust.com>
- * @licence http://www.gnu.org/licenses/gpl.txt
- */
+    /**
+     * PENSPackageHandler
+     * 
+     * Provides the PENSPackageHandler abstract class
+     * 
+     * @package PENS
+     * @author Guillaume Viguier-Just <guillaume@viguierjust.com>
+     * @licence http://www.gnu.org/licenses/gpl.txt
+     */
 
 require_once(dirname(__FILE__)."/pens_config.php");
 
@@ -39,76 +39,76 @@ 
  * @licence http://www.gnu.org/licenses/gpl.txt
  */
 abstract class PENSPackageHandler {
-	/**
-	 * Array of supported package types for this handler. Set by default to PENSConfig::$allowed_package_types
-	 * @var array
-	 */
-	protected $_supported_package_types = null;
+    /**
+     * Array of supported package types for this handler. Set by default to PENSConfig::$allowed_package_types
+     * @var array
+     */
+    protected $_supported_package_types = null;
 	
-	/**
-	 * Array of supported package formats for this handler. Set by default to PENSConfig::$allowed_package_formats
-	 * @var array
-	 */
-	protected $_supported_package_formats = null;
+    /**
+     * Array of supported package formats for this handler. Set by default to PENSConfig::$allowed_package_formats
+     * @var array
+     */
+    protected $_supported_package_formats = null;
 	
-	/**
-	 * Constructor. Sets the default values of supported_package_types and supported_package_formats
-	 */
-	public function __construct() {
-		$this->_supported_package_types = PENSConfig::$allowed_package_types;
-		$this->_supported_package_formats = PENSConfig::$allowed_package_formats;
-	}
+    /**
+     * Constructor. Sets the default values of supported_package_types and supported_package_formats
+     */
+    public function __construct() {
+        $this->_supported_package_types = PENSConfig::$allowed_package_types;
+        $this->_supported_package_formats = PENSConfig::$allowed_package_formats;
+    }
 	
-	public function getSupportedPackageTypes() {
-		return $this->_supported_package_types;
-	}
+    public function getSupportedPackageTypes() {
+        return $this->_supported_package_types;
+    }
 	
-	/**
-	 * Sets the supported package types. All package types in the array provided as an argument
-	 * not present in PENSConfig::$allowed_package_types will be ignored. The supported_package_types
-	 * will be set to null if the argument given is not an array
-	 * 
-	 * @param array Supported package types
-	 */
-	public function setSupportedPackageTypes($supported_package_types) {
-		$this->_supported_package_types = null;
-		if(is_array($supported_package_types)) {
-			foreach($supported_package_types as $package_type) {
-				if(in_array($package_type, PENSConfig::$allowed_package_types)) {
-					$this->_supported_package_types[] = $package_type;
-				}
-			}
-		}
-	}
+    /**
+     * Sets the supported package types. All package types in the array provided as an argument
+     * not present in PENSConfig::$allowed_package_types will be ignored. The supported_package_types
+     * will be set to null if the argument given is not an array
+     * 
+     * @param array Supported package types
+     */
+    public function setSupportedPackageTypes($supported_package_types) {
+        $this->_supported_package_types = null;
+        if(is_array($supported_package_types)) {
+            foreach($supported_package_types as $package_type) {
+                if(in_array($package_type, PENSConfig::$allowed_package_types)) {
+                    $this->_supported_package_types[] = $package_type;
+                }
+            }
+        }
+    }
 	
-	public function getSupportedPackageFormats() {
-		return $this->_supported_package_formats;
-	}
+    public function getSupportedPackageFormats() {
+        return $this->_supported_package_formats;
+    }
 	
-	/**
-	 * Sets the supported package formats. All package types in the array provided as an argument
-	 * not present in PENSConfig::$allowed_package_formats will be ignored. The supported_package_formats
-	 * will be set to null if the argument given is not an array.
-	 * 
-	 * @param array Supported package formats
-	 */
-	public function setSupportedPackageFormats($supported_package_formats) {
-		$this->_supported_package_formats = null;
-		if(is_array($supported_package_formats)) {
-			foreach($supported_package_formats as $package_format) {
-				if(in_array($package_format, PENSConfig::$allowed_package_formats)) {
-					$this->_supported_package_formats[] = $package_format;
-				}
-			}
-		}
-	}
+    /**
+     * Sets the supported package formats. All package types in the array provided as an argument
+     * not present in PENSConfig::$allowed_package_formats will be ignored. The supported_package_formats
+     * will be set to null if the argument given is not an array.
+     * 
+     * @param array Supported package formats
+     */
+    public function setSupportedPackageFormats($supported_package_formats) {
+        $this->_supported_package_formats = null;
+        if(is_array($supported_package_formats)) {
+            foreach($supported_package_formats as $package_format) {
+                if(in_array($package_format, PENSConfig::$allowed_package_formats)) {
+                    $this->_supported_package_formats[] = $package_format;
+                }
+            }
+        }
+    }
 	
-	/**
-	 * Processes the package. Must be implemented by subclasses
-	 * 
-	 * @param PENSRequestCollect Collect request sent by the client
-	 * @param string Path to the collected package on the hard drive
-	 */
-	abstract public function processPackage($request, $path_to_package);
+    /**
+     * Processes the package. Must be implemented by subclasses
+     * 
+     * @param PENSRequestCollect Collect request sent by the client
+     * @param string Path to the collected package on the hard drive
+     */
+    abstract public function processPackage($request, $path_to_package);
 	
 }

plugin/pens/lib/pens/pens_request_handler.php

Indentation +16 added lines, -16 removed lines

@@ -16,15 +16,15 @@ 
  * along with php-pens.  If not, see <http://www.gnu.org/licenses/>.
  */
  
- /**
- * PENSRequestHandler
- * 
- * Provides the PENSRequestHandler abstract class
- * 
- * @package PENS
- * @author Guillaume Viguier-Just <guillaume@viguierjust.com>
- * @licence http://www.gnu.org/licenses/gpl.txt
- */
+    /**
+     * PENSRequestHandler
+     * 
+     * Provides the PENSRequestHandler abstract class
+     * 
+     * @package PENS
+     * @author Guillaume Viguier-Just <guillaume@viguierjust.com>
+     * @licence http://www.gnu.org/licenses/gpl.txt
+     */
 
 /**
  * PENSRequestHandler
@@ -37,12 +37,12 @@ 
  * @licence http://www.gnu.org/licenses/gpl.txt
  */
 abstract class PENSRequestHandler {
-	/**
-	 * Processes the request. Must be implemented by subclasses
-	 * 
-	 * @param PENSRequest Alert or Receipt request sent by the server
-	 * @param PENSResponse Response sent by the server (error, error-text etc...)
-	 */
-	abstract public function processRequest($request, $response);
+    /**
+     * Processes the request. Must be implemented by subclasses
+     * 
+     * @param PENSRequest Alert or Receipt request sent by the server
+     * @param PENSResponse Response sent by the server (error, error-text etc...)
+     */
+    abstract public function processRequest($request, $response);
 }
 

plugin/pens/lib/pens/pens_request_receipt.php

Indentation +4 added lines, -4 removed lines

@@ -40,9 +40,9 @@
 
 class PENSRequestReceipt extends PENSRequest {
 	
-	public function __construct($arguments) {
-		parent::__construct($arguments);
-		$this->setCommand("receipt");
-	}
+    public function __construct($arguments) {
+        parent::__construct($arguments);
+        $this->setCommand("receipt");
+    }
 
 }

plugin/pens/lib/pens/pens_server.php

Indentation +260 added lines, -260 removed lines

@@ -16,15 +16,15 @@ 
  * along with php-pens.  If not, see <http://www.gnu.org/licenses/>.
  */
  
- /**
- * PENSServer
- * 
- * Provides the PENSServer class
- * 
- * @package PENS
- * @author Guillaume Viguier-Just <guillaume@viguierjust.com>
- * @licence http://www.gnu.org/licenses/gpl.txt
- */
+    /**
+     * PENSServer
+     * 
+     * Provides the PENSServer class
+     * 
+     * @package PENS
+     * @author Guillaume Viguier-Just <guillaume@viguierjust.com>
+     * @licence http://www.gnu.org/licenses/gpl.txt
+     */
 
 require_once __DIR__ . '/pens_controller.php';
 require_once __DIR__ . '/pens_package_handler.php';
@@ -42,272 +42,272 @@ 
  */
 class PENSServer extends PENSController {
 
-	/**
-	 * Instance of the PENSServer
-	 * @var PENSServer
-	 */
-	private static $_instance;
+    /**
+     * Instance of the PENSServer
+     * @var PENSServer
+     */
+    private static $_instance;
 	
-	/**
-	 * Package handler
-	 * @var PENSPackageHandler
-	 */
-	protected $_package_handler = null;
+    /**
+     * Package handler
+     * @var PENSPackageHandler
+     */
+    protected $_package_handler = null;
 	
-	/**
-	 * Private constructor
-	 */
-	private function __construct() {
-	}
+    /**
+     * Private constructor
+     */
+    private function __construct() {
+    }
 	
-	/**
-	 * Singleton method
-	 */
-	public static function singleton() {
-		if(!isset(self::$_instance)) {
-			$c = __CLASS__;
-			self::$_instance = new $c;
-		}
-		return self::$_instance;
-	}
+    /**
+     * Singleton method
+     */
+    public static function singleton() {
+        if(!isset(self::$_instance)) {
+            $c = __CLASS__;
+            self::$_instance = new $c;
+        }
+        return self::$_instance;
+    }
 	
-	/**
-	 * Prevent users to clone the instance
-	 */
-	public function __clone() {
-		trigger_error('Clone is not allowed', E_USER_ERROR);
-	}
+    /**
+     * Prevent users to clone the instance
+     */
+    public function __clone() {
+        trigger_error('Clone is not allowed', E_USER_ERROR);
+    }
 	
-	public function getPackageHandler() {
-		return $this->_package_handler;
-	}
+    public function getPackageHandler() {
+        return $this->_package_handler;
+    }
 	
-	/**
-	 * Sets the package handler. Does nothing if the argument is not an instance of PENSPackageHandler
-	 * 
-	 * @param PENSPackageHandler Package handler
-	 */
-	public function setPackageHandler($package_handler) {
-		if($package_handler instanceof PENSPackageHandler) {
-			$this->_package_handler = $package_handler;
-		}
-	}
+    /**
+     * Sets the package handler. Does nothing if the argument is not an instance of PENSPackageHandler
+     * 
+     * @param PENSPackageHandler Package handler
+     */
+    public function setPackageHandler($package_handler) {
+        if($package_handler instanceof PENSPackageHandler) {
+            $this->_package_handler = $package_handler;
+        }
+    }
 	
-	/**
-	 * Receives a collect request and treats it
-	 */
-	public function receiveCollect() {
-		$request = null;
-		try {
-			// First, try to parse the request
-			$request = $this->parseRequest();
-			if($request->getCommand() == "collect") {
-				if(isset($_REQUEST['process'])) {
-					// Collect the package and process it
-					$receipt = null;
-					$path_to_package = null;
-					try {
-						// Collect the package
-						$path_to_package = $this->collectPackage($request);
-						$receipt = new PENSResponse(0, "package successfully collected");
-					} catch(PENSException $e) {
-						$receipt = new PENSResponse($e);
-					}
-					// Send receipt
-					$response = $this->sendReceipt($request, $receipt);
-					if(!is_null($response) && !is_null($path_to_package)) {
-						if($response->getError() === 0) {
-							// Process package
-							$this->processPackage($request, $path_to_package);
-						}
-						unlink($path_to_package);
-					}
-				} else {
-					// Then, send a success response to the client
-					$this->sendResponse(new PENSResponse(0, "collect command received and understood"));
-					// Send a request to process the package: fake multithreading
-					$params = $_REQUEST;
-					$params['process'] = 1;
-					$scheme = "http";
-					if(!empty($_SERVER['HTTPS'])) {
-						$scheme = "https";
-					}
-					$ch = curl_init();
-					curl_setopt($ch, CURLOPT_URL, $scheme."://".$_SERVER['HTTP_HOST'].$_SERVER['REQUEST_URI']);
-					curl_setopt($ch, CURLOPT_POSTFIELDS, $params);
-					curl_setopt($ch, CURLOPT_TIMEOUT, 1);
-					curl_exec($ch);
-					curl_close($ch);
-				}
-			}
+    /**
+     * Receives a collect request and treats it
+     */
+    public function receiveCollect() {
+        $request = null;
+        try {
+            // First, try to parse the request
+            $request = $this->parseRequest();
+            if($request->getCommand() == "collect") {
+                if(isset($_REQUEST['process'])) {
+                    // Collect the package and process it
+                    $receipt = null;
+                    $path_to_package = null;
+                    try {
+                        // Collect the package
+                        $path_to_package = $this->collectPackage($request);
+                        $receipt = new PENSResponse(0, "package successfully collected");
+                    } catch(PENSException $e) {
+                        $receipt = new PENSResponse($e);
+                    }
+                    // Send receipt
+                    $response = $this->sendReceipt($request, $receipt);
+                    if(!is_null($response) && !is_null($path_to_package)) {
+                        if($response->getError() === 0) {
+                            // Process package
+                            $this->processPackage($request, $path_to_package);
+                        }
+                        unlink($path_to_package);
+                    }
+                } else {
+                    // Then, send a success response to the client
+                    $this->sendResponse(new PENSResponse(0, "collect command received and understood"));
+                    // Send a request to process the package: fake multithreading
+                    $params = $_REQUEST;
+                    $params['process'] = 1;
+                    $scheme = "http";
+                    if(!empty($_SERVER['HTTPS'])) {
+                        $scheme = "https";
+                    }
+                    $ch = curl_init();
+                    curl_setopt($ch, CURLOPT_URL, $scheme."://".$_SERVER['HTTP_HOST'].$_SERVER['REQUEST_URI']);
+                    curl_setopt($ch, CURLOPT_POSTFIELDS, $params);
+                    curl_setopt($ch, CURLOPT_TIMEOUT, 1);
+                    curl_exec($ch);
+                    curl_close($ch);
+                }
+            }
 				
-		} catch(PENSException $e) {
-			// If we could not parse the request, send the error back to the client
-			$this->sendResponse(new PENSResponse($e));
-		}
-	}
+        } catch(PENSException $e) {
+            // If we could not parse the request, send the error back to the client
+            $this->sendResponse(new PENSResponse($e));
+        }
+    }
 	
-	/**
-	 * Collects the package onto the local server
-	 * 
-	 * @param PENSRequest request
-	 * @return string Path to the package on the hard drive
-	 * @throws PENSException if an exception occured
-	 */
-	protected function collectPackage($request) {
-		$supported_package_types = $this->_package_handler->getSupportedPackageTypes();
-		if(!in_array($request->getPackageType(), $supported_package_types)) {
-			throw new PENSException(1430);
-		}
-		$supported_package_formats = $this->_package_handler->getSupportedPackageFormats();
-		if(!in_array($request->getPackageFormat(), $supported_package_formats)) {
-			throw new PENSException(1431);
-		}
-		if(!$this->isExpiryDateValid($request->getPackageUrlExpiry())) {
-			throw new PENSException(1322);
-		}
+    /**
+     * Collects the package onto the local server
+     * 
+     * @param PENSRequest request
+     * @return string Path to the package on the hard drive
+     * @throws PENSException if an exception occured
+     */
+    protected function collectPackage($request) {
+        $supported_package_types = $this->_package_handler->getSupportedPackageTypes();
+        if(!in_array($request->getPackageType(), $supported_package_types)) {
+            throw new PENSException(1430);
+        }
+        $supported_package_formats = $this->_package_handler->getSupportedPackageFormats();
+        if(!in_array($request->getPackageFormat(), $supported_package_formats)) {
+            throw new PENSException(1431);
+        }
+        if(!$this->isExpiryDateValid($request->getPackageUrlExpiry())) {
+            throw new PENSException(1322);
+        }
 		
-		// Try to download the package in the temporary directory
-		$tmp = null;
-		if(function_exists("sys_get_temp_dir")) {
-			$tmp = sys_get_temp_dir();
-		} else {
-			$tmp = "/tmp";
-		}
-		$path_to_file = $tmp."/".$request->getFilename();
-		$fp = fopen($path_to_file, 'w');
-		$ch = curl_init();
-		curl_setopt($ch, CURLOPT_URL, $request->getPackageUrl());
-		curl_setopt($ch, CURLOPT_HEADER, false);	
-		curl_setopt($ch, CURLOPT_FILE, $fp);
-		if(!is_null($request->getPackageUrlUserId())) {
-			curl_setopt($ch, CURLOPT_USERPWD, $request->getPackageUrlUserId().":".$request->getPackageUrlPassword());
-		}
-		if(curl_exec($ch) === false) {
-			$errno = curl_errno($ch);
-			curl_close($ch);
-			// Error occured. Throw an exception
-			switch($errno) {
-				case CURLE_UNSUPPORTED_PROTOCOL:
-					throw new PENSException(1301);
-					break;
-				case CURLE_URL_MALFORMAT:
-				case CURLE_COULDNT_RESOLVE_PROXY:
-				case CURLE_COULDNT_RESOLVE_HOST:
-				case CURLE_COULDNT_CONNECT:
-				case CURLE_OPERATION_TIMEOUT:
-				case CURLE_REMOTE_FILE_NOT_FOUND:
-					throw new PENSException(1310);
-					break;
-				case CURLE_REMOTE_ACCESS_DENIED:
-					throw new PENSException(1312);
-					break;
-				default:
-					throw new PENSException(1301);
-					break;
-			}
-			return null;
+        // Try to download the package in the temporary directory
+        $tmp = null;
+        if(function_exists("sys_get_temp_dir")) {
+            $tmp = sys_get_temp_dir();
+        } else {
+            $tmp = "/tmp";
+        }
+        $path_to_file = $tmp."/".$request->getFilename();
+        $fp = fopen($path_to_file, 'w');
+        $ch = curl_init();
+        curl_setopt($ch, CURLOPT_URL, $request->getPackageUrl());
+        curl_setopt($ch, CURLOPT_HEADER, false);	
+        curl_setopt($ch, CURLOPT_FILE, $fp);
+        if(!is_null($request->getPackageUrlUserId())) {
+            curl_setopt($ch, CURLOPT_USERPWD, $request->getPackageUrlUserId().":".$request->getPackageUrlPassword());
+        }
+        if(curl_exec($ch) === false) {
+            $errno = curl_errno($ch);
+            curl_close($ch);
+            // Error occured. Throw an exception
+            switch($errno) {
+                case CURLE_UNSUPPORTED_PROTOCOL:
+                    throw new PENSException(1301);
+                    break;
+                case CURLE_URL_MALFORMAT:
+                case CURLE_COULDNT_RESOLVE_PROXY:
+                case CURLE_COULDNT_RESOLVE_HOST:
+                case CURLE_COULDNT_CONNECT:
+                case CURLE_OPERATION_TIMEOUT:
+                case CURLE_REMOTE_FILE_NOT_FOUND:
+                    throw new PENSException(1310);
+                    break;
+                case CURLE_REMOTE_ACCESS_DENIED:
+                    throw new PENSException(1312);
+                    break;
+                default:
+                    throw new PENSException(1301);
+                    break;
+            }
+            return null;
 				
-		} else {
-			curl_close($ch);
-			return $path_to_file;
-		}
-	}
+        } else {
+            curl_close($ch);
+            return $path_to_file;
+        }
+    }
 	
-	/**
-	 * Verifies that the package url is not expired
-	 * 
-	 * @param DateTime DateTime object to verify against current time
-	 */
-	protected function isExpiryDateValid($expiry) {
-		date_default_timezone_set('UTC');
-		$current_time = time();
-		$expiry_time = strtotime($expiry->format(DateTime::ISO8601));
-		if($current_time > $expiry_time) {
-			return false;
-		} else {
-			return true;
-		}
-	}
+    /**
+     * Verifies that the package url is not expired
+     * 
+     * @param DateTime DateTime object to verify against current time
+     */
+    protected function isExpiryDateValid($expiry) {
+        date_default_timezone_set('UTC');
+        $current_time = time();
+        $expiry_time = strtotime($expiry->format(DateTime::ISO8601));
+        if($current_time > $expiry_time) {
+            return false;
+        } else {
+            return true;
+        }
+    }
 	
-	/**
-	 * Sends an alert or a receipt. Called by sendReceipt and sendAlert
-	 * 
-	 * @param PENSRequest Original collect request
-	 * @param PENSResponse Reponse to send in the receipt or the alert
-	 * @param string Mode (alert | receipt)
-	 * @return PENSResponse Response
-	 */
-	protected function sendAlertOrReceipt($request, $response, $mode) {
-		if($mode == "alert") {
-			$url = $request->getAlerts();
-		} else {
-			$url = $request->getReceipt();
-		}
-		if(!empty($url)) {
-			$url_components = parse_url($url);
-			$scheme = $url_components["scheme"];
-			if($scheme == "mailto") {
-				$to = $url_components["path"];
-				if($mode == "alert") {
-					$subject = "PENS Alert for ".$request->getPackageId();
-				} else {
-					$subject = "PENS Receipt for ".$request->getPackageId();
-				}
-				$message = $response->__toString();
-				mail($to, $subject, $message);
-				return new PENSResponse(0, "");
-			} else if($scheme == "http" || $scheme == "https") {
-				if($mode == "alert") {
-					$params = array_merge($request->getSendAlertArray(), $response->getArray());
-				} else {
-					$params = array_merge($request->getSendReceiptArray(), $response->getArray());
-				}
-				$ch = curl_init($url);
-				curl_setopt($ch, CURLOPT_POST, true);
-				curl_setopt($ch, CURLOPT_POSTFIELDS, $params);
-				curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
-				$data = curl_exec($ch);
-				curl_close($ch);
-				if($data === false) {
-					return null;
-				} else {
-					return new PENSResponse($data);
-				}
-			}
-		}
-	}
+    /**
+     * Sends an alert or a receipt. Called by sendReceipt and sendAlert
+     * 
+     * @param PENSRequest Original collect request
+     * @param PENSResponse Reponse to send in the receipt or the alert
+     * @param string Mode (alert | receipt)
+     * @return PENSResponse Response
+     */
+    protected function sendAlertOrReceipt($request, $response, $mode) {
+        if($mode == "alert") {
+            $url = $request->getAlerts();
+        } else {
+            $url = $request->getReceipt();
+        }
+        if(!empty($url)) {
+            $url_components = parse_url($url);
+            $scheme = $url_components["scheme"];
+            if($scheme == "mailto") {
+                $to = $url_components["path"];
+                if($mode == "alert") {
+                    $subject = "PENS Alert for ".$request->getPackageId();
+                } else {
+                    $subject = "PENS Receipt for ".$request->getPackageId();
+                }
+                $message = $response->__toString();
+                mail($to, $subject, $message);
+                return new PENSResponse(0, "");
+            } else if($scheme == "http" || $scheme == "https") {
+                if($mode == "alert") {
+                    $params = array_merge($request->getSendAlertArray(), $response->getArray());
+                } else {
+                    $params = array_merge($request->getSendReceiptArray(), $response->getArray());
+                }
+                $ch = curl_init($url);
+                curl_setopt($ch, CURLOPT_POST, true);
+                curl_setopt($ch, CURLOPT_POSTFIELDS, $params);
+                curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
+                $data = curl_exec($ch);
+                curl_close($ch);
+                if($data === false) {
+                    return null;
+                } else {
+                    return new PENSResponse($data);
+                }
+            }
+        }
+    }
 	
-	/**
-	 * Sends a receipt. Returns a PENSResponse in case of success, null if a problem occured
-	 * 
-	 * @param PENSRequest Original collect request
-	 * @param PENSResponse Response to send in the receipt
-	 * @return PENSResponse Response
-	 */
-	protected function sendReceipt($request, $receipt) {
-		return $this->sendAlertOrReceipt($request, $receipt, "receipt");
-	}
+    /**
+     * Sends a receipt. Returns a PENSResponse in case of success, null if a problem occured
+     * 
+     * @param PENSRequest Original collect request
+     * @param PENSResponse Response to send in the receipt
+     * @return PENSResponse Response
+     */
+    protected function sendReceipt($request, $receipt) {
+        return $this->sendAlertOrReceipt($request, $receipt, "receipt");
+    }
 	
-	/**
-	 * Processes the package using the handler provided
-	 * 
-	 * @param PENSRequest Original collect request
-	 * @param string Path to the package on the hard drive
-	 */
-	protected function processPackage($request, $path_to_package) {
-		return $this->_package_handler->processPackage($request, $path_to_package);
-	}
+    /**
+     * Processes the package using the handler provided
+     * 
+     * @param PENSRequest Original collect request
+     * @param string Path to the package on the hard drive
+     */
+    protected function processPackage($request, $path_to_package) {
+        return $this->_package_handler->processPackage($request, $path_to_package);
+    }
 	
-	/**
-	 * Sends an alert to the client. Returns a PENSResponse in case of success, null if a problem occured
-	 * 
-	 * @param PENSRequest Original collect request
-	 * @param PENSResponse Response to send in the alert
-	 * @return PENSResponse Response
-	 */
-	public function sendAlert($request, $alert) {
-		return $this->sendAlertOrReceipt($request, $alert, "alert");
-	}
+    /**
+     * Sends an alert to the client. Returns a PENSResponse in case of success, null if a problem occured
+     * 
+     * @param PENSRequest Original collect request
+     * @param PENSResponse Response to send in the alert
+     * @return PENSResponse Response
+     */
+    public function sendAlert($request, $alert) {
+        return $this->sendAlertOrReceipt($request, $alert, "alert");
+    }
 	
 }