system_announcements.lib.php 31 KB

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