Enalean / tuleap

src/common/project/Project.class.php

<?php
/**
 * Copyright 1999-2000 (c) The SourceForge Crew
 * Copyright Enalean (c) 2015. All rights reserved.
 *
 * Tuleap and Enalean names and logos are registrated trademarks owned by
 * Enalean SAS. All other trademarks or names are properties of their respective
 * owners.
 *
 * This file is a part of Tuleap.
 *
 * Tuleap 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.
 *
 * Tuleap 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 Tuleap. If not, see <http://www.gnu.org/licenses/>.
 */

// see getProjectsDescFieldsInfos
function cmp($a, $b){
	if ($a["desc_rank"] == $b["desc_rank"]) {
        return 0;
    }
    return ($a["desc_rank"] < $b["desc_rank"]) ? -1 : 1;
}
 
function getProjectsDescFieldsInfos(){
	$sql = 'SELECT * FROM group_desc WHERE 1';
      
    $descfieldsinfos = array();
    if ($res = db_query($sql)) {
        while($data = db_fetch_array($res)) {
            $descfieldsinfos[] = $data;
        }
    }
    
	usort($descfieldsinfos, "cmp");
    return $descfieldsinfos;
}	


class Project extends Group implements PFO_Project {

    /**
     * The project is active
     */
    const STATUS_ACTIVE = 'A';
    
    /**
     * The project is pending
     */
    const STATUS_PENDING = 'P';

    /**
     * The project is incomplete
     */
    const STATUS_INCOMPLETE = 'I';

    /**
     * The project is holding
     */
    const STATUS_HOLDING = 'H';

    const SITE_NEWS_PROJECT_ID = 46;
    const ADMIN_PROJECT_ID     = 100;

    const ACCESS_PRIVATE             = 'private';
    const ACCESS_PUBLIC_UNRESTRICTED = 'unrestricted';
    const ACCESS_PUBLIC              = 'public';

    var $project_data_array;

    // All data concerning services for this project
    private $service_data_array = null;
    private $cache_active_services;
    private $services;
    
    /**
     * @var array The classnames for services
     */
    private $serviceClassnames;
    
    /*
		basically just call the parent to set up everything
                and set up services arrays
    */
    function Project($param) {
        $this->Group($param);
        
        //for right now, just point our prefs array at Group's data array
        //this will change later when we split the project_data table off from groups table
        $this->project_data_array = $this->data_array;
    }

    private function cacheServices() {
        if ($this->services !== null) {
            return;
        }

        $this->serviceClassnames = array(
            'file' => 'ServiceFile',
            'svn'  => 'ServiceSVN'
        );
        EventManager::instance()->processEvent(Event::SERVICE_CLASSNAMES, array('classnames' => &$this->serviceClassnames));

        // Get Service data
        $allowed_services = ServiceManager::instance()->getListOfAllowedServicesForProject($this);
        if (count($allowed_services) < 1) {
            $this->service_data_array = array();
        }
        $j = 1;
        foreach ($allowed_services as $service) {
            $res_row = $service->data;
            $short_name = $service->getShortName();
            if (! $short_name) {
                $short_name = $j++;
            }

            // needed for localisation
            $matches = array();
            if ($res_row['description'] == "service_" . $short_name . "_desc_key") {
                $res_row['description'] = $GLOBALS['Language']->getText('project_admin_editservice', $res_row['description']);
            } elseif (preg_match('/(.*):(.*)/', $res_row['description'], $matches)) {
                if ($GLOBALS['Language']->hasText($matches[1], $matches[2])) {
                    $res_row['description'] = $GLOBALS['Language']->getText($matches[1], $matches[2]);
                }
            }
            if ($res_row['label'] == "service_" . $short_name . "_lbl_key") {
                $res_row['label'] = $GLOBALS['Language']->getText('project_admin_editservice', $res_row['label']);
            } elseif (preg_match('/(.*):(.*)/', $res_row['label'], $matches)) {
                if ($GLOBALS['Language']->hasText($matches[1], $matches[2])) {
                    $res_row['label'] = $GLOBALS['Language']->getText($matches[1], $matches[2]);
                }
            }

            $this->service_data_array[$short_name] = $res_row;
            $this->services[$short_name] = $service;
            if ($service->isActive()) {
                $this->cache_active_services[] = $service;
            }
        }
    }

    public function getMinimalRank() {
        // get it, no matter if summary is enabled or not
        $this->cacheServices();
        return $this->services[Service::SUMMARY]->getRank();
    }

    public function getServiceLabel($short_name) {
        return $this->getService($short_name)->getLabel();
    }

    private function getServiceLink($short_name) {
        return $this->getService($short_name)->getUrl();
    }

    public function getServicesData() {
        $this->cacheServices();
        return $this->service_data_array;
    }

    /**
     * Return the name of the class to instantiate a service based on its short name
     *
     * @param string $short_name the short name of the service
     *
     * @return string
     */
    public function getServiceClassName($short_name) {
        $classname = 'Service';
        if (isset($this->serviceClassnames[$short_name])) {
            $classname = $this->serviceClassnames[$short_name];
        }
        return $classname;
    }

    /**
     * Return service corresponding to project
     *
     * @param String $service_name
     * 
     * @return Service
     */
    public function getService($service_name) {
        $this->cacheServices();
        return $this->usesService($service_name) ? $this->services[$service_name] : null;
    }

    /**
     * 
     * @return array
     */
    public function getAllUsedServices() {
        $used_services = array();
        foreach($this->getServices() as $service) {
            if ($service->isUsed()) {
                $used_services[] = $service->getShortName();
            }
        }
        
        return $used_services;
    }

    /**
     * @return Service[]
     */
    public function getServices() {
        $this->cacheServices();
        return $this->services;
    }

    public function getActiveServices() {
        $this->cacheServices();
        return $this->cache_active_services;
    }
    
    function usesHomePage() {
        return $this->usesService(Service::HOMEPAGE);
    }
    
    function usesAdmin() {
        return $this->usesService(Service::ADMIN);
    }
    
    function usesSummary() {
        return $this->usesService(Service::SUMMARY);
    }

    function usesTracker() {
        return $this->usesService(Service::TRACKERV3);
    }

    function usesCVS() {
        return $this->usesService(Service::CVS);
    }

    function usesSVN() {
        return $this->usesService(Service::SVN);
    }

    function usesDocman() {
        return $this->usesService(Service::LEGACYDOC);
    }

    function usesFile() {
        return $this->usesService(Service::FILE);
    }

    //whether or not this group has opted to use mailing lists
    function usesMail() {
        return $this->usesService(Service::ML);
    }

    //whether or not this group has opted to use news
    function usesNews() {
        return $this->usesService(Service::NEWS);
    }

    //whether or not this group has opted to use discussion forums
    function usesForum() {
        return $this->usesService(Service::FORUM);
    }       

    //whether or not this group has opted to use surveys
    function usesSurvey() {
        return $this->usesService(Service::SURVEY);
    }       

    //whether or not this group has opted to use wiki
    function usesWiki() {
        return $this->usesService(Service::WIKI);
    }   


    // Generic versions

    function usesService($service_short_name) {
        $data = $this->getServicesData();
        return isset($data[$service_short_name]) && $data[$service_short_name]['is_used'];
    }

    /*
        The URL for this project's home page
    */
    function getHomePage() {
        return $this->usesHomePage() ? $this->getServiceLink(Service::HOMEPAGE) : '';
    }
    
    function getWikiPage(){
        return $this->getServiceLink(Service::WIKI);
    }

    function getForumPage(){
        return $this->getServiceLink(Service::FORUM);
    }
    
    function getMailPage(){
        return $this->getServiceLink(Service::ML);
    }
    
    function getCvsPage(){
        return $this->getServiceLink(Service::CVS);
    }
    
    function getSvnPage(){
        return $this->getServiceLink(Service::SVN);
    }
    
    function getTrackerPage(){
        return $this->getServiceLink(Service::TRACKERV3);
    }
    
    /*

    Subversion and CVS settings

    */

    function cvsMailingList() {
        return $this->project_data_array['cvs_events_mailing_list'];
    }

    function getCVSMailingHeader() {
        return $this->project_data_array['cvs_events_mailing_header'];
    }

    function isCVSTracked() {
        return $this->project_data_array['cvs_tracker'];
    }

    function getCVSWatchMode() {
        return $this->project_data_array['cvs_watch_mode'];
    }

    function getCVSpreamble() {
        return $this->project_data_array['cvs_preamble'];
    }
    
    function isCVSPrivate() {
        return $this->project_data_array['cvs_is_private'];
    }

    function getSVNMailingHeader() {
        return $this->project_data_array['svn_events_mailing_header'];
    }

    function isSVNTracked() {
        return $this->project_data_array['svn_tracker'];
    }

    function isSVNMandatoryRef() {
        return $this->project_data_array['svn_mandatory_ref'];
    }

    function canChangeSVNLog(){
        return $this->project_data_array['svn_can_change_log'];
    }
    
    function getSVNpreamble() {
        return $this->project_data_array['svn_preamble'];
    }

    function isSVNPrivate() {
        // TODO XXXX not implemented yet.
        return false;
    }
    
    function getSVNAccess() {
        return $this->project_data_array['svn_accessfile'];
    }

    public function getAccess() {
        return $this->data_array['access'];
    }

    public function getTruncatedEmailsUsage() {
        return $this->data_array['truncated_emails'];
    }

    public function isPublic() {
        $access = $this->data_array['access'];
        return $access != Project::ACCESS_PRIVATE;
    }

    /**
     * @return boolean
     */
    public function allowsRestricted() {
        return $this->getAccess() === self::ACCESS_PUBLIC_UNRESTRICTED
            || $this->isSuperPublic();
    }

    private function isSuperPublic() {
        $super_public_projects = ForgeConfig::getSuperPublicProjectsFromRestrictedFile();

        return in_array($this->getID(), $super_public_projects);
    }

    /**
     * SVN root path must have project name in mixed case.
     *
     * @return String
     */
    public function getSVNRootPath() {
        return ForgeConfig::get('svn_prefix') . DIRECTORY_SEPARATOR . $this->getUnixNameMixedCase();
    }

    function getProjectsCreatedFrom() {
        $sql = 'SELECT * FROM groups WHERE built_from_template = '. $this->getGroupId() ." AND status <> 'D'";
        $subprojects = array();
        if ($res = db_query($sql)) {
            while($data = db_fetch_array($res)) {
                $subprojects[] = $data;
            }
        }
        return $subprojects;
    }
    
    function getProjectsDescFieldsValue(){
    	$sql = 'SELECT group_desc_id, value FROM group_desc_value WHERE group_id='.$this->getGroupId() ;
        
        $descfieldsvalue = array();
        if ($res = db_query($sql)) {
            while($data = db_fetch_array($res)) {
                $descfieldsvalue[] = $data;
            }
        }
        
        return $descfieldsvalue;
    }
    
    function displayProjectsDescFieldsValue(){
    	$descfieldsvalue=$this->getProjectsDescFieldsValue();
    	$descfields = getProjectsDescFieldsInfos();
    	$hp = Codendi_HTMLPurifier::instance();
    	
    	for($i=0;$i<sizeof($descfields);$i++){

It seems like you are calling the size function sizeof() as part of the test condition. You might want to compute the size beforehand, and not on each iteration.

	
			$displayfieldname[$i]=$descfields[$i]['desc_name'];
			$displayfieldvalue[$i]='';
			for($j=0;$j<sizeof($descfieldsvalue);$j++){

It seems like you are calling the size function sizeof() as part of the test condition. You might want to compute the size beforehand, and not on each iteration.

				
				if($descfieldsvalue[$j]['group_desc_id']==$descfields[$i]['group_desc_id']){
					$displayfieldvalue[$i]=$descfieldsvalue[$j]['value'];
				}	
			}
			
			$descname=$displayfieldname[$i];
                        if (preg_match('/(.*):(.*)/', $descname, $matches)) {
                            if ($GLOBALS['Language']->hasText($matches[1], $matches[2])) {
                                $descname = $GLOBALS['Language']->getText($matches[1], $matches[2]);
                            }
                        }
			
			echo "<h3>".$hp->purify($descname,CODENDI_PURIFIER_LIGHT,$this->getGroupId())."</h3>";
			echo "<p>";
			echo ($displayfieldvalue[$i] == '') ? $GLOBALS['Language']->getText('global','none') : $hp->purify($displayfieldvalue[$i], CODENDI_PURIFIER_LIGHT,$this->getGroupId())  ;
			echo "</p>";
			
		}
    	
    }

    private function getUGroupManager() {
        return new UGroupManager();
    }

    /**
     * @return array of User admin of the project
     */
    public function getAdmins() {
        return $this->getUGroupManager()->getDynamicUGroupsMembers(ProjectUGroup::PROJECT_ADMIN, $this->getID());
    }

    /**
     * @return array of User members of the project
     */
    public function getMembers() {
        return $this->getUGroupManager()->getDynamicUGroupsMembers(ProjectUGroup::PROJECT_MEMBERS, $this->getID());
    }

    /**
     * Alias of @see getMembers()
     */
    public function getUsers() {
        return $this->getMembers();
    }
    
    /**
     * getRolesId - Get the roles of the group.
     *
     * @return      array   Role ids of this group.
     */
    function getRolesId() {
            $role_ids = array();

            /*if (USE_PFO_RBAC) {
                    $res = db_query_params('SELECT role_id FROM pfo_role WHERE home_group_id=$1',
                                            array($this->getID()));
                    while ($arr = db_fetch_array($res)) {
                            $role_ids[] = $arr['role_id'];
                    }
                    $res = db_query_params('SELECT role_id FROM role_project_refs WHERE group_id=$1',
                                            array($this->getID()));
                    while ($arr = db_fetch_array($res)) {
                            $role_ids[] = $arr['role_id'];
                    }
            } else {
                    $res = db_query_params('SELECT role_id FROM role WHERE group_id=$1',
                                                        array($this->getID()));
                    while ($arr = db_fetch_array($res)) {
                            $role_ids[] = $arr['role_id'];
                    }
            }*/

            return array_unique($role_ids);
    }

    /**
     * getRoles - Get the roles of the group.
     *
     * @return      array   Roles of this group.
     */
    function getRoles() {
            $result = array();

            /*$roles = $this->getRolesId();
            if (USE_PFO_RBAC) {
                    $engine = RBACEngine::getInstance();
                    foreach ($roles as $role_id) {
                            $result[] = $engine->getRoleById ($role_id);
                    }
            } else {
                    foreach ($roles as $role_id) {
                            $result[] = new Role ($this, $role_id);
                    }
            }*/

            return $result;
    }

    public function projectsMustBeApprovedByAdmin() {
        return ForgeConfig::get('sys_project_approval', 1) === 1;
    }
}
?>