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) {
12 $fp = fopen($filename, 'w');
14 trigger_error('file_put_contents cannot write in file '.$filename, E_USER_ERROR
);
23 * class used in thread overviews
27 /** date (timestamp) */
33 /** reference of parent */
35 /** paren is direct */
37 /** array of children */
38 var $children = Array();
39 /** true if post is read */
41 /** number of posts deeper in this branch of tree */
43 /** same as desc, but counts only unread posts */
47 * @param $_date INTEGER timestamp of post
48 * @param $_subject STRING subject of post
49 * @param $_from STRING author of post
50 * @param $_desc INTEGER desc value (1 for a new post)
51 * @param $_read BOOLEAN true if read
52 * @param $_descunread INTEGER descunread value (0 for a new post)
55 function SpoolHead($_date, $_subject, $_from, $_desc=1, $_read=true
, $_descunread=0)
58 $this->subject
= $_subject;
61 $this->isread
= $_read;
62 $this->descunread
= $_descunread;
67 * builds and updates spool
70 define("BANANA_SPOOL_VERSION", '0.2');
79 /** array msgid => msgnum */
85 * @param $_nntp RESOURCE NNTP socket filehandle
86 * @param $_group STRING group name
87 * @param $_display INTEGER 1 => all posts, 2 => only threads with new posts
88 * @param $_since INTEGER time stamp (used for read/unread)
90 function spool(&$_nntp, $_group, $_display=0, $_since="")
93 $this->group
= $_group;
94 $groupinfo = $_nntp->group($_group);
95 if (!$groupinfo) { return ($this = null
); }
97 $this->_readFromFile();
100 $first = max($groupinfo[2]-$news['maxspool'], $groupinfo[1]);
101 $last = $groupinfo[2];
102 if ($this->version
== BANANA_SPOOL_VERSION
) {
103 for ($id = min(array_keys($this->overview
)); $id<$first; $id++
) {
104 $this->delid($id, false
);
107 $first = max(array_keys($this->overview
))+
1;
109 unset($this->overview
, $this->ids
);
110 $this->version
= BANANA_SPOOL_VERSION
;
113 if ($first<$last && $groupinfo[0]) {
115 $this->_updateSpool($_nntp, "$first-$last");
118 if ($do_save) { $this->_saveToFile(); }
120 $this->_updateUnread($_nntp, $_since, $_display);
123 function _readFromFile()
125 $file = dirname(dirname(__FILE__
))."/spool/spool-{$this->group}.dat";
126 if (file_exists($file)) {
127 $this = unserialize(file_get_contents($file));
131 function _saveToFile()
133 $file = dirname(dirname(__FILE__
))."/spool/spool-{$this->group}.dat";
134 uasort($this->overview
, "spoolcompare");
136 $this->roots
= Array();
137 foreach($this->overview
as $id=>$msg) {
138 if (is_null($msg->parent
)) {
139 $this->roots
[] = $id;
143 file_put_contents($file, serialize($this));
146 function _updateSpool(&$_nntp, $arg)
148 $dates = array_map(strtotime
, $_nntp->xhdr("Date", $arg));
149 $subjects = array_map(headerdecode
, $_nntp->xhdr("Subject", $arg));
150 $froms = array_map(headerdecode
, $_nntp->xhdr("From", $arg));
151 $msgids = $_nntp->xhdr("Message-ID", $arg);
152 $refs = $_nntp->xhdr("References", $arg);
154 if (is_array($this->ids
)) {
155 $this->ids
= array_merge($this->ids
, array_flip($msgids));
157 $this->ids
= array_flip($msgids);
160 foreach ($msgids as $id=>$msgid) {
161 $msg = new spoolhead($dates[$id], $subjects[$id], $froms[$id]);
162 $refs[$id] = str_replace('><', '> <', $refs[$id]);
163 $msgrefs = preg_split("/[ \t]/", strtr($refs[$id], $this->ids
));
164 $parents = preg_grep('/^\d+$/', $msgrefs);
165 $msg->parent
= array_pop($parents);
166 $msg->parent_direct
= preg_match('/^\d+$/', array_pop($msgrefs));
168 if (isset($this->overview
[$id])) {
169 $msg->desc
= $this->overview
[$id]->desc
;
170 $msg->children
= $this->overview
[$id]->children
;
172 $this->overview
[$id] = $msg;
174 if ($p = $msg->parent
) {
175 if (empty($this->overview
[$p])) {
176 $this->overview
[$p] = new spoolhead($dates[$p], $subjects[$p], $froms[$p], 1);
178 $this->overview
[$p]->children
[] = $id;
181 $this->overview
[$p]->desc +
= $msg->desc
;
182 $p = $this->overview
[$p]->parent
;
188 function _updateUnread(&$nntp, $since, $mode) {
189 if (empty($since)) { return; }
191 if (is_array($newpostsids = $nntp->newnews($since, $this->group
))) {
192 $newpostsids = array_intersect($newpostsids, array_keys($this->ids
));
193 foreach ($newpostsids as $mid) {
194 $this->overview
[$this->ids
[$mid]]->isread
= false
;
195 $this->overview
[$this->ids
[$mid]]->descunread
= 1;
196 $parentmid = $this->ids
[$mid];
197 while (isset($parentmid)) {
198 $this->overview
[$parentmid]->descunread ++
;
199 $parentmid = $this->overview
[$parentmid]->parent
;
203 if (count($newpostsids)) {
206 foreach ($this->roots
as $k=>$i) {
207 if ($this->overview
[$i]->descunread
==0) {
209 unset($this->roots
[$k]);
218 /** kill post and childrens
219 * @param $_id MSGNUM of post
222 function killdesc($_id)
224 if (sizeof($this->overview
[$_id]->children
)) {
225 foreach ($this->overview
[$_id]->children
as $c) {
229 unset($this->overview
[$_id]);
230 if (($msgid = array_search($_id, $this->ids
)) !== false
) {
231 unset($this->ids
[$msgid]);
235 /** delete a post from overview
236 * @param $_id MSGNUM of post
239 function delid($_id, $write=true
)
241 if (isset($this->overview
[$_id])) {
242 if (sizeof($this->overview
[$_id]->parent
)) {
243 $this->overview
[$this->overview
[$_id]->parent
]->children
=
244 array_diff($this->overview
[$this->overview
[$_id]->parent
]->children
, array($_id));
245 if (sizeof($this->overview
[$_id]->children
)) {
246 $this->overview
[$this->overview
[$_id]->parent
]->children
=
247 array_merge($this->overview
[$this->overview
[$_id]->parent
]->children
, $this->overview
[$_id]->children
);
248 foreach ($this->overview
[$_id]->children
as $c) {
249 $this->overview
[$c]->parent
= $this->overview
[$_id]->parent
;
250 $this->overview
[$c]->parent_direct
= false
;
253 $p = $this->overview
[$_id]->parent
;
255 $this->overview
[$p]->desc
--;
256 $p = $this->overview
[$p]->parent
;
258 } elseif (sizeof($this->overview
[$_id]->children
)) {
259 foreach ($this->overview
[$_id]->children
as $c) {
260 $this->overview
[$c]->parent
= null
;
263 unset($this->overview
[$_id]);
264 $msgid = array_search($_id, $this->ids
);
266 unset($this->ids
[$msgid]);
269 if ($write) { $this->_saveToFile(); }
273 /** displays children tree of a post
274 * @param $_id INTEGER MSGNUM of post
275 * @param $_index INTEGER linear number of post in the tree
276 * @param $_first INTEGER linear number of first post displayed
277 * @param $_last INTEGER linear number of last post displayed
278 * @param $_ref STRING MSGNUM of current post
279 * @param $_pfx_node STRING prefix used for current node
280 * @param $_pfx_end STRING prefix used for children of current node
281 * @param $_head BOOLEAN true if first post in thread
284 function _disp_desc($_id, $_index, $_first=0, $_last=0, $_ref="", $_pfx_node="", $_pfx_end="", $_head=true
) {
286 $spfx_f = '<img src="img/k1.gif" height="21" width="9" alt="o" />';
287 $spfx_n = '<img src="img/k2.gif" height="21" width="9" alt="*" />';
288 $spfx_Tnd = '<img src="img/T-direct.gif" height="21" width="12" alt="+" />';
289 $spfx_Lnd = '<img src="img/L-direct.gif" height="21" width="12" alt="`" />';
290 $spfx_snd = '<img src="img/s-direct.gif" height="21" width="5" alt="-" />';
291 $spfx_T = '<img src="img/T.gif" height="21" width="12" alt="+" />';
292 $spfx_L = '<img src="img/L.gif" height="21" width="12" alt="`" />';
293 $spfx_s = '<img src="img/s.gif" height="21" width="5" alt="-" />';
294 $spfx_e = '<img src="img/e.gif" height="21" width="12" alt=" " />';
295 $spfx_I = '<img src="img/I.gif" height="21" width="12"alt="|" />';
297 if ($_index +
$this->overview
[$_id]->desc
< $_first ||
$_index > $_last) {
301 if ($_index>=$_first) {
302 $us = ($_index == $_ref);
303 $hc = empty($this->overview
[$_id]->children
);
305 echo '<tr class="'.($_index%2?
$css["pair"]:$css["impair"]).($this->overview
[$_id]->isread?
'':' new')."\">\n";
306 echo "<td class=\"{$css['date']}\">".locale_header_date($this->overview
[$_id]->date
)." </td>\n";
307 echo "<td class=\"{$css['subject']}\">"
308 ."<div class=\"{$css['tree']}\">$_pfx_node".($hc?
($_head?
$spfx_f:($this->overview
[$_id]->parent_direct?
$spfx_s:$spfx_snd)):$spfx_n)
310 if ($_index == $_ref) {
311 echo '<span class="isref">'.htmlentities($this->overview
[$_id]->subject
).'</span>';
313 echo "<a href='article.php?group={$this->group}&id=$_id'>".htmlentities($this->overview
[$_id]->subject
).'</a>';
315 echo "</td>\n<td class=\"{$css['author']}\">".formatFrom($this->overview
[$_id]->from
)."</td>\n</tr>";
322 $children = $this->overview
[$_id]->children
;
323 while ($child = array_shift($children)) {
324 if ($_index > $_last) { return; }
325 if ($_index+
$this->overview
[$child]->desc
>= $_first) {
326 if (sizeof($children)) {
327 $this->_disp_desc($child, $_index, $_first, $_last, $_ref,
328 $_pfx_end.($this->overview
[$child]->parent_direct?
$spfx_T:$spfx_Tnd),
329 $_pfx_end.$spfx_I, false
);
331 $this->_disp_desc($child, $_index, $_first, $_last, $_ref,
332 $_pfx_end.($this->overview
[$child]->parent_direct?
$spfx_L:$spfx_Lnd),
333 $_pfx_end.$spfx_e, false
);
336 $_index +
= $this->overview
[$child]->desc
;
340 /** Displays overview
341 * @param $_first INTEGER MSGNUM of first post
342 * @param $_last INTEGER MSGNUM of last post
343 * @param $_ref STRING MSGNUM of current/selectionned post
346 function disp($_first=0, $_last=0, $_ref="") {
349 if (sizeof($this->overview
)) {
350 foreach ($this->roots
as $id) {
351 $this->_disp_desc($id, $index, $_first, $_last, $_ref);
352 $index +
= $this->overview
[$id]->desc
;
353 if ($index > $_last) { break; }
356 echo "<tr class=\"{$css['pair']}\">\n";
357 echo "\t<td colspan=\"3\">\n";
358 echo "\t\tNo post in this newsgroup\n";
364 /** computes linear post index
365 * @param $_id INTEGER MSGNUM of post
366 * @return INTEGER linear index of post
369 function getndx($_id) {
373 $id_parent = $this->overview
[$id_cur]->parent
;
374 if (is_null($id_parent)) break;
375 $pos = array_search($id_cur, $this->overview
[$id_parent]->children
);
377 for ($i = 0; $i < $pos ; $i++
) {
378 $ndx +
= $this->overview
[$this->overview
[$id_parent]->children
[$i]]->desc
;
382 $id_cur = $id_parent;
385 foreach ($this->roots
as $i) {
389 $ndx +
= $this->overview
[$i]->desc
;