include/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 if(!function_exists('_file_put_contents')) {
  11     function file_put_contents($filename, $data) {
  12         $fp = fopen($filename, 'w');
  13         if(!$fp) {
  14             trigger_error('file_put_contents cannot write in file '.$filename, E_USER_ERROR);
  15             return;
  16         }
  17         fputs($fp, $data);
  18         fclose($fp);
  19
  20     }
  21 }
  22
  23
  24 /** Class spoolhead
  25  *  class used in thread overviews
  26  */
  27 class SpoolHead
  28 {
  29     /** date (timestamp) */
  30     var $date;
  31     /** subject */
  32     var $subject;
  33     /** author */
  34     var $from;
  35     /** reference of parent */
  36     var $parent;
  37     /** paren is direct */
  38     var $parent_direct;
  39     /** array of children */
  40     var $children = Array();
  41     /** true if post is read */
  42     var $isread;
  43     /** number of posts deeper in this branch of tree */
  44     var $desc;
  45     /**  same as desc, but counts only unread posts */
  46     var $descunread;
  47
  48     /** constructor
  49      * @param $_date INTEGER timestamp of post
  50      * @param $_subject STRING subject of post
  51      * @param $_from STRING author of post
  52      * @param $_desc INTEGER desc value (1 for a new post)
  53      * @param $_read BOOLEAN true if read
  54      * @param $_descunread INTEGER descunread value (0 for a new post)
  55      */
  56
  57     function SpoolHead($_date, $_subject, $_from, $_desc=1, $_read=true, $_descunread=0)
  58     {
  59         $this->date       = $_date;
  60         $this->subject    = $_subject;
  61         $this->from       = $_from;
  62         $this->desc       = $_desc;
  63         $this->isread     = $_read;
  64         $this->descunread = $_descunread;
  65     }
  66 }
  67
  68 /** Class spool
  69  * builds and updates spool
  70  */
  71
  72 define("BANANA_SPOOL_VERSION", '0.2');
  73
  74 class spool
  75 {
  76     var $version;
  77     /**  spool */
  78     var $overview;
  79     /**  group name */
  80     var $group;
  81     /**  array msgid => msgnum */
  82     var $ids;
  83
  84     /** constructor
  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)
  89      */
  90
  91     function spool(&$_nntp, $_group, $_display=0, $_since="")
  92     {
  93         global $news;
  94
  95         $spool_path = dirname(dirname(__FILE__)).'/spool';
  96         $spoolfile  = "$spool_path/spool-$_group.dat";
  97
  98         $groupinfo  = $_nntp->group($_group);
  99         $first      = max($groupinfo[2]-$news['maxspool'], $groupinfo[1]);
 100         $last       = $groupinfo[2];
 101
 102         if (!$groupinfo) {
 103             $this = null;
 104             return false;
 105         }
 106         if (file_exists($spoolfile)) {
 107             $this   = unserialize(file_get_contents($spoolfile));
 108         }
 109
 110         if ($this->version == BANANA_SPOOL_VERSION) {
 111             $keys   = array_values($this->ids);
 112             rsort($keys);
 113             // remove expired messages
 114             for ($id=min(array_keys($this->overview)); $id<$first; $id++) {
 115                 $this->delid($id, false);
 116             }
 117             $first  = max(array_keys($this->overview))+1;
 118         } else {
 119             unset($this->overview, $this->ids);
 120             $this->group   = $_group;
 121             $this->version = BANANA_SPOOL_VERSION;
 122         }
 123
 124         if (($first<$last) && $groupinfo[0]) {
 125             $dates    = array_map("strtotime",    $_nntp->xhdr("Date",    "$first-$last"));
 126             $subjects = array_map("headerdecode", $_nntp->xhdr("Subject", "$first-$last"));
 127             $froms    = array_map("headerdecode", $_nntp->xhdr("From",    "$first-$last"));
 128             $msgids   = $_nntp->xhdr("Message-ID", "$first-$last");
 129             $refs     = $_nntp->xhdr("References", "$first-$last");
 130
 131             if (isset($this->ids)) {
 132                 $this->ids = array_merge($this->ids, array_flip($msgids));
 133             } else {
 134                 $this->ids = array_flip($msgids);
 135             }
 136
 137             foreach ($msgids as $id=>$msgid) {
 138                 $msg                = new spoolhead($dates[$id], $subjects[$id], $froms[$id], 1);
 139                 $refs[$id]          = str_replace("><", "> <", $refs[$id]);
 140                 $msgrefs            = preg_split("/( |\t)/", strtr($refs[$id], $this->ids));
 141                 $parents            = preg_grep("/^\d+$/", $msgrefs);
 142                 $msg->parent        = array_pop($parents);
 143                 $msg->parent_direct = preg_match("/^\d+$/", array_pop($msgrefs));
 144
 145                 $p = $msg->parent;
 146                 while ($p) {
 147                     if (isset($this->overview[$p])) {
 148                         $this->overview[$p]->desc++;
 149                         $p = $this->overview[$p]->parent;
 150                     } else {
 151                         $this->overview[$p] = new spoolhead($dates[$p], $subjects[$p], $froms[$p], 1);
 152                         break;
 153                     }
 154                 }
 155                 if ($msg->parent) {
 156                     $this->overview[$msg->parent]->children[] = $id;
 157                 }
 158                 $this->overview[$id] = $msg;
 159             }
 160             uasort($this->overview, "spoolcompare");
 161             file_put_contents($spoolfile, serialize($this));
 162         }
 163
 164         if ($_since) {
 165             $newpostsids = $_nntp->newnews($_since, $_group);
 166             if (sizeof($newpostsids)) {
 167                 $newpostsids = array_intersect($newpostsids, array_keys($this->ids));
 168                 if ($newpostsids && !is_null($newpostsids)) {
 169                     foreach ($newpostsids as $mid) {
 170                         $this->overview[$this->ids[$mid]]->isread     = false;
 171                         $this->overview[$this->ids[$mid]]->descunread = 1;
 172                         $parentmid = $this->ids[$mid];
 173                         while (isset($parentmid)) {
 174                             $this->overview[$parentmid]->descunread ++;
 175                             $parentmid = $this->overview[$parentmid]->parent;
 176                         }
 177                     }
 178                 }
 179             }
 180             if (sizeof($newpostsids)>0) {
 181                 switch ($_display) {
 182                     case 1:
 183                         foreach ($this->overview as $i=>$p) {
 184                             if (isset($this->overview[$i]) &&
 185                                     !isset($this->overview[$i]->parent) &&
 186                                     ($this->overview[$i]->descunread==0))
 187                             {
 188                                 $this->killdesc($i);
 189                             }
 190                         }
 191                         break;
 192
 193                     case 2:
 194                         $flipids = array_flip($this->ids);
 195                         foreach ($this->overview as $i=>$p) {
 196                             if ($p->isread) {
 197                                 unset($this->overview[$i]);
 198                                 unset($flipids[$i]);
 199                             }
 200                         }
 201                         $this->ids = array_flip($flipids);
 202                         break;
 203                 }
 204             }
 205         }
 206         return true;
 207     }
 208
 209     /** kill post and childrens
 210      * @param $_id MSGNUM of post
 211      */
 212
 213     function killdesc($_id)
 214     {
 215         if (sizeof($this->overview[$_id]->children)) {
 216             foreach ($this->overview[$_id]->children as $c) {
 217                 $this->killdesc($c);
 218             }
 219         }
 220         unset($this->overview[$_id]);
 221         $msgid = array_search($_id, $this->ids);
 222         if ($msgids) {
 223             unset($this->ids[$msgid]);
 224         }
 225     }
 226
 227     /** delete a post from overview
 228      * @param $_id MSGNUM of post
 229      */
 230
 231     function delid($_id, $write=true)
 232     {
 233         if (isset($this->overview[$_id])) {
 234             if (sizeof($this->overview[$_id]->parent)) {
 235                 $this->overview[$this->overview[$_id]->parent]->children =
 236                     array_diff($this->overview[$this->overview[$_id]->parent]->children, array($_id));
 237                 if (sizeof($this->overview[$_id]->children)) {
 238                     $this->overview[$this->overview[$_id]->parent]->children =
 239                         array_merge($this->overview[$this->overview[$_id]->parent]->children, $this->overview[$_id]->children);
 240                     foreach ($this->overview[$_id]->children as $c) {
 241                         $this->overview[$c]->parent        = $this->overview[$_id]->parent;
 242                         $this->overview[$c]->parent_direct = false;
 243                     }
 244                 }
 245                 $p = $this->overview[$_id]->parent;
 246                 while ($p) {
 247                     $this->overview[$p]->desc--;
 248                     $p = $this->overview[$p]->parent;
 249                 }
 250             } elseif (sizeof($this->overview[$_id]->children)) {
 251                 foreach ($this->overview[$_id]->children as $c) {
 252                     $this->overview[$c]->parent = null;
 253                 }
 254             }
 255             unset($this->overview[$_id]);
 256             $msgid = array_search($_id, $this->ids);
 257             if ($msgid) {
 258                 unset($this->ids[$msgid]);
 259             }
 260
 261             if ($write) {
 262                 $spool_path = dirname(dirname(__FILE__)).'/spool';
 263                 file_put_contents("$spool_path/spool-$_group.dat", serialize($this));
 264             }
 265         }
 266     }
 267
 268     /** displays children tree of a post
 269      * @param $_id INTEGER MSGNUM of post
 270      * @param $_index INTEGER linear number of post in the tree
 271      * @param $_first INTEGER linear number of first post displayed
 272      * @param $_last INTEGER linear number of last post displayed
 273      * @param $_ref STRING MSGNUM of current post
 274      * @param $_pfx_node STRING prefix used for current node
 275      * @param $_pfx_end STRING prefix used for children of current node
 276      * @param $_head BOOLEAN true if first post in thread
 277      */
 278
 279     function disp_desc($_id, $_index="", $_first=0, $_last=0, $_ref="", $_pfx_node="", $_pfx_end="", $_head=true) {
 280         global $css;
 281         $debug    = false;
 282         $spfx_f   = '<img src="img/k1.gif" height="21" width="9" alt="o" />';
 283         $spfx_n   = '<img src="img/k2.gif" height="21" width="9" alt="*" />';
 284         $spfx_Tnd = '<img src="img/T-direct.gif" height="21" width="12" alt="+" />';
 285         $spfx_Lnd = '<img src="img/L-direct.gif" height="21" width="12" alt="`" />';
 286         $spfx_snd = '<img src="img/s-direct.gif" height="21" width="5" alt="-" />';
 287         $spfx_T   = '<img src="img/T.gif" height="21" width="12" alt="+" />';
 288         $spfx_L   = '<img src="img/L.gif" height="21" width="12" alt="`" />';
 289         $spfx_s   = '<img src="img/s.gif" height="21" width="5" alt="-" />';
 290         $spfx_e   = '<img src="img/e.gif" height="21" width="12" alt="&nbsp;" />';
 291         $spfx_I   = '<img src="img/I.gif" height="21" width="12"alt="|" />';
 292
 293         if ($_index == "") {
 294             $_index = $this->getndx($_id);
 295         }
 296
 297         if (!sizeof($this->overview[$_id]->children) && ($_index<=$_last) && ($_index>=$_first)) {
 298             echo '<tr class="'.($_index%2?$css["pair"]:$css["impair"])."\">\n";
 299             echo "<td class=\"{$css['date']}\">"
 300                 .formatSpoolHeader("date", $this->overview[$_id]->date, $_id,
 301                         $this->group, ($_index==$_ref), $this->overview[$_id]->isread)
 302                 ." </td>\n";
 303             echo "<td class=\"{$css['subject']}\"><div class=\"{$css['tree']}\">"
 304                 .$_pfx_node.($_head?$spfx_f:
 305                         ($this->overview[$_id]->parent_direct?$spfx_s:$spfx_snd))
 306                 ."</div>"
 307                 .formatSpoolHeader("subject", $this->overview[$_id]->subject, $_id,
 308                         $this->group, ($_index==$_ref), $this->overview[$_id]->isread)
 309                 .($debug?" $_id $_index ".
 310                         $this->overview[$_id]->desc." ".$this->overview[$_id]->descunread." ":"")." </td>\n";
 311             echo "<td class=\"{$css['author']}\">"
 312                 .formatSpoolHeader("from", $this->overview[$_id]->from, $_id,
 313                         $this->group, ($_index==$_ref), $this->overview[$_id]->isread)
 314                 ." </td>\n</tr>";
 315             return true;
 316         }
 317         $children = $this->overview[$_id]->children;
 318         if (($_index<=$_last) && ($_index>=$_first)) {
 319             echo '<tr class="'.($_index%2?$css["pair"]:$css["impair"])."\">\n";
 320             echo "<td class=\"{$css['date']}\">"
 321                 .formatSpoolHeader("date", $this->overview[$_id]->date, $_id,
 322                         $this->group, ($_index==$_ref), $this->overview[$_id]->isread)
 323                 ." </td>\n";
 324             echo "<td class=\"{$css['subject']}\"><div class=\"{$css['tree']}\">"
 325                 .$_pfx_node.$spfx_n."</div>"
 326                 .formatSpoolHeader("subject", $this->overview[$_id]->subject, $_id,
 327                         $this->group, ($_index==$_ref), $this->overview[$_id]->isread)
 328                 .($debug?" $_id $_index ".
 329                         $this->overview[$_id]->desc." ".$this->overview[$_id]->descunread." ":"")." </td>\n";
 330             echo "<td class=\"{$css['author']}\">"
 331                 .formatSpoolHeader("from", $this->overview[$_id]->from, $_id,
 332                         $this->group, ($_index==$_ref), $this->overview[$_id]->isread)
 333                 ." </td>\n</tr>";
 334         }
 335         $index=$_index+1;
 336         while ($child = array_shift($children)) {
 337             if (($index+$this->overview[$child]->desc-1>=$_first)
 338                     ||($index<$_last)){
 339                 if (sizeof($children)) {
 340                     $this->disp_desc($child, $index, $_first, $_last, $_ref, $_pfx_end.
 341                             ($this->overview[$child]->parent_direct?$spfx_T:$spfx_Tnd),
 342                             $_pfx_end.$spfx_I, false);
 343                 } else {
 344                     $this->disp_desc($child, $index, $_first, $_last, $_ref, $_pfx_end.
 345                             ($this->overview[$child]->parent_direct?$spfx_L:$spfx_Lnd),
 346                             $_pfx_end.$spfx_e, false);
 347                 }
 348             }
 349             $index += $this->overview[$child]->desc;
 350         }
 351     }
 352
 353     /** Displays overview
 354      * @param $_first INTEGER MSGNUM of first post
 355      * @param $_last INTEGER MSGNUM of last post
 356      * @param $_ref STRING MSGNUM of current/selectionned post
 357      */
 358
 359     function disp($_first=0, $_last=0, $_ref="") {
 360         global $css;
 361         $index = 1;
 362         if (sizeof($this->overview)) {
 363             foreach ($this->overview as $id=>$msg) {
 364                 if (!isset($msg->parent)) {
 365                     $this->disp_desc($id, $index, $_first, $_last, $_ref);
 366                     $index += $msg->desc;
 367                 }
 368             }
 369         } else {
 370             echo "<tr class=\"{$css['pair']}\">\n";
 371             echo "\t<td colspan=\"3\">\n";
 372             echo "\t\tNo post in this newsgroup\n";
 373             echo "\t</td>\n";
 374             echo "</tr>\n";
 375         }
 376     }
 377
 378     /** computes linear post index
 379      * @param $_id INTEGER MSGNUM of post
 380      * @return INTEGER linear index of post
 381      */
 382
 383     function getndx($_id) {
 384         $ndx = 1;
 385         // on remonte l'arbre
 386         $id_parent = $this->overview[$_id]->parent;
 387         $id_curr   = $_id;
 388         while (!is_null($id_parent)) {
 389             for ($i=0; $i<array_search($id_curr, $this->overview[$id_parent]->children) ; $i++) {
 390                 $ndx += $this->overview[$this->overview[$id_parent]->children[$i]]->desc;
 391             }
 392             $ndx++; //noeud père
 393             $id_curr   = $id_parent;
 394             $id_parent = $this->overview[$id_curr]->parent;
 395         }
 396         // on compte les threads précédents
 397         foreach ($this->overview as $i=>$p) {
 398             if ($i==$id_curr) {
 399                 break;
 400             }
 401             if (is_null($p->parent)) {
 402                 $ndx += $this->overview[$i]->desc;
 403             }
 404         }
 405         return $ndx;
 406     }
 407 }
 408
 409 ?>