Move projectlist classes to their own folder
[gitphp.git] / include / git / projectlist / ProjectListFile.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
<?php
/**
 * GitPHP ProjectListFile
 *
 * Lists all projects in a given file
 *
 * @author Christopher Han <xiphux@gmail.com>
 * @copyright Copyright (c) 2010 Christopher Han
 * @package GitPHP
 * @subpackage Git
 */
 
require_once(GITPHP_INCLUDEDIR . 'Config.class.php');
require_once(GITPHP_GITOBJECTDIR . 'projectlist/ProjectListBase.class.php');
require_once(GITPHP_GITOBJECTDIR . 'Project.class.php');
 
/**
 * ProjectListFile class
 *
 * @package GitPHP
 * @subpackage Git
 */
class GitPHP_ProjectListFile extends GitPHP_ProjectListBase
{
 
        /**
         * fileContents
         *
         * Stores the contents of the project list 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 $lineData) {
                        if (isset($lineData['project'])) {
                                $projObj = $this->InstantiateProject($lineData['project']);
                                if ($projObj) {
                                        $this->projects[$lineData['project']] = $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();
 
                $found = false;
                $owner = null;
                foreach ($this->fileContents as $lineData) {
                        if (isset($lineData['project']) && ($lineData['project'] == $proj)) {
                                $projectRoot = GitPHP_Util::AddSlash($this->projectRoot);
                                if (is_file($projectRoot . $proj . '/HEAD')) {
                                        $found = true;
                                        if (isset($lineData['owner'])) {
                                                $owner = $lineData['owner'];
                                        }
                                } else {
                                        GitPHP_DebugLog::GetInstance()->Log(sprintf('%1$s is not a git project', $projectRoot . $proj));
                                }
                                break;
                        }
                }
 
                if (!$found)
                        return null;
 
                $projectObj = new GitPHP_Project($this->projectRoot, $proj);
 
                $this->ApplyGlobalConfig($projectObj);
 
                $this->ApplyGitConfig($projectObj);
 
                if (!empty($owner))
                        $projectObj->SetOwner($owner);
 
                if ($this->projectSettings && isset($this->projectSettings[$proj])) {
                        $this->ApplyProjectSettings($projectObj, $this->projectSettings[$proj]);
                }
 
                return $projectObj;
        }
 
        /**
         * ReadFile
         *
         * Reads the file contents
         *
         * @access protected
         */
        protected function ReadFile()
        {
                $this->fileRead = true;
 
                $fileString = file_get_contents($this->projectConfig);
                
                if ($fileString === false) {
                        throw new Exception(sprintf(__('Failed to open project list file %1$s'), $this->projectConfig));
                }
 
                $this->fileContents = array();
 
                $fileLines = explode("\n", $fileString);
                foreach ($fileLines as $line) {
                        if (preg_match('/^([^\s]+)(\s.+)?$/', $line, $regs)) {
                                $data = array();
                                $data['project'] = $regs[1];
                                $owner = trim($regs[2]);
                                if (!empty($owner)) {
                                        $data['owner'] = $owner;
                                }
                                $this->fileContents[] = $data;
                        }
                }
        }
 
}
 
comments