Merge pull request #46 from LeSpocky/maintenance

collected maintenance changes
rafaelsteil · Jul 20, 2018 · 6ba2fe2 · 6ba2fe2
2 parents c13110c + d5bf438
commit 6ba2fe2
Show file tree

Hide file tree

Showing 23 changed files with 102 additions and 47 deletions.
diff --git a/.gitignore b/.gitignore
@@ -8,5 +8,4 @@ libcgi.a
 libcgi.so
 autom4te.cache
 configure
-src/config.h
 *swp
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -28,6 +28,7 @@ option(BUILD_SHARED_LIBS
 )
 
 # subdirectories
+add_subdirectory("include/libcgi")
 add_subdirectory("src")
 
 # test

diff --git a/include/libcgi/CMakeLists.txt b/include/libcgi/CMakeLists.txt
@@ -0,0 +1,15 @@
+#
+# Copyright 2018 Alexander Dahl <[email protected]>
+#
+
+configure_file(
+	"${CMAKE_CURRENT_SOURCE_DIR}/config.h.in"
+	"${CMAKE_CURRENT_BINARY_DIR}/config.h"
+)
+
+install(FILES
+	cgi.h
+	error.h
+	session.h
+	DESTINATION "${CMAKE_INSTALL_INCLUDEDIR}/libcgi"
+)
diff --git a/src/cgi.h → include/libcgi/cgi.h b/src/cgi.h → include/libcgi/cgi.h
@@ -23,11 +23,21 @@
 
 #include <stdio.h>
 
+#if defined(__GNUC__)
+#define CGI_DEPRECATED __attribute__ ((deprecated))
+#elif defined(_MSC_VER)
+#define CGI_DEPRECATED __declspec(deprecated)
+#elif defined(__clang__)
+#define CGI_DEPRECATED __deprecated
+#else
+#pragma message("WARNING: You need to implement CGI_DEPRECATED for this compiler")
+#define CGI_DEPRECATED
+#endif
+
 #ifdef __cplusplus
 extern "C" {
 #endif
 
-
 // general purpose linked list. Actually isn't very portable
 // because uses only 'name' and 'value' variables to store data.
 // Problably, in a future release, this will be replaced by
@@ -81,7 +91,7 @@ extern char *stripslashes(char *str);
 extern char *str_base64_encode(char *str);
 extern char *str_base64_decode(char *str);
 extern char *recvline(FILE *fp);
-extern char *md5(const char *str);
+CGI_DEPRECATED char *md5(const char *str);
 extern char *cgi_ltrim(char *str);
 extern char *cgi_rtrim(char *str);
 extern char *cgi_trim(char *str);
@@ -126,6 +136,13 @@ extern void cgi_session_save_path(const char *path);
  */
 void cgi_session_free( void );
 
+/**
+ *	The version of this library.
+ *
+ *	@return	Version string.
+ */
+const char *cgi_version( void );
+
 #ifdef __cplusplus
 }
 #endif

diff --git a/include/libcgi/config.h.in b/include/libcgi/config.h.in
@@ -0,0 +1,16 @@
+/*******************************************************************//**
+ *	@file		config.h
+ *
+ *	@brief		Stuff set by the build system.
+ *
+ *	@author		Alexander Dahl <[email protected]>
+ *
+ *	SPDX-License-Identifier: LGPL-2.1-or-later
+ *	License-Filename: COPYING
+ *
+ *	@copyright	2018 Alexander Dahl and libcgi contributors
+ **********************************************************************/
+
+#pragma once
+
+#define CGI_VERSION					"v@PROJECT_VERSION@"
diff --git a/src/error.h → include/libcgi/error.h b/src/error.h → include/libcgi/error.h
diff --git a/src/session.h → include/libcgi/session.h b/src/session.h → include/libcgi/session.h
diff --git a/src/CMakeLists.txt b/src/CMakeLists.txt
@@ -2,19 +2,14 @@
 # Copyright 2013,2016,2018 Alexander Dahl <[email protected]>
 #
 
-configure_file(
-	"${CMAKE_CURRENT_SOURCE_DIR}/config.h.cmake.in"
-	"${CMAKE_CURRENT_BINARY_DIR}/config.h"
-)
-
 set(CGI_SRC
 	base64.c
 	cgi.c
 	cookie.c
 	error.c
 	general.c
 	list.c
-	#	md5.c
+	md5.c
 	session.c
 	string.c
 )
@@ -32,8 +27,8 @@ set_target_properties(${PROJECT_NAME} PROPERTIES
 
 target_include_directories(${PROJECT_NAME}
 	PUBLIC
-		$<BUILD_INTERFACE:${CMAKE_CURRENT_SOURCE_DIR}>
-		$<BUILD_INTERFACE:${CMAKE_CURRENT_BINARY_DIR}>
+		$<BUILD_INTERFACE:${PROJECT_SOURCE_DIR}/include>
+		$<BUILD_INTERFACE:${PROJECT_BINARY_DIR}/include>
 		$<INSTALL_INTERFACE:${CMAKE_INSTALL_INCLUDEDIR}>
 )
 
@@ -49,11 +44,3 @@ install(EXPORT ${PROJECT_NAME}-targets
 	NAMESPACE ${PROJECT_NAME}::
 	DESTINATION "${CMAKE_INSTALL_LIBDIR}/cmake/${PROJECT_NAME}"
 )
-
-# install headers
-install(FILES
-	cgi.h
-	error.h
-	session.h
-	DESTINATION "${CMAKE_INSTALL_INCLUDEDIR}/lib${PROJECT_NAME}"
-)
diff --git a/src/base64.c b/src/base64.c
@@ -32,7 +32,7 @@ LICENCE:        Copyright (c) 2001 Bob Trower, Trantor Standard Systems Inc.
 #include <stdlib.h>
 #include <string.h>
 
-#include "error.h"
+#include "libcgi/error.h"
 
 static const char cb64[]="ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/";
 static const char cd64[]="|$$$}rstuvwxyz{$$$$$$$>?@ABCDEFGHIJKLMNOPQRSTUVW$$$$$$XYZ[\\]^_`abcdefghijklmnopq";

diff --git a/src/cgi.c b/src/cgi.c
@@ -25,8 +25,9 @@
 #include <ctype.h>
 #include <sys/stat.h> /* for cgi_include() */
 
-#include "cgi.h"
-#include "error.h"
+#include "libcgi/cgi.h"
+#include "libcgi/config.h"
+#include "libcgi/error.h"
 
 // There's no reason to not have this initialised.
 static const char hextable[256] = {
@@ -551,6 +552,10 @@ void cgi_send_header(const char *header)
 	printf("%s\r\n", header);
 }
 
+const char *cgi_version( void )
+{
+	return CGI_VERSION;
+}
 
 /**
 * @}

diff --git a/src/config.h.cmake.in b/src/config.h.cmake.in
diff --git a/src/cookie.c b/src/cookie.c
@@ -23,8 +23,8 @@
 #include <stdlib.h>
 #include <string.h>
 
-#include "error.h"
-#include "cgi.h"
+#include "libcgi/cgi.h"
+#include "libcgi/error.h"
 
 formvars *cookies_start = NULL;
 formvars *cookies_last = NULL;

diff --git a/src/error.c b/src/error.c
@@ -2,8 +2,8 @@
 #include <stdarg.h>
 #include <stdlib.h>
 
-#include "error.h"
-#include "cgi.h"
+#include "libcgi/cgi.h"
+#include "libcgi/error.h"
 
 const char *libcgi_error_type[] = {
 	"LibCGI Warning",

diff --git a/src/general.c b/src/general.c
@@ -23,8 +23,8 @@
 #include <string.h>
 #include <stdlib.h>
 
-#include "error.h"
-#include "cgi.h"
+#include "libcgi/cgi.h"
+#include "libcgi/error.h"
 
 struct iso8859_15 {
 	char code;

diff --git a/src/list.c b/src/list.c
@@ -25,8 +25,8 @@
 #include <stdlib.h>
 #include <string.h>
 
-#include "error.h"
-#include "cgi.h"
+#include "libcgi/cgi.h"
+#include "libcgi/error.h"
 
 // Add a new item to the list
 void slist_add(formvars *item, formvars **start, formvars **last)

diff --git a/src/md5.c b/src/md5.c
@@ -23,16 +23,13 @@
 #include <stdlib.h>
 #include <string.h>
 
-#include "config.h"
-#include "error.h"
-#include "cgi.h"
+#include "libcgi/cgi.h"
+#include "libcgi/error.h"
 
 /** @ingroup libcgi_general
 * @{
 */
 
-#if HAVE_MD5
-
 #ifndef MD5_H
 #define MD5_H
 
@@ -95,7 +92,6 @@ char *md5(const char *str)
 	// returning a encrypted string
 	return tmp;
 }
-#endif
 
 /*=======================================================================*/
 

diff --git a/src/session.c b/src/session.c
@@ -67,9 +67,9 @@
 #include <unistd.h>
 #include <errno.h>
 
-#include "cgi.h"
-#include "session.h"
-#include "error.h"
+#include "libcgi/cgi.h"
+#include "libcgi/error.h"
+#include "libcgi/session.h"
 
 // session id length
 #define SESS_ID_LEN 45

diff --git a/src/string.c b/src/string.c
@@ -25,8 +25,8 @@
 #include <stdarg.h>
 #include <ctype.h>
 
-#include "cgi.h"
-#include "error.h"
+#include "libcgi/cgi.h"
+#include "libcgi/error.h"
 
 /*********************************************************
 * 					STRING GROUP

diff --git a/test/CMakeLists.txt b/test/CMakeLists.txt
@@ -7,6 +7,11 @@ add_executable(cgi-test
 	cgi_test.c
 	test.c
 )
+target_compile_definitions(cgi-test
+	PRIVATE
+		_POSIX_C_SOURCE=200112L
+		_XOPEN_SOURCE
+)
 target_link_libraries(cgi-test
 	${PROJECT_NAME}
 )
@@ -28,6 +33,9 @@ add_test(NAME cgi_ltrim
 add_test(NAME cgi_rtrim
     COMMAND cgi-test rtrim
 )
+add_test(NAME cgi_version
+	COMMAND cgi-test version
+)
 
 # slist
 add_executable(cgi-test-slist

diff --git a/test/test.c b/test/test.c
@@ -7,7 +7,8 @@
 
 #include "cgi_test.h"
 
-#include "cgi.h"
+#include "libcgi/cgi.h"
+#include "libcgi/config.h"
 
 extern formvars *
 process_data(const char *query, formvars **start, formvars **last,
@@ -23,6 +24,7 @@ static int test_cgi_param_multiple( void );
 static int test_cgi_process_form( void );
 static int _test_ltrim( void );
 static int _test_rtrim( void );
+static int version( void );
 
 int main( int argc, char *argv[] )
 {
@@ -33,6 +35,7 @@ int main( int argc, char *argv[] )
 		{ "process_form",			test_cgi_process_form			},
 		{ "ltrim",					_test_ltrim						},
 		{ "rtrim",					_test_rtrim						},
+		{ "version",				version							},
 	};
 
 	/*	require at least one argument to select test	*/
@@ -61,7 +64,6 @@ int test_cgi_escape_special_chars( void )
 
 	for (c = 0; c < 256; ++c)
 		str[c] = (char) c + 1;
-	str[c] = 0;
 
 	check( strlen(str) == 255, "strlen" );
 	check( esc = cgi_escape_special_chars(str), "escape" );
@@ -312,3 +314,13 @@ int _test_rtrim( void )
 error:
 	return EXIT_FAILURE;
 }
+
+int version( void )
+{
+	check( 0 == strcmp( CGI_VERSION, cgi_version() ),
+			"strcmp( '%s', '%s' )", CGI_VERSION, cgi_version() );
+
+	return EXIT_SUCCESS;
+error:
+	return EXIT_FAILURE;
+}
diff --git a/test/test_session.c b/test/test_session.c
@@ -14,7 +14,7 @@
 
 #include "cgi_test.h"
 
-#include "cgi.h"
+#include "libcgi/cgi.h"
 
 #define CGI_TEST_SHRT_COOKIE_NAME	"cgi_sess"
 #define CGI_TEST_COOKIE_NAME_49		"_______ten____twenty____thirty____fourty_____fift"

diff --git a/test/test_slist.c b/test/test_slist.c
@@ -13,7 +13,7 @@
 
 #include "cgi_test.h"
 
-#include "cgi.h"
+#include "libcgi/cgi.h"
 
 /*	declarations for functions not declared in src	*/
 formvars *process_data(const char *query, formvars **start, formvars **last,

diff --git a/test/test_trim.c b/test/test_trim.c
@@ -13,7 +13,7 @@
 
 #include "cgi_test.h"
 
-#include "cgi.h"
+#include "libcgi/cgi.h"
 
 /*	trim.c	*/
 char* ltrim(char* s);