Source for file config.inc.php

<?php
/* ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
SVN Web Control
Copyright ©2006 by sTEFANs
Created on 26.02.2006
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
This program 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.
 
This program 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., 59 Temple Place - Suite 330,
Boston, MA 02111-1307, USA.
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
*/
 
/**
 * This file contains interfaces that needs to be implemented for project configuration.
 * 
 * @package Swc
 * @subpackage Inc
 * @author Stefan Schraml
 * @copyright Copyright ©2006 by sTEFANs
 * @license http://opensource.org/licenses/lgpl-license.php GNU General Public License
 * @version v1.1.0
 * @since v1.0.0
 */
  
/** 
 * This interface defines a factory for SVN Web Control (SWC) configuration.
 * There are two ways of applying configurations via Configuration Factory:
 * 1. In the root folder of a project that should
 *         be controlled via SWC is a frameset page. This
 *         frameset page offers just on frame. The source url
 *         of that frame points to swc/start.php and has a argument
 *         that points to the SWC configuration file for that project.
 *         This means the frame src could be swc/start.php?config=../conf.php.
 *         The path of the config file must be relative to SWC directory
 *         from SWCs point of view. The example above assumes that SWC is
 *         located within root/swc directory. By the way, it is a good idea
 *         to place the project also into a subdirectory of root, just keep
 *         everything clean and separated.
 *         Within this configuration file there must be function called
 *         <b>GetSwcConfigFactory()</b> that returns the implementation
 *         object of <b>SwcConfigFactory</b> and provides the config
 *         for the project.
 * 2. If a configuration factory is not provided as described above,
 *         SWC takes the config factory instance proivded within
 *         <b>.swc/config/std_config_factory.php</b>. This factory needs to be
 *         implemented in a way, that it returns <b>Configuration</b>s for
 *         all projects that should be controled by SWC.
 * 
 * Both scenarios described above has some advantages but also some disadvantages.
 * It depends highly on the development rules and environment, which one
 * to use. However, examples for both scenarios are provided together SWC.
 * Have a look into the html root directory for scenario 1 and into swc/config
 * for scenario 2.
 * @package Swc
 * @subpackage Inc
 * @author Stefan Schraml
 * @since v1.0.0
 */
interface SwcConfigFactory {
    
    /** 
     * Returns an array of <b>SwcConfig</b> objects.
     * These objects represents configured projects that
     * are selectable within the project list, if more
     * than one project is returned.
     * @return array Array of configured projects.
     * @see SwcConfig
     * @since v1.0.0
     */
    public function GetSwcConfigs();
}
 
/** 
 * This interface defines a configuration that encapsulates several project settings
 * needed by SVN Web Control. The main reason why a interface is chosen is to enable
 * multiple instances of configuration. This interface must be implemented
 * to configure projects.
 * @package Swc
 * @subpackage Inc
 * @author Stefan Schraml
 * @version v1.1.0
 * @since v1.0.0
 */
interface SwcConfig {
 
    /** 
     * Returns a user friendly name for the project.
     * @return string User friendly project name.
     * @since v1.0.0
     */
    public function GetProjectName();
    
    /** 
     * Returns the relative URL of the Webpage under control.
     * @return string URL of page to display in MainFrame.
     * @since v1.0.0
     */
    public function GetMainFrame();
    
    /** 
     * Returns the URL of the repository for the main frame.
     * @return string URL of repository. Any protocol
     *  (http://, svn://, etc.) is supported.
     *  <br>
     *  <b>Note:</b> <i>public function GetRepositoryRootDir</i> is deprecated
     *  and removed from <i>SwcConfig</i> interface in SWC v1.1.0.
     *  Please use <i>GetRepositoryRoot</i> instead.
     * @since v1.0.0
     */
    public function GetRepositoryRoot();
        
    /** 
     * Returns subdirectories which contains directories for tags.
     * @return array or string (Array of) repository directory that contains tags.
     * @since v1.0.0
     */
    public function GetTagDirs();
    
    /** 
     * Returns the maximum depth of directories that should be considered
     * as tag directory underneath <b>GetTagDirs()</b> hierarchy.
     * E.g. if this is set to 2 than GetTagDirs()/dir1/dir2 is considered
     * as tag directory while GetTagDirs()/dir1/dir2/dir3 is not.
     * @return int Maximal path depth for tag directories.
     * @since v1.0.0
     */
    public function GetMaxTagDirDepth();
    
    /** 
     * Returns subdirectories which contains directories for branches.
     * @return array or string (Array of) repository directory that contains branches.
     * @since v1.0.0
     */
    public function GetBranchDirs();
    
    /** 
     * Returns the maximum depth of directories that should be considered
     * as branch directory underneath <b>GetBranchDirs()</b> hierarchy.
     * E.g. if this is set to 2 than GetBranchDirs()/dir1/dir2 is considered
     * as tag directory while GetBranchDirs()/dir1/dir2/dir3 is not.
     * @return int Maximal path depth for branch directories.
     * @since v1.0.0
     */
    public function GetMaxBranchDirDepth();
    
    /** 
     * Returns subdirectoy which contains repository trunk.
     * @return string Repository directory that contains main developement.
     * @since v1.0.0
     */
    public function GetTrunkDir();
        
    /** 
     * Returns the absolute path of the workspace directory in the local file system.
     * @return string Absolute path of the workspace.
     *  <br>
     *  <b>Note:</b> <i>public function GetWebspaceRoot</i> is deprecated
     *  and removed from <i>SwcConfig</i> interface in SWC v1.1.0.
     *  Please use <i>GetWebspaceRootDir</i> instead.
     * @since v1.0.0
     */
    public function GetWebspaceRootDir();
    
    /** 
     * Returns the SVN user which should be used for repository access.
     * @return string SVN user.
     * @since v1.0.0
     */
    public function GetSvnUser();
    
    /** 
     * Returns the password of the SVN user which should be used for repository access.
     * @return string Password of SVN user.
     * @since v1.0.0
     */
    public function GetSvnPassword();
    
    /** 
     * Returns the URL of WebSVN view for this project or NULL if WebSVN is not available.
     * @return string URL for WebSVN view for this project.
     * @since v1.0.0
     */
    public function GetWebSvnUrl();
    
    /** 
     * Returns true if SVN command bar may be shown, false otherwise.
     * This setting overrides corresponding user setting in order to
     * protect the system agaist malicious commands.
     * @since v1.0.0
     */
    public function IsSvnCommandBarEnabled();
    
    /** 
     * Returns the directory for packed (release) archives called
     * spaceballs. Spaceballs archives are usually created for a dedicated revision.
     * <i>Note</i> PHP needs write access granted on this directory.
     * @return string Path for archive directory.
     * @since v1.1.0
     */
    public function GetSpaceballDir();
    
    /** 
     * Returns the HTTP URL for packed (release) archives. The
     * URL should point to the directory returned by
     * <i>GetSpaceballDir()</i>.
     * @return string URL for spaceball directory.
     * @since v1.1.0
     */
    public function GetSpaceballUrl();
}
 
/**
 * This interface contains any deprecated functions of interface <i>SwcConfig</i>
 * and is introduced for documentation purposes only. <br>
 * <b>Do not implement or extend this interface.</i>
 *  
 * @package Swc
 * @subpackage Inc
 * @author Stefan Schraml
 * @since v1.1.0
 */
interface DeprecatedSwcConfig extends SwcConfig {
    
    /** 
     * Returns the absolute path of the repository in the local file system.
     * @deprecated v1.1.0 Use GetRepositroyRoot() instead to configure the repository root.
     * @return string Absolute path of the repository.
     * @see SwcConfig::GetRepositoryRoot
     */
    public function GetRepositoryRootDir();
    
    /** 
     * Returns the URL for the workspace where the project
     * is checked out. Used by SVN.
     * @return string URL of Webspace.
     * @deprecated v1.1.0 Use <i>GetWebspaceRootDir</i> instead to configure
     *  webspace.
     * @see SwcConfig::GetWebspaceRootDir
     */
    public function GetWebspaceRoot();
}
 
/** 
 * This abstract class provides default implementations of
 * configuration methods that usually do not change. Deriving
 * from this class instead of the the interface minimizes the
 * number of methods that needs to be implemented.
 * @package Swc
 * @subpackage Inc
 * @author Stefan Schraml
 * @since v1.1.0
 */
abstract class SwcConfigAdapter implements SwcConfig {
    
    /** 
     * Returns subdirectories which contains directories for tags.
     * @return array or string (Array of) repository directory that contains tags.
     * @since v1.1.0
     */
    public function GetTagDirs(){
        return 'tags/';
    }
    
    /** 
     * Returns the maximum depth of directories that should be considered
     * as tag directory underneath <b>GetTagDirs()</b> hierarchy.
     * E.g. if this is set to 2 than GetTagDirs()/dir1/dir2 is considered
     * as tag directory while GetTagDirs()/dir1/dir2/dir3 is not.
     * @return int Maximal path depth for tag directories.
     * @since v1.1.0
     */
    public function GetMaxTagDirDepth(){
        return 1;
    }
    
    /** 
     * Returns subdirectories which contains directories for branches.
     * @return array or string (Array of) repository directory that contains branches.
     * @since v1.1.0
     */
    public function GetBranchDirs(){
        return 'branches/';
    }
    
    /** 
     * Returns the maximum depth of directories that should be considered
     * as branch directory underneath <b>GetBranchDirs()</b> hierarchy.
     * E.g. if this is set to 2 than GetBranchDirs()/dir1/dir2 is considered
     * as tag directory while GetBranchDirs()/dir1/dir2/dir3 is not.
     * @return int Maximal path depth for branch directories.
     * @since v1.1.0
     */
    public function GetMaxBranchDirDepth(){
        return 1;
    }
    
    /** 
     * Returns subdirectoy which contains repository trunk.
     * @return string Repository directory that contains main developement.
     * @since v1.1.0
     */
    public function GetTrunkDir(){
        return 'trunk/';
    }
    
    /** 
     * Returns the SVN user which should be used for repository access.
     * @return string SVN user.
     * @since v1.1.0
     */
    public function GetSvnUser(){
        return 'swc_user';
    }
    
    /** 
     * Returns the password of the SVN user which should be used for repository access.
     * @return string Password of SVN user.
     * @since v1.1.0
     */
    public function GetSvnPassword(){
        return 'swc_password';
    }
    
    /** 
     * Returns the URL of WebSVN view for this project or NULL if WebSVN is not available.
     * @since v1.1.0
     */
    public function GetWebSvnUrl(){
        return NULL;
    }
    
    /** 
     * Returns true if SVN command bar may be shown, false otherwise.
     * This setting overrides corresponding user setting in order to
     * protect the system agaist malicious commands.
     * @since v1.1.0
     */
    public function IsSvnCommandBarEnabled(){
        return true;
    }
    
    /** 
     * Returns the directory for packed (release) archives called
     * spaceballs. Spaceballs archives are usually created for a dedicated revision.
     * <i>Note</i> PHP needs write access granted on this directory.
     * @return string Path for archive directory.
     * @since v1.1.0
     */
    public function GetSpaceballDir() {
        $dir = $this->GetWebspaceRootDir().'archives';
        return $dir;
    }
    
    /** 
     * Returns the HTTP URL for packed (release) archives. The
     * URL should point to the directory returned by
     * <i>GetSpaceballDir()</i>. The default implementation
     * tries to match the frist part of <i>GetMainFrame()</i>
     * against the later part of <i>GetSpaceBallDir()</i>
     * since usually the URL for the main frame contains the
     * common root URL that also leads to the spaceball
     * directory URL. If this implementation does not fit
     * concrete requirments, this function must be overwritten
     * within the concrete project configuration.
     * @return string URL for spaceball directory.
     * @since v1.1.0
     */
    public function GetSpaceballUrl(){
        $dir = $this->GetSpaceballDir();
        $mf_url = $this->GetMainFrame();
        $dir_tmp = str_replace('\\', '/', $dir);
        $sb_dir_tokens = explode('/', $dir);
        $mf_url_tokens = explode('/', $mf_url);
        $common = array_intersect($sb_dir_tokens, $mf_url_tokens);
        $last = array_pop($common);
        $url = '';
        if ($last != NULL && $last != ''){    
            $mf_keys = array_keys($mf_url_tokens, $last);
            $mf_key = array_pop($mf_keys);
            $sb_keys = array_keys($sb_dir_tokens, $last);
            $sb_key = array_pop($sb_keys);
            $i = 0;
            while ($i <= $mf_key){
                $url .= $mf_url_tokens[$i].'/';
                $i++;
            }
            $i = $sb_key + 1;
            $cnt = count($sb_dir_tokens);
          while ($i < $cnt){
              $url .= $sb_dir_tokens[$i].'/';
              $i++;
          }
        }
        return $url;
    }
}
 
?>