Merge commit '79623d6'

Conflicts:
	lib/curl_transport/curltransaction.c

Author: ensc

Windows/UsingCURLinWin32.txt

@@ -1,128 +1,73 @@
-Background:
+Motivation:
 
-Let�s say you need to have a Xmlrpc-c client running as a service.
-In this situation you cannot use WinInet.  Details of the restriction
-can be found on the libcurl website or various Microsoft KB articles.
-The alternative is to use libcurl.  This document describes the steps
-required to use libcurl as your client XML transport mechanism.
+Let�s say you need to have a Xmlrpc-c client running as a service.  In this
+situation you cannot use WinInet.  You can find details of the restriction on
+the Curl website or various Microsoft KB articles.  Your alternative is to use
+the Curl HTTP client library.  This document tells how to use use the Curl
+library instead of the default Wininet as your client XML transport mechanism.
 
 Overview:
 
-The default projects in Xmlrpc-c create standalone executables that do
-not require other DLL�s (release mode).  While the case can be made
-for this behavior pro and con, it is beyond this document to justify
-it.  Therefore, we need to create static link libraries for libcurl
-that mimics this behavior.  Once the link libraries are created, we
-can then add them (plus the requisite curl headers) into the Xmlrpc-c
-project.  Finally, we enable the compilation of the curl transport
-file and tell Xmlrpc-c that we will be using curl.  Lastly, we build
-and test the project.
-
-Steps to use CURL with Win32 Xmlrpc-c:
-
-1. Download the CURL source.  In the �include� folder of the
-CURL distribution, copy the curl directory to the �lib�
-directory of xmlrpc-c.  When you are done with this step, you should
-have a curl.h file located in the directory xmlrpc-c\lib\curl\.  The
-xmlrpc project looks in this relative path for the necessary headers.
-
-2. In the CURL distribution, lib directory, is a file called
-Makefile.vc6.  Edit this file.  The line starting with CCNODBG should
-be changed to:
-
-CCNODBG    = cl.exe /MT /O2 /DNDEBUG
-
-The /MT option links with the Multithreaded non-dll version of the c
-runtime.  If this change is not made, the project will not link, as
-this is the default setting for the Xmlrpc-c projects.
-
-3. Open a command prompt window and run the vcvars32.bat file in your
-Visual C++ distribution.  If you are using Studio 2002 or 2003, use
-the �Visual Studio Command Prompt� from the Start menu to open
-the console.
-
-4. Compile release and debug mode libraries.  For the purposes of this
-tutorial, we are going to build only the curl library without ssl or
-zlib compression capability.  In the command prompt, navigate to the
-curl\lib directory and execute the following commands:
-
-nmake -f Makefile.vc6 CFG=debug RTLIBCFG=static
-nmake -f Makefile.vc6 CFG=release RTLIBCFG=static
-
-5. The above step should have generated two static link libraries in
-the curl\lib directory: libcurl.lib and libcurld.lib.  Copy these
-files into the root of the xmlrpc-c\lib\ directory.  This step ends
-our involvement with the actual CURL distribution.  The remainder of
-the steps are for Xmlrpc-c.
-
-6. Open the Xmlrpc-c Visual Studio workspace (Instructions for VC++ 6,
-other versions are slightly different).  In File View, expand the
-xmlrpc project.  Under "Source Files" there is an entry for
-xmlrpc_curl_transport.c This is not included in any build paths by
-default.  To enable it for compilation, right click the file to change
-the settings.  In the dropdown, select "All Configurations."  Pick the
-General tab and uncheck the "Exclude File From Build" setting.  Press
-OK to save your changes to the project.
-
-7.  In the "Header Files" section of the xmlrpc project is a file
-called "transport_config.h".  Edit this file to set the
-MUST_BUILD_CURL_CLIENT to 1, and if you wish to change the default
-transport to curl, change the XMLRPC_DEFAULT_TRANSPORT to "curl".
-
-8. Compile and test one or more of the sample client projects.
-
-USING MSVC8 - 2007/11/25
-========================
-
-This is for MSVC8, but most will apply to all version of Microsoft
-Visual Studio.
-
-Download the CURL source. Run the buildconf.bat to generate some
-additional files. This builds a 'dummy' hugehelp.c, but it can also
-be built using the src\mkhelp.pl Perl script. You may have to build
-you own VCPROJ file for CURL, if you want to use MSVC. It does
-provide a Makefile.vc6 as mentioned above.
+The default projects in Xmlrpc-c create standalone executables that do not
+require other DLL�s.  Therefore, we need to create static link libraries for
+libcurl.  Once we create the link libraries, we add them (plus the requisite
+curl headers) into the Xmlrpc-c project.  Finally, we configure the build to
+build the curl transport and build client libraries that use it.  Finally, we
+build and test the project.
+
+
+BUILD THE CURL LIBRARY
+----------------------
+
+Download the Curl source code.  Run the buildconf.bat to generate some
+additional files.  This builds a 'dummy' hugehelp.c, but it can also be built
+using the src\mkhelp.pl Perl script. You may have to build your own VCPROJ
+file for CURL, if you want to use MSVC.
 
 To build all the CURL library variations, use
-> nmake /nologo vc-all 
+
+  > nmake /nologo vc-all 
+
 but note this will use the /MD[d] DLL runtime. Only by adding
 RTCFGLIB=static to each of the makefile commands will /MT[d] be
 used.
 
-Essentially, for building the static Debug or Release CURL libraries,
-it is all the sources in the curl\lib folder. Make sure you choose /MT
-and /MTd for the runtime, and build both using say the name libcurl.lib.
+Essentially, for building the static Debug or Release CURL libraries, it is
+all the sources in the curl\lib folder. Make sure you choose /MT and /MTd for
+the runtime, and build both using the name 'libcurl.lib'.
 
-When you have Debug\libcurl.lib and Release\libcurl.lib built, you
-are ready to build and link them with Xmlrpc-c.
 
-After running xmlrpc-c\Windows\configurewin32.bat, loading xmlrpc.dsw
-will convert all the projects to VCPROJ files. In the File View, in
-the xmlrpc project, in the properties of xmlrpc_curl_transport.c,
-change 'Exclude file from build' from 'yes' to 'no', for Debug
-and Release.
+BUILD XMLRPC-C, LINK WITH CURL
+------------------------------
+
+From the step above, you have Debug\libcurl.lib and Release\libcurl.lib.
+
+After running xmlrpc-c\Windows\configurewin32.bat, start Visual Studio.
+
+In the File View, in the 'xmlrpc' project, in the properties of
+xmlrpc_curl_transport.c, change "Exclude file from build" from "yes" to "no",
+for Debug and Release.  ==>BUT NOTE: as late as Xmlrpc-c 1.30, this is
+broken - there is no xmlrpc_curl_transport.c in the projects.  You need to
+add it.  If you do, please send your changes to the Xmlrpc-c maintainer to
+help the next person.
 
 In the 'Header Files' section, open the "transport_config.h" file,
 and change MUST_BUILD_CURL_CLIENT to 1, and the XMLRPC_DEFAULT_TRANSPORT
-to "curl", if desired.
-
-As usual, for each of the 'client' projects, and rpctest, in the properties,
-Linker section, you can add the library libcurl.lib on the Input tab, and
-the relative path to the library in the General tab to something like -
-..\..\curl\Debug and ..\..\curl\Release, or where ever you built or
-copied these static libraries too.
+to "curl", if you want.
 
-Or you can adjust the Windows/curlink.h, to directly point to your
-respective Debug and Release static CURL libraries, either where you
-built them, or where you copied them too.
+As usual, for each of the "client" projects, and 'rpctest', in the properties,
+Linker section, you can add the library libcurl.lib on the Input tab, and the
+relative path to the library in the General tab to something like -
+..\..\curl\Debug and ..\..\curl\Release (or wherever you placed the static
+Curl libraries you built if you didn't follow recommendations above).
 
-Now, Xmlrpc-c should build using the CURL transport.
+Or you can adjust the Windows/curlink.h, to directly point to your respective
+Debug and Release static Curl libraries.
 
-Note, for the final linking, all RUNTIME libraries MUST be the SAME.
-A mixture of /MD and /MT will give big linkage problems. Any one project
-built with the alterate RUNTIME will show many items defined more than
-once. And of course, you can also NOT mix Debug with Release. That is
-/MDd with /MD, nor /MTd with /MT, or else there will be unresolved
-debug items.
+Now, Xmlrpc-c should build using the Curl transport.
 
-EOF
+Note, for the final linking, all libraries must be linked the same.  A mixture
+of /MD and /MT will give big linkage problems. Any one project built with the
+alterate library will show many items defined more than once. And of course,
+you also cannot mix Debug with Release. That is /MDd with /MD, nor /MTd with
+/MT.  Otherwise, there will be unresolved debug items.

Windows/project/vs2008/xmlrpc.vcproj

@@ -678,10 +678,6 @@
 				RelativePath="..\..\..\src\xmlrpc_array.c"
 				>
 			</File>
-			<File
-				RelativePath="..\..\..\src\xmlrpc_base64.c"
-				>
-			</File>
 			<File
 				RelativePath="..\..\..\src\xmlrpc_build.c"
 				>

Windows/xmlrpc_win32_config.h

@@ -239,4 +239,11 @@
   #define XMLRPC_S_IRUSR S_IRUSR
 #endif
 
+
+#if MSVCRT
+  #define XMLRPC_CHDIR _chdir
+#else
+  #define XMLRPC_CHDIR chdir
+#endif
+
 #endif

common.mk

@@ -493,6 +493,13 @@ endif
 $(TARGET_MODS:%=%.o) $(TARGET_MODS:%=%.osh): \
   $(BLDDIR)/include/xmlrpc-c/config.h
 
+ifneq ($(OMIT_XMLRPC_LIB_RULE),Y)
+$(BLDDIR)/src/libxmlrpc_client.cflags:
+	$(MAKE) -C $(dir $@) -f $(SRCDIR)/src/Makefile $(notdir $@)
+$(BLDDIR)/src/libxmlrpc_client.ldflags:
+	$(MAKE) -C $(dir $@) -f $(SRCDIR)/src/Makefile $(notdir $@)
+endif
+
 # With a separate build directory, you have to make the directory itself
 # before you can make anything in it.  Here's the rule to do that.
 $(SUBDIRS:%=$(CURDIR)/%):

config.mk.in

@@ -322,6 +322,17 @@ ifeq ($(patsubst cygwin%,cygwin,$(HOST_OS)),cygwin)
   LDFLAGS_SHLIB = -shared -Wl,-soname,$(SONAME) $(SHLIB_CLIB)
 endif
 
+ifeq ($(patsubst mingw32%,mingw32,$(HOST_OS)),mingw32)
+  SHARED_LIB_TYPE = dll
+  MUST_BUILD_SHLIB = Y
+  MUST_BUILD_SHLIBLE = N
+  SHLIB_SUFFIX = dll
+  shlibfn = $(1:%=%.$(SHLIB_SUFFIX))
+  shliblefn = $(1:%=%.$(SHLIB_SUFFIX))
+  LDFLAGS_SHLIB = -shared -Wl,-soname,$(SONAME) $(SHLIB_CLIB)
+  MSVCRT = yes
+endif
+
 ##############################################################################
 #                     MISCELLANEOUS
 ##############################################################################

examples/Makefile

@@ -31,21 +31,26 @@ CLIENTPROGS = \
   xmlrpc_asynch_client \
 
 ifeq ($(MUST_BUILD_CURL_CLIENT),yes)
-  CLIENTPROGS += interrupted_client
+  ifneq ($(MSVCRT),yes)
+    CLIENTPROGS += interrupted_client
+  endif
 endif
 
 SERVERPROGS_CGI = \
   xmlrpc_sample_add_server.cgi
 
 SERVERPROGS_ABYSS = \
   compound_value_server \
-  interrupted_server \
   xmlrpc_inetd_server \
   xmlrpc_socket_server \
   xmlrpc_loop_server \
   xmlrpc_sample_add_server \
   xmlrpc_server_validatee \
 
+ifneq ($(MSVCRT),yes)
+  SERVERPROGS_ABYSS += interrupted_server
+endif
+
 BASIC_PROGS = \
   json \
   gen_sample_add_xml \

examples/cpp/callinfo_abyss_server.cpp

@@ -19,9 +19,11 @@
 #include <stdexcept>
 #include <iostream>
 #include <unistd.h>
+#include <stdio.h>
+#ifndef _WIN32
 #include <sys/socket.h>
 #include <netinet/in.h>
-#include <stdio.h>
+#endif
 
 #include <xmlrpc-c/base.hpp>
 #include <xmlrpc-c/registry.hpp>
@@ -63,14 +65,26 @@ tcpAddrFromSockAddr(struct sockaddr const sockAddr) {
 
 
 
-static std::string
+/* On Windows, we have struct abyss_win_chaninfo, while on Unix we have
+   struct abyss_unix_chaninfo, but for what we're doing here, they're
+   fungible -- we use only members that exist in both.  So we refer to the
+   generically with macro CHANINFO_TYPE.
+*/
+
+#ifdef _WIN32
+  #define CHANINFO_TYPE abyss_win_chaninfo
+#else
+  #define CHANINFO_TYPE abyss_unix_chaninfo
+#endif
+
+static string
 rpcIpAddrMsg(xmlrpc_c::callInfo_serverAbyss const& callInfo) {
 
     void * chanInfoPtr;
     SessionGetChannelInfo(callInfo.abyssSessionP, &chanInfoPtr);
 
-    struct abyss_unix_chaninfo * const chanInfoP(
-        static_cast<struct abyss_unix_chaninfo *>(chanInfoPtr));
+    struct CHANINFO_TYPE * const chanInfoP(
+        static_cast<struct CHANINFO_TYPE *>(chanInfoPtr));
 
     struct tcpPortAddr const tcpAddr(tcpAddrFromSockAddr(chanInfoP->peerAddr));
 
@@ -83,7 +97,7 @@ rpcIpAddrMsg(xmlrpc_c::callInfo_serverAbyss const& callInfo) {
             tcpAddr.ipAddr[3],
             tcpAddr.portNumber);
 
-    return std::string(msg);
+    return string(msg);
 }
 
 

examples/cpp/pstream_client.cpp

@@ -42,10 +42,12 @@ main(int argc, char **) {
         exit(1);
     }
 
+#ifndef _WIN32
     // It's a good idea to disable SIGPIPE signals; if server closes his end
     // of the pipe/socket, we'd rather see a failure to send a call than
     // get killed by the OS.
     signal(SIGPIPE, SIG_IGN);
+#endif
 
     try {
         xmlrpc_c::clientXmlTransport_pstream myTransport(

examples/cpp/pstream_inetd_server.cpp

@@ -17,7 +17,7 @@
      $ socketexec -accept -local_port=8080 ./pstream_inetd_server
 */
 
-#ifndef WIN32
+#ifndef _WIN32
 #include <unistd.h>
 #endif
 #include <cassert>
@@ -59,10 +59,12 @@ int
 main(int           const, 
      const char ** const) {
 
+#ifndef _WIN32
     // It's a good idea to disable SIGPIPE signals; if client closes his end
     // of the pipe/socket, we'd rather see a failure to send a response than
     // get killed by the OS.
     signal(SIGPIPE, SIG_IGN);
+#endif
 
     try {
         xmlrpc_c::registry myRegistry;

examples/cpp/pstream_serial_server.cpp

@@ -58,10 +58,12 @@ int
 main(int           const, 
      const char ** const) {
 
+#ifndef _WIN32
     // It's a good idea to disable SIGPIPE signals; if client closes his end
     // of the pipe/socket, we'd rather see a failure to send a response than
     // get killed by the OS.
     signal(SIGPIPE, SIG_IGN);
+#endif
 
     try {
         xmlrpc_c::registry myRegistry;

examples/cpp/xmlrpc_inetd_server.cpp

@@ -24,7 +24,7 @@
 
 #define WIN32_LEAN_AND_MEAN  /* required by xmlrpc-c/server_abyss.hpp */
 
-#ifndef WIN32
+#ifndef _WIN32
 #  include <unistd.h>
 #endif
 #include <cassert>

examples/cpp/xmlrpc_sample_add_server.cpp

@@ -3,7 +3,7 @@
 #include <cassert>
 #include <stdexcept>
 #include <iostream>
-#ifdef WIN32
+#ifdef _WIN32
 #  include <windows.h>
 #else
 #  include <unistd.h>
@@ -15,7 +15,7 @@
 
 using namespace std;
 
-#ifdef WIN32
+#ifdef _WIN32
   #define SLEEP(seconds) SleepEx(seconds * 1000);
 #else
   #define SLEEP(seconds) sleep(seconds);