include/newsletter.inc.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 MailNotFound
  23
  24 class MailNotFound extends Exception {
  25 }
  26
  27 // }}}
  28
  29 // {{{ class NewsLetter
  30
  31 class NewsLetter
  32 {
  33     public $id;  // ID of the NL (in table newsletters)
  34     public $group;  // Short name of the group corresponding to the NL
  35     public $group_id;  // ID of that group
  36     public $name;  // Name of the NL (e.g "Lettre de Polytechnique.org", ...)
  37     public $cats;  // List of all categories for this NL
  38     public $criteria;  // PlFlagSet of allowed filters for recipient selection
  39
  40     protected $custom_css = false;
  41
  42     // Base name to use instead of the group short name for NLs without a custom CSS
  43     const FORMAT_DEFAULT_GROUP = 'default';
  44
  45     // Diminutif of X.net groups with a specific NL view
  46     const GROUP_XORG = 'Polytechnique.org';
  47     const GROUP_AX = 'AX';
  48     const GROUP_EP = 'Ecole';
  49
  50     // Searches on mutiple fields
  51     const SEARCH_ALL = 'all';
  52     const SEARCH_TITLE = 'title';
  53
  54
  55     // {{{ Constructor, NewsLetter retrieval (forGroup, getAll)
  56
  57     public function __construct($id)
  58     {
  59         // Load NL data
  60         $res = XDB::query('SELECT  nls.group_id, g.diminutif AS group_name,
  61                                    nls.name AS nl_name, nls.custom_css, nls.criteria
  62                              FROM  newsletters AS nls
  63                         LEFT JOIN  groups AS g ON (nls.group_id = g.id)
  64                             WHERE  nls.id = {?}',
  65                             $id);
  66         if (!$res->numRows()) {
  67             throw new MailNotFound();
  68         }
  69
  70         $data = $res->fetchOneAssoc();
  71         $this->id = $id;
  72         $this->group_id = $data['group_id'];
  73         $this->group = $data['group_name'];
  74         $this->name = $data['nl_name'];
  75         $this->custom_css = $data['custom_css'];
  76         $this->criteria = new PlFlagSet($data['criteria']);
  77
  78         // Load the categories
  79         $res = XDB::iterRow(
  80             'SELECT  cid, title
  81                FROM  newsletter_cat
  82               WHERE  nlid = {?}
  83            ORDER BY  pos', $id);
  84         while (list($cid, $title) = $res->next()) {
  85             $this->cats[$cid] = $title;
  86         }
  87     }
  88
  89     /** Retrieve the NL associated with a given group.
  90      * @p $group Short name of the group
  91      * @return A NewsLetter object, or null if the group doesn't have a NL.
  92      */
  93     public static function forGroup($group)
  94     {
  95         $res = XDB::query('SELECT  nls.id
  96                              FROM  newsletters AS nls
  97                         LEFT JOIN  groups AS g ON (nls.group_id = g.id)
  98                             WHERE  g.diminutif = {?}', $group);
  99         if (!$res->numRows()) {
 100             return null;
 101         }
 102         return new NewsLetter($res->fetchOneCell());
 103     }
 104
 105     /** Retrieve all newsletters
 106      * @return An array of $id => NewsLetter objects
 107      */
 108     public static function getAll()
 109     {
 110         $res = XDB::query('SELECT  id
 111                              FROM  newsletters');
 112         $nls = array();
 113         foreach ($res->fetchColumn() as $id) {
 114             $nls[$id] = new NewsLetter($id);
 115         }
 116         return $nls;
 117     }
 118
 119     // }}}
 120     // {{{ Issue retrieval
 121
 122     /** Retrieve all issues which should be sent
 123      * @return An array of NLIssue objects to send (i.e state = 'new' and send_before <= today)
 124      */
 125     public static function getIssuesToSend()
 126     {
 127         $res = XDB::query('SELECT  id
 128                              FROM  newsletter_issues
 129                             WHERE  state = \'pending\' AND send_before <= NOW()');
 130         $issues = array();
 131         foreach ($res->fetchColumn() as $id) {
 132             $issues[$id] = new NLIssue($id);
 133         }
 134         return $issues;
 135     }
 136
 137     /** Retrieve a given issue of this NewsLetter
 138      * @p $name Name or ID of the issue to retrieve.
 139      * @return A NLIssue object.
 140      *
 141      * $name may be either a short_name, an ID or the special value 'last' which
 142      * selects the latest sent NL.
 143      * If $name is null, this will retrieve the current pending NL.
 144      */
 145     public function getIssue($name = null, $only_sent = true)
 146     {
 147         if ($name) {
 148             if ($name == 'last') {
 149                 if ($only_sent) {
 150                     $where = 'state = \'sent\' AND ';
 151                 } else {
 152                     $where = '';
 153                 }
 154                 $res = XDB::query('SELECT  MAX(id)
 155                                      FROM  newsletter_issues
 156                                     WHERE  ' . $where . ' nlid = {?}',
 157                                    $this->id);
 158             } else {
 159                 $res = XDB::query('SELECT  id
 160                                      FROM  newsletter_issues
 161                                     WHERE  nlid = {?} AND (id = {?} OR short_name = {?})',
 162                                   $this->id, $name, $name);
 163             }
 164             if (!$res->numRows()) {
 165                 throw new MailNotFound();
 166             }
 167             $id = $res->fetchOneCell();
 168         } else {
 169             $query = XDB::format('SELECT  id
 170                                     FROM  newsletter_issues
 171                                    WHERE  nlid = {?} AND state = \'new\'
 172                                 ORDER BY  id DESC', $this->id);
 173             $res = XDB::query($query);
 174             if ($res->numRows()) {
 175                 $id = $res->fetchOneCell();
 176             } else {
 177                 // Create a new, empty issue, and return it
 178                 $id = $this->createPending();
 179             }
 180         }
 181
 182         return new NLIssue($id, $this);
 183     }
 184
 185     /** Create a new, empty, pending newsletter issue
 186      * @p $nlid The id of the NL for which a new pending issue should be created.
 187      * @return Id of the newly created issue.
 188      */
 189     public function createPending()
 190     {
 191         XDB::execute('INSERT INTO  newsletter_issues
 192                               SET  nlid = {?}, state=\'new\', date=NOW(),
 193                                    title=\'to be continued\',
 194                                    mail_title=\'to be continued\'',
 195                                    $this->id);
 196         return XDB::insertId();
 197     }
 198
 199     /** Return all sent issues of this newsletter.
 200      * @return An array of (id => NLIssue)
 201      */
 202     public function listSentIssues($check_user = false, $user = null)
 203     {
 204         if ($check_user && $user == null) {
 205             $user = S::user();
 206         }
 207
 208         $res = XDB::query('SELECT  id
 209                              FROM  newsletter_issues
 210                             WHERE  nlid = {?} AND state = \'sent\'
 211                          ORDER BY  date DESC', $this->id);
 212         $issues = array();
 213         foreach ($res->fetchColumn() as $id) {
 214             $issue = new NLIssue($id, $this, false);
 215             if (!$check_user || $issue->checkUser($user)) {
 216                 $issues[$id] = $issue;
 217             }
 218         }
 219         return $issues;
 220     }
 221
 222     /** Return all issues of this newsletter, including invalid and sent.
 223      * @return An array of (id => NLIssue)
 224      */
 225     public function listAllIssues()
 226     {
 227         $res = XDB::query('SELECT  id
 228                              FROM  newsletter_issues
 229                             WHERE  nlid = {?}
 230                          ORDER BY  FIELD(state, \'pending\', \'new\') DESC, date DESC', $this->id);
 231         $issues = array();
 232         foreach ($res->fetchColumn() as $id) {
 233             $issues[$id] = new NLIssue($id, $this, false);
 234         }
 235         return $issues;
 236     }
 237
 238     /** Return the latest pending issue of the newsletter.
 239      * @p $create Whether to create an empty issue if no pending issue exist.
 240      * @return Either null, or a NL object.
 241      */
 242     public function getPendingIssue($create = false)
 243     {
 244         $res = XDB::query('SELECT  MAX(id)
 245                              FROM  newsletter_issues
 246                             WHERE  nlid = {?} AND state = \'new\'',
 247                             $this->id);
 248         $id = $res->fetchOneCell();
 249         if ($id != null) {
 250             return new NLIssue($id, $this);
 251         } else if ($create) {
 252             $id = $this->createPending();
 253             return new NLIssue($id, $this);
 254         } else {
 255             return null;
 256         }
 257     }
 258
 259     /** Returns a list of either issues or articles corresponding to the search.
 260      * @p $search The searched pattern.
 261      * @p $field The fields where to search, if none given, search in all possible fields.
 262      * @return The list of object found.
 263      */
 264     public function issueSearch($search, $field, $user)
 265     {
 266         $search = XDB::formatWildcards(XDB::WILDCARD_CONTAINS, $search);
 267         if ($field == self::SEARCH_ALL) {
 268             $where = '(title ' . $search . ' OR mail_title ' . $search . ' OR head ' . $search . ' OR signature ' . $search . ')';
 269         } elseif ($field == self::SEARCH_TITLE) {
 270             $where = '(title ' . $search . ' OR mail_title ' . $search . ')';
 271         } else {
 272             $where = $field . $search;
 273         }
 274         $list = XDB::fetchColumn('SELECT  DISTINCT(id)
 275                                     FROM  newsletter_issues
 276                                    WHERE  nlid = {?} AND state = \'sent\' AND ' . $where . '
 277                                 ORDER BY  date DESC',
 278                                  $this->id);
 279
 280         $issues = array();
 281         foreach ($list as $id) {
 282             $issue = new NLIssue($id, $this, false);
 283             if ($issue->checkUser($user)) {
 284                 $issues[] = $issue;
 285             }
 286         }
 287         return $issues;
 288     }
 289
 290     public function articleSearch($search, $field, $user)
 291     {
 292         $search = XDB::formatWildcards(XDB::WILDCARD_CONTAINS, $search);
 293         if ($field == self::SEARCH_ALL) {
 294             $where = '(a.title ' . $search . ' OR a.body ' . $search . ' OR a.append ' . $search . ')';
 295         } else {
 296             $where = 'a.' . $field . $search;
 297         }
 298         $list = XDB::fetchAllAssoc('SELECT  i.short_name, a.aid, i.id, a.title
 299                                       FROM  newsletter_art    AS a
 300                                 INNER JOIN  newsletter_issues AS i ON (a.id = i.id)
 301                                      WHERE  i.nlid = {?} AND i.state = \'sent\' AND ' . $where . '
 302                                   GROUP BY  a.id, a.aid
 303                                   ORDER BY  i.date DESC, a.aid',
 304                                    $this->id);
 305
 306         $articles = array();
 307         foreach ($list as $item) {
 308             $issue = new NLIssue($item['id'], $this, false);
 309             if ($issue->checkUser($user)) {
 310                 $articles[] = $item;
 311             }
 312         }
 313         return $articles;
 314     }
 315
 316     // }}}
 317     // {{{ Subscription related function
 318
 319     /** Unsubscribe a user from this newsletter
 320      * @p $uid UID to unsubscribe from the newsletter; if null, use current user.
 321      * @p $hash True if the uid is actually a hash.
 322      * @return True if the user was successfully unsubscribed.
 323      */
 324     public function unsubscribe($issue_id = null, $uid = null, $hash = false)
 325     {
 326         if (is_null($uid) && $hash) {
 327             // Unable to unsubscribe from an empty hash
 328             return false;
 329         }
 330         $user = is_null($uid) ? S::user()->id() : $uid;
 331         $field = $hash ? 'hash' : 'uid';
 332         $res = XDB::query('SELECT  uid
 333                              FROM  newsletter_ins
 334                             WHERE  nlid = {?} AND ' . $field . ' = {?}',
 335                             $this->id, $user);
 336         if (!$res->numRows()) {
 337             // No subscribed user with that UID/hash
 338             return false;
 339         }
 340         $user = $res->fetchOneCell();
 341
 342         XDB::execute('DELETE FROM  newsletter_ins
 343                             WHERE  nlid = {?} AND uid = {?}',
 344                             $this->id, $user);
 345         if (!is_null($issue_id)) {
 346             XDB::execute('UPDATE  newsletter_issues
 347                              SET  unsubscribe = unsubscribe + 1
 348                            WHERE  id = {?}',
 349                          $id);
 350         }
 351         return true;
 352     }
 353
 354     /** Subscribe a user to a newsletter
 355      * @p $user User to subscribe to the newsletter; if null, use current user.
 356      */
 357     public function subscribe($user = null)
 358     {
 359         if (is_null($user)) {
 360             $user = S::user();
 361         }
 362         if (self::maySubscribe($user)) {
 363             XDB::execute('INSERT IGNORE INTO  newsletter_ins (nlid, uid, last, hash)
 364                                       VALUES  ({?}, {?}, NULL, hash)',
 365                          $this->id, $user->id());
 366         }
 367     }
 368
 369     /** Subscribe a batch of users to a newsletter.
 370      * This skips 'maySubscribe' test.
 371      *
 372      * @p $user_ids Array of user IDs to subscribe to the newsletter.
 373      */
 374     public function bulkSubscribe($user_ids)
 375     {
 376         // TODO: use a 'bulkMaySubscribe'.
 377         XDB::execute('INSERT IGNORE INTO  newsletter_ins (nlid, uid, last, hash)
 378                                   SELECT  {?}, a.uid, NULL, NULL
 379                                     FROM  accounts AS a
 380                                    WHERE  a.uid IN {?}',
 381                      $this->id, $user_ids);
 382     }
 383
 384     /** Retrieve subscription state of a user
 385      * @p $user Target user; if null, use current user.
 386      * @return Boolean: true if the user has subscribed to the NL.
 387      */
 388     public function subscriptionState($user = null)
 389     {
 390         if (is_null($user)) {
 391             $user = S::user();
 392         }
 393         $res = XDB::query('SELECT  1
 394                              FROM  newsletter_ins
 395                             WHERE  nlid = {?} AND uid = {?}',
 396                           $this->id, $user->id());
 397         return ($res->numRows() == 1);
 398     }
 399
 400     /** Get the count of subscribers to the NL.
 401      * @return Number of subscribers.
 402      */
 403     public function subscriberCount()
 404     {
 405         return XDB::fetchOneCell('SELECT  COUNT(uid)
 406                                     FROM  newsletter_ins
 407                                    WHERE  nlid = {?}', $this->id);
 408     }
 409
 410     /** Get the count of subscribers with non valid redirection.
 411      */
 412     public function lostSubscriberCount()
 413     {
 414         return XDB::fetchOneCell('SELECT  COUNT(DISTINCT(n.uid))
 415                                     FROM  newsletter_ins         AS n
 416                               INNER JOIN  accounts               AS a ON (n.uid = a.uid)
 417                               INNER JOIN  account_types          AS t ON (t.type = a.type)
 418                                LEFT JOIN  email_redirect_account AS r ON (r.uid = a.uid AND r.flags = \'active\' AND r.broken_level < 3
 419                                                                           AND r.type != \'imap\' AND r.type != \'homonym\')
 420                                    WHERE  n.nlid = {?} AND r.redirect IS NULL AND a.state = \'active\' AND FIND_IN_SET(\'mail\', t.perms)',
 421                                  $this->id);
 422     }
 423
 424     /** Get the number of subscribers to the NL whose last received mailing was $last.
 425      * @p $last ID of the issue for which subscribers should be counted.
 426      * @return Number of subscribers
 427      */
 428     public function subscriberCountForLast($last)
 429     {
 430         return XDB::fetchOneCell('SELECT  COUNT(uid)
 431                                     FROM  newsletter_ins
 432                                    WHERE  nlid = {?} AND last = {?}', $this->id, $last);
 433     }
 434
 435     /** Retrieve the list of newsletters a user has subscribed to
 436      * @p $user User whose subscriptions should be retrieved (if null, use session user).
 437      * @return Array of newsletter IDs
 438      */
 439     public static function getUserSubscriptions($user = null)
 440     {
 441         if (is_null($user)) {
 442             $user = S::user();
 443         }
 444         $res = XDB::query('SELECT  nlid
 445                              FROM  newsletter_ins
 446                             WHERE  uid = {?}',
 447                           $user->id());
 448         return $res->fetchColumn();
 449     }
 450
 451     /** Retrieve the UserFilterBuilder for subscribers to this NL.
 452      * This is the place where NL-specific filters may be allowed or prevented.
 453      * @p $envprefix Prefix to use for env fields (cf. UserFilterBuilder)
 454      * @return A UserFilterBuilder object using the given env prefix
 455      */
 456     public function getSubscribersUFB($envprefix = '')
 457     {
 458         require_once 'ufbuilder.inc.php';
 459         return new UFB_NewsLetter($this->criteria, $envprefix);
 460     }
 461
 462     // }}}
 463     // {{{ Permissions related functions
 464
 465     /** For later use: check whether a given user may subscribe to this newsletter.
 466      * @p $user User whose access should be checked
 467      * @return Boolean: whether the user may subscribe to the NL.
 468      */
 469     public function maySubscribe($user = null)
 470     {
 471         return true;
 472     }
 473
 474     /** Whether a given user may edit this newsletter
 475      * @p $uid UID of the user whose perms should be checked (if null, use current user)
 476      * @return Boolean: whether the user may edit the NL
 477      */
 478     public function mayEdit($user = null)
 479     {
 480         if (is_null($user)) {
 481             $user = S::user();
 482         }
 483         if ($user->checkPerms('admin')) {
 484             return true;
 485         }
 486         $res = XDB::query('SELECT  perms
 487                              FROM  group_members
 488                             WHERE  asso_id = {?} AND uid = {?}',
 489                             $this->group_id, $user->id());
 490         return ($res->numRows() && $res->fetchOneCell() == 'admin');
 491     }
 492
 493     /** Whether a given user may submit articles to this newsletter using X.org validation system
 494      * @p $user User whose access should be checked (if null, use current user)
 495      * @return Boolean: whether the user may submit articles
 496      */
 497     public function maySubmit($user = null)
 498     {
 499         // Submission of new articles is only enabled for the X.org NL (and forbidden when viewing issues on X.net)
 500         return ($this->group == self::GROUP_XORG && !isset($GLOBALS['IS_XNET_SITE']));
 501     }
 502
 503     // }}}
 504     // {{{ Display-related functions: cssFile, tplFile, prefix, admin_prefix, admin_links_enabled, automatic_mailings_enabled
 505
 506     /** Get the name of the css file used to display this newsletter.
 507      */
 508     public function cssFile()
 509     {
 510         if ($this->custom_css) {
 511             $base = $this->group;
 512         } else {
 513             $base = self::FORMAT_DEFAULT_GROUP;
 514         }
 515         return 'nl.' . $base . '.css';
 516     }
 517
 518     /** Get the name of the template file used to display this newsletter.
 519      */
 520     public function tplFile()
 521     {
 522         if ($this->custom_css) {
 523             $base = $this->group;
 524         } else {
 525             $base = self::FORMAT_DEFAULT_GROUP;
 526         }
 527         return 'newsletter/nl.' . $base . '.mail.tpl';
 528     }
 529
 530     /** Get the prefix leading to the page for this NL
 531      * Only X.org / AX / X groups may be seen on X.org.
 532      */
 533     public function prefix($enforce_xnet=true, $with_group=true)
 534     {
 535         if (!empty($GLOBALS['IS_XNET_SITE'])) {
 536             if ($with_group) {
 537                 return $this->group . '/nl';
 538             } else {
 539                 return 'nl';
 540             }
 541         }
 542         switch ($this->group) {
 543         case self::GROUP_XORG:
 544             return 'nl';
 545         case self::GROUP_AX:
 546             return 'ax';
 547         case self::GROUP_EP:
 548             return 'epletter';
 549         default:
 550             // Don't display groups NLs on X.org
 551             assert(!$enforce_xnet);
 552         }
 553     }
 554
 555     /** Get the prefix to use for all 'admin' pages of this NL.
 556      */
 557     public function adminPrefix($enforce_xnet=true, $with_group=true)
 558     {
 559         if (!empty($GLOBALS['IS_XNET_SITE'])) {
 560             if ($with_group) {
 561                 return $this->group . '/admin/nl';
 562             } else {
 563                 return 'admin/nl';
 564             }
 565         }
 566         switch ($this->group) {
 567         case self::GROUP_XORG:
 568             return 'admin/newsletter';
 569         case self::GROUP_AX:
 570             return 'ax/admin';
 571         case self::GROUP_EP:
 572             return 'epletter/admin';
 573         default:
 574             // Don't display groups NLs on X.org
 575             assert(!$enforce_xnet);
 576         }
 577     }
 578
 579     /** Hack used to remove "admin" links on X.org page on X.net
 580      * The 'admin' links are enabled for all pages, except for X.org when accessing NL through X.net
 581      */
 582     public function adminLinksEnabled()
 583     {
 584         return ($this->group != self::GROUP_XORG || !isset($GLOBALS['IS_XNET_SITE']));
 585     }
 586
 587     /** Automatic mailings are disabled for X.org NL.
 588      */
 589     public function automaticMailingEnabled()
 590     {
 591         return $this->group != self::GROUP_XORG;
 592     }
 593
 594     public function hasCustomCss()
 595     {
 596         return $this->custom_css;
 597     }
 598
 599     public function canSyncWithGroup()
 600     {
 601         switch ($this->group) {
 602           case self::GROUP_XORG:
 603           case self::GROUP_AX:
 604           case self::GROUP_EP:
 605             return false;
 606           default:
 607             return true;
 608         }
 609     }
 610
 611     // }}}
 612 }
 613
 614 // }}}
 615
 616 // {{{ class NLIssue
 617
 618 // A NLIssue is an issue of a given NewsLetter
 619 class NLIssue
 620 {
 621     protected $nlid;  // Id of the newsletter
 622
 623     const STATE_NEW = 'new';  // New, currently being edited
 624     const STATE_PENDING = 'pending';  // Ready for mailing
 625     const STATE_SENT = 'sent';  // Sent
 626
 627     public $nl;  // Related NL
 628
 629     public $id;  // Id of this issue of the newsletter
 630     public $shortname;  // Shortname for this issue
 631     public $title;  // Title of this issue
 632     public $title_mail;  // Title of the email
 633     public $state;  // State of the issue (one of the STATE_ values)
 634     public $sufb;  // Environment to use to generate the UFC through an UserFilterBuilder
 635
 636     public $date;  // Date at which this issue was sent
 637     public $send_before;  // Date at which issue should be sent
 638     public $head;  // Foreword of the issue (or body for letters with no articles)
 639     public $signature;  // Signature of the letter
 640     public $arts = array();  // Articles of the issue
 641
 642     const BATCH_SIZE = 60;  // Number of emails to send every minute.
 643
 644     // {{{ Constructor, id-related functions
 645
 646     /** Build a NewsLetter.
 647      * @p $id: ID of the issue (unique among all newsletters)
 648      * @p $nl: Optional argument containing an already built NewsLetter object.
 649      */
 650     function __construct($id, $nl = null, $fetch_articles = true)
 651     {
 652         return $this->fetch($id, $nl, $fetch_articles);
 653     }
 654
 655     protected function refresh()
 656     {
 657         return $this->fetch($this->id, $this->nl, false);
 658     }
 659
 660     protected function fetch($id, $nl = null, $fetch_articles = true)
 661     {
 662         // Load this issue
 663         $res = XDB::query('SELECT  nlid, short_name, date, send_before, state, sufb_json,
 664                                    title, mail_title, head, signature
 665                              FROM  newsletter_issues
 666                             WHERE  id = {?}',
 667                           $id);
 668         if (!$res->numRows()) {
 669             throw new MailNotFound();
 670         }
 671         $issue = $res->fetchOneAssoc();
 672         if ($nl && $nl->id == $issue['nlid']) {
 673             $this->nl = $nl;
 674         } else {
 675             $this->nl = new NewsLetter($issue['nlid']);
 676         }
 677         $this->id = $id;
 678         $this->nlid        = $issue['nlid'];
 679         $this->shortname   = $issue['short_name'];
 680         $this->date        = $issue['date'];
 681         $this->send_before = $issue['send_before'];
 682         $this->state       = $issue['state'];
 683         $this->title       = $issue['title'];
 684         $this->title_mail  = $issue['mail_title'];
 685         $this->head        = $issue['head'];
 686         $this->signature   = $issue['signature'];
 687         $this->sufb        = $this->importJSonStoredUFB($issue['sufb_json']);
 688
 689         if ($fetch_articles) {
 690             $this->fetchArticles();
 691         }
 692     }
 693
 694     protected function fetchArticles($force = false)
 695     {
 696         if (count($this->arts) && !$force) {
 697             return;
 698         }
 699
 700         // Load the articles
 701         $res = XDB::iterRow(
 702             'SELECT  a.title, a.body, a.append, a.aid, a.cid, a.pos
 703                FROM  newsletter_art AS a
 704          INNER JOIN  newsletter_issues AS ni USING(id)
 705          LEFT  JOIN  newsletter_cat AS c ON (a.cid = c.cid)
 706               WHERE  a.id = {?}
 707            ORDER BY  c.pos, a.pos',
 708            $this->id);
 709         while (list($title, $body, $append, $aid, $cid, $pos) = $res->next()) {
 710             $this->arts[$cid][$aid] = new NLArticle($title, $body, $append, $aid, $cid, $pos);
 711         }
 712     }
 713
 714     protected function importJSonStoredUFB($json = null)
 715     {
 716         require_once 'ufbuilder.inc.php';
 717         $ufb = $this->nl->getSubscribersUFB();
 718         if (is_null($json)) {
 719             return new StoredUserFilterBuilder($ufb, new PFC_True());
 720         }
 721         $export = json_decode($json, true);
 722         if (is_null($export)) {
 723             PlErrorReport::report("Invalid json while reading NL {$this->nlid}, issue {$this->id}: failed to import '''{$json}'''.");
 724             return new StoredUserFilterBuilder($ufb, new PFC_True());
 725         }
 726         $sufb = new StoredUserFilterBuilder($ufb);
 727         $sufb->fillFromExport($export);
 728         return $sufb;
 729     }
 730
 731     protected function exportStoredUFBAsJSon()
 732     {
 733         return json_encode($this->sufb->export());
 734     }
 735
 736     public function id()
 737     {
 738         return is_null($this->shortname) ? $this->id : $this->shortname;
 739     }
 740
 741     protected function selectId($where)
 742     {
 743         $res = XDB::query("SELECT  IFNULL(ni.short_name, ni.id)
 744                              FROM  newsletter_issues AS ni
 745                             WHERE  ni.state != 'new' AND ni.nlid = {?} AND ${where}
 746                             LIMIT  1", $this->nl->id);
 747         if ($res->numRows() != 1) {
 748             return null;
 749         }
 750         return $res->fetchOneCell();
 751     }
 752
 753     /** Delete this issue
 754      * @return True if the issue could be deleted, false otherwise.
 755      * Related articles will be deleted through cascading FKs.
 756      * If this issue was the last issue for at least one subscriber, the deletion will be aborted.
 757      */
 758     public function delete()
 759     {
 760         if ($this->state == self::STATE_NEW) {
 761             $res = XDB::query('SELECT  COUNT(*)
 762                                  FROM  newsletter_ins
 763                                 WHERE  last = {?}', $this->id);
 764             if ($res->fetchOneCell() > 0) {
 765                 return false;
 766             }
 767
 768             return XDB::execute('DELETE FROM  newsletter_issues
 769                                        WHERE  id = {?}', $this->id);
 770         } else {
 771             return false;
 772         }
 773     }
 774
 775     /** Schedule a mailing of this NL
 776      * If the 'send_before' field was NULL, it is set to the current time.
 777      * @return Boolean Whether the date could be set (false if trying to schedule an already sent NL)
 778      */
 779     public function scheduleMailing()
 780     {
 781         if ($this->state == self::STATE_NEW) {
 782             $success = XDB::execute('UPDATE  newsletter_issues
 783                                         SET  state = \'pending\', send_before = IFNULL(send_before, NOW())
 784                                       WHERE  id = {?}',
 785                                       $this->id);
 786             if ($success) {
 787                 global $globals;
 788                 $mailer = new PlMailer('newsletter/notify_scheduled.mail.tpl');
 789                 $mailer->assign('issue', $this);
 790                 $mailer->assign('base', $globals->baseurl);
 791                 $mailer->send();
 792                 $this->refresh();
 793             }
 794             return $success;
 795         } else {
 796             return false;
 797         }
 798     }
 799
 800     /** Cancel the scheduled mailing of this NL
 801      * @return Boolean: whether the mailing could be cancelled.
 802      */
 803     public function cancelMailing()
 804     {
 805         if ($this->state == self::STATE_PENDING) {
 806             $success = XDB::execute('UPDATE  newsletter_issues
 807                                         SET  state = \'new\'
 808                                       WHERE  id = {?}', $this->id);
 809             if ($success) {
 810                 $this->refresh();
 811             }
 812             return $success;
 813         } else {
 814             return false;
 815         }
 816     }
 817
 818     /** Helper function for smarty templates: is this issue editable ?
 819      */
 820     public function isEditable()
 821     {
 822         return $this->state == self::STATE_NEW;
 823     }
 824
 825     /** Helper function for smarty templates: is the mailing of this issue scheduled ?
 826      */
 827     public function isPending()
 828     {
 829         return $this->state == self::STATE_PENDING;
 830     }
 831
 832     /** Helper function for smarty templates: has this issue been sent ?
 833      */
 834     public function isSent()
 835     {
 836         return $this->state == self::STATE_SENT;
 837     }
 838
 839     // }}}
 840     // {{{ Navigation
 841
 842     private $id_prev = null;
 843     private $id_next = null;
 844     private $id_last = null;
 845
 846     /** Retrieve ID of the previous issue
 847      * That value, once fetched, is cached in the private $id_prev variable.
 848      * @return ID of the previous issue.
 849      */
 850     public function prev()
 851     {
 852         if (is_null($this->id_prev)) {
 853             $this->id_prev = $this->selectId(XDB::format("ni.id < {?} ORDER BY ni.id DESC", $this->id));
 854         }
 855         return $this->id_prev;
 856     }
 857
 858     /** Retrieve ID of the following issue
 859      * That value, once fetched, is cached in the private $id_next variable.
 860      * @return ID of the following issue.
 861      */
 862     public function next()
 863     {
 864         if (is_null($this->id_next)) {
 865             $this->id_next = $this->selectId(XDB::format("ni.id > {?} ORDER BY ni.id", $this->id));
 866         }
 867         return $this->id_next;
 868     }
 869
 870     /** Retrieve ID of the last issue
 871      * That value, once fetched, is cached in the private $id_last variable.
 872      * @return ID of the last issue.
 873      */
 874     public function last()
 875     {
 876         if (is_null($this->id_last)) {
 877             try {
 878                 $this->id_last = $this->nl->getIssue('last')->id;
 879             } catch (MailNotFound $e) {
 880                 $this->id_last = null;
 881             }
 882         }
 883         return $this->id_last;
 884     }
 885
 886     // }}}
 887     // {{{ Edition, articles
 888
 889     const ERROR_INVALID_SHORTNAME = 'invalid_shortname';
 890     const ERROR_INVALID_UFC = 'invalid_ufc';
 891     const ERROR_TOO_LONG_UFC = 'too_long_ufc';
 892     const ERROR_SQL_SAVE = 'sql_error';
 893
 894     /** Save the global properties of this NL issue (title&co).
 895      */
 896     public function save()
 897     {
 898         $errors = array();
 899
 900         // Fill the list of fields to update
 901         $fields = array(
 902             'title' => $this->title,
 903             'mail_title' => $this->title_mail,
 904             'head' => $this->head,
 905             'signature' => $this->signature,
 906         );
 907
 908         if ($this->isEditable()) {
 909             $fields['date'] = $this->date;
 910             if (!preg_match('/^[-a-z0-9]+$/i', $this->shortname) || is_numeric($this->shortname)) {
 911                 $errors[] = self::ERROR_INVALID_SHORTNAME;
 912             } else {
 913                 $fields['short_name'] = $this->shortname;
 914             }
 915             if ($this->sufb->isValid() || $this->sufb->isEmpty()) {
 916                 $fields['sufb_json'] = json_encode($this->sufb->export()->dict());
 917                 // If sufb_json is too long to be store, we do not store a truncated json and notify the user.
 918                 // The limit is LONGTEXT's one, ie 2^32 = 4294967296.
 919                 if (strlen($fields['sufb_json']) > 4294967295) {
 920                     $errors[] = self::ERROR_TOO_LONG_UFC;
 921                 }
 922             } else {
 923                 $errors[] = self::ERROR_INVALID_UFC;
 924             }
 925
 926             if ($this->nl->automaticMailingEnabled()) {
 927                 $fields['send_before'] = ($this->send_before ? $this->send_before : null);
 928             }
 929         }
 930
 931         if (count($errors)) {
 932             return $errors;
 933         }
 934         $field_sets = array();
 935         foreach ($fields as $key => $value) {
 936             $field_sets[] = XDB::format($key . ' = {?}', $value);
 937         }
 938         XDB::execute('UPDATE  newsletter_issues
 939                          SET  ' . implode(', ', $field_sets) . '
 940                        WHERE  id={?}',
 941                        $this->id);
 942         if (XDB::affectedRows()) {
 943             $this->refresh();
 944         } else {
 945             $errors[] = self::ERROR_SQL_SAVE;
 946         }
 947         return $errors;
 948     }
 949
 950     /** Get an article by number
 951      * @p $aid Article ID (among articles of the issue)
 952      * @return A NLArticle object, or null if there is no article by that number
 953      */
 954     public function getArt($aid)
 955     {
 956         $this->fetchArticles();
 957
 958         foreach ($this->arts as $category => $artlist) {
 959             if (isset($artlist[$aid])) {
 960                 return $artlist[$aid];
 961             }
 962         }
 963         return null;
 964     }
 965
 966     /** Save an article
 967      * @p $a A reference to a NLArticle object (will be modified once saved)
 968      */
 969     public function saveArticle($a)
 970     {
 971         $this->fetchArticles();
 972
 973         // Prevent cid to be 0 (use NULL instead)
 974         $a->cid = ($a->cid == 0) ? null : $a->cid;
 975         if ($a->aid >= 0) {
 976             // Article already exists in DB
 977             XDB::execute('UPDATE  newsletter_art
 978                              SET  cid = {?}, pos = {?}, title = {?}, body = {?}, append = {?}
 979                            WHERE  id = {?} AND aid = {?}',
 980                          $a->cid, $a->pos, $a->title, $a->body, $a->append, $this->id, $a->aid);
 981         } else {
 982             // New article
 983             XDB::startTransaction();
 984             list($aid, $pos) = XDB::fetchOneRow('SELECT  MAX(aid) AS aid, MAX(pos) AS pos
 985                                                    FROM  newsletter_art AS a
 986                                                   WHERE  a.id = {?}',
 987                                                 $this->id);
 988             $a->aid = ++$aid;
 989             $a->pos = ($a->pos ? $a->pos : ++$pos);
 990             XDB::execute('INSERT INTO  newsletter_art (id, aid, cid, pos, title, body, append)
 991                                VALUES  ({?}, {?}, {?}, {?}, {?}, {?}, {?})',
 992                          $this->id, $a->aid, $a->cid, $a->pos,
 993                          $a->title, $a->body, $a->append);
 994             XDB::commit();
 995         }
 996         // Update local ID of article
 997         $this->arts[$a->aid] = $a;
 998     }
 999
1000     /** Delete an article by its ID
1001      * @p $aid ID of the article to delete
1002      */
1003     public function delArticle($aid)
1004     {
1005         $this->fetchArticles();
1006
1007         XDB::execute('DELETE FROM newsletter_art WHERE id={?} AND aid={?}', $this->id, $aid);
1008         foreach ($this->arts as $key=>$art) {
1009             unset($this->arts[$key][$aid]);
1010         }
1011     }
1012
1013     // }}}
1014     // {{{ Display
1015
1016     /** Retrieve the title of this issue
1017      * @p $mail Whether we want the normal title or the email subject
1018      * @return Title of the issue
1019      */
1020     public function title($mail = false)
1021     {
1022         return $mail ? $this->title_mail : $this->title;
1023     }
1024
1025     /** Retrieve the head of this issue
1026      * @p $user User for <dear> customization (may be null: no customization)
1027      * @p $type Either 'text' or 'html'
1028      * @return Formatted head of the issue.
1029      */
1030     public function head($user = null, $type = 'text')
1031     {
1032         if (is_null($user)) {
1033             return $this->head;
1034         } else {
1035             $head = $this->head;
1036             $head = str_replace(array('<cher>', '<prenom>', '<nom>'),
1037                                 array(($user->isFemale() ? 'Chère' : 'Cher'), $user->displayName(), ''),
1038                                 $head);
1039             return format_text($head, $type, 2, 64);
1040         }
1041     }
1042
1043     /** Retrieve the formatted signature of this issue.
1044      */
1045     public function signature($type = 'text')
1046     {
1047         return format_text($this->signature, $type, 2, 64);
1048     }
1049
1050     /** Get the title of a given category
1051      * @p $cid ID of the category to retrieve
1052      * @return Name of the category
1053      */
1054     public function category($cid)
1055     {
1056         return $this->nl->cats[$cid];
1057     }
1058
1059     /** Add required data to the given $page for proper CSS display
1060      * @p $page Smarty object
1061      * @return Either 'true' (if CSS was added to a page) or the raw CSS to add (when $page is null)
1062      */
1063     public function css($page = null)
1064     {
1065         if (!is_null($page)) {
1066             $page->addCssLink($this->nl->cssFile());
1067             return true;
1068         } else {
1069             $css = file_get_contents(dirname(__FILE__) . '/../htdocs/css/' . $this->nl->cssFile());
1070             return preg_replace('@/\*.*?\*/@us', '', $css);
1071         }
1072     }
1073
1074     /** Set up a smarty page for a 'text' mode render of the issue
1075      * @p $page Smarty object (using the $this->nl->tplFile() template)
1076      * @p $user User to use when rendering the template
1077      */
1078     public function toText($page, $user)
1079     {
1080         $this->fetchArticles();
1081
1082         $this->css($page);
1083         $page->assign('prefix', null);
1084         $page->assign('is_mail', false);
1085         $page->assign('mail_part', 'text');
1086         $page->assign('user', $user);
1087         $page->assign('hash', null);
1088         $this->assignData($page);
1089     }
1090
1091     /** Set up a smarty page for a 'html' mode render of the issue
1092      * @p $page Smarty object (using the $this->nl->tplFile() template)
1093      * @p $user User to use when rendering the template
1094      */
1095     public function toHtml($page, $user)
1096     {
1097         $this->fetchArticles();
1098
1099         $this->css($page);
1100         $page->assign('prefix', $this->nl->prefix() . '/show/' . $this->id());
1101         $page->assign('is_mail', false);
1102         $page->assign('mail_part', 'html');
1103         $page->assign('user', $user);
1104         $page->assign('hash', null);
1105         $this->assignData($page);
1106     }
1107
1108     /** Set all 'common' data for the page (those which are required for both web and email rendering)
1109      * @p $smarty Smarty object (e.g page) which should be filled
1110      */
1111     protected function assignData($smarty)
1112     {
1113         $this->fetchArticles();
1114
1115         $smarty->assign_by_ref('issue', $this);
1116         $smarty->assign_by_ref('nl', $this->nl);
1117     }
1118
1119     // }}}
1120     // {{{ Mailing
1121
1122     /** Check whether this issue is empty
1123      * An issue is empty if the email has no title (or the default one), or no articles and an empty head.
1124      */
1125     public function isEmpty()
1126     {
1127         return $this->title_mail == '' || $this->title_mail == 'to be continued' || (count($this->arts) == 0 && strlen($this->head) == 0);
1128     }
1129
1130     /** Retrieve the 'Send before' date, in a clean format.
1131      */
1132     public function getSendBeforeDate()
1133     {
1134         return strftime('%Y-%m-%d', strtotime($this->send_before));
1135     }
1136
1137     /** Retrieve the 'Send before' time (i.e hour), in a clean format.
1138      */
1139     public function getSendBeforeTime()
1140     {
1141         return strtotime($this->send_before);
1142     }
1143
1144     /** Create a hash based on some additional data
1145      * $line Line-specific data (to prevent two hashes generated at the same time to be the same)
1146      */
1147     protected static function createHash($line)
1148     {
1149         $hash = implode(time(), $line) . rand();
1150         $hash = md5($hash);
1151         return $hash;
1152     }
1153
1154     /** Send this issue to the given user, reusing an existing hash if provided.
1155      * @p $user User to whom the issue should be mailed
1156      * @p $hash Optional hash to use in the 'unsubscribe' link; if null, another one will be generated.
1157      */
1158     public function sendTo($user, $hash = null)
1159     {
1160         $this->fetchArticles();
1161
1162         if (is_null($hash)) {
1163             $hash = XDB::fetchOneCell("SELECT  hash
1164                                          FROM  newsletter_ins
1165                                         WHERE  uid = {?} AND nlid = {?}",
1166                                       $user->id(), $this->nl->id);
1167         }
1168         if (is_null($hash)) {
1169             $hash = self::createHash(array($user->displayName(), $user->fullName(),
1170                                        $user->isFemale(), $user->isEmailFormatHtml(),
1171                                        rand(), "X.org rulez"));
1172             XDB::execute("UPDATE  newsletter_ins as ni
1173                              SET  ni.hash = {?}
1174                            WHERE  ni.uid = {?} AND ni.nlid = {?}",
1175                          $hash, $user->id(), $this->nl->id);
1176         }
1177
1178         $mailer = new PlMailer($this->nl->tplFile());
1179         $this->assignData($mailer);
1180         $mailer->assign('is_mail', true);
1181         $mailer->assign('user', $user);
1182         $mailer->assign('prefix',  null);
1183         $mailer->assign('hash',    $hash);
1184         $mailer->sendTo($user);
1185     }
1186
1187     /** Select a subset of subscribers which should receive the newsletter.
1188      * NL-Specific selections (not yet received, is subscribed) are done when sending.
1189      * @return A PlFilterCondition.
1190      */
1191     protected function getRecipientsUFC()
1192     {
1193         return $this->sufb->getUFC();
1194     }
1195
1196     /** Check whether a given user may see this issue.
1197      * @p $user User whose access should be checked
1198      * @return Whether he may access the issue
1199      */
1200     public function checkUser($user = null)
1201     {
1202         if ($user == null) {
1203             $user = S::user();
1204         }
1205         $uf = new UserFilter($this->getRecipientsUFC());
1206         return $uf->checkUser($user);
1207     }
1208
1209     /** Sent this issue to all valid recipients
1210      * @return Number of issues sent
1211      */
1212     public function sendToAll()
1213     {
1214         $this->fetchArticles();
1215
1216         XDB::execute('UPDATE  newsletter_issues
1217                          SET  state = \'sent\', date=CURDATE()
1218                        WHERE  id = {?}',
1219                        $this->id);
1220
1221         $ufc = new PFC_And($this->getRecipientsUFC(), new UFC_NLSubscribed($this->nl->id, $this->id), new UFC_HasValidEmail());
1222         $uf = new UserFilter($ufc, array(new UFO_IsAdmin(), new UFO_Uid()));
1223         $limit = new PlLimit(self::BATCH_SIZE);
1224         $global_sent = array();
1225
1226         while (true) {
1227             $sent = array();
1228             $users = $uf->getUsers($limit);
1229             if (count($users) == 0) {
1230                 break;
1231             }
1232             foreach ($users as $user) {
1233                 if (array_key_exists($user->id(), $global_sent)) {
1234                     Platal::kill('Sending the same newsletter issue ' . $this->id . ' to user ' . $user->id() . ' twice, something must be wrong.');
1235                 }
1236                 $sent[] = $user->id();
1237                 $global_sent[$user->id()] = true;
1238                 $this->sendTo($user, $hash);
1239             }
1240             XDB::execute("UPDATE  newsletter_ins
1241                              SET  last = {?}
1242                            WHERE  nlid = {?} AND uid IN {?}", $this->id, $this->nl->id, $sent);
1243
1244             sleep(60);
1245         }
1246         return count($global_sent);
1247     }
1248
1249     // }}}
1250 }
1251
1252 // }}}
1253 // {{{ class NLArticle
1254
1255 class NLArticle
1256 {
1257     // Maximum number of lines per article
1258     const MAX_LINES_PER_ARTICLE = 8;
1259     const MAX_CHARACTERS_PER_LINE = 68;
1260
1261     // {{{ properties
1262
1263     public $aid;
1264     public $cid;
1265     public $pos;
1266     public $title;
1267     public $body;
1268     public $append;
1269
1270     // }}}
1271     // {{{ constructor
1272
1273     function __construct($title='', $body='', $append='', $aid=-1, $cid=0, $pos=0)
1274     {
1275         $this->body   = $body;
1276         $this->title  = $title;
1277         $this->append = $append;
1278         $this->aid    = $aid;
1279         $this->cid    = $cid;
1280         $this->pos    = $pos;
1281     }
1282
1283     // }}}
1284     // {{{ function title()
1285
1286     public function title()
1287     { return trim($this->title); }
1288
1289     // }}}
1290     // {{{ function body()
1291
1292     public function body()
1293     { return trim($this->body); }
1294
1295     // }}}
1296     // {{{ function append()
1297
1298     public function append()
1299     { return trim($this->append); }
1300
1301     // }}}
1302     // {{{ function toText()
1303
1304     public function toText($hash = null, $login = null)
1305     {
1306         $title = '*'.$this->title().'*';
1307         $body = MiniWiki::WikiToText($this->body, true);
1308         $app = MiniWiki::WikiToText($this->append, false, 4);
1309         $text = trim("$title\n\n$body\n\n$app")."\n";
1310         if (!is_null($hash) && !is_null($login)) {
1311             $text = str_replace('%HASH%', "$hash/$login", $text);
1312         } else {
1313             $text = str_replace('%HASH%', '', $text);
1314         }
1315         return $text;
1316     }
1317
1318     // }}}
1319     // {{{ function toHtml()
1320
1321     public function toHtml($hash = null, $login = null)
1322     {
1323         $title = "<h2 class='xorg_nl'><a id='art{$this->aid}'></a>".pl_entities($this->title()).'</h2>';
1324         $body  = MiniWiki::WikiToHTML($this->body);
1325         $app   = MiniWiki::WikiToHTML($this->append);
1326
1327         $art   = "$title\n";
1328         $art  .= "<div class='art'>\n$body\n";
1329         if ($app) {
1330             $art .= "<div class='app'>$app</div>";
1331         }
1332         $art  .= "</div>\n";
1333         if (!is_null($hash) && !is_null($login)) {
1334             $art = str_replace('%HASH%', "$hash/$login", $art);
1335         } else {
1336             $art = str_replace('%HASH%', '', $art);
1337         }
1338
1339         return $art;
1340     }
1341
1342     // }}}
1343     // {{{ function check()
1344
1345     public function check()
1346     {
1347         $rest = $this->remain();
1348
1349         return $rest['remaining_lines'] >= 0;
1350     }
1351
1352     // }}}
1353     // {{{ function remain()
1354
1355     public function remain()
1356     {
1357         $text  = MiniWiki::WikiToText($this->body);
1358         $array = explode("\n", wordwrap($text, self::MAX_CHARACTERS_PER_LINE));
1359         $lines_count = 0;
1360         foreach ($array as $line) {
1361             if (trim($line) != '') {
1362                 ++$lines_count;
1363             }
1364         }
1365
1366         return array(
1367             'remaining_lines'                    => self::MAX_LINES_PER_ARTICLE - $lines_count,
1368             'remaining_characters_for_last_line' => self::MAX_CHARACTERS_PER_LINE - strlen($array[count($array) - 1])
1369        );
1370     }
1371     // }}}
1372     // {{{ function parseUrlsFromArticle()
1373
1374     protected function parseUrlsFromArticle()
1375     {
1376         $email_regex = '([a-z0-9.\-+_\$]+@([\-.+_]?[a-z0-9])+)';
1377         $url_regex = '((https?|ftp)://[a-zA-Z0-9._%#+/?=&~-]+)';
1378         $regex = '{' . $email_regex . '|' . $url_regex . '}i';
1379
1380         $matches = array();
1381         $body_matches = array();
1382         if (preg_match_all($regex, $this->body(), $body_matches)) {
1383             $matches = array_merge($matches, $body_matches[0]);
1384         }
1385
1386         $append_matches = array();
1387         if (preg_match_all($regex, $this->append(), $append_matches)) {
1388             $matches = array_merge($matches, $append_matches[0]);
1389         }
1390
1391         return $matches;
1392     }
1393
1394     // }}}
1395     // {{{ function getLinkIps()
1396
1397     public function getLinkIps(&$blacklist_host_resolution_count)
1398     {
1399         $matches = $this->parseUrlsFromArticle();
1400         $article_ips = array();
1401
1402         if (!empty($matches)) {
1403             global $globals;
1404
1405             foreach ($matches as $match) {
1406                 $host = parse_url($match, PHP_URL_HOST);
1407                 if ($host == '') {
1408                     list(, $host) = explode('@', $match);
1409                 }
1410
1411                 if ($blacklist_host_resolution_count >= $globals->mail->blacklist_host_resolution_limit) {
1412                    break;
1413                 }
1414
1415                 if (!preg_match('/^(' . str_replace(' ', '|', $globals->mail->domain_whitelist) . ')$/i', $host)) {
1416                     $article_ips = array_merge($article_ips, array(gethostbyname($host) => $host));
1417                     ++$blacklist_host_resolution_count;
1418                 }
1419             }
1420         }
1421
1422         return $article_ips;
1423     }
1424
1425     // }}}
1426 }
1427
1428 // }}}
1429
1430 // {{{ Functions
1431
1432 function format_text($input, $format, $indent = 0, $width = 68)
1433 {
1434     if ($format == 'text') {
1435         return MiniWiki::WikiToText($input, true, $indent, $width, "title");
1436     }
1437     return MiniWiki::WikiToHTML($input, "title");
1438 }
1439
1440 // function enriched_to_text($input,$html=false,$just=false,$indent=0,$width=68)
1441
1442 // }}}
1443
1444 // vim:set et sw=4 sts=4 sws=4 enc=utf-8:
1445 ?>