includes/cachev.php

   1 <?php
   2 /*=====================================================================*\
   3 || ###################################################################
   4 || # ViewSVN [#]version[#]
   5 || # Copyright ©2002-[#]year[#] Iris Studios, Inc.
   6 || #
   7 || # This program is free software; you can redistribute it and/or modify
   8 || # it under the terms of the GNU General Public License as published by
   9 || # the Free Software Foundation; version [#]gpl[#] of the License.
  10 || #
  11 || # This program is distributed in the hope that it will be useful, but
  12 || # WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
  13 || # or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
  14 || # more details.
  15 || #
  16 || # You should have received a copy of the GNU General Public License along
  17 || # with this program; if not, write to the Free Software Foundation, Inc.,
  18 || # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
  19 || ###################################################################
  20 \*=====================================================================*/
  21
  22 /**
  23 * File container for cacheV class
  24 *
  25 * @package      ViewSVN
  26 */
  27
  28 /**
  29 * cacheV
  30 *
  31 * This class is responsible for interacting with a given cacheV table.
  32 * It controls rebuilding from scratch, updates, and querying the cache.
  33 *
  34 * @author               Iris Studios, Inc.
  35 * @copyright    Copyright ©2002 - [#]year[#], Iris Studios, Inc.
  36 * @version              $Revision$
  37 * @package              ViewSVN
  38 *
  39 */
  40 class cacheV
  41 {
  42         /**
  43         * Controller
  44         * @var  object
  45         * @access       private
  46         */
  47         var $controller = null;
  48
  49         /**
  50         * cacheV hash
  51         * @var  string
  52         * @access       private
  53         */
  54         var $hash;
  55
  56         /**
  57         * Record count - the number of records in cacheV
  58         * @var  integer
  59         * @access       private
  60         */
  61         var $count;
  62
  63         /**
  64         * Memcache for all fetched revisions so we don't have to query-dupe
  65         * @var  array
  66         * @access       private
  67         */
  68         var $memcache = array('revs' => array(), 'nodes' => array());
  69
  70         // ###################################################################
  71         /**
  72         * Constructor: initialies the registry
  73         *
  74         * @param        object  Controller
  75         */
  76         function cacheV(&$controller)
  77         {
  78                 $this->controller =& $controller;
  79                 $this->set_hash();
  80         }
  81
  82         // ###################################################################
  83         /**
  84         * Sets the hash so we know what table we're dealing with
  85         *
  86         * @access       public
  87         */
  88         function set_hash()
  89         {
  90                 $this->hash = md5($this->controller->repospath);
  91                 $this->controller->registry->debug("hash: $this->hash");
  92         }
  93
  94         // ###################################################################
  95         /**
  96         * Returns a node string that has the beginning and ending slashes
  97         * removed to allow it to match to the _nodes cacheV table
  98         *
  99         * @access       public
 100         *
 101         * @param        string  Original string
 102         *
 103         * @return       string  Matchable string
 104         */
 105         function fetch_node_string($node)
 106         {
 107                 trigger_error('You shouldn\'t be calling fetch_node_string. It\'s evil.', E_USER_WARNING);
 108                 return preg_replace('#(^/|/$)#', '', $node);
 109         }
 110
 111         // ###################################################################
 112         /**
 113         * Returns a specific log entry
 114         *
 115         * @access       public
 116         *
 117         * @param        integer Revision number
 118         *
 119         * @return       array   Complete revision/commit entry
 120         */
 121         function fetch_revision($revision)
 122         {
 123                 $revision = $this->controller->registry->clean($revision, TYPE_UINT);
 124
 125                 if (!isset($this->memcache['revs']["$revision"]))
 126                 {
 127                         $this->memcache['revs']["$revision"] = $this->controller->registry->db->query_first("SELECT * FROM c{$this->hash}_revs " . ($revision == 0 ? " ORDER BY revision DESC LIMIT 1" : "WHERE revision = $revision"));
 128                         $this->memcache['revs']["$revision"]['files'] = unserialize($this->memcache['revs']["$revision"]['files']);
 129                 }
 130
 131                 return $this->memcache['revs']["$revision"];
 132         }
 133
 134         // ###################################################################
 135         /**
 136         * Returns the revision entry before the specified one
 137         *
 138         * @access       public
 139         *
 140         * @param        integer Revision number
 141         *
 142         * @return       array   Complete revision/commit entry
 143         */
 144         function fetch_prev_revision($revision)
 145         {
 146                 $data = $this->fetch_node();
 147                 $data = $data['history'];
 148                 if (sizeof($data) < 1)
 149                 {
 150                         return $this->fetch_revision(0);
 151                 }
 152
 153                 $list = array_keys($data);
 154                 $key = array_search($revision, $list);
 155
 156                 if ($revision == 'HEAD')
 157                 {
 158                         $key = 0;
 159                 }
 160
 161                 $key++; // go to the next earliest revision
 162                 if (!isset($list["$key"]))
 163                 {
 164                         return -1;
 165                 }
 166
 167                 return $this->fetch_revision($list["$key"]);
 168         }
 169
 170         // ###################################################################
 171         /**
 172         * Returns the latest revision that the file is at
 173         *
 174         * @access       public
 175         *
 176         * @return       integer HEAD revision
 177         */
 178         function fetch_head_revision()
 179         {
 180                 $data = $this->fetch_node();
 181                 $data = $data['history'];
 182
 183                 return max(array_keys($data));
 184         }
 185
 186         // ###################################################################
 187         /**
 188         * Returns the revision entry that it's in context with the node. For
 189         * instance, if the version 50 was passed and this node only has 48 as
 190         * it's max, 48 will be returned.
 191         *
 192         * @access       public
 193         *
 194         * @param        integer Target revision
 195         *
 196         * @return       integer Contextual revision
 197         */
 198         function fetch_revision_context($target)
 199         {
 200                 $data = $this->fetch_node();
 201                 $data = $data['history'];
 202
 203                 if ($target == 'HEAD')
 204                 {
 205                         $target = $this->fetch_head_revision();
 206                 }
 207
 208                 if (isset($data["$target"]))
 209                 {
 210                         return $this->fetch_revision($target);
 211                 }
 212
 213                 $keys = array_keys($data);
 214
 215                 $prev = 0;
 216                 foreach ($keys AS $id => $revnum)
 217                 {
 218                         if ($target > $revnum)
 219                         {
 220                                 $prev = $revnum;
 221                                 if ($prev > $rev)
 222                                 {
 223                                         $rev = $prev;
 224                                 }
 225                         }
 226                         else if ($target < $revnum)
 227                         {
 228                                 $rev = $prev;
 229                         }
 230                         else
 231                         {
 232                                 $rev = $keys[0];
 233                         }
 234                 }
 235
 236                 return $this->fetch_revision($rev);
 237         }
 238
 239         // ###################################################################
 240         /**
 241         * Fetches the latest revision for a given path
 242         *
 243         * @access       public
 244         *
 245         * @return       integer Latest revision; FALSE if none (not in HEAD)
 246         */
 247         function fetch_node()
 248         {
 249                 $node = $this->controller->path;
 250                 if (!isset($this->memcache['nodes']["$node"]))
 251                 {
 252                         $result = $this->controller->registry->db->query_first("SELECT * FROM c{$this->hash}_nodes WHERE name = '" . $this->controller->registry->escape($node) . "'");
 253                         if ($result == false)
 254                         {
 255                                 return false;
 256                         }
 257
 258                         $this->memcache['nodes']["$node"] = $result;
 259                         $this->memcache['nodes']["$node"]['history'] = unserialize($this->memcache['nodes']["$node"]['history']);
 260                         $this->memcache['nodes']["$node"]['properties'] = unserialize($this->memcache['nodes']["$node"]['properties']);
 261                 }
 262
 263                 return $this->memcache['nodes']["$node"];
 264         }
 265
 266         // ###################################################################
 267         /**
 268         * Checks to see if a given node is a directory. Returns TRUE if so.
 269         *
 270         * @access       public
 271         *
 272         * @return       bool    TRUE if directory, FALSE if not
 273         */
 274         function isdir()
 275         {
 276                 $node = $this->fetch_node();
 277                 if ($node['node'] == 'dir')
 278                 {
 279                         return true;
 280                 }
 281
 282                 return false;
 283         }
 284
 285         // ###################################################################
 286         /**
 287         * Checks to see if it's necessary to rebuild the cacheV table for the
 288         * current repository. This is done by making sure $count > 0. If not,
 289         * then rebuild() is run. This also checks against the cacheV table
 290         * to make sure that it's up-to-date against the root repository.
 291         *
 292         * @access       public
 293         *
 294         * @return       bool    Whether or not any part of the cache was (re-)built
 295         */
 296         function exec_build()
 297         {
 298                 $result = $this->controller->registry->db->query_first("SELECT MAX(revision) AS max FROM c{$this->hash}_revs");
 299                 $this->count = $result['max'];
 300
 301                 // time to go from the start
 302                 if ($this->count == 0)
 303                 {
 304                         $this->build(null);
 305                 }
 306                 else
 307                 {
 308                         // send an Xquery to SVN to see if we need to update
 309                         $query = $this->controller->library->svn('info --xml ' . $this->controller->repospath);
 310                         $query = implode("\n", $query);
 311
 312                         $tree = $this->controller->registry->xml->parse($query);
 313
 314                         if ($tree['info']['entry']['revision'] != $this->count)
 315                         {
 316                                 $this->build($this->count);
 317                                 return true;
 318                         }
 319                 }
 320
 321                 return false;
 322         }
 323
 324         // ###################################################################
 325         /**
 326         * Builds the cacheV table. This can be used to build only part of the
 327         * cache or the entire thing, if the revision is set to NULL.
 328         *
 329         * @access       public
 330         *
 331         * @param        integer Lower (current) revision
 332         * @param        bool    Use separate and individual queries for inserting?
 333         */
 334         function build($revision, $seps = false)
 335         {
 336                 $start = microtime();
 337
 338                 // get _revs
 339                 $output = $this->controller->library->svn('log --xml -v ' . ($revision !== null ? '-r' . $revision . ':HEAD ' : '') . $this->controller->repospath);
 340                 $output = implode("\n", $output);
 341                 $tree = $this->controller->registry->xml->parse($output);
 342
 343                 // get _nodes
 344                 $output = $this->controller->library->svn('info --xml -R ' . $this->controller->repospath);
 345                 $output = implode("\n", $output);
 346                 $infolist = $this->controller->registry->xml->parse($output);
 347
 348                 // other part of _nodes: properties
 349                 $output = $this->controller->library->svn('proplist -v -R ' . $this->controller->repospath);
 350                 $init = false;
 351                 foreach ($output AS $line)
 352                 {
 353                         if (preg_match('#^Properties on \'(.*?)\':$#', $line, $bits))
 354                         {
 355                                 if ($init == true)
 356                                 {
 357                                         $proplist["$index"]["$curprop"] = trim($proplist["$index"]["$curprop"]);
 358                                 }
 359                                 $init = true;
 360
 361                                 $index = str_replace($this->controller->repospath, '', $bits[1]);
 362                                 $index = ($index == '' ? '/' : $index);
 363                                 $capture = false;
 364                         }
 365                         else
 366                         {
 367                                 if (preg_match('#^\s+(.*)\s:\s(.*)#', $line, $matches))
 368                                 {
 369                                         $curprop = $matches[1];
 370                                         $proplist["$index"]["$curprop"] = $matches[2] . "\n";
 371                                         $capture = true;
 372                                 }
 373                                 else if ($capture == true)
 374                                 {
 375                                         $proplist["$index"]["$curprop"] .= $line . "\n";
 376                                 }
 377                         }
 378                 }
 379
 380                 // construct _revs inserts and the list of add revisions
 381                 foreach ($tree['log']['logentry'] AS $log)
 382                 {
 383                         $this->controller->registry->xml->unify_node($log['paths']['path']);
 384
 385                         $inserts['revs'][] = "($log[revision], '{$log['author']['value']}', '{$log['date']['value']}', '" . $this->controller->registry->escape($log['msg']['value']) . "', '" . $this->controller->registry->escape(serialize($log['paths']['path'])) . "')";
 386
 387                         foreach ($log['paths']['path'] AS $path)
 388                         {
 389                                 if (trim($path['action']) == 'A')
 390                                 {
 391                                         $path['value'] = preg_replace('#^/#', '', $path['value']);
 392                                         $addlist["$path[value]"] = $log['revision'];
 393                                 }
 394                         }
 395                 }
 396
 397                 // construct list of HEAD nodes for _nodes
 398                 foreach ($infolist['info']['entry'] AS $node)
 399                 {
 400                         $history = $this->controller->library->svn('log --xml ' . $node['url']['value']);
 401                         $history = implode("\n", $history);
 402                         $history = $this->controller->registry->xml->parse($history);
 403
 404                         $loglist = array();
 405                         $latestrev = -1;
 406                         foreach ($history['log']['logentry'] AS $log)
 407                         {
 408                                 // WHY THE HELL DOES THIS GET HIT ON REBUILDS?
 409                                 if (!is_array($log))
 410                                 {
 411                                         print_r($node);
 412                                         var_dump($log);
 413                                         continue;
 414                                 }
 415                                 $loglist["$log[revision]"] = array(
 416                                         'revision'      => $log['revision'],
 417                                         'author'        => $log['author']['value'], // why does PHP5 hate this?
 418                                         'date'          => $log['date']['value'],
 419                                         'message'       => $log['msg']['value']
 420                                 );
 421                         }
 422
 423                         $path = str_replace($this->controller->repospath, '', $node['url']['value']);
 424                         $path = ($path == '' ? '/' : $path);
 425
 426                         $inserts['nodes'][] = "('$path', '" . $node['kind'] . "', " . $node['commit']['revision'] . ", '" . $this->controller->registry->escape(serialize($loglist)) . "', '" . $this->controller->registry->escape(serialize($proplist["$path"])) . "')";
 427                 }
 428
 429                 if ($seps == false)
 430                 {
 431                         // insert _revs
 432                         $this->controller->registry->db->query("
 433                                 REPLACE INTO c{$this->hash}_revs
 434                                         (revision, author, dateline, message, files)
 435                                 VALUES
 436                                         " . implode(",\n", $inserts['revs'])
 437                         );
 438
 439                         // insert _nodes
 440                         $this->controller->registry->db->query("
 441                                 REPLACE INTO c{$this->hash}_nodes
 442                                         (name, node, revision, history, properties)
 443                                 VALUES
 444                                         " . implode(",\n", $inserts['nodes'])
 445                         );
 446                 }
 447                 else
 448                 {
 449                         // _revs
 450                         foreach ($inserts['revs'] AS $insert)
 451                         {
 452                                 $this->controller->registry->db->query("
 453                                         REPLACE INTO c{$this->hash}_revs
 454                                                 (revision, author, dateline, message, files)
 455                                         VALUES
 456                                                 $insert"
 457                                 );
 458                         }
 459
 460                         // _nodes
 461                         foreach ($inserts['nodes'] AS $insert)
 462                         {
 463                                 $this->controller->registry->db->query("
 464                                         REPLACE INTO c{$this->hash}_nodes
 465                                                 (name, node, revision, history, properties)
 466                                         VALUES
 467                                                 $insert"
 468                                 );
 469                         }
 470                 }
 471
 472                 $this->controller->registry->debug("TIME TO (RE)BUILD: " . $this->controller->registry->funct->fetch_microtime_diff($start));
 473         }
 474 }
 475
 476 /*=====================================================================*\
 477 || ###################################################################
 478 || # $HeadURL$
 479 || # $Id$
 480 || ###################################################################
 481 \*=====================================================================*/
 482 ?>