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