events_email.class.php 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281
  1. <?php
  2. /* For licensing terms, see /license.txt */
  3. /**
  4. * Class EventsMail
  5. * @deprecated to be removed in 2.x
  6. * manages the e-mail sending action when a event requires it
  7. */
  8. class EventsMail
  9. {
  10. /**
  11. * Sends email according to an event
  12. *
  13. * @param string $event_name the name of the event that was triggered
  14. * @param array $event_data what to put in the mail
  15. *
  16. * Possible key :
  17. * - $event_data["about_user"] (= $user_id)
  18. * - $event_data["prior_lang"]
  19. *
  20. * Warning :
  21. * - $event_data["send_to"] MUST BE an array
  22. */
  23. public static function send_mail($event_name, $event_data)
  24. {
  25. /**
  26. * Global explanation :
  27. * 1. we get information about the user that fired the event (in $event_data["about_user"])
  28. * 2. we send mail to people that are in the $event_data["send_to"]
  29. * 2b. if a language was specified, we use that one to send the mail,
  30. * else we get the user's language, if there isn't any, we get the english one
  31. * 3. we do the same with the people associated to the event through the admin panel
  32. */
  33. global $event_config;
  34. // common variable for every mail sent
  35. $sender_name = api_get_person_name(
  36. api_get_setting('administratorName'),
  37. api_get_setting('administratorSurname'),
  38. null,
  39. PERSON_NAME_EMAIL_ADDRESS
  40. );
  41. $email_admin = api_get_setting('emailAdministrator');
  42. // basic keys
  43. $event_data["sitename"] = api_get_setting('siteName');
  44. $event_data["administrator_name"] = api_get_setting('administratorName');
  45. $event_data["administrator_surname"] = api_get_setting('administratorSurname');
  46. $event_data["administrator_phone"] = api_get_setting('administratorTelephone');
  47. $event_data["administrator_email"] = api_get_setting('emailAdministrator');
  48. $event_data["portal"] = api_get_path(WEB_PATH);
  49. // Fill the array's cells with info regarding the user that fired the event
  50. // (for the keys in the template)
  51. if (isset($event_data["about_user"])) {
  52. $about_user = api_get_user_info($event_data["about_user"]);
  53. $event_data["firstname"] = $about_user["firstname"];
  54. $event_data["lastname"] = $about_user["lastname"];
  55. $event_data["username"] = $about_user["username"];
  56. $event_data["usermail"] = $about_user["mail"];
  57. $event_data["language"] = $about_user["language"];
  58. $event_data["user_id"] = $about_user["user_id"];
  59. }
  60. // First, we send the mail to people we put in the $event_data["send_to"]
  61. if ($event_data["send_to"] != null) {
  62. // the users we precised need to receive the mail
  63. foreach ($event_data["send_to"] as $id) {
  64. // for every member put in the array
  65. // get user's info (to know where to send)
  66. $user_info = api_get_user_info($id);
  67. // get the language the email will be in
  68. if ($event_data["prior_lang"] != null) {
  69. // if $lang is not null, we use that lang
  70. $language = $event_data["prior_lang"];
  71. } else {
  72. // else we use the user's language
  73. $sql = 'SELECT language
  74. FROM '.Database::get_main_table(TABLE_MAIN_USER).' u
  75. WHERE u.user_id = "'.$id.'"
  76. ';
  77. $language = Database::store_result(
  78. Database::query($sql),
  79. 'ASSOC'
  80. );
  81. $language = $language[0]["language"];
  82. }
  83. // we get the message in the correct language (or in english if doesn't exist)
  84. $result = self::getMessage($event_name, $language);
  85. $message = "";
  86. $subject = "";
  87. self::getCorrectMessage($message, $subject, $language, $result);
  88. // replace the keycodes used in the message
  89. self::formatMessage($message, $subject, $event_config, $event_name, $event_data);
  90. // sending email
  91. $recipient_name = api_get_person_name($user_info['firstname'], $user_info['lastname']);
  92. // checks if there's a file we need to join to the mail
  93. if (isset($values["certificate_pdf_file"])) {
  94. $message = str_replace("\n", "<br />", $message);
  95. api_mail_html(
  96. $recipient_name,
  97. $user_info["mail"],
  98. $subject,
  99. $message,
  100. $sender_name,
  101. $email_admin,
  102. null,
  103. array($values['certificate_pdf_file'])
  104. );
  105. } else {
  106. api_mail_html(
  107. $recipient_name,
  108. $user_info["mail"],
  109. $subject,
  110. $message,
  111. $sender_name,
  112. $email_admin
  113. );
  114. }
  115. // If the mail only need to be send once (we know that thanks to the events.conf), we log it in the table
  116. if ($event_config[$event_name]["sending_mail_once"]) {
  117. $sql = 'INSERT INTO '.Database::get_main_table(TABLE_EVENT_SENT).' (user_from, user_to, event_type_name)
  118. VALUES ('.$event_data["user_id"].', '.$id.' ,"'.Database::escape_string($event_name).'")
  119. ';
  120. Database::query($sql);
  121. }
  122. }
  123. }
  124. // Second, we send to people linked to the event
  125. // So, we get everyone
  126. $sql = 'SELECT u.user_id, u.language, u.email, u.firstname, u.lastname
  127. FROM ' . Database::get_main_table(TABLE_EVENT_TYPE_REL_USER).' ue
  128. INNER JOIN '.Database::get_main_table(TABLE_MAIN_USER).' u ON u.user_id = ue.user_id
  129. WHERE event_type_name = "' . $event_name.'"';
  130. $result = Database::store_result(Database::query($sql), 'ASSOC');
  131. // for each of the linked users
  132. foreach ($result as $key => $value) {
  133. // we get the language
  134. if ($event_data["prior_lang"] != null) {
  135. // if $lang is not null, we use that lang
  136. $language = $event_data["prior_lang"];
  137. } else {
  138. // else we get the user's lang
  139. $sql = 'SELECT language FROM '.Database::get_main_table(TABLE_MAIN_USER).'
  140. where user_id = '.$value["user_id"].' ';
  141. $result = Database::store_result(Database::query($sql), 'ASSOC');
  142. $language = $result[0]["language"];
  143. }
  144. // we get the message in the correct language (or in english if doesn't exist)
  145. $result = self::getMessage($event_name, $language);
  146. $message = '';
  147. $subject = '';
  148. self::getCorrectMessage($message, $subject, $language, $result);
  149. // replace the keycodes used in the message
  150. self::formatMessage($message, $subject, $event_config, $event_name, $event_data);
  151. // we send the mail
  152. $recipient_name = api_get_person_name($value['firstname'], $value['lastname']);
  153. api_mail_html(
  154. $recipient_name,
  155. $value["email"],
  156. $subject,
  157. $message,
  158. $sender_name,
  159. $email_admin
  160. );
  161. // If the mail only need to be send once (we know that thanks to the events.conf, we log it in the table
  162. if ($event_config[$event_name]["sending_mail_once"]) {
  163. $sql = 'INSERT INTO '.Database::get_main_table(TABLE_EVENT_SENT).'
  164. (user_from, user_to, event_type_name)
  165. VALUES ('.$event_data["user_id"].', '.$value["user_id"].' , "'.Database::escape_string($event_name).'");
  166. ';
  167. Database::query($sql);
  168. }
  169. }
  170. }
  171. /**
  172. * Checks if a message in a language exists, if the event is activated
  173. * and if "manage event" is checked in admin panel.
  174. * If yes to three, we can use this class, else we still use api_mail.
  175. *
  176. * @param string $event_name
  177. * @return boolean
  178. */
  179. public static function check_if_using_class($event_name)
  180. {
  181. if (api_get_setting('activate_email_template') === 'false') {
  182. return false;
  183. }
  184. $current_language = api_get_interface_language();
  185. $sql = 'SELECT COUNT(*) as total
  186. FROM ' . Database::get_main_table(TABLE_EVENT_EMAIL_TEMPLATE).' em
  187. INNER JOIN ' . Database::get_main_table(TABLE_MAIN_LANGUAGE).' l
  188. ON em.language_id = l.id
  189. WHERE
  190. em.event_type_name = "' . $event_name.'" and
  191. l.dokeos_folder = "'.$current_language.'" and
  192. em.activated = 1';
  193. $exists = Database::store_result(Database::query($sql), 'ASSOC');
  194. if ($exists[0]["total"]) {
  195. return true;
  196. } else {
  197. return false;
  198. }
  199. }
  200. /**
  201. * Get the record containing the good message and subject
  202. *
  203. * @param string $event_name
  204. * @param string $language
  205. * @return array
  206. */
  207. private static function getMessage($event_name, $language)
  208. {
  209. $sql = 'SELECT message, subject, l.dokeos_folder
  210. FROM ' . Database::get_main_table(TABLE_EVENT_EMAIL_TEMPLATE).' em
  211. INNER JOIN ' . Database::get_main_table(TABLE_MAIN_LANGUAGE).' l
  212. ON em.language_id = l.id
  213. WHERE
  214. em.event_type_name = "' . $event_name.'" AND
  215. (l.dokeos_folder = "' . $language.'" OR l.dokeos_folder = "english") AND
  216. em.message <> ""
  217. ';
  218. return Database::store_result(Database::query($sql), 'ASSOC');
  219. }
  220. /**
  221. * Get the correct message, meaning in the specified language or in english if previous one doesn't exist
  222. *
  223. * @param string $message
  224. * @param string $subject
  225. * @param string $language
  226. * @param array $result
  227. */
  228. private static function getCorrectMessage(&$message, &$subject, $language, $result)
  229. {
  230. foreach ($result as $msg) {
  231. if ($msg["dokeos_folder"] == $language) {
  232. $message = $msg["message"];
  233. $subject = $msg["subject"];
  234. break;
  235. } else {
  236. if ($msg["dokeos_folder"] == "english") {
  237. $message = $msg["message"];
  238. $subject = $msg["subject"];
  239. }
  240. }
  241. }
  242. }
  243. /**
  244. * Replaces the ((key)) by the good values
  245. *
  246. * @param string $message
  247. * @param string $subject
  248. * @param array $event_config
  249. * @param string $event_name
  250. */
  251. private static function formatMessage(&$message, &$subject, $event_config, $event_name, &$event_data)
  252. {
  253. foreach ($event_config[$event_name]["available_keyvars"] as $key => $word) {
  254. $message = str_replace('(('.$key.'))', $event_data[$word], $message);
  255. $subject = str_replace('(('.$key.'))', $event_data[$word], $subject);
  256. }
  257. }
  258. }