banana/spool.inc.php

   1 <?php
   2 /********************************************************************************
   3 * include/spool.inc.php : spool subroutines
   4 * -----------------------
   5 *
   6 * This file is part of the banana distribution
   7 * Copyright: See COPYING files that comes with this distribution
   8 ********************************************************************************/
   9
  10 require_once dirname(__FILE__) . '/banana.inc.php';
  11 require_once dirname(__FILE__) . '/tree.inc.php';
  12
  13 define('BANANA_SPOOL_VERSION', '0.5.14');
  14
  15 /** Class spoolhead
  16  *  class used in thread overviews
  17  */
  18 class BananaSpoolHead
  19 {
  20     public $id;
  21     public $msgid;
  22
  23     /** date (timestamp) */
  24     public $date;
  25     /** subject */
  26     public $subject;
  27     /** author */
  28     public $from;
  29     public $name;
  30     public $color;
  31     /** reference of parent */
  32     public $parent = null;
  33     /** array of children */
  34     public $children = Array();
  35     /** true if post is read */
  36     public $isread;
  37     /** number of posts deeper in this branch of tree */
  38     public $desc;
  39     /**  same as desc, but counts only unread posts */
  40     public $descunread;
  41     /** last time the number of children has been updated */
  42     public $time = 0;
  43
  44     /** storage data */
  45     public $storage = array();
  46
  47     /** constructor
  48      * @param $_date INTEGER timestamp of post
  49      * @param $_subject STRING subject of post
  50      * @param $_from STRING author of post
  51      * @param $_desc INTEGER desc value (1 for a new post)
  52      * @param $_read BOOLEAN true if read
  53      * @param $_descunread INTEGER descunread value (0 for a new post)
  54      */
  55     public function __construct($id, array &$message)
  56     {
  57         $this->id         = $id;
  58         $this->msgid      = @$message['message-id'];
  59         $this->date       = $message['date'];
  60         $this->subject    = @$message['subject'];
  61         $this->from       = $message['from'];
  62         $this->color      = sprintf('#%06x', abs(crc32($this->from) % 0xffffff));
  63         $this->desc       = 1;
  64         $this->isread     = true;
  65         $this->descunread = 0;
  66         if (preg_match("/^([^ ]+@[^ ]+) \((.*)\)$/", $this->from, $regs)) {
  67             $this->name = $regs[2];
  68         }
  69         if (preg_match("/^\"?([^<>\"]+)\"? +<(.+@.+)>$/", $this->from, $regs)) {
  70             $this->name = preg_replace("/^'(.*)'$/", '\1', $regs[1]);
  71             $this->name = stripslashes($this->name);
  72         }
  73         if ($this->name) {
  74             $this->name =  preg_replace("/\\\(\(|\))/","\\1", $this->name);
  75         } else if (preg_match("/([^< ]+)@([^> ]+)/", $this->from, $regs)) {
  76             $this->name = $regs[1];
  77         } else {
  78             $this->name = 'Anonymous';
  79         }
  80     }
  81 }
  82
  83
  84 class BananaSpool
  85 {
  86     private $version;
  87     private $mode;
  88
  89     /**  group name */
  90     public $group;
  91     /**  spool */
  92     public $overview = array();
  93     /**  array msgid => msgnum */
  94     public $ids      = array();
  95     /** thread starts */
  96     public $roots    = array();
  97
  98     /** protocole specific data */
  99     public $storage = array();
 100
 101     private $unreadnb = 0;
 102
 103     /** constructor
 104      * @param $_group STRING group name
 105      * @param $_display INTEGER 1 => all posts, 2 => only threads with new posts
 106      * @param $_since INTEGER time stamp (used for read/unread)
 107      */
 108     protected function __construct($group)
 109     {
 110         $this->version    = BANANA_SPOOL_VERSION;
 111         $this->mode       = Banana::SPOOL_ALL;
 112         $this->group      = $group;
 113     }
 114
 115     public static function &getSpool($group, $since = 0, $clean = false)
 116     {
 117         if (!is_null(Banana::$spool) && Banana::$spool->group == $group) {
 118             $spool =& Banana::$spool;
 119         } else {
 120             $spool =& BananaSpool::readFromFile($group);
 121         }
 122         if (is_null($spool)) {
 123             $spool = new BananaSpool($group);
 124         }
 125         Banana::$spool =& $spool;
 126         $spool->build();
 127         if ($clean) {
 128             $spool->markAllAsRead();
 129         }
 130         $spool->updateUnread($since);
 131         return $spool;
 132     }
 133
 134     public static function getPath($file = null)
 135     {
 136         $path = Banana::$spool_root . '/' . Banana::$protocole->name() . '/' . Banana::$protocole->filename();
 137         if (!is_dir($path)) {
 138             if (file_exists($path)) {
 139                 @unlink($path);
 140             }
 141             mkdir($path, 0777, true);
 142         }
 143         return $path . '/' . $file;
 144     }
 145
 146     private static function spoolFilename()
 147     {
 148         return BananaSpool::getPath('spool');
 149     }
 150
 151     private static function &readFromFile($group)
 152     {
 153         $spool = null;
 154         $file = BananaSpool::spoolFilename();
 155         if (!file_exists($file)) {
 156             return $spool;
 157         }
 158         $spool =  unserialize(file_get_contents($file));
 159         if ($spool->version != BANANA_SPOOL_VERSION || $spool->mode != Banana::SPOOL_ALL) {
 160             $spool = null;
 161             return $spool;
 162         }
 163         $spool->markAllAsRead();
 164         return $spool;
 165     }
 166
 167     private function compare($a, $b)
 168     {
 169         return ($b->date - $a->date);
 170     }
 171
 172     private function saveToFile()
 173     {
 174         $file = BananaSpool::spoolFilename();
 175
 176         $this->roots = Array();
 177         foreach($this->overview as &$msg) {
 178             if (is_null($msg->parent)) {
 179                 $this->roots[] =& $msg;
 180             }
 181         }
 182         usort($this->roots, array($this, 'compare'));
 183
 184         if ($this->mode == Banana::SPOOL_ALL) {
 185             file_put_contents($file, serialize($this));
 186         }
 187     }
 188
 189     private function build()
 190     {
 191         $threshold = 0;
 192
 193         // Compute the range of indexes
 194         list($msgnum, $first, $last) = Banana::$protocole->getIndexes();
 195         if ($last < $first) {
 196             $threshold = $first + $msgnum - $last;
 197             $threshold = (int)(log($threshold)/log(2));
 198             $threshold = (2 ^ ($threshold + 1)) - 1;
 199         }
 200         if (Banana::$spool_max && Banana::$spool_max < $msgnum) {
 201             $first = $last - Banana::$spool_max;
 202             if ($first < 0) {
 203                 $first += $threshold;
 204             }
 205         }
 206         $clean  = $this->clean($first, $last, $msgnum);
 207         $update = $this->update($first, $last, $msgnum);
 208
 209         if ($clean || $update) {
 210             $this->saveToFile();
 211         }
 212     }
 213
 214     private function clean(&$first, &$last, $msgnum)
 215     {
 216         $do_save = false;
 217         if (!empty($this->overview)) {
 218             $mids = array_keys($this->overview);
 219             foreach ($mids as $id) {
 220                 if (($first <= $last && ($id < $first || $id > $last))
 221                         || ($first > $last && $id < $first && $id > $last)) {
 222                     $this->delid($id, false);
 223                     $do_save = true;
 224                 }
 225             }
 226             if (!empty($this->overview)) {
 227                 $first = max(array_keys($this->overview))+1;
 228             }
 229         }
 230         return $do_save;
 231     }
 232
 233     private function update(&$first, &$last, $msgnum)
 234     {
 235         if ($first > $last || !$msgnum) {
 236             return false;
 237         }
 238
 239         $messages =& Banana::$protocole->getMessageHeaders($first, $last,
 240             array('Date', 'Subject', 'From', 'Message-ID', 'References', 'In-Reply-To'));
 241
 242         // Build all the new Spool Heads
 243         $time = time();
 244         foreach ($messages as $id=>&$message) {
 245             if (!isset($this->overview[$id])) {
 246                 $this->overview[$id] = new BananaSpoolHead($id, $message);
 247                 $head =& $this->overview[$id];
 248                 $this->ids[$head->msgid] =& $head;
 249                 $head->time = $time;
 250             }
 251         }
 252
 253         // Build tree
 254         $null = null;
 255         foreach ($messages as $id=>&$message) {
 256             $msg         =& $this->overview[$id];
 257             $parents     =& $this->getReferences($message);
 258             while (!empty($parents) && ($msg->parent === $msg || is_null($msg->parent))) {
 259                 @$msg->parent =& array_pop($parents);
 260             }
 261
 262             if (!is_null($msg->parent)) {
 263                 $parent =& $msg->parent;
 264                 $parent->children[] =& $msg;
 265                 while (!is_null($parent)) {
 266                     $parent->desc += $msg->desc;
 267                     $parent->time  = $time;
 268                     $prev =& $parent;
 269                     if ($parent !== $parent->parent) {
 270                         $parent =& $parent->parent;
 271                     } else {
 272                         $parent =& $null;
 273                     }
 274                 }
 275             }
 276         }
 277         Banana::$protocole->updateSpool($messages);
 278         return true;
 279     }
 280
 281     public function updateUnread($since)
 282     {
 283         if (empty($since)) {
 284             return;
 285         }
 286
 287         $newpostsids = Banana::$protocole->getNewIndexes($since);
 288
 289         if (empty($newpostsids)) {
 290             return;
 291         }
 292
 293         $newpostsids = array_intersect($newpostsids, array_keys($this->ids));
 294         foreach ($newpostsids as $mid) {
 295             $overview =& $this->ids[$mid];
 296             if ($overview->isread) {
 297                 $overview->isread = false;
 298                 while (!is_null($overview)) {
 299                     $overview->descunread++;
 300                     $overview =& $overview->parent;
 301                 }
 302             }
 303         }
 304         $this->unreadnb += count($newpostsids);
 305
 306         if (function_exists('hook_listReadMessages')) {
 307             $msgs = hook_listReadMessages($this->group);
 308             if (!is_array($msgs)) {
 309                 return;
 310             }
 311             foreach ($msgs as $msg) {
 312                 if (!is_numeric($msg)) {
 313                     if (!isset($this->ids[$msg])) {
 314                         continue;
 315                     }
 316                     $msg = $this->ids[$msg];
 317                 }
 318                 $this->markAsRead($msg);
 319             }
 320         }
 321     }
 322
 323     public function setMode($mode)
 324     {
 325         $this->mode = $mode;
 326         switch ($mode) {
 327           case Banana::SPOOL_UNREAD:
 328             $num = max(array_keys($this->overview));
 329             if ($this->overview[$num]->isread) {
 330                 break;
 331             }
 332             foreach ($this->roots as &$root) {
 333                 if ($root->descunread == 0) {
 334                     $this->killdesc($root->id);
 335                 }
 336             }
 337             break;
 338         }
 339     }
 340
 341     /** Fetch list of references
 342      */
 343     public function &getReferences(array &$refs)
 344     {
 345         $references = array();
 346         if (isset($refs['references'])) {
 347             $text = preg_split('/\s/', str_replace('><', '> <', $refs['references']));
 348             foreach ($text as $id=>&$value) {
 349                 if (isset($this->ids[$value])) {
 350                     $references[] =& $this->ids[$value];
 351                 }
 352             }
 353         } elseif (isset($refs['in-reply-to']) && isset($this->ids[$refs['in-reply-to']])) {
 354             $references[] =& $this->ids[$refs['in-reply-to']];
 355         }
 356         return $references;
 357     }
 358
 359     /** Get the tree associated to a given id
 360      */
 361     public function &getTree($id)
 362     {
 363         return BananaTree::build($id)->show();
 364     }
 365
 366     /** Mark the given id as read
 367      * @param id MSGNUM of post
 368      */
 369     public function markAsRead($id)
 370     {
 371         $overview =& $this->overview[$id];
 372         if (!$overview->isread) {
 373             $overview->isread = true;
 374             $this->unreadnb--;
 375             while (!is_null($overview)) {
 376                 $overview->descunread--;
 377                 $overview =& $overview->parent;
 378             }
 379         }
 380     }
 381
 382     /** Mark all unread messages as read
 383      */
 384     public function markAllAsRead(array &$array = null)
 385     {
 386         if (!$this->unreadnb) {
 387             return;
 388         }
 389         if (is_null($array) && !empty($this->roots)) {
 390             $array =& $this->roots;
 391         } elseif (is_null($array)) {
 392             return;
 393         }
 394         foreach ($array as &$msg) {
 395             if (!$msg->isread) {
 396                 $this->markAsRead($msg->id);
 397                 if (!$this->unreadnb) {
 398                     return;
 399                 }
 400             }
 401             if ($msg->descunread) {
 402                 $this->markAllAsRead($msg->children);
 403             }
 404         }
 405     }
 406
 407     /** kill post and childrens
 408      * @param $_id MSGNUM of post
 409      */
 410     private function killdesc($_id)
 411     {
 412         $overview =& $this->overview[$_id];
 413         $children =& $overview->children;
 414         if (sizeof($children)) {
 415             foreach ($children as &$c) {
 416                 $this->killdesc($c->id);
 417             }
 418         }
 419         unset($this->overview[$_id]);
 420         foreach ($this->roots as $k=>&$root) {
 421             if ($root === $overview) {
 422                 unset($this->roots[$k]);
 423                 break;
 424             }
 425         }
 426         unset($this->ids[$overview->msgid]);
 427         $overview = null;
 428     }
 429
 430     /** delete a post from overview
 431      * @param $_id MSGNUM of post
 432      */
 433     public function delid($_id, $write = true)
 434     {
 435         if (!isset($this->overview[$_id])) {
 436             return;
 437         }
 438
 439         $overview =& $this->overview[$_id];
 440         // Be sure it is not counted as unread
 441         if (!$overview->isread) {
 442             $this->markAsRead($_id);
 443         }
 444
 445         $parent =& $overview->parent;
 446
 447         // Remove from the message tree
 448         if (!is_null($parent)) {
 449             $time = time();
 450             foreach ($parent->children as $key=>&$child) {
 451                 if ($child === $overview) {
 452                     unset($parent->children[$key]);
 453                     break;
 454                 }
 455             }
 456             if (sizeof($overview->children)) {
 457                 foreach ($overview->children as &$child) {
 458                     $parent->children[] =& $child;
 459                     $child->time   = $time;
 460                     $child->parent =& $parent;
 461                 }
 462             }
 463             while (!is_null($parent)) {
 464                 $parent->desc--;
 465                 $parent->time = $time;
 466                 $parent =& $parent->parent;
 467             }
 468         }
 469
 470         // Remove all refenrences and assign null to the object
 471         unset($this->ids[$overview->msgid]);
 472         unset($this->overview[$_id]);
 473         BananaTree::kill($_id);
 474         foreach ($this->roots as $k=>&$root) {
 475             if ($root === $overview) {
 476                 unset($this->roots[$k]);
 477                 break;
 478             }
 479         }
 480         $overview = null;
 481
 482         if ($write) {
 483             $this->saveToFile();
 484         }
 485     }
 486
 487     public function formatDate(BananaSpoolHead $head)
 488     {
 489         $stamp  = $head->date;
 490         $today  = intval(time() / (24*3600));
 491         $dday   = intval($stamp / (24*3600));
 492
 493         if ($today == $dday) {
 494             $format = "%H:%M";
 495         } elseif ($today == 1 + $dday) {
 496             $format = _b_('hier')." %H:%M";
 497         } elseif ($today < 7 + $dday) {
 498             $format = '%a %H:%M';
 499         } elseif ($today < 90 + $dday) {
 500             $format = '%a %e %b';
 501         } else {
 502             $format = '%a %e %b %Y';
 503         }
 504         return strftime($format, $stamp);
 505     }
 506
 507     public function formatSubject(BananaSpoolHead $head)
 508     {
 509         $subject = $popup = $head->subject;
 510         $popup = $subject;
 511         if (function_exists('hook_formatDisplayHeader')) {
 512             list($subject, $link) = hook_formatDisplayHeader('subject', $subject, true);
 513         } else {
 514             $subject = banana_catchFormats(banana_entities(stripslashes($subject)));
 515             $link = null;
 516         }
 517         if (empty($subject)) {
 518             $subject = _b_('(pas de sujet)');
 519         }
 520         if (mb_strlen($subject) > 100) {
 521             $subject = mb_substr($subject, 0, 99) . '&hellip;';
 522         }
 523         if ($head->id !== Banana::$artid) {
 524             $subject = Banana::$page->makeLink(Array('group' => $this->group, 'artid' => $head->id,
 525                                                      'text'  => $subject, 'popup' => $popup));
 526         }
 527         return $subject . $link;
 528     }
 529
 530     public function formatFrom(BananaSpoolHead $head)
 531     {
 532         return BananaMessage::formatFrom($head->from);
 533     }
 534
 535     public function start()
 536     {
 537         if (Banana::$first) {
 538             return Banana::$first;
 539         } else {
 540             $first = array_search(Banana::$artid, $this->roots);
 541             return max(0, $first - Banana::$spool_tbefore);
 542         }
 543     }
 544
 545     public function context()
 546     {
 547         return Banana::$first ? Banana::$spool_tmax : Banana::$spool_tcontext;
 548     }
 549
 550     /** Return root message of the given thread
 551      * @param id INTEGER id of a message
 552      */
 553     public function &root($id)
 554     {
 555         $parent =& $this->overview[$id];
 556         while (!is_null($parent->parent)) {
 557             $parent =& $parent->parent;
 558         }
 559         return $parent;
 560     }
 561
 562     /** Return the last post id with the given subject
 563      * @param subject
 564      */
 565     public function getPostId($subject)
 566     {
 567         $subject = trim($subject);
 568         $id = max(array_keys($this->overview));
 569         while (isset($this->overview[$id])) {
 570             $test = $this->overview[$id]->subject;
 571             if (function_exists('hook_formatDisplayHeader')) {
 572                 $val = hook_formatDisplayHeader('subject', $test, true);
 573                 if (is_array($val)) {
 574                     $test = banana_html_entity_decode($val[0]);
 575                 } else {
 576                     $test = banana_html_entity_decode($val);
 577                 }
 578             }
 579             $test = trim($test);
 580             if ($test == $subject) {
 581                 return $id;
 582             }
 583             $id--;
 584         }
 585         return -1;
 586     }
 587
 588     /** Returns previous thread root index
 589      * @param id INTEGER message number
 590      */
 591     public function prevThread($id)
 592     {
 593         $root =& $this->root($id);
 594         $last = null;
 595         foreach ($this->roots as &$i) {
 596             if ($i === $root) {
 597                 return $last;
 598             }
 599             $last = $i->id;
 600         }
 601         return $last;
 602     }
 603
 604     /** Returns next thread root index
 605      * @param id INTEGER message number
 606      */
 607     public function nextThread($id)
 608     {
 609         $root =& $this->root($id);
 610         $ok   = false;
 611         foreach ($this->roots as &$i) {
 612             if ($ok) {
 613                 return $i->id;
 614             }
 615             if ($i === $root) {
 616                 $ok = true;
 617             }
 618         }
 619         return null;
 620     }
 621
 622     /** Return prev post in the thread
 623      * @param id INTEGER message number
 624      */
 625     public function prevPost($id)
 626     {
 627         $parent =& $this->overview[$id]->parent;
 628         if (is_null($parent)) {
 629             return null;
 630         }
 631         $last = $parent->id;
 632         foreach ($parent->children as &$child) {
 633             if ($child->id == $id) {
 634                 return $last;
 635             }
 636             $last = $child->id;
 637         }
 638         return null;
 639     }
 640
 641     /** Return next post in the thread
 642      * @param id INTEGER message number
 643      */
 644     public function nextPost($id)
 645     {
 646         $cur =& $this->overview[$id];
 647         if (count($cur->children) != 0) {
 648             return $cur->children[0]->id;
 649         }
 650
 651         $parent =& $cur;
 652         while (true) {
 653             $parent =& $cur->parent;
 654             if (is_null($parent)) {
 655                 return null;
 656             }
 657             $ok = false;
 658             foreach ($parent->children as &$child) {
 659                 if ($ok) {
 660                     return $child->id;
 661                 }
 662                 if ($child === $cur) {
 663                     $ok = true;
 664                 }
 665             }
 666             $cur =& $parent;
 667         }
 668         return null;
 669     }
 670
 671     /** Look for an unread message in the thread rooted by the message
 672      * @param id INTEGER message number
 673      */
 674     private function _nextUnread(BananaSpoolHead $cur)
 675     {
 676         if (!$cur->isread) {
 677             return $cur->id;
 678         }
 679         foreach ($cur->children as &$child) {
 680             $unread = $this->_nextUnread($child);
 681             if (!is_null($unread)) {
 682                 return $unread;
 683             }
 684         }
 685         return null;
 686     }
 687
 688     /** Find next unread message
 689      * @param id INTEGER message number
 690      */
 691     public function nextUnread($id = null)
 692     {
 693         if (!$this->unreadnb) {
 694             return null;
 695         }
 696
 697         if (!is_null($id)) {
 698             // Look in message children
 699             foreach ($this->overview[$id]->children as &$child) {
 700                 $next = $this->_nextUnread($child);
 701                 if (!is_null($next)) {
 702                     return $next;
 703                 }
 704             }
 705         }
 706
 707         // Look in current thread
 708         if (is_null($id)) {
 709             $cur = null;
 710         } else {
 711             $cur =& $this->overview[$id];
 712         }
 713         do {
 714             if (is_null($cur)) {
 715                 $parent =& $cur;
 716                 $ok     = true;
 717             } else {
 718                 $parent =& $cur->parent;
 719                 $ok     =  false;
 720             }
 721             if (!is_null($parent)) {
 722                 $array =& $parent->children;
 723             } else {
 724                 $array =& $this->roots;
 725             }
 726             foreach ($array as &$child) {
 727                 if ($ok) {
 728                     $next = $this->_nextUnread($child);
 729                     if (!is_null($next)) {
 730                         return $next;
 731                     }
 732                 }
 733                 if ($child === $cur) {
 734                     $ok = true;
 735                 }
 736             }
 737             $cur =& $parent;
 738         } while(!is_null($cur));
 739         return null;
 740     }
 741 }
 742 // vim:set et sw=4 sts=4 ts=4 enc=utf-8:
 743 ?>