Merge branch 'maint'
[git/git.git] / transport.h
CommitLineData
9b288516
DB
1#ifndef TRANSPORT_H
2#define TRANSPORT_H
3
4#include "cache.h"
5#include "remote.h"
6
aa5af974
IL
7struct git_transport_options {
8 unsigned thin : 1;
9 unsigned keep : 1;
10 unsigned followtags : 1;
c6807a40
NTND
11 unsigned check_self_contained_and_connected : 1;
12 unsigned self_contained_and_connected : 1;
aa5af974
IL
13 int depth;
14 const char *uploadpack;
15 const char *receivepack;
16};
17
9b288516 18struct transport {
9b288516
DB
19 struct remote *remote;
20 const char *url;
9b288516 21 void *data;
4577370e 22 const struct ref *remote_refs;
9b288516 23
b0d66e15
TRC
24 /**
25 * Indicates whether we already called get_refs_list(); set by
26 * transport.c::transport_get_remote_refs().
27 */
28 unsigned got_remote_refs : 1;
29
9b288516
DB
30 /**
31 * Returns 0 if successful, positive if the option is not
32 * recognized or is inapplicable, and negative if the option
33 * is applicable but the value is invalid.
34 **/
35 int (*set_option)(struct transport *connection, const char *name,
36 const char *value);
37
37148311
DB
38 /**
39 * Returns a list of the remote side's refs. In order to allow
40 * the transport to try to share connections, for_push is a
41 * hint as to whether the ultimate operation is a push or a fetch.
42 *
43 * If the transport is able to determine the remote hash for
44 * the ref without a huge amount of effort, it should store it
45 * in the ref's old_sha1 field; otherwise it should be all 0.
46 **/
64fcef2d 47 struct ref *(*get_refs_list)(struct transport *transport, int for_push);
37148311
DB
48
49 /**
50 * Fetch the objects for the given refs. Note that this gets
51 * an array, and should ignore the list structure.
52 *
53 * If the transport did not get hashes for refs in
54 * get_refs_list(), it should set the old_sha1 fields in the
55 * provided refs now.
56 **/
57 int (*fetch)(struct transport *transport, int refs_nr, struct ref **refs);
58
59 /**
60 * Push the objects and refs. Send the necessary objects, and
61 * then, for any refs where peer_ref is set and
62 * peer_ref->new_sha1 is different from old_sha1, tell the
63 * remote side to update each ref in the list from old_sha1 to
64 * peer_ref->new_sha1.
65 *
66 * Where possible, set the status for each ref appropriately.
67 *
68 * The transport must modify new_sha1 in the ref to the new
69 * value if the remote accepted the change. Note that this
70 * could be a different value from peer_ref->new_sha1 if the
71 * process involved generating new commits.
72 **/
64fcef2d 73 int (*push_refs)(struct transport *transport, struct ref *refs, int flags);
9b288516 74 int (*push)(struct transport *connection, int refspec_nr, const char **refspec, int flags);
b236752a
IL
75 int (*connect)(struct transport *connection, const char *name,
76 const char *executable, int fd[2]);
9b288516 77
37148311 78 /** get_refs_list(), fetch(), and push_refs() can keep
41ccfdd9 79 * resources (such as a connection) reserved for further
37148311
DB
80 * use. disconnect() releases these resources.
81 **/
9b288516 82 int (*disconnect)(struct transport *connection);
824d5776 83 char *pack_lockfile;
cff7123c 84 signed verbose : 3;
d01b3c02
TRC
85 /**
86 * Transports should not set this directly, and should use this
87 * value without having to check isatty(2), -q/--quiet
88 * (transport->verbose < 0), etc. - checking has already been done
89 * in transport_set_verbosity().
90 **/
21188b1e 91 unsigned progress : 1;
aa5af974
IL
92 /*
93 * If transport is at least potentially smart, this points to
94 * git_transport_options structure to use in case transport
95 * actually turns out to be smart.
96 */
97 struct git_transport_options *smart_options;
9b288516
DB
98};
99
824d5776
SP
100#define TRANSPORT_PUSH_ALL 1
101#define TRANSPORT_PUSH_FORCE 2
2e13e5d8 102#define TRANSPORT_PUSH_DRY_RUN 4
94c89ba6 103#define TRANSPORT_PUSH_MIRROR 8
212cfe15
TRC
104#define TRANSPORT_PUSH_PORCELAIN 16
105#define TRANSPORT_PUSH_SET_UPSTREAM 32
d2b17b32 106#define TRANSPORT_RECURSE_SUBMODULES_CHECK 64
6ddba5e2 107#define TRANSPORT_PUSH_PRUNE 128
eb21c732 108#define TRANSPORT_RECURSE_SUBMODULES_ON_DEMAND 256
ec55559f 109#define TRANSPORT_PUSH_NO_HOOK 512
c2aba155 110#define TRANSPORT_PUSH_FOLLOW_TAGS 1024
824d5776 111
f1863d0d 112#define TRANSPORT_SUMMARY_WIDTH (2 * DEFAULT_ABBREV + 3)
754395d3 113#define TRANSPORT_SUMMARY(x) (int)(TRANSPORT_SUMMARY_WIDTH + strlen(x) - gettext_width(x)), (x)
824d5776 114
9b288516 115/* Returns a transport suitable for the url */
e5f4e214 116struct transport *transport_get(struct remote *, const char *);
9b288516
DB
117
118/* Transport options which apply to git:// and scp-style URLs */
119
c29727d5
DB
120/* The program to use on the remote side to send a pack */
121#define TRANS_OPT_UPLOADPACK "uploadpack"
122
9b288516
DB
123/* The program to use on the remote side to receive a pack */
124#define TRANS_OPT_RECEIVEPACK "receivepack"
125
126/* Transfer the data as a thin pack if not null */
127#define TRANS_OPT_THIN "thin"
128
c29727d5
DB
129/* Keep the pack that was transferred if not null */
130#define TRANS_OPT_KEEP "keep"
131
c29727d5
DB
132/* Limit the depth of the fetch if not null */
133#define TRANS_OPT_DEPTH "depth"
134
41fa7d2e
SP
135/* Aggressively fetch annotated tags if possible */
136#define TRANS_OPT_FOLLOWTAGS "followtags"
137
9b288516
DB
138/**
139 * Returns 0 if the option was used, non-zero otherwise. Prints a
140 * message to stderr if the option is not used.
141 **/
142int transport_set_option(struct transport *transport, const char *name,
143 const char *value);
d01b3c02
TRC
144void transport_set_verbosity(struct transport *transport, int verbosity,
145 int force_progress);
9b288516 146
10643d4e
CR
147#define REJECT_NON_FF_HEAD 0x01
148#define REJECT_NON_FF_OTHER 0x02
b24e6047 149#define REJECT_ALREADY_EXISTS 0x04
75e5c0dc
JH
150#define REJECT_FETCH_FIRST 0x08
151#define REJECT_NEEDS_FORCE 0x10
10643d4e 152
9b288516 153int transport_push(struct transport *connection,
07436e43 154 int refspec_nr, const char **refspec, int flags,
10643d4e 155 unsigned int * reject_reasons);
9b288516 156
4577370e 157const struct ref *transport_get_remote_refs(struct transport *transport);
c29727d5 158
37148311 159int transport_fetch_refs(struct transport *transport, struct ref *refs);
1788c39c 160void transport_unlock_pack(struct transport *transport);
9b288516 161int transport_disconnect(struct transport *transport);
47abd85b 162char *transport_anonymize_url(const char *url);
61b075bd
IL
163void transport_take_over(struct transport *transport,
164 struct child_process *child);
9b288516 165
b236752a
IL
166int transport_connect(struct transport *transport, const char *name,
167 const char *exec, int fd[2]);
168
6eb996b5 169/* Transport methods defined outside transport.c */
c9e388bb 170int transport_helper_init(struct transport *transport, const char *name);
419f37db 171int bidirectional_transfer_loop(int input, int output);
6eb996b5 172
09b7e220 173/* common methods used by transport.c and builtin/send-pack.c */
f1863d0d
ML
174void transport_verify_remote_names(int nr_heads, const char **heads);
175
176void transport_update_tracking_ref(struct remote *remote, struct ref *ref, int verbose);
177
178int transport_refs_pushed(struct ref *ref);
179
180void transport_print_push_status(const char *dest, struct ref *refs,
10643d4e 181 int verbose, int porcelain, unsigned int *reject_reasons);
f1863d0d 182
36cfda15 183typedef void alternate_ref_fn(const struct ref *, void *);
114a6a88 184extern void for_each_alternate_ref(alternate_ref_fn, void *);
36cfda15 185
f5d942e1
NTND
186struct send_pack_args;
187extern int send_pack(struct send_pack_args *args,
188 int fd[], struct child_process *conn,
189 struct ref *remote_refs,
190 struct extra_have_objects *extra_have);
9b288516 191#endif