| 1 | #ifndef TRANSPORT_H |
| 2 | #define TRANSPORT_H |
| 3 | |
| 4 | #include "run-command.h" |
| 5 | #include "remote.h" |
| 6 | #include "list-objects-filter-options.h" |
| 7 | #include "string-list.h" |
| 8 | #include "connect.h" |
| 9 | |
| 10 | struct git_transport_options { |
| 11 | unsigned thin : 1; |
| 12 | unsigned keep : 1; |
| 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 reject_shallow : 1; |
| 18 | unsigned deepen_relative : 1; |
| 19 | unsigned refetch : 1; |
| 20 | |
| 21 | /* see documentation of corresponding flag in fetch-pack.h */ |
| 22 | unsigned from_promisor : 1; |
| 23 | |
| 24 | /* |
| 25 | * If this transport supports connect or stateless-connect, |
| 26 | * the corresponding field in struct fetch_pack_args is copied |
| 27 | * here after fetching. |
| 28 | * |
| 29 | * See the definition of connectivity_checked in struct |
| 30 | * fetch_pack_args for more information. |
| 31 | */ |
| 32 | unsigned connectivity_checked:1; |
| 33 | |
| 34 | int depth; |
| 35 | const char *deepen_since; |
| 36 | const struct string_list *deepen_not; |
| 37 | const char *uploadpack; |
| 38 | const char *receivepack; |
| 39 | struct push_cas_option *cas; |
| 40 | struct list_objects_filter_options filter_options; |
| 41 | |
| 42 | /* |
| 43 | * This is only used during fetch. See the documentation of |
| 44 | * these member names in struct fetch_pack_args. |
| 45 | * |
| 46 | * These fields are only supported by transports that support connect or |
| 47 | * stateless_connect. Set this field directly instead of using |
| 48 | * transport_set_option(). |
| 49 | */ |
| 50 | struct oid_array *negotiation_restrict_tips; |
| 51 | struct oid_array *negotiation_include_tips; |
| 52 | |
| 53 | /* |
| 54 | * If allocated, whenever transport_fetch_refs() is called, add known |
| 55 | * common commits to this oidset instead of fetching any packfiles. |
| 56 | */ |
| 57 | struct oidset *acked_commits; |
| 58 | }; |
| 59 | |
| 60 | enum transport_family { |
| 61 | TRANSPORT_FAMILY_ALL = 0, |
| 62 | TRANSPORT_FAMILY_IPV4, |
| 63 | TRANSPORT_FAMILY_IPV6 |
| 64 | }; |
| 65 | |
| 66 | struct bundle_list; |
| 67 | struct transport { |
| 68 | const struct transport_vtable *vtable; |
| 69 | |
| 70 | struct remote *remote; |
| 71 | const char *url; |
| 72 | void *data; |
| 73 | const struct ref *remote_refs; |
| 74 | |
| 75 | /** |
| 76 | * Indicates whether we already called get_refs_list(); set by |
| 77 | * transport.c::transport_get_remote_refs(). |
| 78 | */ |
| 79 | unsigned got_remote_refs : 1; |
| 80 | |
| 81 | /** |
| 82 | * Indicates whether we already called get_bundle_uri_list(); set by |
| 83 | * transport.c::transport_get_remote_bundle_uri(). |
| 84 | */ |
| 85 | unsigned got_remote_bundle_uri : 1; |
| 86 | |
| 87 | /* |
| 88 | * The results of "command=bundle-uri", if both sides support |
| 89 | * the "bundle-uri" capability. |
| 90 | */ |
| 91 | struct bundle_list *bundles; |
| 92 | |
| 93 | /* |
| 94 | * Transports that call take-over destroys the data specific to |
| 95 | * the transport type while doing so, and cannot be reused. |
| 96 | */ |
| 97 | unsigned cannot_reuse : 1; |
| 98 | |
| 99 | /* |
| 100 | * A hint from caller that it will be performing a clone, not |
| 101 | * normal fetch. IOW the repository is guaranteed empty. |
| 102 | */ |
| 103 | unsigned cloning : 1; |
| 104 | |
| 105 | /* |
| 106 | * Indicates that the transport is connected via a half-duplex |
| 107 | * connection and should operate in stateless-rpc mode. |
| 108 | */ |
| 109 | unsigned stateless_rpc : 1; |
| 110 | |
| 111 | /* |
| 112 | * These strings will be passed to the {pre, post}-receive hook, |
| 113 | * on the remote side, if both sides support the push options capability. |
| 114 | */ |
| 115 | const struct string_list *push_options; |
| 116 | |
| 117 | /* |
| 118 | * These strings will be passed to the remote side on each command |
| 119 | * request, if both sides support the server-option capability. |
| 120 | */ |
| 121 | const struct string_list *server_options; |
| 122 | |
| 123 | struct string_list pack_lockfiles; |
| 124 | |
| 125 | signed verbose : 3; |
| 126 | /** |
| 127 | * Transports should not set this directly, and should use this |
| 128 | * value without having to check isatty(2), -q/--quiet |
| 129 | * (transport->verbose < 0), etc. - checking has already been done |
| 130 | * in transport_set_verbosity(). |
| 131 | **/ |
| 132 | unsigned progress : 1; |
| 133 | /* |
| 134 | * If transport is at least potentially smart, this points to |
| 135 | * git_transport_options structure to use in case transport |
| 136 | * actually turns out to be smart. |
| 137 | */ |
| 138 | struct git_transport_options *smart_options; |
| 139 | |
| 140 | enum transport_family family; |
| 141 | |
| 142 | const struct git_hash_algo *hash_algo; |
| 143 | }; |
| 144 | |
| 145 | #define TRANSPORT_PUSH_ALL (1<<0) |
| 146 | #define TRANSPORT_PUSH_FORCE (1<<1) |
| 147 | #define TRANSPORT_PUSH_DRY_RUN (1<<2) |
| 148 | #define TRANSPORT_PUSH_MIRROR (1<<3) |
| 149 | #define TRANSPORT_PUSH_PORCELAIN (1<<4) |
| 150 | #define TRANSPORT_PUSH_SET_UPSTREAM (1<<5) |
| 151 | #define TRANSPORT_RECURSE_SUBMODULES_CHECK (1<<6) |
| 152 | #define TRANSPORT_PUSH_PRUNE (1<<7) |
| 153 | #define TRANSPORT_RECURSE_SUBMODULES_ON_DEMAND (1<<8) |
| 154 | #define TRANSPORT_PUSH_NO_HOOK (1<<9) |
| 155 | #define TRANSPORT_PUSH_FOLLOW_TAGS (1<<10) |
| 156 | #define TRANSPORT_PUSH_CERT_ALWAYS (1<<11) |
| 157 | #define TRANSPORT_PUSH_CERT_IF_ASKED (1<<12) |
| 158 | #define TRANSPORT_PUSH_ATOMIC (1<<13) |
| 159 | #define TRANSPORT_PUSH_OPTIONS (1<<14) |
| 160 | #define TRANSPORT_RECURSE_SUBMODULES_ONLY (1<<15) |
| 161 | #define TRANSPORT_PUSH_FORCE_IF_INCLUDES (1<<16) |
| 162 | #define TRANSPORT_PUSH_AUTO_UPSTREAM (1<<17) |
| 163 | |
| 164 | int transport_summary_width(const struct ref *refs); |
| 165 | |
| 166 | /* Returns a transport suitable for the url */ |
| 167 | struct transport *transport_get(struct remote *, const char *); |
| 168 | |
| 169 | /* |
| 170 | * Check whether a transport is allowed by the environment. |
| 171 | * |
| 172 | * Type should generally be the URL scheme, as described in |
| 173 | * Documentation/git.adoc |
| 174 | * |
| 175 | * from_user specifies if the transport was given by the user. If unknown pass |
| 176 | * a -1 to read from the environment to determine if the transport was given by |
| 177 | * the user. |
| 178 | * |
| 179 | */ |
| 180 | int is_transport_allowed(const char *type, int from_user); |
| 181 | |
| 182 | /* |
| 183 | * Check whether a transport is allowed by the environment, |
| 184 | * and die otherwise. |
| 185 | */ |
| 186 | void transport_check_allowed(const char *type); |
| 187 | |
| 188 | /* Transport options which apply to git:// and scp-style URLs */ |
| 189 | |
| 190 | /* The program to use on the remote side to send a pack */ |
| 191 | #define TRANS_OPT_UPLOADPACK "uploadpack" |
| 192 | |
| 193 | /* The program to use on the remote side to receive a pack */ |
| 194 | #define TRANS_OPT_RECEIVEPACK "receivepack" |
| 195 | |
| 196 | /* Transfer the data as a thin pack if not null */ |
| 197 | #define TRANS_OPT_THIN "thin" |
| 198 | |
| 199 | /* Check the current value of the remote ref */ |
| 200 | #define TRANS_OPT_CAS "cas" |
| 201 | |
| 202 | /* Keep the pack that was transferred if not null */ |
| 203 | #define TRANS_OPT_KEEP "keep" |
| 204 | |
| 205 | /* Limit the depth of the fetch if not null */ |
| 206 | #define TRANS_OPT_DEPTH "depth" |
| 207 | |
| 208 | /* Limit the depth of the fetch based on time if not null */ |
| 209 | #define TRANS_OPT_DEEPEN_SINCE "deepen-since" |
| 210 | |
| 211 | /* Limit the depth of the fetch based on revs if not null */ |
| 212 | #define TRANS_OPT_DEEPEN_NOT "deepen-not" |
| 213 | |
| 214 | /* Limit the deepen of the fetch if not null */ |
| 215 | #define TRANS_OPT_DEEPEN_RELATIVE "deepen-relative" |
| 216 | |
| 217 | /* Aggressively fetch annotated tags if possible */ |
| 218 | #define TRANS_OPT_FOLLOWTAGS "followtags" |
| 219 | |
| 220 | /* Reject shallow repo transport */ |
| 221 | #define TRANS_OPT_REJECT_SHALLOW "rejectshallow" |
| 222 | |
| 223 | /* Accept refs that may update .git/shallow without --depth */ |
| 224 | #define TRANS_OPT_UPDATE_SHALLOW "updateshallow" |
| 225 | |
| 226 | /* Send push certificates */ |
| 227 | #define TRANS_OPT_PUSH_CERT "pushcert" |
| 228 | |
| 229 | /* Indicate that these objects are being fetched by a promisor */ |
| 230 | #define TRANS_OPT_FROM_PROMISOR "from-promisor" |
| 231 | |
| 232 | /* Filter objects for partial clone and fetch */ |
| 233 | #define TRANS_OPT_LIST_OBJECTS_FILTER "filter" |
| 234 | |
| 235 | /* Refetch all objects without negotiating */ |
| 236 | #define TRANS_OPT_REFETCH "refetch" |
| 237 | |
| 238 | /* Request atomic (all-or-nothing) updates when pushing */ |
| 239 | #define TRANS_OPT_ATOMIC "atomic" |
| 240 | |
| 241 | /* Require remote changes to be integrated locally. */ |
| 242 | #define TRANS_OPT_FORCE_IF_INCLUDES "force-if-includes" |
| 243 | |
| 244 | /** |
| 245 | * Returns 0 if the option was used, non-zero otherwise. Prints a |
| 246 | * message to stderr if the option is not used. |
| 247 | **/ |
| 248 | int transport_set_option(struct transport *transport, const char *name, |
| 249 | const char *value); |
| 250 | void transport_set_verbosity(struct transport *transport, int verbosity, |
| 251 | int force_progress); |
| 252 | |
| 253 | #define REJECT_NON_FF_HEAD 0x01 |
| 254 | #define REJECT_NON_FF_OTHER 0x02 |
| 255 | #define REJECT_ALREADY_EXISTS 0x04 |
| 256 | #define REJECT_FETCH_FIRST 0x08 |
| 257 | #define REJECT_NEEDS_FORCE 0x10 |
| 258 | #define REJECT_REF_NEEDS_UPDATE 0x20 |
| 259 | |
| 260 | int transport_push(struct repository *repo, |
| 261 | struct transport *connection, |
| 262 | struct refspec *rs, int flags, |
| 263 | unsigned int * reject_reasons); |
| 264 | |
| 265 | struct transport_ls_refs_options { |
| 266 | /* |
| 267 | * Optionally, a list of ref prefixes can be provided which can be sent |
| 268 | * to the server (when communicating using protocol v2) to enable it to |
| 269 | * limit the ref advertisement. Since ref filtering is done on the |
| 270 | * server's end (and only when using protocol v2), |
| 271 | * transport_get_remote_refs() could return refs which don't match the |
| 272 | * provided ref_prefixes. |
| 273 | */ |
| 274 | struct strvec ref_prefixes; |
| 275 | |
| 276 | /* |
| 277 | * If unborn_head_target is not NULL, and the remote reports HEAD as |
| 278 | * pointing to an unborn branch, transport_get_remote_refs() stores the |
| 279 | * unborn branch in unborn_head_target. |
| 280 | */ |
| 281 | const char *unborn_head_target; |
| 282 | }; |
| 283 | #define TRANSPORT_LS_REFS_OPTIONS_INIT { \ |
| 284 | .ref_prefixes = STRVEC_INIT, \ |
| 285 | } |
| 286 | |
| 287 | /** |
| 288 | * Release the "struct transport_ls_refs_options". |
| 289 | */ |
| 290 | void transport_ls_refs_options_release(struct transport_ls_refs_options *opts); |
| 291 | |
| 292 | /* |
| 293 | * Retrieve refs from a remote. |
| 294 | */ |
| 295 | const struct ref *transport_get_remote_refs(struct transport *transport, |
| 296 | struct transport_ls_refs_options *transport_options); |
| 297 | |
| 298 | /** |
| 299 | * Retrieve bundle URI(s) from a remote. Populates "struct |
| 300 | * transport"'s "bundle_uri" and "got_remote_bundle_uri". |
| 301 | */ |
| 302 | int transport_get_remote_bundle_uri(struct transport *transport); |
| 303 | |
| 304 | /* |
| 305 | * Fetch the hash algorithm used by a remote. |
| 306 | * |
| 307 | * This can only be called after fetching the remote refs. |
| 308 | */ |
| 309 | const struct git_hash_algo *transport_get_hash_algo(struct transport *transport); |
| 310 | int transport_fetch_refs(struct transport *transport, struct ref *refs); |
| 311 | |
| 312 | /* |
| 313 | * If this flag is set, unlocking will avoid to call non-async-signal-safe |
| 314 | * functions. This will necessarily leave behind some data structures which |
| 315 | * cannot be cleaned up. |
| 316 | */ |
| 317 | #define TRANSPORT_UNLOCK_PACK_IN_SIGNAL_HANDLER (1 << 0) |
| 318 | |
| 319 | /* |
| 320 | * Unlock all packfiles locked by the transport. |
| 321 | */ |
| 322 | void transport_unlock_pack(struct transport *transport, unsigned int flags); |
| 323 | |
| 324 | int transport_disconnect(struct transport *transport); |
| 325 | char *transport_anonymize_url(const char *url); |
| 326 | void transport_take_over(struct transport *transport, |
| 327 | struct child_process *child); |
| 328 | |
| 329 | int transport_connect(struct transport *transport, |
| 330 | enum git_connect_service service, |
| 331 | const char *exec, int fd[2]); |
| 332 | |
| 333 | /* Transport methods defined outside transport.c */ |
| 334 | int transport_helper_init(struct transport *transport, const char *name); |
| 335 | int bidirectional_transfer_loop(int input, int output); |
| 336 | |
| 337 | /* common methods used by transport.c and builtin/send-pack.c */ |
| 338 | void transport_update_tracking_ref(struct remote *remote, struct ref *ref, int verbose); |
| 339 | |
| 340 | int transport_refs_pushed(struct ref *ref); |
| 341 | |
| 342 | void transport_print_push_status(const char *dest, struct ref *refs, |
| 343 | int verbose, int porcelain, unsigned int *reject_reasons); |
| 344 | |
| 345 | /* common method used by transport-helper.c and send-pack.c */ |
| 346 | void reject_atomic_push(struct ref *refs, int mirror_mode); |
| 347 | |
| 348 | /* common method to parse push-option or server-option from config */ |
| 349 | int parse_transport_option(const char *var, const char *value, |
| 350 | struct string_list *transport_options); |
| 351 | |
| 352 | #endif |