class.ilMemberExport.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('Services/PrivacySecurity/classes/class.ilPrivacySettings.php');
include_once('Services/Membership/classes/class.ilMemberAgreement.php');
include_once('Modules/Course/classes/class.ilCourseParticipants.php');
include_once('Modules/Course/classes/Export/class.ilCourseDefinedFieldDefinition.php');
include_once('Services/User/classes/class.ilUserDefinedData.php');
include_once('Services/User/classes/class.ilUserFormSettings.php');

define("IL_MEMBER_EXPORT_CSV_FIELD_SEPERATOR", ',');
define("IL_MEMBER_EXPORT_CSV_STRING_DELIMITER", '"');


class ilMemberExport
{
    const EXPORT_CSV = 1;
    const EXPORT_EXCEL = 2;
    
    
    private $ref_id;
    private $obj_id;
    private $type;
    private $members;
    private $groups = array();
    private $groups_participants = array();
    private $groups_rights = array();
    
    private $lng;
    
    private $settings;
    
    private $export_type = null;
    private $filename = null;
    
    private $user_ids = array();
    private $user_course_data = array();
    private $user_course_fields = array();
    private $user_profile_data = array();
    private $privacy;
    
    public function __construct($a_ref_id, $a_type = self::EXPORT_CSV)
    {
        global $DIC;

        $ilObjDataCache = $DIC['ilObjDataCache'];
        $lng = $DIC['lng'];
        
        $this->lng = $lng;
        
        $this->export_type = $a_type;
        
        $this->ref_id = $a_ref_id;
        $this->obj_id = $ilObjDataCache->lookupObjId($this->ref_id);
        $this->type = ilObject::_lookupType($this->obj_id);
        
        $this->initMembers();
        $this->initGroups();
            
        $this->agreement = ilMemberAgreement::_readByObjId($this->obj_id);
        $this->settings = new ilUserFormSettings('memexp');
        $this->privacy = ilPrivacySettings::_getInstance();
    }
    
    
    public function filterUsers($a_usr_ids)
    {
        return $GLOBALS['DIC']->access()->filterUserIdsByRbacOrPositionOfCurrentUser(
            'manage_members',
            'manage_members',
            $this->ref_id,
            $a_usr_ids
        );
    }
    
    public function setFilename($a_file)
    {
        $this->filename = $a_file;
    }
    
    public function getFilename()
    {
        return $this->filename;
    }
    
    public function getRefId()
    {
        return $this->ref_id;
    }
    
    public function getType()
    {
        return $this->type;
    }
    
    public function getExportType()
    {
        return $this->export_type;
    }
    
    public function getObjId()
    {
        return $this->obj_id;
    }
    
    public function create()
    {
        $this->fetchUsers();
        
        // DONE: Switch different export types
        switch ($this->getExportType()) {
            case self::EXPORT_CSV:
                $this->createCSV();
                break;
                
            case self::EXPORT_EXCEL:
                $this->createExcel();
                break;
        }
    }
    
    public function getCSVString()
    {
        return $this->csv->getCSVString();
    }
    
    
    public function createExcel()
    {
        include_once "./Services/Excel/classes/class.ilExcel.php";
        $this->worksheet = new ilExcel();
        $this->worksheet->addSheet($this->lng->txt("members"));
        
        $this->write();
        
        $this->worksheet->writeToFile($this->getFilename());
    }
    
    public function createCSV()
    {
        include_once('Services/Utilities/classes/class.ilCSVWriter.php');
        $this->csv = new ilCSVWriter();
        
        $this->write();
    }
    
    
    
    protected function addCol($a_value, $a_row, $a_col)
    {
        switch ($this->getExportType()) {
            case self::EXPORT_CSV:
                $this->csv->addColumn($a_value);
                break;
                
            case self::EXPORT_EXCEL:
                $this->worksheet->setCell($a_row + 1, $a_col, $a_value);
                break;
        }
    }
    
    protected function addRow()
    {
        switch ($this->getExportType()) {
            case self::EXPORT_CSV:
                $this->csv->addRow();
                break;
            
            case self::EXPORT_EXCEL:
                break;
        }
    }
    
    protected function getOrderedExportableFields()
    {
        include_once('Services/PrivacySecurity/classes/class.ilPrivacySettings.php');
        include_once('Services/PrivacySecurity/classes/class.ilExportFieldsInfo.php');
        include_once('Modules/Course/classes/Export/class.ilCourseDefinedFieldDefinition.php');
        include_once('Services/User/classes/class.ilUserDefinedFields.php');

        $field_info = ilExportFieldsInfo::_getInstanceByType(ilObject::_lookupType($this->obj_id));
        $field_info->sortExportFields();
        $fields[] = 'role';
        // Append agreement info
        $privacy = ilPrivacySettings::_getInstance();
        if ($privacy->courseConfirmationRequired()) {
            $fields[] = 'agreement';
        }

        foreach ($field_info->getExportableFields() as $field) {
            if ($this->settings->enabled($field)) {
                $fields[] = $field;
            }
        }
        
        $udf = ilUserDefinedFields::_getInstance();
        foreach ($udf->getCourseExportableFields() as $field_id => $udf_data) {
            if ($this->settings->enabled('udf_' . $field_id)) {
                $fields[] = 'udf_' . $field_id;
            }
        }
        
        // Add course specific fields
        foreach (ilCourseDefinedFieldDefinition::_getFields($this->obj_id) as $field_obj) {
            if ($this->settings->enabled('cdf_' . $field_obj->getId())) {
                $fields[] = 'cdf_' . $field_obj->getId();
            }
        }
        if ($this->settings->enabled('group_memberships')) {
            $fields[] = 'crs_members_groups';
        }

        return $fields ? $fields : array();
    }
    
    protected function write()
    {
        // Add header line
        $row = 0;
        $col = 0;
        foreach ($all_fields = $this->getOrderedExportableFields() as $field) {
            switch ($field) {
                case 'role':
                    #$this->csv->addColumn($this->lng->txt($this->getType().'_role_status'));
                    $this->addCol($this->lng->txt($this->getType() . '_role_status'), $row, $col++);
                    break;
                case 'agreement':
                    #$this->csv->addColumn($this->lng->txt('ps_agreement_accepted'));
                    $this->addCol($this->lng->txt('ps_agreement_accepted'), $row, $col++);
                    break;
                case 'consultation_hour':
                    $this->lng->loadLanguageModule('dateplaner');
                    $this->addCol($this->lng->txt('cal_ch_field_ch'), $row, $col++);
                    break;
                
                case 'org_units':
                    $this->addCol($this->lng->txt('org_units'), $row, $col++);
                    break;
                
                default:
                    if (substr($field, 0, 4) == 'udf_') {
                        $field_id = explode('_', $field);
                        include_once('Services/User/classes/class.ilUserDefinedFields.php');
                        $udf = ilUserDefinedFields::_getInstance();
                        $def = $udf->getDefinition($field_id[1]);
                        #$this->csv->addColumn($def['field_name']);
                        $this->addCol($def['field_name'], $row, $col++);
                    } elseif (substr($field, 0, 4) == 'cdf_') {
                        $field_id = explode('_', $field);
                        #$this->csv->addColumn(ilCourseDefinedFieldDefinition::_lookupName($field_id[1]));
                        $this->addCol(ilCourseDefinedFieldDefinition::_lookupName($field_id[1]), $row, $col++);
                    } elseif ($field == "username") {//User Name Presentation Guideline; username should be named login
                        $this->addCol($this->lng->txt("login"), $row, $col++);
                    } else {
                        #$this->csv->addColumn($this->lng->txt($field));
                        $this->addCol($this->lng->txt($field), $row, $col++);
                    }
                    break;
            }
        }
        #$this->csv->addRow();
        $this->addRow();
        // Add user data
        foreach ($this->user_ids as $usr_id) {
            $row++;
            $col = 0;
            
            $udf_data = new ilUserDefinedData($usr_id);
            foreach ($all_fields as $field) {
                // Handle course defined fields
                if ($this->addUserDefinedField($udf_data, $field, $row, $col)) {
                    $col++;
                    continue;
                }
                
                if ($this->addCourseField($usr_id, $field, $row, $col)) {
                    $col++;
                    continue;
                }
                
                switch ($field) {
                    case 'role':
                        switch ($this->user_course_data[$usr_id]['role']) {
                            case IL_CRS_ADMIN:
                                #$this->csv->addColumn($this->lng->txt('crs_admin'));
                                $this->addCol($this->lng->txt('crs_admin'), $row, $col++);
                                break;
                                
                            case IL_CRS_TUTOR:
                                #$this->csv->addColumn($this->lng->txt('crs_tutor'));
                                $this->addCol($this->lng->txt('crs_tutor'), $row, $col++);
                                break;

                            case IL_CRS_MEMBER:
                                #$this->csv->addColumn($this->lng->txt('crs_member'));
                                $this->addCol($this->lng->txt('crs_member'), $row, $col++);
                                break;
                                
                            case IL_GRP_ADMIN:
                                #$this->csv->addColumn($this->lng->txt('il_grp_admin'));
                                $this->addCol($this->lng->txt('il_grp_admin'), $row, $col++);
                                break;
                                
                            case IL_GRP_MEMBER:
                                #$this->csv->addColumn($this->lng->txt('il_grp_member'));
                                $this->addCol($this->lng->txt('il_grp_member'), $row, $col++);
                                break;
                                
                            case 'subscriber':
                                #$this->csv->addColumn($this->lng->txt($this->getType().'_subscriber'));
                                $this->addCol($this->lng->txt($this->getType() . '_subscriber'), $row, $col++);
                                break;
                            
                            default:
                                #$this->csv->addColumn($this->lng->txt('crs_waiting_list'));
                                $this->addCol($this->lng->txt('crs_waiting_list'), $row, $col++);
                                break;
                            
                        }
                        break;
                    
                    case 'agreement':
                        if (isset($this->agreement[$usr_id])) {
                            if ($this->agreement[$usr_id]['accepted']) {
                                #$this->csv->addColumn(il-Format::format-Unix-Time($this->agreement[$usr_id]['acceptance_time'],true));
                                $dt = new ilDateTime($this->agreement[$usr_id]['acceptance_time'], IL_CAL_UNIX);
                                $this->addCol($dt->get(IL_CAL_DATETIME), $row, $col++);
                            } else {
                                #$this->csv->addColumn($this->lng->txt('ps_not_accepted'));
                                $this->addCol($this->lng->txt('ps_not_accepted'), $row, $col++);
                            }
                        } else {
                            #$this->csv->addColumn($this->lng->txt('ps_not_accepted'));
                            $this->addCol($this->lng->txt('ps_not_accepted'), $row, $col++);
                        }
                        break;
                        
                    // These fields are always enabled
                    case 'username':
                        #$this->csv->addColumn($this->user_profile_data[$usr_id]['login']);
                        $this->addCol($this->user_profile_data[$usr_id]['login'], $row, $col++);
                        break;
                        
                    case 'firstname':
                    case 'lastname':
                        #$this->csv->addColumn($this->user_profile_data[$usr_id][$field]);
                        $this->addCol($this->user_profile_data[$usr_id][$field], $row, $col++);
                        break;
                    
                    case 'consultation_hour':
                        include_once './Services/Booking/classes/class.ilBookingEntry.php';
                        $bookings = ilBookingEntry::lookupManagedBookingsForObject($this->obj_id, $GLOBALS['DIC']['ilUser']->getId());
                        
                        $uts = array();
                        foreach ((array) $bookings[$usr_id] as $ut) {
                            ilDatePresentation::setUseRelativeDates(false);
                            $tmp = ilDatePresentation::formatPeriod(
                                new ilDateTime($ut['dt'], IL_CAL_UNIX),
                                new ilDateTime($ut['dtend'], IL_CAL_UNIX)
                            );
                            if (strlen($ut['explanation'])) {
                                $tmp .= ' ' . $ut['explanation'];
                            }
                            $uts[] = $tmp;
                        }
                        $uts_str = implode(',', $uts);
                        $this->addCol($uts_str, $row, $col++);
                        break;
                    case 'crs_members_groups':
                        $groups = array();

                        foreach (array_keys($this->groups) as $grp_ref) {
                            if (in_array($usr_id, $this->groups_participants[$grp_ref])
                                && $this->groups_rights[$grp_ref]) {
                                $groups[] = $this->groups[$grp_ref];
                            }
                        }
                        $this->addCol(implode(", ", $groups), $row, $col++);
                        break;
                        
                    case 'org_units':
                        $this->addCol(ilObjUser::lookupOrgUnitsRepresentation($usr_id), $row, $col++);
                        break;
                        
                    default:
                        // Check aggreement
                        if (!$this->privacy->courseConfirmationRequired() or $this->agreement[$usr_id]['accepted']) {
                            #$this->csv->addColumn($this->user_profile_data[$usr_id][$field]);
                            $this->addCol($this->user_profile_data[$usr_id][$field], $row, $col++);
                        } else {
                            #$this->csv->addColumn('');
                            $this->addCol('', $row, $col++);
                        }
                        break;
                        
                }
            }
            #$this->csv->addRow();
            $this->addRow();
        }
    }
    
    
    
    private function fetchUsers()
    {
        $this->readCourseSpecificFieldsData();
        
        if ($this->settings->enabled('admin')) {
            $this->user_ids = $tmp_ids = $this->members->getAdmins();
            $this->readCourseData($tmp_ids);
        }
        if ($this->settings->enabled('tutor')) {
            $this->user_ids = array_merge($tmp_ids = $this->members->getTutors(), $this->user_ids);
            $this->readCourseData($tmp_ids);
        }
        if ($this->settings->enabled('member')) {
            $this->user_ids = array_merge($tmp_ids = $this->members->getMembers(), $this->user_ids);
            $this->readCourseData($tmp_ids);
        }
        if ($this->settings->enabled('subscribers')) {
            $this->user_ids = array_merge($tmp_ids = $this->members->getSubscribers(), $this->user_ids);
            $this->readCourseData($tmp_ids, 'subscriber');
        }
        if ($this->settings->enabled('waiting_list')) {
            include_once('Modules/Course/classes/class.ilCourseWaitingList.php');
            $waiting_list = new ilCourseWaitingList($this->obj_id);
            $this->user_ids = array_merge($waiting_list->getUserIds(), $this->user_ids);
        }
        $this->user_ids = $this->filterUsers($this->user_ids);

        // Sort by lastname
        $this->user_ids = ilUtil::_sortIds($this->user_ids, 'usr_data', 'lastname', 'usr_id');
        
        // Finally read user profile data
        $this->user_profile_data = ilObjUser::_readUsersProfileData($this->user_ids);
    }
    
    private function readCourseData($a_user_ids, $a_status = 'member')
    {
        foreach ($a_user_ids as $user_id) {
            // Read course related data
            if ($this->members->isAdmin($user_id)) {
                $this->user_course_data[$user_id]['role'] = $this->getType() == 'crs' ? IL_CRS_ADMIN : IL_GRP_ADMIN;
            } elseif ($this->members->isTutor($user_id)) {
                $this->user_course_data[$user_id]['role'] = IL_CRS_TUTOR;
            } elseif ($this->members->isMember($user_id)) {
                $this->user_course_data[$user_id]['role'] = $this->getType() == 'crs' ? IL_CRS_MEMBER : IL_GRP_MEMBER;
            } else {
                $this->user_course_data[$user_id]['role'] = 'subscriber';
            }
        }
    }
    
    private function readCourseSpecificFieldsData()
    {
        include_once('Modules/Course/classes/Export/class.ilCourseUserData.php');
        $this->user_course_fields = ilCourseUserData::_getValuesByObjId($this->obj_id);
    }
    
    private function addCourseField($a_usr_id, $a_field, $row, $col)
    {
        if (substr($a_field, 0, 4) != 'cdf_') {
            return false;
        }
        if (!$this->privacy->courseConfirmationRequired() or $this->agreement[$a_usr_id]['accepted']) {
            $field_info = explode('_', $a_field);
            $field_id = $field_info[1];
            $value = $this->user_course_fields[$a_usr_id][$field_id];
            #$this->csv->addColumn($value);
            $this->addCol($value, $row, $col);
            return true;
        }
        #$this->csv->addColumn('');
        $this->addCol('', $row, $col);
        return true;
    }
    
    private function addUserDefinedField($udf_data, $a_field, $row, $col)
    {
        if (substr($a_field, 0, 4) != 'udf_') {
            return false;
        }

        if (!$this->privacy->courseConfirmationRequired() or $this->agreement[$udf_data->getUserId()]['accepted']) {
            $field_info = explode('_', $a_field);
            $field_id = $field_info[1];
            $value = $udf_data->get('f_' . $field_id);
            #$this->csv->addColumn($value);
            $this->addCol($value, $row, $col);
            return true;
        }

        $this->addCol('', $row, $col);
        return true;
    }
    
    protected function initMembers()
    {
        if ($this->getType() == 'crs') {
            $this->members = ilCourseParticipants::_getInstanceByObjId($this->getObjId());
        }
        if ($this->getType() == 'grp') {
            $this->members = ilGroupParticipants::_getInstanceByObjId($this->getObjId());
        }
        return true;
    }

    protected function initGroups()
    {
        global $DIC;

        $tree = $DIC['tree'];
        $ilAccess = $DIC['ilAccess'];
        $parent_node = $tree->getNodeData($this->ref_id);
        $groups = $tree->getSubTree($parent_node, true, "grp");
        if (is_array($groups) && sizeof($groups)) {
            include_once('./Modules/Group/classes/class.ilGroupParticipants.php');
            $this->groups_rights = array();
            foreach ($groups as $idx => $group_data) {
                // check for group in group
                if ($group_data["parent"] != $this->ref_id && $tree->checkForParentType($group_data["ref_id"], "grp", true)) {
                    unset($groups[$idx]);
                } else {
                    $this->groups[$group_data["ref_id"]] = $group_data["title"];
                    //TODO: change permissions from write to manage_members plus "|| ilObjGroup->getShowMembers()"----- uncomment below; testing required
                    //$obj = new ilObjGroup($group_data["ref_id"], true);
                    $this->groups_rights[$group_data["ref_id"]] = (bool) $ilAccess->checkAccess("write", "", $group_data["ref_id"])/* || $obj->getShowMembers()*/;
                    $gobj = ilGroupParticipants::_getInstanceByObjId($group_data["obj_id"]);
                    $this->groups_participants[$group_data["ref_id"]] = $gobj->getParticipants();
                }
            }
        }
    }
}