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 number of subscribers to the NL whose last received mailing was $last.
 411      * @p $last ID of the issue for which subscribers should be counted.
 412      * @return Number of subscribers
 413      */
 414     public function subscriberCountForLast($last)
 415     {
 416         return XDB::fetchOneCell('SELECT  COUNT(uid)
 417                                     FROM  newsletter_ins
 418                                    WHERE  nlid = {?} AND last = {?}', $this->id, $last);
 419     }
 420
 421     /** Retrieve the list of newsletters a user has subscribed to
 422      * @p $user User whose subscriptions should be retrieved (if null, use session user).
 423      * @return Array of newsletter IDs
 424      */
 425     public static function getUserSubscriptions($user = null)
 426     {
 427         if (is_null($user)) {
 428             $user = S::user();
 429         }
 430         $res = XDB::query('SELECT  nlid
 431                              FROM  newsletter_ins
 432                             WHERE  uid = {?}',
 433                           $user->id());
 434         return $res->fetchColumn();
 435     }
 436
 437     /** Retrieve the UserFilterBuilder for subscribers to this NL.
 438      * This is the place where NL-specific filters may be allowed or prevented.
 439      * @p $envprefix Prefix to use for env fields (cf. UserFilterBuilder)
 440      * @return A UserFilterBuilder object using the given env prefix
 441      */
 442     public function getSubscribersUFB($envprefix = '')
 443     {
 444         require_once 'ufbuilder.inc.php';
 445         return new UFB_NewsLetter($this->criteria, $envprefix);
 446     }
 447
 448     // }}}
 449     // {{{ Permissions related functions
 450
 451     /** For later use: check whether a given user may subscribe to this newsletter.
 452      * @p $user User whose access should be checked
 453      * @return Boolean: whether the user may subscribe to the NL.
 454      */
 455     public function maySubscribe($user = null)
 456     {
 457         return true;
 458     }
 459
 460     /** Whether a given user may edit this newsletter
 461      * @p $uid UID of the user whose perms should be checked (if null, use current user)
 462      * @return Boolean: whether the user may edit the NL
 463      */
 464     public function mayEdit($user = null)
 465     {
 466         if (is_null($user)) {
 467             $user = S::user();
 468         }
 469         if ($user->checkPerms('admin')) {
 470             return true;
 471         }
 472         $res = XDB::query('SELECT  perms
 473                              FROM  group_members
 474                             WHERE  asso_id = {?} AND uid = {?}',
 475                             $this->group_id, $user->id());
 476         return ($res->numRows() && $res->fetchOneCell() == 'admin');
 477     }
 478
 479     /** Whether a given user may submit articles to this newsletter using X.org validation system
 480      * @p $user User whose access should be checked (if null, use current user)
 481      * @return Boolean: whether the user may submit articles
 482      */
 483     public function maySubmit($user = null)
 484     {
 485         // Submission of new articles is only enabled for the X.org NL (and forbidden when viewing issues on X.net)
 486         return ($this->group == self::GROUP_XORG && !isset($GLOBALS['IS_XNET_SITE']));
 487     }
 488
 489     // }}}
 490     // {{{ Display-related functions: cssFile, tplFile, prefix, admin_prefix, admin_links_enabled, automatic_mailings_enabled
 491
 492     /** Get the name of the css file used to display this newsletter.
 493      */
 494     public function cssFile()
 495     {
 496         if ($this->custom_css) {
 497             $base = $this->group;
 498         } else {
 499             $base = self::FORMAT_DEFAULT_GROUP;
 500         }
 501         return 'nl.' . $base . '.css';
 502     }
 503
 504     /** Get the name of the template file used to display this newsletter.
 505      */
 506     public function tplFile()
 507     {
 508         if ($this->custom_css) {
 509             $base = $this->group;
 510         } else {
 511             $base = self::FORMAT_DEFAULT_GROUP;
 512         }
 513         return 'newsletter/nl.' . $base . '.mail.tpl';
 514     }
 515
 516     /** Get the prefix leading to the page for this NL
 517      * Only X.org / AX / X groups may be seen on X.org.
 518      */
 519     public function prefix($enforce_xnet=true, $with_group=true)
 520     {
 521         if (!empty($GLOBALS['IS_XNET_SITE'])) {
 522             if ($with_group) {
 523                 return $this->group . '/nl';
 524             } else {
 525                 return 'nl';
 526             }
 527         }
 528         switch ($this->group) {
 529         case self::GROUP_XORG:
 530             return 'nl';
 531         case self::GROUP_AX:
 532             return 'ax';
 533         case self::GROUP_EP:
 534             return 'epletter';
 535         default:
 536             // Don't display groups NLs on X.org
 537             assert(!$enforce_xnet);
 538         }
 539     }
 540
 541     /** Get the prefix to use for all 'admin' pages of this NL.
 542      */
 543     public function adminPrefix($enforce_xnet=true, $with_group=true)
 544     {
 545         if (!empty($GLOBALS['IS_XNET_SITE'])) {
 546             if ($with_group) {
 547                 return $this->group . '/admin/nl';
 548             } else {
 549                 return 'admin/nl';
 550             }
 551         }
 552         switch ($this->group) {
 553         case self::GROUP_XORG:
 554             return 'admin/newsletter';
 555         case self::GROUP_AX:
 556             return 'ax/admin';
 557         case self::GROUP_EP:
 558             return 'epletter/admin';
 559         default:
 560             // Don't display groups NLs on X.org
 561             assert(!$enforce_xnet);
 562         }
 563     }
 564
 565     /** Hack used to remove "admin" links on X.org page on X.net
 566      * The 'admin' links are enabled for all pages, except for X.org when accessing NL through X.net
 567      */
 568     public function adminLinksEnabled()
 569     {
 570         return ($this->group != self::GROUP_XORG || !isset($GLOBALS['IS_XNET_SITE']));
 571     }
 572
 573     /** Automatic mailings are disabled for X.org NL.
 574      */
 575     public function automaticMailingEnabled()
 576     {
 577         return $this->group != self::GROUP_XORG;
 578     }
 579
 580     public function hasCustomCss()
 581     {
 582         return $this->custom_css;
 583     }
 584
 585     public function canSyncWithGroup()
 586     {
 587         switch ($this->group) {
 588           case self::GROUP_XORG:
 589           case self::GROUP_AX:
 590           case self::GROUP_EP:
 591             return false;
 592           default:
 593             return true;
 594         }
 595     }
 596
 597     // }}}
 598 }
 599
 600 // }}}
 601
 602 // {{{ class NLIssue
 603
 604 // A NLIssue is an issue of a given NewsLetter
 605 class NLIssue
 606 {
 607     protected $nlid;  // Id of the newsletter
 608
 609     const STATE_NEW = 'new';  // New, currently being edited
 610     const STATE_PENDING = 'pending';  // Ready for mailing
 611     const STATE_SENT = 'sent';  // Sent
 612
 613     public $nl;  // Related NL
 614
 615     public $id;  // Id of this issue of the newsletter
 616     public $shortname;  // Shortname for this issue
 617     public $title;  // Title of this issue
 618     public $title_mail;  // Title of the email
 619     public $state;  // State of the issue (one of the STATE_ values)
 620     public $sufb;  // Environment to use to generate the UFC through an UserFilterBuilder
 621
 622     public $date;  // Date at which this issue was sent
 623     public $send_before;  // Date at which issue should be sent
 624     public $head;  // Foreword of the issue (or body for letters with no articles)
 625     public $signature;  // Signature of the letter
 626     public $arts = array();  // Articles of the issue
 627
 628     const BATCH_SIZE = 60;  // Number of emails to send every minute.
 629
 630     // {{{ Constructor, id-related functions
 631
 632     /** Build a NewsLetter.
 633      * @p $id: ID of the issue (unique among all newsletters)
 634      * @p $nl: Optional argument containing an already built NewsLetter object.
 635      */
 636     function __construct($id, $nl = null, $fetch_articles = true)
 637     {
 638         return $this->fetch($id, $nl, $fetch_articles);
 639     }
 640
 641     protected function refresh()
 642     {
 643         return $this->fetch($this->id, $this->nl, false);
 644     }
 645
 646     protected function fetch($id, $nl = null, $fetch_articles = true)
 647     {
 648         // Load this issue
 649         $res = XDB::query('SELECT  nlid, short_name, date, send_before, state, sufb_json,
 650                                    title, mail_title, head, signature
 651                              FROM  newsletter_issues
 652                             WHERE  id = {?}',
 653                           $id);
 654         if (!$res->numRows()) {
 655             throw new MailNotFound();
 656         }
 657         $issue = $res->fetchOneAssoc();
 658         if ($nl && $nl->id == $issue['nlid']) {
 659             $this->nl = $nl;
 660         } else {
 661             $this->nl = new NewsLetter($issue['nlid']);
 662         }
 663         $this->id = $id;
 664         $this->nlid        = $issue['nlid'];
 665         $this->shortname   = $issue['short_name'];
 666         $this->date        = $issue['date'];
 667         $this->send_before = $issue['send_before'];
 668         $this->state       = $issue['state'];
 669         $this->title       = $issue['title'];
 670         $this->title_mail  = $issue['mail_title'];
 671         $this->head        = $issue['head'];
 672         $this->signature   = $issue['signature'];
 673         $this->sufb        = $this->importJSonStoredUFB($issue['sufb_json']);
 674
 675         if ($fetch_articles) {
 676             $this->fetchArticles();
 677         }
 678     }
 679
 680     protected function fetchArticles($force = false)
 681     {
 682         if (count($this->arts) && !$force) {
 683             return;
 684         }
 685
 686         // Load the articles
 687         $res = XDB::iterRow(
 688             'SELECT  a.title, a.body, a.append, a.aid, a.cid, a.pos
 689                FROM  newsletter_art AS a
 690          INNER JOIN  newsletter_issues AS ni USING(id)
 691          LEFT  JOIN  newsletter_cat AS c ON (a.cid = c.cid)
 692               WHERE  a.id = {?}
 693            ORDER BY  c.pos, a.pos',
 694            $this->id);
 695         while (list($title, $body, $append, $aid, $cid, $pos) = $res->next()) {
 696             $this->arts[$cid][$aid] = new NLArticle($title, $body, $append, $aid, $cid, $pos);
 697         }
 698     }
 699
 700     protected function importJSonStoredUFB($json = null)
 701     {
 702         require_once 'ufbuilder.inc.php';
 703         $ufb = $this->nl->getSubscribersUFB();
 704         if (is_null($json)) {
 705             return new StoredUserFilterBuilder($ufb, new PFC_True());
 706         }
 707         $export = json_decode($json, true);
 708         if (is_null($export)) {
 709             PlErrorReport::report("Invalid json while reading NL {$this->nlid}, issue {$this->id}: failed to import '''{$json}'''.");
 710             return new StoredUserFilterBuilder($ufb, new PFC_True());
 711         }
 712         $sufb = new StoredUserFilterBuilder($ufb);
 713         $sufb->fillFromExport($export);
 714         return $sufb;
 715     }
 716
 717     protected function exportStoredUFBAsJSon()
 718     {
 719         return json_encode($this->sufb->export());
 720     }
 721
 722     public function id()
 723     {
 724         return is_null($this->shortname) ? $this->id : $this->shortname;
 725     }
 726
 727     protected function selectId($where)
 728     {
 729         $res = XDB::query("SELECT  IFNULL(ni.short_name, ni.id)
 730                              FROM  newsletter_issues AS ni
 731                             WHERE  ni.state != 'new' AND ni.nlid = {?} AND ${where}
 732                             LIMIT  1", $this->nl->id);
 733         if ($res->numRows() != 1) {
 734             return null;
 735         }
 736         return $res->fetchOneCell();
 737     }
 738
 739     /** Delete this issue
 740      * @return True if the issue could be deleted, false otherwise.
 741      * Related articles will be deleted through cascading FKs.
 742      * If this issue was the last issue for at least one subscriber, the deletion will be aborted.
 743      */
 744     public function delete()
 745     {
 746         if ($this->state == self::STATE_NEW) {
 747             $res = XDB::query('SELECT  COUNT(*)
 748                                  FROM  newsletter_ins
 749                                 WHERE  last = {?}', $this->id);
 750             if ($res->fetchOneCell() > 0) {
 751                 return false;
 752             }
 753
 754             return XDB::execute('DELETE FROM  newsletter_issues
 755                                        WHERE  id = {?}', $this->id);
 756         } else {
 757             return false;
 758         }
 759     }
 760
 761     /** Schedule a mailing of this NL
 762      * If the 'send_before' field was NULL, it is set to the current time.
 763      * @return Boolean Whether the date could be set (false if trying to schedule an already sent NL)
 764      */
 765     public function scheduleMailing()
 766     {
 767         if ($this->state == self::STATE_NEW) {
 768             $success = XDB::execute('UPDATE  newsletter_issues
 769                                         SET  state = \'pending\', send_before = IFNULL(send_before, NOW())
 770                                       WHERE  id = {?}',
 771                                       $this->id);
 772             if ($success) {
 773                 global $globals;
 774                 $mailer = new PlMailer('newsletter/notify_scheduled.mail.tpl');
 775                 $mailer->assign('issue', $this);
 776                 $mailer->assign('base', $globals->baseurl);
 777                 $mailer->send();
 778                 $this->refresh();
 779             }
 780             return $success;
 781         } else {
 782             return false;
 783         }
 784     }
 785
 786     /** Cancel the scheduled mailing of this NL
 787      * @return Boolean: whether the mailing could be cancelled.
 788      */
 789     public function cancelMailing()
 790     {
 791         if ($this->state == self::STATE_PENDING) {
 792             $success = XDB::execute('UPDATE  newsletter_issues
 793                                         SET  state = \'new\'
 794                                       WHERE  id = {?}', $this->id);
 795             if ($success) {
 796                 $this->refresh();
 797             }
 798             return $success;
 799         } else {
 800             return false;
 801         }
 802     }
 803
 804     /** Helper function for smarty templates: is this issue editable ?
 805      */
 806     public function isEditable()
 807     {
 808         return $this->state == self::STATE_NEW;
 809     }
 810
 811     /** Helper function for smarty templates: is the mailing of this issue scheduled ?
 812      */
 813     public function isPending()
 814     {
 815         return $this->state == self::STATE_PENDING;
 816     }
 817
 818     /** Helper function for smarty templates: has this issue been sent ?
 819      */
 820     public function isSent()
 821     {
 822         return $this->state == self::STATE_SENT;
 823     }
 824
 825     // }}}
 826     // {{{ Navigation
 827
 828     private $id_prev = null;
 829     private $id_next = null;
 830     private $id_last = null;
 831
 832     /** Retrieve ID of the previous issue
 833      * That value, once fetched, is cached in the private $id_prev variable.
 834      * @return ID of the previous issue.
 835      */
 836     public function prev()
 837     {
 838         if (is_null($this->id_prev)) {
 839             $this->id_prev = $this->selectId(XDB::format("ni.id < {?} ORDER BY ni.id DESC", $this->id));
 840         }
 841         return $this->id_prev;
 842     }
 843
 844     /** Retrieve ID of the following issue
 845      * That value, once fetched, is cached in the private $id_next variable.
 846      * @return ID of the following issue.
 847      */
 848     public function next()
 849     {
 850         if (is_null($this->id_next)) {
 851             $this->id_next = $this->selectId(XDB::format("ni.id > {?} ORDER BY ni.id", $this->id));
 852         }
 853         return $this->id_next;
 854     }
 855
 856     /** Retrieve ID of the last issue
 857      * That value, once fetched, is cached in the private $id_last variable.
 858      * @return ID of the last issue.
 859      */
 860     public function last()
 861     {
 862         if (is_null($this->id_last)) {
 863             try {
 864                 $this->id_last = $this->nl->getIssue('last')->id;
 865             } catch (MailNotFound $e) {
 866                 $this->id_last = null;
 867             }
 868         }
 869         return $this->id_last;
 870     }
 871
 872     // }}}
 873     // {{{ Edition, articles
 874
 875     const ERROR_INVALID_SHORTNAME = 'invalid_shortname';
 876     const ERROR_INVALID_UFC = 'invalid_ufc';
 877     const ERROR_TOO_LONG_UFC = 'too_long_ufc';
 878     const ERROR_SQL_SAVE = 'sql_error';
 879
 880     /** Save the global properties of this NL issue (title&co).
 881      */
 882     public function save()
 883     {
 884         $errors = array();
 885
 886         // Fill the list of fields to update
 887         $fields = array(
 888             'title' => $this->title,
 889             'mail_title' => $this->title_mail,
 890             'head' => $this->head,
 891             'signature' => $this->signature,
 892         );
 893
 894         if ($this->isEditable()) {
 895             $fields['date'] = $this->date;
 896             if (!preg_match('/^[-a-z0-9]+$/i', $this->shortname) || is_numeric($this->shortname)) {
 897                 $errors[] = self::ERROR_INVALID_SHORTNAME;
 898             } else {
 899                 $fields['short_name'] = $this->shortname;
 900             }
 901             if ($this->sufb->isValid() || $this->sufb->isEmpty()) {
 902                 $fields['sufb_json'] = json_encode($this->sufb->export()->dict());
 903                 // If sufb_json is too long to be store, we do not store a truncated json and notify the user.
 904                 // The limit is LONGTEXT's one, ie 2^32 = 4294967296.
 905                 if (strlen($fields['sufb_json']) > 4294967295) {
 906                     $errors[] = self::ERROR_TOO_LONG_UFC;
 907                 }
 908             } else {
 909                 $errors[] = self::ERROR_INVALID_UFC;
 910             }
 911
 912             if ($this->nl->automaticMailingEnabled()) {
 913                 $fields['send_before'] = ($this->send_before ? $this->send_before : null);
 914             }
 915         }
 916
 917         if (count($errors)) {
 918             return $errors;
 919         }
 920         $field_sets = array();
 921         foreach ($fields as $key => $value) {
 922             $field_sets[] = XDB::format($key . ' = {?}', $value);
 923         }
 924         XDB::execute('UPDATE  newsletter_issues
 925                          SET  ' . implode(', ', $field_sets) . '
 926                        WHERE  id={?}',
 927                        $this->id);
 928         if (XDB::affectedRows()) {
 929             $this->refresh();
 930         } else {
 931             $errors[] = self::ERROR_SQL_SAVE;
 932         }
 933         return $errors;
 934     }
 935
 936     /** Get an article by number
 937      * @p $aid Article ID (among articles of the issue)
 938      * @return A NLArticle object, or null if there is no article by that number
 939      */
 940     public function getArt($aid)
 941     {
 942         $this->fetchArticles();
 943
 944         foreach ($this->arts as $category => $artlist) {
 945             if (isset($artlist[$aid])) {
 946                 return $artlist[$aid];
 947             }
 948         }
 949         return null;
 950     }
 951
 952     /** Save an article
 953      * @p $a A reference to a NLArticle object (will be modified once saved)
 954      */
 955     public function saveArticle($a)
 956     {
 957         $this->fetchArticles();
 958
 959         // Prevent cid to be 0 (use NULL instead)
 960         $a->cid = ($a->cid == 0) ? null : $a->cid;
 961         if ($a->aid >= 0) {
 962             // Article already exists in DB
 963             XDB::execute('UPDATE  newsletter_art
 964                              SET  cid = {?}, pos = {?}, title = {?}, body = {?}, append = {?}
 965                            WHERE  id = {?} AND aid = {?}',
 966                          $a->cid, $a->pos, $a->title, $a->body, $a->append, $this->id, $a->aid);
 967         } else {
 968             // New article
 969             XDB::startTransaction();
 970             list($aid, $pos) = XDB::fetchOneRow('SELECT  MAX(aid) AS aid, MAX(pos) AS pos
 971                                                    FROM  newsletter_art AS a
 972                                                   WHERE  a.id = {?}',
 973                                                 $this->id);
 974             $a->aid = ++$aid;
 975             $a->pos = ($a->pos ? $a->pos : ++$pos);
 976             XDB::execute('INSERT INTO  newsletter_art (id, aid, cid, pos, title, body, append)
 977                                VALUES  ({?}, {?}, {?}, {?}, {?}, {?}, {?})',
 978                          $this->id, $a->aid, $a->cid, $a->pos,
 979                          $a->title, $a->body, $a->append);
 980             XDB::commit();
 981         }
 982         // Update local ID of article
 983         $this->arts[$a->aid] = $a;
 984     }
 985
 986     /** Delete an article by its ID
 987      * @p $aid ID of the article to delete
 988      */
 989     public function delArticle($aid)
 990     {
 991         $this->fetchArticles();
 992
 993         XDB::execute('DELETE FROM newsletter_art WHERE id={?} AND aid={?}', $this->id, $aid);
 994         foreach ($this->arts as $key=>$art) {
 995             unset($this->arts[$key][$aid]);
 996         }
 997     }
 998
 999     // }}}
1000     // {{{ Display
1001
1002     /** Retrieve the title of this issue
1003      * @p $mail Whether we want the normal title or the email subject
1004      * @return Title of the issue
1005      */
1006     public function title($mail = false)
1007     {
1008         return $mail ? $this->title_mail : $this->title;
1009     }
1010
1011     /** Retrieve the head of this issue
1012      * @p $user User for <dear> customization (may be null: no customization)
1013      * @p $type Either 'text' or 'html'
1014      * @return Formatted head of the issue.
1015      */
1016     public function head($user = null, $type = 'text')
1017     {
1018         if (is_null($user)) {
1019             return $this->head;
1020         } else {
1021             $head = $this->head;
1022             $head = str_replace(array('<cher>', '<prenom>', '<nom>'),
1023                                 array(($user->isFemale() ? 'Chère' : 'Cher'), $user->displayName(), ''),
1024                                 $head);
1025             return format_text($head, $type, 2, 64);
1026         }
1027     }
1028
1029     /** Retrieve the formatted signature of this issue.
1030      */
1031     public function signature($type = 'text')
1032     {
1033         return format_text($this->signature, $type, 2, 64);
1034     }
1035
1036     /** Get the title of a given category
1037      * @p $cid ID of the category to retrieve
1038      * @return Name of the category
1039      */
1040     public function category($cid)
1041     {
1042         return $this->nl->cats[$cid];
1043     }
1044
1045     /** Add required data to the given $page for proper CSS display
1046      * @p $page Smarty object
1047      * @return Either 'true' (if CSS was added to a page) or the raw CSS to add (when $page is null)
1048      */
1049     public function css($page = null)
1050     {
1051         if (!is_null($page)) {
1052             $page->addCssLink($this->nl->cssFile());
1053             return true;
1054         } else {
1055             $css = file_get_contents(dirname(__FILE__) . '/../htdocs/css/' . $this->nl->cssFile());
1056             return preg_replace('@/\*.*?\*/@us', '', $css);
1057         }
1058     }
1059
1060     /** Set up a smarty page for a 'text' mode render of the issue
1061      * @p $page Smarty object (using the $this->nl->tplFile() template)
1062      * @p $user User to use when rendering the template
1063      */
1064     public function toText($page, $user)
1065     {
1066         $this->fetchArticles();
1067
1068         $this->css($page);
1069         $page->assign('prefix', null);
1070         $page->assign('is_mail', false);
1071         $page->assign('mail_part', 'text');
1072         $page->assign('user', $user);
1073         $page->assign('hash', null);
1074         $this->assignData($page);
1075     }
1076
1077     /** Set up a smarty page for a 'html' mode render of the issue
1078      * @p $page Smarty object (using the $this->nl->tplFile() template)
1079      * @p $user User to use when rendering the template
1080      */
1081     public function toHtml($page, $user)
1082     {
1083         $this->fetchArticles();
1084
1085         $this->css($page);
1086         $page->assign('prefix', $this->nl->prefix() . '/show/' . $this->id());
1087         $page->assign('is_mail', false);
1088         $page->assign('mail_part', 'html');
1089         $page->assign('user', $user);
1090         $page->assign('hash', null);
1091         $this->assignData($page);
1092     }
1093
1094     /** Set all 'common' data for the page (those which are required for both web and email rendering)
1095      * @p $smarty Smarty object (e.g page) which should be filled
1096      */
1097     protected function assignData($smarty)
1098     {
1099         $this->fetchArticles();
1100
1101         $smarty->assign_by_ref('issue', $this);
1102         $smarty->assign_by_ref('nl', $this->nl);
1103     }
1104
1105     // }}}
1106     // {{{ Mailing
1107
1108     /** Check whether this issue is empty
1109      * An issue is empty if the email has no title (or the default one), or no articles and an empty head.
1110      */
1111     public function isEmpty()
1112     {
1113         return $this->title_mail == '' || $this->title_mail == 'to be continued' || (count($this->arts) == 0 && strlen($this->head) == 0);
1114     }
1115
1116     /** Retrieve the 'Send before' date, in a clean format.
1117      */
1118     public function getSendBeforeDate()
1119     {
1120         return strftime('%Y-%m-%d', strtotime($this->send_before));
1121     }
1122
1123     /** Retrieve the 'Send before' time (i.e hour), in a clean format.
1124      */
1125     public function getSendBeforeTime()
1126     {
1127         return strtotime($this->send_before);
1128     }
1129
1130     /** Create a hash based on some additional data
1131      * $line Line-specific data (to prevent two hashes generated at the same time to be the same)
1132      */
1133     protected static function createHash($line)
1134     {
1135         $hash = implode(time(), $line) . rand();
1136         $hash = md5($hash);
1137         return $hash;
1138     }
1139
1140     /** Send this issue to the given user, reusing an existing hash if provided.
1141      * @p $user User to whom the issue should be mailed
1142      * @p $hash Optional hash to use in the 'unsubscribe' link; if null, another one will be generated.
1143      */
1144     public function sendTo($user, $hash = null)
1145     {
1146         $this->fetchArticles();
1147
1148         if (is_null($hash)) {
1149             $hash = XDB::fetchOneCell("SELECT  hash
1150                                          FROM  newsletter_ins
1151                                         WHERE  uid = {?} AND nlid = {?}",
1152                                       $user->id(), $this->nl->id);
1153         }
1154         if (is_null($hash)) {
1155             $hash = self::createHash(array($user->displayName(), $user->fullName(),
1156                                        $user->isFemale(), $user->isEmailFormatHtml(),
1157                                        rand(), "X.org rulez"));
1158             XDB::execute("UPDATE  newsletter_ins as ni
1159                              SET  ni.hash = {?}
1160                            WHERE  ni.uid = {?} AND ni.nlid = {?}",
1161                          $hash, $user->id(), $this->nl->id);
1162         }
1163
1164         $mailer = new PlMailer($this->nl->tplFile());
1165         $this->assignData($mailer);
1166         $mailer->assign('is_mail', true);
1167         $mailer->assign('user', $user);
1168         $mailer->assign('prefix',  null);
1169         $mailer->assign('hash',    $hash);
1170         $mailer->sendTo($user);
1171     }
1172
1173     /** Select a subset of subscribers which should receive the newsletter.
1174      * NL-Specific selections (not yet received, is subscribed) are done when sending.
1175      * @return A PlFilterCondition.
1176      */
1177     protected function getRecipientsUFC()
1178     {
1179         return $this->sufb->getUFC();
1180     }
1181
1182     /** Check whether a given user may see this issue.
1183      * @p $user User whose access should be checked
1184      * @return Whether he may access the issue
1185      */
1186     public function checkUser($user = null)
1187     {
1188         if ($user == null) {
1189             $user = S::user();
1190         }
1191         $uf = new UserFilter($this->getRecipientsUFC());
1192         return $uf->checkUser($user);
1193     }
1194
1195     /** Sent this issue to all valid recipients
1196      * @return Number of issues sent
1197      */
1198     public function sendToAll()
1199     {
1200         $this->fetchArticles();
1201
1202         XDB::execute('UPDATE  newsletter_issues
1203                          SET  state = \'sent\', date=CURDATE()
1204                        WHERE  id = {?}',
1205                        $this->id);
1206
1207         $ufc = new PFC_And($this->getRecipientsUFC(), new UFC_NLSubscribed($this->nl->id, $this->id), new UFC_HasValidEmail());
1208         $uf = new UserFilter($ufc, array(new UFO_IsAdmin(), new UFO_Uid()));
1209         $limit = new PlLimit(self::BATCH_SIZE);
1210         $global_sent = array();
1211
1212         while (true) {
1213             $sent = array();
1214             $users = $uf->getUsers($limit);
1215             if (count($users) == 0) {
1216                 break;
1217             }
1218             foreach ($users as $user) {
1219                 if (array_key_exists($user->id(), $global_sent)) {
1220                     Platal::kill('Sending the same newsletter issue ' . $this->id . ' to user ' . $user->id() . ' twice, something must be wrong.');
1221                 }
1222                 $sent[] = $user->id();
1223                 $global_sent[$user->id()] = true;
1224                 $this->sendTo($user, $hash);
1225             }
1226             XDB::execute("UPDATE  newsletter_ins
1227                              SET  last = {?}
1228                            WHERE  nlid = {?} AND uid IN {?}", $this->id, $this->nl->id, $sent);
1229
1230             sleep(60);
1231         }
1232         return count($global_sent);
1233     }
1234
1235     // }}}
1236 }
1237
1238 // }}}
1239 // {{{ class NLArticle
1240
1241 class NLArticle
1242 {
1243     // Maximum number of lines per article
1244     const MAX_LINES_PER_ARTICLE = 8;
1245     const MAX_CHARACTERS_PER_LINE = 68;
1246
1247     // {{{ properties
1248
1249     public $aid;
1250     public $cid;
1251     public $pos;
1252     public $title;
1253     public $body;
1254     public $append;
1255
1256     // }}}
1257     // {{{ constructor
1258
1259     function __construct($title='', $body='', $append='', $aid=-1, $cid=0, $pos=0)
1260     {
1261         $this->body   = $body;
1262         $this->title  = $title;
1263         $this->append = $append;
1264         $this->aid    = $aid;
1265         $this->cid    = $cid;
1266         $this->pos    = $pos;
1267     }
1268
1269     // }}}
1270     // {{{ function title()
1271
1272     public function title()
1273     { return trim($this->title); }
1274
1275     // }}}
1276     // {{{ function body()
1277
1278     public function body()
1279     { return trim($this->body); }
1280
1281     // }}}
1282     // {{{ function append()
1283
1284     public function append()
1285     { return trim($this->append); }
1286
1287     // }}}
1288     // {{{ function toText()
1289
1290     public function toText($hash = null, $login = null)
1291     {
1292         $title = '*'.$this->title().'*';
1293         $body = MiniWiki::WikiToText($this->body, true);
1294         $app = MiniWiki::WikiToText($this->append, false, 4);
1295         $text = trim("$title\n\n$body\n\n$app")."\n";
1296         if (!is_null($hash) && !is_null($login)) {
1297             $text = str_replace('%HASH%', "$hash/$login", $text);
1298         } else {
1299             $text = str_replace('%HASH%', '', $text);
1300         }
1301         return $text;
1302     }
1303
1304     // }}}
1305     // {{{ function toHtml()
1306
1307     public function toHtml($hash = null, $login = null)
1308     {
1309         $title = "<h2 class='xorg_nl'><a id='art{$this->aid}'></a>".pl_entities($this->title()).'</h2>';
1310         $body  = MiniWiki::WikiToHTML($this->body);
1311         $app   = MiniWiki::WikiToHTML($this->append);
1312
1313         $art   = "$title\n";
1314         $art  .= "<div class='art'>\n$body\n";
1315         if ($app) {
1316             $art .= "<div class='app'>$app</div>";
1317         }
1318         $art  .= "</div>\n";
1319         if (!is_null($hash) && !is_null($login)) {
1320             $art = str_replace('%HASH%', "$hash/$login", $art);
1321         } else {
1322             $art = str_replace('%HASH%', '', $art);
1323         }
1324
1325         return $art;
1326     }
1327
1328     // }}}
1329     // {{{ function check()
1330
1331     public function check()
1332     {
1333         $rest = $this->remain();
1334
1335         return $rest['remaining_lines'] >= 0;
1336     }
1337
1338     // }}}
1339     // {{{ function remain()
1340
1341     public function remain()
1342     {
1343         $text  = MiniWiki::WikiToText($this->body);
1344         $array = explode("\n", wordwrap($text, self::MAX_CHARACTERS_PER_LINE));
1345         $lines_count = 0;
1346         foreach ($array as $line) {
1347             if (trim($line) != '') {
1348                 ++$lines_count;
1349             }
1350         }
1351
1352         return array(
1353             'remaining_lines'                    => self::MAX_LINES_PER_ARTICLE - $lines_count,
1354             'remaining_characters_for_last_line' => self::MAX_CHARACTERS_PER_LINE - strlen($array[count($array) - 1])
1355        );
1356     }
1357     // }}}
1358     // {{{ function parseUrlsFromArticle()
1359
1360     protected function parseUrlsFromArticle()
1361     {
1362         $email_regex = '([a-z0-9.\-+_\$]+@([\-.+_]?[a-z0-9])+)';
1363         $url_regex = '((https?|ftp)://[a-zA-Z0-9._%#+/?=&~-]+)';
1364         $regex = '{' . $email_regex . '|' . $url_regex . '}i';
1365
1366         $matches = array();
1367         $body_matches = array();
1368         if (preg_match_all($regex, $this->body(), $body_matches)) {
1369             $matches = array_merge($matches, $body_matches[0]);
1370         }
1371
1372         $append_matches = array();
1373         if (preg_match_all($regex, $this->append(), $append_matches)) {
1374             $matches = array_merge($matches, $append_matches[0]);
1375         }
1376
1377         return $matches;
1378     }
1379
1380     // }}}
1381     // {{{ function getLinkIps()
1382
1383     public function getLinkIps(&$blacklist_host_resolution_count)
1384     {
1385         $matches = $this->parseUrlsFromArticle();
1386         $article_ips = array();
1387
1388         if (!empty($matches)) {
1389             global $globals;
1390
1391             foreach ($matches as $match) {
1392                 $host = parse_url($match, PHP_URL_HOST);
1393                 if ($host == '') {
1394                     list(, $host) = explode('@', $match);
1395                 }
1396
1397                 if ($blacklist_host_resolution_count >= $globals->mail->blacklist_host_resolution_limit) {
1398                    break;
1399                 }
1400
1401                 if (!preg_match('/^(' . str_replace(' ', '|', $globals->mail->domain_whitelist) . ')$/i', $host)) {
1402                     $article_ips = array_merge($article_ips, array(gethostbyname($host) => $host));
1403                     ++$blacklist_host_resolution_count;
1404                 }
1405             }
1406         }
1407
1408         return $article_ips;
1409     }
1410
1411     // }}}
1412 }
1413
1414 // }}}
1415
1416 // {{{ Functions
1417
1418 function format_text($input, $format, $indent = 0, $width = 68)
1419 {
1420     if ($format == 'text') {
1421         return MiniWiki::WikiToText($input, true, $indent, $width, "title");
1422     }
1423     return MiniWiki::WikiToHTML($input, "title");
1424 }
1425
1426 // function enriched_to_text($input,$html=false,$just=false,$indent=0,$width=68)
1427
1428 // }}}
1429
1430 // vim:set et sw=4 sts=4 sws=4 enc=utf-8:
1431 ?>