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