-
Notifications
You must be signed in to change notification settings - Fork 387
/
JGitAPIImpl.java
2594 lines (2311 loc) · 99.9 KB
/
JGitAPIImpl.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
package org.jenkinsci.plugins.gitclient;
import static org.apache.commons.lang.StringUtils.isBlank;
import static org.apache.commons.lang.StringUtils.removeStart;
import static org.eclipse.jgit.api.ResetCommand.ResetType.HARD;
import static org.eclipse.jgit.api.ResetCommand.ResetType.MIXED;
import static org.eclipse.jgit.lib.Constants.CHARSET;
import static org.eclipse.jgit.lib.Constants.HEAD;
import static org.eclipse.jgit.lib.Constants.R_HEADS;
import static org.eclipse.jgit.lib.Constants.R_REMOTES;
import static org.eclipse.jgit.lib.Constants.R_TAGS;
import static org.eclipse.jgit.lib.Constants.typeString;
import static org.eclipse.jgit.transport.RemoteRefUpdate.Status.OK;
import static org.eclipse.jgit.transport.RemoteRefUpdate.Status.UP_TO_DATE;
import hudson.FilePath;
import hudson.Util;
import hudson.model.TaskListener;
import hudson.plugins.git.Branch;
import hudson.plugins.git.GitException;
import hudson.plugins.git.GitLockFailedException;
import hudson.plugins.git.IndexEntry;
import hudson.plugins.git.Revision;
import hudson.util.IOUtils;
import java.io.File;
import java.io.FileNotFoundException;
import java.io.IOException;
import java.io.InputStreamReader;
import java.io.PrintWriter;
import java.io.StringWriter;
import java.io.Writer;
import java.lang.reflect.Field;
import java.net.URISyntaxException;
import java.text.MessageFormat;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.Comparator;
import java.util.Date;
import java.util.HashMap;
import java.util.HashSet;
import java.util.List;
import java.util.ListIterator;
import java.util.Map;
import java.util.Set;
import java.util.regex.Pattern;
import javax.annotation.Nullable;
import org.apache.commons.lang.time.FastDateFormat;
import org.eclipse.jgit.api.AddNoteCommand;
import org.eclipse.jgit.api.CommitCommand;
import org.eclipse.jgit.api.CreateBranchCommand.SetupUpstreamMode;
import org.eclipse.jgit.api.FetchCommand;
import org.eclipse.jgit.api.SubmoduleUpdateCommand;
import org.eclipse.jgit.api.Git;
import org.eclipse.jgit.api.ListBranchCommand;
import org.eclipse.jgit.api.LsRemoteCommand;
import org.eclipse.jgit.api.MergeResult;
import org.eclipse.jgit.api.MergeCommand.FastForwardMode;
import org.eclipse.jgit.api.ResetCommand;
import org.eclipse.jgit.api.ShowNoteCommand;
import org.eclipse.jgit.api.errors.CheckoutConflictException;
import org.eclipse.jgit.api.errors.GitAPIException;
import org.eclipse.jgit.api.errors.InvalidRemoteException;
import org.eclipse.jgit.api.errors.JGitInternalException;
import org.eclipse.jgit.diff.DiffEntry;
import org.eclipse.jgit.diff.DiffEntry.ChangeType;
import org.eclipse.jgit.diff.RenameDetector;
import org.eclipse.jgit.errors.InvalidPatternException;
import org.eclipse.jgit.errors.LockFailedException;
import org.eclipse.jgit.errors.NotSupportedException;
import org.eclipse.jgit.errors.TransportException;
import org.eclipse.jgit.fnmatch.FileNameMatcher;
import org.eclipse.jgit.internal.JGitText;
import org.eclipse.jgit.internal.storage.file.FileRepository;
import org.eclipse.jgit.lib.Config;
import org.eclipse.jgit.lib.Constants;
import org.eclipse.jgit.lib.ObjectId;
import org.eclipse.jgit.lib.ObjectLoader;
import org.eclipse.jgit.lib.ObjectReader;
import org.eclipse.jgit.lib.PersonIdent;
import org.eclipse.jgit.lib.Ref;
import org.eclipse.jgit.lib.RefDatabase;
import org.eclipse.jgit.lib.RefUpdate;
import org.eclipse.jgit.lib.RefUpdate.Result;
import org.eclipse.jgit.lib.Repository;
import org.eclipse.jgit.lib.RepositoryBuilder;
import org.eclipse.jgit.lib.StoredConfig;
import org.eclipse.jgit.lib.SymbolicRef;
import org.eclipse.jgit.merge.MergeStrategy;
import org.eclipse.jgit.notes.Note;
import org.eclipse.jgit.revwalk.RevCommit;
import org.eclipse.jgit.revwalk.RevFlag;
import org.eclipse.jgit.revwalk.RevFlagSet;
import org.eclipse.jgit.revwalk.RevObject;
import org.eclipse.jgit.revwalk.RevSort;
import org.eclipse.jgit.revwalk.RevTree;
import org.eclipse.jgit.revwalk.RevWalk;
import org.eclipse.jgit.revwalk.filter.MaxCountRevFilter;
import org.eclipse.jgit.revwalk.filter.RevFilter;
import org.eclipse.jgit.submodule.SubmoduleWalk;
import org.eclipse.jgit.transport.BasePackFetchConnection;
import org.eclipse.jgit.transport.CredentialsProvider;
import org.eclipse.jgit.transport.FetchConnection;
import org.eclipse.jgit.transport.HttpTransport;
import org.eclipse.jgit.transport.RefSpec;
import org.eclipse.jgit.transport.RemoteConfig;
import org.eclipse.jgit.transport.SshSessionFactory;
import org.eclipse.jgit.transport.TagOpt;
import org.eclipse.jgit.transport.Transport;
import org.eclipse.jgit.transport.URIish;
import org.eclipse.jgit.transport.PushResult;
import org.eclipse.jgit.transport.RemoteRefUpdate;
import org.jenkinsci.plugins.gitclient.jgit.PreemptiveAuthHttpClientConnectionFactory;
import org.eclipse.jgit.treewalk.TreeWalk;
import org.eclipse.jgit.treewalk.filter.TreeFilter;
import org.jenkinsci.plugins.gitclient.trilead.SmartCredentialsProvider;
import org.jenkinsci.plugins.gitclient.trilead.TrileadSessionFactory;
import com.cloudbees.plugins.credentials.common.StandardCredentials;
import com.google.common.base.Functions;
import com.google.common.base.Predicate;
import com.google.common.base.Predicates;
import com.google.common.collect.Iterables;
import com.google.common.collect.Lists;
import edu.umd.cs.findbugs.annotations.NonNull;
import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
import org.eclipse.jgit.api.RebaseCommand.Operation;
import org.eclipse.jgit.api.RebaseResult;
/**
* GitClient pure Java implementation using JGit.
* Goal is to eventually get a full java implementation for GitClient
* <b>
* For internal use only, don't use directly. See {@link org.jenkinsci.plugins.gitclient.Git}
* </b>
*
* @author <a href="mailto:nicolas.deloof@gmail.com">Nicolas De Loof</a>
* @author Kohsuke Kawaguchi
*/
public class JGitAPIImpl extends LegacyCompatibleGitAPIImpl {
private static final long serialVersionUID = 1L;
private final TaskListener listener;
private PersonIdent author, committer;
private transient CredentialsProvider provider;
JGitAPIImpl(File workspace, TaskListener listener) {
/* If workspace is null, then default to current directory to match
* CliGitAPIImpl behavior */
this(workspace, listener, null);
}
JGitAPIImpl(File workspace, TaskListener listener, final PreemptiveAuthHttpClientConnectionFactory httpConnectionFactory) {
/* If workspace is null, then default to current directory to match
* CliGitAPIImpl behavior */
super(workspace == null ? new File(".") : workspace);
this.listener = listener;
// to avoid rogue plugins from clobbering what we use, always
// make a point of overwriting it with ours.
SshSessionFactory.setInstance(new TrileadSessionFactory());
if (httpConnectionFactory != null) {
httpConnectionFactory.setCredentialsProvider(asSmartCredentialsProvider());
// allow override of HttpConnectionFactory to avoid JENKINS-37934
HttpTransport.setConnectionFactory(httpConnectionFactory);
}
}
/**
* clearCredentials.
*/
public void clearCredentials() {
asSmartCredentialsProvider().clearCredentials();
}
/** {@inheritDoc} */
public void addCredentials(String url, StandardCredentials credentials) {
asSmartCredentialsProvider().addCredentials(url, credentials);
}
/** {@inheritDoc} */
public void addDefaultCredentials(StandardCredentials credentials) {
asSmartCredentialsProvider().addDefaultCredentials(credentials);
}
private synchronized SmartCredentialsProvider asSmartCredentialsProvider() {
if (!(provider instanceof SmartCredentialsProvider)) {
provider = new SmartCredentialsProvider(listener);
}
return ((SmartCredentialsProvider) provider);
}
/**
* setCredentialsProvider.
*
* @param prov a {@link org.eclipse.jgit.transport.CredentialsProvider} object.
*/
public synchronized void setCredentialsProvider(CredentialsProvider prov) {
this.provider = prov;
}
private synchronized CredentialsProvider getProvider() {
return provider;
}
/** {@inheritDoc} */
public GitClient subGit(String subdir) {
return new JGitAPIImpl(new File(workspace, subdir), listener);
}
/** {@inheritDoc} */
public void setAuthor(String name, String email) throws GitException {
author = new PersonIdent(name,email);
}
/** {@inheritDoc} */
public void setCommitter(String name, String email) throws GitException {
committer = new PersonIdent(name,email);
}
/**
* init.
*
* @throws hudson.plugins.git.GitException if underlying git operation fails.
* @throws java.lang.InterruptedException if interrupted.
*/
public void init() throws GitException, InterruptedException {
init_().workspace(workspace.getAbsolutePath()).execute();
}
private void doInit(String workspace, boolean bare) throws GitException {
try {
Git.init().setBare(bare).setDirectory(new File(workspace)).call();
} catch (GitAPIException e) {
throw new GitException(e);
}
}
/**
* checkout.
*
* @return a {@link org.jenkinsci.plugins.gitclient.CheckoutCommand} object.
*/
public CheckoutCommand checkout() {
return new CheckoutCommand() {
public String ref;
public String branch;
public boolean deleteBranch;
public List<String> sparseCheckoutPaths = Collections.emptyList();
public CheckoutCommand ref(String ref) {
this.ref = ref;
return this;
}
public CheckoutCommand branch(String branch) {
this.branch = branch;
return this;
}
public CheckoutCommand deleteBranchIfExist(boolean deleteBranch) {
this.deleteBranch = deleteBranch;
return this;
}
public CheckoutCommand sparseCheckoutPaths(List<String> sparseCheckoutPaths) {
this.sparseCheckoutPaths = sparseCheckoutPaths == null ? Collections.<String>emptyList() : sparseCheckoutPaths;
return this;
}
public CheckoutCommand timeout(Integer timeout) {
// noop in jgit
return this;
}
@Override
public CheckoutCommand lfsRemote(String lfsRemote) {
listener.getLogger().println("[WARNING] JGit doesn't support LFS checkout. This flag is ignored.");
return this;
}
public void execute() throws GitException, InterruptedException {
if(! sparseCheckoutPaths.isEmpty()) {
listener.getLogger().println("[ERROR] JGit doesn't support sparse checkout.");
throw new UnsupportedOperationException("not implemented yet");
}
if (branch == null)
doCheckout(ref);
else if (deleteBranch)
doCheckoutCleanBranch(branch, ref);
else
doCheckout(ref, branch);
}
};
}
private void doCheckout(String ref) throws GitException {
boolean retried = false;
Repository repo = null;
while (true) {
try {
repo = getRepository();
try {
// force in Jgit is "-B" in Git CLI, meaning no forced switch,
// but forces recreation of the branch.
// we need to take back all open changes to get the equivalent
// of git checkout -f
git(repo).reset().setMode(HARD).call();
} catch (GitAPIException e) {
throw new GitException("Could not reset the workspace before checkout of " + ref, e);
} catch (JGitInternalException e) {
if (e.getCause() instanceof LockFailedException){
throw new GitLockFailedException("Could not lock repository. Please try again", e);
} else {
throw e;
}
}
if (repo.resolve(ref) != null) {
// ref is either an existing reference or a shortcut to a tag or branch (without refs/heads/)
git(repo).checkout().setName(ref).setForce(true).call();
return;
}
List<String> remoteTrackingBranches = new ArrayList<>();
for (String remote : repo.getRemoteNames()) {
// look for exactly ONE remote tracking branch
String matchingRemoteBranch = Constants.R_REMOTES + remote + "/" + ref;
if (repo.getRef(matchingRemoteBranch) != null) {
remoteTrackingBranches.add(matchingRemoteBranch);
}
}
if (remoteTrackingBranches.isEmpty()) {
throw new GitException("No matching revision for " + ref + " found.");
}
if (remoteTrackingBranches.size() > 1) {
throw new GitException("Found more than one matching remote tracking branches for " + ref + " : " + remoteTrackingBranches);
}
String matchingRemoteBranch = remoteTrackingBranches.get(0);
listener.getLogger().format("[WARNING] Automatically creating a local branch '%s' tracking remote branch '%s'", ref, removeStart(matchingRemoteBranch, Constants.R_REMOTES));
git(repo).checkout()
.setCreateBranch(true)
.setName(ref)
.setUpstreamMode(SetupUpstreamMode.SET_UPSTREAM)
.setStartPoint(matchingRemoteBranch).call();
return;
} catch (CheckoutConflictException e) {
if (repo != null) {
repo.close(); /* Close and null for immediate reuse */
repo = null;
}
// "git checkout -f" seems to overwrite local untracked files but git CheckoutCommand doesn't.
// see the test case GitAPITestCase.test_localCheckoutConflict. so in this case we manually
// clean up the conflicts and try it again
if (retried)
throw new GitException("Could not checkout " + ref, e);
retried = true;
repo = getRepository(); /* Reusing repo declared and assigned earlier */
for (String path : e.getConflictingPaths()) {
File conflict = new File(repo.getWorkTree(), path);
if (!conflict.delete() && conflict.exists()) {
listener.getLogger().println("[WARNING] conflicting path " + conflict + " not deleted");
}
}
} catch (IOException | GitAPIException e) {
throw new GitException("Could not checkout " + ref, e);
} catch (JGitInternalException e) {
if (Pattern.matches("Cannot lock.+", e.getMessage())){
throw new GitLockFailedException("Could not lock repository. Please try again", e);
} else {
throw e;
}
} finally {
if (repo != null) repo.close();
}
}
}
private void doCheckout(String ref, String branch) throws GitException {
try (Repository repo = getRepository()) {
if (ref == null) ref = repo.resolve(HEAD).name();
git(repo).checkout().setName(branch).setCreateBranch(true).setForce(true).setStartPoint(ref).call();
} catch (IOException | GitAPIException e) {
throw new GitException("Could not checkout " + branch + " with start point " + ref, e);
}
}
private void doCheckoutCleanBranch(String branch, String ref) throws GitException {
try (Repository repo = getRepository()) {
RefUpdate refUpdate = repo.updateRef(R_HEADS + branch);
refUpdate.setNewObjectId(repo.resolve(ref));
switch (refUpdate.forceUpdate()) {
case NOT_ATTEMPTED:
case LOCK_FAILURE:
case REJECTED:
case REJECTED_CURRENT_BRANCH:
case IO_FAILURE:
case RENAMED:
throw new GitException("Could not update " + branch + " to " + ref);
}
doCheckout(branch);
} catch (IOException e) {
throw new GitException("Could not checkout " + branch + " with start point " + ref, e);
}
}
/** {@inheritDoc} */
public void add(String filePattern) throws GitException {
try (Repository repo = getRepository()) {
git(repo).add().addFilepattern(filePattern).call();
} catch (GitAPIException e) {
throw new GitException(e);
}
}
private Git git(Repository repo) {
return Git.wrap(repo);
}
/** {@inheritDoc} */
public void commit(String message) throws GitException {
try (Repository repo = getRepository()) {
CommitCommand cmd = git(repo).commit().setMessage(message);
if (author!=null)
cmd.setAuthor(author);
if (committer!=null)
cmd.setCommitter(new PersonIdent(committer,new Date()));
cmd.call();
} catch (GitAPIException e) {
throw new GitException(e);
}
}
/** {@inheritDoc} */
public void branch(String name) throws GitException {
try (Repository repo = getRepository()) {
git(repo).branchCreate().setName(name).call();
} catch (GitAPIException e) {
throw new GitException(e);
}
}
/** {@inheritDoc} */
public void deleteBranch(String name) throws GitException {
try (Repository repo = getRepository()) {
git(repo).branchDelete().setForce(true).setBranchNames(name).call();
} catch (GitAPIException e) {
throw new GitException(e);
}
}
/**
* getBranches.
*
* @return a {@link java.util.Set} object.
* @throws hudson.plugins.git.GitException if underlying git operation fails.
*/
public Set<Branch> getBranches() throws GitException {
try (Repository repo = getRepository()) {
List<Ref> refs = git(repo).branchList().setListMode(ListBranchCommand.ListMode.ALL).call();
Set<Branch> branches = new HashSet<>(refs.size());
for (Ref ref : refs) {
branches.add(new Branch(ref));
}
return branches;
} catch (GitAPIException e) {
throw new GitException(e);
}
}
/**
* getRemoteBranches.
*
* @return a {@link java.util.Set} object.
* @throws hudson.plugins.git.GitException if underlying git operation fails.
*/
public Set<Branch> getRemoteBranches() throws GitException {
try (Repository repo = getRepository()) {
List<Ref> refs = git(repo).branchList().setListMode(ListBranchCommand.ListMode.REMOTE).call();
Set<Branch> branches = new HashSet<>(refs.size());
for (Ref ref : refs) {
branches.add(new Branch(ref));
}
return branches;
} catch (GitAPIException e) {
throw new GitException(e);
}
}
/** {@inheritDoc} */
public void tag(String name, String message) throws GitException {
try (Repository repo = getRepository()) {
git(repo).tag().setName(name).setMessage(message).setForceUpdate(true).call();
} catch (GitAPIException e) {
throw new GitException(e);
}
}
/** {@inheritDoc} */
public boolean tagExists(String tagName) throws GitException {
try (Repository repo = getRepository()) {
Ref tag = repo.getRefDatabase().getRef(R_TAGS + tagName);
return tag != null;
} catch (IOException e) {
throw new GitException(e);
}
}
/**
* fetch_.
*
* @return a {@link org.jenkinsci.plugins.gitclient.FetchCommand} object.
*/
public org.jenkinsci.plugins.gitclient.FetchCommand fetch_() {
return new org.jenkinsci.plugins.gitclient.FetchCommand() {
public URIish url;
public List<RefSpec> refspecs;
// JGit 3.3.0 thru 3.6.0 prune more branches than expected
// Refer to GitAPITestCase.test_fetch_with_prune()
private boolean shouldPrune = false;
public boolean tags = true;
public org.jenkinsci.plugins.gitclient.FetchCommand from(URIish remote, List<RefSpec> refspecs) {
this.url = remote;
this.refspecs = refspecs;
return this;
}
public org.jenkinsci.plugins.gitclient.FetchCommand prune() {
shouldPrune = true;
return this;
}
public org.jenkinsci.plugins.gitclient.FetchCommand shallow(boolean shallow) {
if (shallow) {
listener.getLogger().println("[WARNING] JGit doesn't support shallow clone. This flag is ignored");
}
return this;
}
public org.jenkinsci.plugins.gitclient.FetchCommand timeout(Integer timeout) {
// noop in jgit
return this;
}
public org.jenkinsci.plugins.gitclient.FetchCommand tags(boolean tags) {
this.tags = tags;
return this;
}
public org.jenkinsci.plugins.gitclient.FetchCommand depth(Integer depth) {
listener.getLogger().println("[WARNING] JGit doesn't support shallow clone and therefore depth is meaningless. This flag is ignored");
return this;
}
public void execute() throws GitException, InterruptedException {
try (Repository repo = getRepository()) {
Git git = git(repo);
List<RefSpec> refSpecs = new ArrayList<>();
if (tags) {
// see http://stackoverflow.com/questions/14876321/jgit-fetch-dont-update-tag
refSpecs.add(new RefSpec("+refs/tags/*:refs/tags/*"));
}
if (refspecs != null)
for (RefSpec rs: refspecs)
if (rs != null)
refSpecs.add(rs);
if (shouldPrune) {
// since prune is broken in JGit, we go the trivial way:
// delete all refs matching the right side of the refspecs
// then fetch and let the git recreate them.
List<Ref> refs = git.branchList().setListMode(ListBranchCommand.ListMode.REMOTE).call();
List<String> toDelete = new ArrayList<>(refs.size());
for (ListIterator<Ref> it = refs.listIterator(); it.hasNext(); ) {
Ref branchRef = it.next();
if (!branchRef.isSymbolic()) { // Don't delete HEAD and other symbolic refs
for (RefSpec rs : refSpecs) {
if (rs.matchDestination(branchRef)) {
toDelete.add(branchRef.getName());
break;
}
}
}
}
if (!toDelete.isEmpty()) {
// we need force = true because usually not all remote branches will be merged into the current branch.
git.branchDelete().setForce(true).setBranchNames(toDelete.toArray(new String[toDelete.size()])).call();
}
}
FetchCommand fetch = git.fetch();
fetch.setTagOpt(tags ? TagOpt.FETCH_TAGS : TagOpt.NO_TAGS);
fetch.setRemote(url.toString());
fetch.setCredentialsProvider(getProvider());
fetch.setRefSpecs(refSpecs);
// fetch.setRemoveDeletedRefs(shouldPrune);
fetch.call();
} catch (GitAPIException e) {
throw new GitException(e);
}
}
};
}
/**
* {@inheritDoc}
*
* @param url a {@link org.eclipse.jgit.transport.URIish} object.
* @param refspecs a {@link java.util.List} object.
* @throws hudson.plugins.git.GitException if any.
* @throws java.lang.InterruptedException if any.
*/
public void fetch(URIish url, List<RefSpec> refspecs) throws GitException, InterruptedException {
fetch_().from(url, refspecs).execute();
}
/** {@inheritDoc} */
public void fetch(String remoteName, RefSpec... refspec) throws GitException {
try (Repository repo = getRepository()) {
FetchCommand fetch = git(repo).fetch().setTagOpt(TagOpt.FETCH_TAGS);
if (remoteName != null) fetch.setRemote(remoteName);
fetch.setCredentialsProvider(getProvider());
// see http://stackoverflow.com/questions/14876321/jgit-fetch-dont-update-tag
List<RefSpec> refSpecs = new ArrayList<>();
refSpecs.add(new RefSpec("+refs/tags/*:refs/tags/*"));
if (refspec != null && refspec.length > 0)
for (RefSpec rs: refspec)
if (rs != null)
refSpecs.add(rs);
fetch.setRefSpecs(refSpecs);
fetch.call();
} catch (GitAPIException e) {
throw new GitException(e);
}
}
/** {@inheritDoc} */
public void fetch(String remoteName, RefSpec refspec) throws GitException {
fetch(remoteName, new RefSpec[] {refspec});
}
/** {@inheritDoc} */
public void ref(String refName) throws GitException, InterruptedException {
refName = refName.replace(' ', '_');
try (Repository repo = getRepository()) {
RefUpdate refUpdate = repo.updateRef(refName);
refUpdate.setNewObjectId(repo.getRef(Constants.HEAD).getObjectId());
switch (refUpdate.forceUpdate()) {
case NOT_ATTEMPTED:
case LOCK_FAILURE:
case REJECTED:
case REJECTED_CURRENT_BRANCH:
case IO_FAILURE:
case RENAMED:
throw new GitException("Could not update " + refName + " to HEAD");
}
} catch (IOException e) {
throw new GitException("Could not update " + refName + " to HEAD", e);
}
}
/** {@inheritDoc} */
public boolean refExists(String refName) throws GitException, InterruptedException {
refName = refName.replace(' ', '_');
try (Repository repo = getRepository()) {
Ref ref = repo.getRefDatabase().getRef(refName);
return ref != null;
} catch (IOException e) {
throw new GitException("Error checking ref " + refName, e);
}
}
/** {@inheritDoc} */
public void deleteRef(String refName) throws GitException, InterruptedException {
refName = refName.replace(' ', '_');
try (Repository repo = getRepository()) {
RefUpdate refUpdate = repo.updateRef(refName);
// Required, even though this is a forced delete.
refUpdate.setNewObjectId(repo.getRef(Constants.HEAD).getObjectId());
refUpdate.setForceUpdate(true);
switch (refUpdate.delete()) {
case NOT_ATTEMPTED:
case LOCK_FAILURE:
case REJECTED:
case REJECTED_CURRENT_BRANCH:
case IO_FAILURE:
case RENAMED:
throw new GitException("Could not delete " + refName);
}
} catch (IOException e) {
throw new GitException("Could not delete " + refName, e);
}
}
/** {@inheritDoc} */
public Set<String> getRefNames(String refPrefix) throws GitException, InterruptedException {
if (refPrefix.isEmpty()) {
refPrefix = RefDatabase.ALL;
} else {
refPrefix = refPrefix.replace(' ', '_');
}
try (Repository repo = getRepository()) {
Map<String, Ref> refList = repo.getRefDatabase().getRefs(refPrefix);
// The key set for refList will have refPrefix removed, so to recover it we just grab the full name.
Set<String> refs = new HashSet<>(refList.size());
for (Ref ref : refList.values()) {
refs.add(ref.getName());
}
return refs;
} catch (IOException e) {
throw new GitException("Error retrieving refs with prefix " + refPrefix, e);
}
}
/** {@inheritDoc} */
public Map<String, ObjectId> getHeadRev(String url) throws GitException, InterruptedException {
Map<String, ObjectId> heads = new HashMap<>();
try (Repository repo = openDummyRepository();
final Transport tn = Transport.open(repo, new URIish(url))) {
tn.setCredentialsProvider(getProvider());
try (FetchConnection c = tn.openFetch()) {
for (final Ref r : c.getRefs()) {
heads.put(r.getName(), r.getPeeledObjectId() != null ? r.getPeeledObjectId() : r.getObjectId());
}
}
} catch (IOException | URISyntaxException e) {
throw new GitException(e);
}
return heads;
}
/** {@inheritDoc} */
public Map<String, ObjectId> getRemoteReferences(String url, String pattern, boolean headsOnly, boolean tagsOnly)
throws GitException, InterruptedException {
Map<String, ObjectId> references = new HashMap<>();
String regexPattern = null;
if (pattern != null) {
regexPattern = createRefRegexFromGlob(pattern);
}
try (Repository repo = openDummyRepository()) {
LsRemoteCommand lsRemote = new LsRemoteCommand(repo);
if (headsOnly) {
lsRemote.setHeads(headsOnly);
}
if (tagsOnly) {
lsRemote.setTags(tagsOnly);
}
lsRemote.setRemote(url);
lsRemote.setCredentialsProvider(getProvider());
Collection<Ref> refs = lsRemote.call();
for (final Ref r : refs) {
final String refName = r.getName();
final ObjectId refObjectId =
r.getPeeledObjectId() != null ? r.getPeeledObjectId() : r.getObjectId();
if (regexPattern != null) {
if (refName.matches(regexPattern)) {
references.put(refName, refObjectId);
}
} else {
references.put(refName, refObjectId);
}
}
} catch (GitAPIException | IOException e) {
throw new GitException(e);
}
return references;
}
@Override
public Map<String, String> getRemoteSymbolicReferences(String url, String pattern)
throws GitException, InterruptedException {
Map<String, String> references = new HashMap<>();
String regexPattern = null;
if (pattern != null) {
regexPattern = createRefRegexFromGlob(pattern);
}
// HACK ALERT... JGit doesn't give the info we require hard-coding HEAD symref support only based on pre 1.8.5
// behaviour of the git command line - whereby it would just look for the branch with the same ref as HEAD
// and if there are multiple matches and one of them is master then we can assume master... otherwise
// throw our hands up and say "no clue"
if (regexPattern != null && !Constants.HEAD.matches(regexPattern)) {
return references;
}
try (Repository repo = openDummyRepository()) {
try {
// HACK HACK HACK
// The symref info is advertised as a capability starting from git 1.8.5
// So all we need to do is ask JGit to fetch the refs and then (because JGit adds all capabilities
// into a Set) we iterate the resulting set to find any that matching symref=$symref:$realref
// of course JGit does not expose a way to iterate the capabilities, so instead we have to hack
// and peek inside
// TODO if JGit implement https://bugs.eclipse.org/bugs/show_bug.cgi?id=514052 we should switch to that
Class<?> basePackConnection = BasePackFetchConnection.class.getSuperclass();
Field remoteCapablities = basePackConnection.getDeclaredField("remoteCapablities");
remoteCapablities.setAccessible(true);
try (Transport transport = Transport.open(repo, url)) {
transport.setCredentialsProvider(getProvider());
try (FetchConnection fc = transport.openFetch()) {
fc.getRefs();
if (fc instanceof BasePackFetchConnection) {
Object o = remoteCapablities.get(fc);
if (o instanceof Set) {
boolean hackWorked = false;
for (String capability: (Set<String>)o) {
if (capability.startsWith("symref=")) {
hackWorked = true;
int index = capability.indexOf(":", 7);
if (index != -1) {
references.put(capability.substring(7, index), capability.substring(index+1));
}
}
}
if (hackWorked) {
return references;
}
}
}
}
// ignore this is a total hack
}
} catch (IllegalAccessException | NoSuchFieldException e) {
// ignore, caller will just have to try it the Git 1.8.4 way, we'll return an empty map
}
} catch (IOException | URISyntaxException e) {
throw new GitException(e);
}
return references;
}
/* Adapted from http://stackoverflow.com/questions/1247772/is-there-an-equivalent-of-java-util-regex-for-glob-type-patterns */
private String createRefRegexFromGlob(String glob)
{
StringBuilder out = new StringBuilder();
if(glob.startsWith("refs/")) {
out.append("^");
} else {
out.append("^.*/");
}
for (int i = 0; i < glob.length(); ++i) {
final char c = glob.charAt(i);
switch(c) {
case '*':
out.append(".*");
break;
case '?':
out.append('.');
break;
case '.':
out.append("\\.");
break;
case '\\':
out.append("\\\\");
break;
default:
out.append(c);
break;
}
}
out.append('$');
return out.toString();
}
/** {@inheritDoc} */
public ObjectId getHeadRev(String remoteRepoUrl, String branchSpec) throws GitException {
try (Repository repo = openDummyRepository();
final Transport tn = Transport.open(repo, new URIish(remoteRepoUrl))) {
final String branchName = extractBranchNameFromBranchSpec(branchSpec);
String regexBranch = createRefRegexFromGlob(branchName);
tn.setCredentialsProvider(getProvider());
try (FetchConnection c = tn.openFetch()) {
for (final Ref r : c.getRefs()) {
if (r.getName().matches(regexBranch)) {
return r.getPeeledObjectId() != null ? r.getPeeledObjectId() : r.getObjectId();
}
}
}
} catch (IOException | URISyntaxException | IllegalStateException e) {
throw new GitException(e);
}
return null;
}
/**
* Creates a empty dummy {@link Repository} to keep JGit happy where it wants a valid {@link Repository} operation
* for remote objects.
*/
private Repository openDummyRepository() throws IOException {
final File tempDir = Util.createTempDir();
return new FileRepository(tempDir) {
@Override
public void close() {
super.close();
try {
Util.deleteRecursive(tempDir);
} catch (IOException e) {
// ignore
}
}
};
}
/** {@inheritDoc} */
public String getRemoteUrl(String name) throws GitException {
try (Repository repo = getRepository()) {
return repo.getConfig().getString("remote",name,"url");
}
}
/**
* getRepository.
*
* @return a {@link org.eclipse.jgit.lib.Repository} object.
* @throws hudson.plugins.git.GitException if underlying git operation fails.
*/
@NonNull
public Repository getRepository() throws GitException {
try {
return new RepositoryBuilder().setWorkTree(workspace).build();
} catch (IOException e) {
throw new GitException(e);
}
}
/**
* getWorkTree.
*
* @return a {@link hudson.FilePath} object.
*/
public FilePath getWorkTree() {
return new FilePath(workspace);
}
/** {@inheritDoc} */
public void setRemoteUrl(String name, String url) throws GitException {
try (Repository repo = getRepository()) {
StoredConfig config = repo.getConfig();
config.setString("remote", name, "url", url);
config.save();
} catch (IOException e) {
throw new GitException(e);
}
}
/** {@inheritDoc} */
public void addRemoteUrl(String name, String url) throws GitException, InterruptedException {
try (Repository repo = getRepository()) {
StoredConfig config = repo.getConfig();
List<String> urls = new ArrayList<>();
urls.addAll(Arrays.asList(config.getStringList("remote", name, "url")));
urls.add(url);
config.setStringList("remote", name, "url", urls);
config.save();
} catch (IOException e) {
throw new GitException(e);
}
}
/** {@inheritDoc} */
public void addNote(String note, String namespace) throws GitException {
try (Repository repo = getRepository()) {
ObjectId head = repo.resolve(HEAD); // commit to put a note on
AddNoteCommand cmd = git(repo).notesAdd();
cmd.setMessage(normalizeNote(note));
cmd.setNotesRef(qualifyNotesNamespace(namespace));
try (ObjectReader or = repo.newObjectReader();
RevWalk walk = new RevWalk(or)) {
cmd.setObjectId(walk.parseAny(head));
cmd.call();
}
} catch (GitAPIException | IOException e) {
throw new GitException(e);