system_announcements.lib.php 33 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956
  1. <?php
  2. /* For licensing terms, see /license.txt */
  3. /**
  4. * Class SystemAnnouncementManager
  5. */
  6. class SystemAnnouncementManager
  7. {
  8. const VISIBLE_GUEST = 'visible_guest';
  9. const VISIBLE_STUDENT = 'visible_student';
  10. const VISIBLE_TEACHER = 'visible_teacher';
  11. // Requires DB change
  12. const VISIBLE_DRH = 'visible_drh';
  13. const VISIBLE_SESSION_ADMIN = 'visible_session_admin';
  14. const VISIBLE_STUDENT_BOSS = 'visible_boss';
  15. /**
  16. * @return array
  17. */
  18. public static function getVisibilityList()
  19. {
  20. $extraRoles = self::newRolesActivated();
  21. $visibleToUsers = [
  22. self::VISIBLE_TEACHER => get_lang('Teacher'),
  23. self::VISIBLE_STUDENT => get_lang('Student'),
  24. self::VISIBLE_GUEST => get_lang('Guest')
  25. ];
  26. if ($extraRoles) {
  27. $visibleToUsers[self::VISIBLE_DRH] = get_lang('DRH');
  28. $visibleToUsers[self::VISIBLE_SESSION_ADMIN] = get_lang('SessionAdministrator');
  29. $visibleToUsers[self::VISIBLE_STUDENT_BOSS] = get_lang('StudentBoss');
  30. }
  31. return $visibleToUsers;
  32. }
  33. /**
  34. * @param string $visibility
  35. * @return string
  36. */
  37. public static function getVisibilityCondition($visibility)
  38. {
  39. $list = self::getVisibilityList();
  40. $visibilityCondition = " AND ".self::VISIBLE_GUEST." = 1 ";
  41. if (in_array($visibility, array_keys($list))) {
  42. $visibilityCondition = " AND $visibility = 1 ";
  43. }
  44. return $visibilityCondition;
  45. }
  46. /**
  47. * Displays all announcements
  48. * @param string $visibility VISIBLE_GUEST, VISIBLE_STUDENT or VISIBLE_TEACHER
  49. * @param int $id The identifier of the announcement to display
  50. */
  51. public static function display_announcements($visibility, $id = -1)
  52. {
  53. $user_selected_language = api_get_interface_language();
  54. $db_table = Database::get_main_table(TABLE_MAIN_SYSTEM_ANNOUNCEMENTS);
  55. $tbl_announcement_group = Database::get_main_table(TABLE_MAIN_SYSTEM_ANNOUNCEMENTS_GROUPS);
  56. $userGroup = new UserGroup();
  57. $temp_user_groups = $userGroup->get_groups_by_user(api_get_user_id(), 0);
  58. $groups = array();
  59. foreach ($temp_user_groups as $user_group) {
  60. $groups = array_merge($groups, array($user_group['id']));
  61. $groups = array_merge(
  62. $groups,
  63. $userGroup->get_parent_groups($user_group['id'])
  64. );
  65. }
  66. $groups_string = '('.implode($groups, ',').')';
  67. $now = api_get_utc_datetime();
  68. $sql = "SELECT *, DATE_FORMAT(date_start,'%d-%m-%Y %h:%i:%s') AS display_date
  69. FROM $db_table
  70. WHERE
  71. (lang='$user_selected_language' OR lang IS NULL) AND
  72. (('$now' BETWEEN date_start AND date_end) OR date_end='0000-00-00') ";
  73. $sql .= self::getVisibilityCondition($visibility);
  74. if (count($groups) > 0) {
  75. $sql .= " OR id IN (
  76. SELECT announcement_id FROM $tbl_announcement_group
  77. WHERE group_id in $groups_string
  78. ) ";
  79. }
  80. $current_access_url_id = 1;
  81. if (api_is_multiple_url_enabled()) {
  82. $current_access_url_id = api_get_current_access_url_id();
  83. }
  84. $sql .= " AND access_url_id = '$current_access_url_id' ";
  85. $sql .= " ORDER BY date_start DESC LIMIT 0,7";
  86. $announcements = Database::query($sql);
  87. if (Database::num_rows($announcements) > 0) {
  88. $query_string = ereg_replace('announcement=[1-9]+', '', $_SERVER['QUERY_STRING']);
  89. $query_string = ereg_replace('&$', '', $query_string);
  90. $url = api_get_self();
  91. echo '<div class="system_announcements">';
  92. echo '<h3>'.get_lang('SystemAnnouncements').'</h3>';
  93. echo '<div style="margin:10px;text-align:right;"><a href="news_list.php">'.get_lang('More').'</a></div>';
  94. while ($announcement = Database::fetch_object($announcements)) {
  95. if ($id != $announcement->id) {
  96. if (strlen($query_string) > 0) {
  97. $show_url = 'news_list.php#'.$announcement->id;
  98. } else {
  99. $show_url = 'news_list.php#'.$announcement->id;
  100. }
  101. $display_date = api_convert_and_format_date($announcement->display_date, DATE_FORMAT_LONG);
  102. echo '<a name="'.$announcement->id.'"></a>
  103. <div class="system_announcement">
  104. <div class="system_announcement_title">
  105. <a name="ann'.$announcement->id.'" href="'.$show_url.'">'.
  106. $announcement->title.'</a>
  107. </div>
  108. <div class="system_announcement_date">'.$display_date.'</div>
  109. </div>';
  110. } else {
  111. echo '<div class="system_announcement">
  112. <div class="system_announcement_title">'
  113. .$announcement->display_date.'
  114. <a name="ann'.$announcement->id.'" href="'.$url.'?'.$query_string.'#ann'.$announcement->id.'">'.
  115. $announcement->title.'
  116. </a>
  117. </div>';
  118. }
  119. echo '<br />';
  120. }
  121. echo '</div>';
  122. }
  123. return;
  124. }
  125. /**
  126. * @param string $visibility
  127. * @param int $id
  128. * @param int $start
  129. * @param string $user_id
  130. * @return string
  131. */
  132. public static function displayAllAnnouncements(
  133. $visibility,
  134. $id = -1,
  135. $start = 0,
  136. $user_id = ''
  137. ) {
  138. $user_selected_language = api_get_interface_language();
  139. $start = intval($start);
  140. $userGroup = new UserGroup();
  141. $tbl_announcement_group = Database::get_main_table(TABLE_MAIN_SYSTEM_ANNOUNCEMENTS_GROUPS);
  142. $temp_user_groups = $userGroup->get_groups_by_user(api_get_user_id(), 0);
  143. $groups = array();
  144. foreach ($temp_user_groups as $user_group) {
  145. $groups = array_merge($groups, array($user_group['id']));
  146. $groups = array_merge($groups, $userGroup->get_parent_groups($user_group['id']));
  147. }
  148. // Checks if tables exists to not break platform not updated
  149. $groups_string = '('.implode($groups, ',').')';
  150. $table = Database::get_main_table(TABLE_MAIN_SYSTEM_ANNOUNCEMENTS);
  151. $now = api_get_utc_datetime();
  152. $sql = "SELECT * FROM $table
  153. WHERE
  154. (lang = '$user_selected_language' OR lang IS NULL) AND
  155. ( '$now' >= date_start AND '$now' <= date_end) ";
  156. $sql .= self::getVisibilityCondition($visibility);
  157. if (count($groups) > 0) {
  158. $sql .= " OR id IN (
  159. SELECT announcement_id FROM $tbl_announcement_group
  160. WHERE group_id in $groups_string
  161. ) ";
  162. }
  163. if (api_is_multiple_url_enabled()) {
  164. $current_access_url_id = api_get_current_access_url_id();
  165. $sql .= " AND access_url_id IN ('1', '$current_access_url_id')";
  166. }
  167. if (!isset($_GET['start']) || $_GET['start'] == 0) {
  168. $sql .= " ORDER BY date_start DESC LIMIT ".$start.",20";
  169. } else {
  170. $sql .= " ORDER BY date_start DESC LIMIT ".($start + 1).",20";
  171. }
  172. $announcements = Database::query($sql);
  173. $content = '';
  174. if (Database::num_rows($announcements) > 0) {
  175. $content .= '<div class="system_announcements">';
  176. $content .= '<h3>'.get_lang('SystemAnnouncements').'</h3>';
  177. $content .= '<table align="center">';
  178. $content .= '<tr>';
  179. $content .= '<td>';
  180. $content .= self::display_arrow($user_id);
  181. $content .= '</td>';
  182. $content .= '</tr>';
  183. $content .= '</table>';
  184. $content .= '<table align="center" border="0" width="900px">';
  185. while ($announcement = Database::fetch_object($announcements)) {
  186. $display_date = api_convert_and_format_date($announcement->display_date, DATE_FORMAT_LONG);
  187. $content .= '<tr><td>';
  188. $content .= '<a name="'.$announcement->id.'"></a>
  189. <div class="system_announcement">
  190. <h2>'.$announcement->title.'</h2>
  191. <div class="system_announcement_date">'.$display_date.'</div>
  192. <br />
  193. <div class="system_announcement_content">'
  194. .$announcement->content.'
  195. </div>
  196. </div><br />';
  197. $content .= '</tr></td>';
  198. }
  199. $content .= '</table>';
  200. $content .= '<table align="center">';
  201. $content .= '<tr>';
  202. $content .= '<td>';
  203. $content .= self::display_arrow($user_id);
  204. $content .= '</td>';
  205. $content .= '</tr>';
  206. $content .= '</table>';
  207. $content .= '</div>';
  208. }
  209. return $content;
  210. }
  211. /**
  212. * @param int $user_id
  213. * @return string
  214. */
  215. public static function display_arrow($user_id)
  216. {
  217. $start = (int) $_GET['start'];
  218. $nb_announcement = self::count_nb_announcement($start, $user_id);
  219. $next = ((int) $_GET['start'] + 19);
  220. $prev = ((int) $_GET['start'] - 19);
  221. $content = '';
  222. if (!isset($_GET['start']) || $_GET['start'] == 0) {
  223. if ($nb_announcement > 20) {
  224. $content .= '<a href="news_list.php?start='.$next.'">'.get_lang('NextBis').' >> </a>';
  225. }
  226. } else {
  227. echo '<a href="news_list.php?start='.$prev.'"> << '.get_lang('Prev').'</a>';
  228. if ($nb_announcement > 20) {
  229. $content .= '<a href="news_list.php?start='.$next.'">'.get_lang('NextBis').' >> </a>';
  230. }
  231. }
  232. return $content;
  233. }
  234. /**
  235. * @param int $start
  236. * @param string $user_id
  237. * @return int
  238. */
  239. public static function count_nb_announcement($start = 0, $user_id = '')
  240. {
  241. $start = intval($start);
  242. $user_selected_language = api_get_interface_language();
  243. $db_table = Database::get_main_table(TABLE_MAIN_SYSTEM_ANNOUNCEMENTS);
  244. $sql = 'SELECT id FROM '.$db_table.'
  245. WHERE (lang="'.$user_selected_language.'" OR lang IS NULL) ';
  246. $visibility = self::getCurrentUserVisibility();
  247. $sql .= self::getVisibilityCondition($visibility);
  248. $current_access_url_id = 1;
  249. if (api_is_multiple_url_enabled()) {
  250. $current_access_url_id = api_get_current_access_url_id();
  251. }
  252. $sql .= " AND access_url_id = '$current_access_url_id' ";
  253. $sql .= 'LIMIT '.$start.', 21';
  254. $announcements = Database::query($sql);
  255. $i = 0;
  256. while ($rows = Database::fetch_array($announcements)) {
  257. $i++;
  258. }
  259. return $i;
  260. }
  261. /**
  262. * Get all announcements
  263. * @return array An array with all available system announcements (as php
  264. * objects)
  265. */
  266. public static function get_all_announcements()
  267. {
  268. $table = Database::get_main_table(TABLE_MAIN_SYSTEM_ANNOUNCEMENTS);
  269. $now = api_get_utc_datetime();
  270. $sql = "SELECT *, IF ( '$now' >= date_start AND '$now' <= date_end, '1', '0') AS visible
  271. FROM $table";
  272. $current_access_url_id = 1;
  273. if (api_is_multiple_url_enabled()) {
  274. $current_access_url_id = api_get_current_access_url_id();
  275. }
  276. $sql .= " WHERE access_url_id = '$current_access_url_id' ";
  277. $sql .= " ORDER BY date_start ASC";
  278. $result = Database::query($sql);
  279. $announcements = array();
  280. while ($announcement = Database::fetch_object($result)) {
  281. $announcements[] = $announcement;
  282. }
  283. return $announcements;
  284. }
  285. /**
  286. * Adds an announcement to the database
  287. *
  288. * @param string $title Title of the announcement
  289. * @param string $content Content of the announcement
  290. * @param string $date_start Start date (YYYY-MM-DD HH:II: SS)
  291. * @param string $date_end End date (YYYY-MM-DD HH:II: SS)
  292. * @param array $visibility
  293. * @param string $lang The language for which the announvement should be shown. Leave null for all langages
  294. * @param int $send_mail Whether to send an e-mail to all users (1) or not (0)
  295. * @param bool $add_to_calendar
  296. * @param bool $sendEmailTest
  297. *
  298. * @return mixed insert_id on success, false on failure
  299. */
  300. public static function add_announcement(
  301. $title,
  302. $content,
  303. $date_start,
  304. $date_end,
  305. $visibility,
  306. $lang = '',
  307. $send_mail = 0,
  308. $add_to_calendar = false,
  309. $sendEmailTest = false
  310. ) {
  311. $original_content = $content;
  312. $a_dateS = explode(' ', $date_start);
  313. $a_arraySD = explode('-', $a_dateS[0]);
  314. $a_arraySH = explode(':', $a_dateS[1]);
  315. $date_start_to_compare = array_merge($a_arraySD, $a_arraySH);
  316. $a_dateE = explode(' ', $date_end);
  317. $a_arrayED = explode('-', $a_dateE[0]);
  318. $a_arrayEH = explode(':', $a_dateE[1]);
  319. $date_end_to_compare = array_merge($a_arrayED, $a_arrayEH);
  320. $db_table = Database::get_main_table(TABLE_MAIN_SYSTEM_ANNOUNCEMENTS);
  321. if (!checkdate($date_start_to_compare[1], $date_start_to_compare[2], $date_start_to_compare[0])) {
  322. Display::addFlash(
  323. Display::return_message(get_lang('InvalidStartDate'), 'warning')
  324. );
  325. return false;
  326. }
  327. if (($date_end_to_compare[1] ||
  328. $date_end_to_compare[2] ||
  329. $date_end_to_compare[0]) &&
  330. !checkdate($date_end_to_compare[1], $date_end_to_compare[2], $date_end_to_compare[0])
  331. ) {
  332. Display::addFlash(
  333. Display::return_message(get_lang('InvalidEndDate'), 'warning')
  334. );
  335. return false;
  336. }
  337. if (strlen(trim($title)) == 0) {
  338. Display::addFlash(
  339. Display::return_message(get_lang('InvalidTitle'), 'warning')
  340. );
  341. return false;
  342. }
  343. $start = api_get_utc_datetime($date_start);
  344. $end = api_get_utc_datetime($date_end);
  345. //Fixing urls that are sent by email
  346. //$content = str_replace('src=\"/home/', 'src=\"'.api_get_path(WEB_PATH).'home/', $content);
  347. //$content = str_replace('file=/home/', 'file='.api_get_path(WEB_PATH).'home/', $content);
  348. $content = str_replace(
  349. 'src=\"'.api_get_path(REL_HOME_PATH),
  350. 'src=\"'.api_get_path(WEB_PATH).api_get_path(REL_HOME_PATH),
  351. $content
  352. );
  353. $content = str_replace(
  354. 'file='.api_get_path(REL_HOME_PATH),
  355. 'file='.api_get_path(WEB_PATH).api_get_path(REL_HOME_PATH),
  356. $content
  357. );
  358. $lang = is_null($lang) ? '' : $lang;
  359. $current_access_url_id = 1;
  360. if (api_is_multiple_url_enabled()) {
  361. $current_access_url_id = api_get_current_access_url_id();
  362. }
  363. $params = [
  364. 'title' => $title,
  365. 'content' => $content,
  366. 'date_start' => $start,
  367. 'date_end' => $end,
  368. 'lang' => $lang,
  369. 'access_url_id' => $current_access_url_id
  370. ];
  371. foreach ($visibility as $key => $value) {
  372. $params[$key] = $value;
  373. }
  374. $resultId = Database::insert($db_table, $params);
  375. if ($resultId) {
  376. if ($sendEmailTest) {
  377. self::send_system_announcement_by_email(
  378. $title,
  379. $content,
  380. $visibility,
  381. $lang,
  382. true
  383. );
  384. } else {
  385. if ($send_mail == 1) {
  386. self::send_system_announcement_by_email(
  387. $title,
  388. $content,
  389. $visibility,
  390. $lang
  391. );
  392. }
  393. }
  394. if ($add_to_calendar) {
  395. $agenda = new Agenda('admin');
  396. $agenda->addEvent(
  397. $date_start,
  398. $date_end,
  399. false,
  400. $title,
  401. $original_content
  402. );
  403. }
  404. return $resultId;
  405. }
  406. return false;
  407. }
  408. /**
  409. * Makes the announcement id visible only for groups in groups_array
  410. * @param int $announcement_id
  411. * @param array $group_array array of group id
  412. * @return bool
  413. **/
  414. public static function announcement_for_groups($announcement_id, $group_array)
  415. {
  416. $tbl_announcement_group = Database::get_main_table(
  417. TABLE_MAIN_SYSTEM_ANNOUNCEMENTS_GROUPS
  418. );
  419. //first delete all group associations for this announcement
  420. $res = Database::query(
  421. "DELETE FROM $tbl_announcement_group
  422. WHERE announcement_id=".intval($announcement_id)
  423. );
  424. if ($res === false) {
  425. return false;
  426. }
  427. foreach ($group_array as $group_id) {
  428. if (intval($group_id) != 0) {
  429. $sql = "INSERT INTO $tbl_announcement_group SET
  430. announcement_id=".intval($announcement_id).",
  431. group_id=".intval($group_id);
  432. $res = Database::query($sql);
  433. if ($res === false) {
  434. return false;
  435. }
  436. }
  437. }
  438. return true;
  439. }
  440. /**
  441. * Gets the groups of this announce
  442. * @param int announcement id
  443. * @return array array of group id
  444. **/
  445. public static function get_announcement_groups($announcement_id)
  446. {
  447. $tbl_announcement_group = Database::get_main_table(TABLE_MAIN_SYSTEM_ANNOUNCEMENTS_GROUPS);
  448. $tbl_group = Database::get_main_table(TABLE_USERGROUP);
  449. //first delete all group associations for this announcement
  450. $sql = "SELECT
  451. g.id as group_id,
  452. g.name as group_name
  453. FROM $tbl_group g , $tbl_announcement_group ag
  454. WHERE
  455. announcement_id =".intval($announcement_id)." AND
  456. ag.group_id = g.id";
  457. $res = Database::query($sql);
  458. $groups = Database::fetch_array($res);
  459. return $groups;
  460. }
  461. /**
  462. * Updates an announcement to the database
  463. *
  464. * @param integer $id of the announcement
  465. * @param string $title title of the announcement
  466. * @param string $content content of the announcement
  467. * @param array $date_start start date (0 => day ; 1 => month ; 2 => year ; 3 => hour ; 4 => minute)
  468. * @param array $date_end end date of (0 => day ; 1 => month ; 2 => year ; 3 => hour ; 4 => minute)
  469. * @param array $visibility
  470. * @param array $lang
  471. * @param int $send_mail
  472. * @param bool $sendEmailTest
  473. * @return bool True on success, false on failure
  474. */
  475. public static function update_announcement(
  476. $id,
  477. $title,
  478. $content,
  479. $date_start,
  480. $date_end,
  481. $visibility,
  482. $lang = null,
  483. $send_mail = 0,
  484. $sendEmailTest = false
  485. ) {
  486. $em = Database::getManager();
  487. $announcement = $em->find('ChamiloCoreBundle:SysAnnouncement', $id);
  488. if (!$announcement) {
  489. return false;
  490. }
  491. $a_dateS = explode(' ', $date_start);
  492. $a_arraySD = explode('-', $a_dateS[0]);
  493. $a_arraySH = explode(':', $a_dateS[1]);
  494. $date_start_to_compare = array_merge($a_arraySD, $a_arraySH);
  495. $a_dateE = explode(' ', $date_end);
  496. $a_arrayED = explode('-', $a_dateE[0]);
  497. $a_arrayEH = explode(':', $a_dateE[1]);
  498. $date_end_to_compare = array_merge($a_arrayED, $a_arrayEH);
  499. $lang = is_null($lang) ? '' : $lang;
  500. if (!checkdate($date_start_to_compare[1], $date_start_to_compare[2], $date_start_to_compare[0])) {
  501. echo Display::return_message(get_lang('InvalidStartDate'));
  502. return false;
  503. }
  504. if (($date_end_to_compare[1] ||
  505. $date_end_to_compare[2] ||
  506. $date_end_to_compare[0]) &&
  507. !checkdate($date_end_to_compare[1], $date_end_to_compare[2], $date_end_to_compare[0])
  508. ) {
  509. echo Display::return_message(get_lang('InvalidEndDate'));
  510. return false;
  511. }
  512. if (strlen(trim($title)) == 0) {
  513. echo Display::return_message(get_lang('InvalidTitle'));
  514. return false;
  515. }
  516. $start = api_get_utc_datetime($date_start);
  517. $end = api_get_utc_datetime($date_end);
  518. //Fixing urls that are sent by email
  519. //$content = str_replace('src=\"/home/', 'src=\"'.api_get_path(WEB_PATH).'home/', $content);
  520. //$content = str_replace('file=/home/', 'file='.api_get_path(WEB_PATH).'home/', $content);
  521. $content = str_replace(
  522. 'src=\"'.api_get_path(REL_HOME_PATH),
  523. 'src=\"'.api_get_path(WEB_PATH).api_get_path(REL_HOME_PATH),
  524. $content
  525. );
  526. $content = str_replace(
  527. 'file='.api_get_path(REL_HOME_PATH),
  528. 'file='.api_get_path(WEB_PATH).api_get_path(REL_HOME_PATH),
  529. $content
  530. );
  531. if ($sendEmailTest) {
  532. self::send_system_announcement_by_email(
  533. $title,
  534. $content,
  535. null,
  536. null,
  537. $lang,
  538. $sendEmailTest
  539. );
  540. } else {
  541. if ($send_mail == 1) {
  542. self::send_system_announcement_by_email(
  543. $title,
  544. $content,
  545. $visibility,
  546. $lang
  547. );
  548. }
  549. }
  550. $dateStart = new DateTime($start, new DateTimeZone('UTC'));
  551. $dateEnd = new DateTime($end, new DateTimeZone('UTC'));
  552. $announcement
  553. ->setLang($lang)
  554. ->setTitle($title)
  555. ->setContent($content)
  556. ->setDateStart($dateStart)
  557. ->setDateEnd($dateEnd)
  558. //->setVisibleTeacher($visible_teacher)
  559. //->setVisibleStudent($visible_student)
  560. //->setVisibleGuest($visible_guest)
  561. ->setAccessUrlId(api_get_current_access_url_id());
  562. $em->merge($announcement);
  563. $em->flush();
  564. // Update visibility
  565. $list = self::getVisibilityList();
  566. $table = Database::get_main_table(TABLE_MAIN_SYSTEM_ANNOUNCEMENTS);
  567. foreach ($list as $key => $title) {
  568. $value = isset($visibility[$key]) && $visibility[$key] ? 1 : 0;
  569. $sql = "UPDATE $table SET $key = '$value' WHERE id = $id";
  570. Database::query($sql);
  571. }
  572. return true;
  573. }
  574. /**
  575. * Deletes an announcement
  576. * @param int $id The identifier of the announcement that should be
  577. * @return bool True on success, false on failure
  578. */
  579. public static function delete_announcement($id)
  580. {
  581. $table = Database::get_main_table(TABLE_MAIN_SYSTEM_ANNOUNCEMENTS);
  582. $id = intval($id);
  583. $sql = "DELETE FROM $table WHERE id =".$id;
  584. $res = Database::query($sql);
  585. if ($res === false) {
  586. return false;
  587. }
  588. return true;
  589. }
  590. /**
  591. * Gets an announcement
  592. * @param int $id The identifier of the announcement that should be
  593. * @return object Object of class StdClass or the required class, containing the query result row
  594. */
  595. public static function get_announcement($id)
  596. {
  597. $db_table = Database::get_main_table(TABLE_MAIN_SYSTEM_ANNOUNCEMENTS);
  598. $id = intval($id);
  599. $sql = "SELECT * FROM ".$db_table." WHERE id = ".$id;
  600. $announcement = Database::fetch_object(Database::query($sql));
  601. return $announcement;
  602. }
  603. /**
  604. * Change the visibility of an announcement
  605. * @param int $id
  606. * @param int $user For who should the visibility be changed
  607. * @param bool $visible
  608. * @return bool True on success, false on failure
  609. */
  610. public static function set_visibility($id, $user, $visible)
  611. {
  612. $table = Database::get_main_table(TABLE_MAIN_SYSTEM_ANNOUNCEMENTS);
  613. $id = (int) $id;
  614. $list = array_keys(self::getVisibilityList());
  615. $user = trim($user);
  616. $visible = (int) $visible;
  617. if (!in_array($user, $list)) {
  618. return false;
  619. }
  620. $field = $user;
  621. $sql = "UPDATE $table SET ".$field." = '".$visible."'
  622. WHERE id='".$id."'";
  623. $res = Database::query($sql);
  624. if ($res === false) {
  625. return false;
  626. }
  627. return true;
  628. }
  629. /**
  630. * Send a system announcement by e-mail to all teachers/students depending on parameters
  631. * @param string $title
  632. * @param string $content
  633. * @param array $visibility
  634. * @param string $language Language (optional, considered for all languages if left empty)
  635. * @param bool $sendEmailTest
  636. * @return bool True if the message was sent or there was no destination matching.
  637. * False on database or e-mail sending error.
  638. */
  639. public static function send_system_announcement_by_email(
  640. $title,
  641. $content,
  642. $visibility,
  643. $language = null,
  644. $sendEmailTest = false
  645. ) {
  646. $content = str_replace(array('\r\n', '\n', '\r'), '', $content);
  647. $now = api_get_utc_datetime();
  648. $teacher = $visibility['visible_teacher'];
  649. $student = $visibility['visible_student'];
  650. if ($sendEmailTest) {
  651. MessageManager::send_message_simple(api_get_user_id(), $title, $content);
  652. return true;
  653. }
  654. $user_table = Database::get_main_table(TABLE_MAIN_USER);
  655. if (api_is_multiple_url_enabled()) {
  656. $current_access_url_id = api_get_current_access_url_id();
  657. $url_rel_user = Database::get_main_table(TABLE_MAIN_ACCESS_URL_REL_USER);
  658. $url_condition = " INNER JOIN $url_rel_user uu ON uu.user_id = u.user_id ";
  659. }
  660. if ($teacher <> 0 && $student == 0) {
  661. $sql = "SELECT DISTINCT u.user_id FROM $user_table u $url_condition
  662. WHERE status = '1' ";
  663. }
  664. if ($teacher == 0 && $student <> 0) {
  665. $sql = "SELECT DISTINCT u.user_id FROM $user_table u $url_condition
  666. WHERE status = '5' ";
  667. }
  668. if ($teacher <> 0 && $student <> 0) {
  669. $sql = "SELECT DISTINCT u.user_id FROM $user_table u $url_condition
  670. WHERE 1 = 1 ";
  671. }
  672. if (!empty($language)) {
  673. //special condition because language was already treated for SQL insert before
  674. $sql .= " AND language = '".Database::escape_string($language)."' ";
  675. }
  676. if (api_is_multiple_url_enabled()) {
  677. $sql .= " AND access_url_id = '".$current_access_url_id."' ";
  678. }
  679. // Sent to active users.
  680. $sql .= " AND email <>'' AND active = 1 ";
  681. // Expiration date
  682. $sql .= " AND (expiration_date = '' OR expiration_date IS NULL OR expiration_date > '$now') ";
  683. if ((empty($teacher) || $teacher == '0') && (empty($student) || $student == '0')) {
  684. return true;
  685. }
  686. $result = Database::query($sql);
  687. if ($result === false) {
  688. return false;
  689. }
  690. $message_sent = false;
  691. while ($row = Database::fetch_array($result, 'ASSOC')) {
  692. MessageManager::send_message_simple($row['user_id'], $title, $content);
  693. $message_sent = true;
  694. }
  695. // Minor validation to clean up the attachment files in the announcement
  696. if (!empty($_FILES)) {
  697. $attachments = $_FILES;
  698. foreach ($attachments as $attachment) {
  699. unlink($attachment['tmp_name']);
  700. }
  701. }
  702. return $message_sent; //true if at least one e-mail was sent
  703. }
  704. /**
  705. * Displays announcements as an slideshow
  706. * @param string $visible see self::VISIBLE_* constants
  707. * @param int $id The identifier of the announcement to display
  708. *
  709. * @return string
  710. */
  711. public static function displayAnnouncementsSlider($visible, $id = null)
  712. {
  713. $user_selected_language = Database::escape_string(api_get_interface_language());
  714. $table = Database::get_main_table(TABLE_MAIN_SYSTEM_ANNOUNCEMENTS);
  715. $cut_size = 500;
  716. $now = api_get_utc_datetime();
  717. $sql = "SELECT * FROM $table
  718. WHERE
  719. (lang = '$user_selected_language' OR lang = '') AND
  720. ('$now' >= date_start AND '$now' <= date_end) ";
  721. $sql .= self::getVisibilityCondition($visible);
  722. if (isset($id) && !empty($id)) {
  723. $id = intval($id);
  724. $sql .= " AND id = $id ";
  725. }
  726. if (api_is_multiple_url_enabled()) {
  727. $current_url_id = api_get_current_access_url_id();
  728. $sql .= " AND access_url_id IN ('1', '$current_url_id') ";
  729. }
  730. $sql .= " ORDER BY date_start DESC";
  731. $result = Database::query($sql);
  732. $announcements = [];
  733. if (Database::num_rows($result) > 0) {
  734. while ($announcement = Database::fetch_object($result)) {
  735. $announcementData = [
  736. 'id' => $announcement->id,
  737. 'title' => $announcement->title,
  738. 'content' => $announcement->content,
  739. 'readMore' => null
  740. ];
  741. if (empty($id)) {
  742. if (api_strlen(strip_tags($announcement->content)) > $cut_size) {
  743. $announcementData['content'] = cut($announcement->content, $cut_size);
  744. $announcementData['readMore'] = true;
  745. }
  746. }
  747. $announcements[] = $announcementData;
  748. }
  749. }
  750. if (count($announcements) === 0) {
  751. return null;
  752. }
  753. $template = new Template(null, false, false);
  754. $template->assign('announcements', $announcements);
  755. $layout = $template->get_template('announcement/slider.tpl');
  756. return $template->fetch($layout);
  757. }
  758. /**
  759. * Get the HTML code for an announcement
  760. * @param int $announcementId The announcement ID
  761. * @param int $visibility The announcement visibility
  762. * @return string The HTML code
  763. */
  764. public static function displayAnnouncement($announcementId, $visibility)
  765. {
  766. $selectedUserLanguage = Database::escape_string(api_get_interface_language());
  767. $announcementTable = Database::get_main_table(TABLE_MAIN_SYSTEM_ANNOUNCEMENTS);
  768. $now = api_get_utc_datetime();
  769. $whereConditions = [
  770. "(lang = ? OR lang IS NULL OR lang = '') " => $selectedUserLanguage,
  771. "AND (? >= date_start AND ? <= date_end) " => [$now, $now],
  772. "AND id = ? " => intval($announcementId)
  773. ];
  774. $condition = self::getVisibilityCondition($visibility);
  775. $whereConditions[$condition] = 1;
  776. if (api_is_multiple_url_enabled()) {
  777. $whereConditions["AND access_url_id IN (1, ?) "] = api_get_current_access_url_id();
  778. }
  779. $announcement = Database::select(
  780. '*',
  781. $announcementTable,
  782. [
  783. 'where' => $whereConditions,
  784. 'order' => 'date_start',
  785. ],
  786. 'first'
  787. );
  788. $template = new Template(null, false, false);
  789. $template->assign('announcement', $announcement);
  790. $layout = $template->get_template('announcement/view.tpl');
  791. return $template->fetch($layout);
  792. }
  793. /**
  794. * @return bool
  795. */
  796. public static function newRolesActivated()
  797. {
  798. /* In order to use this option you need to run this SQL changes :
  799. ALTER TABLE sys_announcement ADD COLUMN visible_drh INT DEFAULT 0;
  800. ALTER TABLE sys_announcement ADD COLUMN visible_session_admin INT DEFAULT 0;
  801. ALTER TABLE sys_announcement ADD COLUMN visible_boss INT DEFAULT 0;
  802. */
  803. return api_get_configuration_value('system_announce_extra_roles');
  804. }
  805. /**
  806. * @return string
  807. */
  808. public static function getCurrentUserVisibility()
  809. {
  810. if (api_is_anonymous()) {
  811. return SystemAnnouncementManager::VISIBLE_GUEST;
  812. }
  813. if (self::newRolesActivated()) {
  814. if (api_is_student_boss()) {
  815. return SystemAnnouncementManager::VISIBLE_STUDENT_BOSS;
  816. }
  817. if (api_is_session_admin()) {
  818. return SystemAnnouncementManager::VISIBLE_SESSION_ADMIN;
  819. }
  820. if (api_is_drh()) {
  821. return SystemAnnouncementManager::VISIBLE_DRH;
  822. }
  823. if (api_is_teacher()) {
  824. return SystemAnnouncementManager::VISIBLE_TEACHER;
  825. } else {
  826. return SystemAnnouncementManager::VISIBLE_STUDENT;
  827. }
  828. } else {
  829. // Default behaviour
  830. return api_is_teacher() ? SystemAnnouncementManager::VISIBLE_TEACHER : SystemAnnouncementManager::VISIBLE_STUDENT;
  831. }
  832. }
  833. }