Makefile

TX_VERSION ?= 2_6
DEMO_BRANCH ?= prod-2-6

ANGULAR_VERSION := $(shell buildtools/get-version angular)

ESLINT_CONFIG_FILES := $(shell find * -not -path 'node_modules/*' -type f -name '.eslintrc*')
WEBPACK_CONFIG_FILES := $(shell find . -not -path './node_modules/*' -name 'webpack.*.js')

API_JS_FILES = $(shell find api/src/ -type f -name '*.js')
NGEO_JS_FILES = $(shell find src/ -type f -name '*.js')
NGEO_PARTIALS_FILES := $(shell find src/ -name '*.html')
NGEO_ALL_SRC_FILES := $(shell find src/ -type f)
NGEO_TEST_JS_FILES := $(shell find test/ -type f -name '*.js')
NGEO_EXAMPLES_HTML_FILES := $(shell ls -1 examples/*.html)
NGEO_EXAMPLES_JS_FILES := $(NGEO_EXAMPLES_HTML_FILES:.html=.js)

GMF_PARTIALS_FILES := $(shell find contribs/gmf/src/ -name *.html)
GMF_JS_FILES := $(shell find contribs/gmf/src/ -type f -name '*.js')
GMF_ALL_SRC_FILES := $(shell find contribs/gmf/src/ -type f) $(NGEO_ALL_SRC_FILES)
GMF_TEST_JS_FILES := $(shell find contribs/gmf/test/ -type f -name '*.js')
GMF_EXAMPLES_HTML_FILES := $(shell ls -1 contribs/gmf/examples/*.html)
GMF_EXAMPLES_JS_FILES := $(GMF_EXAMPLES_HTML_FILES:.html=.js)

GMF_APPS += mobile desktop desktop_alt iframe_api mobile_alt oeedit
GMF_APPS_JS_FILES = $(shell find contribs/gmf/apps/ -type f -name '*.js')
BUILD_JS_FILES = $(shell find buildtools/ -type f -name '*.js')
GMF_APPS_PARTIALS_FILES = $(shell find contribs/gmf/apps/ -type f -name '*.html' -or -name '*.html.ejs')
GMF_APPS_ALL_FILES = $(shell find contribs/gmf/apps/ -type f) $(GMF_ALL_SRC_FILES)

CHECK_EXAMPLE_CHECKER := $(patsubst test/check-example/%.html,.build/test-check-example/%.check.timestamp,$(shell ls -1 test/check-example/*.html))
BUILD_EXAMPLES_CHECK_TIMESTAMP_FILES := \
	$(addprefix .build/contribs/gmf/apps/,$(addsuffix .check.timestamp,$(GMF_APPS))) \
	$(patsubst examples/%.html,.build/%.check.timestamp,$(NGEO_EXAMPLES_HTML_FILES)) \
	$(patsubst contribs/gmf/examples/%.html,.build/contribs/gmf/%.check.timestamp,$(GMF_EXAMPLES_HTML_FILES))


# Git
GITHUB_USERNAME ?= camptocamp
GIT_BRANCH ?= $(shell git rev-parse --symbolic-full-name --abbrev-ref HEAD)
GIT_REMOTE_NAME ?= origin
export GITHUB_USERNAME
export GIT_BRANCH
export GIT_REMOTE_NAME


# i18n
L10N_LANGUAGES = fr de it
L10N_PO_FILES = \
	$(addprefix .build/locale/,$(addsuffix /LC_MESSAGES/ngeo.po, $(L10N_LANGUAGES))) \
	$(addprefix .build/locale/,$(addsuffix /LC_MESSAGES/gmf.po, $(L10N_LANGUAGES))) \
	$(addprefix .build/locale/,$(addsuffix /LC_MESSAGES/demo.po, $(L10N_LANGUAGES)))
LANGUAGES = en $(L10N_LANGUAGES)
ANGULAR_LOCALES_FILES = $(addprefix contribs/gmf/build/angular-locale_, $(addsuffix .js, $(LANGUAGES)))

ifeq (,$(wildcard $(HOME)/.transifexrc))
TOUCHBACK_TXRC = $(TOUCH_DATE) "$(shell date --iso-8601=seconds)" $(HOME)/.transifexrc
else
TOUCHBACK_TXRC = $(TOUCH_DATE) "$(shell $(STAT_LAST_MODIFIED) $(HOME)/.transifexrc)" $(HOME)/.transifexrc
endif


# OS compatibility
OS := $(shell uname)
ifeq ($(OS),Darwin)
	STAT_LAST_MODIFIED = stat -f '%m'
	TOUCH_DATE = touch -t
else
	STAT_LAST_MODIFIED = stat -c '%y'
	TOUCH_DATE = touch --date
endif

ifneq (,$(findstring CYGWIN,$(OS)))
	PY_VENV_BIN = .build/python-venv/Scripts
	PY_VERSION =
else
	PY_VENV_BIN = .build/python-venv/bin
	PY_VERSION = --python python3
endif


# Disabling Make built-in rules to speed up execution time
.SUFFIXES:

.PHONY: all
all: help

.PHONY: help
help:
	@echo "Usage: make <target>"
	@echo
	@echo "Main targets:"
	@echo
	@echo "- help                        Display this help message"
	@echo "- serve-ngeo                  Run a development web server for running the ngeo examples"
	@echo "- serve-api                   Run a development web server for running the api examples"
	@echo "- serve-gmf                   Run a development web server for running the gmf examples"
	@echo "- serve-gmf-apps              Run a development web server for running the gmf apps"
	@echo "- examples-hosted             Build the hosted examples"
	@echo "- examples-hosted-ngeo        Build the ngeo hosted examples"
	@echo "- examples-hosted-gmf         Build the gmf hosted examples"
	@echo "- examples-hosted-apps        Build the gmf apps hosted examples"
	@echo "- check                       Perform a number of checks on the code"
	@echo "- test                        Run the test suite"
	@echo "- test-debug                  Run the test suite in the browser"
	@echo "- clean                       Remove generated files"
	@echo "- cleanall                    Remove all the build artifacts"
	@echo "- cleanallcache               Remove all the build artifacts and the extra caches (npm and pip)"
	@echo
	@echo "Secondary targets:"
	@echo
	@echo "- lint                    Check the code with the linter"
	@echo "- gh-pages                Update the GitHub pages"
	@echo

.PHONY: check
check: lint spell check-examples-checker check-examples test examples-hosted-apps

.PHONY: check-examples-checker
check-examples-checker: $(CHECK_EXAMPLE_CHECKER)

.PHONY: check-examples
check-examples: $(BUILD_EXAMPLES_CHECK_TIMESTAMP_FILES)

.PHONY: lint
lint: .build/eslint.timestamp eclint lint-extra

.PHONY: lint-extra
lint-extra:
	if [ "`git grep @fileoverview src contribs`" != "" ]; then echo "Using @fileoverview breaks the documentation main page"; false; fi
	if [ "`git grep @example src contribs`" != "" ]; then echo "We don't use @example to have the example in the description"; false; fi

.PHONY: spell
spell: .build/python-venv.timestamp
	$(PY_VENV_BIN)/codespell --quiet-level=2 --ignore-words=spell-ignore-words.txt \
		$(shell find -name 'node_modules' -prune -or -name '.build' -prune -or -name '.git' -prune \
		-or -name '__pycache__' -prune -or -name 'build' -prune \
		-or \( -type f -and -not -name '*.png' -and -not -name '*.mo' -and -not -name '*.po*' -and -not -name '*_translation' \
		-and -not -name 'themescapabilities.js' -and -not -name 'themes.js' -and -not -name 'prettify.js' \
		-and -not -name 'asitvd.capabilities.xml' \) -print)

.PHONY: eslint
eslint: .build/eslint.timestamp

.PHONY: eclint
eclint: .build/node_modules.timestamp
	npm run eclint

.PHONY: test
test: .build/node_modules.timestamp .build/build-dll.timestamp
	TS_NODE_PROJECT=disable.json ./node_modules/karma/bin/karma start karma-conf.js --single-run

.PHONY: test-debug
test-debug: .build/node_modules.timestamp .build/build-dll.timestamp .build/node_modules_karma-chrome-launcher.timestamp
	TS_NODE_PROJECT=disable.json ./node_modules/karma/bin/karma start karma-conf.js --browsers=Chrome --single-run=false --autoWatch=true --debug

.build/node_modules_karma-chrome-launcher.timestamp:
	npm install karma-chrome-launcher
	mkdir -p $(dir $@)
	touch $@

.PHONY: serve-ngeo
serve-ngeo: examples/dist $(ANGULAR_LOCALES_FILES)
	npm run serve-ngeo-examples

.PHONY: serve-gmf
serve-gmf: contribs/dist $(ANGULAR_LOCALES_FILES)
	npm run serve-gmf-examples

.PHONY: serve-gmf-apps
serve-gmf-apps: .build/build-dll.timestamp $(ANGULAR_LOCALES_FILES)
	npm run serve-gmf-apps

.PHONY: serve-api
serve-api: .build/node_modules.timestamp
	npm run serve-api

.PHONY: examples-hosted
examples-hosted: \
		examples-hosted-ngeo \
		examples-hosted-gmf \
		examples-hosted-apps

.PHONY: examples-hosted-ngeo
examples-hosted-ngeo: .build/examples-ngeo.timestamp .build/examples-hosted/index.html

.build/examples-ngeo.timestamp: $(NGEO_ALL_SRC_FILES) $(WEBPACK_CONFIG_FILES) \
		.build/node_modules.timestamp \
		.build/build-dll.timestamp \
		.build/examples-hosted/dist \
		.build/examples-hosted/partials
	npm run build-ngeo-examples
	touch $@

.PHONY: examples-hosted-gmf
examples-hosted-gmf: .build/examples-gmf.timestamp .build/examples-hosted/contribs/gmf/index.html

.build/examples-gmf.timestamp: $(GMF_ALL_SRC_FILES) $(WEBPACK_CONFIG_FILES) \
		.build/node_modules.timestamp \
		.build/build-dll.timestamp \
		.build/examples-hosted/dist
	npm run build-gmf-examples
	touch $@

.PHONY: examples-hosted-apps
examples-hosted-apps: .build/gmf-apps.timestamp

.build/gmf-apps.timestamp: $(GMF_APPS_ALL_SRC_FILES) $(WEBPACK_CONFIG_FILES) \
		.build/node_modules.timestamp \
		.build/examples-hosted/dist \
		.build/examples-hosted-gmf-apps-deps.timestamp
	npm run build-gmf-apps
	touch $@

.PHONY: gh-pages
gh-pages: .build/python-venv.timestamp
	buildtools/deploy.sh

.build/node_modules.copyright.timestamp: .build/node_modules.timestamp
	npm install --no-save -no-optional --no-package-lock buildtools/copyright
	touch $@

.build/eslint.timestamp: .build/node_modules.copyright.timestamp $(ESLINT_CONFIG_FILES) \
		$(API_JS_FILES) \
		$(NGEO_JS_FILES) \
		$(NGEO_TEST_JS_FILES) \
		$(NGEO_EXAMPLES_JS_FILES) \
		$(GMF_TEST_JS_FILES) \
		$(GMF_JS_FILES) \
		$(GMF_EXAMPLES_JS_FILES) \
		$(GMF_APPS_JS_FILES) \
		$(BUILD_JS_FILES)
	./node_modules/.bin/eslint $(filter-out .build/node_modules.copyright.timestamp $(ESLINT_CONFIG_FILES), $^)
	touch $@

.build/examples-hosted/partials: examples/partials/
	mkdir -p $(dir $@)
	cp -r $< $@

.build/examples-hosted/dist: .build/build-dll.timestamp
	mkdir -p .build/examples-hosted/
	cp -r dist .build/examples-hosted/
	touch $@

examples/dist: .build/build-dll.timestamp
	mkdir -p .build/examples-hosted/
	cp -r dist examples/
	touch $@

contribs/dist: .build/build-dll.timestamp
	mkdir -p .build/examples-hosted/
	cp -r dist contribs/
	touch $@

.build/examples-hosted-gmf-apps-deps.timestamp: \
		$(addprefix contribs/gmf/build/gmf-, $(addsuffix .json, $(LANGUAGES))) \
		$(addprefix contribs/gmf/build/angular-locale_, $(addsuffix .js, $(LANGUAGES)))
	mkdir -p .build/examples-hosted/contribs/gmf
	# We need the files for each app
	# To simplify processing, we first copy them in gmfappsdeps directory, then from there to each app
	$(foreach f,$^,mkdir -p .build/examples-hosted/gmfappsdeps/`dirname $(f)`; cp $(f) .build/examples-hosted/gmfappsdeps/$(f);)
	rsync --recursive .build/examples-hosted/gmfappsdeps/contribs/gmf/ .build/examples-hosted/contribs/gmf/apps/;)
	touch $@

.build/examples-hosted/index.html: \
		buildtools/examples-index.mako.html \
		$(NGEO_EXAMPLES_HTML_FILES) \
		.build/python-venv.timestamp
	mkdir -p $(dir $@)
	$(PY_VENV_BIN)/python buildtools/generate-examples-index.py \
		--app 'GeoMapFish' contribs/gmf/ 'GeoMapFish examples.' \
		--app 'API help' ../api/apihelp/apihelp.html 'GeoMapFish API help.' \
		$< $(NGEO_EXAMPLES_HTML_FILES) > $@

.build/examples-hosted/contribs/gmf/index.html: \
		buildtools/examples-index.mako.html \
		$(GMF_EXAMPLES_HTML_FILES) \
		.build/python-venv.timestamp
	mkdir -p $(dir $@)
	$(PY_VENV_BIN)/python buildtools/generate-examples-index.py \
		--app 'Mobile application' apps/mobile.html 'The mobile example application for GeoMapFish.' \
		--app 'Desktop application' apps/desktop.html 'The desktop example application for GeoMapFish.' \
		--app 'Alternate mobile application' apps/mobile_alt.html 'An alternate mobile example application for GeoMapFish.' \
		--app 'Alternate desktop application' apps/desktop_alt.html 'An alternate desktop example application for GeoMapFish.' \
		--app 'Iframe api application' apps/iframe_api.html 'A desktop application for GeoMapFish without any tools that can be used within an iframe.' \
		--app 'Object editing editor' \
			'apps/oeedit.html?objectediting_geomtype=MultiPolygon&objectediting_id=Test&objectediting_layer=112&objectediting_theme=ObjectEditing&objectediting_property=name&tree_groups=ObjectEditing' \
			'An example application for editing an object.' \
		$< $(GMF_EXAMPLES_HTML_FILES) > $@

.build/httpserver.timestamp:
	python3 -m http.server 3000 &
	touch $@

.build/%.check.timestamp: .build/examples-ngeo.timestamp \
		.build/node_modules.timestamp \
		.build/httpserver.timestamp
	mkdir -p $(dir $@)
	CI=true LANGUAGE=en_US node buildtools/check-example.js \
		.build/examples-hosted/$*.html
	[ "$$(gm compare -metric RMSE -highlight-style xor .build/examples-hosted/$*.html.png \
		examples/$*-ref.png -file .build/examples-hosted/$*.html.png-diff.png 2>&1 | \
		tail --lines=1 | sed 's/.* \([0-9\.]\+\) .*/\1/g')" \< 0.005 ]
	touch $@

.build/error.check.timestamp: .build/examples-ngeo.timestamp \
		.build/node_modules.timestamp \
		.build/httpserver.timestamp
	mkdir -p $(dir $@)
	CI=true LANGUAGE=en_US node buildtools/check-example.js \
		.build/examples-hosted/error.html
	gm compare -metric RMSE -highlight-style xor .build/examples-hosted/error.html.png \
		examples/error-ref.png -file .build/examples-hosted/error.html.png-diff.png
	[ "$$(gm compare -metric RMSE -highlight-style xor .build/examples-hosted/error.html.png \
		examples/error-ref.png -file .build/examples-hosted/error.html.png-diff.png 2>&1 | \
		tail --lines=1 | sed 's/.* \([0-9\.]\+\) .*/\1/g')" \> 0.005 ]
	touch $@

.build/contribs/gmf/%.check.timestamp: .build/examples-gmf.timestamp \
		.build/node_modules.timestamp \
		.build/httpserver.timestamp
	mkdir -p $(dir $@)
	CI=true LANGUAGE=en_US node buildtools/check-example.js \
		.build/examples-hosted/contribs/gmf/$*.html
	[ "$$(gm compare -metric RMSE -highlight-style xor .build/examples-hosted/contribs/gmf/$*.html.png \
		contribs/gmf/examples/$*-ref.png -file .build/examples-hosted/contribs/gmf/$*-diff.png 2>&1 | \
		tail --lines=1 | sed 's/.* \([0-9\.]\+\) .*/\1/g')" \< 0.005 ]
	touch $@

.build/contribs/gmf/apps/%.check.timestamp: .build/gmf-apps.timestamp \
		.build/httpserver.timestamp
	mkdir -p $(dir $@)
	CI=true LANGUAGE=en_US node buildtools/check-example.js \
		.build/examples-hosted/contribs/gmf/apps/$*.html
	[ "$$(gm compare -metric RMSE -highlight-style xor .build/examples-hosted/contribs/gmf/apps/$*.html.png \
		contribs/gmf/apps/$*-ref.png -file .build/examples-hosted/contribs/gmf/apps/$*-diff.png 2>&1 | \
		tail --lines=1 | sed 's/.* \([0-9\.]\+\) .*/\1/g')" \< 0.005 ]
	touch $@

.build/test-check-example/%.check.timestamp: \
		.build/httpserver.timestamp test/check-example/%.html
	mkdir -p $(dir $@)
	( ! CI=true LANGUAGE=en_US node buildtools/check-example.js test/check-example/$*.html)
	touch $@

.build/node_modules.timestamp: package.json
	npm install
	mkdir -p $(dir $@)
	touch $@

contribs/gmf/build/angular-locale_%.js: package.json
	mkdir -p $(dir $@)
	wget -O $@ https://raw.githubusercontent.com/angular/angular.js/v$(ANGULAR_VERSION)/src/ngLocale/angular-locale_$*.js

.build/python-venv.timestamp: requirements.txt
	mkdir -p $(dir $@)
	python3 -m venv .build/python-venv
	$(PY_VENV_BIN)/pip install `grep ^pip== requirements.txt --colour=never`
	$(PY_VENV_BIN)/pip install -r requirements.txt
	touch $@

# i18n

# if don't exists create one for read only access
$(HOME)/.transifexrc:
	echo "[https://www.transifex.com]" > $@
	echo "hostname = https://www.transifex.com" >> $@
	echo "username = c2c" >> $@
	echo "password = c2cc2c" >> $@
	echo "token =" >> $@

.tx/config: .tx/config.mako .build/python-venv.timestamp
	PYTHONIOENCODING=UTF-8 $(PY_VENV_BIN)/mako-render \
		--var "tx_version=$(TX_VERSION)" --var "languages=$(L10N_LANGUAGES)" $< > $@

contribs/gmf/apps/.tx/config: contribs/gmf/apps/.tx/config.mako .build/python-venv.timestamp
	PYTHONIOENCODING=UTF-8 $(PY_VENV_BIN)/mako-render \
		--var "tx_version=$(TX_VERSION)" --var "languages=$(L10N_LANGUAGES)" $< > $@

.build/locale/ngeo.pot: lingua.cfg .build/node_modules.timestamp \
		$(NGEO_PARTIALS_FILES) $(NGEO_JS_FILES)
	mkdir -p $(dir $@)
	node buildtools/extract-messages $(NGEO_PARTIALS_FILES) $(NGEO_JS_FILES) > $@

.build/locale/gmf.pot: lingua.cfg .build/node_modules.timestamp \
		$(GMF_PARTIALS_FILES) $(GMF_JS_FILES)
	mkdir -p $(dir $@)
	node buildtools/extract-messages $(GMF_PARTIALS_FILES) $(GMF_JS_FILES) > $@

.build/locale/apps.pot: lingua.cfg .build/node_modules.timestamp \
		$(GMF_APPS_PARTIALS_FILES) $(GMF_APPS_JS_FILES)
	mkdir -p $(dir $@)
	node buildtools/extract-messages $(GMF_APPS_PARTIALS_FILES) $(GMF_APPS_JS_FILES) > $@

.PHONY: transifex-get
transifex-get: $(L10N_PO_FILES) \
	.build/locale/ngeo.pot \
	.build/locale/gmf.pot \
	$(addprefix .build/locale/,$(addsuffix /LC_MESSAGES/apps.po, $(L10N_LANGUAGES)))

.PHONY: transifex-send
transifex-send: \
		.build/python-venv.timestamp \
		.tx/config \
		$(HOME)/.transifexrc \
		contribs/gmf/apps/.tx/config \
		.build/locale/ngeo.pot \
		.build/locale/gmf.pot \
		.build/locale/apps.pot
	$(PY_VENV_BIN)/tx push --source
	cd contribs/gmf/apps/; ../../../$(PY_VENV_BIN)/tx push --source

.PHONY: transifex-init
transifex-init: .build/python-venv.timestamp \
		.tx/config \
		$(HOME)/.transifexrc \
		contribs/gmf/apps/.tx/config \
		.build/locale/ngeo.pot \
		.build/locale/gmf.pot \
		.build/locale/apps.pot
	$(PY_VENV_BIN)/tx push --source --force --no-interactive
	$(PY_VENV_BIN)/tx push --translations --force --no-interactive

	cd contribs/gmf/apps/; ../../../$(PY_VENV_BIN)/tx push --source --force --no-interactive
	cd contribs/gmf/apps/; ../../../$(PY_VENV_BIN)/tx push --translations --force --no-interactive

.build/locale/%/LC_MESSAGES/ngeo.po: .tx/config $(HOME)/.transifexrc .build/python-venv.timestamp
	$(PY_VENV_BIN)/tx pull -l $* --force --mode=reviewed
	$(TOUCHBACK_TXRC)

.build/locale/%/LC_MESSAGES/gmf.po: .tx/config $(HOME)/.transifexrc .build/python-venv.timestamp
	$(PY_VENV_BIN)/tx pull -l $* --force --mode=reviewed
	$(TOUCHBACK_TXRC)

.PRECIOUS: .build/locale/%/LC_MESSAGES/apps.po
.build/locale/%/LC_MESSAGES/apps.po: contribs/gmf/apps/.tx/config $(HOME)/.transifexrc .build/python-venv.timestamp
	(cd contribs/gmf/apps/; ../../../$(PY_VENV_BIN)/tx pull -l $* --force --mode=reviewed)
	$(TOUCHBACK_TXRC)

.PRECIOUS: .build/locale/%/LC_MESSAGES/demo.po
.build/locale/%/LC_MESSAGES/demo.po:
	mkdir -p $(dir $@)
	wget -O $@ https://raw.githubusercontent.com/camptocamp/demo_geomapfish/$(DEMO_BRANCH)/geoportal/geomapfish_geoportal/locale/$*/LC_MESSAGES/geomapfish_geoportal-client.po

contribs/gmf/build/gmf-%.json: \
		.build/locale/%/LC_MESSAGES/ngeo.po \
		.build/locale/%/LC_MESSAGES/gmf.po \
		.build/locale/%/LC_MESSAGES/demo.po \
		.build/node_modules.timestamp
	mkdir -p $(dir $@)
	node buildtools/compile-catalog $(filter-out .build/node_modules.timestamp, $^) > $@


.PHONY: build-dll
build-dll: .build/build-dll.timestamp

.build/build-dll.timestamp: .build/python-venv.timestamp .build/node_modules.timestamp
	$(PY_VENV_BIN)/python3 buildtools/extract-ngeo-dependencies > deps.js && \
	npm run build-dll
	rm deps.js
	mkdir -p $(dir $@)
	touch $@

.PHONY: clean
clean:
	rm -f .build/*.check.timestamp
	rm -f .build/examples/*.js
	rm -f .build/eslint.timestamp
	rm -f .build/info.json
	rm -f .build/ngeo.json
	rm -f .build/gmf.json
	rm -f .build/app-*.json
	rm -rf apidoc
	rm -rf .build/examples-hosted
	rm -rf .build/contribs
	rm -f .build/locale/ngeo.pot
	rm -f .build/locale/gmf.pot
	rm -f .build/locale/demo.pot
	rm -rf contribs/gmf/build
	rm -f $(ANGULAR_LOCALES_FILES)

.PHONY: cleanall
cleanall: clean
	rm -rf dist
	rm -rf .build
	rm -rf node_modules
	rm -f .tx/config
	rm -f $(L10N_PO_FILES)

.PHONY: cleanallcache
cleanallcache: cleanall
	rm -rf $(HOME)/.npm
	rm -rf $(HOME)/.cache/pip