No longer need the override for fetch_node()
[viewsvn.git] / 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 */
53 var $hash;
54
55 /**
56 * Record count - the number of records in cacheV
57 * @var integer
58 */
59 var $count;
60
61 /**
62 * Memcache for all fetched revisions so we don't have to query-dupe
63 * @var array
64 */
65 var $memcache = array('revs' => array(), 'nodes' => array());
66
67 // ###################################################################
68 /**
69 * Constructor: initialies the registry
70 *
71 * @param object Controller
72 */
73 function cacheV(&$controller)
74 {
75 $this->controller =& $controller;
76 $this->set_hash();
77 }
78
79 // ###################################################################
80 /**
81 * Sets the hash so we know what table we're dealing with
82 *
83 * @access public
84 */
85 function set_hash()
86 {
87 $this->hash = md5($this->controller->repospath);
88 $this->controller->registry->debug("hash: $this->hash");
89 }
90
91 // ###################################################################
92 /**
93 * Returns a node string that has the beginning and ending slashes
94 * removed to allow it to match to the _nodes cacheV table
95 *
96 * @access public
97 *
98 * @param string Original string
99 *
100 * @return string Matchable string
101 */
102 function fetch_node_string($node)
103 {
104 return preg_replace('#(^/|/$)#', '', $node);
105 }
106
107 // ###################################################################
108 /**
109 * Returns a specific log entry
110 *
111 * @access public
112 *
113 * @param integer Revision number
114 *
115 * @return array Complete revision/commit entry
116 */
117 function fetch_revision($revision)
118 {
119 $revision = $this->controller->registry->clean($revision, TYPE_UINT);
120
121 if (!isset($this->memcache['revs']["$revision"]))
122 {
123 $this->memcache['revs']["$revision"] = $this->controller->registry->db->query_first("SELECT * FROM {$this->hash}_revs " . ($revision == 0 ? " ORDER BY revision DESC LIMIT 1" : "WHERE revision = $revision"));
124 $this->memcache['revs']["$revision"]['files'] = unserialize($this->memcache['revs']["$revision"]['files']);
125 }
126
127 return $this->memcache['revs']["$revision"];
128 }
129
130 // ###################################################################
131 /**
132 * Returns the revision entry before the specified one
133 *
134 * @access public
135 *
136 * @param integer Revision number
137 *
138 * @return array Complete revision/commit entry
139 */
140 function fetch_prev_revision($revision)
141 {
142 $data = $this->fetch_node();
143 $data = $data['history'];
144 if (sizeof($data) < 1)
145 {
146 return $this->fetch_revision(0);
147 }
148
149 $list = array_keys($data);
150 $key = array_search($revision, $list);
151
152 if ($revision == 'HEAD')
153 {
154 $key = 0;
155 }
156
157 $key++; // go to the next earliest revision
158 if (!isset($list["$key"]))
159 {
160 return -1;
161 }
162
163 return $this->fetch_revision($list["$key"]);
164 }
165
166 // ###################################################################
167 /**
168 * Returns the latest revision that the file is at
169 *
170 * @access public
171 *
172 * @return integer HEAD revision
173 */
174 function fetch_head_revision()
175 {
176 $data = $this->fetch_node();
177 $data = $data['history'];
178
179 return max(array_keys($data));
180 }
181
182 // ###################################################################
183 /**
184 * Fetches the latest revision for a given path
185 *
186 * @access public
187 *
188 * @return integer Latest revision; FALSE if none (not in HEAD)
189 */
190 function fetch_node()
191 {
192 $node = $this->fetch_node_string(($node === false ? $this->controller->path : $node));
193 if (!isset($this->memcache['nodes']["$node"]))
194 {
195 $result = $this->controller->registry->db->query_first("SELECT * FROM {$this->hash}_nodes WHERE name = '" . $this->controller->registry->escape($node) . "'");
196 if ($result == false)
197 {
198 return false;
199 }
200
201 $this->memcache['nodes']["$node"] = $result;
202 $this->memcache['nodes']["$node"]['history'] = unserialize($this->memcache['nodes']["$node"]['history']);
203 }
204
205 return $this->memcache['nodes']["$node"];
206 }
207
208 // ###################################################################
209 /**
210 * Checks to see if a given node is a directory. Returns TRUE if so.
211 *
212 * @access public
213 *
214 * @return bool TRUE if directory, FALSE if not
215 */
216 function isdir()
217 {
218 $node = $this->fetch_node();
219 if ($node['node'] == 'dir')
220 {
221 return true;
222 }
223
224 return false;
225 }
226
227 // ###################################################################
228 /**
229 * Checks to see if it's necessary to rebuild the cacheV table for the
230 * current repository. This is done by making sure $count > 0. If not,
231 * then rebuild() is run. This also checks against the cacheV table
232 * to make sure that it's up-to-date against the root repository.
233 *
234 * @access public
235 */
236 function exec_build()
237 {
238 $result = $this->controller->registry->db->query_first("SELECT MAX(revision) AS max FROM {$this->hash}_revs");
239 $this->count = $result['max'];
240
241 // time to go from the start
242 if ($this->count == 0)
243 {
244 $this->build(null);
245 }
246 else
247 {
248 // send an Xquery to SVN to see if we need to update
249 $query = $this->controller->library->svn('info --xml ' . $this->controller->repospath);
250 $query = implode("\n", $query);
251
252 $tree = $this->controller->registry->xml->parse($query);
253
254 if ($tree['info']['entry']['revision'] != $this->count)
255 {
256 $this->build($this->count);
257 }
258 }
259 }
260
261 // ###################################################################
262 /**
263 * Builds the cacheV table. This can be used to build only part of the
264 * cache or the entire thing, if the revision is set to NULL.
265 *
266 * @access public
267 *
268 * @param integer Lower (current) revision
269 */
270 function build($revision)
271 {
272 $start = microtime();
273
274 // get _revs
275 $output = $this->controller->library->svn('log --xml -v ' . ($revision !== null ? '-r' . $revision . ':HEAD ' : '') . $this->controller->repospath);
276 $output = implode("\n", $output);
277 $tree = $this->controller->registry->xml->parse($output);
278
279 // get _nodes
280 $output = $this->controller->library->svn('info --xml -R ' . ($revision !== null ? '-r' . $revision . ':HEAD ' : '') . $this->controller->repospath);
281 $output = implode("\n", $output);
282 $infolist = $this->controller->registry->xml->parse($output);
283
284 // other part of _nodes: properties
285 $output = $this->controller->library->svn('proplist -v -R ' . ($revision !== null ? ' -r' . $revision . ':HEAD ' : '') . $this->controller->repospath);
286 foreach ($output AS $line)
287 {
288 if (preg_match('#^Properties on \'(.*?)\':$#', $line, $bits))
289 {
290 $proplist["$index"]["$curprop"] = trim($proplist["$index"]["$curprop"]);
291 $index = str_replace($this->controller->repospath, '', $bits[1]);
292 $capture = false;
293 }
294 else
295 {
296 if (preg_match('#^\s+(.*)\s:\s(.*)#', $line, $matches))
297 {
298 $curprop = $matches[1];
299 $proplist["$index"]["$curprop"] = $matches[2] . "\n";
300 $capture = true;
301 }
302 else if ($capture == true)
303 {
304 $proplist["$index"]["$curprop"] .= $line . "\n";
305 }
306 }
307 }
308
309 // construct _revs inserts and the list of add revisions
310 foreach ($tree['log']['logentry'] AS $log)
311 {
312 $this->controller->registry->xml->unify_node($log['paths']['path']);
313
314 $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'])) . "')";
315
316 foreach ($log['paths']['path'] AS $path)
317 {
318 if (trim($path['action']) == 'A')
319 {
320 $path['value'] = preg_replace('#^/#', '', $path['value']);
321 $addlist["$path[value]"] = $log['revision'];
322 }
323 }
324 }
325
326 // construct list of HEAD nodes for _nodes
327 foreach ($infolist['info']['entry'] AS $node)
328 {
329 $history = $this->controller->library->svn('log --xml ' . $node['url']['value']);
330 $history = implode("\n", $history);
331 $history = $this->controller->registry->xml->parse($history);
332
333 $loglist = array();
334 $latestrev = -1;
335 foreach ($history['log']['logentry'] AS $log)
336 {
337 // WHY THE HELL DOES THIS GET HIT ON REBUILDS?
338 if (!is_array($log))
339 {
340 print_r($node);
341 var_dump($log);
342 continue;
343 }
344 $loglist["$log[revision]"] = array(
345 'revision' => $log['revision'],
346 'author' => $log['author']['value'], // why does PHP5 hate this?
347 'date' => $log['date']['value'],
348 'message' => $log['msg']['value']
349 );
350 }
351
352 $path = str_replace($this->controller->repospath, '', $node['url']['value']);
353
354 $inserts['nodes'][] = "('$path', '" . $node['kind'] . "', " . $node['commit']['revision'] . ", '" . $this->controller->registry->escape(serialize($loglist)) . "', '" . $this->controller->registry->escape(serialize($proplist["$path"])) . "')";
355 }
356
357 // insert _revs
358 $this->controller->registry->db->query("
359 REPLACE INTO {$this->hash}_revs
360 (revision, author, dateline, message, files)
361 VALUES
362 " . implode(",\n", $inserts['revs'])
363 );
364
365 // insert _nodes
366 $this->controller->registry->db->query("
367 REPLACE INTO {$this->hash}_nodes
368 (name, node, revision, history, properties)
369 VALUES
370 " . implode(",\n", $inserts['nodes'])
371 );
372
373 $this->controller->registry->debug("TIME TO (RE)BUILD: " . $this->controller->registry->funct->fetch_microtime_diff($start));
374 }
375 }
376
377 /*=====================================================================*\
378 || ###################################################################
379 || # $HeadURL$
380 || # $Id$
381 || ###################################################################
382 \*=====================================================================*/
383 ?>