/
MultiBranchProject.java
2455 lines (2330 loc) · 103 KB
/
MultiBranchProject.java
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
/*
* The MIT License
*
* Copyright (c) 2011-2017, CloudBees, Inc., Stephen Connolly.
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
* THE SOFTWARE.
*/
package jenkins.branch;
import com.cloudbees.hudson.plugins.folder.ChildNameGenerator;
import com.cloudbees.hudson.plugins.folder.FolderIcon;
import com.cloudbees.hudson.plugins.folder.computed.ChildObserver;
import com.cloudbees.hudson.plugins.folder.computed.ComputedFolder;
import com.cloudbees.hudson.plugins.folder.computed.EventOutputStreams;
import com.cloudbees.hudson.plugins.folder.computed.FolderComputation;
import com.cloudbees.hudson.plugins.folder.views.AbstractFolderViewHolder;
import com.thoughtworks.xstream.XStreamException;
import edu.umd.cs.findbugs.annotations.CheckForNull;
import edu.umd.cs.findbugs.annotations.NonNull;
import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
import hudson.BulkChange;
import hudson.Extension;
import hudson.Util;
import hudson.XmlFile;
import hudson.console.ModelHyperlinkNote;
import hudson.model.Action;
import hudson.model.Cause;
import hudson.model.CauseAction;
import hudson.model.Descriptor;
import hudson.model.Failure;
import hudson.model.Item;
import hudson.model.ItemGroup;
import hudson.model.Items;
import hudson.model.Job;
import hudson.model.Run;
import hudson.model.Saveable;
import hudson.model.StreamBuildListener;
import hudson.model.TaskListener;
import hudson.model.TopLevelItem;
import hudson.model.View;
import hudson.model.listeners.ItemListener;
import hudson.model.listeners.SaveableListener;
import hudson.scm.PollingResult;
import hudson.security.ACL;
import hudson.security.Permission;
import hudson.util.PersistedList;
import hudson.util.StreamTaskListener;
import hudson.util.XStream2;
import java.io.ByteArrayOutputStream;
import java.io.File;
import java.io.IOException;
import java.nio.charset.StandardCharsets;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.HashMap;
import java.util.HashSet;
import java.util.IdentityHashMap;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;
import java.util.Objects;
import java.util.Optional;
import java.util.Set;
import java.util.TreeSet;
import java.util.concurrent.TimeUnit;
import java.util.logging.Level;
import java.util.logging.LogRecord;
import java.util.logging.Logger;
import javax.servlet.ServletException;
import jenkins.model.Jenkins;
import jenkins.model.ParameterizedJobMixIn;
import jenkins.model.TransientActionFactory;
import jenkins.scm.api.SCMEvent;
import jenkins.scm.api.SCMEventListener;
import jenkins.scm.api.SCMHead;
import jenkins.scm.api.SCMHeadEvent;
import jenkins.scm.api.SCMHeadMigration;
import jenkins.scm.api.SCMHeadObserver;
import jenkins.scm.api.SCMRevision;
import jenkins.scm.api.SCMSource;
import jenkins.scm.api.SCMSourceCriteria;
import jenkins.scm.api.SCMSourceEvent;
import jenkins.scm.api.SCMSourceOwner;
import jenkins.scm.api.metadata.ObjectMetadataAction;
import jenkins.scm.api.mixin.TagSCMHead;
import jenkins.scm.api.trait.SCMSourceTrait;
import jenkins.scm.impl.NullSCMSource;
import jenkins.triggers.SCMTriggerItem;
import jenkins.util.SystemProperties;
import net.sf.json.JSONObject;
import org.apache.commons.io.FileUtils;
import org.apache.commons.lang.StringUtils;
import org.jenkins.ui.icon.IconSpec;
import org.kohsuke.accmod.Restricted;
import org.kohsuke.accmod.restrictions.NoExternalUse;
import org.kohsuke.stapler.StaplerRequest;
import org.kohsuke.stapler.StaplerResponse;
import org.kohsuke.stapler.export.Exported;
import org.springframework.security.core.Authentication;
import static hudson.Functions.printStackTrace;
/**
* Abstract base class for multiple-branch based projects.
*
* @param <P>
* the project type
* @param <R>
* the run type
*/
public abstract class MultiBranchProject<P extends Job<P, R> & TopLevelItem,
R extends Run<P, R>>
extends ComputedFolder<P> implements SCMSourceOwner, IconSpec {
@SuppressFBWarnings(value = "MS_SHOULD_BE_FINAL", justification = "Accessible via System Groovy Scripts")
private static /* not final */ boolean FIRE_SCM_SOURCE_BUILDS_AFTER_SAVE =
SystemProperties.getBoolean(MultiBranchProject.class.getName() + ".fireSCMSourceBuildsAfterSave", true);
/**
* Our logger.
*/
private static final Logger LOGGER = Logger.getLogger(MultiBranchProject.class.getName());
/**
* The user supplied branch sources.
*/
private /*almost final*/ PersistedList<BranchSource> sources = new BranchSourceList(this);
/**
* The persisted state maintained outside of the config file.
*
* @since 2.0
*/
private transient /*almost final*/ State state = new State(this);
/**
* The source for dead branches.
*/
private transient /*almost final*/ NullSCMSource nullSCMSource;
/**
* The factory for building child job instances.
*/
private BranchProjectFactory<P, R> factory;
private transient String srcDigest, facDigest;
/**
* Constructor, mandated by {@link TopLevelItem}.
*
* @param parent
* the parent of this multibranch job.
* @param name
* the name of the multibranch job.
*/
protected MultiBranchProject(ItemGroup parent, String name) {
super(parent, name);
init2();
}
/**
* {@inheritDoc}
*/
@Override
public void onLoad(ItemGroup<? extends Item> parent, String name) throws IOException {
super.onLoad(parent, name);
init2();
PropertyMigration.applyAll(this);
try {
srcDigest = Util.getDigestOf(Items.XSTREAM2.toXML(sources));
} catch (XStreamException e) {
srcDigest = null;
}
BranchProjectFactory<P, R> factory = getProjectFactory();
try {
facDigest = Util.getDigestOf(Items.XSTREAM2.toXML(factory));
} catch (XStreamException e) {
facDigest = null;
}
if (state == null) {
state = new State(this);
}
try {
state.load();
} catch (XStreamException | IOException e) {
LOGGER.log(Level.WARNING, "Could not read persisted state, will be recovered on next index.", e);
state.reset();
}
// optimize lookup of sources by building a temporary map that is equivalent to getSCMSource(id) in results
Map<String, SCMSource> sourceMap = new HashMap<>();
for (BranchSource source : sources) {
SCMSource s = source.getSource();
String id = s.getId();
if (!sourceMap.containsKey(id)) { // only the first match should win
sourceMap.put(id, s);
}
}
for (P item : getItems(factory::isProject)) {
Branch oldBranch = factory.getBranch(item);
SCMSource source = sourceMap.get(oldBranch.getSourceId());
if (source == null || source instanceof NullSCMSource) {
continue;
}
SCMHead oldHead = oldBranch.getHead();
SCMHead newHead = SCMHeadMigration.readResolveSCMHead(source, oldHead);
if (newHead != oldHead) {
LOGGER.log(Level.INFO, "Job {0}: a plugin upgrade is requesting migration of branch from {1} to {2}",
new Object[]{item.getFullName(), oldHead.getClass(), newHead.getClass()}
);
try {
Branch newBranch = new Branch(oldBranch.getSourceId(), newHead, oldBranch.getScm(),
oldBranch.getProperties());
newBranch.setActions(oldBranch.getActions());
factory.setBranch(item, newBranch);
SCMRevision revision = factory.getRevision(item);
factory.setRevisionHash(item, SCMHeadMigration.readResolveSCMRevision(source, revision));
} catch (IOException | RuntimeException e) {
LogRecord lr = new LogRecord(Level.WARNING,
"Job {0}: Could not complete migration of branch from type {1} to {2}. "
+ "The side-effect of this is that the next index may trigger a rebuild "
+ "of the job (after which the issue will be resolved)");
lr.setThrown(e);
lr.setParameters(new Object[]{item.getFullName(), oldHead.getClass(), newHead.getClass()});
LOGGER.log(lr);
}
}
}
if (Items.currentlyUpdatingByXml() && FIRE_SCM_SOURCE_BUILDS_AFTER_SAVE) {
fireSCMSourceAfterSave(getSCMSources());
if (isBuildable()) {
scheduleBuild();
}
}
}
/**
* Consolidated initialization code.
*/
private synchronized void init2() {
if (sources == null) {
sources = new PersistedList<>(this);
}
if (nullSCMSource == null) {
nullSCMSource = new NullSCMSource();
}
nullSCMSource.setOwner(this);
for (SCMSource source : getSCMSources()) {
source.setOwner(this);
}
final BranchProjectFactory<P, R> factory = getProjectFactory();
factory.setOwner(this);
if (!(getFolderViews() instanceof MultiBranchProjectViewHolder)) {
resetFolderViews();
}
if (getIcon() == null) {
setIcon(newDefaultFolderIcon());
}
}
/**
* {@inheritDoc}
*/
@Override
protected AbstractFolderViewHolder newFolderViewHolder() {
return new MultiBranchProjectViewHolder(this);
}
/**
* {@inheritDoc}
*/
@Override
protected FolderIcon newDefaultFolderIcon() {
return new MetadataActionFolderIcon();
}
/**
* {@inheritDoc}
*/
@Override
public String getIconClassName() {
String result;
if (sources.size() == 1) {
result = sources.get(0).getSource().getDescriptor().getIconClassName();
} else {
result = null;
for (int i = 0; i < sources.size(); i++) {
String iconClassName = sources.get(i).getSource().getDescriptor().getIconClassName();
if (i == 0) {
result = iconClassName;
} else if (!StringUtils.equals(result, iconClassName)) {
result = null;
break;
}
}
}
return result != null ? result : getDescriptor().getIconClassName();
}
/**
* Get the term used in the UI to represent the source for this kind of
* {@link Item}. Must start with a capital letter.
*
* @return term used in the UI to represent the source
*/
public String getSourcePronoun() {
Set<String> result = new TreeSet<>();
for (BranchSource source : sources) {
String pronoun = Util.fixEmptyAndTrim(source.getSource().getPronoun());
if (pronoun != null) {
result.add(pronoun);
}
}
return result.isEmpty() ? this.getPronoun() : StringUtils.join(result, " / ");
}
/**
* Returns the {@link BranchProjectFactory}. ˜
*
* @return the {@link BranchProjectFactory}.
*/
@NonNull
public synchronized BranchProjectFactory<P, R> getProjectFactory() {
if (factory == null) {
setProjectFactory(newProjectFactory());
}
return factory;
}
/**
* Returns the base class of the projects that are managed by this {@link MultiBranchProject}.
*
* @return the base class of the projects that are managed by this {@link MultiBranchProject}.
* @since 2.0
*/
@SuppressWarnings("unchecked")
public final Class<P> getProjectClass() {
return (Class<P>) getDescriptor().getProjectClass();
}
/**
* Sets the {@link BranchProjectFactory}.
*
* @param projectFactory
* the new {@link BranchProjectFactory}.
*/
public synchronized void setProjectFactory(BranchProjectFactory<P, R> projectFactory) {
projectFactory.getClass(); // throw NPE if null
if (factory == projectFactory) {
return;
}
factory = projectFactory;
factory.setOwner(this);
}
/**
* Creates a new instance of the default project factory to be used for a new instance of the project type.
*
* @return a new default {@link BranchProjectFactory}.
*/
@NonNull
protected abstract BranchProjectFactory<P, R> newProjectFactory();
/**
* The sources of branches.
*
* @return the sources of branches.
*/
@Exported
@NonNull
public List<BranchSource> getSources() {
if (sources != null) {
return sources.toList();
} else {
// return empty, this object is still being constructed
return Collections.emptyList();
}
}
/**
* Offers direct access to the configurable list of branch sources.
* Intended for use from scripting and testing.
*
* @return the sources list.
*/
@NonNull
public PersistedList<BranchSource> getSourcesList() {
return sources;
}
/**
* Offers direct access to set the configurable list of branch sources <strong>while</strong> preserving
* branch source id associations for sources that are otherwise unmodified
*
* @param sources
* the new sources.
* @throws IOException
* if the sources could not be persisted to disk.
*/
public void setSourcesList(List<BranchSource> sources) throws IOException {
if (this.sources.isEmpty() || sources.isEmpty()) {
// easy
this.sources.replaceBy(sources);
return;
}
Set<String> oldIds = sourceIds(this.sources);
Set<String> newIds = sourceIds(sources);
if (oldIds.containsAll(newIds) || newIds.containsAll(oldIds)) {
// either adding, removing, or updating without an id change
this.sources.replaceBy(sources);
return;
}
// Now we need to check if any of the new entries are effectively the same as an old entry that is being removed
// we will store the ID changes in a map and process all the affected branches to update their sourceIds
Map<String, String> changedIds = new HashMap<>();
Set<String> additions = new HashSet<>(newIds);
additions.removeAll(oldIds);
Set<String> removals = new HashSet<>(oldIds);
removals.removeAll(newIds);
for (BranchSource addition : sources) {
String additionId = addition.getSource().getId();
if (!additions.contains(additionId)) {
continue;
}
for (BranchSource removal : this.sources) {
String removalId = removal.getSource().getId();
if (!removals.contains(removalId)) {
continue;
}
if (!equalButForId(removal.getSource(), addition.getSource())) {
continue;
}
changedIds.put(removalId, additionId);
// now take these two out of consideration
removals.remove(removalId);
additions.remove(additionId);
break;
}
}
this.sources.replaceBy(sources);
BranchProjectFactory<P, R> factory = getProjectFactory();
for (P item : getItems(factory::isProject)) {
Branch oldBranch = factory.getBranch(item);
if (changedIds.containsKey(oldBranch.getSourceId())) {
Branch newBranch = new Branch(changedIds.get(oldBranch.getSourceId()), oldBranch.getHead(), oldBranch.getScm(), oldBranch.getProperties());
newBranch.setActions(oldBranch.getActions());
factory.setBranch(item, newBranch);
}
}
}
private Set<String> sourceIds(List<BranchSource> sources) {
Set<String> result = new HashSet<>();
for (BranchSource s : sources) {
result.add(s.getSource().getId());
}
return result;
}
private boolean equalButForId(SCMSource a, SCMSource b) {
if (!a.getClass().equals(b.getClass())) {
return false;
}
return SOURCE_ID_OMITTED_XSTREAM.toXML(a).equals(SOURCE_ID_OMITTED_XSTREAM.toXML(b));
}
private final static XStream2 SOURCE_ID_OMITTED_XSTREAM = new XStream2();
static {
SOURCE_ID_OMITTED_XSTREAM.omitField(SCMSource.class, "id");
}
/**
* {@inheritDoc}
*/
@NonNull
public List<SCMSource> getSCMSources() {
List<SCMSource> result = new ArrayList<>();
if (sources != null) {
for (BranchSource source : sources) {
result.add(source.getSource());
}
} // else, ok to ignore and return empty, this object is still being constructed
return result;
}
/**
* {@inheritDoc}
*/
@CheckForNull
public SCMSource getSCMSource(@CheckForNull String sourceId) {
for (SCMSource source : getSCMSources()) {
if (source.getId().equals(sourceId)) {
return source;
}
}
return nullSCMSource;
}
/**
* Returns the {@link BranchPropertyStrategy} for a specific {@link SCMSource}.
*
* @param source
* the specific {@link SCMSource}.
* @return the {@link BranchPropertyStrategy} to use.
*/
@CheckForNull
public BranchPropertyStrategy getBranchPropertyStrategy(@NonNull SCMSource source) {
for (BranchSource s : getSources()) {
if (s.getSource().equals(source)) {
return s.getStrategy();
}
}
return null;
}
/**
* Creates a {@link Branch} for a specific {@link SCMSource} and {@link SCMHead}.
*
* @param source
* the {@link SCMSource}
* @param head
* the {@link SCMHead}.
* @return the {@link Branch}
*/
@NonNull
private Branch newBranch(@NonNull SCMSource source, @NonNull SCMHead head) {
source.getClass(); // throw NPE if null
head.getClass(); // throw NPE if null
String sourceId = source.getId();
if (NullSCMSource.ID.equals(sourceId)) {
return new Branch.Dead(head, Collections.emptyList());
} else {
final BranchPropertyStrategy strategy = getBranchPropertyStrategy(source);
return new Branch(sourceId, head, source.build(head),
strategy != null ? strategy.getPropertiesFor(head) : Collections.emptyList());
}
}
/**
* {@inheritDoc}
*/
@CheckForNull
public SCMSourceCriteria getSCMSourceCriteria(@NonNull SCMSource source) {
return null;
}
/**
* {@inheritDoc}
*/
public void onSCMSourceUpdated(@NonNull SCMSource source) {
if (isBuildable()) {
scheduleBuild(0, new BranchIndexingCause());
}
}
/**
* {@inheritDoc}
*/
@Override
public boolean isHasEvents() {
return true;
}
/**
* {@inheritDoc}
*/
@Override
protected void computeChildren(final ChildObserver<P> observer, final TaskListener listener)
throws IOException, InterruptedException {
// capture the current digests to prevent unnecessary reindex if re-saving after index
try {
srcDigest = Util.getDigestOf(Items.XSTREAM2.toXML(sources));
} catch (XStreamException e) {
srcDigest = null;
}
try {
facDigest = Util.getDigestOf(Items.XSTREAM2.toXML(getProjectFactory()));
} catch (XStreamException e) {
facDigest = null;
}
long start = System.currentTimeMillis();
listener.getLogger().format("[%tc] Starting branch indexing...%n", start);
try {
final BranchProjectFactory<P, R> _factory = getProjectFactory();
List<SCMSource> scmSources = getSCMSources();
Map<String, List<Action>> sourceActions = new LinkedHashMap<>();
for (SCMSource source : scmSources) {
try {
sourceActions.put(source.getId(), source.fetchActions(null, listener));
} catch (IOException | InterruptedException | RuntimeException e) {
listener.error("[%tc] Could not update folder level actions from source %s",
System.currentTimeMillis(), source.getId());
throw e;
}
}
// update any persistent actions for the SCMSource
if (!sourceActions.equals(state.sourceActions)) {
boolean saveProject = false;
for (List<Action> actions : sourceActions.values()) {
for (Action a : actions) {
// undo any hacks that attached the contributed actions without attribution
saveProject = removeActions(a.getClass()) || saveProject;
}
}
BulkChange bc = new BulkChange(state);
try {
state.sourceActions.keySet().retainAll(sourceActions.keySet());
state.sourceActions.putAll(sourceActions);
try {
bc.commit();
} catch (IOException | RuntimeException e) {
listener.error("[%tc] Could not persist folder level actions",
System.currentTimeMillis());
throw e;
}
if (saveProject) {
try {
save();
} catch (IOException | RuntimeException e) {
listener.error(
"[%tc] Could not persist folder level configuration changes",
System.currentTimeMillis());
throw e;
}
}
} finally {
bc.abort();
}
}
for (final SCMSource source : scmSources) {
try {
source.fetch(new SCMHeadObserverImpl(source, observer, listener, _factory,
new IndexingCauseFactory(), null), listener);
} catch (IOException | InterruptedException | RuntimeException e) {
listener.error("[%tc] Could not fetch branches from source %s",
System.currentTimeMillis(), source.getId());
throw e;
}
}
} finally {
long end = System.currentTimeMillis();
listener.getLogger().format("[%tc] Finished branch indexing. Indexing took %s%n", end,
Util.getTimeSpanString(end - start));
}
}
private void scheduleBuild(BranchProjectFactory<P, R> factory, final P item, SCMRevision revision, TaskListener listener, String name, Cause[] causes, Action... actions) {
if (!isBuildable()) {
listener.getLogger().printf("Did not schedule build for branch: %s (%s is disabled)%n",
name, getDisplayName());
return;
}
// JENKINS-48090 see Queue.Item.getCauses() which only operates on the first CauseAction
// We need to merge any additional causes with the causes we are supplying
int causeCount = 0;
for (Action action : actions) {
if (action instanceof CauseAction) {
causeCount++;
}
}
Action[] _actions;
if (causeCount == 0) {
// no existing causes, insert new one at start
_actions = new Action[actions.length + 1];
_actions[0] = new CauseAction(causes);
System.arraycopy(actions, 0, _actions, 1, actions.length);
} else {
// existing causes, filter out and insert aggregate at start
_actions = new Action[actions.length + 1 - causeCount];
int i = 1;
List<Cause> _causes = new ArrayList<>();
Collections.addAll(_causes, causes);
for (Action a : actions) {
if (a instanceof CauseAction) {
_causes.addAll(((CauseAction) a).getCauses());
} else {
_actions[i++] = a;
}
}
_actions[0] = new CauseAction(_causes);
}
if (ParameterizedJobMixIn.scheduleBuild2(item, -1, _actions) != null) {
listener.getLogger().println("Scheduled build for branch: " + name);
try {
factory.setRevisionHash(item, revision);
} catch (IOException e) {
printStackTrace(e, listener.error("Could not update last revision hash"));
}
} else {
listener.getLogger().println("Did not schedule build for branch: " + name);
}
}
/**
* {@inheritDoc}
*/
@Override
protected Collection<P> orphanedItems(Collection<P> orphaned, TaskListener listener)
throws IOException, InterruptedException {
BranchProjectFactory<P, R> _factory = getProjectFactory();
for (P project : orphaned) {
if (!_factory.isProject(project)) {
listener.getLogger().println("Detected unsupported subitem " + project + ", skipping");
continue; // TODO perhaps better to remove from list passed to super, and return it from here
}
Branch b = _factory.getBranch(project);
if (!(b instanceof Branch.Dead)) {
_factory.decorate(
_factory.setBranch(project, new Branch.Dead(b)));
}
}
return super.orphanedItems(orphaned, listener);
}
/**
* Returns the named child job or {@code null} if no such job exists.
*
* @param name
* the name of the child job.
* @return the named child job or {@code null} if no such job exists.
*/
@Override
@CheckForNull
public P getItem(String name) {
if (name == null) {
return null;
}
P item = super.getItem(name);
if (item != null) {
return item;
}
if (name.indexOf('%') != -1) {
String decoded = NameEncoder.decode(name);
item = super.getItem(decoded);
if (item != null) {
return item;
}
// fall through for double decoded call paths // TODO is this necessary
}
return super.getItem(NameEncoder.encode(name));
}
/**
* Returns the child job with the specified branch name or {@code null} if no such child job exists.
*
* @param branchName
* the name of the branch.
* @return the child job or {@code null} if no such job exists or if the requesting user does ave permission to
* view it.
* @since 2.0.0
*/
@CheckForNull
public P getItemByBranchName(@NonNull String branchName) {
return super.getItem(NameEncoder.encode(branchName));
}
/**
* Returns the named branch job or {@code null} if no such branch exists.
*
* @param name
* the name of the branch
* @return the named branch job or {@code null} if no such branch exists.
* @deprecated use {@link #getItem(String)} or {@link #getJob(String)} directly
*/
@Deprecated
@CheckForNull
@SuppressWarnings("unused")// by stapler for URL binding
public P getBranch(String name) {
return getItem(name);
}
/**
* {@inheritDoc}
*/
@NonNull
@Override
public ACL getACL() {
final ACL acl = super.getACL();
if (getParent() instanceof ComputedFolder<?>) {
return new ACL() {
@Override
public boolean hasPermission2(@NonNull Authentication a, @NonNull Permission permission) {
if (ACL.SYSTEM2.equals(a)) {
return true;
} else if (SUPPRESSED_PERMISSIONS.contains(permission)) {
return false;
} else {
return acl.hasPermission2(a, permission);
}
}
};
} else {
return acl;
}
}
private static final Set<Permission> SUPPRESSED_PERMISSIONS =
Collections.unmodifiableSet(new HashSet<>(Arrays.asList(
Item.CONFIGURE, Item.DELETE, View.CONFIGURE, View.CREATE, View.DELETE)));
/**
* {@inheritDoc}
*/
@Override
public String getDescription() {
String description = super.getDescription();
if (StringUtils.isNotBlank(description)) {
return description;
}
ObjectMetadataAction action = getAction(ObjectMetadataAction.class);
if (action != null) {
return action.getObjectDescription();
}
return super.getDescription();
}
/**
* {@inheritDoc}
*/
@Override
public String getDisplayName() {
String displayName = getDisplayNameOrNull();
if (displayName == null) {
ObjectMetadataAction action = getAction(ObjectMetadataAction.class);
if (action != null && StringUtils.isNotBlank(action.getObjectDisplayName())) {
return action.getObjectDisplayName();
}
}
return super.getDisplayName();
}
/**
* Returns the directory that all branches are stored in.
*
* @return the directory that all branches are stored in.
*/
@Override
@NonNull
public File getJobsDir() {
return new File(getRootDir(), "branches");
}
/**
* {@inheritDoc}
*/
@Override
public File getRootDirFor(P child) {
return super.getRootDirFor(child); // need the bridge method to provide binary compatibility
}
/**
* Returns the directory that branch indexing is stored in.
*
* @return the directory that branch indexing is stored in.
*/
@Override
@NonNull
public File getComputationDir() {
return new File(getRootDir(), "indexing");
}
/**
* {@inheritDoc}
*/
@Override
@NonNull
public MultiBranchProjectDescriptor getDescriptor() {
return (MultiBranchProjectDescriptor) super.getDescriptor();
}
/**
* Returns the current/most recent indexing details.
*
* @return the current/most recent indexing details.
*/
@SuppressWarnings("unused") // URL binding for stapler.
public synchronized BranchIndexing<P, R> getIndexing() {
return (BranchIndexing) getComputation();
}
/**
* {@inheritDoc}
*/
@Override
protected void submit(StaplerRequest req, StaplerResponse rsp)
throws IOException, ServletException, Descriptor.FormException {
super.submit(req, rsp);
List<SCMSource> _sources = new ArrayList<>();
synchronized (this) {
JSONObject json = req.getSubmittedForm();
setSourcesList(req.bindJSONToList(BranchSource.class, json.opt("sources")));
for (SCMSource scmSource : getSCMSources()) {
scmSource.setOwner(this);
_sources.add(scmSource);
}
setProjectFactory(req.bindJSON(BranchProjectFactory.class, json.getJSONObject("projectFactory")));
}
fireSCMSourceAfterSave(_sources);
recalculateAfterSubmitted(updateDigests());
}
/**
* Fires the {@link SCMSource#afterSave()} method for the supplied sources.
*
* @param sources
* the sources.
*/
protected void fireSCMSourceAfterSave(List<SCMSource> sources) {
for (SCMSource scmSource : sources) {
scmSource.afterSave();
}
}
/**
* Updates the digests used to detect changes to the sources and project factories (which would mandate a
* recalculation).
*
* @return {@code true} if the digests have changed.
*/
/*package*/ boolean updateDigests() {
String srcDigest;
try {
srcDigest = Util.getDigestOf(Items.XSTREAM2.toXML(sources));
} catch (XStreamException e) {
srcDigest = null;
}
String facDigest;
try {
facDigest = Util.getDigestOf(Items.XSTREAM2.toXML(getProjectFactory()));
} catch (XStreamException e) {
facDigest = null;
}
try {
return !StringUtils.equals(srcDigest, this.srcDigest)
|| !StringUtils.equals(facDigest, this.facDigest);
} finally {
this.srcDigest = srcDigest;
this.facDigest = facDigest;
}
}
/**
* Creates a place-holder view when there's no active branch indexed.
*
* @return the place-holder view when there's no active branch indexed.
*/
protected View getWelcomeView() {
return new MultiBranchProjectEmptyView(this);
}
/**
* {@inheritDoc}
*/
@Override
public View getView(String name) {
if (name.equals("Welcome")) {
return getWelcomeView();
} else {
return super.getView(name);
}
}
/**
* Represents the branch indexing job.
*
* @param <P>
* the type of project that the branch projects consist of.
* @param <R>
* the type of runs that the branch projects use.
*/
public static class BranchIndexing<P extends Job<P, R> & TopLevelItem,
R extends Run<P, R>> extends FolderComputation<P> {
public BranchIndexing(@NonNull MultiBranchProject<P, R> project,
@CheckForNull BranchIndexing<P, R> previousIndexing) {
super(project, previousIndexing);
}