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