Root/
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 | <?php/* -*- tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- *//*# ***** BEGIN LICENSE BLOCK *****# This file is part of InDefero, an open source project management application.# Copyright (C) 2008 Céondo Ltd and contributors.## InDefero is free software; you can redistribute it and/or modify# it under the terms of the GNU General Public License as published by# the Free Software Foundation; either version 2 of the License, or# (at your option) any later version.## InDefero is distributed in the hope that it will be useful,# but WITHOUT ANY WARRANTY; without even the implied warranty of# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the# GNU General Public License for more details.## You should have received a copy of the GNU General Public License# along with this program; if not, write to the Free Software# Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA## ***** END LICENSE BLOCK ***** *//** * Manage differents SCM systems. * * This is the base class with the different required methods to be * implemented by the SCMs. Each SCM backend need to extend this * class. We are not using an interface because this is not really * needed. * * The philosophy behind the interface is not to provide a wrapper * around the different SCMs but to provide methods to retrieve in the * most efficient way the informations to be displayed/needed in the * web interface. This means that each SCM can use the best options, * including caching to retrieve the informations. * * Note on caching: You must not cache ephemeral information like the * changelog, but you can cache the commit info (except with * subversion where you can change commit info...). It is ok to do * some caching for the lifetime of the IDF_Scm object, for example * not to retrieve several times the list of branches, etc. * * All the output of the methods must be serializable. This means that * if you are parsing XML you need to correctly cast the results as * string when needed. */class IDF_Scm{ /** * String template for consistent error messages. */ public $error_tpl = 'Error command "%s" returns code %d and output: %s'; /** * Path to the repository. */ public $repo = ''; /** * Corresponding project object. */ public $project = null; /** * Cache storage. * * It must only be used to store data for the lifetime of the * object. For example if you need to get the list of branches in * several functions, better to try to get from the cache first. */ protected $cache = array(); /** * Default constructor. */ public function __construct($repo, $project=null) { $this->repo = $repo; $this->project = $project; } /** * Returns an instance of the correct scm backend object. * * @param IDF_Project * @return Object */ public static function get($project) { // Get scm type from project conf ; defaults to git // We will need to cache the factory $scm = $project->getConf()->getVal('scm', 'git'); $scms = Pluf::f('allowed_scm'); return call_user_func(array($scms[$scm], 'factory'), $project); } /** * Returns the URL of the git daemon. * * @param IDF_Project * @return string URL */ public static function getAnonymousAccessUrl($project) { throw new Pluf_Exception_NotImplemented(); } /** * Returns the URL for SSH access * * @param IDF_Project * @param Pluf_User * @return string URL */ public static function getAuthAccessUrl($project, $user) { throw new Pluf_Exception_NotImplemented(); } /** * Check if the backend is available for display. * * @return bool Available */ public function isAvailable() { throw new Pluf_Exception_NotImplemented(); } /** * Check if a revision or commit is valid. * * @param string Revision or commit * @return bool */ public function isValidRevision($rev) { throw new Pluf_Exception_NotImplemented(); } /** * Returns in which branches a commit/path is. * * A commit can be in several branches and some of the SCMs are * managing branches using subfolders (like Subversion). * * This means that to know in which branch we are at the moment, * one needs to have both the path and the commit. * * @param string Commit * @param string Path * @return array Branches */ public function inBranches($commit, $path) { throw new Pluf_Exception_NotImplemented(); } /** * Returns the list of branches. * * The return value must be a branch indexed array with the * optional path to access the branch as value. For example with * git you would get (note that some people are using / in the * name of their git branches): * * <pre> * array('master' => '', * 'foo-branch' => '', * 'design/feature1' => '') * </pre> * * But with Subversion, as the branches are managed as subfolder * with a special folder for trunk, you would get something like: * * <pre> * array('trunk' => 'trunk', * 'foo-branch' => 'branches/foo-branch',) * </pre> * * @return array Branches */ public function getBranches() { throw new Pluf_Exception_NotImplemented(); } /** * Returns the list of tags. * * The format is the same as for the branches. * * @see self::getBranches() * * @return array Tags */ public function getTags() { throw new Pluf_Exception_NotImplemented(); } /** * Returns the main branch. * * The main branch is the one displayed by default. For example * master, trunk or tip. * * @return string */ public function getMainBranch() { throw new Pluf_Exception_NotImplemented(); } /** * Returns the list of files in a given folder. * * The list is an array of standard class objects with attributes * for each file/directory/external element. * * This is the most important method of the SCM backend as this is * the one conveying the speed feeling of the application. All the * dirty optimization tricks are allowed there. * * @param string Revision or commit * @param string Folder ('/') * @param string Branch (null) * @return array */ public function getTree($rev, $folder='/', $branch=null) { throw new Pluf_Exception_NotImplemented(); } /** * Get commit details. * * @param string Commit or revision number * @param bool Get commit diff (false) * @return stdClass */ public function getCommit($commit, $getdiff=false) { throw new Pluf_Exception_NotImplemented(); } /** * Get latest changes. * * It default to the main branch. If possible you should code in a * way to avoid repetitive calls to getCommit. Try to be * efficient. * * @param string Branch (null) * @param int Number of changes (25) * @return array List of commits */ public function getChangeLog($branch=null, $n=10) { throw new Pluf_Exception_NotImplemented(); } /** * Given the string describing the author from the log find the * author in the database. * * If the input is an array, it will return an array of results. * * @param mixed string/array Author * @return mixed Pluf_User or null or array */ public function findAuthor($author) { throw new Pluf_Exception_NotImplemented(); } /** * Given a revision and a file path, retrieve the file content. * * The $cmd_only parameter is to only request the command that is * used to get the file content. This is used when downloading a * file at a given revision as it can be passed to a * Pluf_HTTP_Response_CommandPassThru reponse. This allows to * stream a large response without buffering it in memory. * * The file definition is coming from getPathInfo(). * * @see self::getPathInfo() * * @param stdClass File definition * @param bool Returns command only (false) * @return string File content */ public function getFile($def, $cmd_only=false) { throw new Pluf_Exception_NotImplemented(); } /** * Get information about a file or a path. * * @param string File or path * @param string Revision (null) * @return mixed False or stdClass with info */ public function getPathInfo($file, $rev=null) { throw new Pluf_Exception_NotImplemented(); } /** * Given a revision and possible path returns additional properties. * * @param string Revision * @param string Path ('') * @return mixed null or array of properties */ public function getProperties($rev, $path='') { return null; } /** * Generate the command to create a zip archive at a given commit. * * @param string Commit * @param string Prefix ('repository/') * @return string Command */ public function getArchiveCommand($commit, $prefix='repository/') { throw new Pluf_Exception_NotImplemented(); } /** * Sync the changes in the repository with the timeline. * */ public static function syncTimeline($project) { $cache = Pluf_Cache::factory(); $key = 'IDF_Scm:'.$project->shortname.':lastsync'; if (null === ($res=$cache->get($key))) { $scm = IDF_Scm::get($project); foreach ($scm->getBranches() as $branche) { foreach ($scm->getChangeLog($branche, 25) as $change) { IDF_Commit::getOrAdd($change, $project); } } $cache->set($key, true, (int)(Pluf::f('cache_timeout', 300)/2)); } }} |
