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 */
88 * @param $_group STRING group name
89 * @param $_display INTEGER 1 => all posts, 2 => only threads with new posts
90 * @param $_since INTEGER time stamp (used for read/unread)
92 function BananaSpool($_group, $_display=0, $_since="")
95 $this->group
= $_group;
96 $groupinfo = $banana->nntp
->group($_group);
97 if (!$groupinfo) { return ($this = null
); }
99 $this->_readFromFile();
102 $first = $banana->maxspool ?
max($groupinfo[2]-$banana->maxspool
, $groupinfo[1]) : $groupinfo[1];
103 $last = $groupinfo[2];
104 if ($this->version
== BANANA_SPOOL_VERSION
) {
105 for ($id = min(array_keys($this->overview
)); $id<$first; $id++
) {
106 $this->delid($id, false
);
109 $first = max(array_keys($this->overview
))+
1;
111 unset($this->overview
, $this->ids
);
112 $this->version
= BANANA_SPOOL_VERSION
;
115 if ($first<=$last && $groupinfo[0]) {
117 $this->_updateSpool("$first-$last");
120 if ($do_save) { $this->_saveToFile(); }
122 $this->_updateUnread($_since, $_display);
125 function _readFromFile()
127 $file = dirname(dirname(__FILE__
))."/spool/spool-{$this->group}.dat";
128 if (file_exists($file)) {
129 $this = unserialize(file_get_contents($file));
133 function _saveToFile()
135 $file = dirname(dirname(__FILE__
))."/spool/spool-{$this->group}.dat";
136 uasort($this->overview
, "spoolcompare");
138 $this->roots
= Array();
139 foreach($this->overview
as $id=>$msg) {
140 if (is_null($msg->parent
)) {
141 $this->roots
[] = $id;
145 file_put_contents($file, serialize($this));
148 function _updateSpool($arg)
151 $dates = array_map(strtotime
, $banana->nntp
->xhdr("Date", $arg));
152 $subjects = array_map(headerdecode
, $banana->nntp
->xhdr("Subject", $arg));
153 $froms = array_map(headerdecode
, $banana->nntp
->xhdr("From", $arg));
154 $msgids = $banana->nntp
->xhdr("Message-ID", $arg);
155 $refs = $banana->nntp
->xhdr("References", $arg);
157 if (is_array($this->ids
)) {
158 $this->ids
= array_merge($this->ids
, array_flip($msgids));
160 $this->ids
= array_flip($msgids);
163 foreach ($msgids as $id=>$msgid) {
164 $msg = new BananaSpoolHead($dates[$id], $subjects[$id], $froms[$id]);
165 $refs[$id] = str_replace('><', '> <', $refs[$id]);
166 $msgrefs = preg_split("/[ \t]/", strtr($refs[$id], $this->ids
));
167 $parents = preg_grep('/^\d+$/', $msgrefs);
168 $msg->parent
= array_pop($parents);
169 $msg->parent_direct
= preg_match('/^\d+$/', array_pop($msgrefs));
171 if (isset($this->overview
[$id])) {
172 $msg->desc
= $this->overview
[$id]->desc
;
173 $msg->children
= $this->overview
[$id]->children
;
175 $this->overview
[$id] = $msg;
177 if ($p = $msg->parent
) {
178 if (empty($this->overview
[$p])) {
179 $this->overview
[$p] = new BananaSpoolHead($dates[$p], $subjects[$p], $froms[$p], 1);
181 $this->overview
[$p]->children
[] = $id;
184 $this->overview
[$p]->desc +
= $msg->desc
;
185 $p = $this->overview
[$p]->parent
;
191 function _updateUnread($since, $mode)
194 if (empty($since)) { return; }
196 if (is_array($newpostsids = $banana->nntp
->newnews($since, $this->group
))) {
197 $newpostsids = array_intersect($newpostsids, array_keys($this->ids
));
198 foreach ($newpostsids as $mid) {
199 $this->overview
[$this->ids
[$mid]]->isread
= false
;
200 $this->overview
[$this->ids
[$mid]]->descunread
= 1;
201 $parentmid = $this->ids
[$mid];
202 while (isset($parentmid)) {
203 $this->overview
[$parentmid]->descunread ++
;
204 $parentmid = $this->overview
[$parentmid]->parent
;
208 if (count($newpostsids)) {
211 foreach ($this->roots
as $k=>$i) {
212 if ($this->overview
[$i]->descunread
==0) {
214 unset($this->roots
[$k]);
223 /** kill post and childrens
224 * @param $_id MSGNUM of post
227 function killdesc($_id)
229 if (sizeof($this->overview
[$_id]->children
)) {
230 foreach ($this->overview
[$_id]->children
as $c) {
234 unset($this->overview
[$_id]);
235 if (($msgid = array_search($_id, $this->ids
)) !== false
) {
236 unset($this->ids
[$msgid]);
240 /** delete a post from overview
241 * @param $_id MSGNUM of post
244 function delid($_id, $write=true
)
246 if (isset($this->overview
[$_id])) {
247 if (sizeof($this->overview
[$_id]->parent
)) {
248 $this->overview
[$this->overview
[$_id]->parent
]->children
=
249 array_diff($this->overview
[$this->overview
[$_id]->parent
]->children
, array($_id));
250 if (sizeof($this->overview
[$_id]->children
)) {
251 $this->overview
[$this->overview
[$_id]->parent
]->children
=
252 array_merge($this->overview
[$this->overview
[$_id]->parent
]->children
, $this->overview
[$_id]->children
);
253 foreach ($this->overview
[$_id]->children
as $c) {
254 $this->overview
[$c]->parent
= $this->overview
[$_id]->parent
;
255 $this->overview
[$c]->parent_direct
= false
;
258 $p = $this->overview
[$_id]->parent
;
260 $this->overview
[$p]->desc
--;
261 $p = $this->overview
[$p]->parent
;
263 } elseif (sizeof($this->overview
[$_id]->children
)) {
264 foreach ($this->overview
[$_id]->children
as $c) {
265 $this->overview
[$c]->parent
= null
;
268 unset($this->overview
[$_id]);
269 $msgid = array_search($_id, $this->ids
);
271 unset($this->ids
[$msgid]);
274 if ($write) { $this->_saveToFile(); }
278 /** displays children tree of a post
279 * @param $_id INTEGER MSGNUM of post
280 * @param $_index INTEGER linear number of post in the tree
281 * @param $_first INTEGER linear number of first post displayed
282 * @param $_last INTEGER linear number of last post displayed
283 * @param $_ref STRING MSGNUM of current post
284 * @param $_pfx_node STRING prefix used for current node
285 * @param $_pfx_end STRING prefix used for children of current node
286 * @param $_head BOOLEAN true if first post in thread
289 function _disp_desc($_id, $_index, $_first=0, $_last=0, $_ref="", $_pfx_node="", $_pfx_end="", $_head=true
)
292 $spfx_f = '<img src="img/k1.gif" height="21" width="9" alt="o" />';
293 $spfx_n = '<img src="img/k2.gif" height="21" width="9" alt="*" />';
294 $spfx_Tnd = '<img src="img/T-direct.gif" height="21" width="12" alt="+" />';
295 $spfx_Lnd = '<img src="img/L-direct.gif" height="21" width="12" alt="`" />';
296 $spfx_snd = '<img src="img/s-direct.gif" height="21" width="5" alt="-" />';
297 $spfx_T = '<img src="img/T.gif" height="21" width="12" alt="+" />';
298 $spfx_L = '<img src="img/L.gif" height="21" width="12" alt="`" />';
299 $spfx_s = '<img src="img/s.gif" height="21" width="5" alt="-" />';
300 $spfx_e = '<img src="img/e.gif" height="21" width="12" alt=" " />';
301 $spfx_I = '<img src="img/I.gif" height="21" width="12"alt="|" />';
303 if ($_index +
$this->overview
[$_id]->desc
< $_first ||
$_index > $_last) {
307 if ($_index>=$_first) {
308 $us = ($_index == $_ref);
309 $hc = empty($this->overview
[$_id]->children
);
311 echo '<tr class="'.($_index%2?
$css["pair"]:$css["impair"]).($this->overview
[$_id]->isread?
'':' new')."\">\n";
312 echo "<td class=\"{$css['date']}\">".fancyDate($this->overview
[$_id]->date
)." </td>\n";
313 echo "<td class=\"{$css['subject']}\">"
314 ."<div class=\"{$css['tree']}\">$_pfx_node".($hc?
($_head?
$spfx_f:($this->overview
[$_id]->parent_direct?
$spfx_s:$spfx_snd)):$spfx_n)
316 if ($_index == $_ref) {
317 echo '<span class="isref">'.htmlentities($this->overview
[$_id]->subject
).'</span>';
319 echo "<a href='article.php?group={$this->group}&id=$_id'>".htmlentities($this->overview
[$_id]->subject
).'</a>';
321 echo "</td>\n<td class=\"{$css['author']}\">".formatFrom($this->overview
[$_id]->from
)."</td>\n</tr>";
328 $children = $this->overview
[$_id]->children
;
329 while ($child = array_shift($children)) {
330 if ($_index > $_last) { return; }
331 if ($_index+
$this->overview
[$child]->desc
>= $_first) {
332 if (sizeof($children)) {
333 $this->_disp_desc($child, $_index, $_first, $_last, $_ref,
334 $_pfx_end.($this->overview
[$child]->parent_direct?
$spfx_T:$spfx_Tnd),
335 $_pfx_end.$spfx_I, false
);
337 $this->_disp_desc($child, $_index, $_first, $_last, $_ref,
338 $_pfx_end.($this->overview
[$child]->parent_direct?
$spfx_L:$spfx_Lnd),
339 $_pfx_end.$spfx_e, false
);
342 $_index +
= $this->overview
[$child]->desc
;
346 /** Displays overview
347 * @param $_first INTEGER MSGNUM of first post
348 * @param $_last INTEGER MSGNUM of last post
349 * @param $_ref STRING MSGNUM of current/selectionned post
352 function disp($_first=0, $_last=0, $_ref="")
356 if (sizeof($this->overview
)) {
357 foreach ($this->roots
as $id) {
358 $this->_disp_desc($id, $index, $_first, $_last, $_ref);
359 $index +
= $this->overview
[$id]->desc
;
360 if ($index > $_last) { break; }
363 echo "<tr class=\"{$css['pair']}\">\n";
364 echo "\t<td colspan=\"3\">\n";
365 echo "\t\tNo post in this newsgroup\n";
371 /** computes linear post index
372 * @param $_id INTEGER MSGNUM of post
373 * @return INTEGER linear index of post
376 function getndx($_id)
381 $id_parent = $this->overview
[$id_cur]->parent
;
382 if (is_null($id_parent)) break;
383 $pos = array_search($id_cur, $this->overview
[$id_parent]->children
);
385 for ($i = 0; $i < $pos ; $i++
) {
386 $ndx +
= $this->overview
[$this->overview
[$id_parent]->children
[$i]]->desc
;
390 $id_cur = $id_parent;
393 foreach ($this->roots
as $i) {
397 $ndx +
= $this->overview
[$i]->desc
;