modules/newsletter.php

   1 <?php
   2 /***************************************************************************
   3  *  Copyright (C) 2003-2011 Polytechnique.org                              *
   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
  22 class NewsletterModule extends PLModule
  23 {
  24     function handlers()
  25     {
  26         return array(
  27             'nl'                           => $this->make_hook('nl',              AUTH_COOKIE),
  28             'nl/show'                      => $this->make_hook('nl_show',         AUTH_COOKIE),
  29             'nl/search'                    => $this->make_hook('nl_search',       AUTH_COOKIE),
  30             'nl/submit'                    => $this->make_hook('nl_submit',       AUTH_MDP),
  31             'nl/remaining'                 => $this->make_hook('nl_remaining',    AUTH_MDP),
  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'),
  36             'admin/newsletter/edit/delete' => $this->make_hook('admin_nl_delete', AUTH_MDP, 'admin'),
  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'),
  40         );
  41     }
  42
  43     /** This function should return the adequate NewsLetter object for the current module.
  44      */
  45     protected function getNl()
  46     {
  47         require_once 'newsletter.inc.php';
  48         return NewsLetter::forGroup(NewsLetter::GROUP_XORG);
  49     }
  50
  51     function handler_nl($page, $action = null, $hash = null)
  52     {
  53         $nl = $this->getNl();
  54         if (!$nl) {
  55             return PL_NOT_FOUND;
  56         }
  57
  58         $page->changeTpl('newsletter/index.tpl');
  59         $page->setTitle('Lettres mensuelles');
  60
  61         switch ($action) {
  62           case 'out': $nl->unsubscribe($hash, $hash != null); break;
  63           case 'in':  $nl->subscribe(); break;
  64           default: ;
  65         }
  66
  67         $page->assign_by_ref('nl', $nl);
  68         $page->assign('nls', $nl->subscriptionState());
  69         $page->assign('nl_list', $nl->listSentIssues(true));
  70     }
  71
  72     function handler_nl_show($page, $nid = 'last')
  73     {
  74         $page->changeTpl('newsletter/show.tpl');
  75         $nl = $this->getNl();
  76         if (!$nl) {
  77             return PL_NOT_FOUND;
  78         }
  79
  80         try {
  81             $issue = $nl->getIssue($nid);
  82             $user =& S::user();
  83             if (Get::has('text')) {
  84                 $issue->toText($page, $user);
  85             } else {
  86                 $issue->toHtml($page, $user);
  87             }
  88             if (Post::has('send')) {
  89                 $issue->sendTo($user);
  90             }
  91         } catch (MailNotFound $e) {
  92             return PL_NOT_FOUND;
  93         }
  94     }
  95
  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
 145     function handler_nl_submit($page)
 146     {
 147         $page->changeTpl('newsletter/submit.tpl');
 148
 149         $nl = $this->getNl();
 150         if (!$nl) {
 151             return PL_NOT_FOUND;
 152         }
 153
 154         $wp = new PlWikiPage('Xorg.LettreMensuelle');
 155         $wp->buildCache();
 156
 157         if (Post::has('see') || (Post::has('valid') && (!trim(Post::v('title')) || !trim(Post::v('body'))))) {
 158             if (!Post::has('see')) {
 159                 $page->trigError("L'article doit avoir un titre et un contenu");
 160             }
 161             $art = new NLArticle(Post::v('title'), Post::v('body'), Post::v('append'));
 162             $page->assign('art', $art);
 163         } elseif (Post::has('valid')) {
 164             $art = new NLReq(S::user(), Post::v('title'),
 165                              Post::v('body'), Post::v('append'));
 166             $art->submit();
 167             $page->assign('submited', true);
 168         }
 169         $page->addCssLink($nl->cssFile());
 170     }
 171
 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
 187     function handler_admin_nl($page, $new = false) {
 188         $page->changeTpl('newsletter/admin.tpl');
 189         $page->setTitle('Administration - Newsletter : liste');
 190
 191         $nl = $this->getNl();
 192         if (!$nl) {
 193             return PL_NOT_FOUND;
 194         }
 195
 196         if ($new == 'new') {
 197             // Logs NL creation.
 198             S::logger()->log('nl_issue_create', $nid);
 199
 200             $id = $nl->createPending();
 201             pl_redirect($nl->adminPrefix() . '/edit/' . $id);
 202         }
 203
 204         $page->assign_by_ref('nl', $nl);
 205         $page->assign('nl_list', $nl->listAllIssues());
 206     }
 207
 208     function handler_admin_nl_groups($page)
 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());
 216     }
 217
 218     function handler_admin_nl_edit($page, $nid = 'last', $aid = null, $action = 'edit') {
 219         $page->changeTpl('newsletter/edit.tpl');
 220         $page->addCssLink('nl.Polytechnique.org.css');
 221         $page->setTitle('Administration - Newsletter : Édition');
 222
 223         $nl = $this->getNl();
 224         if (!$nl) {
 225             return PL_NOT_FOUND;
 226         }
 227
 228         try {
 229             $issue = $nl->getIssue($nid, false);
 230         } catch (MailNotFound $e) {
 231             return PL_NOT_FOUND;
 232         }
 233
 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_TOO_LONG_UFC => "Le nombre de matricules AX renseigné est trop élevé."
 242             NLIssue::ERROR_SQL_SAVE => "Une erreur est survenue en tentant de sauvegarder la lettre, merci de réessayer.",
 243         );
 244
 245         // Update the current issue
 246         if($aid == 'update' && Post::has('submit')) {
 247
 248             // Save common fields
 249             $issue->title      = Post::s('title');
 250             $issue->title_mail = Post::s('title_mail');
 251             $issue->head       = Post::s('head');
 252             $issue->signature  = Post::s('signature');
 253
 254             if ($issue->isEditable()) {
 255                 // Date and shortname may only be modified for pending NLs, otherwise all links get broken.
 256                 $issue->date = Post::s('date');
 257                 $issue->shortname = strlen(Post::blank('shortname')) ? null : Post::s('shortname');
 258                 $issue->sufb->updateFromEnv($ufb->getEnv());
 259
 260                 if ($nl->automaticMailingEnabled()) {
 261                     $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';
 262                 }
 263             }
 264             $errors = $issue->save();
 265             if (count($errors)) {
 266                 foreach ($errors as $error_code) {
 267                     $page->trigError($error_msgs[$error_code]);
 268                 }
 269             }
 270         }
 271
 272         // Delete an article
 273         if($action == 'delete') {
 274             $issue->delArticle($aid);
 275             pl_redirect($nl->adminPrefix() . "/edit/$nid");
 276         }
 277
 278         // Save an article
 279         if(Post::v('save')) {
 280             $art  = new NLArticle(Post::v('title'), Post::v('body'), Post::v('append'),
 281                                   $aid, Post::v('cid'), Post::v('pos'));
 282             $issue->saveArticle($art);
 283             pl_redirect($nl->adminPrefix() . "/edit/$nid");
 284         }
 285
 286         // Edit an article
 287         if ($action == 'edit' && $aid != 'update') {
 288             $eaid = $aid;
 289             if (Post::has('title')) {
 290                 $art  = new NLArticle(Post::v('title'), Post::v('body'), Post::v('append'),
 291                                       $eaid, Post::v('cid'), Post::v('pos'));
 292             } else {
 293                 $art = ($eaid == 'new') ? new NLArticle() : $issue->getArt($eaid);
 294             }
 295             if ($art && !$art->check()) {
 296                 $page->trigError("Cet article est trop long.");
 297             }
 298             $page->assign('art', $art);
 299         }
 300
 301         // Check blacklisted IPs
 302         if ($aid == 'blacklist_check') {
 303             global $globals;
 304             $ips_to_check = array();
 305             $blacklist_host_resolution_count = 0;
 306
 307             foreach ($issue->arts as $key => $articles) {
 308                 foreach ($articles as $article) {
 309                     $article_ips = $article->getLinkIps($blacklist_host_resolution_count);
 310                     if (!empty($article_ips)) {
 311                         $ips_to_check[$article->title()] = $article_ips;
 312                     }
 313                 }
 314             }
 315
 316             $page->assign('ips_to_check', $ips_to_check);
 317             if ($blacklist_host_resolution_count >= $globals->mail->blacklist_host_resolution_limit) {
 318                 $page->trigError("Toutes les url et adresses emails de la lettre"
 319                                 . " n'ont pas été prises en compte car la"
 320                                 . " limite du nombre de résolutions DNS"
 321                                 . " autorisée a été atteinte.");
 322             }
 323         }
 324
 325         if ($issue->state == NLIssue::STATE_SENT) {
 326             $page->trigWarning("Cette lettre a déjà été envoyée ; il est recommandé de limiter les modifications au maximum (orthographe, adresses web et mail).");
 327         }
 328
 329         $ufb->setEnv($issue->sufb->getEnv());
 330         $page->assign_by_ref('nl', $nl);
 331         $page->assign_by_ref('issue', $issue);
 332     }
 333
 334     /** This handler will cancel the sending of the currently pending issue
 335      * It is disabled for X.org mailings.
 336      */
 337     function handler_admin_nl_cancel($page, $nid, $force = null)
 338     {
 339         $nl = $this->getNl();
 340         if (!$nl) {
 341             return PL_NOT_FOUND;
 342         }
 343
 344         if (!$nl->mayEdit() || !S::has_xsrf_token()) {
 345             return PL_FORBIDDEN;
 346         }
 347
 348         if (!$nid) {
 349             $page->kill("La lettre n'a pas été spécifiée");
 350         }
 351
 352         $issue = $nl->getIssue($nid);
 353         if (!$issue) {
 354             $page->kill("La lettre {$nid} n'existe pas.");
 355         }
 356         if (!$issue->cancelMailing()) {
 357             $page->trigErrorRedirect("Une erreur est survenue lors de l'annulation de l'envoi.", $nl->adminPrefix());
 358         }
 359
 360         // Logs NL cancelling.
 361         S::logger()->log('nl_mailing_cancel', $nid);
 362
 363         $page->trigSuccessRedirect("L'envoi de l'annonce {$issue->title()} est annulé.", $nl->adminPrefix());
 364     }
 365
 366     /** This handler will enable the sending of the currently pending issue
 367      * It is disabled for X.org mailings.
 368      */
 369     function handler_admin_nl_valid($page, $nid, $force = null)
 370     {
 371         $nl = $this->getNl();
 372         if (!$nl) {
 373             return PL_NOT_FOUND;
 374         }
 375
 376         if (!$nl->mayEdit() || !S::has_xsrf_token()) {
 377             return PL_FORBIDDEN;
 378         }
 379
 380         if (!$nid) {
 381             $page->kill("La lettre n'a pas été spécifiée.");
 382         }
 383
 384         $issue = $nl->getIssue($nid);
 385         if (!$issue) {
 386             $page->kill("La lettre {$nid} n'existe pas.");
 387         }
 388         if (!$issue->scheduleMailing()) {
 389             $page->trigErrorRedirect("Une erreur est survenue lors de la validation de l'envoi.", $nl->adminPrefix());
 390         }
 391
 392         // Logs NL validation.
 393         S::logger()->log('nl_mailing_valid', $nid);
 394
 395         $page->trigSuccessRedirect("L'envoi de la newsletter {$issue->title()} a été validé.", $nl->adminPrefix());
 396     }
 397
 398     /** This handler will remove the given issue.
 399      */
 400     function handler_admin_nl_delete($page, $nid, $force = null)
 401     {
 402         $nl = $this->getNl();
 403         if (!$nl) {
 404             return PL_NOT_FOUND;
 405         }
 406
 407         if (!$nl->mayEdit() || !S::has_xsrf_token()) {
 408             return PL_FORBIDDEN;
 409         }
 410
 411         if (!$nid) {
 412             $page->kill("La lettre n'a pas été spécifiée.");
 413         }
 414
 415         $issue = $nl->getIssue($nid);
 416         if (!$issue) {
 417             $page->kill("La lettre {$nid} n'existe pas");
 418         }
 419         if (!$issue->isEditable()) {
 420             $page->trigErrorRedirect("La lette a été envoyée ou est en cours d'envoi, elle ne peut être supprimée.", $nl->adminPrefix());
 421         }
 422         if (!$issue->delete()) {
 423             $page->trigErrorRedirect("Une erreur est survenue lors de la suppression de la lettre.", $nl->adminPrefix());
 424         }
 425
 426         // Logs NL deletion.
 427         S::logger()->log('nl_issue_delete', $nid);
 428
 429         $page->trigSuccessRedirect("La lettre a bien été supprimée.", $nl->adminPrefix());
 430     }
 431
 432     function handler_admin_nl_cat($page, $action = 'list', $id = null) {
 433         $page->setTitle('Administration - Newsletter : Catégories');
 434         $page->assign('title', 'Gestion des catégories de la newsletter');
 435         $table_editor = new PLTableEditor('admin/newsletter/categories','newsletter_cat','cid');
 436         $table_editor->describe('title','intitulé',true);
 437         $table_editor->describe('pos','position',true);
 438         $table_editor->apply($page, $action, $id);
 439     }
 440 }
 441
 442 // vim:set et sw=4 sts=4 sws=4 foldmethod=marker enc=utf-8:
 443 ?>