%PDF-
%PDF-
Mini Shell
Mini Shell
<?php
/* For licensing terms, see /license.txt */
use Chamilo\CoreBundle\Entity\ExtraField as ExtraFieldEntity;
use Chamilo\CoreBundle\Entity\ExtraFieldValues;
use Chamilo\CourseBundle\Entity\CAnnouncement;
use Chamilo\CourseBundle\Entity\CCalendarEvent;
use Chamilo\CourseBundle\Entity\CItemProperty;
/**
* Include file with functions for the announcements module.
*
* @author jmontoya
*
* @package chamilo.announcements
*
* @todo use OOP
*/
class AnnouncementManager
{
/**
* Constructor.
*/
public function __construct()
{
}
/**
* @return array
*/
public static function getTags(array $excluded = [])
{
$tags = [
'((user_name))',
'((user_email))',
'((user_firstname))',
'((user_lastname))',
'((user_picture))',
'((user_complete_name))',
'((user_official_code))',
'((course_title))',
'((course_link))',
];
$tags[] = '((teachers))';
$extraField = new ExtraField('user');
$extraFields = $extraField->get_all(['filter = ?' => 1]);
if (!empty($extraFields)) {
foreach ($extraFields as $extra) {
$tags[] = "((extra_".$extra['variable']."))";
}
}
$sessionId = api_get_session_id();
if (!empty($sessionId)) {
$tags[] = '((coaches))';
$tags[] = '((general_coach))';
$tags[] = '((general_coach_email))';
}
if ($excluded) {
return array_diff($tags, $excluded);
}
return $tags;
}
/**
* @param int $userId
* @param string $content
* @param string $courseCode
* @param int $sessionId
*
* @return string
*/
public static function parseContent(
$userId,
$content,
$courseCode = '',
$sessionId = 0
) {
$readerInfo = api_get_user_info($userId, false, false, true, true, false, true);
$courseInfo = $courseCode ? api_get_course_info($courseCode) : [];
$teacherList = '';
if ($courseInfo) {
$teacherList = CourseManager::getTeacherListFromCourseCodeToString($courseInfo['code']);
}
$generalCoachName = '';
$generalCoachEmail = '';
$coaches = '';
if (!empty($sessionId)) {
$sessionInfo = api_get_session_info($sessionId);
$coaches = $courseInfo
? CourseManager::get_coachs_from_course_to_string($sessionId, $courseInfo['real_id'])
: '';
$generalCoach = api_get_user_info($sessionInfo['id_coach']);
$generalCoachName = $generalCoach['complete_name'];
$generalCoachEmail = $generalCoach['email'];
}
$data = [];
$data['user_name'] = '';
$data['user_firstname'] = '';
$data['user_lastname'] = '';
$data['user_complete_name'] = '';
$data['user_official_code'] = '';
$data['user_email'] = '';
if (!empty($readerInfo)) {
$data['user_name'] = $readerInfo['username'];
$data['user_email'] = $readerInfo['email'];
$data['user_firstname'] = $readerInfo['firstname'];
$data['user_lastname'] = $readerInfo['lastname'];
$data['user_official_code'] = $readerInfo['official_code'];
$data['user_complete_name'] = $readerInfo['complete_name'];
}
$data['user_picture'] = UserManager::getUserPicture($userId, USER_IMAGE_SIZE_ORIGINAL);
$data['course_title'] = $courseInfo['name'] ?? '';
$courseLink = $courseCode ? api_get_course_url($courseCode, $sessionId) : '';
$data['course_link'] = Display::url($courseLink, $courseLink);
$data['teachers'] = $teacherList;
if (!empty($readerInfo)) {
$extraField = new ExtraField('user');
$extraFields = $extraField->get_all(['filter = ?' => 1]);
if (!empty($extraFields)) {
foreach ($extraFields as $extra) {
$data['extra_'.$extra['variable']] = '';
}
}
if (!empty($readerInfo['extra'])) {
foreach ($readerInfo['extra'] as $extra) {
if (isset($extra['value'])) {
/** @var \Chamilo\CoreBundle\Entity\ExtraFieldValues $value */
$value = $extra['value'];
if ($value instanceof ExtraFieldValues) {
$field = $value->getField();
if ($field instanceof ExtraFieldEntity) {
$data['extra_'.$field->getVariable()] = $value->getValue();
}
}
}
}
}
}
if (!empty($sessionId)) {
$data['coaches'] = $coaches;
$data['general_coach'] = $generalCoachName;
$data['general_coach_email'] = $generalCoachEmail;
}
$tags = self::getTags();
foreach ($tags as $tag) {
$simpleTag = str_replace(['((', '))'], '', $tag);
$value = $data[$simpleTag] ?? '';
$content = str_replace($tag, $value, $content);
}
return $content;
}
/**
* Gets all announcements from a course.
*
* @param array $course_info
* @param int $session_id
*
* @return array html with the content and count of announcements or false otherwise
*/
public static function get_all_annoucement_by_course($course_info, $session_id = 0)
{
$session_id = (int) $session_id;
$courseId = $course_info['real_id'];
$tbl_announcement = Database::get_course_table(TABLE_ANNOUNCEMENT);
$tbl_item_property = Database::get_course_table(TABLE_ITEM_PROPERTY);
$sql = "SELECT DISTINCT
announcement.id,
announcement.title,
announcement.content
FROM $tbl_announcement announcement
INNER JOIN $tbl_item_property i
ON (announcement.id = i.ref AND announcement.c_id = i.c_id)
WHERE
i.tool='announcement' AND
announcement.session_id = '$session_id' AND
announcement.c_id = $courseId AND
i.c_id = $courseId
ORDER BY display_order DESC";
$rs = Database::query($sql);
$num_rows = Database::num_rows($rs);
if ($num_rows > 0) {
$list = [];
while ($row = Database::fetch_array($rs)) {
$list[] = $row;
}
return $list;
}
return false;
}
/**
* This functions switches the visibility a course resource
* using the visibility field in 'item_property'.
*
* @param array $courseInfo
* @param int $id ID of the element of the corresponding type
*
* @return bool False on failure, True on success
*/
public static function change_visibility_announcement($courseInfo, $id)
{
$session_id = api_get_session_id();
$item_visibility = api_get_item_visibility(
$courseInfo,
TOOL_ANNOUNCEMENT,
$id,
$session_id
);
if ($item_visibility == '1') {
api_item_property_update(
$courseInfo,
TOOL_ANNOUNCEMENT,
$id,
'invisible',
api_get_user_id()
);
} else {
api_item_property_update(
$courseInfo,
TOOL_ANNOUNCEMENT,
$id,
'visible',
api_get_user_id()
);
}
return true;
}
/**
* Deletes an announcement.
*
* @param array $courseInfo the course array
* @param int $id the announcement id
*/
public static function delete_announcement($courseInfo, $id)
{
api_item_property_update(
$courseInfo,
TOOL_ANNOUNCEMENT,
$id,
'delete',
api_get_user_id()
);
}
/**
* Deletes all announcements by course.
*
* @param array $courseInfo the course array
*/
public static function delete_all_announcements($courseInfo)
{
$announcements = self::get_all_annoucement_by_course(
$courseInfo,
api_get_session_id()
);
if (!empty($announcements)) {
foreach ($announcements as $annon) {
api_item_property_update(
$courseInfo,
TOOL_ANNOUNCEMENT,
$annon['id'],
'delete',
api_get_user_id()
);
}
}
}
/**
* @param string $title
* @param int $courseId
* @param int $sessionId
* @param int $visibility 1 or 0
*
* @return mixed
*/
public static function getAnnouncementsByTitle(
$title,
$courseId,
$sessionId = 0,
$visibility = 1
) {
$dql = "SELECT a
FROM ChamiloCourseBundle:CAnnouncement a
JOIN ChamiloCourseBundle:CItemProperty ip
WITH a.id = ip.ref AND a.cId = ip.course
WHERE
ip.tool = 'announcement' AND
a.cId = :course AND
a.sessionId = :session AND
a.title like :title AND
ip.visibility = :visibility
ORDER BY a.displayOrder DESC";
$qb = Database::getManager()->createQuery($dql);
$result = $qb->execute(
[
'course' => $courseId,
'session' => $sessionId,
'visibility' => $visibility,
'title' => "%$title%",
]
);
return $result;
}
/**
* @param int $announcementId
* @param int $courseId
* @param int $userId
* @param int $groupId
*
* @return array
*/
public static function getAnnouncementInfoById(
$announcementId,
$courseId,
$userId,
$groupId = 0
) {
$announcementId = (int) $announcementId;
$courseId = (int) $courseId;
$userId = (int) $userId;
$groupId = (int) $groupId;
if (api_is_allowed_to_edit(false, true) ||
(api_get_course_setting('allow_user_edit_announcement') && !api_is_anonymous())
) {
$dql = "SELECT a, ip
FROM ChamiloCourseBundle:CAnnouncement a
JOIN ChamiloCourseBundle:CItemProperty ip
WITH a.id = ip.ref AND a.cId = ip.course
WHERE
a.id = :announcement AND
ip.tool = 'announcement' AND
a.cId = :course
ORDER BY a.displayOrder DESC";
} else {
$groupList[] = $groupId;
if (api_get_user_id() != 0) {
$extraGroupCondition = '';
if (!empty($groupId)) {
$groupProperties = GroupManager::get_group_properties($groupId);
if ($groupProperties['announcements_state'] == GroupManager::TOOL_PRIVATE_BETWEEN_USERS) {
$extraGroupCondition = " AND (
ip.toUser = $userId AND ip.group = $groupId OR
(ip.group IN ('0') OR ip.group IS NULL) OR
(ip.group = $groupId AND (ip.toUser IS NULL OR ip.toUser = 0))
)";
}
}
$dql = "SELECT a, ip
FROM ChamiloCourseBundle:CAnnouncement a
JOIN ChamiloCourseBundle:CItemProperty ip
WITH a.id = ip.ref AND a.cId = ip.course
WHERE
a.id = :announcement AND
ip.tool='announcement' AND
(
ip.toUser = $userId OR
ip.group IN ('0', '".$groupId."') OR
ip.group IS NULL
) AND
ip.visibility = '1' AND
ip.course = :course
$extraGroupCondition
ORDER BY a.displayOrder DESC";
} else {
$dql = "SELECT a, ip
FROM ChamiloCourseBundle:CAnnouncement a
JOIN ChamiloCourseBundle:CItemProperty ip
WITH a.id = ip.ref AND a.cId = ip.course
WHERE
a.id = :announcement AND
ip.tool = 'announcement' AND
(ip.group = '0' OR ip.group IS NULL) AND
ip.visibility = '1' AND
ip.course = :course";
}
}
$qb = Database::getManager()->createQuery($dql);
$result = $qb->execute(
[
'announcement' => $announcementId,
'course' => $courseId,
]
);
if (!empty($result)) {
return [
'announcement' => $result[0],
'item_property' => $result[1],
];
}
return [];
}
/**
* Displays one specific announcement.
*
* @param int $id the id of the announcement you want to display
*
* @return string
*/
public static function displayAnnouncement($id)
{
$id = (int) $id;
if (empty($id)) {
return '';
}
global $charset;
$html = '';
$result = self::getAnnouncementInfoById(
$id,
api_get_course_int_id(),
api_get_user_id(),
api_get_group_id()
);
if (empty($result)) {
return '';
}
/** @var CAnnouncement $announcement */
$announcement = $result['announcement'];
/** @var CItemProperty $itemProperty */
$itemProperty = $result['item_property'];
if (empty($announcement) || empty($itemProperty)) {
return '';
}
$title = Security::remove_XSS($announcement->getTitle());
$content = $announcement->getContent();
$html .= "<table height=\"100\" width=\"100%\" cellpadding=\"5\" cellspacing=\"0\" class=\"table table-hover table-striped data_table\">";
$html .= "<tr><td><h2>".$title."</h2></td></tr>";
if (api_is_allowed_to_edit(false, true) ||
(api_get_course_setting('allow_user_edit_announcement') && !api_is_anonymous())
) {
$modify_icons = "<a href=\"".api_get_self()."?".api_get_cidreq()."&action=modify&id=".$id."\">".
Display::return_icon('edit.png', get_lang('Edit'), '', ICON_SIZE_SMALL)."</a>";
$image_visibility = 'invisible';
$alt_visibility = get_lang('Visible');
if ($itemProperty->getVisibility() === 1) {
$image_visibility = 'visible';
$alt_visibility = get_lang('Hide');
}
global $stok;
$modify_icons .= "<a href=\"".api_get_self()."?".api_get_cidreq()."&action=showhide&id=".$id."&sec_token=".$stok."\">".
Display::return_icon($image_visibility.'.png', $alt_visibility, '', ICON_SIZE_SMALL)."</a>";
if (api_is_allowed_to_edit(false, true)) {
$modify_icons .= "<a
href=\"".api_get_self()."?".api_get_cidreq()."&action=delete&id=".$id."&sec_token=".$stok."\"
onclick=\"javascript:if(!confirm('".addslashes(api_htmlentities(get_lang('ConfirmYourChoice'), ENT_QUOTES, $charset))."')) return false;\">".
Display::return_icon('delete.png', get_lang('Delete'), '', ICON_SIZE_SMALL).
"</a>";
}
$html .= "<tr><th style='text-align:right'>$modify_icons</th></tr>";
}
// The user id is always the current one.
$toUserId = api_get_user_id();
$content = Security::remove_XSS(self::parseContent(
$toUserId,
$content,
api_get_course_id(),
api_get_session_id()
));
$html .= "<tr><td>$content</td></tr>";
$html .= "<tr>";
$html .= "<td class=\"announcements_datum\">".get_lang('LastUpdateDate')." : ";
$lastEdit = $itemProperty->getLasteditDate();
$html .= Display::dateToStringAgoAndLongDate($lastEdit);
$html .= "</td></tr>";
$allow = !api_get_configuration_value('hide_announcement_sent_to_users_info');
if ($allow && api_is_allowed_to_edit(false, true)) {
$sent_to = self::sent_to('announcement', $id);
$sentToForm = self::sent_to_form($sent_to);
$html .= Display::tag(
'td',
get_lang('SentTo').': '.$sentToForm,
['class' => 'announcements_datum']
);
}
$attachment_list = self::get_attachment($id);
if (count($attachment_list) > 0) {
$html .= "<tr><td>";
$realname = $attachment_list['path'];
$user_filename = $attachment_list['filename'];
$full_file_name = 'download.php?'.api_get_cidreq().'&file='.$realname;
$html .= '<br/>';
$html .= Display::return_icon('attachment.gif', get_lang('Attachment'));
$html .= '<a href="'.$full_file_name.' "> '.$user_filename.' </a>';
$html .= ' - <span class="forum_attach_comment" >'.Security::remove_XSS($attachment_list['comment']).'</span>';
if (api_is_allowed_to_edit(false, true)) {
$url = api_get_self()."?".api_get_cidreq().
"&action=delete_attachment&id_attach=".$attachment_list['id']."&sec_token=".$stok;
$html .= Display::url(
Display::return_icon(
'delete.png',
get_lang('Delete'),
'',
16
),
$url
);
}
$html .= '</td></tr>';
}
$html .= '</table>';
return $html;
}
/**
* @param array $courseInfo
*
* @return int
*/
public static function getLastAnnouncementOrder($courseInfo)
{
if (empty($courseInfo)) {
return 0;
}
if (!isset($courseInfo['real_id'])) {
return false;
}
$courseId = $courseInfo['real_id'];
$table = Database::get_course_table(TABLE_ANNOUNCEMENT);
$sql = "SELECT MAX(display_order)
FROM $table
WHERE c_id = $courseId ";
$result = Database::query($sql);
$order = 0;
if (Database::num_rows($result)) {
$row = Database::fetch_array($result);
$order = (int) $row[0] + 1;
}
return $order;
}
/**
* Store an announcement in the database (including its attached file if any).
*
* @param array $courseInfo
* @param int $sessionId
* @param string $title Announcement title (pure text)
* @param string $newContent Content of the announcement (can be HTML)
* @param array $sentTo Array of users and groups to send the announcement to
* @param array $file uploaded file $_FILES
* @param string $file_comment Comment describing the attachment
* @param string $end_date
* @param bool $sendToUsersInSession
* @param int $authorId
*
* @return int false on failure, ID of the announcement on success
*/
public static function add_announcement(
$courseInfo,
$sessionId,
$title,
$newContent,
$sentTo,
$file = [],
$file_comment = null,
$end_date = null,
$sendToUsersInSession = false,
$authorId = 0
) {
if (empty($courseInfo)) {
return false;
}
if (!isset($courseInfo['real_id'])) {
return false;
}
$courseId = $courseInfo['real_id'];
$tbl_announcement = Database::get_course_table(TABLE_ANNOUNCEMENT);
$authorId = empty($authorId) ? api_get_user_id() : $authorId;
if (empty($end_date)) {
$end_date = api_get_utc_datetime();
}
$order = self::getLastAnnouncementOrder($courseInfo);
// store in the table announcement
$params = [
'c_id' => $courseId,
'content' => $newContent,
'title' => $title,
'end_date' => $end_date,
'display_order' => $order,
'session_id' => (int) $sessionId,
];
$last_id = Database::insert($tbl_announcement, $params);
if (empty($last_id)) {
return false;
} else {
$sql = "UPDATE $tbl_announcement SET id = iid WHERE iid = $last_id";
Database::query($sql);
if (!empty($file)) {
self::add_announcement_attachment_file(
$last_id,
$file_comment,
$_FILES['user_upload']
);
}
// store in item_property (first the groups, then the users
if (empty($sentTo) ||
(!empty($sentTo) && isset($sentTo[0]) && $sentTo[0] == 'everyone')
) {
// The message is sent to EVERYONE, so we set the group to 0
api_item_property_update(
$courseInfo,
TOOL_ANNOUNCEMENT,
$last_id,
'AnnouncementAdded',
$authorId,
'0',
null,
null,
null,
$sessionId
);
} else {
$send_to = CourseManager::separateUsersGroups($sentTo);
$batchSize = 20;
$em = Database::getManager();
// Storing the selected groups
if (is_array($send_to['groups']) &&
!empty($send_to['groups'])
) {
$counter = 1;
foreach ($send_to['groups'] as $group) {
$groupInfo = GroupManager::get_group_properties($group);
api_item_property_update(
$courseInfo,
TOOL_ANNOUNCEMENT,
$last_id,
'AnnouncementAdded',
$authorId,
$groupInfo
);
if (($counter % $batchSize) === 0) {
$em->flush();
$em->clear();
}
$counter++;
}
}
// Storing the selected users
if (is_array($send_to['users'])) {
$counter = 1;
foreach ($send_to['users'] as $user) {
api_item_property_update(
$courseInfo,
TOOL_ANNOUNCEMENT,
$last_id,
'AnnouncementAdded',
$authorId,
'',
$user
);
if (($counter % $batchSize) === 0) {
$em->flush();
$em->clear();
}
$counter++;
}
}
}
if ($sendToUsersInSession) {
self::addAnnouncementToAllUsersInSessions($last_id);
}
return $last_id;
}
}
/**
* @param string $title
* @param string $newContent
* @param int $groupId
* @param array $to_users
* @param array $file
* @param string $file_comment
* @param bool $sendToUsersInSession
*
* @return bool|int
*/
public static function addGroupAnnouncement(
$title,
$newContent,
$groupId,
$to_users,
$file = [],
$file_comment = '',
$sendToUsersInSession = false
) {
$courseInfo = api_get_course_info();
// Database definitions
$table = Database::get_course_table(TABLE_ANNOUNCEMENT);
$order = self::getLastAnnouncementOrder($courseInfo);
$now = api_get_utc_datetime();
$courseId = api_get_course_int_id();
// store in the table announcement
$params = [
'c_id' => $courseId,
'content' => $newContent,
'title' => $title,
'end_date' => $now,
'display_order' => $order,
'session_id' => api_get_session_id(),
];
$last_id = Database::insert($table, $params);
// Store the attach file
if ($last_id) {
$sql = "UPDATE $table SET id = iid
WHERE iid = $last_id";
Database::query($sql);
if (!empty($file)) {
self::add_announcement_attachment_file(
$last_id,
$file_comment,
$file
);
}
$send_to_users = CourseManager::separateUsersGroups($to_users);
// if nothing was selected in the menu then send to all the group
$sentToAllGroup = false;
if (empty($send_to_users['groups']) && empty($send_to_users['users'])) {
$groupInfo = GroupManager::get_group_properties($groupId);
api_item_property_update(
$courseInfo,
TOOL_ANNOUNCEMENT,
$last_id,
'AnnouncementAdded',
api_get_user_id(),
$groupInfo
);
$sentToAllGroup = true;
}
if ($sentToAllGroup === false) {
if (!empty($send_to_users['groups'])) {
foreach ($send_to_users['groups'] as $group) {
$groupInfo = GroupManager::get_group_properties($group);
api_item_property_update(
$courseInfo,
TOOL_ANNOUNCEMENT,
$last_id,
'AnnouncementAdded',
api_get_user_id(),
$groupInfo
);
}
}
$groupInfo = GroupManager::get_group_properties($groupId);
if (!empty($send_to_users['users'])) {
foreach ($send_to_users['users'] as $user) {
api_item_property_update(
$courseInfo,
TOOL_ANNOUNCEMENT,
$last_id,
'AnnouncementAdded',
api_get_user_id(),
$groupInfo,
$user
);
}
}
}
if ($sendToUsersInSession) {
self::addAnnouncementToAllUsersInSessions($last_id);
}
}
return $last_id;
}
/**
* This function stores the announcement item in the announcement table
* and updates the item_property table.
*
* @param int $id id of the announcement
* @param string $title
* @param string $newContent
* @param array $to users that will receive the announcement
* @param mixed $file attachment
* @param string $file_comment file comment
* @param bool $sendToUsersInSession
*/
public static function edit_announcement(
$id,
$title,
$newContent,
$to,
$file = [],
$file_comment = '',
$sendToUsersInSession = false
) {
$courseInfo = api_get_course_info();
$courseId = api_get_course_int_id();
$tbl_item_property = Database::get_course_table(TABLE_ITEM_PROPERTY);
$table = Database::get_course_table(TABLE_ANNOUNCEMENT);
$id = (int) $id;
$params = [
'title' => $title,
'content' => $newContent,
];
Database::update(
$table,
$params,
['c_id = ? AND id = ?' => [$courseId, $id]]
);
// save attachment file
$row_attach = self::get_attachment($id);
$id_attach = 0;
if ($row_attach) {
$id_attach = (int) $row_attach['id'];
}
if (!empty($file)) {
if (empty($id_attach)) {
self::add_announcement_attachment_file(
$id,
$file_comment,
$file
);
} else {
self::edit_announcement_attachment_file(
$id_attach,
$file,
$file_comment
);
}
}
// We remove everything from item_property for this
$sql = "DELETE FROM $tbl_item_property
WHERE c_id = $courseId AND ref='$id' AND tool='announcement'";
Database::query($sql);
if ($sendToUsersInSession) {
self::addAnnouncementToAllUsersInSessions($id);
}
// store in item_property (first the groups, then the users
if (!empty($to)) {
// !is_null($to): when no user is selected we send it to everyone
$send_to = CourseManager::separateUsersGroups($to);
// storing the selected groups
if (is_array($send_to['groups'])) {
foreach ($send_to['groups'] as $group) {
$groupInfo = GroupManager::get_group_properties($group);
if (empty($groupInfo)) {
// Probably the group id and iid are different try checking the iid
$groupInfo = GroupManager::get_group_properties($group, true);
}
if ($groupInfo) {
api_item_property_update(
$courseInfo,
TOOL_ANNOUNCEMENT,
$id,
'AnnouncementUpdated',
api_get_user_id(),
$groupInfo
);
}
}
}
// storing the selected users
if (is_array($send_to['users'])) {
foreach ($send_to['users'] as $user) {
api_item_property_update(
$courseInfo,
TOOL_ANNOUNCEMENT,
$id,
'AnnouncementUpdated',
api_get_user_id(),
0,
$user
);
}
}
// Send to everyone
if (isset($to[0]) && $to[0] === 'everyone') {
api_item_property_update(
$courseInfo,
TOOL_ANNOUNCEMENT,
$id,
'AnnouncementUpdated',
api_get_user_id(),
0
);
}
} else {
// the message is sent to everyone, so we set the group to 0
api_item_property_update(
$courseInfo,
TOOL_ANNOUNCEMENT,
$id,
'AnnouncementUpdated',
api_get_user_id(),
0
);
}
}
/**
* @param int $announcementId
*/
public static function addAnnouncementToAllUsersInSessions($announcementId)
{
$courseCode = api_get_course_id();
$courseInfo = api_get_course_info();
$sessionList = SessionManager::get_session_by_course(api_get_course_int_id());
if (!empty($sessionList)) {
foreach ($sessionList as $sessionInfo) {
$sessionId = $sessionInfo['id'];
$userList = CourseManager::get_user_list_from_course_code(
$courseCode,
$sessionId
);
if (!empty($userList)) {
foreach ($userList as $user) {
api_item_property_update(
$courseInfo,
TOOL_ANNOUNCEMENT,
$announcementId,
'AnnouncementUpdated',
api_get_user_id(),
0,
$user['user_id'],
0,
0,
$sessionId
);
}
}
}
}
}
/**
* @param int $insert_id
*
* @return bool
*/
public static function update_mail_sent($insert_id)
{
$table = Database::get_course_table(TABLE_ANNOUNCEMENT);
if ($insert_id != strval(intval($insert_id))) {
return false;
}
$insert_id = intval($insert_id);
$courseId = api_get_course_int_id();
// store the modifications in the table tbl_annoucement
$sql = "UPDATE $table SET email_sent='1'
WHERE c_id = $courseId AND id = $insert_id";
Database::query($sql);
}
/**
* @param int $user_id
*
* @return array|bool
*/
public static function getAnnoucementCourseTotalByUser($user_id)
{
$user_id = (int) $user_id;
if (empty($user_id)) {
return false;
}
$tbl_announcement = Database::get_course_table(TABLE_ANNOUNCEMENT);
$tbl_item_property = Database::get_course_table(TABLE_ITEM_PROPERTY);
$sql = "SELECT DISTINCT
announcement.c_id,
count(announcement.id) count
FROM $tbl_announcement announcement
INNER JOIN $tbl_item_property ip
ON (announcement.id = ip.ref AND announcement.c_id = ip.c_id)
WHERE
ip.tool='announcement' AND
(
ip.to_user_id = '$user_id' AND
(ip.to_group_id='0' OR ip.to_group_id IS NULL)
)
AND ip.visibility='1'
AND announcement.session_id = 0
GROUP BY announcement.c_id";
$rs = Database::query($sql);
$num_rows = Database::num_rows($rs);
$result = [];
if ($num_rows > 0) {
while ($row = Database::fetch_array($rs, 'ASSOC')) {
if (empty($row['c_id'])) {
continue;
}
$result[] = ['course' => api_get_course_info_by_id($row['c_id']), 'count' => $row['count']];
}
}
return $result;
}
/**
* Returns announcement info from its id.
*
* @param int $courseId
* @param int $id
*
* @return array
*/
public static function get_by_id($courseId, $id)
{
$id = (int) $id;
$courseId = $courseId ? (int) $courseId : api_get_course_int_id();
$tbl_announcement = Database::get_course_table(TABLE_ANNOUNCEMENT);
$tbl_item_property = Database::get_course_table(TABLE_ITEM_PROPERTY);
$sql = "SELECT DISTINCT
announcement.id,
announcement.title,
announcement.content,
ip.to_group_id
FROM $tbl_announcement announcement
INNER JOIN $tbl_item_property ip
ON
announcement.id = ip.ref AND
announcement.c_id = ip.c_id
WHERE
announcement.c_id = $courseId AND
ip.tool='announcement' AND
announcement.id = $id
";
$result = Database::query($sql);
if (Database::num_rows($result)) {
return Database::fetch_array($result);
}
return [];
}
/**
* this function gets all the groups of the course,
* not including linked courses.
*/
public static function get_course_groups()
{
$session_id = api_get_session_id();
if ($session_id != 0) {
$new_group_list = CourseManager::get_group_list_of_course(
api_get_course_id(),
$session_id,
1
);
} else {
$new_group_list = CourseManager::get_group_list_of_course(
api_get_course_id(),
0,
1
);
}
return $new_group_list;
}
/**
* This tools loads all the users and all the groups who have received
* a specific item (in this case an announcement item).
*
* @param string $tool
* @param int $id
* @param bool $includeGroupWhenLoadingUser
*
* @return array
*/
public static function loadEditUsers($tool, $id, $includeGroupWhenLoadingUser = false)
{
$table = Database::get_course_table(TABLE_ITEM_PROPERTY);
$tool = Database::escape_string($tool);
$id = (int) $id;
$courseId = api_get_course_int_id();
$groupId = api_get_group_id();
$sql = "SELECT to_user_id, to_group_id FROM $table
WHERE c_id = $courseId AND tool='$tool' AND ref = $id";
$result = Database::query($sql);
$to = [];
while ($row = Database::fetch_array($result)) {
// This is the iid of c_group_info
$toGroup = $row['to_group_id'];
if (empty($row['to_user_id']) && !empty($groupId) && $groupId != $toGroup) {
//continue;
}
switch ($toGroup) {
// it was send to one specific user
case null:
if (isset($row['to_user_id']) && !empty($row['to_user_id'])) {
if (!in_array('USER:'.$row['to_user_id'], $to)) {
$to[] = 'USER:'.$row['to_user_id'];
}
}
break;
// it was sent to everyone
case 0:
return 'everyone';
break;
default:
if (isset($row['to_user_id']) && !empty($row['to_user_id'])) {
if (!in_array('USER:'.$row['to_user_id'], $to)) {
$to[] = 'USER:'.$row['to_user_id'];
}
} else {
if (!in_array('GROUP:'.$toGroup, $to)) {
$to[] = 'GROUP:'.$toGroup;
}
}
if ($includeGroupWhenLoadingUser) {
if (!in_array('GROUP:'.$toGroup, $to)) {
$to[] = 'GROUP:'.$toGroup;
}
}
break;
}
}
return $to;
}
/**
* constructs the form to display all the groups and users the message has been sent to.
*
* @param array $sent_to_array
* input:
* $sent_to_array is a 2 dimensional array containing the groups and the users
* the first level is a distinction between groups and users:
* $sent_to_array['groups'] * and $sent_to_array['users']
* $sent_to_array['groups'] (resp. $sent_to_array['users']) is also an array
* containing all the id's of the groups (resp. users) who have received this message.
*
* @return string
*
* @author Patrick Cool <patrick.cool@>
*/
public static function sent_to_form($sent_to_array)
{
// we find all the names of the groups
$group_names = self::get_course_groups();
// we count the number of users and the number of groups
$number_users = 0;
if (isset($sent_to_array['users'])) {
$number_users = count($sent_to_array['users']);
}
$number_groups = 0;
if (isset($sent_to_array['groups'])) {
$number_groups = count($sent_to_array['groups']);
}
$total_numbers = $number_users + $number_groups;
// starting the form if there is more than one user/group
$output = [];
if ($total_numbers > 1) {
// outputting the name of the groups
if (is_array($sent_to_array['groups'])) {
foreach ($sent_to_array['groups'] as $group_id) {
$users = GroupManager::getStudents($group_id, true);
$userToArray = [];
foreach ($users as $student) {
$userToArray[] = $student['complete_name_with_username'];
}
$output[] =
'<br />'.
Display::label($group_names[$group_id]['name'], 'info').
' '.implode(', ', $userToArray);
}
}
if (isset($sent_to_array['users'])) {
if (is_array($sent_to_array['users'])) {
$usersToArray = [];
foreach ($sent_to_array['users'] as $user_id) {
$user_info = api_get_user_info($user_id);
$usersToArray[] = $user_info['complete_name_with_username'];
}
$output[] = '<br />'.Display::label(get_lang('Users')).' '.implode(', ', $usersToArray);
}
}
} else {
// there is only one user/group
if (isset($sent_to_array['users']) && is_array($sent_to_array['users'])) {
$user_info = api_get_user_info($sent_to_array['users'][0]);
$output[] = api_get_person_name($user_info['firstname'], $user_info['lastname']);
}
if (isset($sent_to_array['groups']) &&
is_array($sent_to_array['groups']) &&
isset($sent_to_array['groups'][0]) &&
$sent_to_array['groups'][0] !== 0
) {
$group_id = $sent_to_array['groups'][0];
$users = GroupManager::getStudents($group_id, true);
$userToArray = [];
foreach ($users as $student) {
$userToArray[] = $student['complete_name_with_username'];
}
$output[] =
'<br />'.
Display::label($group_names[$group_id]['name'], 'info').
' '.implode(', ', $userToArray);
}
if (empty($sent_to_array['groups']) && empty($sent_to_array['users'])) {
$output[] = " ".get_lang('Everybody');
}
}
if (!empty($output)) {
$output = array_filter($output);
if (count($output) > 0) {
$output = implode('<br />', $output);
}
return $output;
}
}
/**
* Returns all the users and all the groups a specific announcement item
* has been sent to.
*
* @param string The tool (announcement, agenda, ...)
* @param int ID of the element of the corresponding type
*
* @return array Array of users and groups to whom the element has been sent
*/
public static function sent_to($tool, $id)
{
$table = Database::get_course_table(TABLE_ITEM_PROPERTY);
$tool = Database::escape_string($tool);
$id = (int) $id;
$sent_to_group = [];
$sent_to = [];
$courseId = api_get_course_int_id();
$sql = "SELECT to_group_id, to_user_id
FROM $table
WHERE c_id = $courseId AND tool = '$tool' AND ref=".$id;
$result = Database::query($sql);
while ($row = Database::fetch_array($result)) {
// if to_user_id <> 0 then it is sent to a specific user
if ($row['to_user_id'] != 0) {
$sent_to_user[] = $row['to_user_id'];
continue;
}
// if to_group_id is null then it is sent to a specific user
// if to_group_id = 0 then it is sent to everybody
if ($row['to_group_id'] != 0) {
$sent_to_group[] = $row['to_group_id'];
}
}
if (isset($sent_to_group)) {
$sent_to['groups'] = $sent_to_group;
}
if (isset($sent_to_user)) {
$sent_to['users'] = $sent_to_user;
}
return $sent_to;
}
/**
* Show a list with all the attachments according to the post's id.
*
* @param int $announcementId
*
* @return array with the post info
*
* @author Arthur Portugal
*
* @version November 2009, dokeos 1.8.6.2
*/
public static function get_attachment($announcementId)
{
$table = Database::get_course_table(TABLE_ANNOUNCEMENT_ATTACHMENT);
$announcementId = (int) $announcementId;
$courseId = api_get_course_int_id();
$row = [];
$sql = 'SELECT id, path, filename, comment
FROM '.$table.'
WHERE c_id = '.$courseId.' AND announcement_id = '.$announcementId;
$result = Database::query($sql);
if (Database::num_rows($result) != 0) {
$row = Database::fetch_array($result, 'ASSOC');
}
return $row;
}
/**
* This function add a attachment file into announcement.
*
* @param int announcement id
* @param string file comment
* @param array uploaded file $_FILES
*
* @return int -1 if failed, 0 if unknown (should not happen), 1 if success
*/
public static function add_announcement_attachment_file(
$announcement_id,
$file_comment,
$file
) {
$courseInfo = api_get_course_info();
$table = Database::get_course_table(TABLE_ANNOUNCEMENT_ATTACHMENT);
$return = 0;
$announcement_id = intval($announcement_id);
$courseId = api_get_course_int_id();
if (is_array($file) && $file['error'] == 0) {
// TODO: This path is obsolete. The new document repository scheme should be kept in mind here.
$courseDir = $courseInfo['path'].'/upload/announcements';
$sys_course_path = api_get_path(SYS_COURSE_PATH);
$updir = $sys_course_path.$courseDir;
// Try to add an extension to the file if it hasn't one
$new_file_name = add_ext_on_mime(stripslashes($file['name']), $file['type']);
// user's file name
$file_name = $file['name'];
if (!filter_extension($new_file_name)) {
$return = -1;
echo Display::return_message(get_lang('UplUnableToSaveFileFilteredExtension'), 'error');
} else {
$new_file_name = uniqid('');
$new_path = $updir.'/'.$new_file_name;
// This file is copy here but its cleaned in api_mail_html in api.lib.php
copy($file['tmp_name'], $new_path);
$params = [
'c_id' => $courseId,
'filename' => $file_name,
'comment' => $file_comment,
'path' => $new_file_name,
'announcement_id' => $announcement_id,
'size' => (int) $file['size'],
];
$insertId = Database::insert($table, $params);
if ($insertId) {
$sql = "UPDATE $table SET id = iid
WHERE iid = $insertId";
Database::query($sql);
}
$return = 1;
}
}
return $return;
}
/**
* This function edit a attachment file into announcement.
*
* @param int attach id
* @param array uploaded file $_FILES
* @param string file comment
*
* @return int
*/
public static function edit_announcement_attachment_file(
$id_attach,
$file,
$file_comment
) {
$courseInfo = api_get_course_info();
$table = Database::get_course_table(TABLE_ANNOUNCEMENT_ATTACHMENT);
$return = 0;
$courseId = api_get_course_int_id();
if (is_array($file) && $file['error'] == 0) {
// TODO: This path is obsolete. The new document repository scheme should be kept in mind here.
$courseDir = $courseInfo['path'].'/upload/announcements';
$sys_course_path = api_get_path(SYS_COURSE_PATH);
$updir = $sys_course_path.$courseDir;
// Try to add an extension to the file if it hasn't one
$new_file_name = add_ext_on_mime(
stripslashes($file['name']),
$file['type']
);
// user's file name
$file_name = $file['name'];
if (!filter_extension($new_file_name)) {
$return = -1;
echo Display::return_message(
get_lang('UplUnableToSaveFileFilteredExtension'),
'error'
);
} else {
$new_file_name = uniqid('');
$new_path = $updir.'/'.$new_file_name;
copy($file['tmp_name'], $new_path);
$safe_file_comment = Database::escape_string($file_comment);
$safe_file_name = Database::escape_string($file_name);
$safe_new_file_name = Database::escape_string($new_file_name);
$id_attach = intval($id_attach);
$sql = "UPDATE $table SET
filename = '$safe_file_name',
comment = '$safe_file_comment',
path = '$safe_new_file_name',
size ='".intval($file['size'])."'
WHERE c_id = $courseId AND id = '$id_attach'";
$result = Database::query($sql);
if ($result === false) {
$return = -1;
echo Display::return_message(
get_lang('UplUnableToSaveFile'),
'error'
);
} else {
$return = 1;
}
}
}
return $return;
}
/**
* This function delete a attachment file by id.
*
* @param int $id attachment file Id
*
* @return bool
*/
public static function delete_announcement_attachment_file($id)
{
$table = Database::get_course_table(TABLE_ANNOUNCEMENT_ATTACHMENT);
$id = intval($id);
$courseId = api_get_course_int_id();
if (empty($courseId) || empty($id)) {
return false;
}
$sql = "DELETE FROM $table
WHERE c_id = $courseId AND id = $id";
Database::query($sql);
return true;
}
/**
* @param array $courseInfo
* @param int $sessionId
* @param int $announcementId
* @param bool $sendToUsersInSession
* @param bool $sendToDrhUsers
* @param Monolog\Handler\HandlerInterface logger
* @param int $senderId
* @param bool $directMessage
* @param bool $checkUrls It checks access url of user when multiple_access_urls = true
*
* @return array
*/
public static function sendEmail(
$courseInfo,
$sessionId,
$announcementId,
$sendToUsersInSession = false,
$sendToDrhUsers = false,
$logger = null,
$senderId = 0,
$directMessage = false,
$checkUrls = false
) {
$email = new AnnouncementEmail($courseInfo, $sessionId, $announcementId, $logger);
return $email->send($sendToUsersInSession, $sendToDrhUsers, $senderId, $directMessage, $checkUrls);
}
/**
* @param $stok
* @param $announcement_number
* @param bool $getCount
* @param null $start
* @param null $limit
* @param string $sidx
* @param string $sord
* @param string $titleToSearch
* @param int $userIdToSearch
* @param int $userId
* @param int $courseId
* @param int $sessionId
*
* @return array
*/
public static function getAnnouncements(
$stok,
$announcement_number,
$getCount = false,
$start = null,
$limit = null,
$sidx = '',
$sord = '',
$titleToSearch = '',
$userIdToSearch = 0,
$userId = 0,
$courseId = 0,
$sessionId = 0
) {
$tbl_announcement = Database::get_course_table(TABLE_ANNOUNCEMENT);
$tbl_item_property = Database::get_course_table(TABLE_ITEM_PROPERTY);
$user_id = $userId ?: api_get_user_id();
$group_id = api_get_group_id();
$session_id = $sessionId ?: api_get_session_id();
if (empty($courseId)) {
$courseInfo = api_get_course_info();
$courseId = $courseInfo['real_id'];
} else {
$courseId = (int) $courseId;
$courseInfo = api_get_course_info_by_id($courseId);
}
if (empty($courseInfo)) {
return [];
}
$condition_session = api_get_session_condition(
$session_id,
true,
true,
'announcement.session_id'
);
$group_memberships = GroupManager::get_group_ids(
$courseId,
api_get_user_id()
);
$allowUserEditSetting = api_get_course_setting('allow_user_edit_announcement');
$select = ' DISTINCT
announcement.*,
ip.visibility,
ip.to_group_id,
ip.insert_user_id,
ip.insert_date,
ip.lastedit_date';
$groupBy = ' GROUP BY announcement.iid';
if ($getCount) {
$groupBy = '';
$select = ' COUNT(DISTINCT announcement.iid) count';
}
$searchCondition = '';
if (!empty($titleToSearch)) {
$titleToSearch = Database::escape_string($titleToSearch);
$searchCondition .= " AND (title LIKE '%$titleToSearch%')";
}
if (!empty($userIdToSearch)) {
$userIdToSearch = (int) $userIdToSearch;
$searchCondition .= " AND (ip.insert_user_id = $userIdToSearch)";
}
$allowOnlyGroup = api_get_configuration_value('hide_base_course_announcements_in_group');
$extraGroupCondition = '';
if ($allowOnlyGroup) {
$extraGroupCondition = " AND ip.to_group_id = $group_id ";
}
$allowDrhAccess = api_get_configuration_value('allow_drh_access_announcement');
if ($allowDrhAccess && api_is_drh()) {
// DRH only can see visible
$searchCondition .= ' AND (ip.visibility = 1)';
}
if (api_is_allowed_to_edit(false, true) ||
($allowUserEditSetting && !api_is_anonymous()) ||
($allowDrhAccess && api_is_drh()) ||
($session_id && api_is_coach() && api_get_configuration_value('allow_coach_to_edit_announcements'))
) {
// A.1. you are a course admin with a USER filter
// => see only the messages of this specific user + the messages of the group (s)he is member of.
//if (!empty($user_id)) {
if (0) {
if (is_array($group_memberships) &&
count($group_memberships) > 0
) {
$sql = "SELECT $select
FROM $tbl_announcement announcement
INNER JOIN $tbl_item_property ip
ON (announcement.id = ip.ref AND ip.c_id = announcement.c_id)
WHERE
announcement.c_id = $courseId AND
ip.c_id = $courseId AND
ip.tool = 'announcement' AND
(
ip.to_user_id = $user_id OR
ip.to_group_id IS NULL OR
ip.to_group_id IN (0, ".implode(", ", $group_memberships).")
) AND
ip.visibility IN ('1', '0')
$condition_session
$searchCondition
ORDER BY display_order DESC";
} else {
$sql = "SELECT $select
FROM $tbl_announcement announcement
INNER JOIN $tbl_item_property ip
ON (announcement.id = ip.ref AND ip.c_id = announcement.c_id)
WHERE
announcement.c_id = $courseId AND
ip.c_id = $courseId AND
ip.tool ='announcement' AND
(ip.to_user_id = $user_id OR ip.to_group_id='0' OR ip.to_group_id IS NULL) AND
ip.visibility IN ('1', '0')
$condition_session
$searchCondition
ORDER BY display_order DESC";
}
} elseif ($group_id != 0) {
// A.2. you are a course admin with a GROUP filter
// => see only the messages of this specific group
$sql = "SELECT $select
FROM $tbl_announcement announcement
INNER JOIN $tbl_item_property ip
ON (announcement.id = ip.ref AND announcement.c_id = ip.c_id)
WHERE
ip.tool='announcement' AND
announcement.c_id = $courseId AND
ip.c_id = $courseId AND
ip.visibility<>'2' AND
(ip.to_group_id = $group_id OR ip.to_group_id='0' OR ip.to_group_id IS NULL)
$condition_session
$searchCondition
$extraGroupCondition
$groupBy
ORDER BY display_order DESC";
} else {
// A.3 you are a course admin without any group or user filter
// A.3.a you are a course admin without user or group filter but WITH studentview
// => see all the messages of all the users and groups without editing possibilities
if (isset($isStudentView) && $isStudentView == 'true') {
$sql = "SELECT $select
FROM $tbl_announcement announcement
INNER JOIN $tbl_item_property ip
ON (announcement.id = ip.ref AND announcement.c_id = ip.c_id)
WHERE
ip.tool='announcement' AND
announcement.c_id = $courseId AND
ip.c_id = $courseId AND
ip.visibility='1'
$condition_session
$searchCondition
$groupBy
ORDER BY display_order DESC";
} else {
// A.3.a you are a course admin without user or group filter and WTIHOUT studentview (= the normal course admin view)
// => see all the messages of all the users and groups with editing possibilities
$sql = "SELECT $select
FROM $tbl_announcement announcement
INNER JOIN $tbl_item_property ip
ON (announcement.id = ip.ref AND announcement.c_id = ip.c_id)
WHERE
ip.tool = 'announcement' AND
announcement.c_id = $courseId AND
ip.c_id = $courseId AND
(ip.visibility='0' OR ip.visibility='1')
$condition_session
$searchCondition
$groupBy
ORDER BY display_order DESC";
}
}
} else {
// STUDENT
if (is_array($group_memberships) && count($group_memberships) > 0) {
if ($allowUserEditSetting && !api_is_anonymous()) {
if ($group_id == 0) {
// No group
$cond_user_id = " AND (
ip.lastedit_user_id = '".$user_id."' OR (
(ip.to_user_id='$user_id' OR ip.to_user_id IS NULL) OR
(ip.to_group_id IS NULL OR ip.to_group_id IN (0, ".implode(", ", $group_memberships)."))
)
) ";
} else {
$cond_user_id = " AND (
ip.lastedit_user_id = '".$user_id."' OR ip.to_group_id IS NULL OR ip.to_group_id IN (0, ".$group_id.")
)";
$cond_user_id .= $extraGroupCondition;
}
} else {
if ($group_id == 0) {
$cond_user_id = " AND (
(ip.to_user_id='$user_id' OR ip.to_user_id IS NULL) AND
(ip.to_group_id IS NULL OR ip.to_group_id IN (0, ".implode(", ", $group_memberships)."))
) ";
} else {
$cond_user_id = " AND (
(ip.to_user_id='$user_id' OR ip.to_user_id IS NULL) AND
(ip.to_group_id IS NULL OR ip.to_group_id IN (0, ".$group_id."))
)";
$cond_user_id .= $extraGroupCondition;
}
}
$sql = "SELECT $select
FROM $tbl_announcement announcement INNER JOIN
$tbl_item_property ip
ON (announcement.id = ip.ref AND announcement.c_id = ip.c_id)
WHERE
announcement.c_id = $courseId AND
ip.c_id = $courseId AND
ip.tool='announcement'
$cond_user_id
$condition_session
$searchCondition AND
ip.visibility='1'
$groupBy
ORDER BY display_order DESC";
} else {
if ($user_id) {
if ($allowUserEditSetting && !api_is_anonymous()) {
$cond_user_id = " AND (
ip.lastedit_user_id = '".api_get_user_id()."' OR
((ip.to_user_id='$user_id' OR ip.to_user_id IS NULL) AND
(ip.to_group_id='0' OR ip.to_group_id IS NULL)
)
) ";
} else {
$cond_user_id = " AND ((ip.to_user_id='$user_id' OR ip.to_user_id IS NULL) AND
(ip.to_group_id='0' OR ip.to_group_id IS NULL) ) ";
}
$sql = "SELECT $select
FROM $tbl_announcement announcement
INNER JOIN $tbl_item_property ip
ON (announcement.id = ip.ref AND announcement.c_id = ip.c_id)
WHERE
announcement.c_id = $courseId AND
ip.c_id = $courseId AND
ip.tool='announcement'
$cond_user_id
$condition_session
$searchCondition
AND ip.visibility='1'
AND announcement.session_id IN(0, ".$session_id.")
$groupBy
ORDER BY display_order DESC";
} else {
if (($allowUserEditSetting && !api_is_anonymous())) {
$cond_user_id = " AND (
ip.lastedit_user_id = '".$user_id."' OR ip.to_group_id='0' OR ip.to_group_id IS NULL
)";
} else {
$cond_user_id = " AND ip.to_group_id='0' OR ip.to_group_id IS NULL ";
}
$sql = "SELECT $select
FROM $tbl_announcement announcement
INNER JOIN $tbl_item_property ip
ON (announcement.id = ip.ref AND announcement.c_id = ip.c_id)
WHERE
announcement.c_id = $courseId AND
ip.c_id = $courseId AND
ip.tool='announcement'
$cond_user_id
$condition_session
$searchCondition AND
ip.visibility='1' AND
announcement.session_id IN ( 0,".api_get_session_id().")
$groupBy
";
}
}
}
if (!is_null($start) && !is_null($limit)) {
$start = (int) $start;
$limit = (int) $limit;
$sql .= " LIMIT $start, $limit";
}
$result = Database::query($sql);
if ($getCount) {
$result = Database::fetch_array($result, 'ASSOC');
return $result['count'];
}
$iterator = 1;
$bottomAnnouncement = $announcement_number;
$displayed = [];
$results = [];
$emailIcon = '<i class="fa fa-envelope-o" title="'.get_lang('AnnounceSentByEmail').'"></i>';
$attachmentIcon = '<i class="fa fa-paperclip" title="'.get_lang('Attachment').'"></i>';
$editIcon = Display::return_icon(
'edit.png',
get_lang('Edit'),
'',
ICON_SIZE_SMALL
);
$editIconDisable = Display::return_icon(
'edit_na.png',
get_lang('Edit'),
'',
ICON_SIZE_SMALL
);
$deleteIcon = Display::return_icon(
'delete.png',
get_lang('Delete'),
'',
ICON_SIZE_SMALL
);
$deleteIconDisable = Display::return_icon(
'delete_na.png',
get_lang('Delete'),
'',
ICON_SIZE_SMALL
);
$isTutor = false;
if (!empty($group_id)) {
$groupInfo = GroupManager::get_group_properties(api_get_group_id());
//User has access in the group?
$isTutor = GroupManager::is_tutor_of_group(
api_get_user_id(),
$groupInfo
);
}
while ($row = Database::fetch_array($result, 'ASSOC')) {
if (!in_array($row['id'], $displayed)) {
$actionUrl = api_get_path(WEB_CODE_PATH).'announcements/announcements.php?'
.api_get_cidreq_params($courseInfo['code'], $session_id, $group_id);
$sent_to_icon = '';
// the email icon
if ($row['email_sent'] == '1') {
$sent_to_icon = ' '.$emailIcon;
}
$groupReference = $row['to_group_id'] > 0 ? ' <span class="label label-info">'.get_lang('Group').'</span> ' : '';
$disableEdit = false;
$to = self::loadEditUsers('announcement', $row['id'], true);
$separated = CourseManager::separateUsersGroups($to);
if (!empty($group_id)) {
// If the announcement was sent to many groups, disable edition inside a group
if (isset($separated['groups']) && count($separated['groups']) > 1) {
$disableEdit = true;
}
// If the announcement was sent only to the course disable edition
if (empty($separated['groups']) && empty($separated['users'])) {
$disableEdit = true;
}
// Announcement sent to only a user
if ($separated['groups'] > 1 && !in_array($group_id, $separated['groups'])) {
$disableEdit = true;
}
} else {
if (isset($separated['groups']) && count($separated['groups']) > 1) {
$groupReference = '';
}
}
$title = $row['title'].$groupReference.$sent_to_icon;
$item_visibility = api_get_item_visibility(
$courseInfo,
TOOL_ANNOUNCEMENT,
$row['id'],
$session_id
);
$row['visibility'] = $item_visibility;
// show attachment list
$attachment_list = self::get_attachment($row['id']);
$attachment_icon = '';
if (count($attachment_list) > 0) {
$attachment_icon = ' '.$attachmentIcon;
}
$user_info = api_get_user_info($row['insert_user_id']);
$username = sprintf(get_lang('LoginX'), $user_info['username']);
$username_span = Display::tag(
'span',
$user_info['complete_name'],
['title' => $username]
);
$title = Display::url(
$title.$attachment_icon,
$actionUrl.'&action=view&id='.$row['id']
);
// we can edit if : we are the teacher OR the element belongs to
// the session we are coaching OR the option to allow users to edit is on
if (api_is_allowed_to_edit(false, true) ||
(api_is_session_general_coach() && api_is_element_in_the_session(TOOL_ANNOUNCEMENT, $row['id'])) ||
(api_get_course_setting('allow_user_edit_announcement') && !api_is_anonymous()) ||
($row['to_group_id'] == $group_id && $isTutor) ||
($session_id && api_is_coach() && api_get_configuration_value('allow_coach_to_edit_announcements'))
) {
if ($disableEdit === true) {
$modify_icons = "<a href='#'>".$editIconDisable."</a>";
} else {
$modify_icons = "<a href=\"".$actionUrl."&action=modify&id=".$row['id']."\">".$editIcon."</a>";
}
$image_visibility = 'invisible';
$alt_visibility = get_lang('Visible');
if ($row['visibility'] == 1) {
$image_visibility = 'visible';
$alt_visibility = get_lang('Hide');
}
$modify_icons .= "<a
href=\"".$actionUrl."&action=showhide&id=".$row['id']."&sec_token=".$stok."\">".
Display::return_icon($image_visibility.'.png', $alt_visibility, '', ICON_SIZE_SMALL).
"</a>";
// DISPLAY MOVE UP COMMAND only if it is not the top announcement
if ($iterator != 1) {
$modify_icons .= "<a href=\"".$actionUrl."&action=move&up=".$row["id"]."&sec_token=".$stok."\">".
Display::return_icon('up.gif', get_lang('Up'))."</a>";
} else {
$modify_icons .= Display::return_icon('up_na.gif', get_lang('Up'));
}
if ($iterator < $bottomAnnouncement) {
$modify_icons .= "<a href=\"".$actionUrl."&action=move&down=".$row["id"]."&sec_token=".$stok."\">".
Display::return_icon('down.gif', get_lang('Down'))."</a>";
} else {
$modify_icons .= Display::return_icon('down_na.gif', get_lang('Down'));
}
if (api_is_allowed_to_edit(false, true)) {
if ($disableEdit === true) {
$modify_icons .= Display::url($deleteIconDisable, '#');
} else {
$modify_icons .= "<a href=\"".$actionUrl."&action=delete&id=".$row['id']."&sec_token=".$stok."\" onclick=\"javascript:if(!confirm('".addslashes(
api_htmlentities(
get_lang('ConfirmYourChoice'),
ENT_QUOTES,
api_get_system_encoding()
)
)."')) return false;\">".
$deleteIcon."</a>";
}
}
$iterator++;
} else {
$modify_icons = Display::url(
Display::return_icon('default.png'),
$actionUrl.'&action=view&id='.$row['id']
);
}
$announcement = [
'id' => $row['id'],
'title' => $title,
'username' => $username_span,
'insert_date' => api_convert_and_format_date(
$row['insert_date'],
DATE_TIME_FORMAT_LONG
),
'lastedit_date' => api_convert_and_format_date(
$row['lastedit_date'],
DATE_TIME_FORMAT_LONG
),
'actions' => $modify_icons,
];
$results[] = $announcement;
}
$displayed[] = $row['id'];
}
return $results;
}
/**
* @return int
*/
public static function getNumberAnnouncements()
{
// Maximum title messages to display
$maximum = '12';
// Database Table Definitions
$tbl_announcement = Database::get_course_table(TABLE_ANNOUNCEMENT);
$tbl_item_property = Database::get_course_table(TABLE_ITEM_PROPERTY);
$session_id = api_get_session_id();
$courseInfo = api_get_course_info();
$courseId = $courseInfo['real_id'];
$userId = api_get_user_id();
$condition_session = api_get_session_condition(
$session_id,
true,
true,
'announcement.session_id'
);
if (api_is_allowed_to_edit(false, true)) {
// check teacher status
if (empty($_GET['origin']) || $_GET['origin'] !== 'learnpath') {
if (api_get_group_id() == 0) {
$group_condition = '';
} else {
$group_condition = " AND (ip.to_group_id='".api_get_group_id()."' OR ip.to_group_id = 0 OR ip.to_group_id IS NULL)";
}
$sql = "SELECT
announcement.*,
ip.visibility,
ip.to_group_id,
ip.insert_user_id
FROM $tbl_announcement announcement
INNER JOIN $tbl_item_property ip
ON (announcement.c_id = ip.c_id AND announcement.id = ip.ref)
WHERE
announcement.c_id = $courseId AND
ip.c_id = $courseId AND
ip.tool = 'announcement' AND
ip.visibility <> '2'
$group_condition
$condition_session
GROUP BY ip.ref
ORDER BY display_order DESC
LIMIT 0, $maximum";
}
} else {
// students only get to see the visible announcements
if (empty($_GET['origin']) || $_GET['origin'] !== 'learnpath') {
$group_memberships = GroupManager::get_group_ids(
$courseInfo['real_id'],
$userId
);
if ((api_get_course_setting('allow_user_edit_announcement') &&
!api_is_anonymous())
) {
if (api_get_group_id() == 0) {
$cond_user_id = " AND (
ip.lastedit_user_id = '".$userId."' OR (
ip.to_user_id='".$userId."' OR
ip.to_group_id IN (0, ".implode(", ", $group_memberships).") OR
ip.to_group_id IS NULL
)
)
";
} else {
$cond_user_id = " AND (
ip.lastedit_user_id = '".$userId."'OR
ip.to_group_id IN (0, ".api_get_group_id().") OR
ip.to_group_id IS NULL
)";
}
} else {
if (api_get_group_id() == 0) {
$cond_user_id = " AND (
ip.to_user_id='".$userId."' OR
ip.to_group_id IN (0, ".implode(", ", $group_memberships).") OR
ip.to_group_id IS NULL
) ";
} else {
$cond_user_id = " AND (
ip.to_user_id='".$userId."' OR
ip.to_group_id IN (0, ".api_get_group_id().") OR
ip.to_group_id IS NULL
) ";
}
}
// the user is member of several groups => display personal announcements AND
// his group announcements AND the general announcements
if (is_array($group_memberships) && count($group_memberships) > 0) {
$sql = "SELECT announcement.*, ip.visibility, ip.to_group_id, ip.insert_user_id
FROM $tbl_announcement announcement
INNER JOIN $tbl_item_property ip
ON (announcement.id = ip.ref AND announcement.c_id = ip.c_id)
WHERE
announcement.c_id = $courseId AND
ip.c_id = $courseId AND
ip.tool='announcement' AND
ip.visibility='1'
$cond_user_id
$condition_session
GROUP BY ip.ref
ORDER BY display_order DESC
LIMIT 0, $maximum";
} else {
// the user is not member of any group
// this is an identified user => show the general announcements AND his personal announcements
if ($userId) {
if ((api_get_course_setting('allow_user_edit_announcement') &&
!api_is_anonymous())
) {
$cond_user_id = " AND (
ip.lastedit_user_id = '".$userId."' OR
( ip.to_user_id='".$userId."' OR ip.to_group_id='0' OR ip.to_group_id IS NULL)
) ";
} else {
$cond_user_id = " AND ( ip.to_user_id='".$userId."' OR ip.to_group_id='0' OR ip.to_group_id IS NULL) ";
}
$sql = "SELECT announcement.*, ip.visibility, ip.to_group_id, ip.insert_user_id
FROM $tbl_announcement announcement
INNER JOIN $tbl_item_property ip
ON (announcement.c_id = ip.c_id AND announcement.id = ip.ref)
WHERE
announcement.c_id = $courseId AND
ip.c_id = $courseId AND
ip.tool='announcement' AND
ip.visibility='1'
$cond_user_id
$condition_session
GROUP BY ip.ref
ORDER BY display_order DESC
LIMIT 0, $maximum";
} else {
if (api_get_course_setting('allow_user_edit_announcement')) {
$cond_user_id = " AND (
ip.lastedit_user_id = '".api_get_user_id()."' OR ip.to_group_id='0' OR ip.to_group_id IS NULL
) ";
} else {
$cond_user_id = " AND ip.to_group_id='0' ";
}
// the user is not identiefied => show only the general announcements
$sql = "SELECT
announcement.*,
ip.visibility,
ip.to_group_id,
ip.insert_user_id
FROM $tbl_announcement announcement
INNER JOIN $tbl_item_property ip
ON (announcement.id = ip.ref AND announcement.c_id = ip.c_id)
WHERE
announcement.c_id = $courseId AND
ip.c_id = $courseId AND
ip.tool='announcement' AND
ip.visibility='1' AND
ip.to_group_id='0'
$condition_session
GROUP BY ip.ref
ORDER BY display_order DESC
LIMIT 0, $maximum";
}
}
}
}
$result = Database::query($sql);
return Database::num_rows($result);
}
public static function createEvent(
int $announcementId,
string $startDate,
string $endDate,
array $choosenUsers = [],
array $reminders = []
): ?CCalendarEvent {
$em = Database::getManager();
$announcement = $em->find('ChamiloCourseBundle:CAnnouncement', $announcementId);
$agenda = new Agenda('course');
$eventId = $agenda->addEvent(
$startDate,
$endDate,
'',
$announcement->getTitle(),
$announcement->getContent(),
$choosenUsers,
false,
null,
[],
[],
null,
'',
[],
false,
$reminders
);
if ($eventId) {
return $em->find('ChamiloCourseBundle:CCalendarEvent', $eventId);
}
return null;
}
}
Zerion Mini Shell 1.0