civetweb/Makefile

#
# Copyright (c) 2013 No Face Press, LLC
# License http://opensource.org/licenses/mit-license.php MIT License
#

#
# For help try, "make help"
#

include resources/Makefile.in-os

CPROG = civetweb
#CXXPROG = civetweb
UNIT_TEST_PROG = civetweb_test

BUILD_DIR = out

# Installation directories by convention
# http://www.gnu.org/prep/standards/html_node/Directory-Variables.html
PREFIX ?= /usr/local
EXEC_PREFIX = $(PREFIX)
BINDIR = $(EXEC_PREFIX)/bin
DATAROOTDIR = $(PREFIX)/share
DOCDIR = $(DATAROOTDIR)/doc/$(CPROG)
SYSCONFDIR ?= $(PREFIX)/etc
HTMLDIR = $(DOCDIR)
INCLUDEDIR = $(DESTDIR)$(PREFIX)/include
LIBDIR = $(DESTDIR)$(EXEC_PREFIX)/lib
PID_FILE ?= /var/run/$(CPROG).pid

# build tools
MKDIR = mkdir -p
RMF = rm -f
RMRF = rm -rf

# desired configuration of the document root
# never assume that the document_root actually
# exists on the build machine.  When building
# a chroot, PREFIX if just a directory which
# later becomes /.
DOCUMENT_ROOT = $(HTMLDIR)
PORTS = 8080
USE_STACK_SIZE ?= 102400

BUILD_DIRS = $(BUILD_DIR) $(BUILD_DIR)/src $(BUILD_DIR)/resources

LIB_SOURCES = src/civetweb.c
LIB_INLINE  = src/*.inl
APP_SOURCES = src/main.c
WINDOWS_RESOURCES = resources/res.rc
UNIT_TEST_SOURCES = test/unit_test.c
SOURCE_DIRS =

OBJECTS = $(LIB_SOURCES:.c=.o) $(APP_SOURCES:.c=.o)
HEADERS = include/civetweb.h
BUILD_RESOURCES =

# The unit tests include the source files directly to get visibility to the
# static functions.  So we clear OBJECTS so that we don't try to build or link
# with any external object.  Later if we find WITH_LUA=1, we'll add lua objects
# to this variable so we can run lua-specific unit tests.
ifeq ($(MAKECMDGOALS), unit_test)
OBJECTS =
BUILD_DIRS += $(BUILD_DIR)/test
endif

# only set main compile options if none were chosen
CFLAGS += -Wall -Wextra -Wshadow -Wformat-security -Winit-self -Wmissing-prototypes -D$(TARGET_OS) -Iinclude $(COPT) -DUSE_STACK_SIZE=$(USE_STACK_SIZE)

ifdef WITH_CFLAGS
  CFLAGS += $(WITH_CFLAGS)
endif

LIBS =
ifneq ($(TARGET_OS), RTEMS)
LIBS += -lpthread
endif
LIBS += -lm $(LOPT)

ifdef WITH_DEBUG
  CFLAGS += -g -DDEBUG
else ifdef TEST_ASAN
  CFLAGS += -g -fsanitize=address
  CC = clang
  CXX = clang++
else ifdef TEST_FUZZ
  CFLAGS += -g -fsanitize=address,fuzzer,undefined -O0 -g -ggdb3 -fno-omit-frame-pointer -fsanitize-address-use-after-scope -fno-sanitize-recover=undefined
  CC = clang
  CXX = clang++
  BUILD_DIRS += $(BUILD_DIR)/fuzztest
  APP_SOURCES = fuzztest/fuzzmain.c
  OBJECTS = $(LIB_SOURCES:.c=.o) $(APP_SOURCES:.c=.o)
  CFLAGS += -DTEST_FUZZ$(TEST_FUZZ)
else
  CFLAGS += -O2 -DNDEBUG
endif

ifdef NO_SSL
  CFLAGS += -DNO_SSL
else ifdef WITH_MBEDTLS
  CFLAGS += -DUSE_MBEDTLS
  LIBS += -lmbedcrypto -lmbedtls -lmbedx509
else ifdef WITH_OPENSSL_API_1_0
  CFLAGS += -DOPENSSL_API_1_0
else ifdef WITH_OPENSSL_API_1_1
  CFLAGS += -DOPENSSL_API_1_1
else ifdef WITH_OPENSSL_API_3_0
  CFLAGS += -DOPENSSL_API_3_0
else
  #Use OpenSSL 1.1 API version as default
  CFLAGS += -DOPENSSL_API_1_1
endif
ifdef NO_CGI
  CFLAGS += -DNO_CGI
endif
ifdef NO_CACHING
  CFLAGS += -DNO_CACHING
endif


ifdef WITH_CPP
  OBJECTS += src/CivetServer.o
  HEADERS += include/CivetServer.h
  LCC = $(CXX)
else
  LCC = $(CC)
endif


ifdef WITH_ALL
  WITH_WEBSOCKET = 1
  WITH_IPV6 = 1
  WITH_LUA = 1
  WITH_DUKTAPE = 1
  WITH_SERVER_STATS = 1
  WITH_ZLIB = 1
  WITH_HTTP2 = 1
  WITH_X_DOM_SOCKET = 1
  WITH_EXPERIMENTAL = 1
  #WITH_CPP is not defined, ALL means only real features, not wrappers
endif

# Use Lua?
ifdef WITH_LUA_VERSION
  WITH_LUA = 1
endif

ifdef WITH_LUA_SHARED
  WITH_LUA = 1
endif

ifdef WITH_LUAJIT_SHARED
  WITH_LUA_SHARED = 1
  WITH_LUA = 1
  WITH_LUA_VERSION = 501
endif

ifdef WITH_LUA
  include resources/Makefile.in-lua
endif

# Use Duktape?
ifdef WITH_SSJS
  WITH_DUKTAPE = 1
endif

ifdef WITH_DUKTAPE_VERSION
  WITH_DUKTAPE = 1
endif

ifdef WITH_DUKTAPE_SHARED
  WITH_DUKTAPE = 1
endif

ifdef WITH_DUKTAPE
  include resources/Makefile.in-duktape
endif

# Use zlib?
ifdef WITH_COMPRESSION
  WITH_ZLIB = 1
endif

ifdef WITH_ZLIB
ifneq ($(TARGET_OS), RTEMS)
  LIBS += -lz
endif
  CFLAGS += -DUSE_ZLIB
endif

ifdef WITH_HTTP2
  CFLAGS += -DUSE_HTTP2
endif

# Other features
ifdef WITH_EXPERIMENTAL
  CFLAGS += -DMG_EXPERIMENTAL_INTERFACES
endif

ifdef WITH_IPV6
  CFLAGS += -DUSE_IPV6
endif

ifdef WITH_WEBSOCKET
  CFLAGS += -DUSE_WEBSOCKET
endif
ifdef WITH_WEBSOCKETS
  CFLAGS += -DUSE_WEBSOCKET
endif
ifdef WITH_X_DOM_SOCKET
  CFLAGS += -DUSE_X_DOM_SOCKET
endif
ifdef WITH_X_DOM_SOCKETS
  CFLAGS += -DUSE_X_DOM_SOCKET
endif

ifdef WITH_SERVER_STAT
  CFLAGS += -DUSE_SERVER_STATS
endif
ifdef WITH_SERVER_STATS
  CFLAGS += -DUSE_SERVER_STATS
endif

ifdef WITH_DAEMONIZE
  CFLAGS += -DDAEMONIZE -DPID_FILE=\"$(PID_FILE)\"
endif

# File names
ifdef CONFIG_FILE
  CFLAGS += -DCONFIG_FILE=\"$(CONFIG_FILE)\"
endif

ifdef CONFIG_FILE2
  CFLAGS += -DCONFIG_FILE2=\"$(CONFIG_FILE2)\"
endif

ifdef SSL_LIB
  CFLAGS += -DSSL_LIB=\"$(SSL_LIB)\"
endif

ifdef CRYPTO_LIB
  CFLAGS += -DCRYPTO_LIB=\"$(CRYPTO_LIB)\"
endif

BUILD_DIRS += $(addprefix $(BUILD_DIR)/, $(SOURCE_DIRS))
BUILD_OBJECTS = $(addprefix $(BUILD_DIR)/, $(OBJECTS))
MAIN_OBJECTS = $(addprefix $(BUILD_DIR)/, $(APP_SOURCES:.c=.o))
LIB_OBJECTS = $(filter-out $(MAIN_OBJECTS), $(BUILD_OBJECTS))

ifeq ($(TARGET_OS),LINUX)
  LIBS += -lrt -ldl
  CAN_INSTALL = 1
endif

ifeq ($(TARGET_OS),WIN32)
  MKDIR = mkdir
  RMF = del /q
  RMRF = rmdir /s /q
endif

ifdef WITH_LUAJIT_SHARED
  LIBS += -lluajit-5.1
else
ifdef WITH_LUA_SHARED
  LIBS += $(LUA_SHARED_LIB_FLAG)
endif
endif

ifneq (, $(findstring mingw32, $(shell $(CC) -dumpmachine)))
  BUILD_RESOURCES = $(BUILD_DIR)/$(WINDOWS_RESOURCES:.rc=.o)
  LIBS += -lws2_32 -mwindows
  SHARED_LIB = dll
else
  SHARED_LIB = so
endif

all: build

help:
	@echo "make help                show this message"
	@echo "make build               compile"
	@echo "make install             install on the system"
	@echo "make clean               clean up the mess"
	@echo "make install-headers     install headers"
	@echo "make lib                 build a static library"
	@echo "make install-lib         install the static library"
	@echo "make slib                build a shared library"
	@echo "make install-slib        install the shared library"
	@echo "make unit_test           (obsolete - unit tests use cmake now)"
	@echo ""
	@echo " Make Options"
	@echo "   WITH_LUA=1            build with Lua support; include Lua as static library"
	@echo "   WITH_LUA_SHARED=1     build with Lua support; use dynamic linking to liblua5.2.so"
	@echo "   WITH_LUA_VERSION=502  build with Lua 5.2.x (501 for Lua 5.1.x to 503 for 5.3.x)"
	@echo "   WITH_DUKTAPE=1        build with Duktape support; include as static library"
	@echo "   WITH_DUKTAPE_SHARED=1 build with Duktape support; use libduktape1.3.so"
	@echo "   WITH_DUKTAPE_VERSION=108 build with Duktape 1.8.x"
	@echo "   WITH_DEBUG=1          build with GDB debug support"
	@echo "   WITH_IPV6=1           with IPV6 support"
	@echo "   WITH_WEBSOCKET=1      build with web socket support"
	@echo "   WITH_SERVER_STATS=1   build includes support for server statistics"
	@echo "   WITH_ZLIB=1           build includes support for on-the-fly compression using zlib"
	@echo "   WITH_CPP=1            build library with c++ classes"
	@echo "   WITH_EXPERIMENTAL=1   build with experimental features"
	@echo "   WITH_DAEMONIZE=1      build with daemonize."
	@echo "   WITH_MBEDTLS=1        build with mbedTLS support."
	@echo "   WITH_OPENSSL_API_1_0=1  build with OpenSSL 1.0.x support."
	@echo "   WITH_OPENSSL_API_1_1=1  build with OpenSSL 1.1.x support."
	@echo "   WITH_OPENSSL_API_3_0=1  build with OpenSSL 3.0.x support."
	@echo "   NO_SSL=1              build without SSL support. Build will not need libcrypto/libssl."
	@echo "   NO_CGI=1              build without CGI support."
	@echo "   NO_CACHING=1          disable caching. Send no-cache/no-store headers."
	@echo "   PID_FILE=/path        PID file path of daemon."
	@echo "   CONFIG_FILE=file      use 'file' as the config file"
	@echo "   CONFIG_FILE2=file     use 'file' as the backup config file"
	@echo "   DOCUMENT_ROOT=/path   document root override when installing"
	@echo "   PORTS=8080            listening ports override when installing"
	@echo "   SSL_LIB=libssl.so.0   use versioned SSL library"
	@echo "   CRYPTO_LIB=libcrypto.so.0 system versioned CRYPTO library"
	@echo "   PREFIX=/usr/local     sets the install directory"
	@echo "   COPT='-DNO_SSL'       method to insert compile flags"
	@echo "   LOPT='-lxxx'          method to link xxx library"
	@echo ""
	@echo " Compile Flags"
	@echo "   NDEBUG                strip off all debug code"
	@echo "   DEBUG                 build debug version (very noisy)"
	@echo "   NO_CGI                disable CGI support"
	@echo "   NO_SSL                disable SSL functionality"
	@echo "   NO_SSL_DL             link against system libssl library"
	@echo "   NO_FILES              do not serve files from a directory"
	@echo "   NO_CACHING            disable caching (useful for systems without timegm())"
	@echo ""
	@echo " Variables"
	@echo "   TARGET_OS='$(TARGET_OS)'"
	@echo "   CFLAGS='$(CFLAGS)'"
	@echo "   CXXFLAGS='$(CXXFLAGS)'"
	@echo "   LDFLAGS='$(LDFLAGS)'"
	@echo "   CC='$(CC)'"
	@echo "   CXX='$(CXX)'"
	@echo ""

build: $(CPROG) $(CXXPROG)

unit_test: $(UNIT_TEST_PROG)

ifeq ($(CAN_INSTALL),1)
install: $(HTMLDIR)/index.html $(SYSCONFDIR)/civetweb.conf
	install -D -m 644 -t "$(DOCDIR)/" *.md
	install -D -m 755 -t "$(BINDIR)/" $(CPROG)

install-headers:
	install -D -m 644 -t "$(INCLUDEDIR)/" $(HEADERS)

install-lib: lib$(CPROG).a
	install -D -m 644 -t "$(LIBDIR)/" $<

install-slib: lib$(CPROG).so
	$(eval version=$(shell grep -w "define CIVETWEB_VERSION" include/civetweb.h | sed 's|.*VERSION "\(.*\)"|\1|g'))
	$(eval major=$(shell echo $(version) | cut -d'.' -f1))
	install -D -m 755 -t "$(LIBDIR)" $<.$(version).0
	cd "$(LIBDIR)" && ln -sfv $<.$(version).0 $<.$(major)
	cd "$(LIBDIR)" && ln -sfv $<.$(version).0 $<

# Install target we do not want to overwrite
# as it may be an upgrade
$(HTMLDIR)/index.html:
	install -D -m 644 resources/itworks.html $(HTMLDIR)/index.html
	install -D -m 644 -t "$(HTMLDIR)/" resources/civetweb_64x64.png

# Install target we do not want to overwrite
# as it may be an upgrade
$(SYSCONFDIR)/civetweb.conf:
	install -D -m 644 -t "$(SYSCONFDIR)/" resources/civetweb.conf
	@sed -i 's#^document_root.*$$#document_root $(DOCUMENT_ROOT)#' "$(SYSCONFDIR)/civetweb.conf"
	@sed -i 's#^listening_ports.*$$#listening_ports $(PORTS)#' "$(SYSCONFDIR)/civetweb.conf"

else
install:
	@echo "Target not flagged for installation.  Use CAN_INSTALL=1 to force"
	@echo "As a precaution only LINUX targets are set as installable."
	@echo "If the target is linux-like, use CAN_INSTALL=1 option."
endif

lib: lib$(CPROG).a

slib: lib$(CPROG).$(SHARED_LIB)

clean:
	$(RMRF) $(BUILD_DIR)
	$(eval version=$(shell grep -w "define CIVETWEB_VERSION" include/civetweb.h | sed 's|.*VERSION "\(.*\)"|\1|g'))
	$(eval major=$(shell echo $(version) | cut -d'.' -f1))
	$(RMRF) lib$(CPROG).a
	$(RMRF) lib$(CPROG).so
	$(RMRF) lib$(CPROG).so.$(major)
	$(RMRF) lib$(CPROG).so.$(version).0
	$(RMRF) $(CPROG)
	$(RMF) $(UNIT_TEST_PROG)

distclean: clean
	@$(RMRF) VS2012/Debug VS2012/*/Debug  VS2012/*/*/Debug
	@$(RMRF) VS2012/Release VS2012/*/Release  VS2012/*/*/Release
	$(RMF) $(CPROG) lib$(CPROG).so lib$(CPROG).a *.dmg *.msi *.exe lib$(CPROG).dll lib$(CPROG).dll.a
	$(RMF) $(UNIT_TEST_PROG)

$(LIB_OBJECTS): CFLAGS += -fPIC

lib$(CPROG).a: CFLAGS += -fPIC
lib$(CPROG).a: $(LIB_OBJECTS)
	@$(RMF) $@
	ar cq $@ $(LIB_OBJECTS)

lib$(CPROG).so: CFLAGS += -fPIC
lib$(CPROG).so: $(LIB_OBJECTS)
	$(eval version=$(shell grep -w "define CIVETWEB_VERSION" include/civetweb.h | sed 's|.*VERSION "\(.*\)"|\1|g'))
	$(eval major=$(shell echo $(version) | cut -d'.' -f1))
	$(LCC) -shared -Wl,-soname,$@.$(major) -o $@.$(version).0 $(CFLAGS) $(LDFLAGS) $(LIB_OBJECTS) $(LIBS)
	ln -s -f $@.$(major) $@
	ln -s -f $@.$(version).0 $@.$(major)

lib$(CPROG).dll: CFLAGS += -fPIC
lib$(CPROG).dll: $(LIB_OBJECTS)
	$(LCC) -shared -o $@ $(CFLAGS) $(LDFLAGS) $(LIB_OBJECTS) $(LIBS) -Wl,--out-implib,lib$(CPROG).dll.a

$(UNIT_TEST_PROG): CFLAGS += -Isrc -g
$(UNIT_TEST_PROG): $(LIB_SOURCES) $(LIB_INLINE) $(UNIT_TEST_SOURCES) $(BUILD_OBJECTS)
	$(LCC) -o $@ $(CFLAGS) $(LDFLAGS) $(UNIT_TEST_SOURCES) $(BUILD_OBJECTS) $(LIBS)

$(CPROG): $(BUILD_OBJECTS) $(BUILD_RESOURCES)
	$(LCC) -o $@ $(CFLAGS) $(LDFLAGS) $(BUILD_OBJECTS) $(BUILD_RESOURCES) $(LIBS)

$(CXXPROG): $(BUILD_OBJECTS)
	$(CXX) -o $@ $(CFLAGS) $(LDFLAGS) $(BUILD_OBJECTS) $(LIBS)

$(BUILD_OBJECTS): $(BUILD_DIRS)

$(BUILD_DIRS):
	-@$(MKDIR) "$@"

$(BUILD_DIR)/%.o : %.cpp
	$(CXX) -c $(CFLAGS) $(CXXFLAGS) $< -o $@

$(BUILD_DIR)/%.o : %.c
	$(CC) -c $(CFLAGS) $< -o $@

$(BUILD_RESOURCES) : $(WINDOWS_RESOURCES)
	windres $(WINDRES_FLAGS) $< $@

# This rules is used to keep the code formatted in a reasonable manor
# For this to work astyle must be installed and in the path
# http://sourceforge.net/projects/astyle
indent:
	astyle --suffix=none --style=linux --indent=spaces=4 --lineend=linux  include/*.h src/*.c src/*.cpp src/*.inl examples/*/*.c  examples/*/*.cpp

.PHONY: all help build install clean lib so