Fix UFBF_QuickSearch.
[platal.git] / modules / newsletter.php
CommitLineData
e2efba7d 1<?php
2/***************************************************************************
12262f13 3 * Copyright (C) 2003-2011 Polytechnique.org *
e2efba7d 4 * http://opensource.polytechnique.org/ *
5 * *
6 * This program is free software; you can redistribute it and/or modify *
7 * it under the terms of the GNU General Public License as published by *
8 * the Free Software Foundation; either version 2 of the License, or *
9 * (at your option) any later version. *
10 * *
11 * This program is distributed in the hope that it will be useful, *
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of *
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
14 * GNU General Public License for more details. *
15 * *
16 * You should have received a copy of the GNU General Public License *
17 * along with this program; if not, write to the Free Software *
18 * Foundation, Inc., *
19 * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA *
20 ***************************************************************************/
21
22class NewsletterModule extends PLModule
23{
24 function handlers()
25 {
26 return array(
84163d58
RB
27 'nl' => $this->make_hook('nl', AUTH_COOKIE),
28 'nl/show' => $this->make_hook('nl_show', AUTH_COOKIE),
5e9a29ed 29 'nl/search' => $this->make_hook('nl_search', AUTH_COOKIE),
84163d58 30 'nl/submit' => $this->make_hook('nl_submit', AUTH_MDP),
0fd5be99 31 'nl/remaining' => $this->make_hook('nl_remaining', AUTH_MDP),
84163d58
RB
32 'admin/nls' => $this->make_hook('admin_nl_groups', AUTH_MDP, 'admin'),
33 'admin/newsletter' => $this->make_hook('admin_nl', AUTH_MDP, 'admin'),
34 'admin/newsletter/categories' => $this->make_hook('admin_nl_cat', AUTH_MDP, 'admin'),
35 'admin/newsletter/edit' => $this->make_hook('admin_nl_edit', AUTH_MDP, 'admin'),
fccf0105 36 'admin/newsletter/edit/delete' => $this->make_hook('admin_nl_delete', AUTH_MDP, 'admin'),
84163d58
RB
37 // Automatic mailing is disabled for X.org NL
38// 'admin/newsletter/edit/cancel' => $this->make_hook('cancel', AUTH_MDP, 'admin'),
39// 'admin/newsletter/edit/valid' => $this->make_hook('valid', AUTH_MDP, 'admin'),
e2efba7d 40 );
41 }
42
84163d58
RB
43 /** This function should return the adequate NewsLetter object for the current module.
44 */
45 protected function getNl()
e2efba7d 46 {
47 require_once 'newsletter.inc.php';
84163d58
RB
48 return NewsLetter::forGroup(NewsLetter::GROUP_XORG);
49 }
50
26ba053e 51 function handler_nl($page, $action = null, $hash = null)
84163d58
RB
52 {
53 $nl = $this->getNl();
54 if (!$nl) {
55 return PL_NOT_FOUND;
56 }
e2efba7d 57
58 $page->changeTpl('newsletter/index.tpl');
46f272fe 59 $page->setTitle('Lettres mensuelles');
e2efba7d 60
61 switch ($action) {
84163d58
RB
62 case 'out': $nl->unsubscribe($hash, $hash != null); break;
63 case 'in': $nl->subscribe(); break;
e2efba7d 64 default: ;
65 }
66
84163d58
RB
67 $page->assign_by_ref('nl', $nl);
68 $page->assign('nls', $nl->subscriptionState());
69 $page->assign('nl_list', $nl->listSentIssues(true));
e2efba7d 70 }
71
26ba053e 72 function handler_nl_show($page, $nid = 'last')
e2efba7d 73 {
74 $page->changeTpl('newsletter/show.tpl');
84163d58
RB
75 $nl = $this->getNl();
76 if (!$nl) {
77 return PL_NOT_FOUND;
78 }
e2efba7d 79
9da70671 80 try {
84163d58 81 $issue = $nl->getIssue($nid);
6d1747b3 82 $user =& S::user();
9da70671 83 if (Get::has('text')) {
84163d58 84 $issue->toText($page, $user);
9da70671 85 } else {
84163d58 86 $issue->toHtml($page, $user);
9da70671
SJ
87 }
88 if (Post::has('send')) {
84163d58 89 $issue->sendTo($user);
9da70671
SJ
90 }
91 } catch (MailNotFound $e) {
92 return PL_NOT_FOUND;
e2efba7d 93 }
94 }
95
5e9a29ed
SJ
96 function handler_nl_search($page)
97 {
98 S::assert_xsrf_token();
99 $nl = $this->getNl();
100 if (!$nl) {
101 return PL_NOT_FOUND;
102 }
103
104 if (!Post::has('nl_search')) {
105 pl_redirect($nl->prefix());
106 }
107
108 $nl_search = Post::t('nl_search');
109 $nl_search_type = Post::t('nl_search_type');
110 if (!$nl_search || !($nl_search_type > 0 && $nl_search_type < 10)) {
111 $page->trigErrorRedirect('La recherche est vide ou erronée.', $nl->prefix());
112 }
113
114 $page->changeTpl('newsletter/search.tpl');
115 $user = S::user();
116 $fields = array(1 => 'all', 2 => 'all', 3 => 'title', 4 => 'body', 5 => 'append', 6 => 'all', 7 => 'title', 8 => 'head', 9 => 'signature');
117 $res_articles = $res_issues = array();
118 if ($nl_search_type < 6) {
119 $res_articles = $nl->articleSearch($nl_search, $fields[$nl_search_type], $user);
120 }
121 if ($nl_search_type > 5 || $nl_search_type == 1) {
122 $res_issues = $nl->issueSearch($nl_search, $fields[$nl_search_type], $user);
123 }
124
125 $articles_count = count($res_articles);
126 $issues_count = count($res_issues);
127 $results_count = $articles_count + $issues_count;
128 if ($results_count > 200) {
129 $page->trigError('Recherche trop générale.');
130 } elseif ($results_count == 0) {
131 $page->trigWarning('Aucun résultat pour cette recherche.');
132 } else {
133 $page->assign('res_articles', $res_articles);
134 $page->assign('res_issues', $res_issues);
135 $page->assign('articles_count', $articles_count);
136 $page->assign('issues_count', $issues_count);
137 }
138
139 $page->assign_by_ref('nl', $nl);
140 $page->assign('nl_search', $nl_search);
141 $page->assign('nl_search_type', $nl_search_type);
142 $page->assign('results_count', $results_count);
143 }
144
26ba053e 145 function handler_nl_submit($page)
e2efba7d 146 {
147 $page->changeTpl('newsletter/submit.tpl');
148
84163d58
RB
149 $nl = $this->getNl();
150 if (!$nl) {
151 return PL_NOT_FOUND;
152 }
153
8f201b69
FB
154 $wp = new PlWikiPage('Xorg.LettreMensuelle');
155 $wp->buildCache();
e2efba7d 156
1970c12b 157 if (Post::has('see') || (Post::has('valid') && (!trim(Post::v('title')) || !trim(Post::v('body'))))) {
158 if (!Post::has('see')) {
a7d35093 159 $page->trigError("L'article doit avoir un titre et un contenu");
1970c12b 160 }
e2efba7d 161 $art = new NLArticle(Post::v('title'), Post::v('body'), Post::v('append'));
162 $page->assign('art', $art);
163 } elseif (Post::has('valid')) {
5daf68f6 164 $art = new NLReq(S::user(), Post::v('title'),
e2efba7d 165 Post::v('body'), Post::v('append'));
166 $art->submit();
167 $page->assign('submited', true);
168 }
84163d58 169 $page->addCssLink($nl->cssFile());
e2efba7d 170 }
171
0fd5be99
SJ
172 function handler_nl_remaining($page)
173 {
174 require_once 'newsletter.inc.php';
175
176 pl_content_headers('text/html');
177 $page->changeTpl('newsletter/remaining.tpl', NO_SKIN);
178
179 $article = new NLArticle('', Post::t('body'), '');
180 $rest = $article->remain();
181
182 $page->assign('too_long', $rest['remaining_lines'] < 0);
183 $page->assign('last_line', ($rest['remaining_lines'] == 0));
184 $page->assign('remaining', ($rest['remaining_lines'] == 0) ? $rest['remaining_characters_for_last_line'] : $rest['remaining_lines']);
185 }
186
26ba053e 187 function handler_admin_nl($page, $new = false) {
e2efba7d 188 $page->changeTpl('newsletter/admin.tpl');
46f272fe 189 $page->setTitle('Administration - Newsletter : liste');
84163d58
RB
190
191 $nl = $this->getNl();
192 if (!$nl) {
193 return PL_NOT_FOUND;
194 }
eaf30d86 195
2d1ed661 196 if ($new == 'new') {
93f23312
SJ
197 // Logs NL creation.
198 S::logger()->log('nl_issue_create', $nid);
199
84163d58
RB
200 $id = $nl->createPending();
201 pl_redirect($nl->adminPrefix() . '/edit/' . $id);
e2efba7d 202 }
eaf30d86 203
84163d58
RB
204 $page->assign_by_ref('nl', $nl);
205 $page->assign('nl_list', $nl->listAllIssues());
206 }
207
26ba053e 208 function handler_admin_nl_groups($page)
84163d58
RB
209 {
210 require_once 'newsletter.inc.php';
211
212 $page->changeTpl('newsletter/admin_all.tpl');
213 $page->setTitle('Administration - Newsletters : Liste des Newsletters');
214
215 $page->assign('nls', Newsletter::getAll());
e2efba7d 216 }
eaf30d86 217
26ba053e 218 function handler_admin_nl_edit($page, $nid = 'last', $aid = null, $action = 'edit') {
e2efba7d 219 $page->changeTpl('newsletter/edit.tpl');
84163d58 220 $page->addCssLink('nl.Polytechnique.org.css');
e4705641 221 $page->setTitle('Administration - Newsletter : Édition');
eaf30d86 222
84163d58
RB
223 $nl = $this->getNl();
224 if (!$nl) {
225 return PL_NOT_FOUND;
226 }
eaf30d86 227
84163d58
RB
228 try {
229 $issue = $nl->getIssue($nid, false);
230 } catch (MailNotFound $e) {
231 return PL_NOT_FOUND;
e2efba7d 232 }
eaf30d86 233
84163d58
RB
234 $ufb = $nl->getSubscribersUFB();
235 $ufb_keepenv = false; // Will be set to True if there were invalid modification to the UFB.
236
237 // Convert NLIssue error messages to human-readable errors
238 $error_msgs = array(
239 NLIssue::ERROR_INVALID_SHORTNAME => "Le nom court est invalide ou vide.",
240 NLIssue::ERROR_INVALID_UFC => "Le filtre des destinataires est invalide.",
241 NLIssue::ERROR_SQL_SAVE => "Une erreur est survenue en tentant de sauvegarder la lettre, merci de réessayer.",
242 );
243
244 // Update the current issue
2d1ed661 245 if($aid == 'update' && Post::has('submit')) {
84163d58
RB
246
247 // Save common fields
248 $issue->title = Post::s('title');
249 $issue->title_mail = Post::s('title_mail');
250 $issue->head = Post::s('head');
251 $issue->signature = Post::s('signature');
252
253 if ($issue->isEditable()) {
254 // Date and shortname may only be modified for pending NLs, otherwise all links get broken.
255 $issue->date = Post::s('date');
256 $issue->shortname = strlen(Post::blank('shortname')) ? null : Post::s('shortname');
257 $issue->sufb->updateFromEnv($ufb->getEnv());
258
259 if ($nl->automaticMailingEnabled()) {
260 $issue->send_before = preg_replace('/^(\d\d\d\d)(\d\d)(\d\d)$/', '\1-\2-\3', Post::v('send_before_date')) . ' ' . Post::i('send_before_time_Hour') . ':00:00';
261 }
262 }
263 $errors = $issue->save();
264 if (count($errors)) {
265 foreach ($errors as $error_code) {
266 $page->trigError($error_msgs[$error_code]);
267 }
e2efba7d 268 }
269 }
eaf30d86 270
84163d58
RB
271 // Delete an article
272 if($action == 'delete') {
273 $issue->delArticle($aid);
274 pl_redirect($nl->adminPrefix() . "/edit/$nid");
275 }
276
277 // Save an article
e2efba7d 278 if(Post::v('save')) {
279 $art = new NLArticle(Post::v('title'), Post::v('body'), Post::v('append'),
9e2a6a32 280 $aid, Post::v('cid'), Post::v('pos'));
84163d58
RB
281 $issue->saveArticle($art);
282 pl_redirect($nl->adminPrefix() . "/edit/$nid");
e2efba7d 283 }
eaf30d86 284
84163d58 285 // Edit an article
9e2a6a32 286 if ($action == 'edit' && $aid != 'update') {
e2efba7d 287 $eaid = $aid;
e4705641 288 if (Post::has('title')) {
e2efba7d 289 $art = new NLArticle(Post::v('title'), Post::v('body'), Post::v('append'),
e4705641 290 $eaid, Post::v('cid'), Post::v('pos'));
e2efba7d 291 } else {
84163d58 292 $art = ($eaid == 'new') ? new NLArticle() : $issue->getArt($eaid);
e4705641
SJ
293 }
294 if ($art && !$art->check()) {
295 $page->trigError("Cet article est trop long.");
e2efba7d 296 }
297 $page->assign('art', $art);
298 }
eaf30d86 299
84163d58 300 // Check blacklisted IPs
9e2a6a32 301 if ($aid == 'blacklist_check') {
955109ba 302 global $globals;
9e2a6a32 303 $ips_to_check = array();
955109ba 304 $blacklist_host_resolution_count = 0;
9e2a6a32 305
84163d58 306 foreach ($issue->arts as $key => $articles) {
9e2a6a32 307 foreach ($articles as $article) {
955109ba 308 $article_ips = $article->getLinkIps($blacklist_host_resolution_count);
9e2a6a32
SJ
309 if (!empty($article_ips)) {
310 $ips_to_check[$article->title()] = $article_ips;
311 }
312 }
313 }
314
315 $page->assign('ips_to_check', $ips_to_check);
955109ba
SJ
316 if ($blacklist_host_resolution_count >= $globals->mail->blacklist_host_resolution_limit) {
317 $page->trigError("Toutes les url et adresses emails de la lettre"
9e2a6a32
SJ
318 . " n'ont pas été prises en compte car la"
319 . " limite du nombre de résolutions DNS"
320 . " autorisée a été atteinte.");
321 }
322 }
323
84163d58
RB
324 if ($issue->state == NLIssue::STATE_SENT) {
325 $page->trigWarning("Cette lettre a déjà été envoyée ; il est recommandé de limiter les modifications au maximum (orthographe, adresses web et mail).");
326 }
327
328 $ufb->setEnv($issue->sufb->getEnv());
9e2a6a32 329 $page->assign_by_ref('nl', $nl);
84163d58
RB
330 $page->assign_by_ref('issue', $issue);
331 }
332
333 /** This handler will cancel the sending of the currently pending issue
334 * It is disabled for X.org mailings.
335 */
26ba053e 336 function handler_admin_nl_cancel($page, $nid, $force = null)
84163d58
RB
337 {
338 $nl = $this->getNl();
339 if (!$nl) {
340 return PL_NOT_FOUND;
341 }
342
343 if (!$nl->mayEdit() || !S::has_xsrf_token()) {
344 return PL_FORBIDDEN;
345 }
346
347 if (!$nid) {
348 $page->kill("La lettre n'a pas été spécifiée");
349 }
350
351 $issue = $nl->getIssue($nid);
352 if (!$issue) {
353 $page->kill("La lettre {$nid} n'existe pas.");
354 }
355 if (!$issue->cancelMailing()) {
356 $page->trigErrorRedirect("Une erreur est survenue lors de l'annulation de l'envoi.", $nl->adminPrefix());
357 }
358
93f23312
SJ
359 // Logs NL cancelling.
360 S::logger()->log('nl_mailing_cancel', $nid);
361
84163d58
RB
362 $page->trigSuccessRedirect("L'envoi de l'annonce {$issue->title()} est annulé.", $nl->adminPrefix());
363 }
364
365 /** This handler will enable the sending of the currently pending issue
366 * It is disabled for X.org mailings.
367 */
26ba053e 368 function handler_admin_nl_valid($page, $nid, $force = null)
84163d58
RB
369 {
370 $nl = $this->getNl();
371 if (!$nl) {
372 return PL_NOT_FOUND;
373 }
374
375 if (!$nl->mayEdit() || !S::has_xsrf_token()) {
376 return PL_FORBIDDEN;
377 }
378
379 if (!$nid) {
380 $page->kill("La lettre n'a pas été spécifiée.");
381 }
382
383 $issue = $nl->getIssue($nid);
384 if (!$issue) {
385 $page->kill("La lettre {$nid} n'existe pas.");
386 }
387 if (!$issue->scheduleMailing()) {
388 $page->trigErrorRedirect("Une erreur est survenue lors de la validation de l'envoi.", $nl->adminPrefix());
389 }
390
93f23312
SJ
391 // Logs NL validation.
392 S::logger()->log('nl_mailing_valid', $nid);
393
84163d58
RB
394 $page->trigSuccessRedirect("L'envoi de la newsletter {$issue->title()} a été validé.", $nl->adminPrefix());
395 }
396
397 /** This handler will remove the given issue.
398 */
26ba053e 399 function handler_admin_nl_delete($page, $nid, $force = null)
84163d58
RB
400 {
401 $nl = $this->getNl();
402 if (!$nl) {
403 return PL_NOT_FOUND;
404 }
405
406 if (!$nl->mayEdit() || !S::has_xsrf_token()) {
407 return PL_FORBIDDEN;
408 }
409
410 if (!$nid) {
411 $page->kill("La lettre n'a pas été spécifiée.");
412 }
413
414 $issue = $nl->getIssue($nid);
415 if (!$issue) {
416 $page->kill("La lettre {$nid} n'existe pas");
417 }
418 if (!$issue->isEditable()) {
419 $page->trigErrorRedirect("La lette a été envoyée ou est en cours d'envoi, elle ne peut être supprimée.", $nl->adminPrefix());
420 }
421 if (!$issue->delete()) {
422 $page->trigErrorRedirect("Une erreur est survenue lors de la suppression de la lettre.", $nl->adminPrefix());
423 }
424
93f23312
SJ
425 // Logs NL deletion.
426 S::logger()->log('nl_issue_delete', $nid);
427
84163d58 428 $page->trigSuccessRedirect("La lettre a bien été supprimée.", $nl->adminPrefix());
e2efba7d 429 }
430
26ba053e 431 function handler_admin_nl_cat($page, $action = 'list', $id = null) {
46f272fe 432 $page->setTitle('Administration - Newsletter : Catégories');
a7de4ef7 433 $page->assign('title', 'Gestion des catégories de la newsletter');
e2efba7d 434 $table_editor = new PLTableEditor('admin/newsletter/categories','newsletter_cat','cid');
84163d58 435 $table_editor->describe('title','intitulé',true);
e2efba7d 436 $table_editor->describe('pos','position',true);
437 $table_editor->apply($page, $action, $id);
bc0903c7 438 }
e2efba7d 439}
440
a7de4ef7 441// vim:set et sw=4 sts=4 sws=4 foldmethod=marker enc=utf-8:
e2efba7d 442?>