/
buildrepository.php
1548 lines (1292 loc) · 53.2 KB
/
buildrepository.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
<?php
/**
* @file buildrepository.php
* Build Repository.
*
* @authors Copyright © 2009-2012 Daniel Swanson <danij@dengine.net>
*
* @par License
* GPL: http://www.gnu.org/licenses/gpl.html
*
* <small>This program 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. This program 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 this program; if not, write to the Free
* Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
* 02110-1301 USA</small>
*/
includeGuard('BuildRepositoryPlugin');
require_once(DIR_CLASSES.'/outputcache.class.php');
/**
* @defgroup platformId Platform Identifier
* @ingroup builds
*/
///@{
define('PID_ANY', 0); ///< (Enumeration). Ordinals are meaningless (can change) however must be unique.
define('PID_WIN_X86', 1);
define('PID_MAC10_4_X86_PPC', 2);
define('PID_MAC10_6_X86_X86_64', 3);
define('PID_LINUX_X86', 4);
define('PID_LINUX_X86_64', 5);
///@}
/**
* @defgroup releaseType Release Type
* @ingroup builds
*/
///@{
define('RT_UNKNOWN', 0); ///< (Enumeration). Ordinals are meaningless (can change) however must be unique.
define('RT_UNSTABLE', 1);
define('RT_CANDIDATE', 2);
define('RT_STABLE', 3);
///@}
require_once('buildevent.class.php');
require_once('buildlogparser.class.php');
require_once('commitutils.php');
require_once('packagefactory.class.php');
class BuildRepositoryPlugin extends Plugin implements Actioner, RequestInterpreter
{
/// Plugin name.
public static $name = 'buildrepository';
/// Feed URIs:
const XML_FEED_URI = 'http://dl.dropbox.com/u/11948701/builds/events.xml';
const RSS_FEED_URI = 'http://dl.dropbox.com/u/11948701/builds/events.rss';
/**
* Plaform (Record):
*
* 'id': @see platformId
* 'name': Symbolic name used to identify this platform.
* 'nicename': User facing/friendly name for this platform.
*/
private static $platforms = array(
PID_WIN_X86 => array('id'=>PID_WIN_X86, 'name'=>'win-x86', 'nicename'=>'Windows'),
PID_MAC10_4_X86_PPC => array('id'=>PID_MAC10_4_X86_PPC, 'name'=>'mac10_4-x86-ppc', 'nicename'=>'Mac OS (10.4+)'),
PID_MAC10_6_X86_X86_64 => array('id'=>PID_MAC10_6_X86_X86_64, 'name'=>'mac10_6-x86-x86_64', 'nicename'=>'Mac OS (10.6+)'),
PID_LINUX_X86 => array('id'=>PID_LINUX_X86, 'name'=>'linux-x86', 'nicename'=>'Ubuntu (32bit)'),
PID_LINUX_X86_64 => array('id'=>PID_LINUX_X86_64, 'name'=>'linux-x86_64', 'nicename'=>'Ubuntu (64bit)')
);
private static $unknownPlatform = array(
'id'=>PID_ANY, 'name'=>'unknown', 'nicename'=>'Unknown');
/**
* ReleaseType (Record):
*
* 'id': @see releaseTypeId
* 'name': Symbolic name used to identify this release type.
* 'nicename': User facing/friendly name for this release type.
*/
private static $releaseTypes = array(
RT_UNSTABLE => array('id'=>RT_UNSTABLE, 'name'=>'unstable', 'nicename'=>'Unstable'),
RT_CANDIDATE => array('id'=>RT_CANDIDATE, 'name'=>'candidate', 'nicename'=>'Candidate'),
RT_STABLE => array('id'=>RT_STABLE, 'name'=>'stable', 'nicename'=>'Stable')
);
private static $unknownReleaseType = array(
'id'=>RT_UNKNOWN, 'name'=>'unknown', 'nicename'=>'Unknown');
/// Special 'null' package.
private static $nullPack = NULL;
/// Builds.
private $builds;
/// Package collections.
private $packages = NULL;
private $symbolicPackages = NULL;
/// Weight values for sorting of Packages.
private static $packageWeights = array(
'DistributionPackage' =>0,
'DistributionBuilderPackage' =>0,
'PluginPackage' =>1,
'PluginBuilderPackage' =>1,
'DistributionUnstablePackage' =>2,
'DistributionUnstableBuilderPackage' =>2,
'PluginUnstablePackage' =>3,
'PluginUnstableBuilderPackage' =>3
);
/// @return Plugin name.
public function title()
{
return self::$name;
}
/**
* Attempt to parse @a str, comparing with known symbolic platform
* names. If no match is determined @c PID_ANY is returned.
*
* @param str (String) Textual value to be parsed.
* @return (Integer) Determined PlatformId.
*/
public static function parsePlatformId($str="")
{
if(is_string($str))
{
foreach(self::$platforms as $plat)
{
if(!strcasecmp($plat['name'], $str)) return $plat['id'];
}
}
return PID_ANY; // Unknown.
}
/**
* Retrieve the Platform record associated with @a platformId.
* If no match is found then the special 'unknown' platform is returned.
*
* @param platformId (Integer) Unique identfier of the platform.
* @return (Object) Determined Platform.
*/
public static function &platform($platformId=PID_ANY)
{
$platformId = intval($platformId);
if(isset(self::$platforms[$platformId])) return self::$platforms[$platformId];
return self::$unknownPlatform;
}
/**
* Attempt to parse a 'release type' symbolic name/identifier from @a str
* if it does not match a known type then RT_UNSTABLE is returned.
* @return (integer) Unique identifier associated the determined release type.
*/
public static function parseReleaseType($str)
{
if(is_string($str))
{
if(!strcasecmp($str, 'unstable')) return RT_UNSTABLE;
if(!strcasecmp($str, 'candidate')) return RT_CANDIDATE;
if(!strcasecmp($str, 'stable')) return RT_STABLE;
}
// Unknown.
return RT_UNKNOWN;
}
/**
* Retrieve the ReleaseType record associated with @a releaseTypeId.
* If no match is found then the special 'unknown' release is returned.
*
* @param releaseTypeId (Integer) Unique identfier of the release type.
* @return (Object) Determined ReleaseType.
*/
public static function &releaseType($releaseTypeId=RT_UNKNOWN)
{
$releaseTypeId = intval($releaseTypeId);
if(isset(self::$releaseTypes[$releaseTypeId])) return self::$releaseTypes[$releaseTypeId];
return self::$unknownReleaseType;
}
public static function packageWeight(&$pack)
{
if($pack instanceof BasePackage)
{
if(isset(self::$packageWeights[get_class($pack)]))
return self::$packageWeights[get_class($pack)];
}
return 4;
}
public static function packageSorter($packA, $packB)
{
// Primarily by platform id.
if($packA->platformId() !== $packB->platformId()) return $packA->platformId() - $packB->platformId();
// Secondarily by package type.
if($packA === $packB) return 0;
$a = self::packageWeight($packA);
$b = self::packageWeight($packB);
if($a !== $b) return $a < $b? -1 : 1;
// Lastly by package title.
return strcasecmp($packA->title(), $packB->title());
}
/**
* Determine if the local cached copy of the remote build log requires an
* update (i.e., the remote server indicates the file has changed, or our
* cached copy has been manually purged).
*
* @param buildLogUri (String) Uri locator to the remote build log.
* @param cacheName (String) Name of the cache copy of the log.
* @return (Boolean) @c true if the cache copy of the log needs an update.
*/
private static function mustUpdateCachedBuildLog(&$buildLogUri, &$cacheName)
{
global $FrontController;
if(!$FrontController->contentCache()->isPresent($cacheName))
return TRUE;
// Only query the remote server at most once every five minutes for an
// updated build log. The modified time of our local cached copy is used
// to determine when it is time to query (we touch the cached copy after
// each query attempt).
$cacheInfo = new ContentInfo();
$FrontController->contentCache()->getInfo($cacheName, $cacheInfo);
if(time() < strtotime('+5 minutes', $cacheInfo->modifiedTime))
return FALSE;
// Check the remote time of the log and compare with our local cached copy.
try
{
// Open a new cURL session.
$cs = curl_init();
if($cs === FALSE)
throw new Exception('Failed initializing cURL');
// We only want the headers.
curl_setopt($cs, CURLOPT_URL, $buildLogUri);
curl_setopt($cs, CURLOPT_NOBODY, true);
curl_setopt($cs, CURLOPT_RETURNTRANSFER, true);
curl_setopt($cs, CURLOPT_FILETIME, true);
$xml = curl_exec($cs);
if($xml !== FALSE)
{
$timestamp = curl_getinfo($cs, CURLINFO_FILETIME);
// Close the cURL session.
curl_close($cs);
if($timestamp != -1)
{
if($timestamp > $cacheInfo->modifiedTime)
{
// Update necessary.
return TRUE;
}
else
{
// Touch our cached copy so we can delay checking again.
$FrontController->contentCache()->touch($cacheName);
return FALSE;
}
}
else
{
// Server could/would not supply the headers we are interested in.
// We'll err on the side of caution and update (our five minute
// repeat delay mitigates the sting).
return TRUE;
}
}
else
{
$error = curl_error($cs);
// We are now done with the cURL session.
curl_close($cs);
throw new Exception('Failed retrieving file info' + $error);
}
}
catch(Exception $e)
{
/// @todo Store error so users can query.
//setError($e->getMessage());
return FALSE;
}
}
private static function retrieveBuildLogXml(&$buildLogUri)
{
// Open a new cURL session.
$cs = curl_init();
if($cs === FALSE)
throw new Exception('Failed initializing cURL');
curl_setopt($cs, CURLOPT_URL, $buildLogUri);
curl_setopt($cs, CURLOPT_HEADER, false);
curl_setopt($cs, CURLOPT_RETURNTRANSFER, true);
$xml = curl_exec($cs);
if($xml === FALSE)
$error = curl_error($cs);
curl_close($cs);
if($xml === FALSE)
throw new Exception('Failed retrieving file' + $error);
return $xml;
}
/**
* Attempt to parse the build log, constructing from it a collection
* of the abstract objects we use to model the events an packages it
* defines.
*
* @param builds (Array) Collection to be populated with BuildEvents.
* @return (Boolean) @c TRUE iff successful.
*/
private function constructBuilds(&$builds)
{
global $FrontController;
$buildLogUri = self::XML_FEED_URI;
// Is it time to update our cached copy of the build log?
$logCacheName = 'buildrepository/events.xml';
if(self::mustUpdateCachedBuildLog($buildLogUri, $logCacheName))
{
try
{
// Grab a copy and store it in the local file cache.
$logXml = self::retrieveBuildLogXml($buildLogUri);
if($logXml == FALSE)
throw new Exception('Failed retrieving build log');
// Attempt to parse the new log.
BuildLogParser::parse($logXml, $builds);
// Parsed successfully; update the cache with this new file.
$FrontController->contentCache()->store($logCacheName, $logXml);
return TRUE;
}
catch(Exception $e)
{
// Free up resources.
unset($logXml);
// Log the error.
trigger_error(sprintf('Failed parsing new XML build log.\nError:%s', $e->getMessage()), E_USER_WARNING);
// Touch our cached copy so we don't try again too soon.
$FrontController->contentCache()->touch($logCacheName);
}
}
// Re-parse our locally cached copy of the log, hopefully
// we don't need to do this too often (cache everything!).
try
{
$cachedLogXml = $FrontController->contentCache()->retrieve($logCacheName);
BuildLogParser::parse($cachedLogXml, $builds);
return TRUE;
}
catch(Exception $e)
{
// Yikes! Looks like we broke something...
trigger_error(sprintf('Failed parsing cached XML build log.\nError:%s', $e->getMessage()), E_USER_WARNING);
return FALSE;
}
}
private function grabAndParseBuildFeedXML()
{
$builds = array();
$this->constructBuilds($builds);
$this->builds = $builds;
}
/**
* Populate the collection with 'static' packages. A static package is
* one which was not produced by or that which has no persistent build
* event information.
*
* Static packages are primarily for historic releases which predate
* the autobuilder.
*
* @param packages (Array) Collection to be populated.
* @return (Boolean) @c TRUE iff successful.
*/
private function populateStaticPackages(&$packages)
{
/**
* @todo Read this information from a config file, we should not
* expect to edit this file in order to change these...
*/
$pack = PackageFactory::newDistribution(PID_WIN_X86, 'Doomsday', '1.8.6',
'http://sourceforge.net/projects/deng/files/Doomsday%20Engine/1.8.6/deng-inst-1.8.6.exe/download',
false/*not an autobuilder packaged*/);
$pack->setReleaseNotesUri('http://dengine.net/dew/index.php?title=Doomsday_version_1.8.6');
$packages[] = $pack;
return TRUE;
}
/**
* Populate the collection with 'symbolic' packages. A symbolic package
* is one which is not linked to any specific downloadable packs or
* build events. Instead symbolic packages use abstract names and
* dynamically resolved download URIs which map to "real" packages.
*
* @param packages (Array) Collection to be populated.
* @return (Boolean) @c TRUE iff successful.
*/
private function populateSymbolicPackages(&$packages)
{
/**
* @todo Read this information from a config file, we should not
* expect to edit this file in order to change these...
*/
// Windows:
$plat = $this->platform(PID_WIN_X86);
$pack = PackageFactory::newDistribution($plat['id'], 'Latest Doomsday',
NULL/*no version*/, 'latestbuild?platform='. $plat['name']);
$packages[] = $pack;
$plat = $this->platform(PID_WIN_X86);
$pack = PackageFactory::newDistributionUnstable($plat['id'], 'Latest Doomsday',
NULL/*no version*/, 'latestbuild?platform='. $plat['name']. '&unstable');
$packages[] = $pack;
// Mac OS:
$plat = $this->platform(PID_MAC10_4_X86_PPC);
$pack = PackageFactory::newDistribution($plat['id'], 'Latest Doomsday',
NULL/*no version*/, 'latestbuild?platform='. $plat['name']);
$packages[] = $pack;
$plat = $this->platform(PID_MAC10_4_X86_PPC);
$pack = PackageFactory::newDistributionUnstable($plat['id'], 'Latest Doomsday',
NULL/*no version*/, 'latestbuild?platform='. $plat['name']. '&unstable');
$packages[] = $pack;
$plat = $this->platform(PID_MAC10_6_X86_X86_64);
$pack = PackageFactory::newDistribution($plat['id'], 'Latest Doomsday',
NULL/*no version*/, 'latestbuild?platform='. $plat['name']);
$packages[] = $pack;
$plat = $this->platform(PID_MAC10_6_X86_X86_64);
$pack = PackageFactory::newDistributionUnstable($plat['id'], 'Latest Doomsday',
NULL/*no version*/, 'latestbuild?platform='. $plat['name']. '&unstable');
$packages[] = $pack;
// Ubuntu:
$plat = $this->platform(PID_LINUX_X86);
$pack = PackageFactory::newDistribution($plat['id'], 'Latest Doomsday',
NULL/*no version*/, 'latestbuild?platform='. $plat['name']);
$packages[] = $pack;
$plat = $this->platform(PID_LINUX_X86);
$pack = PackageFactory::newDistributionUnstable($plat['id'], 'Latest Doomsday',
NULL/*no version*/, 'latestbuild?platform='. $plat['name']. '&unstable');
$packages[] = $pack;
$plat = $this->platform(PID_LINUX_X86_64);
$pack = PackageFactory::newDistribution($plat['id'], 'Latest Doomsday',
NULL/*no version*/, 'latestbuild?platform='. $plat['name']);
$packages[] = $pack;
$plat = $this->platform(PID_LINUX_X86_64);
$pack = PackageFactory::newDistributionUnstable($plat['id'], 'Latest Doomsday',
NULL/*no version*/, 'latestbuild?platform='. $plat['name']. '&unstable');
$packages[] = $pack;
return TRUE;
}
private function findOlderBuild($build=NULL)
{
$older = NULL;
if(!is_null($build) && $build instanceof BuildEvent)
{
foreach($this->builds as &$other)
{
if($other === $build) continue;
$otherId = $other->uniqueId();
if($otherId < $build->uniqueId() &&
(is_null($older) || $otherId > $older->uniqueId()))
{
$older = $other;
}
}
}
return $older;
}
private function findNewerBuild($build=NULL)
{
$newer = NULL;
if(!is_null($build) && $build instanceof BuildEvent)
{
foreach($this->builds as &$other)
{
if($other === $build) continue;
$otherId = $other->uniqueId();
if($otherId > $build->uniqueId() &&
(is_null($newer) || $otherId < $newer->uniqueId()))
{
$newer = $other;
}
}
}
return $newer;
}
/**
* Chain BuildEvents together by 'start date', linking them according
* to their start timestamps.
*/
private function chainBuildsByStartDate()
{
if(!isset($this->builds)) return FALSE;
foreach($this->builds as &$build)
{
$older = $this->findOlderBuild($build);
$build->setPrevForStartDate($older);
$newer = $this->findNewerBuild($build);
$build->setNextForStartDate($newer);
}
return TRUE;
}
/**
* Chain BuildEvents together by 'version', linking them according
* to the version number of the 'Doomsday' package(s) those events
* produced.
*/
private function chainBuildsByDoomsdayVersion()
{
if(!isset($this->packages)) return FALSE;
$releases = array();
foreach($this->packages as &$pack)
{
// We are only interested in the 'Doomsday' packages.
if($pack->title() !== 'Doomsday') continue;
// Have we encountered this version before?.
$version = $pack->version();
$key = array_casekey_exists($version, $releases);
if($key === false)
{
// Not yet construct a new build list (array) and associate it
// in the release array using the version number as the key.
$key = ucwords($version);
$releases[$key] = array();
$buildList = &$releases[$key];
}
else
{
$buildList = &$releases[$version];
}
// Is this package a product of the autobuilder?
if($pack instanceof iBuilderProduct)
{
// Yes; we have "real" BuildEvent we can link with this.
$buildUniqueId = $pack->buildUniqueId();
$build = $this->buildByUniqueId($buildUniqueId);
}
else
{
// No - this must be a symbolic package.
// We'll instantiate a symbolic BuildEvent for this.
$build = new BuildEvent(0, strtotime('Jan 8, 2005'), 'skyjake',
'jaakko.keranen@iki.fi', RT_STABLE/*assumed*/);
if($pack->hasReleaseNotesUri())
{
$build->setReleaseNotesUri($pack->releaseNotesUri());
}
if($pack->hasReleaseChangeLogUri())
{
$build->setReleaseChangeLogUri($pack->releaseChangeLogUri());
}
$build->addPackage($pack);
}
if(!$build instanceof BuildEvent) continue; // Odd...
// Is this build event already present in the index for this release version?
if(array_search($build, $buildList) !== FALSE) continue;
// Add this build to the index.
$buildList[] = $build;
}
foreach($releases as $version => &$buildList)
{
$numEvents = count($buildList);
for($i = (integer)0; $i < $numEvents; $i++)
{
$curEvent = &$buildList[$i];
if(!$curEvent instanceof BuildEvent) throw new Exception('BuildEvent expected but received something else.');
$prevEvent = (($i < $numEvents && isset($buildList[$i+1]))? $buildList[$i+1] : -1);
if($prevEvent instanceof BuildEvent)
{
$curEvent->setPrevForVersion($prevEvent);
}
$nextEvent = (($i > 0 && isset($buildList[$i-1]))? $buildList[$i-1] : -1);
if($nextEvent instanceof BuildEvent)
{
$curEvent->setNextForVersion($nextEvent);
}
}
}
return TRUE;
}
/**
* Chain BuildEvents together to form a navigable web of events.
*/
private function chainBuilds()
{
$this->chainBuildsByStartDate();
$this->chainBuildsByDoomsdayVersion();
}
private function rebuildPackages()
{
// Generate packages from feed events.
$this->grabAndParseBuildFeedXML();
// Main collection consists of those produced from the feed and the statics.
$this->packages = array();
foreach($this->builds as &$build)
foreach($build->packages as &$pack)
{
$this->packages[] = $pack;
}
// Add the 'static' packages.
$this->populateStaticPackages(&$this->packages);
// The symbolic packages are kept seperate.
$this->symbolicPackages = array();
$this->populateSymbolicPackages(&$this->symbolicPackages);
// Link build events together to form the navigation chains.
$this->chainBuilds();
}
/**
* One-time initialization of the Packages collection.
*/
private function initPackages()
{
// Init the special case 'null' package.
self::$nullPack = PackageFactory::newNullPackage();
// Init collections.
$this->rebuildPackages();
}
/**
* Choose a Package from the collection which satisfies the
* specified selection filters. If no suitable package can
* be found the special NullPackage is returned.
*
* @param platformId (Integer) PlatformId filter.
* @param title (String) Symbolic name of the package to download. Default="Doomsday".
* @param unstable (Boolean) @c true= Only consider 'unstable' packs.
* @param hasDownload (Boolean) @c true= Only consider 'downloadable' packs.
* @return (Object) Chosen package.
*/
private function &choosePackage($platformId=PID_ANY, $title="Doomsday",
$unstable=FALSE, $downloadable=TRUE)
{
$unstable = (boolean)$unstable;
$downloadable = (boolean)$downloadable;
if(isset($this->packages))
{
$matchTitle = (boolean)(strlen($title) > 0);
foreach($this->packages as &$pack)
{
if($pack->platformId() !== $platformId) continue;
if($matchTitle && strcasecmp($pack->title(), $title)) continue;
if($unstable != ($pack instanceof AbstractUnstablePackage)) continue;
if($downloadable != ($pack instanceof iDownloadable && $pack->hasDirectDownloadUri())) continue;
// Found something suitable.
return $pack;
}
}
// Nothing suitable.
return self::$nullPack;
}
/**
* Implements RequestInterpreter
*/
public function InterpretRequest($request)
{
global $FrontController;
$uri = urldecode($request->url()->path());
// @kludge skip over the first '/' in the home URL.
$uri = substr($uri, 1);
// Remove any trailing file extension, such as 'something.html'
if(strrpos($uri, '.'))
$uri = substr($uri, 0, strrpos($uri, '.'));
$uriArgs = $request->url()->args();
// Tokenize the request URL so we can begin to determine what to do.
$tokens = explode('/', $uri);
if(!count($tokens)) return false; // How peculiar...
// A symbolic build name?
if($tokens[0] === 'latestbuild')
{
$this->initPackages();
// Are we redirecting to a specific package?
$getPackage = FALSE;
if(isset($uriArgs['platform']))
{
// Parse and validate arguments.
$platformId = $this->parsePlatformId($uriArgs['platform']);
$unstable = isset($uriArgs['unstable']);
// Default to Doomsday if a pack is not specified.
$packTitle = "Doomsday";
if(isset($uriArgs['pack']))
{
$packTitle = trim($uriArgs['pack']);
}
// Try to find a suitable package...
$pack = &$this->choosePackage($platformId, $packTitle, $unstable);
if(!($pack instanceof NullPackage))
{
$args = array();
// Are we retrieving the object graph?
if(isset($uriArgs['graph']))
{
// Return the object graph.
$args['getgraph'] = $pack;
}
else
{
// Redirect to the package download.
$args['getpackage'] = $pack;
}
$FrontController->enqueueAction($this, $args);
return true; // Eat the request.
}
}
// Redirect to the build repository index.
$FrontController->enqueueAction($this, array('build' => -1/*dummy value*/));
return true; // Eat the request.
}
// Perhaps a named build or the index?
if(!strncasecmp('build', $tokens[0], 5))
{
$this->initPackages();
$buildId = intval(substr($tokens[0], 5));
// Is this a known event?
$build = $this->buildByUniqueId($buildId);
if(!$build instanceof BuildEvent)
$buildId = 0; // Show the index.
$FrontController->enqueueAction($this, array('build' => $buildId));
return true; // Eat the request.
}
return false; // Not for us.
}
/**
* Output build event stream navigational controls.
*
* @param currentEvent (integer) Current event.
*/
private function outputBuildStreamNavigation(&$event)
{
$headEvent = $event->prevForStartDate();
if(!$headEvent instanceof BuildEvent)
$headEvent = $event;
?><div id="buildsnav" class="hnav"><h3><span>←Older</span> <a href="builds" title="Back to the Build Repository index">Index</a> <span>Newer→</span></h3><?php
?><div class="buildstreamlist"><?php
$this->outputBuildStreamWidget($headEvent, 'startdate', TRUE/*ascend*/, 3,
NULL/*no release header*/,
TRUE/*use the horiztonal variant*/,
$event, TRUE/*current is inactive*/);
?></div></div><?php
}
/**
* Retrieve the BuildEvent object associated with @a uniqueId.
*
* @param uniqueId (Integer) Unique identfier of the build event.
* @return (Mixed) BuildEvent object for the build else @c NULL.
*/
public function buildByUniqueId($uniqueId=0)
{
$uniqueId = intval($uniqueId);
if($uniqueId > 0)
foreach($this->builds as &$build)
{
if($uniqueId === $build->uniqueId()) return $build;
}
return NULL;
}
private function outputEventList($maxEvents=10)
{
if(!isset($this->builds)) return;
// A clickable button for the RSS feed.
?><div class="buildnews_list"><a href="<?php echo preg_replace('/(&)/', '&', self::RSS_FEED_URI); ?>" class="link-rss" title="Build News via RSS"><span class="hidden">RSS</span></a> <span id="buildnews-label">Latest Build News:</span><?php
if($this->builds)
{
// Generate a table of build events.
?><table><?php
$n = (integer) 0;
foreach($this->builds as $event)
{
$shortDate = date("d/m/y", $event->startDate());
$eventHTML = $event->genBadge();
// Wrap the event in a div which has all if our stylings.
?><tr><td><?php echo htmlspecialchars($shortDate); ?></td><td><?php echo $eventHTML; ?></td></tr><?php
if(++$n >= $maxEvents)
break;
}
?></table><?php
}
else
{
?><ul><li><em>...presently unavailable</em></li></ul><?php
}
?></div><?php
}
private function outputPackageList(&$packages, $notThisPack=NULL,
$chosenPlatformId=NULL, $unstable=-1/*no filter*/, $downloadable=-1/*no filter*/,
$maxPacks=-1/*no limit*/, $listTitleHTML=NULL/*no title*/)
{
if(!is_array($packages)) return;
$maxPacks = intval($maxPacks);
if($maxPacks === 0) return;
if($maxPacks < 0) $maxPacks = -1;
$unstable = intval($unstable);
if($unstable < 0) $unstable = -1; // Any.
else $unstable = $unstable? 1 : 0;
$downloadable = intval($downloadable);
if($downloadable < 0) $downloadable = -1; // Any.
else $downloadable = $downloadable? 1 : 0;
// Generate package list:
$numPacks = (integer)0;
foreach($packages as &$pack)
{
// Filtered out?
if($pack === $notThisPack) continue;
if($unstable != -1 && (boolean)$unstable == ($pack instanceof AbstractUnstablePackage)) continue;
if($downloadable != -1 && (boolean)$downloadable != ($pack instanceof iDownloadable && $pack->hasDirectDownloadUri())) continue;
if(!is_null($chosenPlatformId) && $pack->platformId() === $chosenPlatformId) continue;
// Begin the list?
if(!$numPacks)
{
// Compose list title:
?><div class="downloads_list"><?php
if(!is_null($listTitleHTML))
{
echo $listTitleHTML;
}
?><ul><?php
}
// Generate a pretty download badge/button.
?><li><?php echo $pack->genDownloadBadge(); ?></li><?php
++$numPacks;
if($maxPacks !== -1 && $numPacks === $maxPacks) break;
}
if($numPacks)
{
// Finish this list.
?></ul></div><?php
}
}
private function outputPackageRedirect(&$pack)
{
global $FrontController;
if(!($pack instanceof AbstractPackage))
throw new Exception('Received invalid Package.');
// Begin the page.
$pageTitle = 'Downloading...';
$FrontController->outputHeader($pageTitle);
$FrontController->beginPage($pageTitle);
// Output the redirect directive.
?><meta http-equiv="REFRESH" content="2;url=<?php echo $pack->directDownloadUri(); ?>"><?php
// Generate page content.
?><div id="builds"><?php
?><p>Redirecting to the download for <em><?php echo htmlspecialchars($pack->composeFullTitle()); ?></em>. Your package should begin to download automatically within a few seconds, if not please use this <a href="<?php echo $pack->directDownloadUri(); ?>" title="<?php echo htmlspecialchars('Download '. $pack->composeFullTitle()); ?>">direct link</a> instead.</p><?php
?><p>Not what you wanted? Here are some alternatives:</p><?php
// Alternative packages:
?><div class="centered"><?php
// Latest stable packages.
$packageListTitle = 'Latest packages:';
$this->outputPackageList(&$this->packages, $pack, PID_ANY, FALSE/*stable*/,
TRUE/*only downloadables*/, 8, $packageListTitle);
// Latest unstable packages.
$packageListTitle = 'Latest packages (<a class="link-definition" href="dew/index.php?title=Automated_build_system#Unstable" title="What does \'unstable\' mean?">unstable</a>):';
$this->outputPackageList(&$this->packages, $pack, PID_ANY, TRUE/*unstable*/,
TRUE/*only downloadables*/, 8, $packageListTitle);
?></div><?php
// Alternative pages:
includeHTML('alternativepages', self::$name);
// End of page content.
?></div><?php
$FrontController->endPage();
}
/**
* Compose the cache name for the Package's object graph.
* Packages produced by a build event go into that build's subdirectory.
* Other packages (i.e., stable or symbolic) are placed in the root.
*/
private function composePackageGraphCacheName(&$pack)
{
if(!($pack instanceof BasePackage))
throw new Exception('Received invalid Package.');
$cacheName = 'buildrepository/';
if($pack instanceof iBuilderProduct)
{
$cacheName .= $pack->buildUniqueId().'/';
}
$cacheName .= md5(strtolower($pack->composeFullTitle())).'.json';
return $cacheName;
}