Don't do redundant regexes when reading commit data
[gitphp.git] / include / git / Commit.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
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
<?php
/**
 * GitPHP Commit
 *
 * Represents a single commit
 *
 * @author Christopher Han <xiphux@gmail.com>
 * @copyright Copyright (c) 2010 Christopher Han
 * @package GitPHP
 * @subpackage Git
 */
 
require_once(GITPHP_GITOBJECTDIR . 'GitExe.class.php');
require_once(GITPHP_GITOBJECTDIR . 'GitObject.class.php');
require_once(GITPHP_GITOBJECTDIR . 'Tree.class.php');
require_once(GITPHP_GITOBJECTDIR . 'TreeDiff.class.php');
 
/**
 * Commit class
 *
 * @package GitPHP
 * @subpackage Git
 */
class GitPHP_Commit extends GitPHP_GitObject
{
 
        /**
         * dataRead
         *
         * Indicates whether data for this commit has been read
         *
         * @access protected
         */
        protected $dataRead = false;
 
        /**
         * parents
         *
         * Array of parent commits
         *
         * @access protected
         */
        protected $parents = array();
 
        /**
         * tree
         *
         * Tree object for this commit
         *
         * @access protected
         */
        protected $tree;
 
        /**
         * author
         *
         * Author for this commit
         *
         * @access protected
         */
        protected $author;
 
        /**
         * authorEpoch
         *
         * Author's epoch
         *
         * @access protected
         */
        protected $authorEpoch;
 
        /**
         * authorTimezone
         *
         * Author's timezone
         *
         * @access protected
         */
        protected $authorTimezone;
 
        /**
         * committer
         *
         * Committer for this commit
         *
         * @access protected
         */
        protected $committer;
 
        /**
         * committerEpoch
         *
         * Committer's epoch
         *
         * @access protected
         */
        protected $committerEpoch;
 
        /**
         * committerTimezone
         *
         * Committer's timezone
         *
         * @access protected
         */
        protected $committerTimezone;
 
        /**
         * title
         *
         * Stores the commit title
         *
         * @access protected
         */
        protected $title;
 
        /**
         * comment
         *
         * Stores the commit comment
         *
         * @access protected
         */
        protected $comment = array();
 
        /**
         * readTree
         *
         * Stores whether tree filenames have been read
         *
         * @access protected
         */
        protected $readTree = false;
 
        /**
         * blobPaths
         *
         * Stores blob hash to path mappings
         *
         * @access protected
         */
        protected $blobPaths = array();
 
        /**
         * treePaths
         *
         * Stores tree hash to path mappings
         *
         * @access protected
         */
        protected $treePaths = array();
 
        /**
         * hashPathsRead
         *
         * Stores whether hash paths have been read
         *
         * @access protected
         */
        protected $hashPathsRead = false;
 
        /**
         * containingTag
         *
         * Stores the tag containing the changes in this commit
         *
         * @access protected
         */
        protected $containingTag = null;
 
        /**
         * containingTagRead
         *
         * Stores whether the containing tag has been looked up
         *
         * @access public
         */
        protected $containingTagRead = false;
 
        /**
         * parentsReferenced
         *
         * Stores whether the parents have been referenced into pointers
         *
         * @access private
         */
        private $parentsReferenced = false;
 
        /**
         * treeReferenced
         *
         * Stores whether the tree has been referenced into a pointer
         *
         * @access private
         */
        private $treeReferenced = false;
 
        /**
         * __construct
         *
         * Instantiates object
         *
         * @access public
         * @param mixed $project the project
         * @param string $hash object hash
         * @return mixed git object
         * @throws Exception exception on invalid hash
         */
        public function __construct($project, $hash)
        {
                parent::__construct($project, $hash);
        }
 
        /**
         * GetParent
         *
         * Gets the main parent of this commit
         *
         * @access public
         * @return mixed commit object for parent
         */
        public function GetParent()
        {
                if (!$this->dataRead)
                        $this->ReadData();
 
                if ($this->parentsReferenced)
                        $this->DereferenceParents();
 
                if (isset($this->parents[0]))
                        return $this->parents[0];
                return null;
        }
 
        /**
         * GetParents
         *
         * Gets an array of parent objects for this commit
         *
         * @access public
         * @return mixed array of commit objects
         */
        public function GetParents()
        {
                if (!$this->dataRead)
                        $this->ReadData();
 
                if ($this->parentsReferenced)
                        $this->DereferenceParents();
 
                return $this->parents;
        }
 
        /**
         * GetTree
         *
         * Gets the tree for this commit
         *
         * @access public
         * @return mixed tree object
         */
        public function GetTree()
        {
                if (!$this->dataRead)
                        $this->ReadData();
 
                if ($this->treeReferenced)
                        $this->DereferenceTree();
 
                return $this->tree;
        }
 
        /**
         * GetAuthor
         *
         * Gets the author for this commit
         *
         * @access public
         * @return string author
         */
        public function GetAuthor()
        {
                if (!$this->dataRead)
                        $this->ReadData();
 
                return $this->author;
        }
 
        /**
         * GetAuthorName
         *
         * Gets the author's name only
         *
         * @access public
         * @return string author name
         */
        public function GetAuthorName()
        {
                if (!$this->dataRead)
                        $this->ReadData();
 
                return preg_replace('/ <.*/', '', $this->author);
        }
 
        /**
         * GetAuthorEpoch
         *
         * Gets the author's epoch
         *
         * @access public
         * @return string author epoch
         */
        public function GetAuthorEpoch()
        {
                if (!$this->dataRead)
                        $this->ReadData();
 
                return $this->authorEpoch;
        }
 
        /**
         * GetAuthorLocalEpoch
         *
         * Gets the author's local epoch
         *
         * @access public
         * @return string author local epoch
         */
        public function GetAuthorLocalEpoch()
        {
                $epoch = $this->GetAuthorEpoch();
                $tz = $this->GetAuthorTimezone();
                if (preg_match('/^([+\-][0-9][0-9])([0-9][0-9])$/', $tz, $regs)) {
                        $local = $epoch + ((((int)$regs[1]) + ($regs[2]/60)) * 3600);
                        return $local;
                }
                return $epoch;
        }
 
        /**
         * GetAuthorTimezone
         *
         * Gets the author's timezone
         *
         * @access public
         * @return string author timezone
         */
        public function GetAuthorTimezone()
        {
                if (!$this->dataRead)
                        $this->ReadData();
 
                return $this->authorTimezone;
        }
 
        /**
         * GetCommitter
         *
         * Gets the author for this commit
         *
         * @access public
         * @return string author
         */
        public function GetCommitter()
        {
                if (!$this->dataRead)
                        $this->ReadData();
 
                return $this->committer;
        }
 
        /**
         * GetCommitterName
         *
         * Gets the author's name only
         *
         * @access public
         * @return string author name
         */
        public function GetCommitterName()
        {
                if (!$this->dataRead)
                        $this->ReadData();
 
                return preg_replace('/ <.*/', '', $this->committer);
        }
 
        /**
         * GetCommitterEpoch
         *
         * Gets the committer's epoch
         *
         * @access public
         * @return string committer epoch
         */
        public function GetCommitterEpoch()
        {
                if (!$this->dataRead)
                        $this->ReadData();
 
                return $this->committerEpoch;
        }
 
        /**
         * GetCommitterLocalEpoch
         *
         * Gets the committer's local epoch
         *
         * @access public
         * @return string committer local epoch
         */
        public function GetCommitterLocalEpoch()
        {
                $epoch = $this->GetCommitterEpoch();
                $tz = $this->GetCommitterTimezone();
                if (preg_match('/^([+\-][0-9][0-9])([0-9][0-9])$/', $tz, $regs)) {
                        $local = $epoch + ((((int)$regs[1]) + ($regs[2]/60)) * 3600);
                        return $local;
                }
                return $epoch;
        }
 
        /**
         * GetCommitterTimezone
         *
         * Gets the author's timezone
         *
         * @access public
         * @return string author timezone
         */
        public function GetCommitterTimezone()
        {
                if (!$this->dataRead)
                        $this->ReadData();
 
                return $this->committerTimezone;
        }
 
        /**
         * GetTitle
         *
         * Gets the commit title
         *
         * @access public
         * @param integer $trim length to trim to (0 for no trim)
         * @return string title
         */
        public function GetTitle($trim = 0)
        {
                if (!$this->dataRead)
                        $this->ReadData();
                
                if (($trim > 0) && (strlen($this->title) > $trim)) {
                        return substr($this->title, 0, $trim) . '…';
                }
 
                return $this->title;
        }
 
        /**
         * GetComment
         *
         * Gets the lines of comment
         *
         * @access public
         * @return array lines of comment
         */
        public function GetComment()
        {
                if (!$this->dataRead)
                        $this->ReadData();
 
                return $this->comment;
        }
 
        /**
         * SearchComment
         *
         * Gets the lines of the comment matching the given pattern
         *
         * @access public
         * @param string $pattern pattern to find
         * @return array matching lines of comment
         */
        public function SearchComment($pattern)
        {
                if (empty($pattern))
                        return $this->GetComment();
 
                if (!$this->dataRead)
                        $this->ReadData();
 
                return preg_grep('/' . $pattern . '/i', $this->comment);
        }
 
        /**
         * GetAge
         *
         * Gets the age of the commit
         *
         * @access public
         * @return string age
         */
        public function GetAge()
        {
                if (!$this->dataRead)
                        $this->ReadData();
 
                if (!empty($this->committerEpoch))
                        return time() - $this->committerEpoch;
 
                return '';
        }
 
        /**
         * ReadData
         *
         * Read the data for the commit
         *
         * @access protected
         */
        protected function ReadData()
        {
                $this->dataRead = true;
 
                $lines = null;
 
                if (GitPHP_Config::GetInstance()->GetValue('compat', false)) {
 
                        /* get data from git_rev_list */
                        $exe = new GitPHP_GitExe($this->GetProject());
                        $args = array();
                        $args[] = '--header';
                        $args[] = '--parents';
                        $args[] = '--max-count=1';
                        $args[] = $this->hash;
                        $ret = $exe->Execute(GIT_REV_LIST, $args);
                        unset($exe);
 
                        $lines = explode("\n", $ret);
 
                        if (!isset($lines[0]))
                                return;
 
                        /* In case we returned something unexpected */
                        $tok = strtok($lines[0], ' ');
                        if ($tok != $this->hash)
                                return;
 
                        array_shift($lines);
 
                } else {
                        
                        $data = $this->GetProject()->GetObject($this->hash);
                        if (empty($data))
                                return;
 
                        $lines = explode("\n", $data);
 
                }
 
                $header = true;
 
                foreach ($lines as $i => $line) {
                        if ($header && preg_match('/^tree ([0-9a-fA-F]{40})$/', $line, $regs)) {
                                /* Tree */
                                try {
                                        $tree = $this->GetProject()->GetTree($regs[1]);
                                        if ($tree) {
                                                $tree->SetCommit($this);
                                                $this->tree = $tree;
                                        }
                                } catch (Exception $e) {
                                }
                        } else if ($header && preg_match('/^parent ([0-9a-fA-F]{40})$/', $line, $regs)) {
                                /* Parent */
                                try {
                                        $this->parents[] = $this->GetProject()->GetCommit($regs[1]);
                                } catch (Exception $e) {
                                }
                        } else if ($header && preg_match('/^author (.*) ([0-9]+) (.*)$/', $line, $regs)) {
                                /* author data */
                                $this->author = $regs[1];
                                $this->authorEpoch = $regs[2];
                                $this->authorTimezone = $regs[3];
                        } else if ($header && preg_match('/^committer (.*) ([0-9]+) (.*)$/', $line, $regs)) {
                                /* committer data */
                                $this->committer = $regs[1];
                                $this->committerEpoch = $regs[2];
                                $this->committerTimezone = $regs[3];
                        } else {
                                /* commit comment */
                                $header = false;
                                $trimmed = trim($line);
                                if (empty($this->title) && (strlen($trimmed) > 0))
                                        $this->title = $trimmed;
                                if (!empty($this->title)) {
                                        if ((strlen($trimmed) > 0) || ($i < (count($lines)-1)))
                                                $this->comment[] = $trimmed;
                                }
                        }
                }
 
                GitPHP_Cache::GetInstance()->Set($this->GetCacheKey(), $this);
        }
 
        /**
         * GetHeads
         *
         * Gets heads that point to this commit
         * 
         * @access public
         * @return array array of heads
         */
        public function GetHeads()
        {
                $heads = array();
 
                $projectRefs = $this->GetProject()->GetRefs('heads');
 
                foreach ($projectRefs as $ref) {
                        if ($ref->GetHash() == $this->hash) {
                                $heads[] = $ref;
                        }
                }
 
                return $heads;
        }
 
        /**
         * GetTags
         *
         * Gets tags that point to this commit
         *
         * @access public
         * @return array array of tags
         */
        public function GetTags()
        {
                $tags = array();
 
                $projectRefs = $this->GetProject()->GetRefs('tags');
 
                foreach ($projectRefs as $ref) {
                        if ($ref->GetCommit()->GetHash() === $this->hash) {
                                $tags[] = $ref;
                        }
                }
 
                return $tags;
        }
 
        /**
         * GetContainingTag
         *
         * Gets the tag that contains the changes in this commit
         *
         * @access public
         * @return tag object
         */
        public function GetContainingTag()
        {
                if (!$this->containingTagRead)
                        $this->ReadContainingTag();
 
                return $this->containingTag;
        }
 
        /**
         * ReadContainingTag
         *
         * Looks up the tag that contains the changes in this commit
         *
         * @access private
         */
        public function ReadContainingTag()
        {
                $this->containingTagRead = true;
 
                $exe = new GitPHP_GitExe($this->GetProject());
                $args = array();
                $args[] = '--tags';
                $args[] = $this->hash;
                $revs = explode("\n", $exe->Execute(GIT_NAME_REV, $args));
 
                foreach ($revs as $revline) {
                        if (preg_match('/^([0-9a-fA-F]{40})\s+tags\/(.+)(\^[0-9]+|\~[0-9]+)$/', $revline, $regs)) {
                                if ($regs[1] == $this->hash) {
                                        $this->containingTag = $this->GetProject()->GetTag($regs[2]);
                                        break;
                                }
                        }
                }
 
                GitPHP_Cache::GetInstance()->Set($this->GetCacheKey(), $this);
        }
 
        /**
         * DiffToParent
         *
         * Diffs this commit with its immediate parent
         *
         * @access public
         * @return mixed Tree diff
         */
        public function DiffToParent()
        {
                return new GitPHP_TreeDiff($this->GetProject(), $this->hash);
        }
 
        /**
         * PathToHash
         *
         * Given a filepath, get its hash
         *
         * @access public
         * @param string $path path
         * @return string hash
         */
        public function PathToHash($path)
        {
                if (empty($path))
                        return '';
 
                if (!$this->hashPathsRead)
                        $this->ReadHashPaths();
 
                if (isset($this->blobPaths[$path])) {
                        return $this->blobPaths[$path];
                }
 
                if (isset($this->treePaths[$path])) {
                        return $this->treePaths[$path];
                }
 
                return '';
        }
 
        /**
         * ReadHashPaths
         *
         * Read hash to path mappings
         *
         * @access private
         */
        private function ReadHashPaths()
        {
                $this->hashPathsRead = true;
 
                if (GitPHP_Config::GetInstance()->GetValue('compat', false)) {
                        $this->ReadHashPathsGit();
                } else {
                        $this->ReadHashPathsRaw($this->GetTree());
                }
 
                GitPHP_Cache::GetInstance()->Set($this->GetCacheKey(), $this);
        }
 
        /**
         * ReadHashPathsGit
         *
         * Reads hash to path mappings using git exe
         *
         * @access private
         */
        private function ReadHashPathsGit()
        {
                $exe = new GitPHP_GitExe($this->GetProject());
 
                $args = array();
                $args[] = '--full-name';
                $args[] = '-r';
                $args[] = '-t';
                $args[] = $this->hash;
 
                $lines = explode("\n", $exe->Execute(GIT_LS_TREE, $args));
 
                foreach ($lines as $line) {
                        if (preg_match("/^([0-9]+) (.+) ([0-9a-fA-F]{40})\t(.+)$/", $line, $regs)) {
                                switch ($regs[2]) {
                                        case 'tree':
                                                $this->treePaths[trim($regs[4])] = $regs[3];
                                                break;
                                        case 'blob';
                                                $this->blobPaths[trim($regs[4])] = $regs[3];
                                                break;
                                }
                        }
                }
        }
 
        /**
         * ReadHashPathsRaw
         *
         * Reads hash to path mappings using raw objects
         *
         * @access private
         */
        private function ReadHashPathsRaw($tree)
        {
                if (!$tree) {
                        return;
                }
 
                $contents = $tree->GetContents();
 
                foreach ($contents as $obj) {
                        if ($obj instanceof GitPHP_Blob) {
                                $hash = $obj->GetHash();
                                $path = $obj->GetPath();
                                $this->blobPaths[trim($path)] = $hash;
                        } else if ($obj instanceof GitPHP_Tree) {
                                $hash = $obj->GetHash();
                                $path = $obj->GetPath();
                                $this->treePaths[trim($path)] = $hash;
                                $this->ReadHashPathsRaw($obj);
                        }
                }
        }
 
        /**
         * SearchFilenames
         *
         * Returns array of objects matching pattern
         *
         * @access public
         * @param string $pattern pattern to find
         * @return array array of objects
         */
        public function SearchFilenames($pattern)
        {
                if (empty($pattern))
                        return;
 
                if (!$this->hashPathsRead)
                        $this->ReadHashPaths();
 
                $results = array();
 
                foreach ($this->treePaths as $path => $hash) {
                        if (preg_match('/' . $pattern . '/i', $path)) {
                                $obj = $this->GetProject()->GetTree($hash);
                                $obj->SetCommit($this);
                                $results[$path] = $obj;
                        }
                }
 
                foreach ($this->blobPaths as $path => $hash) {
                        if (preg_match('/' . $pattern . '/i', $path)) {
                                $obj = $this->GetProject()->GetBlob($hash);
                                $obj->SetCommit($this);
                                $results[$path] = $obj;
                        }
                }
 
                ksort($results);
 
                return $results;
        }
 
        /**
         * SearchFileContents
         *
         * Searches for a pattern in file contents
         *
         * @access public
         * @param string $pattern pattern to search for
         * @return array multidimensional array of results
         */
        public function SearchFileContents($pattern)
        {
                if (empty($pattern))
                        return;
 
                $exe = new GitPHP_GitExe($this->GetProject());
 
                $args = array();
                $args[] = '-I';
                $args[] = '--full-name';
                $args[] = '--ignore-case';
                $args[] = '-n';
                $args[] = '-e';
                $args[] = $pattern;
                $args[] = $this->hash;
 
                $lines = explode("\n", $exe->Execute(GIT_GREP, $args));
 
                $results = array();
 
                foreach ($lines as $line) {
                        if (preg_match('/^[^:]+:([^:]+):([0-9]+):(.+)$/', $line, $regs)) {
                                if (!isset($results[$regs[1]]['object'])) {
                                        $hash = $this->PathToHash($regs[1]);
                                        if (!empty($hash)) {
                                                $obj = $this->GetProject()->GetBlob($hash);
                                                $obj->SetCommit($this);
                                                $results[$regs[1]]['object'] = $obj;
                                        }
                                }
                                $results[$regs[1]]['lines'][(int)($regs[2])] = $regs[3];
                        }
                }
 
                return $results;
        }
 
        /**
         * SearchFiles
         *
         * Searches filenames and file contents for a pattern
         *
         * @access public
         * @param string $pattern pattern to search
         * @param integer $count number of results to get
         * @param integer $skip number of results to skip
         * @return array array of results
         */
        public function SearchFiles($pattern, $count = 100, $skip = 0)
        {
                if (empty($pattern))
                        return;
 
                $grepresults = $this->SearchFileContents($pattern);
 
                $nameresults = $this->SearchFilenames($pattern);
 
                /* Merge the results together */
                foreach ($nameresults as $path => $obj) {
                        if (!isset($grepresults[$path]['object'])) {
                                $grepresults[$path]['object'] = $obj;
                        }
                }
 
                ksort($grepresults);
 
                return array_slice($grepresults, $skip, $count, true);
        }
 
        /**
         * ReferenceParents
         *
         * Turns the list of parents into reference pointers
         *
         * @access private
         */
        private function ReferenceParents()
        {
                if ($this->parentsReferenced)
                        return;
 
                if ((!isset($this->parents)) || (count($this->parents) < 1))
                        return;
 
                for ($i = 0; $i < count($this->parents); $i++) {
                        $this->parents[$i] = $this->parents[$i]->GetHash();
                }
 
                $this->parentsReferenced = true;
        }
 
        /**
         * DereferenceParents
         *
         * Turns the list of parent pointers back into objects
         *
         * @access private
         */
        private function DereferenceParents()
        {
                if (!$this->parentsReferenced)
                        return;
 
                if ((!$this->parents) || (count($this->parents) < 1))
                        return;
 
                for ($i = 0; $i < count($this->parents); $i++) {
                        $this->parents[$i] = $this->GetProject()->GetCommit($this->parents[$i]);
                }
 
                $this->parentsReferenced = false;
        }
 
        /**
         * ReferenceTree
         *
         * Turns the tree into a reference pointer
         *
         * @access private
         */
        private function ReferenceTree()
        {
                if ($this->treeReferenced)
                        return;
 
                if (!$this->tree)
                        return;
 
                $this->tree = $this->tree->GetHash();
 
                $this->treeReferenced = true;
        }
 
        /**
         * DereferenceTree
         *
         * Turns the tree pointer back into an object
         *
         * @access private
         */
        private function DereferenceTree()
        {
                if (!$this->treeReferenced)
                        return;
 
                if (empty($this->tree))
                        return;
 
                $this->tree = $this->GetProject()->GetTree($this->tree);
 
                if ($this->tree)
                        $this->tree->SetCommit($this);
 
                $this->treeReferenced = false;
        }
 
        /**
         * __sleep
         *
         * Called to prepare the object for serialization
         *
         * @access public
         * @return array list of properties to serialize
         */
        public function __sleep()
        {
                if (!$this->parentsReferenced)
                        $this->ReferenceParents();
 
                if (!$this->treeReferenced)
                        $this->ReferenceTree();
 
                $properties = array('dataRead', 'parents', 'tree', 'author', 'authorEpoch', 'authorTimezone', 'committer', 'committerEpoch', 'committerTimezone', 'title', 'comment', 'readTree', 'blobPaths', 'treePaths', 'hashPathsRead', 'parentsReferenced', 'treeReferenced');
                return array_merge($properties, parent::__sleep());
        }
 
        /**
         * GetCacheKey
         *
         * Gets the cache key to use for this object
         *
         * @access public
         * @return string cache key
         */
        public function GetCacheKey()
        {
                $key = parent::GetCacheKey();
                if (!empty($key))
                        $key .= '|';
 
                $key .= 'commit|' . $this->hash;
 
                return $key;
        }
 
        /**
         * CompareAge
         *
         * Compares two commits by age
         *
         * @access public
         * @static
         * @param mixed $a first commit
         * @param mixed $b second commit
         * @return integer comparison result
         */
        public static function CompareAge($a, $b)
        {
                if ($a->GetAge() === $b->GetAge())
                        return 0;
                return ($a->GetAge() < $b->GetAge() ? -1 : 1);
        }
 
}
 
comments