Implement pagination interface on history
[gitphp.git] / include / git / FileHistory.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
229
230
231
232
233
234
235
236
<?php
/**
 * Class to load a file's history
 *
 * @author Christopher Han <xiphux@gmail.com>
 * @copyright Copyright (c) 2012 Christopher Han
 * @package GitPHP
 * @subpackage Git
 */
class GitPHP_FileHistory implements Iterator
{
        /**
         * The project
         *
         * @var GitPHP_Project
         */
        protected $project;
 
        /**
         * The commit hash
         *
         * @var string
         */
        protected $commitHash;
 
        /**
         * The path
         *
         * @var string
         */
        protected $path;
 
        /**
         * The history
         *
         * @var GitPHP_FileDiff[]
         */
        protected $history = array();
 
        /**
         * Whether data has been loaded
         *
         * @var boolean
         */
        protected $dataLoaded = false;
 
        /**
         * Executable
         *
         * @var GitPHP_GitExe
         */
        protected $exe;
 
        /**
         * Constructor
         *
         * @param GitPHP_Project $project project
         * @param GitPHP_Commit $commit commit to start history from
         * @param string $path file path to trace history of
         * @param GitPHP_GitExe $exe git exe
         */
        public function __construct($project, $commit, $path, $exe)
        {
                if (!$project)
                        throw new Exception('Project is required');
 
                if (!$commit)
                        throw new Exception('Commit is required');
 
                if (empty($path))
                        throw new Exception('Path is required');
 
                if (!$exe)
                        throw new Exception('Git exe is required');
 
                $this->project = $project;
 
                $this->commitHash = $commit->GetHash();
 
                $this->path = $path;
 
                $this->exe = $exe;
        }
 
        /**
         * Gets the project for this file history
         *
         * @return GitPHP_Project project
         */
        public function GetProject()
        {
                return $this->project;
        }
 
        /**
         * Gets the commit for this file history
         *
         * @return GitPHP_Commit commit
         */
        public function GetCommit()
        {
                return $this->project->GetCommit($this->commitHash);
        }
 
        /**
         * Gets the path for this file history
         *
         * @return string path
         */
        public function GetPath()
        {
                return $this->path;
        }
 
        /**
         * Gets the history
         *
         * @return GitPHP_FileDiff[] history data
         */
        public function GetHistory()
        {
                if (!$this->dataLoaded)
                        $this->LoadData();
 
                return $this->history;
        }
 
        /**
         * Loads the history data
         */
        private function LoadData()
        {
                $this->dataLoaded = true;
 
                $args = array();
                $args[] = $this->commitHash;
                $args[] = '|';
                $args[] = $this->exe->GetBinary();
                $args[] = '--git-dir=' . $this->project->GetPath();
                $args[] = GIT_DIFF_TREE;
                $args[] = '-r';
                $args[] = '--stdin';
                $args[] = '--';
                $args[] = $this->path;
                
                $historylines = explode("\n", $this->exe->Execute($this->project->GetPath(), GIT_REV_LIST, $args));
 
                $commitHash = null;
                foreach ($historylines as $line) {
                        if (preg_match('/^([0-9a-fA-F]{40})/', $line, $regs)) {
                                $commitHash = $regs[1];
                        } else if ($commitHash) {
                                try {
                                        $history = $this->GetProject()->GetObjectManager()->GetFileDiff($line);
                                        $history->SetCommitHash($commitHash);
                                        $this->history[] = $history;
                                } catch (Exception $e) {
                                }
                                $commitHash = null;
                        }
                }
 
        }
 
        /**
         * Rewinds the iterator
         *
         * @return GitPHP_FileDiff
         */
        function rewind()
        {
                if (!$this->dataLoaded) {
                        $this->LoadData();
                }
 
                return reset($this->history);
        }
 
        /**
         * Returns the current revision
         *
         * @return GitPHP_FileDiff
         */
        function current()
        {
                if (!$this->dataLoaded) {
                        $this->LoadData();
                }
 
                return current($this->history);
        }
 
        /**
         * Returns the current key
         *
         * @return int
         */
        function key()
        {
                if (!$this->dataLoaded) {
                        $this->LoadData();
                }
 
                return key($this->history);
        }
 
        /**
         * Advance the pointer
         *
         * @return GitPHP_FileDiff|boolean
         */
        function next()
        {
                if (!$this->dataLoaded) {
                        $this->LoadData();
                }
 
                return next($this->history);
        }
 
        /**
         * Test for a valid pointer
         *
         * @return boolean
         */
        function valid()
        {
                if (!$this->dataLoaded) {
                        $this->LoadData();
                }
 
                return key($this->history) !== null;
        }
 
}
 
comments