Move projectlist classes to their own folder
[gitphp.git] / include / git / ProjectListScmManager.class.php
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
<?php
/**
 * GitPHP ProjectListScmManager
 *
 * Lists all projects in an scm-manager config file
 *
 * @author Christopher Han <xiphux@gmail.com>
 * @copyright Copyright (c) 2011 Christopher Han
 * @package GitPHP
 * @subpackage Git
 */
 
require_once(GITPHP_INCLUDEDIR . 'Config.class.php');
require_once(GITPHP_GITOBJECTDIR . 'ProjectListBase.class.php');
require_once(GITPHP_GITOBJECTDIR . 'Project.class.php');
 
/**
 * ProjectListScmManager class
 *
 * @package GitPHP
 * @subpackage Git
 */
class GitPHP_ProjectListScmManager extends GitPHP_ProjectListBase
{
        /**
         * fileContents
         *
         * Stores the contents of the project config file
         *
         * @access protected
         */
        protected $fileContents = array();
 
        /**
         * fileRead
         *
         * Stores whether the file has been read
         *
         * @access protected
         */
        protected $fileRead = false;
        
        /**
         * __construct
         *
         * constructor
         *
         * @param string $projectRoot project root
         * @param string $projectFile file to read
         * @throws Exception if parameter is not a readable file
         * @access public
         */
        public function __construct($projectRoot, $projectFile)
        {
                if (!(is_string($projectFile) && is_file($projectFile))) {
                        throw new Exception(sprintf(__('%1$s is not a file'), $projectFile));
                }
 
                $this->projectConfig = $projectFile;
 
                parent::__construct($projectRoot);
        }
 
        /**
         * PopulateProjects
         *
         * Populates the internal list of projects
         *
         * @access protected
         * @throws Exception if file cannot be read
         */
        protected function PopulateProjects()
        {
                if (!$this->fileRead)
                        $this->ReadFile();
 
                foreach ($this->fileContents as $projData) {
                        $projObj = $this->InstantiateProject($projData['name']);
                        if ($projObj) {
                                $this->projects[$projData['name']] = $projObj;
                                unset($projObj);
                        }
                }
        }
 
        /**
         * InstantiateProject
         *
         * Instantiates the project object
         *
         * @access protected
         * @param string $proj project
         * @return mixed project object
         */
        protected function InstantiateProject($proj)
        {
                if (!$this->fileRead)
                        $this->ReadFile();
 
                $data = null;
                $found = false;
 
                foreach ($this->fileContents as $projData) {
                        if (isset($projData) && ($proj == $projData['name'])) {
                                $data = $projData;
                                $found = true;
                                break;
                        }
                }
 
                if (!$found)
                        return null;
 
                if (!(isset($data['type']) && ($data['type'] == 'git'))) {
                        GitPHP_DebugLog::GetInstance()->Log(sprintf('%1$s is not a git project', $proj));
                        return null;
                }
 
                if (!(isset($data['public']) && ($data['public'] == true))) {
                        GitPHP_DebugLog::GetInstance()->Log(sprintf('%1$s is not public', $proj));
                        return null;
                }
 
                if (!is_file(GitPHP_Util::AddSlash($this->projectRoot) . $proj . '/HEAD')) {
                        GitPHP_DebugLog::GetInstance()->Log(sprintf('%1$s is not a git project', $proj));
                }
 
                $projectObj = new GitPHP_Project($this->projectRoot, $proj);
 
                $this->ApplyGlobalConfig($projectObj);
 
                $this->ApplyGitConfig($projectObj);
 
                if (isset($data['owner']) && !empty($data['owner'])) {
                        $projectObj->SetOwner($data['owner']);
                }
 
                if (isset($data['description']) && !empty($data['description'])) {
                        $projectObj->SetDescription($data['description']);
                }
 
                if ($this->projectSettings && isset($this->projectSettings[$proj])) {
                        $this->ApplyProjectSettings($projectObj, $this->projectSettings[$proj]);
                }
 
                return $projectObj;
        }
 
        /**
         * ReadFile
         *
         * Reads the file contents
         *
         * @access private
         */
        protected function ReadFile()
        {
                $this->fileRead = true;
 
                $use_errors = libxml_use_internal_errors(true);
 
                $xml = simplexml_load_file($this->projectConfig);
 
                libxml_clear_errors();
                libxml_use_internal_errors($use_errors);
 
                if (!$xml) {
                        throw new Exception(sprintf('Could not load SCM manager config %1$s', $this->projectConfig));
                }
 
                foreach ($xml->repositories->repository as $repository) {
                        
                        $name = trim($repository->name);
                        if (empty($name))
                                continue;
 
                        $data = array();
                        $data['name'] = $name;
                        $data['type'] = $repository->type;
                        $data['public'] = ($repository->public == 'true');
                        
                        $owner = trim($repository->contact);
                        if (!empty($owner))
                                $data['owner'] = $owner;
 
                        $description = trim($repository->description);
                        if (!empty($description))
                                $data['description'] = $description;
 
                        $this->fileContents[] = $data;
 
                }
        }
 
        /**
         * IsSCMManager
         *
         * Tests if this file is an SCM manager config file
         *
         * @access protected
         * @returns true if file is an SCM manager config
         */
        public static function IsSCMManager($file)
        {
                if (empty($file))
                        return false;
 
                if (!(is_string($file) && is_file($file)))
                        return false;
 
                $use_errors = libxml_use_internal_errors(true);
 
                $xml = simplexml_load_file($file);
 
                libxml_clear_errors();
                libxml_use_internal_errors($use_errors);
 
                if (!$xml)
                        return false;
 
                if ($xml->getName() !== 'repository-db')
                        return false;
 
                return true;
        }
 
}
 
comments