1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708 |
- <?php
- /* For licensing terms, see /license.txt */
- /**
- *
- * @package chamilo.library
- */
- /**
- * Code
- */
- require_once 'fileManage.lib.php';
- require_once 'fileUpload.lib.php';
- require_once 'document.lib.php';
- /**
- * This library contains some functions for group-management.
- * @author Bart Mollet
- * @package chamilo.library
- * @todo Add $course_code parameter to all functions. So this GroupManager can
- * be used outside a session.
- */
- class GroupManager {
- //- VIRTUAL_COURSE_CATEGORY: in this category groups are created based on the virtual course of a course
- CONST VIRTUAL_COURSE_CATEGORY = 1;
-
- //DEFAULT_GROUP_CATEGORY: When group categories aren't available (platform-setting), all groups are created in this 'dummy'-category
- CONST DEFAULT_GROUP_CATEGORY = 2;
-
- /**
- * infinite
- */
- CONST INFINITE = 99999;
- /**
- * No limit on the number of users in a group
- */
- CONST MEMBER_PER_GROUP_NO_LIMIT = 0;
- /**
- * No limit on the number of groups per user
- */
- CONST GROUP_PER_MEMBER_NO_LIMIT = 0;
- /**
- * The tools of a group can have 3 states
- * - not available
- * - public
- * - private
- */
- CONST TOOL_NOT_AVAILABLE = 0;
- CONST TOOL_PUBLIC = 1;
- CONST TOOL_PRIVATE = 2;
- /**
- * Constants for the available group tools
- */
- CONST GROUP_TOOL_FORUM = 0;
- CONST GROUP_TOOL_DOCUMENTS = 1;
- CONST GROUP_TOOL_CALENDAR = 2;
- CONST GROUP_TOOL_ANNOUNCEMENT = 3;
- CONST GROUP_TOOL_WORK = 4;
- CONST GROUP_TOOL_WIKI = 5;
- CONST GROUP_TOOL_CHAT = 6;
-
-
-
-
-
-
- //GROUP FUNCTIONS
- private function __construct() {
- }
-
- public static function get_groups() {
- $table_group = Database :: get_course_table(TABLE_GROUP);
- $course_id = api_get_course_int_id();
-
- $sql = "SELECT * FROM $table_group WHERE c_id = $course_id ";
- $result = Database::query($sql);
- return Database::store_result($result, 'ASSOC');
-
- }
-
- /**
- * Get list of groups for current course.
- * @param int $category The id of the category from which the groups are
- * requested
- * @param string $course_code Default is current course
- * @return array An array with all information about the groups.
- */
- public static function get_group_list ($category = null, $course_code = null) {
- $my_user_id = api_get_user_id();
-
- /*
- if ($course_code != null) {
- $course_info = Database :: get_course_info($course_code);
- $course_db = $course_info['database'];
- } else {
- $my_course_code=api_get_course_id();
- }
- */
- $course_info = api_get_course_info($course_code);
- $course_id = $course_info['real_id'];
- $table_course = Database :: get_main_table(TABLE_MAIN_COURSE);
- $table_group_user = Database :: get_course_table(TABLE_GROUP_USER);
- $table_group = Database :: get_course_table(TABLE_GROUP);
- //condition for the session
- $session_id = api_get_session_id();
- $my_status_of_user_in_course = CourseManager::get_user_in_course_status($my_user_id, $course_info['code']);
- $is_student_in_session = false;
- if (is_null($my_status_of_user_in_course) || $my_status_of_user_in_course=='') {//into session
- if ($session_id>0) {
- $is_student_in_session=true;
- }
- }
- //COURSEMANAGER or STUDENT
- if ($my_status_of_user_in_course == COURSEMANAGER || api_is_allowed_to_edit(null, true) || api_is_drh()) {
- $sql = "SELECT g.id ,
- g.name ,
- g.description ,
- g.category_id,
- g.max_student maximum_number_of_members,
- g.secret_directory,
- g.self_registration_allowed,
- g.self_unregistration_allowed,
- g.session_id,
- ug.user_id is_member,
- COUNT(ug2.id) number_of_members
- FROM ".$table_group." g
- LEFT JOIN ".$table_group_user." ug
- ON ug.group_id = g.id AND ug.user_id = '".api_get_user_id()."' AND ug.c_id = $course_id
- LEFT JOIN ".$table_group_user." ug2
- ON ug2.group_id = g.id AND ug2.c_id = $course_id";
- } elseif ($my_status_of_user_in_course==STUDENT || $is_student_in_session===true || $_SESSION['studentview'] == 'studentview') {
- $sql = "SELECT g.id,
- g.name,
- g.description,
- g.category_id,
- g.max_student maximum_number_of_members,
- g.secret_directory,
- g.self_registration_allowed,
- g.self_unregistration_allowed,
- g.session_id,
- ug.user_id is_member,
- COUNT(ug2.id) number_of_members
- FROM ".$table_group." g
- LEFT JOIN ".$table_group_user." ug
- ON ug.group_id = g.id AND ug.user_id = '".api_get_user_id()."' AND ug.c_id = $course_id
- LEFT JOIN ".$table_group_user." ug2
- ON ug2.group_id = g.id AND ug2.c_id = $course_id";
- }
-
- $sql .= " WHERE 1=1 ";
-
- if ($category != null) {
- $sql .= " AND g.category_id = '".Database::escape_string($category)."' ";
- $session_condition = api_get_session_condition($session_id);
- if(!empty($session_condition))
- $sql .= $session_condition;
- } else {
- $session_condition = api_get_session_condition($session_id, true);
- }
-
- $sql .= " AND g.c_id = $course_id ";
-
- if(!empty($session_condition))
- $sql .= $session_condition;
- $sql .= " GROUP BY g.id ORDER BY UPPER(g.name)";
- if (!api_is_anonymous()) {
- $groupList = Database::query($sql);
- } else {
- return array();
- }
- $groups = array ();
- $thisGroup= array();
- while ($thisGroup = Database::fetch_array($groupList)) {
- if ($thisGroup['category_id'] == self::VIRTUAL_COURSE_CATEGORY) {
- $sql = "SELECT title FROM $table_course WHERE code = '".$thisGroup['name']."'";
- $obj = Database::fetch_object(Database::query($sql));
- $thisGroup['name'] = $obj->title;
- }
-
- if($thisGroup['session_id']!=0) {
- $sql_session = 'SELECT name FROM '.Database::get_main_table(TABLE_MAIN_SESSION).' WHERE id='.$thisGroup['session_id'];
- $rs_session = Database::query($sql_session);
- if (Database::num_rows($rs_session)>0) {
- $thisGroup['session_name'] = Database::result($rs_session,0,0);
- } else {
- //the session has probably been removed, so the group is now orphaned
- }
- }
- $groups[] = $thisGroup;
- }
- return $groups;
- }
-
- /**
- * Create a group
- * @param string $name The name for this group
- * @param int $tutor The user-id of the group's tutor
- * @param int $places How many people can subscribe to the new group
- */
- public static function create_group ($name, $category_id, $tutor, $places) {
- global $_course;
- $table_group = Database :: get_course_table(TABLE_GROUP);
-
- $session_id = api_get_session_id();
- $course_id = api_get_course_int_id();
-
- $currentCourseRepository = $_course['path'];
-
- $category = self :: get_category($category_id);
- if (intval($places) == 0) {
- //if the amount of users per group is not filled in, use the setting from the category
- $places = $category['max_student'];
- }
-
- $sql = "INSERT INTO ".$table_group." SET
- c_id = $course_id ,
- category_id='".Database::escape_string($category_id)."',
- max_student = '".$places."',
- doc_state = '".$category['doc_state']."',
- calendar_state = '".$category['calendar_state']."',
- work_state = '".$category['work_state']."',
- announcements_state = '".$category['announcements_state']."',
- forum_state = '".$category['forum_state']."',
- wiki_state = '".$category['wiki_state']."',
- chat_state = '".$category['chat_state']."',
- self_registration_allowed = '".$category['self_reg_allowed']."',
- self_unregistration_allowed = '".$category['self_unreg_allowed']."',
- session_id='".Database::escape_string($session_id)."'";
- Database::query($sql);
- $lastId = Database::insert_id();
-
- if ($lastId) {
- $desired_dir_name= '/'.replace_dangerous_char($name,'strict').'_groupdocs';
- $my_path = api_get_path(SYS_COURSE_PATH).$currentCourseRepository.'/document';
- $unique_name = create_unexisting_directory($_course, api_get_user_id(), $session_id, $lastId, NULL, $my_path, $desired_dir_name);
-
- /* Stores the directory path into the group table */
- $sql = "UPDATE ".$table_group." SET name = '".Database::escape_string($name)."', secret_directory = '".$unique_name."'
- WHERE c_id = $course_id AND id ='".$lastId."'";
- Database::query($sql);
- // create a forum if needed
- if ($category['forum_state'] >= 0) {
- require_once api_get_path(SYS_CODE_PATH).'forum/forumconfig.inc.php';
- require_once api_get_path(SYS_CODE_PATH).'forum/forumfunction.inc.php';
- $forum_categories = get_forum_categories();
-
- $values = array();
- $values['forum_title'] = $name;
- $values['group_id'] = $lastId;
-
- $counter = 0;
- foreach ($forum_categories as $key=>$value) {
- if ($counter==0) {
- $forum_category_id = $key;
- }
- $counter++;
- }
- // A sanity check.
- if (empty($forum_category_id)) {
- $forum_category_id = 0;
- }
- $values['forum_category'] = $forum_category_id;
- $values['allow_anonymous_group']['allow_anonymous'] = 0;
- $values['students_can_edit_group']['students_can_edit'] = 0;
- $values['approval_direct_group']['approval_direct'] = 0;
- $values['allow_attachments_group']['allow_attachments'] = 1;
- $values['allow_new_threads_group']['allow_new_threads'] = 1;
- $values['default_view_type_group']['default_view_type']=api_get_setting('default_forum_view');
- $values['group_forum'] = $lastId;
- if ($category['forum_state'] == '1') {
- $values['public_private_group_forum_group']['public_private_group_forum']='public';
- } elseif ($category['forum_state'] == '2') {
- $values['public_private_group_forum_group']['public_private_group_forum']='private';
- } elseif ($category['forum_state'] == '0') {
- $values['public_private_group_forum_group']['public_private_group_forum']='unavailable';
- }
- store_forum($values);
- }
- }
-
- return $lastId;
- }
- /**
- * Create subgroups.
- * This function creates new groups based on an existing group. It will
- * create the specified number of groups and fill those groups with users
- * from the base group
- * @param int $group_id The group from which subgroups have to be created.
- * @param int $number_of_groups The number of groups that have to be created
- */
- public static function create_subgroups ($group_id, $number_of_groups) {
- $course_id = api_get_course_int_id();
- $table_group = Database :: get_course_table(TABLE_GROUP);
- $category_id = self :: create_category('Subgroups', '', GroupManager::TOOL_PRIVATE, GroupManager::TOOL_PRIVATE, 0, 0, 1, 1);
- $users = self :: get_users($group_id);
- $group_ids = array ();
- for ($group_nr = 1; $group_nr <= $number_of_groups; $group_nr ++)
- {
- $group_ids[] = self :: create_group('SUBGROUP '.$group_nr, $category_id, 0, 0);
- }
- $members = array ();
- foreach ($users as $index => $user_id) {
- self :: subscribe_users($user_id, $group_ids[$index % $number_of_groups]);
- $members[$group_ids[$index % $number_of_groups]]++;
- }
- foreach ($members as $group_id => $places) {
- $sql = "UPDATE $table_group SET max_student = $places WHERE c_id = $course_id AND id = $group_id";
- Database::query($sql);
- }
- }
- /**
- * Create groups from all virtual courses in the given course.
- */
- public static function create_groups_from_virtual_courses() {
- self :: delete_category(self::VIRTUAL_COURSE_CATEGORY);
- $id = self :: create_category(get_lang('GroupsFromVirtualCourses'), '', GroupManager::TOOL_NOT_AVAILABLE, GroupManager::TOOL_NOT_AVAILABLE, 0, 0, 1, 1);
- $table_group_cat = Database :: get_course_table(TABLE_GROUP_CATEGORY);
- $course_id = api_get_course_int_id();
-
- $sql = "UPDATE ".$table_group_cat." SET id=".self::VIRTUAL_COURSE_CATEGORY." WHERE c_id = $course_id AND id=$id";
- Database::query($sql);
- $course = api_get_course_info();
- $course['code'] = $course['sysCode'];
- $course['title'] = $course['name'];
- $virtual_courses = CourseManager :: get_virtual_courses_linked_to_real_course($course['sysCode']);
- $group_courses = $virtual_courses;
- $group_courses[] = $course;
- $ids = array ();
- foreach ($group_courses as $index => $group_course) {
- $users = CourseManager :: get_user_list_from_course_code($group_course['code']);
- $members = array ();
- foreach ($users as $index => $user) {
- if ($user['status'] == 5 && $user['tutor_id'] == 0) {
- $members[] = $user['user_id'];
- }
- }
- $id = self :: create_group($group_course['code'], self::VIRTUAL_COURSE_CATEGORY, 0, count($members));
- self :: subscribe_users($members, $id);
- $ids[] = $id;
- }
- return $ids;
- }
- /**
- * Create a group for every class subscribed to the current course
- * @param int $category_id The category in which the groups should be
- * created
- */
- public static function create_class_groups ($category_id) {
- global $_course;
- $classes = ClassManager::get_classes_in_course($_course['sysCode']);
- $group_ids = array();
- foreach($classes as $index => $class)
- {
- $users = ClassManager::get_users($class['id']);
- $group_id = self::create_group($class['name'],$category_id,0,count($users));
- $user_ids = array();
- foreach($users as $index_user => $user)
- {
- $user_ids[] = $user['user_id'];
- }
- self::subscribe_users($user_ids,$group_id);
- $group_ids[] = $group_id;
- }
- return $group_ids;
- }
- /**
- * deletes groups and their data.
- * @author Christophe Gesche <christophe.gesche@claroline.net>
- * @author Hugues Peeters <hugues.peeters@claroline.net>
- * @author Bart Mollet
- * @param mixed $groupIdList - group(s) to delete. It can be a single id
- * (int) or a list of id (array).
- * @param string $course_code Default is current course
- * @return integer - number of groups deleted.
- */
- public static function delete_groups($group_ids, $course_code = null) {
- $course_info = api_get_course_info($course_code);
- $course_id = $course_info['real_id'];
- // Database table definitions
- $group_table = Database :: get_course_table(TABLE_GROUP);
- $forum_table = Database :: get_course_table(TABLE_FORUM);
-
- $group_ids = is_array($group_ids) ? $group_ids : array ($group_ids);
- $group_ids = array_map('intval',$group_ids);
- if (api_is_course_coach()) {
- //a coach can only delete courses from his session
- for($i=0 ; $i<count($group_ids) ; $i++) {
- if(!api_is_element_in_the_session(TOOL_GROUP,$group_ids[$i])) {
- array_splice($group_ids,$i,1);
- $i--;
- }
- }
- if(count($group_ids)==0)
- return 0;
- }
- // Unsubscribe all users
- self :: unsubscribe_all_users($group_ids);
- $sql = "SELECT id, secret_directory, session_id FROM $group_table WHERE c_id = $course_id AND id IN (".implode(' , ', $group_ids).")";
- $db_result = Database::query($sql);
- $forum_ids = array ();
- while ($group = Database::fetch_object($db_result)) {
- // move group-documents to garbage
- //$source_directory = api_get_path(SYS_COURSE_PATH).$course['path']."/group/".$group->secret_directory;
- $source_directory = api_get_path(SYS_COURSE_PATH).$course['path']."/document".$group->secret_directory;
- //File to renamed
- $destination_dir = api_get_path(SYS_COURSE_PATH).$course['path']."/document".$group->secret_directory.'_DELETED_'.$group->id;
- if (!empty($group->secret_directory)) {
- //Deleting from document tool
- DocumentManager::delete_document($course, $group->secret_directory, $source_directory);
- if (file_exists($source_directory)) {
- if (api_get_setting('permanently_remove_deleted_files') == 'true') {
- //Delete
- my_delete($source_directory);
- } else {
- //Rename
- rename($source_directory, $destination_dir);
- }
- }
- }
- //$forum_ids[] = $group->forum_id;
- }
- // delete the groups
- $sql = "DELETE FROM ".$group_table." WHERE c_id = $course_id AND id IN ('".implode("' , '", $group_ids)."')";
- Database::query($sql);
- $sql2 = "DELETE FROM ".$forum_table." WHERE c_id = $course_id AND forum_of_group IN ('".implode("' , '", $group_ids)."')";
- Database::query($sql2);
- return Database::affected_rows();
- }
- /**
- * Get group properties
- * @param int $group_id The group from which properties are requested.
- * @return array All properties. Array-keys are name, tutor_id, description, maximum_number_of_students, directory and visibility of tools
- */
- public static function get_group_properties($group_id) {
- $course_id = api_get_course_int_id();
- if (empty($group_id) or !is_integer(intval($group_id)) ) {
- return null;
- }
- $result = array();
-
- $table_group = Database :: get_course_table(TABLE_GROUP);
- $sql = "SELECT * FROM $table_group WHERE c_id = $course_id AND id = ".intval($group_id);
- $db_result = Database::query($sql);
- $db_object = Database::fetch_object($db_result);
-
- $result['id'] = $db_object->id;
- $result['name'] = $db_object->name;
- $result['tutor_id'] = isset($db_object->tutor_id)?$db_object->tutor_id:null;
- $result['description'] = $db_object->description;
- $result['maximum_number_of_students'] = $db_object->max_student;
- $result['doc_state'] = $db_object->doc_state;
- $result['work_state'] = $db_object->work_state;
- $result['calendar_state'] = $db_object->calendar_state;
- $result['announcements_state'] = $db_object->announcements_state;
- $result['forum_state'] = $db_object->forum_state;
- $result['wiki_state'] = $db_object->wiki_state;
- $result['chat_state'] = $db_object->chat_state;
- $result['directory'] = $db_object->secret_directory;
- $result['self_registration_allowed'] = $db_object->self_registration_allowed;
- $result['self_unregistration_allowed'] = $db_object->self_unregistration_allowed;
-
- $result['count_users'] = count(self::get_subscribed_users($group_id));
- $result['count_tutor'] = count(self::get_subscribed_tutors($group_id));
- $result['count_all'] = $result['count_users'] + $result['count_tutor'];
-
- return $result;
- }
- /**
- * Set group properties
- * Changes the group's properties.
- * @param int Group Id
- * @param string Group name
- * @param string Group description
- * @param int Max number of students in group
- * @param int Document tool's visibility (0=none,1=private,2=public)
- * @param int Work tool's visibility (0=none,1=private,2=public)
- * @param int Calendar tool's visibility (0=none,1=private,2=public)
- * @param int Announcement tool's visibility (0=none,1=private,2=public)
- * @param int Forum tool's visibility (0=none,1=private,2=public)
- * @param int Wiki tool's visibility (0=none,1=private,2=public)
- * @param int Chat tool's visibility (0=none,1=private,2=public)
- * @param bool Whether self registration is allowed or not
- * @param bool Whether self unregistration is allowed or not
- * @return bool TRUE if properties are successfully changed, false otherwise
- */
- public static function set_group_properties ($group_id, $name, $description, $maximum_number_of_students, $doc_state, $work_state, $calendar_state, $announcements_state, $forum_state, $wiki_state, $chat_state, $self_registration_allowed, $self_unregistration_allowed) {
- $table_group = Database :: get_course_table(TABLE_GROUP);
- $table_forum = Database :: get_course_table(TABLE_FORUM);
- //$forum_id = get_forums_of_group($group_id);
- $group_id = Database::escape_string($group_id);
- $course_id = api_get_course_int_id();
- $sql = "UPDATE ".$table_group."
- SET name='".Database::escape_string(trim($name))."',
- doc_state = '".Database::escape_string($doc_state)."',
- work_state = '".Database::escape_string($work_state)."',
- calendar_state = '".Database::escape_string($calendar_state)."',
- announcements_state = '".Database::escape_string($announcements_state)."',
- forum_state = '".Database::escape_string($forum_state)."',
- wiki_state = '".Database::escape_string($wiki_state)."',
- chat_state = '".Database::escape_string($chat_state)."',
- description='".Database::escape_string(trim($description))."',
- max_student=".Database::escape_string($maximum_number_of_students).",
- self_registration_allowed='".Database::escape_string($self_registration_allowed)."',
- self_unregistration_allowed='".Database::escape_string($self_unregistration_allowed)."'
- WHERE c_id = $course_id AND id=".$group_id;
- $result = Database::query($sql);
- //Here we are updating a field in the table forum_forum that perhaps duplicates the table group_info.forum_state cvargas
- $forum_state = (int) $forum_state;
- $sql2 = "UPDATE ".$table_forum." SET ";
- if ($forum_state===1) {
- $sql2 .= " forum_group_public_private='public' ";
- } elseif ($forum_state===2) {
- $sql2 .= " forum_group_public_private='private' ";
- } elseif ($forum_state===0) {
- $sql2 .= " forum_group_public_private='unavailable' ";
- }
- $sql2 .=" WHERE c_id = $course_id AND forum_of_group=".$group_id;
- $result2 = Database::query($sql2);
- return $result;
- }
- /**
- * Get the total number of groups for the current course.
- * @return int The number of groups for the current course.
- */
- public static function get_number_of_groups() {
- $course_id = api_get_course_int_id();
- $table_group = Database :: get_course_table(TABLE_GROUP);
- $res = Database::query("SELECT COUNT(id) AS number_of_groups FROM $table_group WHERE c_id = $course_id ");
- $obj = Database::fetch_object($res);
- return $obj->number_of_groups;
- }
- //GROUPCATEGORY FUNCTIONS
-
- /**
- * Get all categories
- * @param string $course_code The cours (default = current course)
- */
- public static function get_categories ($course_code = null) {
- $course_info = api_get_course_info($course_code);
- $course_id = $course_info['real_id'];
- $table_group_cat = Database :: get_course_table(TABLE_GROUP_CATEGORY);
- $sql = "SELECT * FROM $table_group_cat WHERE c_id = $course_id ORDER BY display_order";
- $res = Database::query($sql);
- $cats = array ();
- while ($cat = Database::fetch_array($res)) {
- $cats[] = $cat;
- }
- return $cats;
- }
- /**
- * Get a group category
- * @param int $id The category id
- * @param string $course_code The course (default = current course)
- */
- public static function get_category ($id, $course_code = null) {
- if (empty($id)) {
- return array();
- }
- $course_info = api_get_course_info($course_code);
- $course_id = $course_info['real_id'];
- $id = Database::escape_string($id);
- $table_group_cat = Database :: get_course_table(TABLE_GROUP_CATEGORY);
- $sql = "SELECT * FROM $table_group_cat WHERE c_id = $course_id AND id = $id LIMIT 1";
- $res = Database::query($sql);
- return Database::fetch_array($res);
- }
- /**
- * Get the unique category of a given group
- * @param int $group_id The id of the group
- * @param string $course_code The course in which the group is (default =
- * current course)
- * @return array The category
- */
- public static function get_category_from_group ($group_id, $course_code = null) {
- $table_group = Database :: get_course_table(TABLE_GROUP);
- $table_group_cat = Database :: get_course_table(TABLE_GROUP_CATEGORY);
-
- if (empty($group_id)) {
- return array();
- }
-
- $course_info = api_get_course_info($course_code);
- $course_id = $course_info['real_id'];
-
- $group_id = Database::escape_string($group_id);
- $sql = "SELECT gc.* FROM $table_group_cat gc, $table_group g
- WHERE gc.c_id = $course_id AND
- g.c_id = $course_id AND
- gc.id = g.category_id AND g.id= $group_id LIMIT 1";
- $res = Database::query($sql);
- $cat = array();
- if (Database::num_rows($res)) {
- $cat = Database::fetch_array($res);
- }
- return $cat;
- }
- /**
- * Delete a group category
- * @param int $cat_id The id of the category to delete
- * @param string $course_code The code in which the category should be
- * deleted (default = current course)
- */
- public static function delete_category ($cat_id, $course_code = null) {
- $course_info = api_get_course_info($course_code);
- $course_id = $course_info['real_id'];
-
- $table_group = Database :: get_course_table(TABLE_GROUP);
- $table_group_cat = Database :: get_course_table(TABLE_GROUP_CATEGORY);
- $cat_id = Database::escape_string($cat_id);
- $sql = "SELECT id FROM $table_group WHERE c_id = $course_id AND category_id='".$cat_id."'";
- $res = Database::query($sql);
- if (Database::num_rows($res) > 0) {
- $groups_to_delete = array ();
- while ($group = Database::fetch_object($res)) {
- $groups_to_delete[] = $group->id;
- }
- self :: delete_groups($groups_to_delete);
- }
- $sql = "DELETE FROM $table_group_cat WHERE c_id = $course_id AND id='".$cat_id."'";
- Database::query($sql);
- }
- /**
- * Create group category
- * @param string $title The title of the new category
- * @param string $description The description of the new category
- * @param bool $self_registration_allowed
- * @param bool $self_unregistration_allowed
- * @param int $max_number_of_students
- * @param int $groups_per_user
- */
- public static function create_category ($title, $description, $doc_state, $work_state, $calendar_state, $announcements_state, $forum_state, $wiki_state,
- $chat_state = 1, $self_registration_allowed = 0, $self_unregistration_allowed = 0, $maximum_number_of_students = 8, $groups_per_user = 0) {
- $table_group_category = Database :: get_course_table(TABLE_GROUP_CATEGORY);
-
- $course_id = api_get_course_int_id();
-
- $sql = "SELECT MAX(display_order)+1 as new_order FROM $table_group_category WHERE c_id = $course_id ";
- $res = Database::query($sql);
- $obj = Database::fetch_object($res);
- if (!isset ($obj->new_order)) {
- $obj->new_order = 1;
- }
- $sql = "INSERT INTO ".$table_group_category." SET
- c_id = $course_id ,
- title='".Database::escape_string($title)."',
- display_order ='".$obj->new_order."',
- description='".Database::escape_string($description)."',
- doc_state = '".Database::escape_string($doc_state)."',
- work_state = '".Database::escape_string($work_state)."',
- calendar_state = '".Database::escape_string($calendar_state)."',
- announcements_state = '".Database::escape_string($announcements_state)."',
- forum_state = '".Database::escape_string($forum_state)."',
- wiki_state = '".Database::escape_string($wiki_state)."',
- chat_state = '".Database::escape_string($chat_state)."',
- groups_per_user = '".Database::escape_string($groups_per_user)."',
- self_reg_allowed = '".Database::escape_string($self_registration_allowed)."',
- self_unreg_allowed = '".Database::escape_string($self_unregistration_allowed)."',
- max_student = '".Database::escape_string($maximum_number_of_students)."' ";
- Database::query($sql);
- $id = Database::insert_id();
- if ($id == self::VIRTUAL_COURSE_CATEGORY) {
- $sql = "UPDATE ".$table_group_category." SET id = ". ($id +1)." WHERE c_id = $course_id AND id = $id";
- Database::query($sql);
- return $id +1;
- }
- return $id;
- }
- /**
- * Update group category
- * @param int $id The id of the category
- * @param string $title The title of the new category
- * @param string $description The description of the new category
- * @param bool $self_registration_allowed
- * @param bool $self_unregistration_allowed
- * @param int $max_number_of_students
- * @param int $groups_per_user
- */
- public static function update_category ($id, $title, $description, $doc_state, $work_state, $calendar_state, $announcements_state, $forum_state, $wiki_state, $chat_state, $self_registration_allowed, $self_unregistration_allowed, $maximum_number_of_students, $groups_per_user) {
- $table_group_category = Database :: get_course_table(TABLE_GROUP_CATEGORY);
- $id = Database::escape_string($id);
-
- $course_id = api_get_course_int_id();
-
- $sql = "UPDATE ".$table_group_category."
- SET title='".Database::escape_string($title)."',
- description='".Database::escape_string($description)."',
- doc_state = '".Database::escape_string($doc_state)."',
- work_state = '".Database::escape_string($work_state)."',
- calendar_state = '".Database::escape_string($calendar_state)."',
- announcements_state = '".Database::escape_string($announcements_state)."',
- forum_state = '".Database::escape_string($forum_state)."',
- wiki_state = '".Database::escape_string($wiki_state)."',
- chat_state = '".Database::escape_string($chat_state)."',
- groups_per_user = ".Database::escape_string($groups_per_user).",
- self_reg_allowed = '".Database::escape_string($self_registration_allowed)."',
- self_unreg_allowed = '".Database::escape_string($self_unregistration_allowed)."',
- max_student = ".Database::escape_string($maximum_number_of_students)."
- WHERE c_id = $course_id AND id=$id";
- Database::query($sql);
- }
- /**
- * Returns the number of groups of the user with the greatest number of
- * subscribtions in the given category
- */
- public static function get_current_max_groups_per_user ($category_id = null, $course_code = null) {
- $course_info = api_get_course_info ($course_code);
- $group_table = Database :: get_course_table(TABLE_GROUP);
- $group_user_table = Database :: get_course_table(TABLE_GROUP_USER);
- $sql = 'SELECT COUNT(gu.group_id) AS current_max FROM '.$group_user_table.' gu, '.$group_table.' g
- WHERE g.c_id = '.$course_info['real_id'].' AND gu.group_id = g.id ';
- if ($category_id != null) {
- $category_id = Database::escape_string($category_id);
- $sql .= ' AND g.category_id = '.$category_id;
- }
- $sql .= ' GROUP BY gu.user_id ORDER BY current_max DESC LIMIT 1';
- $res = Database::query($sql);
- $obj = Database::fetch_object($res);
- return $obj->current_max;
- }
-
- /**
- * Swaps the display-order of two categories
- * @param int $id1 The id of the first category
- * @param int $id2 The id of the second category
- */
- public static function swap_category_order ($id1, $id2) {
- $table_group_cat = Database :: get_course_table(TABLE_GROUP_CATEGORY);
- $id1 = Database::escape_string($id1);
- $id2 = Database::escape_string($id2);
-
- $course_id = api_get_course_int_id();
-
- $sql = "SELECT id,display_order FROM $table_group_cat WHERE id IN ($id1,$id2) AND c_id = $course_id ";
- $res = Database::query($sql);
- $cat1 = Database::fetch_object($res);
- $cat2 = Database::fetch_object($res);
- $sql = "UPDATE $table_group_cat SET display_order=$cat2->display_order WHERE id = $cat1->id AND c_id = $course_id ";
- Database::query($sql);
- $sql = "UPDATE $table_group_cat SET display_order=$cat1->display_order WHERE id = $cat2->id AND c_id = $course_id ";
- Database::query($sql);
- }
-
- //GROUP USERS FUNCTIONS
-
- /**
- * Get all users from a given group
- * @param int $group_id The group
- * @return array list of user id
- */
- public static function get_users ($group_id, $load_extra_info = false) {
- $group_user_table = Database :: get_course_table(TABLE_GROUP_USER);
- $group_id = Database::escape_string($group_id);
- $course_id = api_get_course_int_id();
- $sql = "SELECT user_id FROM $group_user_table WHERE c_id = $course_id AND group_id = $group_id";
- $res = Database::query($sql);
- $users = array ();
- while ($obj = Database::fetch_object($res)) {
- if ($load_extra_info) {
- $users[] = api_get_user_info($obj->user_id);
- } else {
- $users[] = $obj->user_id;
- }
- }
- return $users;
- }
-
- public function get_members_and_tutors($group_id) {
- $group_user_table = Database :: get_course_table(TABLE_GROUP_USER);
- $tutor_user_table = Database :: get_course_table(TABLE_GROUP_TUTOR);
- $course_id = api_get_course_int_id();
- $group_id = intval($group_id);
- $sql = "SELECT user_id FROM $group_user_table WHERE c_id = $course_id AND group_id = $group_id";
- $res = Database::query($sql);
- $users = array();
-
- while ($obj = Database::fetch_object($res)) {
- $users[] = api_get_user_info($obj->user_id);
- }
-
- $sql = "SELECT user_id FROM $tutor_user_table WHERE c_id = $course_id AND group_id = $group_id";
- $res = Database::query($sql);
- while ($obj = Database::fetch_object($res)) {
- $users[] = api_get_user_info($obj->user_id);
- }
-
- return $users;
- }
-
- /**
- * Returns users belonging to any of the group
- *
- * @param array $groups list of group ids
- * @return array list of user ids
- */
- public static function get_groups_users($groups = array()) {
- $result = array();
- $tbl_group_user = Database::get_course_table(TABLE_GROUP_USER);
- $course_id = api_get_course_int_id();
- $groups = array_map('intval', $groups);
- $groups = implode(', ', $groups); //protect individual elements with surrounding quotes
- $sql = "SELECT DISTINCT user_id
- FROM $tbl_group_user gu
- WHERE c_id = $course_id AND gu.group_id IN ($groups)";
- $rs = Database::query($sql);
- while ($row = Database::fetch_array($rs)) {
- $result[] = $row['user_id'];
- }
- return $result;
- }
- /**
- * Fill the groups with students.
- * The algorithm takes care to first fill the groups with the least # of users.
- * Analysis
- * There was a problem with the "ALL" setting.
- * When max # of groups is set to all, the value is sometimes NULL and sometimes ALL
- * and in both cased the query does not work as expected.
- * Stupid solution (currently implemented: set ALL to a big number (INFINITE) and things are solved :)
- * Better solution: that's up to you.
- *
- * Note
- * Throughout Dokeos there is some confusion about "course id" and "course code"
- * The code is e.g. TEST101, but sometimes a variable that is called courseID also contains a course code string.
- * However, there is also a integer course_id that uniquely identifies the course.
- * ywarnier:> Now the course_id has been removed (25/1/2005)
- * The databases are als very inconsistent in this.
- *
- * @author Chrisptophe Gesche <christophe.geshe@claroline.net>,
- * Hugues Peeters <hugues.peeters@claroline.net> - original version
- * @author Roan Embrechts - virtual course support, code cleaning
- * @author Bart Mollet - code cleaning, use other GroupManager-functions
- * @return void
- */
- public static function fill_groups ($group_ids) {
- global $_course;
-
- $group_ids = is_array($group_ids) ? $group_ids : array ($group_ids);
- $group_ids = array_map('intval', $group_ids);
-
- if (api_is_course_coach()) {
- for ($i=0 ; $i< count($group_ids) ; $i++) {
- if (!api_is_element_in_the_session(TOOL_GROUP, $group_ids[$i])){
- array_splice($group_ids,$i,1);
- $i--;
- }
- }
- if (count($group_ids)==0) {
- return false;
- }
- }
-
- $category = self::get_category_from_group($group_ids[0]);
-
- $groups_per_user = $category['groups_per_user'];
- $group_table = Database :: get_course_table(TABLE_GROUP);
- $group_user_table = Database :: get_course_table(TABLE_GROUP_USER);
- $session_id = api_get_session_id();
-
- $complete_user_list = CourseManager :: get_real_and_linked_user_list($_course['code'], true, $session_id);
- $number_groups_per_user = ($groups_per_user == self::GROUP_PER_MEMBER_NO_LIMIT ? self::INFINITE : $groups_per_user);
-
- /*
- * Retrieve all the groups where enrollment is still allowed
- * (reverse) ordered by the number of place available
- */
-
- $course_id = api_get_course_int_id();
- $sql = "SELECT g.id gid, g.max_student-count(ug.user_id) nbPlaces, g.max_student
- FROM ".$group_table." g
- LEFT JOIN ".$group_user_table." ug ON
- g.c_id = $course_id AND ug.c_id = $course_id AND g.id = ug.group_id
- WHERE
- g.id IN (".implode(',', $group_ids).")
- GROUP BY (g.id)
- HAVING (nbPlaces > 0 OR g.max_student = ".GroupManager::MEMBER_PER_GROUP_NO_LIMIT.")
- ORDER BY nbPlaces DESC";
- $sql_result = Database::query($sql);
- $group_available_place = array ();
- while ($group = Database::fetch_array($sql_result, 'ASSOC')) {
- $group_available_place[$group['gid']] = $group['nbPlaces'];
- }
-
- /*
- * Retrieve course users (reverse) ordered by the number
- * of group they are already enrolled
- */
- for ($i = 0; $i < count($complete_user_list); $i ++) {
- //find # of groups the user is enrolled in
- $number_of_groups = self :: user_in_number_of_groups($complete_user_list[$i]["user_id"], $category['id']);
- //add # of groups to user list
- $complete_user_list[$i]['number_groups_left'] = $number_groups_per_user - $number_of_groups;
- }
-
- //first sort by user_id to filter out duplicates
- $complete_user_list = TableSort :: sort_table($complete_user_list, 'user_id');
- $complete_user_list = self :: filter_duplicates($complete_user_list, 'user_id');
- $complete_user_list = self :: filter_only_students($complete_user_list);
-
- //now sort by # of group left
- $complete_user_list = TableSort :: sort_table($complete_user_list, 'number_groups_left', SORT_DESC);
- $userToken = array ();
- foreach ($complete_user_list as $this_user) {
- if ($this_user['number_groups_left'] > 0) {
- $userToken[$this_user['user_id']] = $this_user['number_groups_left'];
- }
- }
-
- $changed = true;
- while ($changed) {
- $changed = false;
- reset($group_available_place);
- arsort($group_available_place);
- reset($userToken);
- arsort($userToken);
-
- foreach ($group_available_place as $group_id => $place) {
- foreach ($userToken as $user_id => $places) {
- if (self :: can_user_subscribe($user_id, $group_id)) {
- self :: subscribe_users($user_id, $group_id);
- $group_available_place[$group_id]--;
- //$userToken[$user_id]--;
- unset($userToken[$user_id]);
- $changed = true;
- break;
- }
- }
- if ($changed) {
- break;
- }
- }
- }
- }
- /**
- * Get the number of students in a group.
- * @param int $group_id
- * @return int Number of students in the given group.
- */
- public static function number_of_students ($group_id, $course_id = null) {
- $table_group_user = Database :: get_course_table(TABLE_GROUP_USER);
- $group_id = Database::escape_string($group_id);
- if (empty($course_id)) {
- $course_id = api_get_course_int_id();
- } else {
- $course_id = intval($course_id);
- }
- $sql = "SELECT COUNT(*) AS number_of_students FROM $table_group_user WHERE c_id = $course_id AND group_id = $group_id";
- $db_result = Database::query($sql);
- $db_object = Database::fetch_object($db_result);
- return $db_object->number_of_students;
- }
- /**
- * Maximum number of students in a group
- * @param int $group_id
- * @return int Maximum number of students in the given group.
- */
- public static function maximum_number_of_students ($group_id) {
- $table_group = Database :: get_course_table(TABLE_GROUP);
- $group_id = Database::escape_string($group_id);
- $course_id = api_get_course_int_id();
- $db_result = Database::query("SELECT max_student FROM $table_group WHERE c_id = $course_id AND id = $group_id");
- $db_object = Database::fetch_object($db_result);
- if ($db_object->max_student == 0) {
- return self::INFINITE;
- }
- return $db_object->max_student;
- }
- /**
- * Number of groups of a user
- * @param int $user_id
- * @return int The number of groups the user is subscribed in.
- */
- public static function user_in_number_of_groups ($user_id, $cat_id = null) {
- $table_group_user = Database :: get_course_table(TABLE_GROUP_USER);
- $table_group = Database :: get_course_table(TABLE_GROUP);
- $user_id = Database::escape_string($user_id);
- $cat_id = Database::escape_string($cat_id);
-
- $course_id = api_get_course_int_id();
- $cat_condition = '';
- if (!empty($cat_id)) {
- $cat_condition = " AND g.category_id = $cat_id ";
- }
-
- $sql = "SELECT COUNT(*) AS number_of_groups FROM $table_group_user gu, $table_group g
- WHERE gu.c_id = $course_id AND
- g.c_id = $course_id AND
- gu.user_id = $user_id AND
- g.id = gu.group_id $cat_condition";
- $db_result = Database::query($sql);
- $db_object = Database::fetch_object($db_result);
- return $db_object->number_of_groups;
- }
- /**
- * Is sef-registration allowed?
- * @param int $user_id
- * @param int $group_id
- * @return bool TRUE if self-registration is allowed in the given group.
- */
- public static function is_self_registration_allowed ($user_id, $group_id) {
- $course_id = api_get_course_int_id();
- if (!$user_id > 0)
- return false;
- $table_group = Database :: get_course_table(TABLE_GROUP);
- $group_id= intval($group_id);
- if (isset($group_id)) {
- $sql = "SELECT self_registration_allowed FROM $table_group WHERE c_id = $course_id AND id = $group_id";
- $db_result = Database::query($sql);
- $db_object = Database::fetch_object($db_result);
- return $db_object->self_registration_allowed == 1 && self :: can_user_subscribe($user_id, $group_id);
- } else {
- return false;
- }
- }
- /**
- * Is sef-unregistration allowed?
- * @param int $user_id
- * @param int $group_id
- * @return bool TRUE if self-unregistration is allowed in the given group.
- */
- public static function is_self_unregistration_allowed ($user_id, $group_id) {
- if (!$user_id > 0)
- return false;
- $table_group = Database :: get_course_table(TABLE_GROUP);
- $group_id = Database::escape_string($group_id);
- $course_id = api_get_course_int_id();
- $db_result = Database::query('SELECT self_unregistration_allowed FROM '.$table_group.' WHERE c_id = '.$course_id.' AND id = '.$group_id);
- $db_object = Database::fetch_object($db_result);
- return $db_object->self_unregistration_allowed == 1 && self :: can_user_unsubscribe($user_id, $group_id);
- }
- /**
- * Is user subscribed in group?
- * @param int $user_id
- * @param int $group_id
- * @return bool TRUE if given user is subscribed in given group
- */
- public static function is_subscribed ($user_id, $group_id) {
- if(empty($user_id) or empty($group_id)){return false;}
- $table_group_user = Database :: get_course_table(TABLE_GROUP_USER);
- $group_id = Database::escape_string($group_id);
- $user_id = Database::escape_string($user_id);
- $course_id = api_get_course_int_id();
- $sql = 'SELECT 1 FROM '.$table_group_user.' WHERE c_id = '.$course_id.' AND group_id = '.$group_id.' AND user_id = '.$user_id;
- $db_result = Database::query($sql);
- return Database::num_rows($db_result) > 0;
- }
- /**
- * Can a user subscribe to a specified group in a course
- * @param int $user_id
- * @param int $group_id
- * @return bool TRUE if given user can be subscribed in given group
- */
- public static function can_user_subscribe ($user_id, $group_id) {
- global $_course;
- $course_code = $_course['sysCode'];
- $category = self :: get_category_from_group($group_id);
- $result = CourseManager :: is_user_subscribed_in_real_or_linked_course($user_id, $course_code);
- $result = !self :: is_subscribed($user_id, $group_id);
- $result &= (self :: number_of_students($group_id) < self :: maximum_number_of_students($group_id));
- if ($category['groups_per_user'] == self::GROUP_PER_MEMBER_NO_LIMIT) {
- $category['groups_per_user'] = self::INFINITE;
- }
- $result &= (self :: user_in_number_of_groups($user_id, $category['id']) < $category['groups_per_user']);
- $result &= !self :: is_tutor_of_group($user_id, $group_id);
- return $result;
- }
-
- /**
- * Can a user unsubscribe to a specified group in a course
- * @param int $user_id
- * @param int $group_id
- * @return bool TRUE if given user can be unsubscribed from given group
- * @internal for now, same as GroupManager::is_subscribed($user_id,$group_id)
- */
- public static function can_user_unsubscribe ($user_id, $group_id) {
- $result = self :: is_subscribed($user_id, $group_id);
- return $result;
- }
-
- /**
- * Get all subscribed users from a group
- * @param int $group_id
- * @return array An array with information of all users from the given group.
- * (user_id, firstname, lastname, email)
- */
- public static function get_subscribed_users($group_id) {
- $table_user = Database :: get_main_table(TABLE_MAIN_USER);
- $table_group_user = Database :: get_course_table(TABLE_GROUP_USER);
- $order_clause = api_sort_by_first_name() ? ' ORDER BY u.firstname, u.lastname' : ' ORDER BY u.lastname, u.firstname';
- if (empty($group_id)) {
- return array();
- }
- $group_id = intval($group_id);
- $course_id = api_get_course_int_id();
-
- $sql = "SELECT ug.id, u.user_id, u.lastname, u.firstname, u.email, u.username
- FROM $table_user u INNER JOIN $table_group_user ug ON (ug.user_id = u.user_id)
- WHERE ug.c_id = $course_id AND
- ug.group_id = $group_id
- $order_clause";
- $db_result = Database::query($sql);
- $users = array();
- while ($user = Database::fetch_object($db_result)) {
- $member['user_id'] = $user->user_id;
- $member['firstname'] = $user->firstname;
- $member['lastname'] = $user->lastname;
- $member['email'] = $user->email;
- $member['username'] = $user->username;
- $users[$member['user_id']] = $member;
- }
- return $users;
- }
- /**
- * @author Patrick Cool <patrick.cool@UGent.be>, Ghent University
- * Get all subscribed tutors of a group
- * @param int $group_id
- * @return array An array with information of all users from the given group.
- * (user_id, firstname, lastname, email)
- */
- public static function get_subscribed_tutors ($group_id,$id_only=false) {
- $table_user = Database :: get_main_table(TABLE_MAIN_USER);
- $table_group_tutor = Database :: get_course_table(TABLE_GROUP_TUTOR);
- $order_clause = api_sort_by_first_name() ? ' ORDER BY u.firstname, u.lastname' : ' ORDER BY u.lastname, u.firstname';
- $group_id = Database::escape_string($group_id);
- $course_id = api_get_course_int_id();
-
- $sql = "SELECT tg.id, u.user_id, u.lastname, u.firstname, u.email
- FROM ".$table_user." u, ".$table_group_tutor." tg
- WHERE tg.c_id = $course_id AND
- tg.group_id='".$group_id."' AND
- tg.user_id=u.user_id".$order_clause;
- $db_result = Database::query($sql);
- $users = array ();
- while ($user = Database::fetch_object($db_result)) {
- if (!$id_only) {
- $member['user_id'] = $user->user_id;
- $member['firstname'] = $user->firstname;
- $member['lastname'] = $user->lastname;
- $member['email'] = $user->email;
- $users[] = $member;
- } else {
- $users[]=$user->user_id;
- }
- }
- return $users;
- }
- /**
- * Subscribe user(s) to a specified group in current course
- * @param mixed $user_ids Can be an array with user-id's or a single user-id
- * @param int $group_id
- * @return bool TRUE if successfull
- */
- public static function subscribe_users ($user_ids, $group_id) {
- $user_ids = is_array($user_ids) ? $user_ids : array ($user_ids);
- $result = true;
- $course_id = api_get_course_int_id();
- $table_group_user = Database :: get_course_table(TABLE_GROUP_USER);
- if (!empty($user_ids)) {
- foreach ($user_ids as $index => $user_id) {
- $user_id = Database::escape_string($user_id);
- $group_id = Database::escape_string($group_id);
- $sql = "INSERT INTO ".$table_group_user." (c_id, user_id, group_id) VALUES ('$course_id', '".$user_id."', '".$group_id."')";
- $result &= Database::query($sql);
- }
- }
- return $result;
- }
- /**
- * Subscribe tutor(s) to a specified group in current course
- * @param mixed $user_ids Can be an array with user-id's or a single user-id
- * @param int $group_id
- * @author Patrick Cool <patrick.cool@UGent.be>, Ghent University
- * @see subscribe_users. This function is almost an exact copy of that function.
- * @return bool TRUE if successfull
- */
- public static function subscribe_tutors ($user_ids, $group_id) {
- $user_ids = is_array($user_ids) ? $user_ids : array ($user_ids);
- $result = true;
- $course_id = api_get_course_int_id();
- $table_group_tutor = Database :: get_course_table(TABLE_GROUP_TUTOR);
-
- foreach ($user_ids as $index => $user_id) {
- $user_id = Database::escape_string($user_id);
- $group_id = Database::escape_string($group_id);
- $sql = "INSERT INTO ".$table_group_tutor." (c_id, user_id, group_id) VALUES ('$course_id', '".$user_id."', '".$group_id."')";
- $result &= Database::query($sql);
- }
- return $result;
- }
- /**
- * Unsubscribe user(s) from a specified group in current course
- * @param mixed $user_ids Can be an array with user-id's or a single user-id
- * @param int $group_id
- * @return bool TRUE if successfull
- */
- public static function unsubscribe_users ($user_ids, $group_id) {
- $user_ids = is_array($user_ids) ? $user_ids : array ($user_ids);
- $table_group_user = Database :: get_course_table(TABLE_GROUP_USER);
- $group_id = Database::escape_string($group_id);
- $course_id = api_get_course_int_id();
-
- $result &= Database::query('DELETE FROM '.$table_group_user.' WHERE c_id = '.$course_id.' AND group_id = '.$group_id.' AND user_id IN ('.implode(',', $user_ids).')');
- }
- /**
- * Unsubscribe all users from one or more groups
- * @param mixed $group_id Can be an array with group-id's or a single group-id
- * @return bool TRUE if successfull
- */
- public static function unsubscribe_all_users ($group_ids) {
- $course_id = api_get_course_int_id();
-
- $group_ids = is_array($group_ids) ? $group_ids : array ($group_ids);
- $group_ids = array_map('intval',$group_ids);
- if( count($group_ids) > 0) {
- if(api_is_course_coach()) {
- for($i=0 ; $i<count($group_ids) ; $i++) {
- if(!api_is_element_in_the_session(TOOL_GROUP,$group_ids[$i])) {
- array_splice($group_ids,$i,1);
- $i--;
- }
- }
- if(count($group_ids)==0) {
- return false;
- }
- }
- $table_group_user = Database :: get_course_table(TABLE_GROUP_USER);
- $sql = 'DELETE FROM '.$table_group_user.' WHERE group_id IN ('.implode(',', $group_ids).') AND c_id = '.$course_id;
- $result = Database::query($sql);
- return $result;
- }
- return true;
- }
- /**
- * Unsubscribe all tutors from one or more groups
- * @param mixed $group_id Can be an array with group-id's or a single group-id
- * @see unsubscribe_all_users. This function is almost an exact copy of that function.
- * @return bool TRUE if successfull
- * @author Patrick Cool <patrick.cool@UGent.be>, Ghent University
- */
- public static function unsubscribe_all_tutors ($group_ids) {
- $course_id = api_get_course_int_id();
- $group_ids = is_array($group_ids) ? $group_ids : array ($group_ids);
- if( count($group_ids) > 0) {
- $table_group_tutor = Database :: get_course_table(TABLE_GROUP_TUTOR);
- $sql = 'DELETE FROM '.$table_group_tutor.' WHERE group_id IN ('.implode(',', $group_ids).') AND c_id = '.$course_id;
- $result = Database::query($sql);
- return $result;
- }
- return true;
- }
- /**
- * Is the user a tutor of this group?
- * @param $user_id the id of the user
- * @param $group_id the id of the group
- * @return boolean true/false
- * @todo use the function user_has_access that includes this function
- * @author Patrick Cool <patrick.cool@UGent.be>, Ghent University
- */
- public static function is_tutor_of_group ($user_id,$group_id) {
- global $_course;
- $table_group_tutor = Database :: get_course_table(TABLE_GROUP_TUTOR);
- $user_id = Database::escape_string($user_id);
- $group_id = Database::escape_string($group_id);
- $course_id = api_get_course_int_id();
-
- $sql = "SELECT * FROM ".$table_group_tutor." WHERE c_id = $course_id AND user_id='".$user_id."' AND group_id='".$group_id."'";
- $result = Database::query($sql);
- if (Database::num_rows($result)>0) {
- return true;
- } else {
- return false;
- }
- }
- /**
- * Is the user part of this group? This can be a tutor or a normal member
- * you should use this function if the access to a tool or functionality is restricted to the people who are actually in the group
- * before you had to check if the user was 1. a member of the group OR 2. a tutor of the group. This function combines both
- * @param $user_id the id of the user
- * @param $group_id the id of the group
- * @return boolean true/false
- * @author Patrick Cool <patrick.cool@UGent.be>, Ghent University
- */
- public static function is_user_in_group ($user_id, $group_id) {
- $member = self :: is_subscribed($user_id,$group_id);
- $tutor = self :: is_tutor_of_group($user_id,$group_id);
- if ($member OR $tutor) {
- return true;
- } else {
- return false;
- }
- }
- /**
- * Get all tutors for the current course.
- * @return array An array with firstname, lastname and user_id for all
- * tutors in the current course.
- * @deprecated this function uses the old tutor implementation
- */
- public static function get_all_tutors() {
- global $_course;
- $course_user_table = Database :: get_main_table(TABLE_MAIN_COURSE_USER);
- $user_table = Database :: get_main_table(TABLE_MAIN_USER);
- $sql = "SELECT user.user_id AS user_id, user.lastname AS lastname, user.firstname AS firstname
- FROM ".$user_table." user, ".$course_user_table." cu
- WHERE cu.user_id=user.user_id
- AND cu.tutor_id='1'
- AND cu.course_code='".$_course['sysCode']."'";
- $resultTutor = Database::query($sql);
- $tutors = array ();
- while ($tutor = Database::fetch_array($resultTutor))
- {
- $tutors[] = $tutor;
- }
- return $tutors;
- }
- /**
- * Is user a tutor in current course
- * @param int $user_id
- * @return bool TRUE if given user is a tutor in the current course.
- * @deprecated this function uses the old tutor implementation
- */
- public static function is_tutor ($user_id) {
- global $_course;
- $course_user_table = Database::get_main_table(TABLE_MAIN_COURSE_USER);
- $user_id = Database::escape_string($user_id);
- $sql = "SELECT tutor_id FROM ".$course_user_table."
- WHERE user_id='".$user_id."' AND course_code='".$_course['code']."'"."AND tutor_id=1";
- $db_result = Database::query($sql);
- $result = (Database::num_rows($db_result) > 0);
- return $result;
- }
- /**
- * Get all group's from a given course in which a given user is unsubscribed
- * @author Patrick Cool
- * @param int course id
- * retrieve the groups for
- * @param integer $user_id: the ID of the user you want to know all its
- * group memberships
- */
- public static function get_group_ids ($course_id, $user_id) {
- $groups = array();
- $tbl_group = Database::get_course_table(TABLE_GROUP_USER);
- $tbl_group_tutor = Database::get_course_table(TABLE_GROUP_TUTOR);
- $user_id = intval($user_id);
- $course_id = intval($course_id);
-
- $sql = "SELECT group_id FROM $tbl_group WHERE c_id = $course_id AND user_id = '$user_id'";
- $groupres = Database::query($sql);
-
- if ($groupres) {
- while ($myrow= Database::fetch_array($groupres))
- $groups[]=$myrow['group_id'];
- }
-
- //Also loading if i'm the tutor
- $sql = "SELECT group_id FROM $tbl_group_tutor WHERE c_id = $course_id AND user_id = '$user_id'";
- $groupres = Database::query($sql);
- if ($groupres) {
- while ($myrow= Database::fetch_array($groupres)) {
- $groups[]=$myrow['group_id'];
- }
- }
- if (!empty($groups)) {
- array_filter($groups);
- }
- return $groups;
- }
-
- /*
- Group functions - these take virtual/linked courses into account when necessary
- */
- /**
- * Get a combined list of all users of the real course $course_code
- * and all users in virtual courses linked to this course $course_code
- * Filter user list: remove duplicate users; plus
- * remove users that
- * - are already in the current group $group_id;
- * - do not have student status in these courses;
- * - are not appointed as tutor (group assistent) for this group;
- * - have already reached their maximum # of groups in this course.
- *
- * Originally to get the correct list of users a big SQL statement was used,
- * but this has become more complicated now there is not just one real course but many virtual courses.
- * Still, that could have worked as well.
- *
- * @version 1.1.3
- * @author Roan Embrechts
- */
- public static function get_complete_list_of_users_that_can_be_added_to_group ($course_code, $group_id) {
- global $_course, $_user;
- $category = self :: get_category_from_group($group_id, $course_code);
- $number_of_groups_limit = $category['groups_per_user'] == self::GROUP_PER_MEMBER_NO_LIMIT ? self::INFINITE : $category['groups_per_user'];
- $real_course_code = $_course['sysCode'];
- $real_course_info = Database :: get_course_info($real_course_code);
- $real_course_user_list = CourseManager :: get_user_list_from_course_code($real_course_code);
- //get list of all virtual courses
- $user_subscribed_course_list = CourseManager :: get_list_of_virtual_courses_for_specific_user_and_real_course($_user['user_id'], $real_course_code);
- //add real course to the list
- $user_subscribed_course_list[] = $real_course_info;
- if (!is_array($user_subscribed_course_list)) {
- return;
- }
- //for all courses...
- foreach ($user_subscribed_course_list as $this_course) {
- $this_course_code = $this_course['code'];
- $course_user_list = CourseManager :: get_user_list_from_course_code($this_course_code);
- //for all users in the course
- foreach ($course_user_list as $this_user) {
- $user_id = $this_user['user_id'];
- $loginname = $this_user['username'];
- $lastname = $this_user['lastname'];
- $firstname = $this_user['firstname'];
- $status = $this_user['status'];
- //$role = $this_user['role'];
- $tutor_id = $this_user['tutor_id'];
- $full_name = api_get_person_name($firstname, $lastname);
- if ($lastname == "" || $firstname == '') {
- $full_name = $loginname;
- }
- $complete_user['user_id'] = $user_id;
- $complete_user['full_name'] = $full_name;
- $complete_user['firstname'] = $firstname;
- $complete_user['lastname'] = $lastname;
- $complete_user['status'] = $status;
- $complete_user['tutor_id'] = $tutor_id;
- $student_number_of_groups = self :: user_in_number_of_groups($user_id, $category['id']);
- //filter: only add users that have not exceeded their maximum amount of groups
- if ($student_number_of_groups < $number_of_groups_limit) {
- $complete_user_list[] = $complete_user;
- }
- }
- }
- if (is_array($complete_user_list)) {
- //sort once, on array field "full_name"
- $complete_user_list = TableSort :: sort_table($complete_user_list, "full_name");
- //filter out duplicates, based on field "user_id"
- $complete_user_list = self :: filter_duplicates($complete_user_list, "user_id");
- $complete_user_list = self :: filter_users_already_in_group($complete_user_list, $group_id);
- }
- return $complete_user_list;
- }
- /**
- * Filter out duplicates in a multidimensional array
- * by comparing field $compare_field.
- *
- * @param $user_array_in list of users (must be sorted).
- * @param string $compare_field, the field to be compared
- */
- public static function filter_duplicates ($user_array_in, $compare_field) {
- $total_number = count($user_array_in);
- $user_array_out[0] = $user_array_in[0];
- $count_out = 0;
- for ($count_in = 1; $count_in < $total_number; $count_in ++) {
- if ($user_array_in[$count_in][$compare_field] != $user_array_out[$count_out][$compare_field]) {
- $count_out ++;
- $user_array_out[$count_out] = $user_array_in[$count_in];
- }
- }
- return $user_array_out;
- }
- /**
- * Filters from the array $user_array_in the users already in the group $group_id.
- */
- public static function filter_users_already_in_group ($user_array_in, $group_id) {
- foreach ($user_array_in as $this_user) {
- if (!self :: is_subscribed($this_user['user_id'], $group_id)) {
- $user_array_out[] = $this_user;
- }
- }
- return $user_array_out;
- }
-
- /**
- * Remove all users that are not students and all users who have tutor status
- * from the list.
- */
- public static function filter_only_students($user_array_in) {
- $user_array_out = array ();
- foreach ($user_array_in as $this_user) {
- //if ($this_user['status_rel'] == STUDENT && $this_user['tutor_id'] == 0) {
- if (api_get_session_id()) {
- if ($this_user['status_session'] == 0) {
- $user_array_out[] = $this_user;
- }
- } else {
- if ($this_user['status_rel'] == STUDENT) {
- $user_array_out[] = $this_user;
- }
- }
- }
- return $user_array_out;
- }
-
- /**
- * Check if a user has access to a certain group tool
- * @param int $user_id The user id
- * @param int $group_id The group id
- * @param constant $tool The tool to check the access rights. This should be
- * one of constants: GROUP_TOOL_DOCUMENTS
- * @return bool True if the given user has access to the given tool in the
- * given course.
- */
- public static function user_has_access($user_id, $group_id, $tool) {
-
- //Admin have access everywhere
- if (api_is_platform_admin()) {
- return true;
- }
- //Course admin also have access to everything
- if (api_is_allowed_to_edit()) {
- return true;
- }
-
- switch ($tool) {
- case self::GROUP_TOOL_FORUM :
- $state_key = 'forum_state';
- break;
- case self::GROUP_TOOL_DOCUMENTS :
- $state_key = 'doc_state';
- break;
- case self::GROUP_TOOL_CALENDAR :
- $state_key = 'calendar_state';
- break;
- case self::GROUP_TOOL_ANNOUNCEMENT :
- $state_key = 'announcements_state';
- break;
- case self::GROUP_TOOL_WORK :
- $state_key = 'work_state';
- break;
- case self::GROUP_TOOL_WIKI :
- $state_key = 'wiki_state';
- break;
- case self::GROUP_TOOL_CHAT :
- $state_key = 'chat_state';
- break;
- default:
- return false;
- }
-
- $user_is_in_group = self :: is_user_in_group($user_id, $group_id);
-
- //Check group properties
- $group_info = self :: get_group_properties($group_id);
-
- //Check group category if exists
- $category_group_info = self::get_category_from_group($group_id);
-
- if (!empty($category_group_info)) {
- //if exists check the category group status first
- if ($category_group_info[$state_key] == GroupManager::TOOL_NOT_AVAILABLE) {
- return false;
- } elseif($category_group_info[$state_key] == GroupManager::TOOL_PRIVATE && !$user_is_in_group) {
- return false;
- }
- }
-
- //is_user_in_group() is more complete that the is_subscribed() function
-
- if ($group_info[$state_key] == GroupManager::TOOL_NOT_AVAILABLE) {
- return false;
- } elseif ($group_info[$state_key] == self::TOOL_PUBLIC) {
- return true;
- } elseif (api_is_allowed_to_edit(false,true)) {
- return true;
- } elseif($group_info['tutor_id'] == $user_id) { //this tutor implementation was dropped
- return true;
- } elseif($group_info[$state_key] == GroupManager::TOOL_PRIVATE && !$user_is_in_group) {
- return false;
- } else {
- return $user_is_in_group;
- }
- }
-
- /**
- * Get all groups where a specific user is subscribed
- */
- public static function get_user_group_name ($user_id) {
- $table_group_user = Database::get_course_table(TABLE_GROUP_USER);
- $table_group = Database::get_course_table(TABLE_GROUP);
- $user_id = intval($user_id);
- $course_id = api_get_course_int_id();
- $sql_groups = "SELECT name FROM $table_group g INNER JOIN $table_group_user gu
- ON (gu.group_id=g.id)
- WHERE gu.c_id= $course_id AND
- g.c_id= $course_id AND
- gu.user_id = $user_id";
- $res = Database::query($sql_groups);
- $groups=array();
- while ($group = Database::fetch_array($res)) {
- $groups[] .= $group['name'];
- }
- return $groups;
- }
-
- /**
- * fill_groups_list
- *
- * see : fill_groups
- * Fill the groups with students.
- *
- * note :
- * optimize fill_groups_list <--> fill_groups
- *
- */
- public static function fill_groups_list ($group_ids) {
- $group_ids = is_array($group_ids) ? $group_ids : array ($group_ids);
- $group_ids = array_map('intval',$group_ids);
- if (api_is_course_coach()) {
- for($i=0 ; $i<count($group_ids) ; $i++) {
- if(!api_is_element_in_the_session(TOOL_GROUP,$group_ids[$i])) {
- array_splice($group_ids,$i,1);
- $i--;
- }
- }
- if (count($group_ids)==0){
- return false;}
- }
- global $_course;
- $category = self :: get_category_from_group($group_ids[0]);
- $groups_per_user = $category['groups_per_user'];
- $course_user_table = Database :: get_main_table(TABLE_MAIN_COURSE_USER);
- $group_table = Database :: get_course_table(TABLE_GROUP);
- $group_user_table = Database :: get_course_table(TABLE_GROUP_USER);
- $session_id = api_get_session_id();
- $complete_user_list = CourseManager :: get_real_and_linked_user_list($_course['sysCode'], true, $session_id);
- $number_groups_per_user = ($groups_per_user == self::GROUP_PER_MEMBER_NO_LIMIT ? self::INFINITE : $groups_per_user);
- $course_id = api_get_course_int_id();
- /*
- * Retrieve all the groups where enrollment is still allowed
- * (reverse) ordered by the number of place available
- */
- $sql = "SELECT g.id gid, g.max_student - count(ug.user_id) nbPlaces, g.max_student
- FROM ".$group_table." g
- LEFT JOIN ".$group_user_table." ug
- ON g.id = ug.group_id
- WHERE g.c_id = $course_id AND
- ug.c_id = $course_id AND
- g.id IN (".implode(',', $group_ids).")
- GROUP BY (g.id)
- HAVING (nbPlaces > 0 OR g.max_student = ".GroupManager::MEMBER_PER_GROUP_NO_LIMIT.")
- ORDER BY nbPlaces DESC";
- $sql_result = Database::query($sql);
- $group_available_place = array ();
- while ($group = Database::fetch_array($sql_result, 'ASSOC')) {
- $group_available_place[$group['gid']] = $group['nbPlaces'];
- }
-
- /*
- * Retrieve course users (reverse) ordered by the number
- * of group they are already enrolled
- */
- for ($i = 0; $i < count($complete_user_list); $i ++) {
- //find # of groups the user is enrolled in
- $number_of_groups = self :: user_in_number_of_groups($complete_user_list[$i]["user_id"],$category['id']);
- //add # of groups to user list
- $complete_user_list[$i]['number_groups_left'] = $number_groups_per_user - $number_of_groups;
- }
- //first sort by user_id to filter out duplicates
- $complete_user_list = TableSort :: sort_table($complete_user_list, 'user_id');
- $complete_user_list = self :: filter_duplicates($complete_user_list, 'user_id');
- //$complete_user_list = self :: filter_only_students($complete_user_list);
- //now sort by # of group left
- $complete_user_list = TableSort :: sort_table($complete_user_list, 'number_groups_left', SORT_DESC);
- return $complete_user_list;
-
- }
- }
|