]>
Commit | Line | Data |
---|---|---|
1 | #ifndef TRANSPORT_H | |
2 | #define TRANSPORT_H | |
3 | ||
4 | #include "cache.h" | |
5 | #include "run-command.h" | |
6 | #include "remote.h" | |
7 | ||
8 | struct git_transport_options { | |
9 | unsigned thin : 1; | |
10 | unsigned keep : 1; | |
11 | unsigned followtags : 1; | |
12 | unsigned check_self_contained_and_connected : 1; | |
13 | unsigned self_contained_and_connected : 1; | |
14 | unsigned update_shallow : 1; | |
15 | int depth; | |
16 | const char *uploadpack; | |
17 | const char *receivepack; | |
18 | struct push_cas_option *cas; | |
19 | }; | |
20 | ||
21 | enum transport_family { | |
22 | TRANSPORT_FAMILY_ALL = 0, | |
23 | TRANSPORT_FAMILY_IPV4, | |
24 | TRANSPORT_FAMILY_IPV6 | |
25 | }; | |
26 | ||
27 | struct transport { | |
28 | struct remote *remote; | |
29 | const char *url; | |
30 | void *data; | |
31 | const struct ref *remote_refs; | |
32 | ||
33 | /** | |
34 | * Indicates whether we already called get_refs_list(); set by | |
35 | * transport.c::transport_get_remote_refs(). | |
36 | */ | |
37 | unsigned got_remote_refs : 1; | |
38 | ||
39 | /* | |
40 | * Transports that call take-over destroys the data specific to | |
41 | * the transport type while doing so, and cannot be reused. | |
42 | */ | |
43 | unsigned cannot_reuse : 1; | |
44 | ||
45 | /* | |
46 | * A hint from caller that it will be performing a clone, not | |
47 | * normal fetch. IOW the repository is guaranteed empty. | |
48 | */ | |
49 | unsigned cloning : 1; | |
50 | ||
51 | /** | |
52 | * Returns 0 if successful, positive if the option is not | |
53 | * recognized or is inapplicable, and negative if the option | |
54 | * is applicable but the value is invalid. | |
55 | **/ | |
56 | int (*set_option)(struct transport *connection, const char *name, | |
57 | const char *value); | |
58 | ||
59 | /** | |
60 | * Returns a list of the remote side's refs. In order to allow | |
61 | * the transport to try to share connections, for_push is a | |
62 | * hint as to whether the ultimate operation is a push or a fetch. | |
63 | * | |
64 | * If the transport is able to determine the remote hash for | |
65 | * the ref without a huge amount of effort, it should store it | |
66 | * in the ref's old_sha1 field; otherwise it should be all 0. | |
67 | **/ | |
68 | struct ref *(*get_refs_list)(struct transport *transport, int for_push); | |
69 | ||
70 | /** | |
71 | * Fetch the objects for the given refs. Note that this gets | |
72 | * an array, and should ignore the list structure. | |
73 | * | |
74 | * If the transport did not get hashes for refs in | |
75 | * get_refs_list(), it should set the old_sha1 fields in the | |
76 | * provided refs now. | |
77 | **/ | |
78 | int (*fetch)(struct transport *transport, int refs_nr, struct ref **refs); | |
79 | ||
80 | /** | |
81 | * Push the objects and refs. Send the necessary objects, and | |
82 | * then, for any refs where peer_ref is set and | |
83 | * peer_ref->new_oid is different from old_oid, tell the | |
84 | * remote side to update each ref in the list from old_oid to | |
85 | * peer_ref->new_oid. | |
86 | * | |
87 | * Where possible, set the status for each ref appropriately. | |
88 | * | |
89 | * The transport must modify new_sha1 in the ref to the new | |
90 | * value if the remote accepted the change. Note that this | |
91 | * could be a different value from peer_ref->new_oid if the | |
92 | * process involved generating new commits. | |
93 | **/ | |
94 | int (*push_refs)(struct transport *transport, struct ref *refs, int flags); | |
95 | int (*push)(struct transport *connection, int refspec_nr, const char **refspec, int flags); | |
96 | int (*connect)(struct transport *connection, const char *name, | |
97 | const char *executable, int fd[2]); | |
98 | ||
99 | /** get_refs_list(), fetch(), and push_refs() can keep | |
100 | * resources (such as a connection) reserved for further | |
101 | * use. disconnect() releases these resources. | |
102 | **/ | |
103 | int (*disconnect)(struct transport *connection); | |
104 | char *pack_lockfile; | |
105 | signed verbose : 3; | |
106 | /** | |
107 | * Transports should not set this directly, and should use this | |
108 | * value without having to check isatty(2), -q/--quiet | |
109 | * (transport->verbose < 0), etc. - checking has already been done | |
110 | * in transport_set_verbosity(). | |
111 | **/ | |
112 | unsigned progress : 1; | |
113 | /* | |
114 | * If transport is at least potentially smart, this points to | |
115 | * git_transport_options structure to use in case transport | |
116 | * actually turns out to be smart. | |
117 | */ | |
118 | struct git_transport_options *smart_options; | |
119 | ||
120 | enum transport_family family; | |
121 | }; | |
122 | ||
123 | #define TRANSPORT_PUSH_ALL 1 | |
124 | #define TRANSPORT_PUSH_FORCE 2 | |
125 | #define TRANSPORT_PUSH_DRY_RUN 4 | |
126 | #define TRANSPORT_PUSH_MIRROR 8 | |
127 | #define TRANSPORT_PUSH_PORCELAIN 16 | |
128 | #define TRANSPORT_PUSH_SET_UPSTREAM 32 | |
129 | #define TRANSPORT_RECURSE_SUBMODULES_CHECK 64 | |
130 | #define TRANSPORT_PUSH_PRUNE 128 | |
131 | #define TRANSPORT_RECURSE_SUBMODULES_ON_DEMAND 256 | |
132 | #define TRANSPORT_PUSH_NO_HOOK 512 | |
133 | #define TRANSPORT_PUSH_FOLLOW_TAGS 1024 | |
134 | #define TRANSPORT_PUSH_CERT_ALWAYS 2048 | |
135 | #define TRANSPORT_PUSH_CERT_IF_ASKED 4096 | |
136 | #define TRANSPORT_PUSH_ATOMIC 8192 | |
137 | ||
138 | #define TRANSPORT_SUMMARY_WIDTH (2 * DEFAULT_ABBREV + 3) | |
139 | #define TRANSPORT_SUMMARY(x) (int)(TRANSPORT_SUMMARY_WIDTH + strlen(x) - gettext_width(x)), (x) | |
140 | ||
141 | /* Returns a transport suitable for the url */ | |
142 | struct transport *transport_get(struct remote *, const char *); | |
143 | ||
144 | /* | |
145 | * Check whether a transport is allowed by the environment. Type should | |
146 | * generally be the URL scheme, as described in Documentation/git.txt | |
147 | */ | |
148 | int is_transport_allowed(const char *type); | |
149 | ||
150 | /* | |
151 | * Check whether a transport is allowed by the environment, | |
152 | * and die otherwise. | |
153 | */ | |
154 | void transport_check_allowed(const char *type); | |
155 | ||
156 | /* | |
157 | * Returns true if the user has attempted to turn on protocol | |
158 | * restrictions at all. | |
159 | */ | |
160 | int transport_restrict_protocols(void); | |
161 | ||
162 | /* Transport options which apply to git:// and scp-style URLs */ | |
163 | ||
164 | /* The program to use on the remote side to send a pack */ | |
165 | #define TRANS_OPT_UPLOADPACK "uploadpack" | |
166 | ||
167 | /* The program to use on the remote side to receive a pack */ | |
168 | #define TRANS_OPT_RECEIVEPACK "receivepack" | |
169 | ||
170 | /* Transfer the data as a thin pack if not null */ | |
171 | #define TRANS_OPT_THIN "thin" | |
172 | ||
173 | /* Check the current value of the remote ref */ | |
174 | #define TRANS_OPT_CAS "cas" | |
175 | ||
176 | /* Keep the pack that was transferred if not null */ | |
177 | #define TRANS_OPT_KEEP "keep" | |
178 | ||
179 | /* Limit the depth of the fetch if not null */ | |
180 | #define TRANS_OPT_DEPTH "depth" | |
181 | ||
182 | /* Aggressively fetch annotated tags if possible */ | |
183 | #define TRANS_OPT_FOLLOWTAGS "followtags" | |
184 | ||
185 | /* Accept refs that may update .git/shallow without --depth */ | |
186 | #define TRANS_OPT_UPDATE_SHALLOW "updateshallow" | |
187 | ||
188 | /* Send push certificates */ | |
189 | #define TRANS_OPT_PUSH_CERT "pushcert" | |
190 | ||
191 | /** | |
192 | * Returns 0 if the option was used, non-zero otherwise. Prints a | |
193 | * message to stderr if the option is not used. | |
194 | **/ | |
195 | int transport_set_option(struct transport *transport, const char *name, | |
196 | const char *value); | |
197 | void transport_set_verbosity(struct transport *transport, int verbosity, | |
198 | int force_progress); | |
199 | ||
200 | #define REJECT_NON_FF_HEAD 0x01 | |
201 | #define REJECT_NON_FF_OTHER 0x02 | |
202 | #define REJECT_ALREADY_EXISTS 0x04 | |
203 | #define REJECT_FETCH_FIRST 0x08 | |
204 | #define REJECT_NEEDS_FORCE 0x10 | |
205 | ||
206 | int transport_push(struct transport *connection, | |
207 | int refspec_nr, const char **refspec, int flags, | |
208 | unsigned int * reject_reasons); | |
209 | ||
210 | const struct ref *transport_get_remote_refs(struct transport *transport); | |
211 | ||
212 | int transport_fetch_refs(struct transport *transport, struct ref *refs); | |
213 | void transport_unlock_pack(struct transport *transport); | |
214 | int transport_disconnect(struct transport *transport); | |
215 | char *transport_anonymize_url(const char *url); | |
216 | void transport_take_over(struct transport *transport, | |
217 | struct child_process *child); | |
218 | ||
219 | int transport_connect(struct transport *transport, const char *name, | |
220 | const char *exec, int fd[2]); | |
221 | ||
222 | /* Transport methods defined outside transport.c */ | |
223 | int transport_helper_init(struct transport *transport, const char *name); | |
224 | int bidirectional_transfer_loop(int input, int output); | |
225 | ||
226 | /* common methods used by transport.c and builtin/send-pack.c */ | |
227 | void transport_verify_remote_names(int nr_heads, const char **heads); | |
228 | ||
229 | void transport_update_tracking_ref(struct remote *remote, struct ref *ref, int verbose); | |
230 | ||
231 | int transport_refs_pushed(struct ref *ref); | |
232 | ||
233 | void transport_print_push_status(const char *dest, struct ref *refs, | |
234 | int verbose, int porcelain, unsigned int *reject_reasons); | |
235 | ||
236 | typedef void alternate_ref_fn(const struct ref *, void *); | |
237 | extern void for_each_alternate_ref(alternate_ref_fn, void *); | |
238 | #endif |