efb2a044929581343d4511b0f05fe45e91dc9ae7
2 /********************************************************************************
3 * include/spool.inc.php : spool subroutines
4 * -----------------------
6 * This file is part of the banana distribution
7 * Copyright: See COPYING files that comes with this distribution
8 ********************************************************************************/
10 require_once dirname(__FILE__
) . '/banana.inc.php';
11 require_once dirname(__FILE__
) . '/tree.inc.php';
13 define('BANANA_SPOOL_VERSION', '0.5.14');
16 * class used in thread overviews
23 /** date (timestamp) */
31 /** reference of parent */
32 public $parent = null
;
33 /** array of children */
34 public $children = Array();
35 /** true if post is read */
37 /** number of posts deeper in this branch of tree */
39 /** same as desc, but counts only unread posts */
41 /** last time the number of children has been updated */
45 public $storage = array();
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)
55 public function __construct($id, array &$message)
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));
65 $this->descunread
= 0;
66 if (preg_match("/^([^ ]+@[^ ]+) \((.*)\)$/", $this->from
, $regs)) {
67 $this->name
= $regs[2];
69 if (preg_match("/^\"?([^<>\"]+)\"? +<(.+@.+)>$/", $this->from
, $regs)) {
70 $this->name
= preg_replace("/^'(.*)'$/", '\1', $regs[1]);
71 $this->name
= stripslashes($this->name
);
74 $this->name
= preg_replace("/\\\(\(|\))/","\\1", $this->name
);
75 } else if (preg_match("/([^< ]+)@([^> ]+)/", $this->from
, $regs)) {
76 $this->name
= $regs[1];
78 $this->name
= 'Anonymous';
92 public $overview = array();
93 /** array msgid => msgnum */
94 public $ids = array();
96 public $roots = array();
98 /** protocole specific data */
99 public $storage = array();
101 private $unreadnb = 0;
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)
108 protected function __construct($group)
110 $this->version
= BANANA_SPOOL_VERSION
;
111 $this->mode
= Banana
::SPOOL_ALL
;
112 $this->group
= $group;
115 public static function &getSpool($group, $since = 0, $clean = false
)
117 if (!is_null(Banana
::$spool) && Banana
::$spool->group
== $group) {
118 $spool =& Banana
::$spool;
120 $spool =& BananaSpool
::readFromFile($group);
122 if (is_null($spool)) {
123 $spool = new BananaSpool($group);
125 Banana
::$spool =& $spool;
128 $spool->markAllAsRead();
130 $spool->updateUnread($since);
134 public static function getPath($file = null
)
136 $path = Banana
::$spool_root . '/' . Banana
::$protocole->name() . '/' . Banana
::$protocole->filename();
137 if (!is_dir($path)) {
138 if (file_exists($path)) {
141 mkdir($path, 0777, true
);
143 return $path . '/' . $file;
146 private static function spoolFilename()
148 return BananaSpool
::getPath('spool');
151 private static function &readFromFile($group)
154 $file = BananaSpool
::spoolFilename();
155 if (!file_exists($file)) {
158 $spool = unserialize(file_get_contents($file));
159 if ($spool->version
!= BANANA_SPOOL_VERSION ||
$spool->mode
!= Banana
::SPOOL_ALL
) {
163 $spool->markAllAsRead();
167 private function compare(&$a, &$b)
169 return ($b->date
- $a->date
);
172 private function saveToFile()
174 $file = BananaSpool
::spoolFilename();
176 $this->roots
= Array();
177 foreach($this->overview
as &$msg) {
178 if (is_null($msg->parent
)) {
179 $this->roots
[] =& $msg;
182 usort($this->roots
, array($this, 'compare'));
184 if ($this->mode
== Banana
::SPOOL_ALL
) {
185 file_put_contents($file, serialize($this));
189 private function build()
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;
200 if (Banana
::$spool_max && Banana
::$spool_max < $msgnum) {
201 $first = $last - Banana
::$spool_max;
203 $first +
= $threshold;
206 $clean = $this->clean($first, $last, $msgnum);
207 $update = $this->update($first, $last, $msgnum);
209 if ($clean ||
$update) {
214 private function clean(&$first, &$last, $msgnum)
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
);
226 if (!empty($this->overview
)) {
227 $first = max(array_keys($this->overview
))+
1;
233 private function update(&$first, &$last, $msgnum)
235 if ($first > $last ||
!$msgnum) {
239 $messages =& Banana
::$protocole->getMessageHeaders($first, $last,
240 array('Date', 'Subject', 'From', 'Message-ID', 'References', 'In-Reply-To'));
242 // Build all the new Spool Heads
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;
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);
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;
269 if ($parent !== $parent->parent
) {
270 $parent =& $parent->parent
;
277 Banana
::$protocole->updateSpool($messages);
281 public function updateUnread($since)
287 $newpostsids = Banana
::$protocole->getNewIndexes($since);
289 if (empty($newpostsids)) {
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
;
304 $this->unreadnb +
= count($newpostsids);
307 public function setMode($mode)
311 case Banana
::SPOOL_UNREAD
:
312 $num = max(array_keys($this->overview
));
313 if ($this->overview
[$num]->isread
) {
316 foreach ($this->roots
as &$root) {
317 if ($root->descunread
== 0) {
318 $this->killdesc($root->id
);
325 /** Fetch list of references
327 public function &getReferences(array &$refs)
329 $references = array();
330 if (isset($refs['references'])) {
331 $text = preg_split('/\s/', str_replace('><', '> <', $refs['references']));
332 foreach ($text as $id=>&$value) {
333 if (isset($this->ids
[$value])) {
334 $references[] =& $this->ids
[$value];
337 } elseif (isset($refs['in-reply-to']) && isset($this->ids
[$refs['in-reply-to']])) {
338 $references[] =& $this->ids
[$refs['in-reply-to']];
343 /** Get the tree associated to a given id
345 public function &getTree($id)
347 return BananaTree
::build($id)->show();
350 /** Mark the given id as read
351 * @param id MSGNUM of post
353 public function markAsRead($id)
355 $overview =& $this->overview
[$id];
356 if (!$overview->isread
) {
357 $overview->isread
= true
;
359 while (!is_null($overview)) {
360 $overview->descunread
--;
361 $overview =& $overview->parent
;
366 /** Mark all unread messages as read
368 public function markAllAsRead(array &$array = null
)
370 if (!$this->unreadnb
) {
373 if (is_null($array) && !empty($this->roots
)) {
374 $array =& $this->roots
;
375 } elseif (is_null($array)) {
378 foreach ($array as &$msg) {
380 $this->markAsRead($msg->id
);
381 if (!$this->unreadnb
) {
385 if ($msg->descunread
) {
386 $this->markAllAsRead($msg->children
);
391 /** kill post and childrens
392 * @param $_id MSGNUM of post
394 private function killdesc($_id)
396 $overview =& $this->overview
[$_id];
397 $children =& $overview->children
;
398 if (sizeof($children)) {
399 foreach ($children as &$c) {
400 $this->killdesc($c->id
);
403 unset($this->overview
[$_id]);
404 foreach ($this->roots
as $k=>&$root) {
405 if ($root === $overview) {
406 unset($this->roots
[$k]);
410 unset($this->ids
[$overview->msgid
]);
414 /** delete a post from overview
415 * @param $_id MSGNUM of post
417 public function delid($_id, $write = true
)
419 if (!isset($this->overview
[$_id])) {
423 $overview =& $this->overview
[$_id];
424 // Be sure it is not counted as unread
425 if (!$overview->isread
) {
426 $this->markAsRead($_id);
429 $parent =& $overview->parent
;
431 // Remove from the message tree
432 if (!is_null($parent)) {
433 foreach ($parent->children
as $key=>&$child) {
434 if ($child === $overview) {
435 unset($parent->children
[$key]);
439 if (sizeof($overview->children
)) {
440 $parent->children
= array_merge($parent->children
, $overview->children
);
441 foreach ($overview->children
as &$child) {
442 $child->parent
=& $parent;
446 while (!is_null($parent)) {
448 $parent->time
= $time;
449 $parent =& $parent->parent
;
453 // Remove all refenrences and assign null to the object
454 unset($this->ids
[$overview->msgid
]);
455 unset($this->overview
[$_id]);
456 BananaTree
::kill($_id);
457 foreach ($this->roots
as $k=>&$root) {
458 if ($root === $overview) {
459 unset($this->roots
[$k]);
470 public function formatDate(BananaSpoolHead
&$head)
472 $stamp = $head->date
;
473 $today = intval(time() / (24*3600));
474 $dday = intval($stamp / (24*3600));
476 if ($today == $dday) {
478 } elseif ($today == 1 +
$dday) {
479 $format = _b_('hier')." %H:%M";
480 } elseif ($today < 7 +
$dday) {
481 $format = '%a %H:%M';
482 } elseif ($today < 90 +
$dday) {
483 $format = '%a %e %b';
485 $format = '%a %e %b %Y';
487 return strftime($format, $stamp);
490 public function formatSubject(BananaSpoolHead
&$head)
492 $subject = $popup = $head->subject
;
494 if (function_exists('hook_formatDisplayHeader')) {
495 list($subject, $link) = hook_formatDisplayHeader('subject', $subject, true
);
497 $subject = banana_catchFormats(banana_entities(stripslashes($subject)));
500 if (empty($subject)) {
501 $subject = _b_('(pas de sujet)');
503 if ($head->id
!== Banana
::$artid) {
504 $subject = Banana
::$page->makeLink(Array('group' => $this->group
, 'artid' => $head->id
,
505 'text' => $subject, 'popup' => $popup));
507 return $subject . $link;
510 public function formatFrom(BananaSpoolHead
&$head)
512 return BananaMessage
::formatFrom($head->from
);
515 public function start()
517 if (Banana
::$first) {
518 return Banana
::$first;
520 $first = array_search(Banana
::$artid, $this->roots
);
521 return max(0, $first - Banana
::$spool_tbefore);
525 public function context()
527 return Banana
::$first ? Banana
::$spool_tmax : Banana
::$spool_tcontext;
530 /** Return root message of the given thread
531 * @param id INTEGER id of a message
533 public function &root($id)
535 $parent =& $this->overview
[$id];
536 while (!is_null($parent->parent
)) {
537 $parent =& $parent->parent
;
542 /** Return the last post id with the given subject
545 public function getPostId($subject)
547 $subject = trim($subject);
548 $id = max(array_keys($this->overview
));
549 while (isset($this->overview
[$id])) {
550 $test = $this->overview
[$id]->subject
;
551 if (function_exists('hook_formatDisplayHeader')) {
552 $val = hook_formatDisplayHeader('subject', $test, true
);
553 if (is_array($val)) {
554 $test = banana_html_entity_decode($val[0]);
556 $test = banana_html_entity_decode($val);
560 if ($test == $subject) {
568 /** Returns previous thread root index
569 * @param id INTEGER message number
571 public function prevThread($id)
573 $root =& $this->root($id);
575 foreach ($this->roots
as &$i) {
584 /** Returns next thread root index
585 * @param id INTEGER message number
587 public function nextThread($id)
589 $root =& $this->root($id);
591 foreach ($this->roots
as &$i) {
602 /** Return prev post in the thread
603 * @param id INTEGER message number
605 public function prevPost($id)
607 $parent =& $this->overview
[$id]->parent
;
608 if (is_null($parent)) {
612 foreach ($parent->children
as &$child) {
613 if ($child->id
== $id) {
621 /** Return next post in the thread
622 * @param id INTEGER message number
624 public function nextPost($id)
626 $cur =& $this->overview
[$id];
627 if (count($cur->children
) != 0) {
628 return $cur->children
[0]->id
;
633 $parent =& $cur->parent
;
634 if (is_null($parent)) {
638 foreach ($parent->children
as &$child) {
642 if ($child === $cur) {
651 /** Look for an unread message in the thread rooted by the message
652 * @param id INTEGER message number
654 private function _nextUnread(BananaSpoolHead
&$cur)
659 foreach ($cur->children
as &$child) {
660 $unread = $this->_nextUnread($child);
661 if (!is_null($unread)) {
668 /** Find next unread message
669 * @param id INTEGER message number
671 public function nextUnread($id = null
)
673 if (!$this->unreadnb
) {
678 // Look in message children
679 foreach ($this->overview
[$id]->children
as &$child) {
680 $next = $this->_nextUnread($child);
681 if (!is_null($next)) {
687 // Look in current thread
691 $cur =& $this->overview
[$id];
698 $parent =& $cur->parent
;
701 if (!is_null($parent)) {
702 $array =& $parent->children
;
704 $array =& $this->roots
;
706 foreach ($array as &$child) {
708 $next = $this->_nextUnread($child);
709 if (!is_null($next)) {
713 if ($child === $cur) {
718 } while(!is_null($cur));
722 // vim:set et sw=4 sts=4 ts=4 enc=utf-8: