<?php
/**
 * SolidStateModule.class.php
 *
 * This file contains the definition of the SolidStateModule class.
 *
 * @package modules
 * @author John Diamond <hide@address.com>
 * @copyright John Diamond <hide@address.com>
 * @license http://www.opensource.org/licenses/gpl-license.php GNU Public License
 */

// Module DBO
require_once BASE_PATH . "DBO/ModuleDBO.class.php";

// Exceptions
class ModuleInstallFailedException extends SWModuleException {
	public function __construct( $name = "unknown module", $message = "Unkown reason" ) {
		$this->message = sprintf( "Failed to install module: %s. (%s).",
				$name,
				$message );
	}
}

/**
 * SolidStateModule
 *
 * Provides an abstract base-class for SolidState modules.
 *
 * @pacakge modules
 * @author John Diamond <hide@address.com>
 */
abstract class SolidStateModule extends Module {
	/**
	 * @var string Config Page
	 */
	protected $configPage = null;

	/**
	 * @var ModuleDBO This module's DBO
	 */
	protected $moduleDBO = null;

	/**
	 * @var string Module type (i.e: registrar, payment_gateway, etc.)
	 */
	protected $type = null;

	/**
	 * Check Enabled
	 *
	 * Cause a fatal error if the module is not enabled
	 */
	public function checkEnabled() {
		if ( !$this->isEnabled() ) {
			fatal_error( "ResellerClub::checkAvailability()",
					"The ResellerClub module is disabled." );
		}
	}

	/**
	 * Disable Module
	 */
	public function disable() {
		$this->moduleDBO->setEnabled( "No" );
		$this->updateModuleDBO();
	}

	/**
	 * Enable Module
	 */
	public function enable() {
		$this->moduleDBO->setEnabled( "Yes" );
		$this->updateModuleDBO();
	}

	/**
	 * Get Config Page
	 *
	 * @return string Name of the config page for this module
	 */
	public function getConfigPage() {
		return $this->configPage;
	}

	/**
	 * Get Module Type
	 *
	 * @return string Module type
	 */
	public function getType() {
		return $this->type;
	}

	/**
	 * Is Enabled
	 *
	 * @return boolean True if this module is enabled
	 */
	public function isEnabled() {
		return $this->moduleDBO->isEnabled();
	}

	/**
	 * Initialize Module
	 *
	 * This method is called by the configuration script when the module is
	 * loaded.
	 *
	 * @return boolean True for success
	 */
	public function init() {
		// Check if this module is installed
		try {
			$this->moduleDBO = load_ModuleDBO( $this->getName() );
		}
		catch ( DBNoRowsFoundException $e ) {
			// Install this module
			$this->install();
		}

		if ( class_exists( "SolidStateMenu", false ) ) {
			// Add this module to the menu
			$menu = SolidStateMenu::getSolidStateMenu();
			$menu->addItem( new SolidStateMenuItem( $this->getName(),
					$this->getName(),
					null,
					"manager_content.php?page=" . $this->getConfigPage() ),
					"modules" );
		}

		return true;
	}

	/**
	 * Install Module
	 *
	 * This method is called by the init() method whenever a new module
	 * is being installed.
	 */
	public function install() {
		// Create a new ModuleDBO and add it to the database
		$this->moduleDBO = new ModuleDBO();
		$this->moduleDBO->setName( $this->getName() );
		$this->moduleDBO->setEnabled( $this->isEnabled() ? "Yes" : "No" );
		$this->moduleDBO->setType( $this->getType() );
		$this->moduleDBO->setShortDescription( $this->getShortDescription() );
		$this->moduleDBO->setDescription( $this->getDescription() );
		add_ModuleDBO( $this->moduleDBO );
	}

	/**
	 * Update Module DBO
	 */
	public function updateModuleDBO() {
		update_ModuleDBO( $this->moduleDBO );
	}
}

/**
 * Remove Missing Module's from Database
 */
function removeMissingModules() {
	$modules = ModuleRegistry::getModuleRegistry()->getAllModules();
	try {
		$moduleDBOArray = load_array_ModuleDBO();
		foreach ( $moduleDBOArray as $moduleDBO ) {
			// Remove from the database any modules that are not installed anymore
			if ( !array_key_exists( $moduleDBO->getName(), $modules ) ) {
				delete_ModuleDBO( $moduleDBO );
			}
		}
	}
	catch ( DBNoRowsFoundException $e ) {

	}
}
?>