table = Database::get_main_table(TABLE_USERGROUP);
$this->usergroup_rel_user_table = Database::get_main_table(TABLE_USERGROUP_REL_USER);
$this->usergroup_rel_course_table = Database::get_main_table(TABLE_USERGROUP_REL_COURSE);
$this->usergroup_rel_session_table = Database::get_main_table(TABLE_USERGROUP_REL_SESSION);
$this->access_url_rel_usergroup = Database::get_main_table(TABLE_MAIN_ACCESS_URL_REL_USERGROUP);
$this->access_url_rel_user = Database::get_main_table(TABLE_MAIN_ACCESS_URL_REL_USER);
$this->table_course = Database::get_main_table(TABLE_MAIN_COURSE);
$this->table_user = Database::get_main_table(TABLE_MAIN_USER);
$this->useMultipleUrl = api_get_configuration_value('multiple_access_urls');
if ($this->allowTeachers()) {
$this->columns[] = 'author_id';
}
}
/**
* @return bool
*/
public function getUseMultipleUrl()
{
return $this->useMultipleUrl;
}
/**
* @return int
*/
public function getTotalCount()
{
$options = [];
$from = $this->table;
if ($this->getUseMultipleUrl()) {
$urlId = api_get_current_access_url_id();
$options = [
'where' => [
'access_url_id = ?' => [
$urlId,
],
],
];
$from = " $this->table u
INNER JOIN $this->access_url_rel_usergroup a
ON (u.id = a.usergroup_id) ";
}
$row = Database::select('count(*) as count', $from, $options, 'first');
return $row['count'];
}
/**
* @param int $id user group id
* @param bool $getCount
*
* @return array|int
*/
public function getUserGroupUsers($id, $getCount = false)
{
$id = (int) $id;
$select = ' u.* ';
if ($getCount) {
$select = 'COUNT(u.id) count ';
}
if ($this->getUseMultipleUrl()) {
$urlId = api_get_current_access_url_id();
$sql = "SELECT $select
FROM $this->usergroup_rel_user_table u
INNER JOIN $this->access_url_rel_user a
ON (u.user_id = a.user_id)
WHERE u.usergroup_id = $id AND access_url_id = $urlId ";
} else {
$sql = "SELECT $select
FROM $this->usergroup_rel_user_table u
WHERE u.usergroup_id = $id";
}
$result = Database::query($sql);
if ($getCount) {
if (Database::num_rows($result)) {
$row = Database::fetch_array($result);
return $row['count'];
}
return 0;
} else {
$list = [];
$showCalendar = api_get_plugin_setting('learning_calendar', 'enabled') === 'true';
$calendarPlugin = null;
if ($showCalendar) {
$calendarPlugin = LearningCalendarPlugin::create();
}
$url = api_get_path(WEB_PLUGIN_PATH).'learning_calendar/calendar.php?';
while ($data = Database::fetch_array($result)) {
$userId = $data['user_id'];
$userInfo = api_get_user_info($userId);
$data['name'] = $userInfo['complete_name_with_username'];
if ($showCalendar) {
$calendar = $calendarPlugin->getUserCalendar($userId);
$data['calendar_id'] = 0;
$data['calendar'] = '';
if (!empty($calendar)) {
$calendarInfo = $calendarPlugin->getCalendar($calendar['calendar_id']);
if ($calendarInfo) {
$data['calendar_id'] = $calendar['calendar_id'];
$data['calendar'] = Display::url(
$calendarInfo['title'],
$url.'&id='.$calendar['calendar_id']
);
}
}
$courseAndSessionList = Tracking::show_user_progress(
$userId,
0,
'',
true,
true,
true
);
$stats = $calendarPlugin->getUserStats($userId, $courseAndSessionList);
$evaluations = $calendarPlugin->getGradebookEvaluationListToString($userId, $courseAndSessionList);
$data['gradebook_items'] = $evaluations;
$totalTime = 0;
foreach ($courseAndSessionList as $sessionId => $course) {
foreach ($course as $courseId) {
$totalTime += Tracking::get_time_spent_on_the_course($userId, $courseId, $sessionId);
}
}
$data['time_spent'] = api_time_to_hms($totalTime);
$data['lp_day_completed'] = $stats['completed'];
$data['days_diff'] = $stats['completed'] - $stats['user_event_count'];
}
$data['id'] = $data['user_id'];
$list[] = $data;
}
return $list;
}
}
/**
* @param int $type
*
* @return int
*/
public function get_count()
{
$authorCondition = '';
if ($this->allowTeachers()) {
if (!api_is_platform_admin()) {
$userId = api_get_user_id();
$authorCondition = " AND author_id = $userId";
}
}
if ($this->getUseMultipleUrl()) {
$urlId = api_get_current_access_url_id();
$sql = "SELECT count(u.id) as count
FROM $this->table u
INNER JOIN $this->access_url_rel_usergroup a
ON (u.id = a.usergroup_id)
WHERE access_url_id = $urlId $authorCondition
";
$result = Database::query($sql);
if (Database::num_rows($result)) {
$row = Database::fetch_array($result);
return $row['count'];
}
} else {
$sql = "SELECT count(a.id) as count
FROM {$this->table} a
WHERE 1 = 1
$authorCondition
";
$result = Database::query($sql);
if (Database::num_rows($result)) {
$row = Database::fetch_array($result);
return $row['count'];
}
}
return 0;
}
/**
* @param string $name
*
* @return mixed
*/
public function getIdByName($name)
{
$row = Database::select(
'id',
$this->table,
['where' => ['name = ?' => $name]],
'first'
);
return $row['id'];
}
/**
* Displays the title + grid.
*/
public function returnGrid()
{
// action links
$html = '';
if (api_is_platform_admin()) {
$html .= '
'.
Display::return_icon(
'back.png',
get_lang('BackTo').' '.get_lang('PlatformAdmin'),
'',
ICON_SIZE_MEDIUM
).
'';
}
$html .= '
'.
Display::return_icon('new_class.png', get_lang('AddClasses'), '', ICON_SIZE_MEDIUM).
'';
$html .= Display::url(
Display::return_icon('import_csv.png', get_lang('Import'), [], ICON_SIZE_MEDIUM),
'usergroup_import.php'
);
$html .= Display::url(
Display::return_icon('export_csv.png', get_lang('Export'), [], ICON_SIZE_MEDIUM),
'usergroup_export.php'
);
$html .= '
';
} else {
$return .= '...
';
}
}
}
$response->addAssign('ajax_list_courses', 'innerHTML', api_utf8_encode($return));
return $response;
}
/**
* Get user list by usergroup.
*
* @param int $id
*
* @return array
*/
public function getUserListByUserGroup($id)
{
$id = (int) $id;
$sql = "SELECT u.* FROM $this->table_user u
INNER JOIN $this->usergroup_rel_user_table c
ON c.user_id = u.id
WHERE c.usergroup_id = $id"
;
$result = Database::query($sql);
return Database::store_result($result);
}
/**
* @param FormValidator $form
* @param string $type
* @param array $data
*/
public function setForm($form, $type = 'add', $data = [])
{
$header = '';
switch ($type) {
case 'add':
$header = get_lang('Add');
break;
case 'edit':
$header = get_lang('Edit');
break;
}
$form->addHeader($header);
// Name
$form->addElement('text', 'name', get_lang('Name'), ['maxlength' => 255]);
$form->applyFilter('name', 'trim');
$form->addRule('name', get_lang('ThisFieldIsRequired'), 'required');
$form->addRule('name', '', 'maxlength', 255);
// Description
$form->addTextarea('description', get_lang('Description'), ['cols' => 58]);
$form->applyFilter('description', 'trim');
if ($this->showGroupTypeSetting) {
$form->addElement(
'checkbox',
'group_type',
null,
get_lang('SocialGroup')
);
}
// url
$form->addElement('text', 'url', get_lang('Url'));
$form->applyFilter('url', 'trim');
// Picture
$allowed_picture_types = $this->getAllowedPictureExtensions();
$form->addElement('file', 'picture', get_lang('AddPicture'));
$form->addRule(
'picture',
get_lang('OnlyImagesAllowed').' ('.implode(',', $allowed_picture_types).')',
'filetype',
$allowed_picture_types
);
if (isset($data['picture']) && strlen($data['picture']) > 0) {
$picture = $this->get_picture_group($data['id'], $data['picture'], 80);
$img = '
';
$form->addElement('label', null, $img);
$form->addElement('checkbox', 'delete_picture', '', get_lang('DelImage'));
}
$form->addElement('select', 'visibility', get_lang('GroupPermissions'), $this->getGroupStatusList());
$form->setRequiredNote('* '.get_lang('ThisFieldIsRequired').'');
$form->addElement('checkbox', 'allow_members_leave_group', '', get_lang('AllowMemberLeaveGroup'));
// Setting the form elements
if ($type === 'add') {
$form->addButtonCreate($header);
} else {
$form->addButtonUpdate($header);
}
}
/**
* Gets the current group image.
*
* @param string $id group id
* @param string picture group name
* @param string height
* @param string $size_picture picture size it can be small_, medium_ or big_
* @param string style css
*
* @return array with the file and the style of an image i.e $array['file'] $array['style']
*/
public function get_picture_group(
$id,
$picture_file,
$height,
$size_picture = GROUP_IMAGE_SIZE_MEDIUM,
$style = ''
) {
$picture = [];
//$picture['style'] = $style;
if ($picture_file === 'unknown.jpg') {
$picture['file'] = Display::returnIconPath($picture_file);
return $picture;
}
switch ($size_picture) {
case GROUP_IMAGE_SIZE_ORIGINAL:
$size_picture = '';
break;
case GROUP_IMAGE_SIZE_BIG:
$size_picture = 'big_';
break;
case GROUP_IMAGE_SIZE_MEDIUM:
$size_picture = 'medium_';
break;
case GROUP_IMAGE_SIZE_SMALL:
$size_picture = 'small_';
break;
default:
$size_picture = 'medium_';
}
$image_array_sys = $this->get_group_picture_path_by_id($id, 'system', false, true);
$image_array = $this->get_group_picture_path_by_id($id, 'web', false, true);
$file = $image_array_sys['dir'].$size_picture.$picture_file;
if (file_exists($file)) {
$picture['file'] = $image_array['dir'].$size_picture.$picture_file;
//$picture['style'] = '';
if ($height > 0) {
$dimension = api_getimagesize($picture['file']);
$margin = ($height - $dimension['width']) / 2;
//@ todo the padding-top should not be here
}
} else {
$file = $image_array_sys['dir'].$picture_file;
if (file_exists($file) && !is_dir($file)) {
$picture['file'] = $image_array['dir'].$picture_file;
} else {
$picture['file'] = Display::returnIconPath('group_na.png', 64);
}
}
return $picture;
}
/**
* Gets the group picture URL or path from group ID (returns an array).
* The return format is a complete path, enabling recovery of the directory
* with dirname() or the file with basename(). This also works for the
* functions dealing with the user's productions, as they are located in
* the same directory.
*
* @param int User ID
* @param string Type of path to return (can be 'none', 'system', 'rel', 'web')
* @param bool Whether we want to have the directory name returned 'as if'
* there was a file or not (in the case we want to know which directory to create -
* otherwise no file means no split subdir)
* @param bool If we want that the function returns the /main/img/unknown.jpg image set it at true
*
* @return array Array of 2 elements: 'dir' and 'file' which contain the dir
* and file as the name implies if image does not exist it will return the unknown
* image if anonymous parameter is true if not it returns an empty er's
*/
public function get_group_picture_path_by_id($id, $type = 'none', $preview = false, $anonymous = false)
{
switch ($type) {
case 'system': // Base: absolute system path.
$base = api_get_path(SYS_UPLOAD_PATH);
break;
case 'rel': // Base: semi-absolute web path (no server base).
$base = api_get_path(REL_CODE_PATH);
break;
case 'web': // Base: absolute web path.
$base = api_get_path(WEB_UPLOAD_PATH);
break;
case 'none':
default: // Base: empty, the result path below will be relative.
$base = '';
}
$id = (int) $id;
if (empty($id) || empty($type)) {
return $anonymous ? ['dir' => $base.'img/', 'file' => 'unknown.jpg'] : ['dir' => '', 'file' => ''];
}
$group_table = Database::get_main_table(TABLE_USERGROUP);
$sql = "SELECT picture FROM $group_table WHERE id = ".$id;
$res = Database::query($sql);
if (!Database::num_rows($res)) {
return $anonymous ? ['dir' => $base.'img/', 'file' => 'unknown.jpg'] : ['dir' => '', 'file' => ''];
}
$user = Database::fetch_array($res);
$picture_filename = trim($user['picture']);
if (api_get_setting('split_users_upload_directory') === 'true') {
if (!empty($picture_filename)) {
$dir = $base.'groups/'.substr($picture_filename, 0, 1).'/'.$id.'/';
} elseif ($preview) {
$dir = $base.'groups/'.substr((string) $id, 0, 1).'/'.$id.'/';
} else {
$dir = $base.'groups/'.$id.'/';
}
} else {
$dir = $base.'groups/'.$id.'/';
}
return ['dir' => $dir, 'file' => $picture_filename];
}
/**
* @return array
*/
public function getAllowedPictureExtensions()
{
return ['jpg', 'jpeg', 'png', 'gif'];
}
/**
* @return array
*/
public function getGroupStatusList()
{
$status = [
GROUP_PERMISSION_OPEN => get_lang('Open'),
GROUP_PERMISSION_CLOSED => get_lang('Closed'),
];
return $status;
}
/**
* @param int $type
*/
public function setGroupType($type)
{
$this->groupType = (int) $type;
}
/**
* @param int $group_id
* @param int $user_id
*
* @return bool
*/
public function is_group_admin($group_id, $user_id = 0)
{
if (empty($user_id)) {
$user_id = api_get_user_id();
}
$user_role = $this->get_user_group_role($user_id, $group_id);
if (in_array($user_role, [GROUP_USER_PERMISSION_ADMIN])) {
return true;
} else {
return false;
}
}
/**
* @param int $group_id
* @param int $user_id
*
* @return bool
*/
public function isGroupModerator($group_id, $user_id = 0)
{
if (empty($user_id)) {
$user_id = api_get_user_id();
}
$user_role = $this->get_user_group_role($user_id, $group_id);
if (in_array($user_role, [GROUP_USER_PERMISSION_ADMIN, GROUP_USER_PERMISSION_MODERATOR])) {
return true;
} else {
return false;
}
}
/**
* @param int $group_id
* @param int $user_id
*
* @return bool
*/
public function is_group_member($group_id, $user_id = 0)
{
if (api_is_platform_admin()) {
return true;
}
if (empty($user_id)) {
$user_id = api_get_user_id();
}
$roles = [
GROUP_USER_PERMISSION_ADMIN,
GROUP_USER_PERMISSION_MODERATOR,
GROUP_USER_PERMISSION_READER,
GROUP_USER_PERMISSION_HRM,
];
$user_role = $this->get_user_group_role($user_id, $group_id);
if (in_array($user_role, $roles)) {
return true;
} else {
return false;
}
}
/**
* Gets the relationship between a group and a User.
*
* @author Julio Montoya
*
* @param int $user_id
* @param int $group_id
*
* @return int 0 if there are not relationship otherwise returns the user group
* */
public function get_user_group_role($user_id, $group_id)
{
$table_group_rel_user = $this->usergroup_rel_user_table;
$return_value = 0;
$user_id = (int) $user_id;
$group_id = (int) $group_id;
if (!empty($user_id) && !empty($group_id)) {
$sql = "SELECT relation_type
FROM $table_group_rel_user
WHERE
usergroup_id = $group_id AND
user_id = $user_id ";
$result = Database::query($sql);
if (Database::num_rows($result) > 0) {
$row = Database::fetch_array($result, 'ASSOC');
$return_value = $row['relation_type'];
}
}
return $return_value;
}
/**
* @param int $userId
* @param int $groupId
*
* @return string
*/
public function getUserRoleToString($userId, $groupId)
{
$role = $this->get_user_group_role($userId, $groupId);
$roleToString = '';
switch ($role) {
case GROUP_USER_PERMISSION_ADMIN:
$roleToString = get_lang('Admin');
break;
case GROUP_USER_PERMISSION_READER:
$roleToString = get_lang('Reader');
break;
case GROUP_USER_PERMISSION_PENDING_INVITATION:
$roleToString = get_lang('PendingInvitation');
break;
case GROUP_USER_PERMISSION_MODERATOR:
$roleToString = get_lang('Moderator');
break;
case GROUP_USER_PERMISSION_HRM:
$roleToString = get_lang('Drh');
break;
}
return $roleToString;
}
/**
* Add a group of users into a group of URLs.
*
* @author Julio Montoya
*
* @param array $user_list
* @param array $group_list
* @param int $relation_type
*
* @return array
*/
public function add_users_to_groups($user_list, $group_list, $relation_type = GROUP_USER_PERMISSION_READER)
{
$table_url_rel_group = $this->usergroup_rel_user_table;
$result_array = [];
$relation_type = (int) $relation_type;
if (is_array($user_list) && is_array($group_list)) {
foreach ($group_list as $group_id) {
foreach ($user_list as $user_id) {
$user_id = (int) $user_id;
$group_id = (int) $group_id;
$role = $this->get_user_group_role($user_id, $group_id);
if ($role == 0) {
$sql = "INSERT INTO $table_url_rel_group
SET
user_id = $user_id ,
usergroup_id = $group_id ,
relation_type = $relation_type ";
$result = Database::query($sql);
if ($result) {
$result_array[$group_id][$user_id] = 1;
} else {
$result_array[$group_id][$user_id] = 0;
}
}
}
}
}
return $result_array;
}
/**
* Deletes an url and session relationship.
*
* @author Julio Montoya
*
* @param int $userId
* @param int $groupId
*
* @return bool true if success
* */
public function delete_user_rel_group($userId, $groupId)
{
$userId = (int) $userId;
$groupId = (int) $groupId;
if (empty($userId) || empty($groupId)) {
return false;
}
$table = $this->usergroup_rel_user_table;
$sql = "DELETE FROM $table
WHERE
user_id = $userId AND
usergroup_id = $groupId";
$result = Database::query($sql);
return $result;
}
/**
* Add a user into a group.
*
* @author Julio Montoya
*
* @param int $user_id
* @param int $group_id
* @param int $relation_type
*
* @return bool true if success
*/
public function add_user_to_group($user_id, $group_id, $relation_type = GROUP_USER_PERMISSION_READER)
{
$table_url_rel_group = $this->usergroup_rel_user_table;
if (!empty($user_id) && !empty($group_id)) {
$role = $this->get_user_group_role($user_id, $group_id);
if ($role == 0) {
$sql = "INSERT INTO $table_url_rel_group
SET
user_id = ".intval($user_id).",
usergroup_id = ".intval($group_id).",
relation_type = ".intval($relation_type);
Database::query($sql);
} elseif ($role == GROUP_USER_PERMISSION_PENDING_INVITATION) {
//if somebody already invited me I can be added
self::update_user_role($user_id, $group_id, GROUP_USER_PERMISSION_READER);
}
}
return true;
}
/**
* Updates the group_rel_user table with a given user and group ids.
*
* @author Julio Montoya
*
* @param int $user_id
* @param int $group_id
* @param int $relation_type
*/
public function update_user_role($user_id, $group_id, $relation_type = GROUP_USER_PERMISSION_READER)
{
$table_group_rel_user = $this->usergroup_rel_user_table;
$group_id = (int) $group_id;
$user_id = (int) $user_id;
$relation_type = (int) $relation_type;
$sql = "UPDATE $table_group_rel_user
SET relation_type = $relation_type
WHERE user_id = $user_id AND usergroup_id = $group_id";
Database::query($sql);
}
/**
* Gets the inner join from users and group table.
*
* @return array Database::store_result of the result
*
* @author Julio Montoya
* */
public function get_groups_by_user($user_id, $relationType = GROUP_USER_PERMISSION_READER, $with_image = false)
{
$table_group_rel_user = $this->usergroup_rel_user_table;
$tbl_group = $this->table;
$user_id = (int) $user_id;
if ($relationType == 0) {
$relationCondition = '';
} else {
if (is_array($relationType)) {
$relationType = array_map('intval', $relationType);
$relationType = implode("','", $relationType);
$relationCondition = " AND ( gu.relation_type IN ('$relationType')) ";
} else {
$relationType = (int) $relationType;
$relationCondition = " AND gu.relation_type = $relationType ";
}
}
$sql = 'SELECT
g.picture,
g.name,
g.description,
g.id ,
gu.relation_type';
$urlCondition = '';
if ($this->getUseMultipleUrl()) {
$sql .= " FROM $tbl_group g
INNER JOIN ".$this->access_url_rel_usergroup." a
ON (g.id = a.usergroup_id)
INNER JOIN $table_group_rel_user gu
ON gu.usergroup_id = g.id";
$urlId = api_get_current_access_url_id();
$urlCondition = " AND access_url_id = $urlId ";
} else {
$sql .= " FROM $tbl_group g
INNER JOIN $table_group_rel_user gu
ON gu.usergroup_id = g.id";
}
$sql .= " WHERE
g.group_type = ".self::SOCIAL_CLASS." AND
gu.user_id = $user_id
$relationCondition
$urlCondition
ORDER BY created_at DESC ";
$result = Database::query($sql);
$array = [];
if (Database::num_rows($result) > 0) {
while ($row = Database::fetch_array($result, 'ASSOC')) {
if ($with_image) {
$picture = $this->get_picture_group($row['id'], $row['picture'], 80);
$img = '';
$row['picture'] = $img;
}
$array[$row['id']] = $row;
}
}
return $array;
}
/** Gets the inner join of users and group table
* @param int quantity of records
* @param bool show groups with image or not
*
* @return array with group content
*
* @author Julio Montoya
* */
public function get_groups_by_popularity($num = 6, $with_image = true)
{
$table_group_rel_user = $this->usergroup_rel_user_table;
$tbl_group = $this->table;
if (empty($num)) {
$num = 6;
} else {
$num = (int) $num;
}
// only show admins and readers
$whereCondition = " WHERE
g.group_type = ".self::SOCIAL_CLASS." AND
gu.relation_type IN
('".GROUP_USER_PERMISSION_ADMIN."' , '".GROUP_USER_PERMISSION_READER."', '".GROUP_USER_PERMISSION_HRM."') ";
$sql = 'SELECT DISTINCT count(user_id) as count, g.picture, g.name, g.description, g.id ';
$urlCondition = '';
if ($this->getUseMultipleUrl()) {
$sql .= " FROM $tbl_group g
INNER JOIN ".$this->access_url_rel_usergroup." a
ON (g.id = a.usergroup_id)
INNER JOIN $table_group_rel_user gu
ON gu.usergroup_id = g.id";
$urlId = api_get_current_access_url_id();
$urlCondition = " AND access_url_id = $urlId ";
} else {
$sql .= " FROM $tbl_group g
INNER JOIN $table_group_rel_user gu
ON gu.usergroup_id = g.id";
}
$sql .= "
$whereCondition
$urlCondition
GROUP BY g.id
ORDER BY count DESC
LIMIT $num";
$result = Database::query($sql);
$array = [];
while ($row = Database::fetch_array($result, 'ASSOC')) {
if ($with_image) {
$picture = $this->get_picture_group($row['id'], $row['picture'], 80);
$img = '';
$row['picture'] = $img;
}
if (empty($row['id'])) {
continue;
}
$array[$row['id']] = $row;
}
return $array;
}
/** Gets the last groups created
* @param int $num quantity of records
* @param bool $withImage show groups with image or not
*
* @return array with group content
*
* @author Julio Montoya
* */
public function get_groups_by_age($num = 6, $withImage = true)
{
$table_group_rel_user = $this->usergroup_rel_user_table;
$tbl_group = $this->table;
if (empty($num)) {
$num = 6;
} else {
$num = (int) $num;
}
$where = " WHERE
g.group_type = ".self::SOCIAL_CLASS." AND
gu.relation_type IN
('".GROUP_USER_PERMISSION_ADMIN."' ,
'".GROUP_USER_PERMISSION_READER."',
'".GROUP_USER_PERMISSION_MODERATOR."',
'".GROUP_USER_PERMISSION_HRM."')
";
$sql = 'SELECT DISTINCT
count(user_id) as count,
g.picture,
g.name,
g.description,
g.id ';
$urlCondition = '';
if ($this->getUseMultipleUrl()) {
$sql .= " FROM $tbl_group g
INNER JOIN ".$this->access_url_rel_usergroup." a
ON (g.id = a.usergroup_id)
INNER JOIN $table_group_rel_user gu
ON gu.usergroup_id = g.id";
$urlId = api_get_current_access_url_id();
$urlCondition = " AND access_url_id = $urlId ";
} else {
$sql .= " FROM $tbl_group g
INNER JOIN $table_group_rel_user gu
ON gu.usergroup_id = g.id";
}
$sql .= "
$where
$urlCondition
GROUP BY g.id
ORDER BY created_at DESC
LIMIT $num ";
$result = Database::query($sql);
$array = [];
while ($row = Database::fetch_array($result, 'ASSOC')) {
if ($withImage) {
$picture = $this->get_picture_group($row['id'], $row['picture'], 80);
$img = '';
$row['picture'] = $img;
}
if (empty($row['id'])) {
continue;
}
$array[$row['id']] = $row;
}
return $array;
}
/**
* Gets the group's members.
*
* @param int group id
* @param bool show image or not of the group
* @param array list of relation type use constants
* @param int from value
* @param int limit
* @param array image configuration, i.e array('height'=>'20px', 'size'=> '20px')
*
* @return array list of users in a group
*/
public function get_users_by_group(
$group_id,
$withImage = false,
$relation_type = [],
$from = null,
$limit = null,
$image_conf = ['size' => USER_IMAGE_SIZE_MEDIUM, 'height' => 80]
) {
$table_group_rel_user = $this->usergroup_rel_user_table;
$tbl_user = Database::get_main_table(TABLE_MAIN_USER);
$group_id = (int) $group_id;
if (empty($group_id)) {
return [];
}
$limit_text = '';
if (isset($from) && isset($limit)) {
$from = (int) $from;
$limit = (int) $limit;
$limit_text = "LIMIT $from, $limit";
}
if (count($relation_type) == 0) {
$where_relation_condition = '';
} else {
$new_relation_type = [];
foreach ($relation_type as $rel) {
$rel = (int) $rel;
$new_relation_type[] = "'$rel'";
}
$relation_type = implode(',', $new_relation_type);
if (!empty($relation_type)) {
$where_relation_condition = "AND gu.relation_type IN ($relation_type) ";
}
}
$sql = "SELECT picture_uri as image, u.id, CONCAT (u.firstname,' ', u.lastname) as fullname, relation_type
FROM $tbl_user u
INNER JOIN $table_group_rel_user gu
ON (gu.user_id = u.id)
WHERE
gu.usergroup_id= $group_id
$where_relation_condition
ORDER BY relation_type, firstname
$limit_text";
$result = Database::query($sql);
$array = [];
while ($row = Database::fetch_array($result, 'ASSOC')) {
if ($withImage) {
$userInfo = api_get_user_info($row['id']);
$userPicture = UserManager::getUserPicture($row['id']);
$row['image'] = '
';
$row['user_info'] = $userInfo;
}
$array[$row['id']] = $row;
}
return $array;
}
/**
* Gets all the members of a group no matter the relationship for
* more specifications use get_users_by_group.
*
* @param int group id
*
* @return array
*/
public function get_all_users_by_group($group_id)
{
$table_group_rel_user = $this->usergroup_rel_user_table;
$tbl_user = Database::get_main_table(TABLE_MAIN_USER);
$group_id = (int) $group_id;
if (empty($group_id)) {
return [];
}
$sql = "SELECT u.id, u.firstname, u.lastname, relation_type
FROM $tbl_user u
INNER JOIN $table_group_rel_user gu
ON (gu.user_id = u.id)
WHERE gu.usergroup_id= $group_id
ORDER BY relation_type, firstname";
$result = Database::query($sql);
$array = [];
while ($row = Database::fetch_array($result, 'ASSOC')) {
$array[$row['id']] = $row;
}
return $array;
}
/**
* Shows the left column of the group page.
*
* @param int $group_id
* @param int $user_id
* @param string $show
*
* @return string
*/
public function show_group_column_information($group_id, $user_id, $show = '')
{
$html = '';
$group_info = $this->get($group_id);
//my relation with the group is set here
$my_group_role = $this->get_user_group_role($user_id, $group_id);
// Loading group permission
$links = '';
switch ($my_group_role) {
case GROUP_USER_PERMISSION_READER:
// I'm just a reader
$relation_group_title = get_lang('IAmAReader');
$links .= ''.
Display::return_icon('invitation_friend.png', get_lang('InviteFriends')).get_lang('InviteFriends').'';
if (self::canLeave($group_info)) {
$links .= ''.
Display::return_icon('group_leave.png', get_lang('LeaveGroup')).get_lang('LeaveGroup').'';
}
break;
case GROUP_USER_PERMISSION_ADMIN:
$relation_group_title = get_lang('IAmAnAdmin');
$links .= ''.
Display::return_icon('group_edit.png', get_lang('EditGroup')).get_lang('EditGroup').'';
$links .= ''.
Display::return_icon('waiting_list.png', get_lang('WaitingList')).get_lang('WaitingList').'';
$links .= ''.
Display::return_icon('invitation_friend.png', get_lang('InviteFriends')).get_lang('InviteFriends').'';
if (self::canLeave($group_info)) {
$links .= ''.
Display::return_icon('group_leave.png', get_lang('LeaveGroup')).get_lang('LeaveGroup').'';
}
break;
case GROUP_USER_PERMISSION_PENDING_INVITATION:
// $links .= ''.Display::return_icon('addd.gif', get_lang('YouHaveBeenInvitedJoinNow'), array('hspace'=>'6')).'';
break;
case GROUP_USER_PERMISSION_PENDING_INVITATION_SENT_BY_USER:
$relation_group_title = get_lang('WaitingForAdminResponse');
break;
case GROUP_USER_PERMISSION_MODERATOR:
$relation_group_title = get_lang('IAmAModerator');
//$links .= ''.Display::return_icon('compose_message.png', get_lang('NewTopic'), array('hspace'=>'6')).'';
//$links .= ''. Display::return_icon('message_list.png', get_lang('MessageList'), array('hspace'=>'6')).'';
//$links .= ''. Display::return_icon('member_list.png', get_lang('MemberList'), array('hspace'=>'6')).'';
if ($group_info['visibility'] == GROUP_PERMISSION_CLOSED) {
$links .= ''.
Display::return_icon('waiting_list.png', get_lang('WaitingList')).get_lang('WaitingList').'';
}
$links .= ''.
Display::return_icon('invitation_friend.png', get_lang('InviteFriends')).get_lang('InviteFriends').'';
if (self::canLeave($group_info)) {
$links .= ''.
Display::return_icon('group_leave.png', get_lang('LeaveGroup')).get_lang('LeaveGroup').'';
}
break;
case GROUP_USER_PERMISSION_HRM:
$relation_group_title = get_lang('IAmAHRM');
$links .= ''.
Display::return_icon('new-message.png', get_lang('NewTopic')).get_lang('NewTopic').'';
$links .= ''.
Display::return_icon('message_list.png', get_lang('MessageList')).get_lang('MessageList').'';
$links .= ''.
Display::return_icon('invitation_friend.png', get_lang('InviteFriends')).get_lang('InviteFriends').'';
$links .= ''.
Display::return_icon('member_list.png', get_lang('MemberList')).get_lang('MemberList').'';
$links .= ''.
Display::return_icon('delete_data.gif', get_lang('LeaveGroup')).get_lang('LeaveGroup').'';
break;
default:
//$links .= ''.Display::return_icon('addd.gif', get_lang('JoinGroup'), array('hspace'=>'6')).'';
break;
}
if (!empty($links)) {
$list = '';
$list .= $links;
$list .= '
';
$html .= Display::panelCollapse(
get_lang('SocialGroups'),
$list,
'sm-groups',
[],
'groups-acordeon',
'groups-collapse'
);
}
return $html;
}
/**
* @param int $group_id
* @param int $topic_id
*/
public function delete_topic($group_id, $topic_id)
{
$table_message = Database::get_main_table(TABLE_MESSAGE);
$topic_id = (int) $topic_id;
$group_id = (int) $group_id;
$sql = "UPDATE $table_message SET
msg_status = 3
WHERE
group_id = $group_id AND
(id = '$topic_id' OR parent_id = $topic_id)
";
Database::query($sql);
}
/**
* @param string $user_id
* @param string $relation_type
* @param bool $with_image
*
* @deprecated
*
* @return int
*/
public function get_groups_by_user_count(
$user_id = '',
$relation_type = GROUP_USER_PERMISSION_READER,
$with_image = false
) {
$table_group_rel_user = $this->usergroup_rel_user_table;
$tbl_group = $this->table;
$user_id = intval($user_id);
if ($relation_type == 0) {
$where_relation_condition = '';
} else {
$relation_type = intval($relation_type);
$where_relation_condition = "AND gu.relation_type = $relation_type ";
}
$sql = "SELECT count(g.id) as count
FROM $tbl_group g
INNER JOIN $table_group_rel_user gu
ON gu.usergroup_id = g.id
WHERE gu.user_id = $user_id $where_relation_condition ";
$result = Database::query($sql);
if (Database::num_rows($result) > 0) {
$row = Database::fetch_array($result, 'ASSOC');
return $row['count'];
}
return 0;
}
/**
* @param string $tag
* @param int $from
* @param int $number_of_items
*
* @return array
*/
public function get_all_group_tags($tag, $from = 0, $number_of_items = 10, $getCount = false)
{
$group_table = $this->table;
$tag = Database::escape_string($tag);
$from = (int) $from;
$number_of_items = (int) $number_of_items;
$return = [];
$keyword = $tag;
$sql = 'SELECT g.id, g.name, g.description, g.url, g.picture ';
$urlCondition = '';
if ($this->getUseMultipleUrl()) {
$urlId = api_get_current_access_url_id();
$sql .= " FROM $this->table g
INNER JOIN $this->access_url_rel_usergroup a
ON (g.id = a.usergroup_id)";
$urlCondition = " AND access_url_id = $urlId ";
} else {
$sql .= " FROM $group_table g";
}
if (isset($keyword)) {
$sql .= " WHERE (
g.name LIKE '%".$keyword."%' OR
g.description LIKE '%".$keyword."%' OR
g.url LIKE '%".$keyword."%'
) $urlCondition
";
} else {
$sql .= " WHERE 1 = 1 $urlCondition ";
}
$direction = 'ASC';
if (!in_array($direction, ['ASC', 'DESC'])) {
$direction = 'ASC';
}
$from = (int) $from;
$number_of_items = (int) $number_of_items;
$sql .= " LIMIT $from, $number_of_items";
$res = Database::query($sql);
if (Database::num_rows($res) > 0) {
while ($row = Database::fetch_array($res, 'ASSOC')) {
if (!in_array($row['id'], $return)) {
$return[$row['id']] = $row;
}
}
}
return $return;
}
/**
* @param int $group_id
*
* @return array
*/
public static function get_parent_groups($group_id)
{
$t_rel_group = Database::get_main_table(TABLE_USERGROUP_REL_USERGROUP);
$group_id = (int) $group_id;
$max_level = 10;
$select_part = 'SELECT ';
$cond_part = '';
for ($i = 1; $i <= $max_level; $i++) {
$rg_number = $i - 1;
if ($i == $max_level) {
$select_part .= "rg$rg_number.group_id as id_$rg_number ";
} else {
$select_part .= "rg$rg_number.group_id as id_$rg_number, ";
}
if ($i == 1) {
$cond_part .= "FROM $t_rel_group rg0
LEFT JOIN $t_rel_group rg$i
ON rg$rg_number.group_id = rg$i.subgroup_id ";
} else {
$cond_part .= " LEFT JOIN $t_rel_group rg$i
ON rg$rg_number.group_id = rg$i.subgroup_id ";
}
}
$sql = $select_part.' '.$cond_part."WHERE rg0.subgroup_id='$group_id'";
$res = Database::query($sql);
$temp_arr = Database::fetch_array($res, 'NUM');
$toReturn = [];
if (is_array($temp_arr)) {
foreach ($temp_arr as $elt) {
if (isset($elt)) {
$toReturn[] = $elt;
}
}
}
return $toReturn;
}
/**
* Get the group member list by a user and his group role.
*
* @param int $userId The user ID
* @param int $relationType Optional. The relation type. GROUP_USER_PERMISSION_ADMIN by default
* @param bool $includeSubgroupsUsers Optional. Whether include the users from subgroups
*
* @return array
*/
public function getGroupUsersByUser(
$userId,
$relationType = GROUP_USER_PERMISSION_ADMIN,
$includeSubgroupsUsers = true
) {
$userId = (int) $userId;
$groups = $this->get_groups_by_user($userId, $relationType);
$groupsId = array_keys($groups);
$subgroupsId = [];
$userIdList = [];
if ($includeSubgroupsUsers) {
foreach ($groupsId as $groupId) {
$subgroupsId = array_merge($subgroupsId, self::getGroupsByDepthLevel($groupId));
}
$groupsId = array_merge($groupsId, $subgroupsId);
}
$groupsId = array_unique($groupsId);
if (empty($groupsId)) {
return [];
}
foreach ($groupsId as $groupId) {
$groupUsers = $this->get_users_by_group($groupId);
if (empty($groupUsers)) {
continue;
}
foreach ($groupUsers as $member) {
if ($member['user_id'] == $userId) {
continue;
}
$userIdList[] = (int) $member['user_id'];
}
}
return array_unique($userIdList);
}
/**
* Get the subgroups ID from a group.
* The default $levels value is 10 considering it as a extensive level of depth.
*
* @param int $groupId The parent group ID
* @param int $levels The depth levels
*
* @return array The list of ID
*/
public static function getGroupsByDepthLevel($groupId, $levels = 10)
{
$groups = [];
$groupId = (int) $groupId;
$groupTable = Database::get_main_table(TABLE_USERGROUP);
$groupRelGroupTable = Database::get_main_table(TABLE_USERGROUP_REL_USERGROUP);
$select = 'SELECT ';
$from = "FROM $groupTable g1 ";
for ($i = 1; $i <= $levels; $i++) {
$tableIndexNumber = $i;
$tableIndexJoinNumber = $i - 1;
$select .= "g$i.id as id_$i ";
$select .= $i != $levels ? ', ' : null;
if ($i == 1) {
$from .= " INNER JOIN $groupRelGroupTable gg0
ON g1.id = gg0.subgroup_id and gg0.group_id = $groupId ";
} else {
$from .= "LEFT JOIN $groupRelGroupTable gg$tableIndexJoinNumber ";
$from .= " ON g$tableIndexJoinNumber.id = gg$tableIndexJoinNumber.group_id ";
$from .= "LEFT JOIN $groupTable g$tableIndexNumber ";
$from .= " ON gg$tableIndexJoinNumber.subgroup_id = g$tableIndexNumber.id ";
}
}
$result = Database::query("$select $from");
while ($item = Database::fetch_assoc($result)) {
foreach ($item as $myGroupId) {
if (!empty($myGroupId)) {
$groups[] = $myGroupId;
}
}
}
return array_map('intval', $groups);
}
/**
* Set a parent group.
*
* @param int $group_id
* @param int $parent_group_id if 0, we delete the parent_group association
* @param int $relation_type
*
* @return \Doctrine\DBAL\Statement
*/
public function setParentGroup($group_id, $parent_group_id, $relation_type = 1)
{
$table = Database::get_main_table(TABLE_USERGROUP_REL_USERGROUP);
$group_id = (int) $group_id;
$parent_group_id = (int) $parent_group_id;
if ($parent_group_id == 0) {
$sql = "DELETE FROM $table WHERE subgroup_id = $group_id";
} else {
$sql = "SELECT group_id FROM $table WHERE subgroup_id = $group_id";
$res = Database::query($sql);
if (Database::num_rows($res) == 0) {
$sql = "INSERT INTO $table SET
group_id = $parent_group_id,
subgroup_id = $group_id,
relation_type = $relation_type";
} else {
$sql = "UPDATE $table SET
group_id = $parent_group_id,
relation_type = $relation_type
WHERE subgroup_id = $group_id";
}
}
$res = Database::query($sql);
return $res;
}
/**
* Filter the groups/classes info to get a name list only.
*
* @param int $userId The user ID
* @param int $filterByType Optional. The type of group
*
* @return array
*/
public function getNameListByUser($userId, $filterByType = null)
{
$userClasses = $this->getUserGroupListByUser($userId, $filterByType);
return array_column($userClasses, 'name');
}
/**
* Get the HTML necessary for display the groups/classes name list.
*
* @param int $userId The user ID
* @param int $filterByType Optional. The type of group
*
* @return string
*/
public function getLabelsFromNameList($userId, $filterByType = null)
{
$groupsNameListParsed = $this->getNameListByUser($userId, $filterByType);
if (empty($groupsNameListParsed)) {
return '';
}
$nameList = '';
foreach ($groupsNameListParsed as $name) {
$nameList .= '- '.Display::span($name, ['class' => 'label label-info']).'
';
}
$nameList .= '
';
return $nameList;
}
/**
* @param array $groupInfo
*
* @return bool
*/
public static function canLeave($groupInfo)
{
return $groupInfo['allow_members_leave_group'] == 1 ? true : false;
}
/**
* Check permissions and blocks the page.
*
* @param array $userGroupInfo
* @param bool $checkAuthor
* @param bool $checkCourseIsAllow
*/
public function protectScript($userGroupInfo = [], $checkAuthor = true, $checkCourseIsAllow = false)
{
api_block_anonymous_users();
if (api_is_platform_admin()) {
return true;
}
if ($checkCourseIsAllow) {
if (api_is_allowed_to_edit()) {
return true;
}
}
if ($this->allowTeachers() && api_is_teacher()) {
if ($checkAuthor && !empty($userGroupInfo)) {
if (isset($userGroupInfo['author_id']) && $userGroupInfo['author_id'] != api_get_user_id()) {
api_not_allowed(true);
}
}
return true;
} else {
api_protect_admin_script(true);
api_protect_limit_for_session_admin();
}
}
}