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): * *
     * array('master' => '',
     *       'foo-branch' => '',
     *       'design/feature1' => '')
     * 
* * But with Subversion, as the branches are managed as subfolder * with a special folder for trunk, you would get something like: * *
     * array('trunk' => 'trunk',
     *       'foo-branch' => 'branches/foo-branch',)
     * 
* * @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 => $path) { foreach ($scm->getChangeLog($branche, 25) as $change) { IDF_Commit::getOrAdd($change, $project); } } $cache->set($key, true, (int)(Pluf::f('cache_timeout', 300)/2)); } } }