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