modules/newsletter.php

   1 <?php
   2 /***************************************************************************
   3  *  Copyright (C) 2003-2014 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, 'user'),
  28             'nl/show'                      => $this->make_hook('nl_show',         AUTH_COOKIE, 'user'),
  29             'nl/search'                    => $this->make_hook('nl_search',       AUTH_COOKIE, 'user'),
  30             'nl/submit'                    => $this->make_hook('nl_submit',       AUTH_PASSWD, 'user'),
  31             'nl/remaining'                 => $this->make_hook('nl_remaining',    AUTH_PASSWD, 'user'),
  32             'admin/nls'                    => $this->make_hook('admin_nl_groups', AUTH_PASSWD, 'admin'),
  33             'admin/newsletter'             => $this->make_hook('admin_nl',        AUTH_PASSWD, 'admin'),
  34             'admin/newsletter/categories'  => $this->make_hook('admin_nl_cat',    AUTH_PASSWD, 'admin'),
  35             'admin/newsletter/edit'        => $this->make_hook('admin_nl_edit',   AUTH_PASSWD, 'admin'),
  36             'admin/newsletter/edit/delete' => $this->make_hook('admin_nl_delete', AUTH_PASSWD, 'admin'),
  37             'stat/newsletter'              => $this->make_hook('stat_nl',         AUTH_PASSWD, 'admin')
  38             // Automatic mailing is disabled for X.org NL
  39 //            'admin/newsletter/edit/cancel' => $this->make_hook('cancel', AUTH_PASSWD, 'admin'),
  40 //            'admin/newsletter/edit/valid'  => $this->make_hook('valid',  AUTH_PASSWD, 'admin'),
  41         );
  42     }
  43
  44     /** This function should return the adequate NewsLetter object for the current module.
  45      */
  46     protected function getNl()
  47     {
  48         require_once 'newsletter.inc.php';
  49         return NewsLetter::forGroup(NewsLetter::GROUP_XORG);
  50     }
  51
  52     function handler_nl($page, $action = null, $hash = null, $issue_id = null)
  53     {
  54         $nl = $this->getNl();
  55         if (!$nl) {
  56             return PL_NOT_FOUND;
  57         }
  58
  59         $hash = ($hash == 'nohash') ? null : $hash;
  60         switch ($action) {
  61           case 'out':
  62             $success = $nl->unsubscribe($issue_id, $hash, $hash != null);
  63             if (!is_null($hash)) {
  64                 if ($success) {
  65                     $page->trigSuccess('La désinscription a été effectuée avec succès.');
  66                 } else {
  67                     $page->trigError("La désinscription n'a été pas pu être effectuée.");
  68                 }
  69                 return;
  70             }
  71             break;
  72           case 'in':  $nl->subscribe(); break;
  73           default: ;
  74         }
  75
  76         $page->changeTpl('newsletter/index.tpl');
  77         $page->setTitle('Lettres mensuelles');
  78
  79         $page->assign_by_ref('nl', $nl);
  80         $page->assign('nls', $nl->subscriptionState());
  81         $page->assign('nl_list', $nl->listSentIssues(true));
  82     }
  83
  84     function handler_nl_show($page, $nid = 'last')
  85     {
  86         $page->changeTpl('newsletter/show.tpl');
  87         $nl = $this->getNl();
  88         if (!$nl) {
  89             return PL_NOT_FOUND;
  90         }
  91
  92         try {
  93             $issue = $nl->getIssue($nid);
  94             $user =& S::user();
  95             if (Get::has('text')) {
  96                 $issue->toText($page, $user);
  97             } else {
  98                 $issue->toHtml($page, $user);
  99             }
 100             if (Post::has('send')) {
 101                 $issue->sendTo($user);
 102             }
 103         } catch (MailNotFound $e) {
 104             return PL_NOT_FOUND;
 105         }
 106     }
 107
 108     function handler_nl_search($page)
 109     {
 110         S::assert_xsrf_token();
 111         $nl = $this->getNl();
 112         if (!$nl) {
 113             return PL_NOT_FOUND;
 114         }
 115
 116         if (!Post::has('nl_search')) {
 117             pl_redirect($nl->prefix(true, false));
 118         }
 119
 120         $nl_search = Post::t('nl_search');
 121         $nl_search_type = Post::t('nl_search_type');
 122         if (!$nl_search || !($nl_search_type > 0 && $nl_search_type < 10)) {
 123             $page->trigErrorRedirect('La recherche est vide ou erronée.', $nl->prefix());
 124         }
 125
 126         $page->changeTpl('newsletter/search.tpl');
 127         $user = S::user();
 128         $fields = array(1 => 'all', 2 => 'all', 3 => 'title', 4 => 'body', 5 => 'append', 6 => 'all', 7 => 'title', 8 => 'head', 9 => 'signature');
 129         $res_articles = $res_issues = array();
 130         if ($nl_search_type < 6) {
 131             $res_articles = $nl->articleSearch($nl_search, $fields[$nl_search_type], $user);
 132         }
 133         if ($nl_search_type > 5 || $nl_search_type == 1) {
 134             $res_issues = $nl->issueSearch($nl_search, $fields[$nl_search_type], $user);
 135         }
 136
 137         $articles_count = count($res_articles);
 138         $issues_count = count($res_issues);
 139         $results_count = $articles_count + $issues_count;
 140         if ($results_count > 200) {
 141             $page->trigError('Recherche trop générale.');
 142         } elseif ($results_count == 0) {
 143             $page->trigWarning('Aucun résultat pour cette recherche.');
 144         } else {
 145             $page->assign('res_articles', $res_articles);
 146             $page->assign('res_issues', $res_issues);
 147             $page->assign('articles_count', $articles_count);
 148             $page->assign('issues_count', $issues_count);
 149         }
 150
 151         $page->assign_by_ref('nl', $nl);
 152         $page->assign('nl_search', $nl_search);
 153         $page->assign('nl_search_type', $nl_search_type);
 154         $page->assign('results_count', $results_count);
 155     }
 156
 157     function handler_nl_submit($page)
 158     {
 159         $page->changeTpl('newsletter/submit.tpl');
 160
 161         $nl = $this->getNl();
 162         if (!$nl) {
 163             return PL_NOT_FOUND;
 164         }
 165
 166         $wp = new PlWikiPage('Xorg.LettreMensuelle');
 167         $wp->buildCache();
 168
 169         if (Post::has('see') || (Post::has('valid') && (!trim(Post::v('title')) || !trim(Post::v('body'))))) {
 170             if (!Post::has('see')) {
 171                 $page->trigError("L'article doit avoir un titre et un contenu");
 172             }
 173             $art = new NLArticle(Post::v('title'), Post::v('body'), Post::v('append'));
 174             $page->assign('art', $art);
 175         } elseif (Post::has('valid')) {
 176             $art = new NLReq(S::user(), Post::v('title'),
 177                              Post::v('body'), Post::v('append'));
 178             $art->submit();
 179             $page->assign('submited', true);
 180         }
 181         $page->addCssLink($nl->cssFile());
 182     }
 183
 184     function handler_nl_remaining($page)
 185     {
 186         require_once 'newsletter.inc.php';
 187
 188         pl_content_headers('text/html');
 189         $page->changeTpl('newsletter/remaining.tpl', NO_SKIN);
 190
 191         $article = new NLArticle('', Post::t('body'), '');
 192         $rest = $article->remain();
 193
 194         $page->assign('too_long', $rest['remaining_lines'] < 0);
 195         $page->assign('last_line', ($rest['remaining_lines'] == 0));
 196         $page->assign('remaining', ($rest['remaining_lines'] == 0) ? $rest['remaining_characters_for_last_line'] : $rest['remaining_lines']);
 197     }
 198
 199     function handler_admin_nl($page, $new = false) {
 200         $page->changeTpl('newsletter/admin.tpl');
 201         $page->setTitle('Administration - Newsletter : liste');
 202
 203         $nl = $this->getNl();
 204         if (!$nl) {
 205             return PL_NOT_FOUND;
 206         }
 207
 208         if ($new == 'new') {
 209             // Logs NL creation.
 210             S::logger()->log('nl_issue_create', $nid);
 211
 212             $id = $nl->createPending();
 213             pl_redirect($nl->adminPrefix(true, false) . '/edit/' . $id);
 214         }
 215
 216         $page->assign_by_ref('nl', $nl);
 217         $page->assign('nl_list', $nl->listAllIssues());
 218     }
 219
 220     function handler_admin_nl_groups($page, $sort = 'id', $order = 'ASC')
 221     {
 222         require_once 'newsletter.inc.php';
 223
 224         static $titles = array(
 225             'id'         => 'Id',
 226             'group_name' => 'Groupe',
 227             'name'       => 'Titre',
 228             'custom_css' => 'CSS spécifique',
 229             'criteria'   => 'Critères actifs'
 230         );
 231         static $next_orders = array(
 232             'ASC'  => 'DESC',
 233             'DESC' => 'ASC'
 234         );
 235
 236         if (!array_key_exists($sort, $titles)) {
 237             $sort = 'id';
 238         }
 239         if (!in_array($order, array('ASC', 'DESC'))) {
 240             $order = 'ASC';
 241         }
 242
 243         $page->changeTpl('newsletter/admin_all.tpl');
 244         $page->setTitle('Administration - Newsletters : Liste des Newsletters');
 245         $page->assign('nls', Newsletter::getAll($sort, $order));
 246         $page->assign('sort', $sort);
 247         $page->assign('order', $order);
 248         $page->assign('next_order', $next_orders[$order]);
 249         $page->assign('titles', $titles);
 250     }
 251
 252     function handler_admin_nl_edit($page, $nid = 'last', $aid = null, $action = 'edit') {
 253         $page->changeTpl('newsletter/edit.tpl');
 254         $page->addCssLink('nl.Polytechnique.org.css');
 255         $page->setTitle('Administration - Newsletter : Édition');
 256
 257         $nl = $this->getNl();
 258         if (!$nl) {
 259             return PL_NOT_FOUND;
 260         }
 261
 262         try {
 263             $issue = $nl->getIssue($nid, false);
 264         } catch (MailNotFound $e) {
 265             return PL_NOT_FOUND;
 266         }
 267
 268         $ufb = $nl->getSubscribersUFB();
 269         $ufb_keepenv = false;  // Will be set to True if there were invalid modification to the UFB.
 270
 271         // Convert NLIssue error messages to human-readable errors
 272         $error_msgs = array(
 273             NLIssue::ERROR_INVALID_REPLY_TO => "L'adresse de réponse est invalide.",
 274             NLIssue::ERROR_INVALID_SHORTNAME => "Le nom court est invalide ou vide.",
 275             NLIssue::ERROR_INVALID_UFC => "Le filtre des destinataires est invalide.",
 276             NLIssue::ERROR_TOO_LONG_UFC => "Le nombre de matricules AX renseigné est trop élevé.",
 277             NLIssue::ERROR_SQL_SAVE => "Une erreur est survenue en tentant de sauvegarder la lettre, merci de réessayer.",
 278         );
 279
 280         // Update the current issue
 281         if($aid == 'update' && Post::has('submit')) {
 282
 283             // Save common fields
 284             $issue->title      = Post::s('title');
 285             $issue->title_mail = Post::s('title_mail');
 286             $issue->head       = Post::s('head');
 287             $issue->signature  = Post::s('signature');
 288             $issue->reply_to   = Post::s('reply_to');
 289
 290             if ($issue->isEditable()) {
 291                 // Date and shortname may only be modified for pending NLs, otherwise all links get broken.
 292                 $issue->date = Post::s('date');
 293                 $issue->shortname = strlen(Post::blank('shortname')) ? null : Post::s('shortname');
 294                 $issue->sufb->updateFromEnv($ufb->getEnv());
 295
 296                 if ($nl->automaticMailingEnabled()) {
 297                     $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';
 298                 }
 299             }
 300             $errors = $issue->save();
 301             if (count($errors)) {
 302                 foreach ($errors as $error_code) {
 303                     $page->trigError($error_msgs[$error_code]);
 304                 }
 305             }
 306         }
 307
 308         // Delete an article
 309         if($action == 'delete') {
 310             $issue->delArticle($aid);
 311             pl_redirect($nl->adminPrefix(true, false) . "/edit/$nid");
 312         }
 313
 314         // Save an article
 315         if(Post::v('save')) {
 316             $art  = new NLArticle(Post::v('title'), Post::v('body'), Post::v('append'),
 317                                   $aid, Post::v('cid'), Post::v('pos'));
 318             $issue->saveArticle($art);
 319             pl_redirect($nl->adminPrefix(true, false) . "/edit/$nid");
 320         }
 321
 322         // Edit an article
 323         if ($action == 'edit' && $aid != 'update') {
 324             $eaid = $aid;
 325             if (Post::has('title')) {
 326                 $art  = new NLArticle(Post::v('title'), Post::v('body'), Post::v('append'),
 327                                       $eaid, Post::v('cid'), Post::v('pos'));
 328             } else {
 329                 $art = ($eaid == 'new') ? new NLArticle() : $issue->getArt($eaid);
 330             }
 331             if ($art && !$art->check()) {
 332                 $page->trigError("Cet article est trop long.");
 333             }
 334             $page->assign('art', $art);
 335         }
 336
 337         // Check blacklisted IPs
 338         if ($aid == 'blacklist_check') {
 339             global $globals;
 340             $ips_to_check = array();
 341             $blacklist_host_resolution_count = 0;
 342
 343             foreach ($issue->arts as $key => $articles) {
 344                 foreach ($articles as $article) {
 345                     $article_ips = $article->getLinkIps($blacklist_host_resolution_count);
 346                     if (!empty($article_ips)) {
 347                         $ips_to_check[$article->title()] = $article_ips;
 348                     }
 349                 }
 350             }
 351
 352             $page->assign('ips_to_check', $ips_to_check);
 353             if ($blacklist_host_resolution_count >= $globals->mail->blacklist_host_resolution_limit) {
 354                 $page->trigError("Toutes les url et adresses emails de la lettre"
 355                                 . " n'ont pas été prises en compte car la"
 356                                 . " limite du nombre de résolutions DNS"
 357                                 . " autorisée a été atteinte.");
 358             }
 359         }
 360
 361         if ($issue->state == NLIssue::STATE_SENT) {
 362             $page->trigWarning("Cette lettre a déjà été envoyée ; il est recommandé de limiter les modifications au maximum (orthographe, adresses web et mail).");
 363         }
 364
 365         $ufb->setEnv($issue->sufb->getEnv());
 366         $page->assign_by_ref('nl', $nl);
 367         $page->assign_by_ref('issue', $issue);
 368     }
 369
 370     /** This handler will cancel the sending of the currently pending issue
 371      * It is disabled for X.org mailings.
 372      */
 373     function handler_admin_nl_cancel($page, $nid, $force = null)
 374     {
 375         $nl = $this->getNl();
 376         if (!$nl) {
 377             return PL_NOT_FOUND;
 378         }
 379
 380         if (!$nl->mayEdit() || !S::has_xsrf_token()) {
 381             return PL_FORBIDDEN;
 382         }
 383
 384         if (!$nid) {
 385             $page->kill("La lettre n'a pas été spécifiée");
 386         }
 387
 388         $issue = $nl->getIssue($nid);
 389         if (!$issue) {
 390             $page->kill("La lettre {$nid} n'existe pas.");
 391         }
 392         if (!$issue->cancelMailing()) {
 393             $page->trigErrorRedirect("Une erreur est survenue lors de l'annulation de l'envoi.", $nl->adminPrefix());
 394         }
 395
 396         // Logs NL cancelling.
 397         S::logger()->log('nl_mailing_cancel', $nid);
 398
 399         $page->trigSuccessRedirect("L'envoi de l'annonce {$issue->title()} est annulé.", $nl->adminPrefix());
 400     }
 401
 402     /** This handler will enable the sending of the currently pending issue
 403      * It is disabled for X.org mailings.
 404      */
 405     function handler_admin_nl_valid($page, $nid, $force = null)
 406     {
 407         $nl = $this->getNl();
 408         if (!$nl) {
 409             return PL_NOT_FOUND;
 410         }
 411
 412         if (!$nl->mayEdit() || !S::has_xsrf_token()) {
 413             return PL_FORBIDDEN;
 414         }
 415
 416         if (!$nid) {
 417             $page->kill("La lettre n'a pas été spécifiée.");
 418         }
 419
 420         $issue = $nl->getIssue($nid);
 421         if (!$issue) {
 422             $page->kill("La lettre {$nid} n'existe pas.");
 423         }
 424
 425         if ($issue->isEmpty()) {
 426             $page->trigErrorRedirect("La lettre étant vide, il n'est pas possible de l'envoyer.", $nl->adminPrefix());
 427         }
 428
 429         if (!$issue->scheduleMailing()) {
 430             $page->trigErrorRedirect("Une erreur est survenue lors de la validation de l'envoi.", $nl->adminPrefix());
 431         }
 432
 433         // Logs NL validation.
 434         S::logger()->log('nl_mailing_valid', $nid);
 435
 436         $page->trigSuccessRedirect("L'envoi de la newsletter {$issue->title()} a été validé.", $nl->adminPrefix());
 437     }
 438
 439     /** This handler will remove the given issue.
 440      */
 441     function handler_admin_nl_delete($page, $nid, $force = null)
 442     {
 443         $nl = $this->getNl();
 444         if (!$nl) {
 445             return PL_NOT_FOUND;
 446         }
 447
 448         if (!$nl->mayEdit() || !S::has_xsrf_token()) {
 449             return PL_FORBIDDEN;
 450         }
 451
 452         if (!$nid) {
 453             $page->kill("La lettre n'a pas été spécifiée.");
 454         }
 455
 456         $issue = $nl->getIssue($nid);
 457         if (!$issue) {
 458             $page->kill("La lettre {$nid} n'existe pas");
 459         }
 460         if (!$issue->isEditable()) {
 461             $page->trigErrorRedirect("La lette a été envoyée ou est en cours d'envoi, elle ne peut être supprimée.", $nl->adminPrefix());
 462         }
 463         if (!$issue->delete()) {
 464             $page->trigErrorRedirect("Une erreur est survenue lors de la suppression de la lettre.", $nl->adminPrefix());
 465         }
 466
 467         // Logs NL deletion.
 468         S::logger()->log('nl_issue_delete', $nid);
 469
 470         $page->trigSuccessRedirect("La lettre a bien été supprimée.", $nl->adminPrefix());
 471     }
 472
 473     function handler_admin_nl_cat($page, $action = 'list', $id = null) {
 474         $nl = $this->getNl();
 475         if (!$nl) {
 476             return PL_NOT_FOUND;
 477         }
 478
 479         if (!$nl->mayEdit()) {
 480             return PL_FORBIDDEN;
 481         }
 482
 483         $page->setTitle('Administration - Newsletter : Catégories');
 484         $page->assign('title', 'Gestion des catégories de la newsletter');
 485         $table_editor = new PLTableEditor($nl->adminPrefix() . '/categories', 'newsletter_cat','cid');
 486         $table_editor->describe('title','intitulé',true);
 487         $table_editor->describe('pos','position',true);
 488         if ($nl->group == Newsletter::GROUP_XORG) {
 489             $table_editor->add_option_table('newsletters', 'newsletters.id = t.nlid');
 490             $table_editor->add_option_field('newsletters.name', 'newsletter_name', 'Newsletter', null, 'nlid');
 491             $table_editor->describe('nlid', 'ID NL', true);
 492         } else {
 493             $table_editor->force_field_value('nlid', $nl->id);
 494             $table_editor->describe('nlid', 'nlid', false, false);
 495         }
 496         // Prevent deletion.
 497         $table_editor->on_delete(null, null);
 498         $table_editor->apply($page, $action, $id);
 499     }
 500
 501     function handler_stat_nl($page)
 502     {
 503         $nl = $this->getNl();
 504         if (!$nl) {
 505             return PL_NOT_FOUND;
 506         }
 507         if (!$nl->mayEdit()) {
 508             return PL_FORBIDDEN;
 509         }
 510
 511         $page->setTitle('Statistiques - Newsletter');
 512         $page->changeTpl('newsletter/statistics.tpl');
 513
 514         $data = array();
 515         foreach (Profile::$cycles as $grade => $name) {
 516             $data[$name] = array();
 517             list($min, $max) = Profile::extremePromotions($grade);
 518             $bound = (((int)($min / 10)) + 1) * 10;
 519             while ($bound <= $max) {
 520                 $data[$name][$min . ' - ' . $bound] = array(
 521                     'count'        => $nl->subscriberCount(null, null, $grade, $min, $bound),
 522                     'lost'         => $nl->subscriberCount(true, null, $grade, $min, $bound),
 523                     'count_female' => $nl->subscriberCount(null, User::GENDER_FEMALE, $grade, $min, $bound),
 524                     'lost_female'  => $nl->subscriberCount(true, User::GENDER_FEMALE, $grade, $min, $bound)
 525                 );
 526                 $min = $bound + 1;
 527                 $bound += 10;
 528             }
 529             $bound -= 9;
 530             if ($bound <= $max) {
 531                 $data[$name][$bound . ' - ' . $max] = array(
 532                     'count'        => $nl->subscriberCount(null, null, $grade, $bound, $max),
 533                     'lost'         => $nl->subscriberCount(true, null, $grade, $bound, $max),
 534                     'count_female' => $nl->subscriberCount(null, User::GENDER_FEMALE, $grade, $bound, $max),
 535                     'lost_female'  => $nl->subscriberCount(true, User::GENDER_FEMALE, $grade, $bound, $max)
 536                 );
 537             }
 538         }
 539         $page->assign_by_ref('nl', $nl);
 540         $page->assign('count', $nl->subscriberCount());
 541         $page->assign('lost', $nl->lostSubscriberCount());
 542         $page->assign('count_female', $nl->subscriberCount(null, User::GENDER_FEMALE));
 543         $page->assign('lost_female', $nl->lostSubscriberCount(User::GENDER_FEMALE));
 544         $page->assign('data', $data);
 545     }
 546 }
 547
 548 // vim:set et sw=4 sts=4 sws=4 foldmethod=marker fenc=utf-8:
 549 ?>