Changeset 794

Timestamp:

Dec 27, 2016, 6:34:38 PM (8 years ago)

Author:

djay

Message:

Add the initial C# language support.

Location:

trunk

Files:

• docs/services/howtos.rst (modified) (3 diffs)
• workshop/index.rst (modified) (1 diff)
• zoo-project/HISTORY.txt (modified) (1 diff)
• zoo-project/zoo-api/mono (added)
• zoo-project/zoo-api/mono/Makefile (added)
• zoo-project/zoo-api/mono/ZMaps.cs (added)
• zoo-project/zoo-kernel/Makefile.in (modified) (3 diffs)
• zoo-project/zoo-kernel/ZOOMakefile.opts.in (modified) (1 diff)
• zoo-project/zoo-kernel/configure.ac (modified) (1 diff)
• zoo-project/zoo-kernel/request_parser.c (modified) (3 diffs)
• zoo-project/zoo-kernel/service.c (modified) (1 diff)
• zoo-project/zoo-kernel/service_internal_mono.c (added)
• zoo-project/zoo-kernel/service_internal_mono.h (added)
• zoo-project/zoo-kernel/zoo_service_loader.c (modified) (2 diffs)
• zoo-project/zoo-services/hello-mono (added)
• zoo-project/zoo-services/hello-mono/Makefile (added)
• zoo-project/zoo-services/hello-mono/cgi-env (added)
• zoo-project/zoo-services/hello-mono/cgi-env/HelloMono.zcfg (added)
• zoo-project/zoo-services/hello-mono/cgi-env/longProcessMono.zcfg (added)
• zoo-project/zoo-services/hello-mono/test.cs (added)

trunk/docs/services/howtos.rst

@@ -6 +6 @@
 :ref:`services_index` are quite easy to create once you have installed the ZOO Kernel and have 
 chosen code (in the language of your choice) to turn into a ZOO service. Here are some 
-HelloWorlds in Python, PHP, Java  and JavaScript with links to their corresponding 
+HelloWorlds in Python, PHP, Java, C#  and JavaScript with links to their corresponding 
 ``.zcfg`` files.
+
+
+.. contents:: :depth: 3
 
 
@@ -199 +202 @@
 ----
 
-Specifically for the Java support, you may add the following two
+Specifically for the Java support, you may add the following three
 sections to your ``main.cfg`` file:
 
@@ -311 +314 @@
   }
 
+C#
+----
+
+Specifically for the C# support, you should add the following
+section to your ``main.cfg`` file.
+
+
+:[mono]:
+   This section is used to define both ``libPath`` and ``etcPath``
+   required by the Mono .NET Framework.
+
+ZOO-API
+*******
+
+Before you build your first ZOO-Service implemented in Mono, you
+should first build the ``ZMaps.dll`` containing the Mono ZOO-API.
+
+.. Note:: You should build ZOO-Kernel prior to follow this instructions.
+
+.. code-block:: guess
+
+  cd zoo-api/mono
+  make
+
+Then you should copy the ``ZMaps.dll`` in your ``servicePath`` or in
+the directory where your ``zoo_loader.cgi`` file is stored.
+
+The ZOO-API is available from a C# class named ZOO_API and provides
+the following static variables:
+
+:int SERVICE_SUCCEEDED:
+   Value to return in case your service end successfully.
+:int SERVICE_FAILED:
+   Value to retrun in case of failure.
+
+The ZOO-API provides the following static functions:
+
+:string Translate(String s):
+   This function call the internal ZOO-Kernel function responsible for
+   searching a translation of ``s`` in the zoo-services dictionary.
+
+:void UpdateStatus(ZMaps conf,String pourcent,String message):
+   This function call the updateStatus ZOO-Kernel function responsible
+   for updating the status of the running service (only usefull when
+   the service has been called asynchronously).
+
+
+C# ZCFG requirements
+**********************************
+
+.. Note:: For each Service provided by your ZOO Mono Services Provider
+          (your corresponding Mono class), the ZCFG File should have
+          the name of the Mono public static function corresponding to the
+          service (case-sensitive).
+
+The ZCFG file should contain the following :
+
+serviceType
+    Mono 
+serviceProvider
+    The full name of the C# dll containing the ZOO-Service Provider
+    (including ``.dll``).
+serviceNameSpace
+    The namespace of the C# class containing the ZOO-Service Provider.
+serviceClass
+    The name of the C# class containing the ZOO-Service Provider definition.
+
+C# Data Structure used
+********************************
+
+The three parameters of the function are passed to the Mono static
+function as ``ZMaps`` which are basically
+``Dictionary<String,_ZMaps>``.
+
+Sample ZOO C# Services Provider
+******************************************
+
+.. literalinclude:: ../../zoo-project/zoo-services/hello-mono/test.cs
+   :language: csharp
+   :lines: 24-100
+
 Javascript
 ----------

trunk/workshop/index.rst

@@ -12 +12 @@
    :maxdepth: 1
 
+   2016/index
    2015/index
    2014/index

trunk/zoo-project/HISTORY.txt

@@ -1 +1 @@
 Version 1.6.0-dev
+  * Add the C# as a supported programming language for Services 
   * Add nested inputs and outputs support (WPS 2.0.0)
   * Add servicePath special key to specify the service location

trunk/zoo-project/zoo-kernel/Makefile.in

@@ -86 +86 @@
         gcc -fPIC ${XML2CFLAGS} ${JSCFLAGS} ${CFLAGS} ${JS_ENABLED} -c service_internal_js.c
 
+service_internal_mono.o: service_internal_mono.h service_internal_mono.c service.h
+        gcc -c ${XML2CFLAGS} ${MONO_CFLAGS} ${CFLAGS} ${MONO_ENABLED} service_internal_mono.c
+
 service_internal_ruby.o: service_internal_ruby.c service_internal_ruby.h
         g++ ${XML2CFLAGS} ${RUBYCFLAGS} ${CFLAGS} ${JSCFLAGS} ${JS_ENABLED} -c service_internal_ruby.c
@@ -92 +95 @@
         g++ -c ${XML2CFLAGS} ${PYTHONCFLAGS} ${CFLAGS} service_loader.c
 
-zoo_service_loader.o: zoo_service_loader.c service.h version.h ${MS_FILE} ${PYTHON_FILE} ${PHP_FILE} ${JAVA_FILE} ${JS_FILE} ${PERL_FILE} ${RUBY_FILE} ${YAML_FILE} ${OTB_FILE} ${SAGA_FILE}
-        g++ -g -O2 ${XML2CFLAGS} ${CFLAGS} ${SAGA_CFLAGS} ${OTBCFLAGS} ${PYTHONCFLAGS} ${JAVACFLAGS} ${JSCFLAGS} ${PERLCFLAGS} ${PHPCFLAGS} ${SAGA_ENABLED} ${OTB_ENABLED} ${PYTHON_ENABLED} ${JS_ENABLED} ${PHP_ENABLED} ${PERL_ENABLED} ${JAVA_ENABLED} -c zoo_service_loader.c  -fno-common -DPIC -o zoo_service_loader.o
+zoo_service_loader.o: zoo_service_loader.c service.h version.h ${MS_FILE} ${PYTHON_FILE} ${PHP_FILE} ${JAVA_FILE} ${JS_FILE} ${PERL_FILE} ${RUBY_FILE} ${YAML_FILE} ${OTB_FILE} ${SAGA_FILE} ${MONO_FILE}
+        g++ -g -O2 ${XML2CFLAGS} ${CFLAGS} ${MONO_CFLAGS} ${SAGA_CFLAGS} ${OTBCFLAGS} ${PYTHONCFLAGS} ${JAVACFLAGS} ${JSCFLAGS} ${PERLCFLAGS} ${PHPCFLAGS} ${SAGA_ENABLED} ${OTB_ENABLED} ${PYTHON_ENABLED} ${JS_ENABLED} ${PHP_ENABLED} ${PERL_ENABLED} ${JAVA_ENABLED} ${MONO_ENABLED}  -c zoo_service_loader.c  -fno-common -DPIC -o zoo_service_loader.o
 
 libzoo_service.${EXT}: version.h service_internal.o service.o sqlapi.o
@@ -100 +103 @@
 zoo_loader.cgi: version.h libzoo_service.${EXT} zoo_loader.c zoo_service_loader.o  ulinet.o service.h lex.sr.o service_conf.tab.o service_conf.y ulinet.o main_conf_read.tab.o lex.cr.o request_parser.o response_print.o server_internal.o caching.o ${MS_FILE} ${PYTHON_FILE} ${PHP_FILE} ${JAVA_FILE} ${JS_FILE} ${PERL_FILE} ${RUBY_FILE} ${YAML_FILE} ${OTB_FILE} ${SAGA_FILE}
         g++ -g -O2 ${JSCFLAGS} ${PHPCFLAGS}  ${PERLCFLAGS} ${RUBYCFLAGS}  ${JAVACFLAGS} ${XML2CFLAGS} ${PYTHONCFLAGS} ${CFLAGS} -c zoo_loader.c  -fno-common -DPIC -o zoo_loader.o
-        g++  ${JSCFLAGS} ${SAGA_CFLAGS} ${OTBCFLAGS} ${GDAL_CFLAGS} ${XML2CFLAGS} ${PHPCFLAGS} ${PERLCFLAGS} ${JAVACFLAGS} ${PYTHONCFLAGS} ${CFLAGS} zoo_loader.o zoo_service_loader.o ${MS_FILE} ${PYTHON_FILE}  ${PERL_FILE} ${PHP_FILE}  ${JS_FILE} ${JAVA_FILE} ${YAML_FILE} ${OTB_FILE} ${SAGA_FILE} response_print.o server_internal.o caching.o request_parser.o ulinet.o lex.cr.o lex.sr.o service_conf.tab.o main_conf_read.tab.o -o zoo_loader.cgi -L. ${LDFLAGS}
+        g++  ${JSCFLAGS} ${SAGA_CFLAGS} ${OTBCFLAGS} ${GDAL_CFLAGS} ${XML2CFLAGS} ${PHPCFLAGS} ${PERLCFLAGS} ${JAVACFLAGS} ${PYTHONCFLAGS} ${CFLAGS} zoo_loader.o zoo_service_loader.o ${MS_FILE} ${PYTHON_FILE}  ${PERL_FILE} ${PHP_FILE}  ${JS_FILE} ${JAVA_FILE} ${YAML_FILE} ${OTB_FILE} ${SAGA_FILE} ${MONO_FILE} response_print.o server_internal.o caching.o request_parser.o ulinet.o lex.cr.o lex.sr.o service_conf.tab.o main_conf_read.tab.o -o zoo_loader.cgi -L. ${LDFLAGS}
 
 zcfg2yaml: zcfg2yaml.c service.h lex.sr.o service_conf.tab.o service_conf.y main_conf_read.tab.o lex.cr.o response_print.o server_internal.o service_internal.o ${MS_FILE} ${YAML_FILE}

trunk/zoo-project/zoo-kernel/ZOOMakefile.opts.in

@@ -96 +96 @@
 SAGA_FILE=@SAGA_FILE@
 
+MONO_CFLAGS=@MONO_CFLAGS@
+MONO_LDFLAGS=@MONO_LDFLAGS@
+MONO_ENABLED=@MONO_ENABLED@
+MONO_FILE=@MONO_FILE@
+
 CFLAGS=@RELY_ON_DB@ @DEB_DEF@ -fpic @OPENSSL_CFLAGS@ ${FCGI_CFLAGS} ${YAML_CFLAGS} ${MACOS_CFLAGS} ${MS_CFLAGS} -I../../thirds/cgic206 -I. -DLINUX_FREE_ISSUE #-DDEBUG #-DDEBUG_SERVICE_CONF
-LDFLAGS=-lzoo_service @DEFAULT_LIBS@ -L../../thirds/cgic206 -lcgic ${GDAL_LIBS} ${XML2LDFLAGS} ${PYTHONLDFLAGS} ${PERLLDFLAGS}  ${PHPLDFLAGS} ${JAVALDFLAGS} ${JSLDFLAGS}  ${FCGI_LDFLAGS} @OPENSSL_LDFLAGS@ -luuid ${MS_LDFLAGS} ${MACOS_LD_FLAGS} ${MACOS_LD_NET_FLAGS} ${YAML_LDFLAGS} ${OTBLDFLAGS} ${SAGA_LDFLAGS}
+LDFLAGS=-lzoo_service @DEFAULT_LIBS@ -L../../thirds/cgic206 -lcgic ${GDAL_LIBS} ${XML2LDFLAGS} ${PYTHONLDFLAGS} ${PERLLDFLAGS}  ${PHPLDFLAGS} ${JAVALDFLAGS} ${JSLDFLAGS}  ${FCGI_LDFLAGS} @OPENSSL_LDFLAGS@ -luuid ${MS_LDFLAGS} ${MACOS_LD_FLAGS} ${MACOS_LD_NET_FLAGS} ${YAML_LDFLAGS} ${OTBLDFLAGS} ${SAGA_LDFLAGS} ${MONO_LDFLAGS}
 
 DATAROOTDIR=@datarootdir@/zoo-project

trunk/zoo-project/zoo-kernel/configure.ac

@@ -637 +637 @@
 
 # ===========================================================================
+# Detect if mono is installed
+# ===========================================================================
+
+AC_ARG_WITH([mono], 
+        [AS_HELP_STRING([--with-mono=PATH], [To enable mono support, specify the path to find pkg-config,  disabled by default])], 
+        [MONOHOME="$withval"; MONO_ENABLED="-DUSE_MONO"], [MONO_ENABLED=""])
+
+if test -z "$MONO_ENABLED"
+then
+        MONO_FILE=""
+else
+        MONO_FILE="service_internal_mono.o"
+        if test "x$MONOHOME" = "x"; 
+        then
+                MONOHOME="/usr"
+        fi
+        if test "x$MONOHOME" = "xyes"; 
+        then
+                MONOHOME="/usr"
+        fi
+
+        # Extract the linker and include flags
+        MONO_CFLAGS=`$MONOHOME/bin/pkg-config --cflags mono-2`
+        MONO_LDFLAGS=`$MONOHOME/bin/pkg-config --libs mono-2`
+
+        AC_LANG([C++])
+        echo $JAVA_CPPFLAGS
+        # Check headers file (second time we check that in fact)
+        CPPFLAGS_SAVE="$CFLAGS"
+        CPPFLAGS="$MONO_CFLAGS"
+        AC_CHECK_HEADERS([mono/jit/jit.h],
+                         [], [AC_MSG_ERROR([could not find jit.h file])])
+        CPPFLAGS="$CPPFLAGS_SAVE"
+        # Ensure we can link against libmono-2.0
+        LIBS_SAVE="$LIBS"
+        LIBS="$MONO_LDFLAGS"
+        AC_CHECK_LIB([mono-2.0], [mono_runtime_invoke], [], [AC_MSG_ERROR([could not find libmono])], [])
+        LIBS="$LIBS_SAVE"
+
+        AC_SUBST([MONO_CFLAGS])
+        AC_SUBST([MONO_LDFLAGS])
+fi 
+
+AC_SUBST([MONO_ENABLED])
+AC_SUBST([MONO_FILE])
+
+# ===========================================================================
 # Detect if ruby is installed
 # ===========================================================================

trunk/zoo-project/zoo-kernel/request_parser.c

@@ -1627 +1627 @@
               cgiFilePtr file;
               int targetFile;
-              char storageNameOnServer[2048];
-              char fileNameOnServer[64];
+              char *storageNameOnServer;
+              char *fileNameOnServer;
               char contentType[1024];
               char buffer[1024];
@@ -1651 +1651 @@
                         break;
                     }
+                  fileNameOnServer=(char*)malloc((strlen(name) - t - 1 )*sizeof(char));
                   strcpy (fileNameOnServer, name + t + 1);
 
+                  storageNameOnServer=(char*)malloc((strlen(path->value) + strlen(fileNameOnServer) + 2)*sizeof(char));
                   sprintf (storageNameOnServer, "%s/%s", path->value,
                            fileNameOnServer);
@@ -1683 +1685 @@
                   cgiFormFileClose (file);
                   close (targetFile);
+                  free(fileNameOnServer);
+                  free(storageNameOnServer);
 #ifdef DEBUG
                   fprintf (stderr, "File \"%s\" has been uploaded",

trunk/zoo-project/zoo-kernel/service.c

@@ -515 +515 @@
     free(tmp->value);
   tmp->value=(char*)malloc((size+1)*sizeof(char));
-  memmove(tmp->value,v,size*sizeof(char));
+  if(v!=NULL)
+    memmove(tmp->value,v,size*sizeof(char));
   tmp->value[size]=0;
   char sin[128];

trunk/zoo-project/zoo-kernel/zoo_service_loader.c

@@ -81 +81 @@
 #ifdef USE_PERL
 #include "service_internal_perl.h"
+#endif
+
+#ifdef USE_MONO
+#include "service_internal_mono.h"
 #endif
 
@@ -705 +709 @@
       *eres =
         zoo_ruby_support (&m, request_inputs, s1, &request_input_real_format,
+                          &request_output_real_format);
+    }
+  else
+#endif
+
+#ifdef USE_MONO
+  if (strncasecmp (r_inputs->value, "Mono", 4) == 0)
+    {
+      *eres =
+        zoo_mono_support (&m, request_inputs, s1, &request_input_real_format,
                           &request_output_real_format);
     }