class.ilSoapSCORMAdministration.php

Go to the documentation of this file.

<?php
  /*
   +-----------------------------------------------------------------------------+
   | ILIAS open source                                                           |
   +-----------------------------------------------------------------------------+
   | Copyright (c) 1998-2006 ILIAS open source, University of Cologne            |
   |                                                                             |
   | This program is free software; you can redistribute it and/or               |
   | modify it under the terms of the GNU General Public License                 |
   | as published by the Free Software Foundation; either version 2              |
   | of the License, or (at your option) any later version.                      |
   |                                                                             |
   | This program is distributed in the hope that it will be useful,             |
   | but WITHOUT ANY WARRANTY; without even the implied warranty of              |
   | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the               |
   | GNU General Public License for more details.                                |
   |                                                                             |
   | You should have received a copy of the GNU General Public License           |
   | along with this program; if not, write to the Free Software                 |
   | Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA. |
   +-----------------------------------------------------------------------------+
  */
 
 
include_once './webservice/soap/classes/class.ilSoapAdministration.php';
 
class ilSoapSCORMAdministration extends ilSoapAdministration
{
        function ilSoapExerciseAdministration()
        {
                parent::ilSoapAdministration();
        }
 
        function getIMSManifestXML ($sid, $ref_id) 
        {
                $this->initAuth($sid);
                $this->initIlias();
                
                if(!$this->__checkSession($sid))
                {
                        return $this->__raiseError($this->__getMessage(),$this->__getMessageCode());
                }
                if(!strlen($ref_id))
                {
                        return $this->__raiseError('No ref id given. Aborting!',
                                                                           'Client');
                }
                global $rbacsystem, $tree, $ilLog;
 
                // get obj_id
                if(!$obj_id = ilObject::_lookupObjectId($ref_id))
                {
                        return $this->__raiseError('No exercise found for id: '.$ref_id,
                                                                           'Client');
                }
 
                if(ilObject::_isInTrash($ref_id))
                {
                        return $this->__raiseError("Parent with ID $ref_id has been deleted.", 'Client');
                }
 
                // Check access
                $permission_ok = false;
                foreach($ref_ids = ilObject::_getAllReferences($obj_id) as $ref_id)
                {
                        if($rbacsystem->checkAccess('read',$ref_id))
                        {
                                $permission_ok = true;
                                break;
                        }
                }
 
                if(!$permission_ok)
                {
                        return $this->__raiseError('No permission to read the object with id: '.$ref_id,
                                                                           'Server');
                }
 
                $lm_obj = ilObjectFactory::getInstanceByObjId($obj_id, false);
                if (!is_object($lm_obj) || $lm_obj->getType()!= "sahs")
                {
                        return $this->__raiseError('Wrong obj id or type for scorm object with id '.$ref_id,
                                                                           'Server');
                }
                // get scorm xml
                require_once("./Modules/ScormAicc/classes/SCORM/class.ilSCORMObject.php");
                require_once("./Modules/ScormAicc/classes/SCORM/class.ilSCORMResource.php");
 
                $imsFilename = $lm_obj->getDataDirectory().DIRECTORY_SEPARATOR."imsmanifest.xml";
 
                if (!file_exists($imsFilename)) {
                        return $this->__raiseError('Could not find manifest file for object with ref id '.$ref_id,
                                                                           'Server');
                        
                }
                return file_get_contents($imsFilename);
        }
        
        public function hasSCORMCertificate($sid, $ref_id, $usr_id)
        {
                $this->initAuth($sid);
                $this->initIlias();
 
                if(!$this->__checkSession($sid))
                {
                        return $this->__raiseError($this->__getMessage(),$this->__getMessageCode());
                }
                if(!strlen($ref_id))
                {
                        return $this->__raiseError('No ref id given. Aborting!',
                                                                           'Client');
                }
                global $rbacsystem, $tree, $ilLog;
 
                // get obj_id
                if(!$obj_id = ilObject::_lookupObjectId($ref_id))
                {
                        return $this->__raiseError('No exercise found for id: '.$ref_id,
                                                                           'Client');
                }
 
                if(ilObject::_isInTrash($ref_id))
                {
                        return $this->__raiseError("Parent with ID $ref_id has been deleted.", 'Client');
                }
 
                $result = false;
                include_once("./Modules/ScormAicc/classes/class.ilObjSAHSLearningModuleAccess.php");
                $result = ilObjSAHSLearningModuleAccess::_lookupUserCertificate($obj_id, $usr_id);
 
                return $result;
        }
 
        public function getSCORMCompletionStatus($sid, $a_usr_id, $a_ref_id)
        {
                $this->initAuth($sid);
                $this->initIlias();
                
                if(!$this->__checkSession($sid))
                {
                        return $this->__raiseError($this->__getMessage(),$this->__getMessageCode());
                }
 
                if(!strlen($a_ref_id))
                {
                        return $this->__raiseError('No ref_id given. Aborting!', 'Client');
                }
                
                include_once 'include/inc.header.php';
                
                // get obj_id
                if(!$obj_id = ilObject::_lookupObjectId($a_ref_id))
                {
                        return $this->__raiseError('No scorm module found for id: '.$a_ref_id,
                                                                           'Client');
                }       
                
                include_once 'Services/Tracking/classes/class.ilLPStatus.php';          
                include_once 'Services/Tracking/classes/class.ilObjUserTracking.php';
                
                if(!ilObjUserTracking::_enabledLearningProgress())
                {
                        return $this->__raiseError('Learning progress not enabled in this installation. Aborting!', 'Server');
                }       
                                                                        
                $status = ilLPStatus::_lookupStatus($obj_id, $a_usr_id);                
                if($status == ilLPStatus::LP_STATUS_COMPLETED_NUM)
                {
                        return 'completed';
                }
                else if($status == ilLPStatus::LP_STATUS_FAILED_NUM)
                {
                        return 'failed';
                }
                else if($status == ilLPStatus::LP_STATUS_IN_PROGRESS_NUM)
                {
                        return 'in_progress';
                }
                else
                {
                        return 'not_attempted';
                }
        }
}
?>