Source for file RepositoryInputOutputModuleManager.class.php

<?php
/**
 *
 * @package polyphony.repository.inputoutput
 * 
 * @copyright Copyright &copy; 2005, Middlebury College
 * @license http://www.gnu.org/copyleft/gpl.html GNU General Public License (GPL)
 *
 * @version $Id: RepositoryInputOutputModuleManager.class.php,v 1.18 2007/09/19 14:04:48 adamfranco Exp $
 */
 
/**
 * Require our necessary files
 * 
 */
require_once(dirname(__FILE__)."/modules/DataManagerPrimativesModule.class.php");
require_once(dirname(__FILE__)."/modules/HarmoniFileModule.class.php");
require_once(HARMONI."/oki2/shared/MultiIteratorIterator.class.php");
 
/**
 * The RepositoryInputOutModuleManager is responcible for sending records to the
 * appropriate RepositoryInputOutputModule based on their Schema Formats.
 * 
 * @package polyphony.repository.inputoutput
 * @version $Id: RepositoryInputOutputModuleManager.class.php,v 1.18 2007/09/19 14:04:48 adamfranco Exp $
 * @since $Date: 2007/09/19 14:04:48 $
 * @copyright 2004 Middlebury College
 */
 
class RepositoryInputOutputModuleManager {
 
    /**
     * Constructor, set up the relations of the Formats to Modules
     * 
     * @return object 
     * @access public
     * @since 10/19/04
     */
    function RepositoryInputOutputModuleManager () {
        $this->_modules = array();
        
        $type = new Type("RecordStructures", 
                    "edu.middlebury.harmoni", 
                    "DataManagerPrimatives", 
                    "RecordStructures stored in the Harmoni DataManager.");
         $this->_modules[Type::typeToString($type)] = new DataManagerPrimativesModule;
        
        $type = new Type("RecordStructures", 
                    "edu.middlebury.harmoni", 
                    "File", 
                    "RecordStructures that store files.");
         $this->_modules[Type::typeToString($type)] = new HarmoniFileModule;
         
//         $this->_modules['text/plain'] = new PlainTextModule;
    }
    
    /**
     * Assign the configuration of this Manager. Valid configuration options are as
     * follows:
     *    database_index            integer
     *    database_name            string
     * 
     * @param object Properties $configuration (original type: java.util.Properties)
     * 
     * @throws object OsidException An exception with one of the following
     *            messages defined in org.osid.OsidException:    {@link }
     *            org.osid.OsidException#OPERATION_FAILED OPERATION_FAILED},
     *            {@link org.osid.OsidException#PERMISSION_DENIED}
     *            PERMISSION_DENIED}, {@link }
     *            org.osid.OsidException#CONFIGURATION_ERROR
     *            CONFIGURATION_ERROR}, {@link }
     *            org.osid.OsidException#UNIMPLEMENTED UNIMPLEMENTED}, {@link }
     *            org.osid.OsidException#NULL_ARGUMENT NULL_ARGUMENT}
     * 
     * @access public
     */
    function assignConfiguration ( $configuration ) { 
        $this->_configuration =$configuration;
    }
 
    /**
     * Return context of this OsidManager.
     *    
     * @return object OsidContext 
     * 
     * @throws object OsidException
     * 
     * @access public
     */
    function getOsidContext () { 
        return $this->_osidContext;
    } 
 
    /**
     * Assign the context of this OsidManager.
     * 
     * @param object OsidContext $context 
     * 
     * @throws object OsidException An exception with one of the following
     *            messages defined in org.osid.OsidException:    {@link }
     *            org.osid.OsidException#NULL_ARGUMENT NULL_ARGUMENT}
     * 
     * @access public
     */
    function assignOsidContext ( $context ) { 
        $this->_osidContext =$context;
    } 
        
    /**
     * Create wizard steps for editing the values of the specified Record and
     * add them to the wizard.
     * 
     * @param object $record 
     * @param object $wizard The wizard to add the steps to.
     * @param array $partStructures An ordered array of the partStructures to include.
     * @return void 
     * @access public
     * @since 10/19/04
     */
    function createWizardStepsForPartStructures ( $record, $wizard, $partStructures ) {
        ArgumentValidator::validate($record, new ExtendsValidatorRule("RecordInterface"));
        ArgumentValidator::validate($wizard, new ExtendsValidatorRule("Wizard"));
        ArgumentValidator::validate($partStructures, new ArrayValidatorRuleWithRule(new ExtendsValidatorRule("PartStructure")));
        
        $recordStructure =$record->getRecordStructure();
        $format = $recordStructure->getFormat();
        
        if (!is_object($this->_modules[$format]))
            throwError(new Error("Unsupported Format, '$format'", "RepositoryInputOutputModuleManager", true));
        
        return $this->_modules[$format]->createWizardStepsForPartStructures($record, $wizard, $partStructures);
    }
    
    /**
     * Create wizard steps for editing the values of the specified Record and
     * add them to the wizard.
     * 
     * @param object $record 
     * @param object $wizard The wizard to add the steps to.
     * @return void 
     * @access public
     * @since 10/19/04
     */
    function createWizardSteps ( $record, $wizard ) {
        ArgumentValidator::validate($record, new ExtendsValidatorRule("RecordInterface"));
        ArgumentValidator::validate($wizard, new ExtendsValidatorRule("Wizard"));
                
        $recordStructure =$record->getRecordStructure();
        $format = $recordStructure->getFormat();
        
        if (!is_object($this->_modules[$format]))
            throwError(new Error("Unsupported Format, '$format'", "RepositoryInputOutputModuleManager", true));
        
        return $this->_modules[$format]->createWizardSteps($record, $wizard);
    }
    
    /**
     * Get the values submitted in the wizard and update the Record with them.
     * 
     * @param object $record 
     * @param object $wizard 
     * @return void 
     * @access public
     * @since 10/19/04
     */
    function updateFromWizard ( $record, $wizard ) {
        ArgumentValidator::validate($record, new ExtendsValidatorRule("RecordInterface"));
        
        $recordStructure =$record->getRecordStructure();
        $format = $recordStructure->getFormat();
        
        if (!is_object($this->_modules[$format]))
            throwError(new Error("Unsupported Format, '$format'", "RepositoryInputOutputModuleManager", true));
        
        return $this->_modules[$format]->updateFromWizard($record, $wizard);
    }
    
    /**
     * Generate HTML for displaying the Record
     * 
     * @param object $record 
     * @return string 
     * @access public
     * @since 10/19/04
     */
    function generateDisplay ( $repositoryId, $assetId, $record ) {
        ArgumentValidator::validate($repositoryId, new ExtendsValidatorRule("Id"));
        ArgumentValidator::validate($assetId, new ExtendsValidatorRule("Id"));
        ArgumentValidator::validate($record, new ExtendsValidatorRule("RecordInterface"));
        
        $recordStructure =$record->getRecordStructure();
        $format = $recordStructure->getFormat();
        
        if (!is_object($this->_modules[$format]))
            throwError(new Error("Unsupported Format, '$format'", "RepositoryInputOutputModuleManager", true));
        
        return $this->_modules[$format]->generateDisplay($repositoryId, $assetId, $record);
    }
    
    /**
     * Generate HTML for displaying particular fields of the Record
     * 
     * @param object $record The record to print.
     * @param array $partStructures An array of partStructures to print.
     * @return string 
     * @access public
     * @since 10/19/04
     */
    function generateDisplayForPartStructures ( $repositoryId, $assetId, 
        $record, $partStructures ) 
    {
        ArgumentValidator::validate($repositoryId, new ExtendsValidatorRule("Id"));
        ArgumentValidator::validate($assetId, new ExtendsValidatorRule("Id"));
        ArgumentValidator::validate($record, new ExtendsValidatorRule("RecordInterface"));
        ArgumentValidator::validate($partStructures, new ArrayValidatorRuleWithRule(new ExtendsValidatorRule("PartStructure")));
        
        $recordStructure =$record->getRecordStructure();
        $type =$recordStructure->getType();
        
        if (!is_object($this->_modules[Type::typeToString($type)]))
            throwError(new Error("Unsupported Format, '".Type::typeToString($type)."'", "RepositoryInputOutputModuleManager", true));
        
        return $this->_modules[Type::typeToString($type)]->generateDisplayForPartStructures($repositoryId, $assetId, $record, $partStructures);
    }
    
    
    /**
     * Return the URL of a thumbnail image for a given Asset.
     * 
     * @param object Id $assetId 
     * @return string The URL of the thumbnail
     * @access public
     * @since 7/22/05
     */
    function getThumbnailUrlForAsset ($assetOrId ) {
        ArgumentValidator::validate($assetOrId, 
            OrValidatorRule::getRule(
                ExtendsValidatorRule::getRule("Id"),
                ExtendsValidatorRule::getRule("Asset")));
        
        $rule = ExtendsValidatorRule::getRule("Id");
        if ($rule->check($assetOrId)) {
            $repositoryManager = Services::getService("RepositoryManager");
            $asset =$repositoryManager->getAsset($assetOrId);
        } else {
            $asset =$assetOrId;
        }
        
        if (!$asset)
            return false;
        
        $fileRecord = RepositoryInputOutputModuleManager::getFirstImageOrFileRecordForAsset(
                            $asset);
        return RepositoryInputOutputModuleManager::getThumbnailUrlForRecord(
                            $asset, $fileRecord);
    }
    
    /**
     * Return the URL of a thumbnail image for a given Asset.
     * 
     * @param object Id $assetId 
     * @return string The URL of the thumbnail
     * @access public
     * @since 7/22/05
     */
    function getThumbnailUrlForRecord ($assetOrId, $fileRecord ) {
        ArgumentValidator::validate($assetOrId, 
            OrValidatorRule::getRule(
                ExtendsValidatorRule::getRule("Id"),
                ExtendsValidatorRule::getRule("Asset")));
        
        $rule = ExtendsValidatorRule::getRule("Id");
        if ($rule->check($assetOrId)) {
            $repositoryManager = Services::getService("RepositoryManager");
            $asset =$repositoryManager->getAsset($assetOrId);
        } else {
            $asset =$assetOrId;
        }
        
        $idManager = Services::getService("IdManager");
        $assetId =$asset->getId();
        $repository =$asset->getRepository();
        $repositoryId =$repository->getId();        
        
        if ($fileRecord === FALSE)
            return FALSE;
        
        $fileRecordId =$fileRecord->getId();
        
        $filenameParts =$fileRecord->getPartsByPartStructure(
            $idManager->getId("FILE_NAME"));
        $filenamePart =$filenameParts->next();
        $filename = $filenamePart->getValue();
        
        $mimeTypeParts =$fileRecord->getPartsByPartStructure(
                $idManager->getId("THUMBNAIL_MIME_TYPE"));
        $mimeTypePart =$mimeTypeParts->next();
        $mimeType = $mimeTypePart->getValue();
        
        
        $harmoni = Harmoni::instance();
        $harmoni->request->startNamespace("polyphony-repository");
        
        $url = $harmoni->request->quickURL("repository", "viewthumbnail",
            array(
                "repository_id" => $repositoryId->getIdString(),
                "asset_id" => $assetId->getIdString(),
                "record_id" => $fileRecordId->getIdString()));
        
        
        $harmoni->request->endNamespace();
        
        return $url;
    }
    
    /**
     * Return the URL of a file for a given Asset. If the Asset has multiple
     * files, only one will be returned.
     * 
     * @param object Id $assetId 
     * @return string The URL of the thumbnail
     * @access public
     * @since 7/22/05
     */
    function getFileUrlForAsset ($assetOrId ) {
        ArgumentValidator::validate($assetOrId, 
            OrValidatorRule::getRule(
                ExtendsValidatorRule::getRule("Id"),
                ExtendsValidatorRule::getRule("Asset")));
        
        $rule = ExtendsValidatorRule::getRule("Id");
        if ($rule->check($assetOrId)) {
            $repositoryManager = Services::getService("RepositoryManager");
            $asset =$repositoryManager->getAsset($assetOrId);
        } else {
            $asset =$assetOrId;
        }
        
        if (!$asset)
            return false;
        
        $fileRecord = RepositoryInputOutputModuleManager::getFirstImageOrFileRecordForAsset(
                            $asset);
        
        return RepositoryInputOutputModuleManager::getFileUrlForRecord(
                            $asset, $fileRecord);
    }
        
    /**
     * Return the URL of a file for a given Asset. If the Asset has multiple
     * files, only one will be returned.
     * 
     * @param object Id $assetId 
     * @return string The URL of the thumbnail
     * @access public
     * @since 7/22/05
     */
    function getFileUrlForRecord($assetOrId, $fileRecord ) {
        $idManager = Services::getService("IdManager");
        ArgumentValidator::validate($assetOrId, 
            OrValidatorRule::getRule(
                ExtendsValidatorRule::getRule("Id"),
                ExtendsValidatorRule::getRule("Asset")));
        
        // Remote Files
        $recStruct =$fileRecord->getRecordStructure();
        $remoteFileId =$idManager->getId("REMOTE_FILE");
        if ($remoteFileId->isEqual($recStruct->getId())) {
            $urlParts =$fileRecord->getPartsByPartStructure($idManager->getId("FILE_URL"));
            $urlPart =$urlParts->next();
            return $urlPart->getValue();
        }
        
        // Local files
        $rule = ExtendsValidatorRule::getRule("Id");
        if ($rule->check($assetOrId)) {
            $repositoryManager = Services::getService("RepositoryManager");
            $asset =$repositoryManager->getAsset($assetOrId);
        } else {
            $asset =$assetOrId;
        }
        
        
        $assetId =$asset->getId();
        $repository =$asset->getRepository();
        $repositoryId =$repository->getId();
        
        if ($fileRecord === FALSE)
            return FALSE;
        
        $fileRecordId =$fileRecord->getId();    
        
        
        $harmoni = Harmoni::instance();
        $harmoni->request->startNamespace("polyphony-repository");
        
        $url = $harmoni->request->quickURL("repository", "viewfile", 
                array(
                    "repository_id" => $repositoryId->getIdString(),
                    "asset_id" => $assetId->getIdString(),
                    "record_id" => $fileRecordId->getIdString()));
        
        
        $harmoni->request->endNamespace();
        
        return $url;
    }
    
    /**
     * Answer the first image Record of the Asset, if none is availible, answer
     * the first file of any time. If none are availible, answer FALSE.
     * 
     * @param object Id $assetId 
     * @return mixed 
     * @access public
     * @since 8/19/05
     */
    function getFirstImageOrFileRecordForAsset ( $assetOrId ) {
        ArgumentValidator::validate($assetOrId, 
            OrValidatorRule::getRule(
                ExtendsValidatorRule::getRule("Id"),
                ExtendsValidatorRule::getRule("Asset")));
        
        $rule = ExtendsValidatorRule::getRule("Id");
        if ($rule->check($assetOrId)) {
            $repositoryManager = Services::getService("RepositoryManager");
            $asset =$repositoryManager->getAsset($assetOrId);
        } else {
            $asset =$assetOrId;
        }
        
        $idManager = Services::getService("IdManager");
        $assetId =$asset->getId();
        
        // Check the cache
        if (!isset($GLOBALS['__RepositoryThumbRecordCache']))
            $GLOBALS['__RepositoryThumbRecordCache'] = array();
        
        if (!isset($GLOBALS['__RepositoryThumbRecordCache'][$assetId->getIdString()])) {        
            $imageProcessor = Services::getService("ImageProcessor");
            $fileRecords = new MultiIteratorIterator();
            $fileRecords->addIterator($asset->getRecordsByRecordStructure($idManager->getId("FILE")));
            $fileRecords->addIterator($asset->getRecordsByRecordStructure($idManager->getId("REMOTE_FILE")));
            while ($fileRecords->hasNext()) {
                $record =$fileRecords->next();
                if (!isset($fileRecord)) {
                    $fileRecord =$record;
                }
                
                $mimeTypeParts =$record->getPartsByPartStructure(
                    $idManager->getId("MIME_TYPE"));
                $mimeTypePart =$mimeTypeParts->next();
                $mimeType = $mimeTypePart->getValue();
                
                // If this record is supported by the image processor, then use it
                // to generate a thumbnail instead of the default icons.
                if ($imageProcessor->isFormatSupported($mimeType)) {
                    $fileRecord =$record;
                    break;    
                }
            }
            
            
            
            if (!isset($fileRecord))
                $GLOBALS['__RepositoryThumbRecordCache'][$assetId->getIdString()] = FALSE;
             else
                $GLOBALS['__RepositoryThumbRecordCache'][$assetId->getIdString()] =$fileRecord;
        }
        
        return $GLOBALS['__RepositoryThumbRecordCache'][$assetId->getIdString()];
    }
    
    /**
     * Answer true if the Asset or AssetId has a thumbnail rather than a default Icon
     * 
     * @param mixed object Asset Id $assetOrID
     * @return boolean 
     * @access public
     * @since 12/4/06
     */
    function hasThumbnailNotIcon ( $assetOrId ) {
        $idManager = Services::getService("IdManager");
        
        $record = RepositoryInputOutputModuleManager::getFirstImageOrFileRecordForAsset($assetOrId);
        
        if (!$record)
            return FALSE;
        
        // Make sure that the structure is the right one.
        $structure =$record->getRecordStructure();
        $fileId =$idManager->getId('FILE');
        $remoteFileId =$idManager->getId('REMOTE_FILE');
        if (!$fileId->isEqual($structure->getId()) && !$remoteFileId->isEqual($structure->getId())) {
            return FALSE;
        } else {
            // Get the parts for the record.
            $partIterator =$record->getParts();
            $parts = array();
            while($partIterator->hasNext()) {
                $part =$partIterator->next();
                $partStructure =$part->getPartStructure();
                $partStructureId =$partStructure->getId();
                $parts[$partStructureId->getIdString()] =$part;
            }
            
            // If we have a thumbnail, print that.
            if ($parts['THUMBNAIL_MIME_TYPE']->getValue())
                return TRUE;
            else
                return FALSE;
        }
    }
}
 
?>