/tine20/Courses/Frontend/Json.php

<?php
/**
 * Tine 2.0
 * @package     Courses
 * @subpackage  Frontend
 * @license     http://www.gnu.org/licenses/agpl.html AGPL Version 3
 * @author      Philipp Schüle <p.schuele@metaways.de>
 * @copyright   Copyright (c) 2007-2011 Metaways Infosystems GmbH (http://www.metaways.de)
 * 
 */

/**
 *
 * This class handles all Json requests for the Courses application
 *
 * @package     Courses
 * @subpackage  Frontend
 */
class Courses_Frontend_Json extends Tinebase_Frontend_Json_Abstract
{
    /**
     * the controller
     *
     * @var Courses_Controller_Course
     */
    protected $_controller = NULL;

    /**
     * the groups controller
     *
     * @var Admin_Controller_Group
     */
    protected $_groupController = NULL;
    
    /**
     * config of courses
     *
     * @var Zend_Config
     */
    protected $_config = NULL;
    
    /**
     * the constructor
     *
     */
    public function __construct()
    {
        $this->_applicationName = 'Courses';
        $this->_controller = Courses_Controller_Course::getInstance();
        $this->_groupController = Admin_Controller_Group::getInstance();
        
        $this->setConfig();
    }
    
    /**
     * set config
     * 
     * @param array $_config
     */
    public function setConfig($_config = array())
    {
        $this->_config = isset(Tinebase_Core::getConfig()->courses) ? Tinebase_Core::getConfig()->courses : new Zend_Config($_config);
    }
    
    /************************************** protected helper functions **********************/
    
    /**
     * returns task prepared for json transport
     *
     * @param Tinebase_Record_Interface $_record
     * @return array record data
     */
    protected function _recordToJson($_record)
    {
        $recordArray = parent::_recordToJson($_record);
        
        // group data
        $groupData = $this->_groupController->get($_record->group_id)->toArray();
        unset($groupData['id']);
        $groupData['members'] = $this->_getCourseMembers($_record->group_id);
        
        // course type
        $recordArray['type'] = array(
            'value' => $recordArray['type'],
            'records' => $this->searchCourseTypes(NULL, NULL)
        );
        return array_merge($groupData, $recordArray);
    }
    
    /**
     * returns multiple records prepared for json transport
     *
     * @param Tinebase_Record_RecordSet $_records
     * @return array data
     */
    protected function _multipleRecordsToJson(Tinebase_Record_RecordSet $_records, $_filter=NULL)
    {
        $result = parent::_multipleRecordsToJson($_records, $_filter);
        
        // get groups + types (departments) and merge data
        $groupIds = $_records->group_id;
        $groups = Tinebase_Group::getInstance()->getMultiple(array_unique(array_values($groupIds)));
        $knownTypes = Tinebase_Department::getInstance()->search(new Tinebase_Model_DepartmentFilter());
        
        foreach ($result as &$course) {
            
            $groupIdx = $groups->getIndexById($course['group_id']);
            if ($groupIdx !== FALSE) {
                $group = $groups[$groupIdx]->toArray();
                unset($group['id']);
                $course = array_merge($group, $course);
            } else {
                if (Tinebase_Core::isLogLevel(Zend_Log::NOTICE)) Tinebase_Core::getLogger()->notice(__METHOD__ . '::' . __LINE__ . ' Group with ID ' . $course['group_id'] . ' does not exist.');
            }
            
            $typeIdx = $knownTypes->getIndexById($course['type']);
            if ($typeIdx !== FALSE) {
                //if (Tinebase_Core::isLogLevel(Zend_Log::DEBUG)) Tinebase_Core::getLogger()->debug(__METHOD__ . '::' . __LINE__ . ' ' . print_r($knownTypes[$typeIdx]->toArray(), true));
                $course['type'] = $knownTypes[$typeIdx]->toArray();
            } else {
                if (Tinebase_Core::isLogLevel(Zend_Log::NOTICE)) Tinebase_Core::getLogger()->notice(__METHOD__ . '::' . __LINE__ . ' Department with ID ' . $course['type'] . ' does not exist.');
                $course['type'] = array(
                    'id' => $course['type'], 
                    'name' => $course['type']
                );
            }
        }
        
        return $result;
    }
    
    /**
     * get course members
     *
     * @param int $_groupId
     * @return array
     */
    protected function _getCourseMembers($_groupId)
    {
        $adminJson = new Admin_Frontend_Json();
        $members = $adminJson->getGroupMembers($_groupId);
        
        $result = array();
        foreach ($members['results'] as $member) {
            
            // get full user for login name
            $fullUser = Tinebase_User::getInstance()->getFullUserById($member['id']);
            
            $result[] = array(
                'id'    => $member['id'],
                'name'  => $member['name'],
                'data'  => $fullUser->accountLoginName,
                'type'  => Tinebase_Acl_Rights::ACCOUNT_TYPE_USER,
            );
        }
        
        return $result;
    }
    
    /**
     * add or remove members from internet/fileserver groups
     *
     * @param array $_members array of member ids
     * @param boolean $_access yes/no
     */
    protected function _manageAccessGroups(array $_members, $_access, $_type = 'internet')
    {
        $configField = $_type . '_group';
        
        if (!isset($this->_config) || !isset($this->_config->{$configField})) {
            return;
        }

        $groupId = $this->_config->{$configField};
        $groupController = Admin_Controller_Group::getInstance();
        
        if (Tinebase_Core::isLogLevel(Zend_Log::DEBUG)) Tinebase_Core::getLogger()->debug(__METHOD__ . '::' . __LINE__ . " Setting $_type to $_access for " . print_r($_members, true));
        
        // add or remove members to or from internet/fileserver groups (defined in config.inc.php)
        foreach ($_members as $memberId) {
            if ($_access) {
                $groupController->addGroupMember($groupId, $memberId);
            } else {
                $groupController->removeGroupMember($groupId, $memberId);
            }
        }
    }
    
    /************************************** public API **************************************/
    
    /**
     * Returns registry data of the application.
     * 
     * @return mixed array 'variable name' => 'data'
     */
    public function getRegistryData()
    {
        $courseTypes = Tinebase_Department::getInstance()->search(new Tinebase_Model_DepartmentFilter());
        
        $defaultType = count($courseTypes) > 0 ? $courseTypes[0]->getId() : '';
        
        $result = array(
            'defaultType' => array(
                'value' => $defaultType,
                'records' => $this->searchCourseTypes(NULL, NULL)
            )
        );
        
        if (Tinebase_Core::isLogLevel(Zend_Log::DEBUG)) Tinebase_Core::getLogger()->debug(__METHOD__ . '::' . __LINE__ .' result: ' . print_r($result, true));
        
        return $result;
    }
    
    /**
     * Search for records matching given arguments
     *
     * @param  array $filter
     * @param  array $paging
     * @return array
     */
    public function searchCourses($filter, $paging)
    {
        return $this->_search($filter, $paging, $this->_controller, 'Courses_Model_CourseFilter');
    }     
    
    /**
     * Return a single record
     *
     * @param   string $id
     * @return  array record data
     */
    public function getCourse($id)
    {
        return $this->_get($id, $this->_controller);
    }

    /**
     * creates/updates a record
     *
     * @todo move non api specific stuff to controller!
     * 
     * @param  array $recordData
     * @return array created/updated record
     */
    public function saveCourse($recordData)
    {
        // create course and group from json data
        $course = new Courses_Model_Course(array(), TRUE);
        $course->setFromJsonInUsersTimezone($recordData);
        $group = new Tinebase_Model_Group(array(), TRUE);
        $group->setFromJsonInUsersTimezone($recordData);
        
        $i18n = Tinebase_Translation::getTranslation('Courses');
        $groupNamePrefix = $i18n->_('Course');
        
        $groupNamePrefix = is_array($groupNamePrefix) ? $groupNamePrefix[0] : $groupNamePrefix;
        $group->name = $groupNamePrefix . '-' . $course->name;
        
        if (Tinebase_Core::isLogLevel(Zend_Log::DEBUG)) Tinebase_Core::getLogger()->debug(__METHOD__ . '::' . __LINE__ . ' ' . print_r($group->toArray(), true));
        
        if (empty($group->id)) {
            $savedGroup         = $this->_groupController->create($group);
            $course->group_id   = $savedGroup->getId();
            $savedRecord        = $this->_controller->create($course);
        } else {
            $savedRecord      = $this->_controller->update($course);
            
            $currentMembers   = $this->_groupController->getGroupMembers($course->group_id);

            $newCourseMembers = array_diff((array)$group->members, $currentMembers);
            $this->_controller->addCourseMembers($course, $newCourseMembers);
            
            $deletedAccounts  = array_diff($currentMembers, (array)$group->members);
            // delete members wich got removed from course
            Admin_Controller_User::getInstance()->delete($deletedAccounts);
        }
        
        // add/remove members to/from internet/fileserver group
        if (! empty($group->members)) {
            $this->_manageAccessGroups($group->members, $savedRecord->internet,     'internet');
            $this->_manageAccessGroups($group->members, $savedRecord->fileserver, 'fileserver');
        }

        return $this->_recordToJson($savedRecord);
    }
    
    /**
     * deletes existing records
     *
     * @param string $ids 
     * @return string
     */
    public function deleteCourses($ids)
    {
        return $this->_delete($ids, $this->_controller);
    }    

    /**
     * import course members
     *
     * @param string $tempFileId
     * @param string $groupId
     * @param string $courseName
     * 
     * @todo write test!!
     */
    public function importMembers($tempFileId, $groupId, $courseId)
    {
        $tempFile = Tinebase_TempFile::getInstance()->getTempFile($tempFileId);
        
        $course = $this->_controller->get($courseId);
        $schoolName = strtolower(Tinebase_Department::getInstance()->get($course->type)->name); 
        
        // get definition and start import with admin user import csv plugin
        $definitionName = $this->_config->get('import_definition', 'admin_user_import_csv');
        if (Tinebase_Core::isLogLevel(Zend_Log::DEBUG)) Tinebase_Core::getLogger()->debug(__METHOD__ . '::' . __LINE__ . ' Using import definition: ' . $definitionName);
        $definition = Tinebase_ImportExportDefinition::getInstance()->getByName($definitionName);
        $importer = Admin_Import_Csv::createFromDefinition($definition, array(
            //'accountLoginNamePrefix'    => $course->name . '-',
            'group_id'                      => $groupId,
            'accountEmailDomain'            => (isset($this->_config->domain)) ? $this->_config->domain : '',
            'accountHomeDirectoryPrefix'    => (isset($this->_config->basehomedir)) ? $this->_config->basehomedir . $schoolName . '/'. $course->name . '/' : '',
            'password'                      => $course->name,
            'course'                        => $course,
            'samba'                         => (isset($this->_config->samba)) ? array(
                'homePath'      => $this->_config->samba->basehomepath,
                'homeDrive'     => $this->_config->samba->homedrive,
                'logonScript'   => $course->name . $this->_config->samba->logonscript_postfix_member,
                'profilePath'   => $this->_config->samba->baseprofilepath . $schoolName . '\\' . $course->name . '\\',
                'pwdCanChange'  => new Tinebase_DateTime('@1'),
                'pwdMustChange' => new Tinebase_DateTime('@1')
            ) : array(),
        ));
        $importer->importFile($tempFile->path);
        
        // return members to update members grid and add to student group
        $members = $this->_getCourseMembers($groupId);
        
        // add to student group if available
        if (isset($this->_config->students_group) && !empty($this->_config->students_group)) {
            $groupController = Admin_Controller_Group::getInstance(); 
            foreach ($members as $member) {
                $groupController->addGroupMember($this->_config->students_group, $member['id']);
            }
        }
        
        return array(
            'results'   => $members,
            'status'    => 'success'
        );
    }
    
    /**
     * Search for records matching given arguments
     *
     * @param  array $filter
     * @param  array $paging
     * @return array
     */
    public function searchCourseTypes($filter, $paging)
    {
        $result = Tinebase_Department::getInstance()->search(new Tinebase_Model_DepartmentFilter())->toArray();
        
        return array(
            'results'       => $result,
            'totalcount'    => count($result),
            'filter'        => $filter,
        );
    }
    
    /**
     * update fileserver/internet access
     *
     * @param  array   $ids
     * @param  string  $type
     * @param  boolean $access
     * @return array
     */
    public function updateAccess($ids, $type, $access)
    {
        $result = FALSE;
        $allowedTypes = array('internet', 'fileserver');
        
        if (in_array($type, $allowedTypes)) {
            
            foreach ($ids as $courseId) {
                $course = $this->_controller->get($courseId);
                $members = $this->_groupController->getGroupMembers($course->group_id);
                
                // update course and groups
                $this->_manageAccessGroups($members, $access, $type);
                $course->{$type} = $access;
                $course = $this->_controller->update($course);
            }
            $result = TRUE;
        }
        
        return array(
            'status'    => ($result) ? 'success' : 'failure'
        );
    }

    /**
     * reset password for given account
     * - call Admin_Frontend_Json::resetPassword()
     *
     * @param  array   $account data of Tinebase_Model_FullUser or account id
     * @param  string  $password the new password
     * @param  bool    $mustChange
     * @return array
     */
    public function resetPassword($account, $password, $mustChange)
    {
        $adminJson = new Admin_Frontend_Json();
        return $adminJson->resetPassword($account, $password, (bool)$mustChange);
    }
}