Add msiMakeUpperGenQuery microservice.

CMakeLists.txt

+cmake_minimum_required(VERSION 2.8.12)
+
+find_package(IRODS 4.2.1 EXACT REQUIRED)
+
+message(STATUS "Building for irods-server version ${IRODS_VERSION}")
+
+# Note: Microservices for iRODS >=4.2 need to be built with the compiler and
+# standard libarary provided by iRODS-externals packages.
+# The following packages need to be installed to build the uu microservices:
+#
+# irods-externals-clang-runtime3.8-0
+# irods-externals-clang3.8-0
+
+set(CMAKE_CXX_COMPILER ${IRODS_EXTERNALS_FULLPATH_CLANG}/bin/clang++)
+
+project(uu-msis CXX)
+
+add_compile_options(-std=c++14
+                    -Os
+                    -fPIC
+                    -DRODS_SERVER
+                    -nostdinc++
+                    -Wall
+                    -Wextra
+                    -Wpedantic
+                    -Wcast-align
+                    -Wredundant-decls
+                    -Wuninitialized
+                    -Wconversion
+                    -Wno-missing-field-initializers
+                    -Wno-unused-parameter)
+
+set(CMAKE_SHARED_LINKER_FLAGS "${CMAKE_SHARED_LINKER_FLAGS} -stdlib=libc++")
+link_libraries(c++abi)
+include_directories("${IRODS_EXTERNALS_FULLPATH_CLANG}/include/c++/v1")
+include_directories("/usr/include/irods")
+
+add_library(msiMakeUpperGenQuery     SHARED src/msiMakeUpperGenQuery.cc)
+
+install(TARGETS
+        msiMakeUpperGenQuery
+        DESTINATION
+        /usr/lib/irods/plugins/microservices)
+
+# Packaging {{{
+
+# Make sure your umask is set correctly when packaging:
+# The default umask on CentOS 7 is 0002, which results in e.g. rwxrwxr-x
+# directories within generated RPMs, which will conflict with existing
+# directories from irods packages, which will be rwxr-xr-x.
+# To create packages on CentOS 7, set your umask to 0022 first (`umask 0022`).
+
+set(CPACK_MONOLITHIC_INSTALL 1)
+set(CPACK_CMAKE_GENERATOR "Unix Makefiles")
+#set(CPACK_GENERATOR "DEB")
+set(CPACK_GENERATOR "RPM")
+set(CPACK_PACKAGE_NAME "irods-uu-microservices")
+set(CPACK_PACKAGE_VENDOR "Utrecht University <fbyoda@uu.nl>")
+set(CPACK_PACKAGE_CONTACT "Utrecht University <fbyoda@uu.nl>")
+set(CPACK_PACKAGE_VERSION "4.2.1_0.1.0")
+
+set(CPACK_PACKAGE_DESCRIPTION_FILE "${CMAKE_CURRENT_SOURCE_DIR}/package/description.txt")
+set(CPACK_PACKAGE_DESCRIPTION_SUMMARY "Miscellaneous microservices developed by Utrecht university.")
+
+set(CPACK_RESOURCE_FILE_README  "${CMAKE_CURRENT_SOURCE_DIR}/README.md")
+
+set(CPACK_RPM_PACKAGE_RELEASE "1")
+set(CPACK_RPM_PACKAGE_LICENSE "LGPLv3")
+set(CPACK_RPM_PACKAGE_REQUIRES "irods-server = ${IRODS_VERSION}")
+set(CPACK_RPM_PACKAGE_URL "https://github.com/UtrechtUniversity/irods-uu-microservices")
+set(CPACK_RPM_PACKAGE_AUTOREQ 0)
+set(CPACK_RPM_PACKAGE_AUTOPROV 0)
+
+set(CPACK_DEBIAN_PACKAGE_DEPENDS "irods-server = ${IRODS_VERSION}, irods-runtime = ${IRODS_VERSION}")
+set(CPACK_DEBIAN_PACKAGE_HOMEPAGE "https://github.com/UtrechtUniversity/irods-uu-microservices")
+set(CPACK_DEBIAN_PACKAGE_SECTION "contrib/science")
+
+set(CPACK_PACKAGE_FILE_NAME "${CPACK_PACKAGE_NAME}-${CPACK_PACKAGE_VERSION}-${CPACK_RPM_PACKAGE_RELEASE}")
+
+include(CPack)
+
+# }}}

COPYING.LESSER

+                   GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions.
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version.
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

LICENSE

-Copyright (c) 2016, Utrecht University.
+Copyright (c) 2017, Utrecht University.
 All rights reserved.

package/description.txt

+Miscellaneous microservices developed by Utrecht university.

src/irods_includes.hh

+/**
+ * \file
+ * \brief     iRODS includes.
+ * \copyright Copyright (c) 2017, Utrecht University
+ */
+#pragma once
+
+// Silence warnings in some external iRODS headers.
+#pragma GCC system_header
+
+#include <irods_ms_plugin.hpp>

src/msiMakeUpperGenQuery.cc

+/**
+ * \file
+ * \brief     iRODS microservice for uppercase version of msiMakeGenQuery.
+ * \author    Lazlo Westerhof
+ * \copyright Copyright (c) 2017, Utrecht University
+ *
+ * Copyright (c) 2017, Utrecht University
+ *
+ * This file is part of irods-uu-microservices.
+ *
+ * irods-uu-microservices is free software: you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public License as
+ * published by the Free Software Foundation, either version 3 of the License,
+ * or (at your option) any later version.
+ *
+ * irods-uu-microservices is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser
+ * General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with irods-uu-microservices.
+ * If not, see <http://www.gnu.org/licenses/>.
+ *
+ * This file incorporates work covered by the following copyright and
+ * permission notice:
+ *
+ *   Copyright (c) 2005-2016, Regents of the University of California, the
+ *   University of North Carolina at Chapel Hill, and the Data Intensive
+ *   Cyberinfrastructure Foundation
+ *   All rights reserved.
+ *
+ *   Redistribution and use in source and binary forms, with or without
+ *   modification, are permitted provided that the following conditions
+ *   are met:
+ *
+ *   - Redistributions of source code must retain the above copyright notice,
+ *     this list of conditions and the following disclaimer.
+ *
+ *   - Redistributions in binary form must reproduce the above copyright
+ *     notice, this list of conditions and the following disclaimer in the
+ *     documentation and/or other materials provided with the distribution.
+ *
+ *   - Neither the name of the University of California, San Diego (UCSD),
+ *     the University of North Carolina at Chapel Hill nor the names of its
+ *     contributors may be used to endorse or promote products derived from
+ *     this software without specific prior written permission.
+ *
+ *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+ *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
+ *   TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+ *   PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS
+ *   BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+ *   CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+ *   SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+ *   INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+ *   CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ *   ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+ *   POSSIBILITY OF SUCH DAMAGE.
+ */
+
+#include "irods_includes.hh"
+#include "genQuery.h"
+#include "rsGenQuery.hpp"
+#include "rcMisc.h"
+
+
+int _makeQuery( char *sel, char *cond, char **sql ) {
+  *sql = ( char * ) malloc( strlen( sel ) + strlen( cond ) + 20 );
+  if ( strlen( cond ) >  0 ) {
+    sprintf( *sql, "SELECT %s WHERE %s", sel, cond );
+  }
+  else {
+    sprintf( *sql, "SELECT %s ", sel );
+  }
+  return 0;
+}
+
+int  msiMakeUpperGenQuery( msParam_t* selectListStr, msParam_t* condStr, msParam_t* genQueryInpParam, ruleExecInfo_t *rei ) {
+  char *sel, *cond, *rawQuery, *query;
+
+
+  RE_TEST_MACRO( "    Calling msiMakeUpperGenQuery" )
+
+    if ( rei == NULL || rei->rsComm == NULL ) {
+      rodsLog( LOG_ERROR, "msiMakeUpperGenQuery: input rei or rsComm is NULL." );
+      return SYS_INTERNAL_NULL_INPUT_ERR;
+    }
+
+  /* parse selectListStr */
+  if ( ( sel = parseMspForStr( selectListStr ) ) == NULL ) {
+    rodsLog( LOG_ERROR, "msiMakeUpperGenQuery: input selectListStr is NULL." );
+    return USER__NULL_INPUT_ERR;
+  }
+
+  /* parse condStr */
+  if ( ( cond = parseMspForStr( condStr ) ) == NULL ) {
+    rodsLog( LOG_ERROR, "msiMakeUpperGenQuery: input condStr is NULL." );
+    return USER__NULL_INPUT_ERR;
+  }
+
+  /* The code below is partly taken from msiMakeQuery and msiExecStrCondQuery. There may be a better way to do this. */
+
+  /* Generate raw SQL query string */
+  rei->status = _makeQuery( sel, cond, &rawQuery );
+
+  /* allocate more memory for query string with expanded variable names */
+  query = ( char * )malloc( strlen( rawQuery ) + 10 + MAX_NAME_LEN * 8 );
+  strcpy( query, rawQuery );
+
+  /* allocate memory for genQueryInp */
+  genQueryInp_t * genQueryInp = ( genQueryInp_t* )malloc( sizeof( genQueryInp_t ) );
+  memset( genQueryInp, 0, sizeof( genQueryInp_t ) );
+
+  /* set up GenQueryInp */
+  genQueryInp->maxRows = MAX_SQL_ROWS;
+  genQueryInp->continueInx = 0;
+
+  /* Ensure that the value in the 'where' condition will be made upper
+     case so one can do case-insensitive queries. */
+  genQueryInp->options = UPPER_CASE_WHERE;
+
+  rei->status = fillGenQueryInpFromStrCond( query, genQueryInp );
+  if ( rei->status < 0 ) {
+    rodsLog( LOG_ERROR, "msiMakeUpperGenQuery: fillGenQueryInpFromStrCond failed." );
+    freeGenQueryInp( &genQueryInp );
+    free( rawQuery ); // cppcheck - Memory leak: rawQuery
+    free( query );
+    return rei->status;
+  }
+
+  /* return genQueryInp through GenQueryInpParam */
+  genQueryInpParam->type = strdup( GenQueryInp_MS_T );
+  genQueryInpParam->inOutStruct = genQueryInp;
+
+  /* cleanup */
+  free( rawQuery );
+  free( query );
+
+  return rei->status;
+}
+
+
+irods::ms_table_entry* plugin_factory() {
+  irods::ms_table_entry *msvc = new irods::ms_table_entry(2);
+
+  msvc->add_operation("msiMakeUpperGenQuery",
+		      std::function<decltype(msiMakeUpperGenQuery)>(msiMakeUpperGenQuery));
+
+  return msvc;
+}