, UGent Internship * @author Patrick Cool , Ghent University: code cleaning * @author Julio Montoya , MORE code cleaning 2011 * * @abstract The task of the internship was to integrate the 'send messages to specific users' with the * Announcements tool and also add the resource linker here. The database also needed refactoring * as there was no title field (the title was merged into the content field) * @package chamilo.announcements * multiple functions */ // use anonymous mode when accessing this course tool $use_anonymous = true; // setting the global file that gets the general configuration, the databases, the languages, ... require_once __DIR__.'/../inc/global.inc.php'; /* Sessions */ $ctok = Security::get_existing_token(); $stok = Security::get_token(); $current_course_tool = TOOL_ANNOUNCEMENT; $this_section = SECTION_COURSES; $nameTools = get_lang('ToolAnnouncement'); $allowToEdit = ( api_is_allowed_to_edit(false, true) || (api_get_course_setting('allow_user_edit_announcement') && !api_is_anonymous()) ); $sessionId = api_get_session_id(); $drhHasAccessToSessionContent = api_get_configuration_value('drh_can_access_all_session_content'); if (!empty($sessionId) && $drhHasAccessToSessionContent) { $allowToEdit = $allowToEdit || api_is_drh(); } /* ACCESS RIGHTS */ api_protect_course_script(true); // Configuration settings $display_announcement_list = true; $display_form = false; $display_title_list = true; // Maximum title messages to display $maximum = '12'; // Length of the titles $length = '36'; // Database Table Definitions $tbl_courses = Database::get_main_table(TABLE_MAIN_COURSE); $tbl_sessions = Database::get_main_table(TABLE_MAIN_SESSION); $tbl_announcement = Database::get_course_table(TABLE_ANNOUNCEMENT); $tbl_item_property = Database::get_course_table(TABLE_ITEM_PROPERTY); $course_id = api_get_course_int_id(); $_course = api_get_course_info_by_id($course_id); $group_id = api_get_group_id(); $sessionId = api_get_session_id(); if (!empty($group_id)) { $group_properties = GroupManager:: get_group_properties($group_id); $interbreadcrumb[] = array( "url" => api_get_path(WEB_CODE_PATH)."group/group.php?".api_get_cidreq(), "name" => get_lang('Groups'), ); $interbreadcrumb[] = array( "url" => api_get_path(WEB_CODE_PATH)."group/group_space.php?".api_get_cidreq(), "name" => get_lang('GroupSpace').' '.$group_properties['name'] ); } api_protect_course_group(GroupManager::GROUP_TOOL_ANNOUNCEMENT); /* Tracking */ Event::event_access_tool(TOOL_ANNOUNCEMENT); $announcement_id = isset($_GET['id']) ? intval($_GET['id']) : null; $action = isset($_GET['action']) ? Security::remove_XSS($_GET['action']) : 'list'; $announcement_number = AnnouncementManager::getNumberAnnouncements(); $homeUrl = api_get_self().'?action=list&'.api_get_cidreq(); $content = ''; $searchFormToString = ''; switch ($action) { case 'move': /* Move announcement up/down */ if (!empty($_GET['down'])) { $thisAnnouncementId = intval($_GET['down']); $sortDirection = "DESC"; } if (!empty($_GET['up'])) { $thisAnnouncementId = intval($_GET['up']); $sortDirection = "ASC"; } if (!empty($sortDirection)) { if (!in_array(trim(strtoupper($sortDirection)), array('ASC', 'DESC'))) { $sortDirection = 'ASC'; } $announcementInfo = AnnouncementManager::get_by_id($course_id, $thisAnnouncementId); $sql = "SELECT DISTINCT announcement.id, announcement.display_order FROM $tbl_announcement announcement, $tbl_item_property itemproperty WHERE announcement.c_id = $course_id AND itemproperty.c_id = $course_id AND itemproperty.ref = announcement.id AND itemproperty.tool = '".TOOL_ANNOUNCEMENT."' AND itemproperty.visibility <> 2 ORDER BY display_order $sortDirection"; $result = Database::query($sql); $thisAnnouncementOrderFound = false; $thisAnnouncementOrder = null; while (list($announcementId, $announcementOrder) = Database::fetch_row($result)) { if ($thisAnnouncementOrderFound) { $nextAnnouncementId = $announcementId; $nextAnnouncementOrder = $announcementOrder; $sql = "UPDATE $tbl_announcement SET display_order = '$nextAnnouncementOrder' WHERE c_id = $course_id AND id = $thisAnnouncementId"; Database::query($sql); $sql = "UPDATE $tbl_announcement SET display_order = '$thisAnnouncementOrder' WHERE c_id = $course_id AND id = $nextAnnouncementId"; Database::query($sql); break; } // STEP 1 : FIND THE ORDER OF THE ANNOUNCEMENT if ($announcementId == $thisAnnouncementId) { $thisAnnouncementOrder = $announcementOrder; $thisAnnouncementOrderFound = true; } } Display::addFlash(Display::return_message(get_lang('AnnouncementMoved'))); header('Location: '.$homeUrl); exit; } break; case 'view': $interbreadcrumb[] = array( "url" => api_get_path(WEB_CODE_PATH).'announcements/announcements.php?'.api_get_cidreq(), "name" => $nameTools, ); $nameTools = get_lang('View'); $content = AnnouncementManager::displayAnnouncement($announcement_id); break; case 'list': $htmlHeadXtra[] = api_get_jqgrid_js(); $searchForm = new FormValidator( 'search_simple', 'post', api_get_self().'?'.api_get_cidreq(), '', array(), FormValidator::LAYOUT_INLINE ); $searchForm->addElement('text', 'keyword', get_lang('Title')); $users = CourseManager::get_user_list_from_course_code(api_get_course_id(), $sessionId); $userList = array('' => ''); if (!empty($users)) { foreach ($users as $user) { $userList[$user['user_id']] = api_get_person_name($user['firstname'], $user['lastname']); } } $users = []; $searchForm->addElement('select', 'user_id', get_lang('Users'), $userList); $searchForm->addButtonSearch(get_lang('Search')); $filterData = array(); $keyword = ''; $userIdToSearch = 0; if ($searchForm->validate()) { $filterData = $searchForm->getSubmitValues(); $keyword = $filterData['keyword']; $userIdToSearch = $filterData['user_id']; } // jqgrid will use this URL to do the selects $url = api_get_path(WEB_AJAX_PATH).'model.ajax.php?a=get_course_announcements&'.api_get_cidreq().'&title_to_search='.$keyword.'&user_id_to_search='.$userIdToSearch; $deleteUrl = api_get_path(WEB_AJAX_PATH).'announcement.ajax.php?a=delete_item&'.api_get_cidreq(); $columns = array(get_lang('Title'), get_lang('By'), get_lang('LastUpdateDate'), get_lang('Actions')); // Column config $columnModel = array( array( 'name' => 'title', 'index' => 'title', 'width' => '300', 'align' => 'left', 'sortable' => 'false', ), array( 'name' => 'username', 'index' => 'username', 'width' => '100', 'align' => 'left', 'sortable' => 'false', ), array( 'name' => 'insert_date', 'index' => 'insert_date', 'width' => '200', 'align' => 'left', 'sortable' => 'false', ), array( 'name' => 'actions', 'index' => 'actions', 'width' => '150', 'align' => 'left', //'formatter' => 'action_formatter', 'sortable' => 'false' ) ); // Autowidth $extra_params['autowidth'] = 'true'; // height auto $extra_params['height'] = 'auto'; $editOptions = ''; if (api_is_allowed_to_edit()) { $extra_params['multiselect'] = true; $editOptions = ' $("#announcements").jqGrid( "navGrid", "#announcements_pager", { edit: false, add: false, del: true }, { height:280, reloadAfterSubmit:false }, // edit options { height:280, reloadAfterSubmit:false }, // add options { reloadAfterSubmit:false, url: "'.$deleteUrl.'" }, // del options { width:500 } // search options ); '; } $content = ''; $count = AnnouncementManager::getAnnouncements($stok, $announcement_number, true); if (empty($count)) { $html = ''; if ($allowToEdit && (empty($_GET['origin']) or $_GET['origin'] !== 'learnpath')) { $html .= '
'; $html .= '

'.get_lang('Announcements').'

'; $html .= Display::return_icon('valves.png', '', array(), 64); $html .= '
'; $html .= Display::url( get_lang('AddAnnouncement'), api_get_self()."?".api_get_cidreq()."&action=add", array('class' => 'btn btn-primary') ); $html .= '
'; $html .= '
'; } else { $html = Display::return_message(get_lang('NoAnnouncements'), 'warning'); } $content = $html; } else { $content .= Display::grid_html('announcements'); } break; case 'delete': /* Delete announcement */ $id = intval($_GET['id']); if ($sessionId != 0 && api_is_allowed_to_session_edit(false, true) == false) { api_not_allowed(); } if (!api_is_course_coach() || api_is_element_in_the_session(TOOL_ANNOUNCEMENT, $id)) { AnnouncementManager::delete_announcement($_course, $id); Display::addFlash(Display::return_message(get_lang('AnnouncementDeleted'))); } header('Location: '.$homeUrl); exit; break; case 'delete_all': if (api_is_allowed_to_edit()) { AnnouncementManager::delete_all_announcements($_course); Display::addFlash(Display::return_message(get_lang('AnnouncementDeletedAll'))); header('Location: '.$homeUrl); exit; } break; case 'delete_attachment': $id = $_GET['id_attach']; if (api_is_allowed_to_edit()) { AnnouncementManager::delete_announcement_attachment_file($id); } header('Location: '.$homeUrl); exit; break; case 'showhide': if (!isset($_GET['isStudentView']) || $_GET['isStudentView'] != 'false') { if (isset($_GET['id']) && $_GET['id']) { if ($sessionId != 0 && api_is_allowed_to_session_edit(false, true) == false ) { api_not_allowed(); } if (!api_is_course_coach() || api_is_element_in_the_session(TOOL_ANNOUNCEMENT, $_GET['id']) ) { AnnouncementManager::change_visibility_announcement( $_course, $_GET['id'] ); Display::addFlash(Display::return_message(get_lang('VisibilityChanged'))); header('Location: '.$homeUrl); exit; } } } break; case 'add': case 'modify': if ($sessionId != 0 && api_is_allowed_to_session_edit(false, true) == false ) { api_not_allowed(true); } // DISPLAY ADD ANNOUNCEMENT COMMAND $id = isset($_GET['id']) ? intval($_GET['id']) : 0; $url = api_get_self().'?action='.$action.'&id='.$id.'&'.api_get_cidreq(); $form = new FormValidator( 'f1', 'post', $url, null, array('enctype' => 'multipart/form-data') ); if (empty($id)) { $form_name = get_lang('AddAnnouncement'); } else { $form_name = get_lang('ModifyAnnouncement'); } $interbreadcrumb[] = array( "url" => api_get_path(WEB_CODE_PATH)."announcements/announcements.php?".api_get_cidreq(), "name" => $nameTools, ); $nameTools = $form_name; $form->addElement('header', $form_name); $form->addButtonAdvancedSettings('choose_recipients', [get_lang('ChooseRecipients'), get_lang('AnnouncementChooseRecipientsDescription')]); $form->addHtml(''); $form->addCheckBox('email_ann', '', get_lang('EmailOption')); if (!isset($announcement_to_modify)) { $announcement_to_modify = ''; } $announcementInfo = AnnouncementManager::get_by_id($course_id, $id); if (isset($announcementInfo) && !empty($announcementInfo)) { $to = AnnouncementManager::load_edit_users("announcement", $id); $defaults = array( 'title' => $announcementInfo['title'], 'content' => $announcementInfo['content'], 'id' => $announcementInfo['id'], 'users' => $to, ); } else { $defaults = array(); if (!empty($to)) { $defaults['users'] = $to; } } if (isset($defaults['users'])) { foreach ($defaults['users'] as $value) { $parts = explode(':', $value); if (!isset($parts[1]) || empty($parts[1])) { continue; } $form->addHtml(" "); break; } } $defaults['email_ann'] = true; $form->addElement('text', 'title', get_lang('EmailTitle')); $form->addRule('title', get_lang('ThisFieldIsRequired'), 'required'); $form->addElement('hidden', 'id'); $htmlTags = "".get_lang('Tags')."

"; $tags = AnnouncementManager::get_tags(); foreach ($tags as $tag) { $htmlTags .= "".$tag."
"; } $form->addLabel('', "
".$htmlTags."
"); $form->addHtmlEditor( 'content', get_lang('Description'), true, false, array('ToolbarSet' => 'Announcements') ); $form->addElement('file', 'user_upload', get_lang('AddAnAttachment')); $form->addElement('textarea', 'file_comment', get_lang('FileComment')); $form->addElement('hidden', 'sec_token', $stok); if (empty($sessionId)) { $form->addCheckBox('send_to_users_in_session', null, get_lang('SendToUsersInSessions')); } $config = api_get_configuration_value('announcements_hide_send_to_hrm_users'); if ($config === false) { $form->addCheckBox('send_to_hrm_users', null, get_lang('SendAnnouncementCopyToDRH')); } $form->addButtonSave(get_lang('ButtonPublishAnnouncement')); $form->setDefaults($defaults); if ($form->validate()) { $data = $form->getSubmitValues(); $data['users'] = isset($data['users']) ? $data['users'] : ['everyone']; $sendToUsersInSession = isset($data['send_to_users_in_session']) ? true : false; if (isset($id) && $id) { // there is an Id => the announcement already exists => update mode if ($ctok == $_POST['sec_token']) { $file_comment = $_POST['file_comment']; $file = $_FILES['user_upload']; AnnouncementManager::edit_announcement( $id, $data['title'], $data['content'], $data['users'], $file, $file_comment, $sendToUsersInSession ); /* MAIL FUNCTION */ if (isset($_POST['email_ann']) && empty($_POST['onlyThoseMails'])) { AnnouncementManager::sendEmail( api_get_course_info(), api_get_session_id(), $id, $sendToUsersInSession, isset($data['send_to_hrm_users']) ); } Display::addFlash( Display::return_message( get_lang('AnnouncementModified'), 'success' ) ); header('Location: '.$homeUrl); exit; } } else { // Insert mode if ($ctok == $_POST['sec_token']) { $file = $_FILES['user_upload']; $file_comment = $data['file_comment']; if (empty($group_id)) { $insert_id = AnnouncementManager::add_announcement( api_get_course_info(), api_get_session_id(), $data['title'], $data['content'], $data['users'], $file, $file_comment, null, $sendToUsersInSession ); } else { $insert_id = AnnouncementManager::add_group_announcement( $data['title'], $data['content'], array('GROUP:'.$group_id), $data['users'], $file, $file_comment, $sendToUsersInSession ); } Display::addFlash( Display::return_message( get_lang('AnnouncementAdded'), 'success' ) ); /* MAIL FUNCTION */ if (isset($data['email_ann']) && $data['email_ann']) { AnnouncementManager::sendEmail( api_get_course_info(), api_get_session_id(), $insert_id, $sendToUsersInSession ); } header('Location: '.$homeUrl); exit; } // end condition token } } $content = $form->returnForm(); break; } if (!empty($_GET['remind_inactive'])) { $to[] = 'USER:'.intval($_GET['remind_inactive']); } if (empty($_GET['origin']) or $_GET['origin'] !== 'learnpath') { //we are not in the learning path Display::display_header($nameTools, get_lang('Announcements')); } // Tool introduction if (empty($_GET['origin']) || $_GET['origin'] !== 'learnpath') { Display::display_introduction_section(TOOL_ANNOUNCEMENT); } // Actions $show_actions = false; $actionsLeft = ''; if ($allowToEdit && (empty($_GET['origin']) || $_GET['origin'] !== 'learnpath') ) { if (in_array($action, array('add', 'modify', 'view'))) { $actionsLeft .= "". Display::return_icon('back.png', get_lang('Back'), '', ICON_SIZE_MEDIUM).""; } else { $actionsLeft .= "". Display::return_icon('new_announce.png', get_lang('AddAnnouncement'), '', ICON_SIZE_MEDIUM).""; } $show_actions = true; } else { if (in_array($action, array('view'))) { $actionsLeft .= "". Display::return_icon('back.png', get_lang('Back'), '', ICON_SIZE_MEDIUM).""; } } if ($allowToEdit) { if (api_get_group_id() == 0) { if (!isset($_GET['action'])) { $actionsLeft .= "". Display::return_icon( 'delete_announce.png', get_lang('AnnouncementDeleteAll'), '', ICON_SIZE_MEDIUM ).""; } } } if ($show_actions) { echo Display::toolbarAction('toolbar', array($actionsLeft, $searchFormToString)); } echo $content; if (empty($_GET['origin']) || $_GET['origin'] !== 'learnpath') { //we are not in learnpath tool Display::display_footer(); }