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