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 if(!function_exists('file_put_contents')) {
11 function file_put_contents($filename, $data)
13 $fp = fopen($filename, 'w');
15 trigger_error('file_put_contents cannot write in file '.$filename, E_USER_ERROR
);
23 function spoolCompare($a,$b) { return ($b->date
>=$a->date
); }
26 * class used in thread overviews
30 /** date (timestamp) */
36 /** reference of parent */
38 /** paren is direct */
40 /** array of children */
41 var $children = Array();
42 /** true if post is read */
44 /** number of posts deeper in this branch of tree */
46 /** same as desc, but counts only unread posts */
50 * @param $_date INTEGER timestamp of post
51 * @param $_subject STRING subject of post
52 * @param $_from STRING author of post
53 * @param $_desc INTEGER desc value (1 for a new post)
54 * @param $_read BOOLEAN true if read
55 * @param $_descunread INTEGER descunread value (0 for a new post)
58 function BananaSpoolHead($_date, $_subject, $_from, $_desc=1, $_read=true
, $_descunread=0)
61 $this->subject
= $_subject;
64 $this->isread
= $_read;
65 $this->descunread
= $_descunread;
70 * builds and updates spool
73 define("BANANA_SPOOL_VERSION", '0.2');
82 /** array msgid => msgnum */
90 * @param $_group STRING group name
91 * @param $_display INTEGER 1 => all posts, 2 => only threads with new posts
92 * @param $_since INTEGER time stamp (used for read/unread)
94 function BananaSpool($_group, $_display=0, $_since="")
97 $this->group
= $_group;
98 $groupinfo = $banana->nntp
->group($_group);
100 $this->valid
= false
;
104 $this->_readFromFile();
107 $first = $banana->maxspool ?
max($groupinfo[2] - $banana->maxspool
, $groupinfo[1]) : $groupinfo[1];
108 $last = $groupinfo[2];
110 if ($this->version
== BANANA_SPOOL_VERSION
&& is_array($this->overview
)) {
111 $mids = array_keys($this->overview
);
112 foreach ($mids as $id) {
113 if (($first <= $last && ($id < $first ||
$id > $last))
114 ||
($first > $last && $id < $first && $id > $last))
116 $this->delid($id, false
);
120 if (!empty($this->overview
)) {
121 $first = max(array_keys($this->overview
))+
1;
124 unset($this->overview
, $this->ids
);
125 $this->version
= BANANA_SPOOL_VERSION
;
128 if ($first<=$last && $groupinfo[0]) {
130 $this->_updateSpool("$first-$last");
133 if ($do_save) { $this->_saveToFile(); }
135 $this->_updateUnread($_since, $_display);
138 function _readFromFile()
140 $file = $this->_spoolfile();
141 if (file_exists($file)) {
142 $temp = unserialize(file_get_contents($file));
143 foreach (get_object_vars($temp) as $key=>$val) {
149 function _saveToFile()
151 $file = $this->_spoolfile();
152 uasort($this->overview
, "spoolcompare");
154 $this->roots
= Array();
155 foreach($this->overview
as $id=>$msg) {
156 if (is_null($msg->parent
)) {
157 $this->roots
[] = $id;
161 file_put_contents($file, serialize($this));
164 function _spoolfile()
167 $url = parse_url($banana->host
);
168 $file = $url['host'].'_'.$url['port'].'_'.$this->group
;
169 return dirname(dirname(__FILE__
)).'/spool/'.$file;
172 function _updateSpool($arg)
175 $dates = array_map('strtotime', $banana->nntp
->xhdr('Date', $arg));
176 $subjects = array_map('headerdecode', $banana->nntp
->xhdr('Subject', $arg));
177 $froms = array_map('headerdecode', $banana->nntp
->xhdr('From', $arg));
178 $msgids = $banana->nntp
->xhdr('Message-ID', $arg);
179 $refs = $banana->nntp
->xhdr('References', $arg);
181 if (is_array(@$this->ids
)) {
182 $this->ids
= array_merge($this->ids
, array_flip($msgids));
184 $this->ids
= array_flip($msgids);
187 foreach ($msgids as $id=>$msgid) {
188 $msg = new BananaSpoolHead($dates[$id], $subjects[$id], $froms[$id]);
189 $refs[$id] = str_replace('><', '> <', @$refs[$id]);
190 $msgrefs = preg_split("/[ \t]/", strtr($refs[$id], $this->ids
));
191 $parents = preg_grep('/^\d+$/', $msgrefs);
192 $msg->parent
= array_pop($parents);
193 $msg->parent_direct
= preg_match('/^\d+$/', array_pop($msgrefs));
195 if (isset($this->overview
[$id])) {
196 $msg->desc
= $this->overview
[$id]->desc
;
197 $msg->children
= $this->overview
[$id]->children
;
199 $this->overview
[$id] = $msg;
201 if ($p = $msg->parent
) {
202 if (empty($this->overview
[$p])) {
203 $this->overview
[$p] = new BananaSpoolHead($dates[$p], $subjects[$p], $froms[$p], 1);
205 $this->overview
[$p]->children
[] = $id;
208 $this->overview
[$p]->desc +
= $msg->desc
;
209 $p = $this->overview
[$p]->parent
;
215 function _updateUnread($since, $mode)
218 if (empty($since)) { return; }
220 if (is_array($newpostsids = $banana->nntp
->newnews($since, $this->group
))) {
221 if (!is_array($this->ids
)) { $this->ids
= array(); }
222 $newpostsids = array_intersect($newpostsids, array_keys($this->ids
));
223 foreach ($newpostsids as $mid) {
224 $this->overview
[$this->ids
[$mid]]->isread
= false
;
225 $this->overview
[$this->ids
[$mid]]->descunread
= 1;
226 $parentmid = $this->ids
[$mid];
227 while (isset($parentmid)) {
228 $this->overview
[$parentmid]->descunread ++
;
229 $parentmid = $this->overview
[$parentmid]->parent
;
233 if (count($newpostsids)) {
236 foreach ($this->roots
as $k=>$i) {
237 if ($this->overview
[$i]->descunread
==0) {
239 unset($this->roots
[$k]);
248 /** kill post and childrens
249 * @param $_id MSGNUM of post
252 function killdesc($_id)
254 if (sizeof($this->overview
[$_id]->children
)) {
255 foreach ($this->overview
[$_id]->children
as $c) {
259 unset($this->overview
[$_id]);
260 if (($msgid = array_search($_id, $this->ids
)) !== false
) {
261 unset($this->ids
[$msgid]);
265 /** delete a post from overview
266 * @param $_id MSGNUM of post
269 function delid($_id, $write=true
)
271 if (isset($this->overview
[$_id])) {
272 if (sizeof($this->overview
[$_id]->parent
)) {
273 $this->overview
[$this->overview
[$_id]->parent
]->children
=
274 array_diff($this->overview
[$this->overview
[$_id]->parent
]->children
, array($_id));
275 if (sizeof($this->overview
[$_id]->children
)) {
276 $this->overview
[$this->overview
[$_id]->parent
]->children
=
277 array_merge($this->overview
[$this->overview
[$_id]->parent
]->children
, $this->overview
[$_id]->children
);
278 foreach ($this->overview
[$_id]->children
as $c) {
279 $this->overview
[$c]->parent
= $this->overview
[$_id]->parent
;
280 $this->overview
[$c]->parent_direct
= false
;
283 $p = $this->overview
[$_id]->parent
;
285 $this->overview
[$p]->desc
--;
286 $p = $this->overview
[$p]->parent
;
288 } elseif (sizeof($this->overview
[$_id]->children
)) {
289 foreach ($this->overview
[$_id]->children
as $c) {
290 $this->overview
[$c]->parent
= null
;
293 unset($this->overview
[$_id]);
294 $msgid = array_search($_id, $this->ids
);
296 unset($this->ids
[$msgid]);
299 if ($write) { $this->_saveToFile(); }
303 /** displays children tree of a post
304 * @param $_id INTEGER MSGNUM of post
305 * @param $_index INTEGER linear number of post in the tree
306 * @param $_first INTEGER linear number of first post displayed
307 * @param $_last INTEGER linear number of last post displayed
308 * @param $_ref STRING MSGNUM of current post
309 * @param $_pfx_node STRING prefix used for current node
310 * @param $_pfx_end STRING prefix used for children of current node
311 * @param $_head BOOLEAN true if first post in thread
313 * If you want to analyse subject, you can define the function hook_getSubject(&$subject) which
314 * take the subject as a reference parameter, transform this subject to be displaid in the spool
315 * view and return a string. This string will be put after the subject.
318 function _to_html($_id, $_index, $_first=0, $_last=0, $_ref="", $_pfx_node="", $_pfx_end="", $_head=true
)
320 $spfx_f = makeImg('k1.gif', 'o', 21, 9);
321 $spfx_n = makeImg('k2.gif', '*', 21, 9);
322 $spfx_Tnd = makeImg('T-direct.gif', '+', 21, 12);
323 $spfx_Lnd = makeImg('L-direct.gif', '`', 21, 12);
324 $spfx_snd = makeImg('s-direct.gif', '-', 21, 5);
325 $spfx_T = makeImg('T.gif', '+', 21, 12);
326 $spfx_L = makeImg('L.gif', '`', 21, 12);
327 $spfx_s = makeImg('s.gif', '-', 21, 5);
328 $spfx_e = makeImg('e.gif', ' ', 21, 12);
329 $spfx_I = makeImg('I.gif', '|', 21, 12);
331 if ($_index +
$this->overview
[$_id]->desc
< $_first ||
$_index > $_last) {
337 if ($_index>=$_first) {
338 $hc = empty($this->overview
[$_id]->children
);
340 $res .= '<tr class="'.($_index%2?
'pair':'impair').($this->overview
[$_id]->isread?
'':' new')."\">\n";
341 $res .= "<td class='date'>".fancyDate($this->overview
[$_id]->date
)." </td>\n";
342 $res .= "<td class='subj'>"
343 ."<div class='tree'>$_pfx_node".($hc?
($_head?
$spfx_f:($this->overview
[$_id]->parent_direct?
$spfx_s:$spfx_snd)):$spfx_n)
345 $subject = $this->overview
[$_id]->subject
;
346 if (strlen($subject) == 0) {
347 $subject = _b_('(pas de sujet)');
350 if (function_exists('hook_getSubject')) {
351 $link = hook_getSubject($subject);
353 $subject = formatPlainText(htmlentities($subject));
354 if ($_index == $_ref) {
355 $res .= '<span class="cur">' . $subject . $link . '</span>';
357 $res .= makeHREF(Array('group' => $this->group
,
363 $res .= "</td>\n<td class='from'>".formatFrom($this->overview
[$_id]->from
)."</td>\n</tr>";
365 if ($hc) { return $res; }
370 $children = $this->overview
[$_id]->children
;
371 while ($child = array_shift($children)) {
372 if ($_index > $_last) { return $res; }
373 if ($_index+
$this->overview
[$child]->desc
>= $_first) {
374 if (sizeof($children)) {
375 $res .= $this->_to_html($child, $_index, $_first, $_last, $_ref,
376 $_pfx_end.($this->overview
[$child]->parent_direct?
$spfx_T:$spfx_Tnd),
377 $_pfx_end.$spfx_I, false
);
379 $res .= $this->_to_html($child, $_index, $_first, $_last, $_ref,
380 $_pfx_end.($this->overview
[$child]->parent_direct?
$spfx_L:$spfx_Lnd),
381 $_pfx_end.$spfx_e, false
);
384 $_index +
= $this->overview
[$child]->desc
;
390 /** Displays overview
391 * @param $_first INTEGER MSGNUM of first post
392 * @param $_last INTEGER MSGNUM of last post
393 * @param $_ref STRING MSGNUM of current/selectionned post
396 function to_html($_first=0, $_last=0, $_ref = null
)
398 $res = '<table class="bicol banana_thread" cellpadding="0" cellspacing="0">';
400 if (is_null($_ref)) {
401 $next = $this->nextUnread();
402 if (!is_null($next)) {
403 $next = '<div class="banana_menu">'
404 . makeImgLink(Array('group' => $this->group
,
407 _b_('Message non-lu suivant'), null
, null
, null
, 'u')
410 $new = '<div class="banana_action">'
411 . makeImgLink(Array('group' => $this->group
,
414 _b_('Nouveau message'), null
, null
, null
, 'p')
417 $res .= '<tr><th>' . $next . _b_('Date') . '</th>';
418 $res .= '<th>' . _b_('Sujet') . '</th>';
419 $res .= '<th>' . $new . _b_('Auteur') . '</th></tr>';
421 $res .= '<tr><th colspan="3">' . _b_('Aperçu de ')
422 . makeHREF(Array('group' => $this->group
),
428 if (sizeof($this->overview
)) {
429 foreach ($this->roots
as $id) {
430 $res .= $this->_to_html($id, $index, $_first, $_last, $_ref);
431 $index +
= $this->overview
[$id]->desc
;
432 if ($index > $_last) { break; }
435 $res .= '<tr><td colspan="3">'._b_('Aucun message dans ce forum').'</td></tr>';
439 if (is_object($banana->groups
)) {
440 $res .= '<tr><td colspan="3" class="subs">'
441 . $banana->groups
->to_html()
444 return $res .= '</table>';
447 /** computes linear post index
448 * @param $_id INTEGER MSGNUM of post
449 * @return INTEGER linear index of post
452 function getndx($_id)
457 $id_parent = $this->overview
[$id_cur]->parent
;
458 if (is_null($id_parent)) break;
459 $pos = array_search($id_cur, $this->overview
[$id_parent]->children
);
461 for ($i = 0; $i < $pos ; $i++
) {
462 $ndx +
= $this->overview
[$this->overview
[$id_parent]->children
[$i]]->desc
;
466 $id_cur = $id_parent;
469 foreach ($this->roots
as $i) {
473 $ndx +
= $this->overview
[$i]->desc
;
478 /** Return root message of the given thread
479 * @param id INTEGER id of a message
485 $id_parent = $this->overview
[$id_cur]->parent
;
486 if (is_null($id_parent)) break;
487 $id_cur = $id_parent;
492 /** Returns previous thread root index
493 * @param id INTEGER message number
495 function prevThread($id)
497 $root = $this->root($id);
499 foreach ($this->roots
as $i) {
508 /** Returns next thread root index
509 * @param id INTEGER message number
511 function nextThread($id)
513 $root = $this->root($id);
515 foreach ($this->roots
as $i) {
526 /** Return prev post in the thread
527 * @param id INTEGER message number
529 function prevPost($id)
531 $parent = $this->overview
[$id]->parent
;
532 if (is_null($parent)) {
536 foreach ($this->overview
[$parent]->children
as $child) {
545 /** Return next post in the thread
546 * @param id INTEGER message number
548 function nextPost($id)
550 if (count($this->overview
[$id]->children
) != 0) {
551 return $this->overview
[$id]->children
[0];
556 $parent = $this->overview
[$cur]->parent
;
557 if (is_null($parent)) {
561 foreach ($this->overview
[$parent]->children
as $child) {
565 if ($child == $cur) {
574 /** Look for an unread message in the thread rooted by the message
575 * @param id INTEGER message number
577 function _nextUnread($id)
579 if (!$this->overview
[$id]->isread
) {
582 foreach ($this->overview
[$id]->children
as $child) {
583 $unread = $this->_nextUnread($child);
584 if (!is_null($unread)) {
591 /** Find next unread message
592 * @param id INTEGER message number
594 function nextUnread($id = null
)
597 // Look in message children
598 foreach ($this->overview
[$id]->children
as $child) {
599 $next = $this->_nextUnread($child);
600 if (!is_null($next)) {
606 // Look in current thread
609 $parent = is_null($cur) ? null
: $this->overview
[$cur]->parent
;
610 $ok = is_null($cur) ? true
: false
;
611 if (!is_null($parent)) {
612 $array = &$this->overview
[$parent]->children
;
614 $array = &$this->roots
;
616 foreach ($array as $child) {
618 $next = $this->_nextUnread($child);
619 if (!is_null($next)) {
623 if ($child == $cur) {
628 } while(!is_null($cur));
633 // vim:set et sw=4 sts=4 ts=4