5 #include "run-command.h"
10 struct git_transport_options
{
13 unsigned followtags
: 1;
14 unsigned check_self_contained_and_connected
: 1;
15 unsigned self_contained_and_connected
: 1;
16 unsigned update_shallow
: 1;
17 unsigned deepen_relative
: 1;
18 unsigned from_promisor
: 1;
19 unsigned no_dependents
: 1;
21 const char *deepen_since
;
22 const struct string_list
*deepen_not
;
23 const char *uploadpack
;
24 const char *receivepack
;
25 struct push_cas_option
*cas
;
28 enum transport_family
{
29 TRANSPORT_FAMILY_ALL
= 0,
30 TRANSPORT_FAMILY_IPV4
,
35 struct remote
*remote
;
38 const struct ref
*remote_refs
;
41 * Indicates whether we already called get_refs_list(); set by
42 * transport.c::transport_get_remote_refs().
44 unsigned got_remote_refs
: 1;
47 * Transports that call take-over destroys the data specific to
48 * the transport type while doing so, and cannot be reused.
50 unsigned cannot_reuse
: 1;
53 * A hint from caller that it will be performing a clone, not
54 * normal fetch. IOW the repository is guaranteed empty.
59 * These strings will be passed to the {pre, post}-receive hook,
60 * on the remote side, if both sides support the push options capability.
62 const struct string_list
*push_options
;
65 * Returns 0 if successful, positive if the option is not
66 * recognized or is inapplicable, and negative if the option
67 * is applicable but the value is invalid.
69 int (*set_option
)(struct transport
*connection
, const char *name
,
73 * Returns a list of the remote side's refs. In order to allow
74 * the transport to try to share connections, for_push is a
75 * hint as to whether the ultimate operation is a push or a fetch.
77 * If the transport is able to determine the remote hash for
78 * the ref without a huge amount of effort, it should store it
79 * in the ref's old_sha1 field; otherwise it should be all 0.
81 struct ref
*(*get_refs_list
)(struct transport
*transport
, int for_push
);
84 * Fetch the objects for the given refs. Note that this gets
85 * an array, and should ignore the list structure.
87 * If the transport did not get hashes for refs in
88 * get_refs_list(), it should set the old_sha1 fields in the
91 int (*fetch
)(struct transport
*transport
, int refs_nr
, struct ref
**refs
);
94 * Push the objects and refs. Send the necessary objects, and
95 * then, for any refs where peer_ref is set and
96 * peer_ref->new_oid is different from old_oid, tell the
97 * remote side to update each ref in the list from old_oid to
100 * Where possible, set the status for each ref appropriately.
102 * The transport must modify new_sha1 in the ref to the new
103 * value if the remote accepted the change. Note that this
104 * could be a different value from peer_ref->new_oid if the
105 * process involved generating new commits.
107 int (*push_refs
)(struct transport
*transport
, struct ref
*refs
, int flags
);
108 int (*push
)(struct transport
*connection
, int refspec_nr
, const char **refspec
, int flags
);
109 int (*connect
)(struct transport
*connection
, const char *name
,
110 const char *executable
, int fd
[2]);
112 /** get_refs_list(), fetch(), and push_refs() can keep
113 * resources (such as a connection) reserved for further
114 * use. disconnect() releases these resources.
116 int (*disconnect
)(struct transport
*connection
);
120 * Transports should not set this directly, and should use this
121 * value without having to check isatty(2), -q/--quiet
122 * (transport->verbose < 0), etc. - checking has already been done
123 * in transport_set_verbosity().
125 unsigned progress
: 1;
127 * If transport is at least potentially smart, this points to
128 * git_transport_options structure to use in case transport
129 * actually turns out to be smart.
131 struct git_transport_options
*smart_options
;
133 enum transport_family family
;
136 #define TRANSPORT_PUSH_ALL (1<<0)
137 #define TRANSPORT_PUSH_FORCE (1<<1)
138 #define TRANSPORT_PUSH_DRY_RUN (1<<2)
139 #define TRANSPORT_PUSH_MIRROR (1<<3)
140 #define TRANSPORT_PUSH_PORCELAIN (1<<4)
141 #define TRANSPORT_PUSH_SET_UPSTREAM (1<<5)
142 #define TRANSPORT_RECURSE_SUBMODULES_CHECK (1<<6)
143 #define TRANSPORT_PUSH_PRUNE (1<<7)
144 #define TRANSPORT_RECURSE_SUBMODULES_ON_DEMAND (1<<8)
145 #define TRANSPORT_PUSH_NO_HOOK (1<<9)
146 #define TRANSPORT_PUSH_FOLLOW_TAGS (1<<10)
147 #define TRANSPORT_PUSH_CERT_ALWAYS (1<<11)
148 #define TRANSPORT_PUSH_CERT_IF_ASKED (1<<12)
149 #define TRANSPORT_PUSH_ATOMIC (1<<13)
150 #define TRANSPORT_PUSH_OPTIONS (1<<14)
151 #define TRANSPORT_RECURSE_SUBMODULES_ONLY (1<<15)
153 extern int transport_summary_width(const struct ref
*refs
);
155 /* Returns a transport suitable for the url */
156 struct transport
*transport_get(struct remote
*, const char *);
159 * Check whether a transport is allowed by the environment.
161 * Type should generally be the URL scheme, as described in
162 * Documentation/git.txt
164 * from_user specifies if the transport was given by the user. If unknown pass
165 * a -1 to read from the environment to determine if the transport was given by
169 int is_transport_allowed(const char *type
, int from_user
);
172 * Check whether a transport is allowed by the environment,
175 void transport_check_allowed(const char *type
);
177 /* Transport options which apply to git:// and scp-style URLs */
179 /* The program to use on the remote side to send a pack */
180 #define TRANS_OPT_UPLOADPACK "uploadpack"
182 /* The program to use on the remote side to receive a pack */
183 #define TRANS_OPT_RECEIVEPACK "receivepack"
185 /* Transfer the data as a thin pack if not null */
186 #define TRANS_OPT_THIN "thin"
188 /* Check the current value of the remote ref */
189 #define TRANS_OPT_CAS "cas"
191 /* Keep the pack that was transferred if not null */
192 #define TRANS_OPT_KEEP "keep"
194 /* Limit the depth of the fetch if not null */
195 #define TRANS_OPT_DEPTH "depth"
197 /* Limit the depth of the fetch based on time if not null */
198 #define TRANS_OPT_DEEPEN_SINCE "deepen-since"
200 /* Limit the depth of the fetch based on revs if not null */
201 #define TRANS_OPT_DEEPEN_NOT "deepen-not"
203 /* Limit the deepen of the fetch if not null */
204 #define TRANS_OPT_DEEPEN_RELATIVE "deepen-relative"
206 /* Aggressively fetch annotated tags if possible */
207 #define TRANS_OPT_FOLLOWTAGS "followtags"
209 /* Accept refs that may update .git/shallow without --depth */
210 #define TRANS_OPT_UPDATE_SHALLOW "updateshallow"
212 /* Send push certificates */
213 #define TRANS_OPT_PUSH_CERT "pushcert"
215 /* Indicate that these objects are being fetched by a promisor */
216 #define TRANS_OPT_FROM_PROMISOR "from-promisor"
219 * Indicate that only the objects wanted need to be fetched, not their
222 #define TRANS_OPT_NO_DEPENDENTS "no-dependents"
225 * Returns 0 if the option was used, non-zero otherwise. Prints a
226 * message to stderr if the option is not used.
228 int transport_set_option(struct transport
*transport
, const char *name
,
230 void transport_set_verbosity(struct transport
*transport
, int verbosity
,
233 #define REJECT_NON_FF_HEAD 0x01
234 #define REJECT_NON_FF_OTHER 0x02
235 #define REJECT_ALREADY_EXISTS 0x04
236 #define REJECT_FETCH_FIRST 0x08
237 #define REJECT_NEEDS_FORCE 0x10
239 int transport_push(struct transport
*connection
,
240 int refspec_nr
, const char **refspec
, int flags
,
241 unsigned int * reject_reasons
);
243 const struct ref
*transport_get_remote_refs(struct transport
*transport
);
245 int transport_fetch_refs(struct transport
*transport
, struct ref
*refs
);
246 void transport_unlock_pack(struct transport
*transport
);
247 int transport_disconnect(struct transport
*transport
);
248 char *transport_anonymize_url(const char *url
);
249 void transport_take_over(struct transport
*transport
,
250 struct child_process
*child
);
252 int transport_connect(struct transport
*transport
, const char *name
,
253 const char *exec
, int fd
[2]);
255 /* Transport methods defined outside transport.c */
256 int transport_helper_init(struct transport
*transport
, const char *name
);
257 int bidirectional_transfer_loop(int input
, int output
);
259 /* common methods used by transport.c and builtin/send-pack.c */
260 void transport_verify_remote_names(int nr_heads
, const char **heads
);
262 void transport_update_tracking_ref(struct remote
*remote
, struct ref
*ref
, int verbose
);
264 int transport_refs_pushed(struct ref
*ref
);
266 void transport_print_push_status(const char *dest
, struct ref
*refs
,
267 int verbose
, int porcelain
, unsigned int *reject_reasons
);
269 typedef void alternate_ref_fn(const char *refname
, const struct object_id
*oid
, void *);
270 extern void for_each_alternate_ref(alternate_ref_fn
, void *);