# $Id$

## @file

# Sub-Makefile for the VBox web service.

#

# Warning! This is a seriously complicated makefile!

#

#

# Copyright (C) 2006-2010 Oracle Corporation

#

# This file is part of VirtualBox Open Source Edition (OSE), as

# available from http://www.virtualbox.org. This file is free software;

# you can redistribute it and/or modify it under the terms of the GNU

# General Public License (GPL) as published by the Free Software

# Foundation, in version 2 as it comes in the "COPYING" file of the

# VirtualBox OSE distribution. VirtualBox OSE is distributed in the

# hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.

#

# Define VBOX_GSOAP_INSTALLED to something if you have gSOAP's

# "wsdl2h" and "soapcpp2" executables on your PATH somewhere.

#

# Here's an overview how all this works. It's complicated. Essentially,

# lots of files get generated automatically from our XML XIDL file that

# describes the VirtualBox API (../idl/VirtualBox.xidl); as a result,

# no manual coding is necessary when the API changes. All generated

# web service code gets adjusted automatically.

#

# In more detail:

#

# 1) We use xsltproc and websrv-wsdl.xsl to generate a WSDL file from

# our XML IDL file. WSDL (Web Service Description language) is an XML

# industry standard that publicly describes a web service.

# So, the WSDL generated here describes the VirtualBox web

# service to third-party clients; for example, one can feed it to

# Java or Perl or some other toolkit that understands WSDL and thus

# easily write a short script that connects to the web service properly.

# This WSDL file ends up in $(VBOXWEB_OUT_DIR)/vboxweb.wsdl.

#

# 2) We use xsltproc and websrv-wsdl2gsoapH.xsl to generate a so-called

# "gSoap header file": $(VBOXWEB_OUT_DIR)/gsoapH_from_xslt.h from

# the WSDL previously generated.

# This file looks like a C header file, but really isn't meant

# to be included by a C compiler. Instead, it just happens to be the

# format that gSOAP uses to specify SOAP interfaces instead of WSDL.

# (The reason for this appears to be that gSOAP predates WSDL and

# thus needed some format to describe the syntax of a web service.)

#

# Note that gSOAP now also comes with its own WSDL-to-gsoap.h converter,

# but the readme mentions some funny license restrictions, so instead we

# have our own converter in XSLT.

#

# 3) We then feed that pseudo-header file to gSOAP's soapcpp2 compiler,

# which generates a ton of files in $(VBOXWEB_OUT_DIR), most importantly:

#

# SOAP_CLIENT_H = $(VBOXWEB_OUT_DIR)/soapStub.h (header file for webservice clients)

# SOAP_SERVER_H = $(VBOXWEB_OUT_DIR)/soapH.h (header file for webservice servers)

#

# These are "real" header files that one can use to program a) a webservice client

# and b) a webservice server. Of course to build b) one will have to write method

# implementations with useful code that does something. This is where more

# code generation via XSLT comes in:

#

# 4) We use xsltproc to generate tons of C++ code directly from the XIDL that

# maps each SOAP method to our COM methods. This large C++ file is

# $(VBOXWEB_OUT_DIR)/methodmaps.cpp. The actual webservice executable (vboxwebsrv,

# which acts as an HTTP server) is composed of this file, plus hard-coded

# method implementations in vboxweb.cpp, plus gSOAP library code for the HTTP

# server.

#

SUB_DEPTH = ../../../..

include $(KBUILD_PATH)/subheader.kmk

#

# Find the gSOAP toolkit.

#

# Note! We're not using the gSOAP toolkit correctly. The main issue is that

# compiling soapcpp2.cpp instead of using the library. So, in order

# to make this work with a locally installed gSOAP toolkit there are

# some hoops to jump thru to say the least... Shipping soapcpp2.cpp/h

# is out of the question without also including the two soap tools.

#

# Some observations on distros for OSE / configure:

# The proposed gentoo ebuild screws up several things in the install phase

# and thus fails to ship stdsoap2.cpp and relatives.

#

# debian (2.7.9l-0.2) stuffs stdsoap2.cpp and a handful of the import files

# into /usr/include/gsoap.

#

# fedora (2.7.12-fc10.x86_64) uses the default install layout and does not

# ship stdsoap2.cpp and friends.

#

ifeq ($(VBOX_GSOAP_INSTALLED),)

VBOX_GSOAP_INSTALLED = 1

VBOX_PATH_GSOAP := $(lastword $(sort $(wildcard $(KBUILD_DEVTOOLS)/common/gsoap/*)))

ifeq ($(VBOX_PATH_GSOAP),)

VBOX_PATH_GSOAP := $(lastword $(sort $(wildcard $(KBUILD_DEVTOOLS_HST)/gsoap/*)))

endif

if "$(VBOX_PATH_GSOAP)" == "" && defined(KBUILD_DEVTOOLS_HST)

VBOX_PATH_GSOAP := $(lastword $(sort $(wildcard $(KBUILD_DEVTOOLS_HST_ALT)/gsoap/*)))

endif

ifeq ($(VBOX_PATH_GSOAP),)

$(warning VBOX_PATH_GSOAP not found...)

VBOX_GSOAP_INSTALLED =

endif

else

VBOX_PATH_GSOAP := $(VBOX_PATH_GSOAP)

endif

VBOX_PATH_GSOAP_BIN := $(strip $(VBOX_PATH_GSOAP_BIN))

if "$(VBOX_PATH_GSOAP_BIN)" == ""

VBOX_PATH_GSOAP_BIN := $(VBOX_PATH_GSOAP)/bin

if "$(KBUILD_HOST)" == "darwin"

VBOX_PATH_GSOAP_BIN := $(VBOX_PATH_GSOAP_BIN)/macosx

else if "$(KBUILD_HOST)" == "win"

VBOX_PATH_GSOAP_BIN := $(VBOX_PATH_GSOAP_BIN)/win32

else if "$(KBUILD_HOST)" == "linux"

VBOX_PATH_GSOAP_BIN := $(VBOX_PATH_GSOAP_BIN)/linux386

else

VBOX_PATH_GSOAP_BIN := $(VBOX_PATH_GSOAP_BIN)/$(KBUILD_HOST).x86

endif

if !exists($(VBOX_PATH_GSOAP_BIN))

VBOX_PATH_GSOAP_BIN := $(VBOX_PATH_GSOAP)/bin

endif

endif

VBOX_SOAPCPP2 := $(VBOX_PATH_GSOAP_BIN)/soapcpp2$(HOSTSUFF_EXE)

VBOX_WSDL2H := $(VBOX_PATH_GSOAP_BIN)/wsdl2h$(HOSTSUFF_EXE)

VBOX_STUBMAKER = $(firstword $(which stubmaker stubmaker.pl) stubmaker_not_found)

VBOX_WSDL2PY = $(firstword $(which wsdl2py) wsdl2py_not_found)

VBOX_PATH_GSOAP_IMPORT := $(strip $(if $(VBOX_PATH_GSOAP_IMPORT),$(VBOX_PATH_GSOAP_IMPORT),$(VBOX_PATH_GSOAP)/import))

VBOX_GSOAP_INCS := $(strip $(if $(VBOX_GSOAP_INCS),$(VBOX_GSOAP_INCS),$(VBOX_PATH_GSOAP) $(VBOX_PATH_GSOAP_IMPORT) ))

# note: $(if $(defined FOO)) does not work here!

VBOX_GSOAP_CXX_SOURCES := $(strip $(if-expr "$(origin VBOX_GSOAP_CXX_SOURCES)" != "undefined",$(VBOX_GSOAP_CXX_SOURCES),$(VBOX_PATH_GSOAP)/stdsoap2.cpp))

VBOX_GSOAP_CXX_LIBS := $(strip $(if-expr "$(origin VBOX_GSOAP_CXX_LIBS)" != "undefined",$(VBOX_GSOAP_CXX_LIBS),))

#

# Globals

#

VBOXWEB_OUT_DIR := $(PATH_TARGET)/webservice

BLDDIRS += $(VBOXWEB_OUT_DIR)

# The webservice location

VBOX_PATH_WEBSERVICE := $(PATH_SUB_CURRENT)

# If this is set, all webservice files are considered out-of-date every time

# this makefile is touched. Otherwise, set this to empty.

RECOMPILE_ON_MAKEFILE_CURRENT := $(MAKEFILE_CURRENT)

PATH_TARGET_SOAPDEMOXML := $(VBOXWEB_OUT_DIR)/demo_soapxml

PATH_TARGET_SOAPDEMOHEADERS := $(VBOXWEB_OUT_DIR)/demo_headers

PATH_TARGET_SOAPDEMONSMAPS := $(VBOXWEB_OUT_DIR)/demo_namespacemaps

PATH_TARGET_WEBTEST := $(VBOXWEB_OUT_DIR)/webtest

# platform-specific XIDL file generated from $(VBOXWEB_IDL_SRC):

VBOXWEB_IDL_SRC_ORIG := $(VBOX_XIDL_FILE)

# the original XIDL file:

VBOXWEB_IDL_SRC := $(VBOXWEB_OUT_DIR)/VirtualBox.xidl

VBOXWEB_WSDL = $(VBOX_PATH_SDK)/bindings/webservice/vboxweb.wsdl

VBOXWEBSERVICE_WSDL = $(VBOX_PATH_SDK)/bindings/webservice/vboxwebService.wsdl

VBOXWEB_TYPEMAP := $(VBOXWEB_OUT_DIR)/typemap.dat

VBOXWEB_GSOAPH_FROM_XSLT := $(VBOXWEB_OUT_DIR)/gsoapH_from_xslt.h

ifdef VBOX_GSOAP_INSTALLED

VBOXWEB_GSOAPH_FROM_GSOAP := $(VBOXWEB_OUT_DIR)/gsoapH_from_gsoap.h

else

VBOXWEB_GSOAPH_FROM_GSOAP :=

endif

VBOXWEB_SOAP_CLIENT_H := $(VBOXWEB_OUT_DIR)/soapStub.h

VBOXWEB_SOAP_SERVER_H := $(VBOXWEB_OUT_DIR)/soapH.h

ifdef VBOX_GSOAP_VERBOSE

VBOXWEB_XSLTPROC_VERBOSE = --stringparam G_argDebug '1'

VBOXWEB_WSDL_VERBOSE = -v

else

VBOXWEB_SOAPCPP2_SKIP_FILES = -x

endif

## @todo VBOXWEB_GSOAPH_FROM_XSLT should probably be a indirect dep of something.

VBOXWEB_OTHERS += \

$(VBOXWEB_GSOAPH_FROM_XSLT)

ifdef VBOX_GSOAP_INSTALLED

ifndef VBOX_ONLY_SDK

#

# vboxsoap - Library used by both the programs (save build time).

#

LIBRARIES += vboxsoap

vboxsoap_TEMPLATE = VBOXR3EXE

ifdef VBOX_USE_VCC80

vboxsoap_CXXFLAGS.win += -bigobj

endif

ifn1of ($(KBUILD_TARGET), win)

vboxsoap_CXXFLAGS += -Wno-shadow

endif

vboxsoap_INCS := \

$(VBOX_GSOAP_INCS) \

$(VBOXWEB_OUT_DIR) \

$(PATH_SUB_CURRENT)

ifdef VBOX_WITHOUT_SPLIT_SOAPC

vboxsoap_SOURCES = \

$(VBOXWEB_OUT_DIR)/soapC.cpp

else

BLDPROGS += split-soapC

split-soapC_TEMPLATE = VBOXBLDPROG

split-soapC_SOURCES = split-soapC.cpp

vboxsoap_SOURCES = \

$(VBOXWEB_OUT_DIR)/soapC-1.cpp \

$(VBOXWEB_OUT_DIR)/soapC-2.cpp \

$(VBOXWEB_OUT_DIR)/soapC-3.cpp \

$(VBOXWEB_OUT_DIR)/soapC-4.cpp \

$(VBOXWEB_OUT_DIR)/soapC-5.cpp \

$(VBOXWEB_OUT_DIR)/soapC-6.cpp \

$(VBOXWEB_OUT_DIR)/soapC-7.cpp \

$(VBOXWEB_OUT_DIR)/soapC-8.cpp \

$(VBOXWEB_OUT_DIR)/soapC-9.cpp \

$(VBOXWEB_OUT_DIR)/soapC-10.cpp \

$(VBOXWEB_OUT_DIR)/soapC-11.cpp \

$(VBOXWEB_OUT_DIR)/soapC-12.cpp \

$(VBOXWEB_OUT_DIR)/soapC-13.cpp \

$(VBOXWEB_OUT_DIR)/soapC-14.cpp \

$(VBOXWEB_OUT_DIR)/soapC-15.cpp \

$(VBOXWEB_OUT_DIR)/soapC-16.cpp \

$(VBOXWEB_OUT_DIR)/soapC-17.cpp \

$(VBOXWEB_OUT_DIR)/soapC-18.cpp \

$(VBOXWEB_OUT_DIR)/soapC-19.cpp \

$(VBOXWEB_OUT_DIR)/soapC-20.cpp

endif

vboxsoap_CLEAN := $(vboxsoap_SOURCES) # lazy bird

vboxsoap_SOURCES += \

$(VBOX_GSOAP_CXX_SOURCES)

vboxsoap_ORDERDEPS = \

$(VBOXWEB_IDL_SRC) \

$(VBOXWEB_OUT_DIR)/gsoap_copy_all_ts

ifn1of ($(KBUILD_TARGET), win)

$(VBOX_GSOAP_CXX_SOURCES)_CXXFLAGS = -Wno-format

endif

$(VBOXWEB_OUT_DIR)/soapC-3.cpp_CXXFLAGS.win.x86 = -Og- # VCC70 says "function too large".

ifdef VBOX_SOAP_PRECOMPILED_HEADER

# This'll save a few seconds, but the compiler invocation currently makes it impracticable. This will

# be addressed in a future kBuild version, by adding PCH support or/and by adding some helpers to

# gather the required data (DEFS,INCS,CXXTOOL,CXXFLAGS).

vboxsoap_INTERMEDIATES += $(VBOXWEB_OUT_DIR)/soapH.h.gch

vboxsoap_CXXFLAGS += -Winvalid-pch -H

vboxsoap_CLEAN += $(VBOXWEB_OUT_DIR)/soapH.h.gch

$(VBOXWEB_OUT_DIR)/soapH.h.gch: $(VBOXWEB_OUT_DIR)/soapH.h

g++ -x c++-header -g -g -Wall -pedantic -Wno-long-long -Wno-trigraphs -Wno-variadic-macros -pipe -O0 -fno-omit-frame-pointer -fno-strict-aliasing -fvisibility-inlines-hidden -fvisibility=hidden -DVBOX_HAVE_VISIBILITY_HIDDEN -mmacosx-version-min=10.4 -isysroot /Developer/SDKs/MacOSX10.4u.sdk -m32 -I/Volumes/ScratchHFS/bird/vbox/svn/trunk/src/VBox/Main/webservice/gsoap -I/Volumes/ScratchHFS/bird/vbox/svn/trunk/out/darwin.x86/debug/obj/src/VBox/Main -I/Volumes/ScratchHFS/bird/vbox/svn/trunk/src/VBox/Main/webservice -I/Volumes/ScratchHFS/bird/vbox/svn/trunk/include -I/Volumes/ScratchHFS/bird/vbox/svn/trunk/out/darwin.x86/debug -DVBOX -DVBOX_WITH_DEBUGGER -DVBOX_WITH_DEBUGGER_GUI -DDEBUG -DDEBUG_bird -DDEBUG_USERNAME=bird -DRT_OS_DARWIN -D__DARWIN__ -DRT_ARCH_X86 -D__X86__ -DVBOX_WITH_HYBRID_32BIT_KERNEL -DIN_RING3 -DHC_ARCH_BITS=32 -DGC_ARCH_BITS=32 -DMAC_OS_X_VERSION_MIN_REQUIRED=1040 -DMAC_OS_X_VERSION_MAX_ALLOWED=1040 \

$< -o $@

endif

endif # !VBOX_ONLY_SDK

ifndef VBOX_ONLY_SDK

#

# vboxwebsrv - webservice server process

#

PROGRAMS += vboxwebsrv

vboxwebsrv_TEMPLATE = VBOXMAINCLIENTEXE

vboxwebsrv_DEFS += SOCKET_CLOSE_ON_EXEC

vboxwebsrv_INCS = \

$(VBOX_GSOAP_INCS) \

$(VBOXWEB_OUT_DIR) \

.

ifdef VBOX_USE_VCC80

vboxwebsrv_CXXFLAGS.win += -bigobj

endif

ifn1of ($(KBUILD_TARGET), win)

vboxwebsrv_CXXFLAGS += -Wno-shadow

endif

vboxwebsrv_LIBS += \

$(PATH_STAGE_LIB)/vboxsoap$(VBOX_SUFF_LIB) \

$(VBOX_GSOAP_CXX_LIBS)

vboxwebsrv_LIBS.solaris += socket nsl

vboxwebsrv_SOURCES = \

vboxweb.cpp \

$(VBOXWEB_OUT_DIR)/methodmaps.cpp \

$(VBOXWEB_OUT_DIR)/soapServer.cpp

vboxwebsrv_CLEAN = \

$(VBOXWEB_OUT_DIR)/methodmaps.cpp \

$(VBOXWEB_OUT_DIR)/soapServer.cpp

vboxweb.cpp_DEFS = \

VBOX_BUILD_TARGET=\"$(KBUILD_TARGET).$(KBUILD_TARGET_ARCH)\" \

$(if $(VBOX_BLEEDING_EDGE),VBOX_BLEEDING_EDGE=\"$(VBOX_BLEEDING_EDGE)\",)

vboxwebsrv_ORDERDEPS = $(VBOXWEB_OUT_DIR)/gsoap_copy_all_ts

endif # !VBOX_ONLY_SDK

ifdef VBOX_WITH_JWS

INSTALLS += VBoxJWs-inst-jar

#

# Java glue JAR files

#

VBOX_JWS_JAR = $(VBoxJWs-inst-jar_0_OUTDIR)/vboxjws.jar

VBOX_JWS_TARGET := $(PATH_TARGET)/vboxjws-gen

VBOX_JWS_GEN = $(VBOX_JWS_TARGET)/jwsgen

VBOX_JWS_JDEST := $(VBOX_JWS_TARGET)/jdest

VBOX_GLUE_XSLT_DIR := $(PATH_ROOT)/src/VBox/Main/glue

VBOX_JAXLIB_DIR := $(PATH_ROOT)/src/VBox/Main/webservice/jaxlibs

VBoxJWs-inst-jar_INST = $(INST_SDK)bindings/webservice/java/jax-ws/

VBoxJWs-inst-jar_SOURCES = \

$(VBOX_JWS_JAR)

VBoxJWs-inst-jar_CLEAN = \

$(VBOX_JWS_JAR) \

$(VBOX_JWS_GEN)/jwsglue.list \

$(wildcard \

$(VBOX_JWS_GEN)/java/*.java \

$(VBOX_JWS_GEN)/java/jws/*/*/*/*.java \

$(VBOX_JWS_JDEST)/*.class \

$(VBOX_JWS_JDEST)/*/*.class \

$(VBOX_JWS_JDEST)/*/*/*.class \

$(VBOX_JWS_JDEST)/*/*/*/*.class \

)

VBoxJWs-inst-jar_BLDDIRS += $(VBOX_JWS_GEN)/java $(VBOX_JWS_GEN)/java/jws

$(VBOX_JWS_GEN)/jwsglue.list: \

$(VBOX_XIDL_FILE) \

$(VBOX_GLUE_XSLT_DIR)/glue-java.xsl \

$(VBOX_FILESPLIT) \

$(VBOXWEBSERVICE_WSDL) \

| $(VBOX_JWS_GEN)/java/jws/

$(call MSG_L1,Generating JAX-WS Java glue files from XIDL)

$(RM) -f $(wildcard $(VBOX_JWS_GEN)/java/*.java) $(wildcard $(VBOX_JWS_GEN)/java/jws/*/*/*/*.java)

$(QUIET)$(VBOX_XSLTPROC) \

--stringparam G_vboxApiSuffix $(VBOX_API_SUFFIX) \

--stringparam G_vboxGlueStyle jaxws \

-o $(VBOX_JWS_GEN)/java/merged.file $(VBOX_GLUE_XSLT_DIR)/glue-java.xsl $<

$(QUIET)$(VBOX_FILESPLIT) $(VBOX_JWS_GEN)/java/merged.file $(VBOX_JWS_GEN)/java

$(call MSG_GENERATE,,$@,JAX-WS for Java 1.6 bindings using $(VBOXWEBSERVICE_WSDL))

$(VBOX_WSIMPORT) -Xnocompile -p $(VBOX_JAVA_PACKAGE).jaxws -d $(VBOX_JWS_GEN)/java/jws $(VBOXWEBSERVICE_WSDL)

$(QUIET)echo $(VBOX_JWS_GEN)/java/*.java > $@

$(QUIET)echo $(VBOX_JWS_GEN)/java/jws/*/*/*/*.java >> $@

$$(VBOX_JWS_JAR): $(VBOX_JWS_GEN)/jwsglue.list $(VBOXWEB_WSDL) $(VBOXWEBSERVICE_WSDL) | $$(dir $$@)

$(call MSG_TOOL,javac,$(notdir $@),jwsgen.list,)

$(QUIET)$(RM) -Rf $(VBOX_JWS_JDEST)

$(QUIET)$(MKDIR) -p $(VBOX_JWS_JDEST)

$(call MSG_L1,Compiling bridge code)

$(VBOX_JAVAC) $(VBOX_JAVAC_OPTS) \

@$(VBOX_JWS_GEN)/jwsglue.list \

-d $(VBOX_JWS_JDEST) -classpath $(VBOX_JWS_JDEST)

$(QUIET)$(SED) -e "s/vboxweb.wsdl/vboxweb$(VBOX_API_SUFFIX).wsdl/" < $(VBOXWEBSERVICE_WSDL) > $(VBOX_JWS_JDEST)/vboxwebService$(VBOX_API_SUFFIX).wsdl

$(QUIET)$(CP) -f $(VBOXWEB_WSDL) $(VBOX_JWS_JDEST)/vboxweb$(VBOX_API_SUFFIX).wsdl

$(call MSG_LINK,$(notdir $@),$@)

$(VBOX_JAR) cf $@ -C $(VBOX_JWS_JDEST) .

endif # VBOX_WITH_JWS

ifndef VBOX_ONLY_SDK

#

# webtest - webservice sample client in C++

#

PROGRAMS += webtest

webtest_TEMPLATE = VBOXR3EXE

ifdef VBOX_USE_VCC80

webtest_CXXFLAGS.win += -bigobj

endif

ifn1of ($(KBUILD_TARGET), win)

webtest_CXXFLAGS += -Wno-shadow

endif

webtest_INCS := \

$(VBOX_GSOAP_INCS) \

$(VBOXWEB_OUT_DIR) \

.

webtest_LIBS += \

$(PATH_STAGE_LIB)/vboxsoap$(VBOX_SUFF_LIB) \

$(VBOX_GSOAP_CXX_LIBS)

webtest_LIBS.solaris += nsl

webtest_SOURCES = \

webtest.cpp \

$(VBOXWEB_OUT_DIR)/soapClient.cpp

webtest_CLEAN = \

$(VBOXWEB_OUT_DIR)/soapClient.cpp

webtest_ORDERDEPS = $(VBOXWEB_OUT_DIR)/gsoap_copy_all_ts

endif # !VBOX_ONLY_SDK

#

# Additional mess to cleanup (applies to both webtest and vboxwebsrv).

#

## @todo figure out whether the SDK really needs this or not...

OTHER_CLEAN += \

$(wildcard $(VBOXWEB_OUT_DIR)/soap*.h) \

$(wildcard $(VBOXWEB_OUT_DIR)/soap*.cpp) \

$(wildcard $(VBOXWEB_OUT_DIR)/*.nsmap) \

$(VBOXWEB_GSOAPH_FROM_XSLT) \

$(VBOXWEB_GSOAPH_FROM_GSOAP) \

$(VBOXWEB_SOAP_CLIENT_H) \

$(VBOXWEB_SOAP_SERVER_H) \

$(VBOXWEB_OUT_DIR)/gsoap_generate_all_ts \

$(VBOXWEB_OUT_DIR)/gsoap_copy_all_ts \

$(wildcard $(PATH_TARGET_SOAPDEMOXML)/*) \

$(PATH_TARGET_SOAPDEMOXML)/dummy_file \

$(wildcard $(PATH_TARGET_SOAPDEMOHEADERS)/*) \

$(PATH_TARGET_SOAPDEMOHEADERS)/dummy_file \

$(wildcard $(PATH_TARGET_SOAPDEMONSMAPS)/*) \

$(PATH_TARGET_SOAPDEMONSMAPS)/dummy_file

endif # VBOX_GSOAP_INSTALLED

ifdef VBOX_ONLY_SDK

#

# Globals relevant to the SDK.

#

VBOXWEB_GLUE_PYTHON = $(VBOX_PATH_SDK)/bindings/webservice/python/lib/VirtualBox_wrappers.py

VBOXWEB_WS_PYTHON = $(VBOX_PATH_SDK)/bindings/webservice/python/lib/VirtualBox_services.py

VBOXWEB_WS_PERL = $(VBOX_PATH_SDK)/bindings/webservice/perl/lib/vboxService.pm

VBOXWEB_WS_PHP = $(VBOX_PATH_SDK)/bindings/webservice/php/lib/vboxServiceWrappers.php

VBOXWEB_SAMPLES_JAXWS_DIR = $(VBOX_PATH_SDK)/bindings/webservice/java/jax-ws/samples

VBOXWEB_JAXWSSAMPLE = $(VBOXWEB_SAMPLES_JAXWS_DIR)/clienttest.java

VBOXWEB_METRICSAMPLE = $(VBOXWEB_SAMPLES_JAXWS_DIR)/metrictest.java

VBOXWEB_GLUE_JAVA_TMP = $(VBOXWEB_OUT_DIR)/glue-jaxws.java.tmp

VBOXWEB_PATH_SDK_GLUE_JAVA = $(VBOX_PATH_SDK)/bindings/webservice/java/jax-ws/src

VBOXWEB_JAVALIB = $(VBOX_PATH_SDK)/bindings/webservice/java/jax-ws/lib

VBOXWEB_JAVA15_JAR = $(VBOXWEB_JAVALIB)/vboxws_java15.jar

VBOXWEB_JAVA16_JAR = $(VBOXWEB_JAVALIB)/vboxws_java16.jar

define find_java_files

$(shell find $(1) -name \*.java)

endef

VBOXWEB_OTHERS += \

$(VBOXWEB_GLUE_PYTHON) \

$(VBOXWEB_WS_PYTHON) \

$(VBOXWEB_WS_PERL) \

$(VBOXWEB_WS_PHP) \

$(VBOXWEB_PYTHONWSSAMPLE) \

$(PATH_ROOT)

#

# Install sample code.

#

INSTALLS += vboxwebinst

vboxwebinst_INST = $(INST_SDK)bindings/webservice/

vboxwebinst_MODE = a+rx,u+w

vboxwebinst_SOURCES = \

samples/perl/clienttest.pl=>perl/samples/clienttest.pl \

samples/php/clienttest.php=>php/samples/clienttest.php

INSTALLS += vboxwebinst_nox

vboxwebinst_nox_INST = $(INST_SDK)bindings/webservice/

vboxwebinst_nox_MODE = a+r,u+w

vboxwebinst_nox_SOURCES = \

samples/python/Makefile=>python/samples/Makefile \

samples/python/Makefile.glue=>python/lib/Makefile \

$(PATH_ROOT)/COPYING.LIB=>java/jax-ws/COPYING.LIB

endif # VBOX_ONLY_SDK

## @todo VBOXWEB_WSDL and VBOXWEBSERVICE_WSDL should be an install target.

VBOXWEB_OTHERS += \

$(VBOXWEB_WSDL) \

$(VBOXWEBSERVICE_WSDL)

#

# Update the OTHERS and OTHER_CLEAN lists with VBOXWEB_OTHERS and some more stuff.

#

# We can't just built up OTHERS and append it to OTHER_CLEAN because we're sharing

# OTHERS with all the other VBox makefiles, thus VBOXWEB_OTHERS.

#

OTHERS += $(VBOXWEB_OTHERS)

OTHER_CLEAN += \

$(VBOXWEB_OTHERS) \

$(VBOXWEB_TYPEMAP) \

$(VBOXWEB_IDL_SRC)

# generate platform-specific XIDL file from original XIDL file

$(VBOXWEB_IDL_SRC): $(VBOXWEB_IDL_SRC_ORIG) $(VBOX_PATH_WEBSERVICE)/platform-xidl.xsl | $$(dir $$@)

$(call MSG_GENERATE,,$@,$(VBOXWEB_IDL_SRC) using platform-xidl.xsl)

$(QUIET)$(VBOX_XSLTPROC) $(VBOXWEB_XSLTPROC_VERBOSE) -o $@ $(VBOX_PATH_WEBSERVICE)/platform-xidl.xsl $<

# generate WSDL from main XIDL file

$(VBOXWEB_WSDL): $(VBOXWEB_IDL_SRC) $(VBOX_PATH_WEBSERVICE)/websrv-wsdl.xsl $(VBOX_PATH_WEBSERVICE)/websrv-shared.inc.xsl $(RECOMPILE_ON_MAKEFILE_CURRENT) ## @todo | $$(dir $$@)

$(QUIET)$(MKDIR) -p $(@D)

$(call MSG_GENERATE,,$@,$(VBOXWEB_IDL_SRC) using websrv-wsdl.xsl)

$(QUIET)$(VBOX_XSLTPROC) $(VBOXWEB_XSLTPROC_VERBOSE) -o $@ $(VBOX_PATH_WEBSERVICE)/websrv-wsdl.xsl $<

$(VBOXWEBSERVICE_WSDL): $(VBOXWEB_IDL_SRC) $(VBOX_PATH_WEBSERVICE)/websrv-wsdl-service.xsl $(VBOX_PATH_WEBSERVICE)/websrv-shared.inc.xsl $(RECOMPILE_ON_MAKEFILE_CURRENT) ## @todo | $$(dir $$@)

$(QUIET)$(MKDIR) -p $(@D)

$(call MSG_GENERATE,,$@,$(VBOXWEB_IDL_SRC) using websrv-wsdl-service.xsl)

$(QUIET)$(VBOX_XSLTPROC) $(VBOXWEB_XSLTPROC_VERBOSE) -o $@ $(VBOX_PATH_WEBSERVICE)/websrv-wsdl-service.xsl $<

ifdef VBOX_ONLY_SDK

$(VBOXWEB_GLUE_PYTHON): $(VBOXWEB_IDL_SRC) $(VBOXWEB_WSDL) $(VBOXWEBSERVICE_WSDL) $(VBOX_PATH_WEBSERVICE)/websrv-python.xsl

$(call MSG_GENERATE,,$@,$(VBOXWEB_IDL_SRC) using websrv-python.xsl)

$(QUIET)$(MKDIR) -p $(@D)

$(QUIET)$(VBOX_XSLTPROC) $(VBOXWEB_XSLTPROC_VERBOSE) -o $@ $(VBOX_PATH_WEBSERVICE)/websrv-python.xsl $<

$(VBOXWEB_WS_PYTHON): $(VBOXWEB_WSDL) $(VBOXWEBSERVICE_WSDL)

$(call MSG_GENERATE,,$@, WS Python bindings)

$(QUIET)$(MKDIR) -p $(@D)

# Try both w/o and with --file option

$(QUIET)$(REDIRECT) -C $(@D) -- bash -c "$(VBOX_WSDL2PY) -b $(VBOXWEBSERVICE_WSDL) || $(VBOX_WSDL2PY) -b --file $(VBOXWEBSERVICE_WSDL)"

$(QUIET)$(APPEND) $@ ''

$(VBOXWEB_WS_PERL): $(VBOXWEB_WSDL) $(VBOXWEBSERVICE_WSDL)

$(call MSG_GENERATE,,$@, WS Perl bindings)

$(QUIET)$(MKDIR) -p $(@D)

$(QUIET)$(REDIRECT) -C $(@D) -- $(VBOX_STUBMAKER) file://$(VBOXWEBSERVICE_WSDL)

# Ugly, ugly, ugly, make me right once

$(QUIET)$(SED) -e "s+http://www.virtualbox.org/Service+http://www.virtualbox.org/+" < $(VBOXWEB_WS_PERL) > $(VBOXWEB_WS_PERL).tmp

$(QUIET)$(MV) $(VBOXWEB_WS_PERL).tmp $(VBOXWEB_WS_PERL)

$(QUIET)$(APPEND) $@ ''

$(VBOXWEB_WS_PHP): $(VBOXWEB_IDL_SRC) $(VBOX_PATH_WEBSERVICE)/websrv-php.xsl

$(call MSG_GENERATE,,$@,$(VBOXWEB_IDL_SRC) using websrv-php.xsl)

$(QUIET)$(MKDIR) -p $(@D)

$(QUIET)$(VBOX_XSLTPROC) $(VBOXWEB_XSLTPROC_VERBOSE) -o $@ $(VBOX_PATH_WEBSERVICE)/websrv-php.xsl $<

endif # VBOX_ONLY_SDK

# generate typemap.dat (used by wsdl2h) from main XIDL file

$(VBOXWEB_TYPEMAP): $(VBOXWEB_IDL_SRC) $(VBOX_PATH_WEBSERVICE)/websrv-typemap.xsl $(VBOX_PATH_WEBSERVICE)/websrv-shared.inc.xsl $(RECOMPILE_ON_MAKEFILE_CURRENT) | $$(dir $$@)

$(call MSG_GENERATE,,$@,$(VBOXWEB_IDL_SRC) using websrv-typemap.xsl)

$(QUIET)$(VBOX_XSLTPROC) $(VBOXWEB_XSLTPROC_VERBOSE) -o $@ $(VBOX_PATH_WEBSERVICE)/websrv-typemap.xsl $<

# generate gsoap pseudo-C header file from that WSDL; once via XSLT...

$(VBOXWEB_GSOAPH_FROM_XSLT): $(VBOXWEB_WSDL) $(VBOX_PATH_WEBSERVICE)/websrv-wsdl2gsoapH.xsl $(VBOX_PATH_WEBSERVICE)/websrv-shared.inc.xsl $(RECOMPILE_ON_MAKEFILE_CURRENT) | $$(dir $$@)

$(call MSG_GENERATE,,$@,$(VBOXWEB_WSDL) using websrv-wsdl2gsoapH.xsl)

$(QUIET)$(VBOX_XSLTPROC) $(VBOXWEB_XSLTPROC_VERBOSE) -o $@ $(VBOX_PATH_WEBSERVICE)/websrv-wsdl2gsoapH.xsl $<

NSMAP = $(VBOXWEB_OUT_DIR)/vboxwebsrv.nsmap

$(NSMAP): $(VBOXWEB_IDL_SRC) $(VBOX_PATH_WEBSERVICE)/websrv-nsmap.xsl $(VBOX_PATH_WEBSERVICE)/websrv-shared.inc.xsl $(RECOMPILE_ON_MAKEFILE_CURRENT) | $$(dir $$@)

$(call MSG_GENERATE,,$@,$(VBOXWEB_IDL_SRC) using websrv-nsmap.xsl)

$(QUIET)$(VBOX_XSLTPROC) $(VBOXWEB_XSLTPROC_VERBOSE) -o $@ $(VBOX_PATH_WEBSERVICE)/websrv-nsmap.xsl $<

ifdef VBOX_GSOAP_INSTALLED

# ... and once with the gSOAP tool (just for comparison, we don't use it for licensing reasons)

$(VBOXWEB_GSOAPH_FROM_GSOAP): $(VBOXWEB_WSDL) $(VBOXWEB_TYPEMAP) | $$(dir $$@)

$(call MSG_GENERATE,,$@,)

$(VBOX_WSDL2H) $(VBOXWEB_WSDL_VERBOSE) -t$(VBOXWEB_TYPEMAP) -nvbox -o $@ $<

# this sets the gsoap header that we use for further compilation; if stuff works, then the

# one we generate via XSLT produces the same end result as the one from the gSOAP tool;

# with this variable we can swap for testing, but shipped code must use VBOXWEB_GSOAPH_FROM_XSLT

GSOAPH_RELEVANT = $(VBOXWEB_GSOAPH_FROM_XSLT)

# wsdl2h -v: verbose

# wsdl2h -e: don't qualify enum names

# wsdl2h -n<prefix>: namespace header prefix

## @todo change this to state explicitly what will be generated?

# generate server and client code from gsoap pseudo-C header file

$(VBOXWEB_OUT_DIR)/gsoap_generate_all_ts \

+ $(VBOXWEB_OUT_DIR)/soapH.h \

+ $(VBOXWEB_OUT_DIR)/soapStub.h \

+ $(VBOXWEB_OUT_DIR)/soapC.cpp \

+ $(VBOXWEB_OUT_DIR)/soapClient.cpp \

+ $(VBOXWEB_OUT_DIR)/soapServer.cpp \

: $(VBOXWEB_GSOAPH_FROM_GSOAP) $(VBOXWEB_GSOAPH_FROM_XSLT) $(NSMAP) $(RECOMPILE_ON_MAKEFILE_CURRENT) | $$(dir $$@)

$(call MSG_GENERATE,,lots of files,$(GSOAPH_RELEVANT))

$(RM) -f $@

$(REDIRECT) -C $(VBOXWEB_OUT_DIR) -- $(VBOX_SOAPCPP2) $(VBOXWEB_SOAPCPP2_SKIP_FILES) -L -2 -w -I$(VBOX_PATH_GSOAP_IMPORT) $(GSOAPH_RELEVANT)

$(APPEND) $@ done

# copy the generated headers and stuff. This has to be a separate rule if we

# want to use wildcard (all commands are expaned when the rule is evaluated).

$(VBOXWEB_OUT_DIR)/gsoap_copy_all_ts: $(VBOXWEB_OUT_DIR)/gsoap_generate_all_ts | $$(dir $$@)

$(RM) -f $@

$(MKDIR) -p $(PATH_TARGET_SOAPDEMOXML) $(PATH_TARGET_SOAPDEMOHEADERS) $(PATH_TARGET_SOAPDEMONSMAPS)

ifdef VBOX_GSOAP_VERBOSE

$(MV) -f $(wildcard $(VBOXWEB_OUT_DIR)/*.req.xml $(VBOXWEB_OUT_DIR)/*.res.xml) $(PATH_TARGET_SOAPDEMOXML)

endif

$(MV) -f $(wildcard $(VBOXWEB_OUT_DIR)/soapvbox*.h) $(PATH_TARGET_SOAPDEMOHEADERS)

$(MV) -f $(VBOXWEB_OUT_DIR)/vboxBinding.nsmap $(PATH_TARGET_SOAPDEMONSMAPS)

$(APPEND) $@ done

$(PATH_TARGET_SOAPDEMONSMAPS) \

$(PATH_TARGET_SOAPDEMOHEADERS)/soapvboxBindingProxy.h \

$(PATH_TARGET_SOAPDEMOHEADERS)/soapvboxBindingObject.h: $(VBOXWEB_OUT_DIR)/gsoap_copy_all_ts

# soapcpp2 -2: generate SOAP 1.2 calls

# soapcpp2 -S: server-side code only

# soapcpp2 -L: don't generate soapClientLib/soapServerLib

# soapcpp2 -w: don't generate WSDL and schema files

# soapcpp2 -x: don't generate sample XML files

ifndef VBOX_WITHOUT_SPLIT_SOAPC

#

# Split up the soapC.cpp monster into manageable bits that can be

# built in parallel and without exhausting all available memory.

#

$(VBOXWEB_OUT_DIR)/soapC-1.cpp \

+ $(VBOXWEB_OUT_DIR)/soapC-2.cpp \

+ $(VBOXWEB_OUT_DIR)/soapC-3.cpp \

+ $(VBOXWEB_OUT_DIR)/soapC-4.cpp \

+ $(VBOXWEB_OUT_DIR)/soapC-5.cpp \

+ $(VBOXWEB_OUT_DIR)/soapC-6.cpp \

+ $(VBOXWEB_OUT_DIR)/soapC-7.cpp \

+ $(VBOXWEB_OUT_DIR)/soapC-8.cpp \

+ $(VBOXWEB_OUT_DIR)/soapC-9.cpp \

+ $(VBOXWEB_OUT_DIR)/soapC-10.cpp \

+ $(VBOXWEB_OUT_DIR)/soapC-11.cpp \

+ $(VBOXWEB_OUT_DIR)/soapC-12.cpp \

+ $(VBOXWEB_OUT_DIR)/soapC-13.cpp \

+ $(VBOXWEB_OUT_DIR)/soapC-14.cpp \

+ $(VBOXWEB_OUT_DIR)/soapC-15.cpp \

+ $(VBOXWEB_OUT_DIR)/soapC-16.cpp \

+ $(VBOXWEB_OUT_DIR)/soapC-17.cpp \

+ $(VBOXWEB_OUT_DIR)/soapC-18.cpp \

+ $(VBOXWEB_OUT_DIR)/soapC-19.cpp \

+ $(VBOXWEB_OUT_DIR)/soapC-20.cpp \

: $(VBOXWEB_OUT_DIR)/soapC.cpp $$(split-soapC_1_TARGET) | $$(dir $$@)

$(RM) -f $(wildcard $(VBOXWEB_OUT_DIR)/soapC-?.cpp $(VBOXWEB_OUT_DIR)/soapC-??.cpp)

$(split-soapC_1_TARGET) $(VBOXWEB_OUT_DIR)/soapC.cpp $(VBOXWEB_OUT_DIR) 20

endif # !VBOX_WITHOUT_SPLIT_SOAPC

endif # VBOX_GSOAP_INSTALLED

# generate method maps in server: map wsdl operations to com/xpcom method calls

$(VBOXWEB_OUT_DIR)/methodmaps.cpp: $(VBOXWEB_IDL_SRC) $(VBOX_PATH_WEBSERVICE)/websrv-cpp.xsl $(VBOX_PATH_WEBSERVICE)/websrv-shared.inc.xsl $(RECOMPILE_ON_MAKEFILE_CURRENT) | $$(dir $$@)

$(call MSG_GENERATE,,$@,$(VBOXWEB_IDL_SRC) using websrv-cpp.xsl)

$(QUIET)$(VBOX_XSLTPROC) -o $@ $(VBOX_PATH_WEBSERVICE)/websrv-cpp.xsl $<

ifdef VBOX_ONLY_SDK

$(VBOXWEB_JAXWSSAMPLE): $(VBOX_PATH_WEBSERVICE)/samples/java/jax-ws/clienttest.java

$(QUIET)$(MKDIR) -p $(VBOXWEB_SAMPLES_JAXWS_DIR)

$(QUIET)$(SED) -e 's/{VBOX_API_SUFFIX}/$(VBOX_API_SUFFIX)/' < $< > $@

$(VBOXWEB_METRICSAMPLE): $(VBOX_PATH_WEBSERVICE)/samples/java/jax-ws/metrictest.java

$(QUIET)$(MKDIR) -p $(VBOXWEB_SAMPLES_JAXWS_DIR)

$(QUIET)$(SED) -e 's/{VBOX_API_SUFFIX}/$(VBOX_API_SUFFIX)/' < $< > $@

endif # VBOX_ONLY_SDK

include $(KBUILD_PATH)/subfooter.kmk