Sync with maint
[git.git] / transport.h
blob02ea248db18a558674825384a5d2678a45483873
1 #ifndef TRANSPORT_H
2 #define TRANSPORT_H
4 #include "cache.h"
5 #include "run-command.h"
6 #include "remote.h"
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;
21 struct transport {
22 struct remote *remote;
23 const char *url;
24 void *data;
25 const struct ref *remote_refs;
27 /**
28 * Indicates whether we already called get_refs_list(); set by
29 * transport.c::transport_get_remote_refs().
31 unsigned got_remote_refs : 1;
34 * Transports that call take-over destroys the data specific to
35 * the transport type while doing so, and cannot be reused.
37 unsigned cannot_reuse : 1;
40 * A hint from caller that it will be performing a clone, not
41 * normal fetch. IOW the repository is guaranteed empty.
43 unsigned cloning : 1;
45 /**
46 * Returns 0 if successful, positive if the option is not
47 * recognized or is inapplicable, and negative if the option
48 * is applicable but the value is invalid.
49 **/
50 int (*set_option)(struct transport *connection, const char *name,
51 const char *value);
53 /**
54 * Returns a list of the remote side's refs. In order to allow
55 * the transport to try to share connections, for_push is a
56 * hint as to whether the ultimate operation is a push or a fetch.
58 * If the transport is able to determine the remote hash for
59 * the ref without a huge amount of effort, it should store it
60 * in the ref's old_sha1 field; otherwise it should be all 0.
61 **/
62 struct ref *(*get_refs_list)(struct transport *transport, int for_push);
64 /**
65 * Fetch the objects for the given refs. Note that this gets
66 * an array, and should ignore the list structure.
68 * If the transport did not get hashes for refs in
69 * get_refs_list(), it should set the old_sha1 fields in the
70 * provided refs now.
71 **/
72 int (*fetch)(struct transport *transport, int refs_nr, struct ref **refs);
74 /**
75 * Push the objects and refs. Send the necessary objects, and
76 * then, for any refs where peer_ref is set and
77 * peer_ref->new_sha1 is different from old_sha1, tell the
78 * remote side to update each ref in the list from old_sha1 to
79 * peer_ref->new_sha1.
81 * Where possible, set the status for each ref appropriately.
83 * The transport must modify new_sha1 in the ref to the new
84 * value if the remote accepted the change. Note that this
85 * could be a different value from peer_ref->new_sha1 if the
86 * process involved generating new commits.
87 **/
88 int (*push_refs)(struct transport *transport, struct ref *refs, int flags);
89 int (*push)(struct transport *connection, int refspec_nr, const char **refspec, int flags);
90 int (*connect)(struct transport *connection, const char *name,
91 const char *executable, int fd[2]);
93 /** get_refs_list(), fetch(), and push_refs() can keep
94 * resources (such as a connection) reserved for further
95 * use. disconnect() releases these resources.
96 **/
97 int (*disconnect)(struct transport *connection);
98 char *pack_lockfile;
99 signed verbose : 3;
101 * Transports should not set this directly, and should use this
102 * value without having to check isatty(2), -q/--quiet
103 * (transport->verbose < 0), etc. - checking has already been done
104 * in transport_set_verbosity().
106 unsigned progress : 1;
108 * If transport is at least potentially smart, this points to
109 * git_transport_options structure to use in case transport
110 * actually turns out to be smart.
112 struct git_transport_options *smart_options;
115 #define TRANSPORT_PUSH_ALL 1
116 #define TRANSPORT_PUSH_FORCE 2
117 #define TRANSPORT_PUSH_DRY_RUN 4
118 #define TRANSPORT_PUSH_MIRROR 8
119 #define TRANSPORT_PUSH_PORCELAIN 16
120 #define TRANSPORT_PUSH_SET_UPSTREAM 32
121 #define TRANSPORT_RECURSE_SUBMODULES_CHECK 64
122 #define TRANSPORT_PUSH_PRUNE 128
123 #define TRANSPORT_RECURSE_SUBMODULES_ON_DEMAND 256
124 #define TRANSPORT_PUSH_NO_HOOK 512
125 #define TRANSPORT_PUSH_FOLLOW_TAGS 1024
127 #define TRANSPORT_SUMMARY_WIDTH (2 * DEFAULT_ABBREV + 3)
128 #define TRANSPORT_SUMMARY(x) (int)(TRANSPORT_SUMMARY_WIDTH + strlen(x) - gettext_width(x)), (x)
130 /* Returns a transport suitable for the url */
131 struct transport *transport_get(struct remote *, const char *);
133 /* Transport options which apply to git:// and scp-style URLs */
135 /* The program to use on the remote side to send a pack */
136 #define TRANS_OPT_UPLOADPACK "uploadpack"
138 /* The program to use on the remote side to receive a pack */
139 #define TRANS_OPT_RECEIVEPACK "receivepack"
141 /* Transfer the data as a thin pack if not null */
142 #define TRANS_OPT_THIN "thin"
144 /* Check the current value of the remote ref */
145 #define TRANS_OPT_CAS "cas"
147 /* Keep the pack that was transferred if not null */
148 #define TRANS_OPT_KEEP "keep"
150 /* Limit the depth of the fetch if not null */
151 #define TRANS_OPT_DEPTH "depth"
153 /* Aggressively fetch annotated tags if possible */
154 #define TRANS_OPT_FOLLOWTAGS "followtags"
156 /* Accept refs that may update .git/shallow without --depth */
157 #define TRANS_OPT_UPDATE_SHALLOW "updateshallow"
160 * Returns 0 if the option was used, non-zero otherwise. Prints a
161 * message to stderr if the option is not used.
163 int transport_set_option(struct transport *transport, const char *name,
164 const char *value);
165 void transport_set_verbosity(struct transport *transport, int verbosity,
166 int force_progress);
168 #define REJECT_NON_FF_HEAD 0x01
169 #define REJECT_NON_FF_OTHER 0x02
170 #define REJECT_ALREADY_EXISTS 0x04
171 #define REJECT_FETCH_FIRST 0x08
172 #define REJECT_NEEDS_FORCE 0x10
174 int transport_push(struct transport *connection,
175 int refspec_nr, const char **refspec, int flags,
176 unsigned int * reject_reasons);
178 const struct ref *transport_get_remote_refs(struct transport *transport);
180 int transport_fetch_refs(struct transport *transport, struct ref *refs);
181 void transport_unlock_pack(struct transport *transport);
182 int transport_disconnect(struct transport *transport);
183 char *transport_anonymize_url(const char *url);
184 void transport_take_over(struct transport *transport,
185 struct child_process *child);
187 int transport_connect(struct transport *transport, const char *name,
188 const char *exec, int fd[2]);
190 /* Transport methods defined outside transport.c */
191 int transport_helper_init(struct transport *transport, const char *name);
192 int bidirectional_transfer_loop(int input, int output);
194 /* common methods used by transport.c and builtin/send-pack.c */
195 void transport_verify_remote_names(int nr_heads, const char **heads);
197 void transport_update_tracking_ref(struct remote *remote, struct ref *ref, int verbose);
199 int transport_refs_pushed(struct ref *ref);
201 void transport_print_push_status(const char *dest, struct ref *refs,
202 int verbose, int porcelain, unsigned int *reject_reasons);
204 typedef void alternate_ref_fn(const struct ref *, void *);
205 extern void for_each_alternate_ref(alternate_ref_fn, void *);
206 #endif