imap-send: use libcurl for implementation
Subsystems (2)
PATCH 1/1 imap-send: use libcurl for implementation
Use libcurl's high-level API functions to implement git-imap-send instead of the previous low-level OpenSSL-based functions.
Since version 7.30.0, libcurl's API has been able to communicate with IMAP servers. Using those high-level functions instead of the current ones would reduce imap-send.c by some 1200 lines of code. For now, the old ones are wrapped in #ifdefs, and the new functions are enabled by make if curl's version is >= 7.34.0, from which version on curl's CURLOPT_LOGIN_OPTIONS (enabling IMAP authentication) parameter has been available. The low-level functions will still be used for tunneling into the server for now.
As I don't have access to that many IMAP servers, I haven't been able to test the new code with a wide variety of parameter combinations. I did test both secure and insecure (imaps:// and imap://) connections and values of "PLAIN" and "LOGIN" for the authMethod.
---
Fixed according to <[email protected]>, and based upon master with f1a35295c2b66d2501f034d864afb2c5d8bb0e08 cherry-picked.
Documentation/git-imap-send.txt | 18 ++++- INSTALL | 15 ++-- Makefile | 16 +++- imap-send.c | 174 +++++++++++++++++++++++++++++++++------- 4 files changed, 184 insertions(+), 39 deletions(-)
Documentation/git-imap-send.txt +15 -3
@@ -9,7 +9,7 @@ git-imap-send - Send a collection of patches from stdin to an IMAP folder SYNOPSIS -------- [verse] -'git imap-send' [-v] [-q] +'git imap-send' [-v] [-q] [--[no-]curl] DESCRIPTION
@@ -25,7 +25,6 @@ Typical usage is something like: git format-patch --signoff --stdout --attach origin | git imap-send - OPTIONS -------
@@ -37,6 +36,17 @@ OPTIONS --quiet:: Be quiet. +--curl:: + Use libcurl to communicate with the IMAP server, unless tunneling + into it. Only available if git was built with the + USE_CURL_FOR_IMAP_SEND option set, in which case this is the + default behavior. + +--no-curl:: + Talk to the IMAP server using git's own IMAP routines instead of + using libcurl. Only available git was built with the + USE_CURL_FOR_IMAP_SEND option set; implicitly assumed otherwise. + CONFIGURATION -------------
@@ -87,7 +97,9 @@ imap.preformattedHTML:: imap.authMethod:: Specify authenticate method for authentication with IMAP server. - Current supported method is 'CRAM-MD5' only. If this is not set + If git was built with the NO_CURL option, or if your curl version is + < 7.34.0, or if you're running git-imap-send with the --no-curl + option, the only supported method is 'CRAM-MD5'. If this is not set then 'git imap-send' uses the basic IMAP plaintext LOGIN command. Examples
INSTALL +9 -6
@@ -108,18 +108,21 @@ Issues of note: so you might need to install additional packages other than Perl itself, e.g. Time::HiRes. - - "openssl" library is used by git-imap-send to use IMAP over SSL. - If you don't need it, use NO_OPENSSL. + - git-imap-send needs the OpenSSL library to talk IMAP over SSL if + you are using libcurl older than 7.34.0. Otherwise you can use + NO_OPENSSL without losing git-imap-send. By default, git uses OpenSSL for SHA1 but it will use its own library (inspired by Mozilla's) with either NO_OPENSSL or BLK_SHA1. Also included is a version optimized for PowerPC (PPC_SHA1). - - "libcurl" library is used by git-http-fetch and git-fetch. You - might also want the "curl" executable for debugging purposes. - If you do not use http:// or https:// repositories, you do not - have to have them (use NO_CURL). + - "libcurl" library is used by git-http-fetch, git-fetch, and, if + the curl version >= 7.34.0, for git-imap-send. You might also + want the "curl" executable for debugging purposes. If you do not + use http:// or https:// repositories, and do not want to put + patches into an IMAP mailbox, you do not have to have them + (use NO_CURL). - "expat" library; git-http-push uses it for remote lock management over DAV. Similar to "curl" above, this is optional
Makefile +14 -2
@@ -995,6 +995,9 @@ ifdef HAVE_ALLOCA_H BASIC_CFLAGS += -DHAVE_ALLOCA_H endif +IMAP_SEND_BUILDDEPS = +IMAP_SEND_LDFLAGS = $(OPENSSL_LINK) $(OPENSSL_LIBSSL) $(LIB_4_CRYPTO) + ifdef NO_CURL BASIC_CFLAGS += -DNO_CURL REMOTE_CURL_PRIMARY =
@@ -1029,6 +1032,15 @@ else PROGRAM_OBJS += http-push.o endif endif + curl_check := $(shell (echo 072200; curl-config --vernum) 2>/dev/null | sort -r | sed -ne 2p) + ifeq "$(curl_check)" "072200" + USE_CURL_FOR_IMAP_SEND = YesPlease + endif + ifdef USE_CURL_FOR_IMAP_SEND + BASIC_CFLAGS += -DUSE_CURL_FOR_IMAP_SEND + IMAP_SEND_BUILDDEPS = http.o + IMAP_SEND_LDFLAGS += $(CURL_LIBCURL) + endif ifndef NO_EXPAT ifdef EXPATDIR BASIC_CFLAGS += -I$(EXPATDIR)/include
@@ -1895,9 +1907,9 @@ endif git-%$X: %.o GIT-LDFLAGS $(GITLIBS) $(QUIET_LINK)$(CC) $(ALL_CFLAGS) -o $@ $(ALL_LDFLAGS) $(filter %.o,$^) $(LIBS) -git-imap-send$X: imap-send.o GIT-LDFLAGS $(GITLIBS) +git-imap-send$X: imap-send.o $(IMAP_SEND_BUILDDEPS) GIT-LDFLAGS $(GITLIBS) $(QUIET_LINK)$(CC) $(ALL_CFLAGS) -o $@ $(ALL_LDFLAGS) $(filter %.o,$^) \ - $(LIBS) $(OPENSSL_LINK) $(OPENSSL_LIBSSL) $(LIB_4_CRYPTO) + $(LIBS) $(IMAP_SEND_LDFLAGS) git-http-fetch$X: http.o http-walker.o http-fetch.o GIT-LDFLAGS $(GITLIBS) $(QUIET_LINK)$(CC) $(ALL_CFLAGS) -o $@ $(ALL_LDFLAGS) $(filter %.o,$^) \
imap-send.c +146 -28
214 lines not on this page · raw message
Signature · 1 line
2.2.0.rc0.4.gb4b9e19
Documentation/git-imap-send.txt Typical usage is something like: · line 28
Quoted 6 lines · Bernhard Reiter
Documentation/git-imap-send.txt +0
-1@@ -25,7 +25,6 @@ Typical usage is something like: git format-patch --signoff --stdout --attach origin | git imap-send - OPTIONS
Why?
Quoted 5 lines
Documentation/git-imap-send.txt +1
-0@@ -37,6 +36,17 @@ OPTIONS --quiet:: Be quiet. +--curl::
Documentation/git-imap-send.txt OPTIONS · line 49
Quoted 10 lines
Documentation/git-imap-send.txt +10
-0+ Use libcurl to communicate with the IMAP server, unless tunneling + into it. Only available if git was built with the + USE_CURL_FOR_IMAP_SEND option set, in which case this is the + default behavior. + +--no-curl:: + Talk to the IMAP server using git's own IMAP routines instead of + using libcurl. Only available git was built with the + USE_CURL_FOR_IMAP_SEND option set; implicitly assumed otherwise. +
I think we tend to spell "Git" not "git" when we refer to the software suite as a whole.
More importantly, the description on these two items are no longer in line with the implementation, aren't they? We accept these options but warn and a build without libcurl ignores --curl with a warning, and --curl is not default in any build.
Documentation/git-imap-send.txt imap.preformattedHTML:: · line 101
Quoted 7 lines
Documentation/git-imap-send.txt +2
-1@@ -87,7 +97,9 @@ imap.preformattedHTML:: imap.authMethod:: Specify authenticate method for authentication with IMAP server. - Current supported method is 'CRAM-MD5' only. If this is not set + If git was built with the NO_CURL option, or if your curl version is + < 7.34.0, or if you're running git-imap-send with the --no-curl
s/< /older than /;
Also quote --no-curl inside bq-pair, i.e. --no-curl, as that is something the user will type as-is.
Quoted 9 lines
Documentation/git-imap-send.txt +1
-0+ option, the only supported method is 'CRAM-MD5'. If this is not set then 'git imap-send' uses the basic IMAP plaintext LOGIN command. ExamplesINSTALL +0
-0
INSTALL Issues of note: · line 113
Quoted 8 lines
INSTALL +3
-2@@ -108,18 +108,21 @@ Issues of note: so you might need to install additional packages other than Perl itself, e.g. Time::HiRes. - - "openssl" library is used by git-imap-send to use IMAP over SSL. - If you don't need it, use NO_OPENSSL. + - git-imap-send needs the OpenSSL library to talk IMAP over SSL if + you are using libcurl older than 7.34.0. Otherwise you can use + NO_OPENSSL without losing git-imap-send.
OK.
INSTALL Issues of note: · line 125
Quoted 6 lines
INSTALL +6
-0+ - "libcurl" library is used by git-http-fetch, git-fetch, and, if + the curl version >= 7.34.0, for git-imap-send. You might also + want the "curl" executable for debugging purposes. If you do not + use http:// or https:// repositories, and do not want to put + patches into an IMAP mailbox, you do not have to have them + (use NO_CURL).
OK.
Quoted 25 lines
imap-send.c +6
-1@@ -30,13 +30,18 @@#ifdef NO_OPENSSL typedef void *SSL ;#endif +#ifdef USE_CURL_FOR_IMAP_SEND +#include "http.h" +#endif static int verbosity; +static int use_curl;/* strictly opt in */ -static const char *const imap_send_usage[] = {"git imap-send [-v] [-q] < <mbox>" ,NULL }; +static const char *const imap_send_usage[] = {"git imap-send [-v] [-q] [--[no-]curl] < <mbox>" ,NULL };static struct option imap_send_options[] = {OPT__VERBOSITY (&verbosity), +OPT_BOOL (0 ,"curl" , &use_curl,"use libcurl to communicate with the IMAP server" ),OPT_END () };
imap-send.c static void git_imap_config(void) · line 1352
Quoted 7 lines
imap-send.c +1
-3@@ -1344,14 +1349,138 @@ static void git_imap_config(void)git_config_get_string ("imap.authmethod" , &server.auth_method); } -int main (int argc,char **argv) -{ -struct strbuf all_msgs =STRBUF_INIT ; +static int append_msgs_to_imap (struct imap_server_conf *server,struct strbuf * all_msgs,int total) {
The opening brace sits on its own line by itself, so
Quoted 21 lines
imap-send.c +21
-0+#ifdef USE_CURL_FOR_IMAP_SEND +static CURL *setup_curl (struct imap_server_conf *srvc) +{ +CURL *curl; +struct strbuf path =STRBUF_INIT ; +struct strbuf auth =STRBUF_INIT ; + +if (curl_global_init (CURL_GLOBAL_ALL ) !=CURLE_OK ) +die ("curl_global_init failed" ); + + curl =curl_easy_init (); + +if (!curl) +die ("curl_easy_init failed" ); + +curl_easy_setopt (curl,CURLOPT_USERNAME , server.user); +curl_easy_setopt (curl,CURLOPT_PASSWORD , server.pass); + +strbuf_addstr (&path, server.host); +if (!path.len || path.buf[path.len -1 ] !='/' ) +strbuf_addch (&path,'/' );
imap-send.c static void git_imap_config(void) · line 1418
Quoted 10 lines
imap-send.c +10
-0+strbuf_addstr (&path, server.folder); + +curl_easy_setopt (curl,CURLOPT_URL , path.buf); +curl_easy_setopt (curl,CURLOPT_PORT , server.port); + +if (server.auth_method) { +strbuf_addstr (&auth,"AUTH=" ); +strbuf_addstr (&auth, server.auth_method); +curl_easy_setopt (curl,CURLOPT_LOGIN_OPTIONS , auth.buf); + }
Are path.buf and auth.buf leaked here, or does CURL *curl take possession of them by curl_easy_setopt() and not freeing them ourselves is the right thing to do? Assuming that is the case, perhaps we would want to use strbuf_detach() on &path and &auth to make it clear that is what is going on?
imap-send.c int main(int argc, char **argv) · line 1492
Quoted 13 lines
imap-send.c +4
-1+int main (int argc,char **argv) +{ +struct strbuf all_msgs =STRBUF_INIT ; +int total;int nongit_ok;git_extract_argv0_path (argv[0 ]);@@ -1360,12 +1489,18 @@ int main(int argc, char **argv)setup_git_directory_gently (&nongit_ok);git_imap_config (); - argc =parse_options (argc, (const char **)argv,"" , imap_send_options, imap_send_usage,0 );
Why?
Thanks.