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
|
/*
* Copyright (C) 2008, Charles O'Farrell <charleso@charleso.org>
* Copyright (C) 2009-2010, Google Inc.
* Copyright (C) 2009, Robin Rosenberg <robin.rosenberg@dewire.com>
* Copyright (C) 2008, Shawn O. Pearce <spearce@spearce.org> and others
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Distribution License v. 1.0 which is available at
* https://www.eclipse.org/org/documents/edl-v10.php.
*
* SPDX-License-Identifier: BSD-3-Clause
*/
package org.eclipse.jgit.lib;
import java.io.IOException;
import java.io.StringWriter;
import java.util.Collection;
import java.util.Map;
import org.eclipse.jgit.internal.storage.file.RefDirectory;
import org.eclipse.jgit.util.RefList;
import org.eclipse.jgit.util.RefMap;
/**
* Writes out refs to the {@link org.eclipse.jgit.lib.Constants#INFO_REFS} and
* {@link org.eclipse.jgit.lib.Constants#PACKED_REFS} files.
*
* This class is abstract as the writing of the files must be handled by the
* caller. This is because it is used by transport classes as well.
*/
public abstract class RefWriter {
private final Collection<Ref> refs;
/**
* <p>Constructor for RefWriter.</p>
*
* @param refs
* the complete set of references. This should have been computed
* by applying updates to the advertised refs already discovered.
*/
public RefWriter(Collection<Ref> refs) {
this.refs = RefComparator.sort(refs);
}
/**
* <p>Constructor for RefWriter.</p>
*
* @param refs
* the complete set of references. This should have been computed
* by applying updates to the advertised refs already discovered.
*/
public RefWriter(Map<String, Ref> refs) {
if (refs instanceof RefMap)
this.refs = refs.values();
else
this.refs = RefComparator.sort(refs.values());
}
/**
* <p>Constructor for RefWriter.</p>
*
* @param refs
* the complete set of references. This should have been computed
* by applying updates to the advertised refs already discovered.
*/
public RefWriter(RefList<Ref> refs) {
this.refs = refs.asList();
}
/**
* Rebuild the {@link org.eclipse.jgit.lib.Constants#INFO_REFS}.
* <p>
* This method rebuilds the contents of the
* {@link org.eclipse.jgit.lib.Constants#INFO_REFS} file to match the passed
* list of references.
*
* @throws java.io.IOException
* writing is not supported, or attempting to write the file
* failed, possibly due to permissions or remote disk full, etc.
*/
public void writeInfoRefs() throws IOException {
final StringWriter w = new StringWriter();
final char[] tmp = new char[Constants.OBJECT_ID_STRING_LENGTH];
for (Ref r : refs) {
if (Constants.HEAD.equals(r.getName())) {
// Historically HEAD has never been published through
// the INFO_REFS file. This is a mistake, but its the
// way things are.
//
continue;
}
ObjectId objectId = r.getObjectId();
if (objectId == null) {
// Symrefs to unborn branches aren't advertised in the info/refs
// file.
continue;
}
objectId.copyTo(tmp, w);
w.write('\t');
w.write(r.getName());
w.write('\n');
ObjectId peeledObjectId = r.getPeeledObjectId();
if (peeledObjectId != null) {
peeledObjectId.copyTo(tmp, w);
w.write('\t');
w.write(r.getName());
w.write("^{}\n"); //$NON-NLS-1$
}
}
writeFile(Constants.INFO_REFS, Constants.encode(w.toString()));
}
/**
* Rebuild the {@link org.eclipse.jgit.lib.Constants#PACKED_REFS} file.
* <p>
* This method rebuilds the contents of the
* {@link org.eclipse.jgit.lib.Constants#PACKED_REFS} file to match the
* passed list of references, including only those refs that have a storage
* type of {@link org.eclipse.jgit.lib.Ref.Storage#PACKED}.
*
* @throws java.io.IOException
* writing is not supported, or attempting to write the file
* failed, possibly due to permissions or remote disk full, etc.
*/
public void writePackedRefs() throws IOException {
boolean peeled = false;
for (Ref r : refs) {
if (r.getStorage().isPacked() && r.isPeeled()) {
peeled = true;
break;
}
}
final StringWriter w = new StringWriter();
if (peeled) {
w.write(RefDirectory.PACKED_REFS_HEADER);
if (peeled)
w.write(RefDirectory.PACKED_REFS_PEELED);
w.write('\n');
}
final char[] tmp = new char[Constants.OBJECT_ID_STRING_LENGTH];
for (Ref r : refs) {
if (r.getStorage() != Ref.Storage.PACKED)
continue;
ObjectId objectId = r.getObjectId();
if (objectId == null) {
// A packed ref cannot be a symref, let alone a symref
// to an unborn branch.
throw new NullPointerException();
}
objectId.copyTo(tmp, w);
w.write(' ');
w.write(r.getName());
w.write('\n');
ObjectId peeledObjectId = r.getPeeledObjectId();
if (peeledObjectId != null) {
w.write('^');
peeledObjectId.copyTo(tmp, w);
w.write('\n');
}
}
writeFile(Constants.PACKED_REFS, Constants.encode(w.toString()));
}
/**
* Handles actual writing of ref files to the git repository, which may
* differ slightly depending on the destination and transport.
*
* @param file
* path to ref file.
* @param content
* byte content of file to be written.
* @throws java.io.IOException
*/
protected abstract void writeFile(String file, byte[] content)
throws IOException;
}
|
