Makefile

# Product Makefile

# ========================================
export

SHELL = /bin/bash
cgDirApp=/opt/libre-bib
cgBin=$(cgDirApp)/bin
mRoot = dist/opt/libre-bib
mDirList = $(mRoot) dist/usr/local/bin
mCoreDir = ../src
RELEASE=1

include package/ver.mak

# ========================================

clean :
	-find . -type f -name '*~' -exec rm {} \; &>/dev/null
	-find . -type f -name '.phptidy-cache' -exec rm {} \; &>/dev/null
	-find . -type f -name '*.tmp' -exec rm {} \; &>/dev/null
	-find . -type f -name '*.bak' -exec rm {} \; &>/dev/null

dist-clean : clean
	if [[ -d tmp-test ]]; then \
		. $(cgDirApp)/etc/conf.env; \
		. tmp-test/conf.env; \
		echo "drop database $$cgDbName;" >cmd.tmp; \
		sudo mysql -u root <cmd.tmp; \
		rm cmd.tmp \
	fi
	-rm -rf tmp-test dist pkg tmp

# ========================================
# Cleanup and make dist/ area
build : build-setup mk-doc package/ver.mak

# ========================================
release :
	bin/incver.sh -m src/VERSION
	git commit -am "Inc Ver"
	git push origin develop
	git checkout main
	git pull origin main
	git merge develop
	git tag -f -F src/VERSION "v$$(cat src/VERSION)"
	git push --tags origin main
	git checkout develop
	bin/incver.sh -p src/VERSION

# ========================================
# Make deb package
package : clean dist pkg incver mk-dist mk-pkg

mk-dist : dist
	-find dist -type l -exec rm {} \; &>/dev/null
	-rm -rf dist/* &>/dev/null
	-mkdir -p dist$(cgDirApp) &>/dev/null
	rsync -avC LICENSE src/* dist$(cgDirApp)/
	find dist$(cgDirApp) -type d -exec chmod a+rx {} \;
	find dist$(cgDirApp) -type f -exec chmod a+r {} \;
	find dist$(cgDirApp) -type f -executable -exec chmod a+rx {} \;

mk-pkg : package/ver.sh package/epm.list
	cd package; . ./ver.env; epm -v -f native -m $$ProdOSDist-$$ProdArch --output-dir ../pkg $(ProdName) ver.epm
	cd package; . ./ver.env; epm -v -f portable -m $$ProdOSDist-$$ProdArch --output-dir ../pkg $(ProdName) ver.epm

package/epm.list : dist$(cgDirApp)
	cd package; mkepmlist -u root -g root --prefix / ../dist | patch-epm-list -f ./epm.patch >epm.list

# ========================================
# Push packages to release repositories
pkg-release:
	. package/ver.env; rsync -aP pkg/* $$ProdRelDir
	git ci -am Released
	git push origin develop
	bin/incver.sh -p src/VERSION
	git ci -am Updated

# ========================================
# Manual install - only for testing
install : clean $(cgDirApp) check clean
	-mkdir -p $(cgDirApp)/etc/old &>/dev/null
	-cp --backup=t $$(find $(cgDirApp)/etc/* -prune -type f) $(cgDirApp)/etc/old/
	rsync -aC src/* $(cgDirApp)/
	find $(cgDirApp) -type d -exec chmod a+rx {} \;
	find $(cgDirApp) -type f -exec chmod a+r {} \;
	find $(cgDirApp) -type f -executable -exec chmod a+rx {} \;
	bin/incver.sh -p src/VERSION
	@echo "Installed OK"

#sudo ln -fs /opt/libre-bib/bin/bib /usr/local/bin/bib

# ========================================
incver :
	bin/incver.sh -m src/VERSION

# ----------------------------------------
package/ver.sh : src/VERSION
	sed -i "s/ProdVer=\".*\"/ProdVer=\"$$(cat src/VERSION)\"/" package/ver.sh
	cd package; mkver.pl -e 'epm env mak'

# ========================================
mk-app-dir $(cgDirApp) :
	sudo mkdir -p $(cgDirApp)
	sudo chown -R $$SUDO_USER:$$SUDO_USER $(cgDirApp)
	sudo find $(cgDirApp) -type d -exec chmod a+rx {} \;
	sudo find $(cgDirApp) -type f -exec chmod a+r {} \;

# Use the rules
mk-doc : \
    src/doc/manual/libre-bib.html \
    src/doc/manual/libre-bib.md \
    src/doc/example/example-outline.html
	. src/etc/conf.env; \
	cgDirApp=$(PWD)/src; \
	cgBin=$(PWD)/src/bin; \
	make -f src/bin/bib-cmd.mak rebuild

# --------------------
db-setup : tmp-test/conf.env tmp-test/status-pkg.txt tmp-test/status-db.txt
	-rm tmp-test/status/*

tmp-test/conf.env :
	-rm -rf tmp-test
	mkdir tmp-test
	-cd tmp-test; bib setup-bib
	-cd tmp-test; bib setup-bib
	echo 'cgDbUser="example"' >>$@
	echo 'cgUseRemote=false' >>$@
	echo 'cgUseLib=true' >>$@
	echo 'cgVerbose=true' >>$@
#	exit 1

tmp-test/status-pkg.txt :
	# mPackageList is not defined
	sudo apt-get update
	-sudo apt-get -y install $(mPackageList)
	date >$@

tmp-test/status-db.txt :
	-echo 'show databases' | mysql -u example | grep biblio_example; \
	if [ $$? -ne 0 ]; then \
		. $(cgDirApp)/etc/conf.env; \
		. tmp-test/conf.env; \
		echo "create database $$cgDbName;" >cmd.tmp; \
		echo "create user '$$cgDbUser'@'localhost';" >>cmd.tmp; \
		echo "grant all privileges on $$cgDbName.* to '$$cgDbUser'@localhost;" >>cmd.tmp; \
		echo "flush privileges;" >>cmd.tmp; \
		echo "show databases;" >>cmd.tmp; \
		echo "show grants for '$$cgDbUser'@localhost;" >>cmd.tmp; \
		sudo mysql -u root <cmd.tmp; \
	fi
	date >$@

# -D $(cgDbName)

# remove later:
#  galera-4 libdbi-perl mariadb-server mariadb-server-10.5
#  mariadb-server-core-10.5

# ========================================
# So far these are just crude "happy-path" tests.

test : test1 test2 test3 test4 test5 test6 test7 test8 test9 test10 test-done

test1 : db-setup check # install

test2 :
	@echo -e "\n==========\nTest2 check db"
	echo -e "show databases;\n quit" | mysql -u example
	. $(cgDirApp)/etc/conf.env; \
	    . tmp-test/conf.env; \
	    echo "" >tmp-test/$$cgDbPassCache

test3 :
	@echo -e "\n==========\nTest3 import-lo"
	cd tmp-test; bib import-lo
	test -f tmp-test/status/import-lo.date
	echo 'show tables;' | mysql -u example biblio_example | grep lo

test4 :
	@echo -e "\n==========\nTest4 export-lo"
	cd tmp-test; bib export-lo
	test -f tmp-test/tmp/biblio.txt
	if diff tmp-test/biblio.txt tmp-test/tmp/biblio.txt | grep 'Id: '; then exit 1; fi

test5 :
	@echo -e "\n==========\nTest5 backup-lo"
	cd tmp-test; bib backup-lo
	test -f tmp-test/status/backup-lo.date
	test -f tmp-test/backup/backup-lo.csv

test6 :
	@echo -e "\n==========\nTest6 import-lib"
	cd tmp-test; bib import-lib
	test -f tmp-test/status/import-lib.date
	echo 'show tables;' | mysql -u example biblio_example | grep lib

test7 :
	@echo -e "\n==========\nTest7 ref-new"
	cd tmp-test; bib ref-new
	test -f tmp-test/status/ref-new.date
	test -f tmp-test/backup/example.odt
	if diff -q tmp-test/backup/example.odt tmp-test/example.odt; then exit 1; fi
	@echo "It is not clear why there is always a diff here. Timestamp?"
	cmp tmp-test/example.odt test/ref/example.odt | grep 'byte 16166'

test8 :
	@echo -e "\n==========\nTest8 ref-update"
	cd tmp-test; bib ref-update
	test -f tmp-test/status/ref-update.date
	test -f tmp-test/backup/example.odt
	cmp tmp-test/example.odt test/ref/example.odt | grep 'byte 16166'

test9 :
	@echo -e "\n==========\nTest9 status-bib"
	cd tmp-test; bib status-bib

test10 :
	@echo -e "\n==========\nTest10 reset example.odt"
	@echo "Reset, so test can be repeated"
	mv -f tmp-test/example.odt tmp-test/tmp
	cp -f src/doc/example/example.odt tmp-test/

test-done :
	@echo -e "\n==========\nPassed"

# ----------------------------------------
build-setup : build-packages update-my-util update-shfmt update-php-util update-pre-commit check

# ----------------------------------------
check :
	bin/check.sh
	bin/unit-test-shell.sh

# ----------------------------------------
build-packages : tmp product-packages \
		/usr/local/bin/epm \
		/usr/local/bin/mkver.pl \
		/usr/local/bin/beekeeper \
		/usr/bin/pod2pdf \
		/usr/bin/pod2markdown

mEpmMx=mx19/epm-5.0.2-1-mx19-x86_64.deb
mEpmUbuntu=ubuntu18/epm-5.0.1-2-linux-5.3-x86_64.deb
/usr/local/bin/epm :
	if [[ "$(ProdOSDist)" = "mx" ]]; then \
		cd tmp; wget $(ProdRelRoot)/released/software/ThirdParty/epm/$(mEpmMx); \
		sudo apt-get install -y tmp/$(notdir $(mEpmMx)); \
	fi
	if [[ "$(ProdOSDist)" = "ubuntu" ]]; then \
		cd tmp; wget $(ProdRelRoot)/released/software/ThirdParty/epm/$(mEpmUbuntu); \
		sudo apt-get install -y tmp/$(notdir $(mEpmUbuntu)); \
	fi

mEpmHelper=epm-helper-1.6.1-3-linux-noarch.deb
/usr/local/bin/mkver.pl :
	cd tmp; wget $(ProdRelRoot)/released/software/ThirdParty/epm/$(mEpmHelper)
	sudo apt-get install -y tmp/$(mEpmHelper)

/usr/bin/pod2pdf :
	sudo apt-get install -y pod2pdf

/usr/bin/pod2markdown :
	sudo apt-get install -y libpod-markdown-perl pod2pdf

product-packages : package/mx.require package/ubuntu.require
	if [[ "$(ProdOSDist)" = "mx" ]]; then \
		sudo apt-get install -y $$(awk '/%requires/ {print $$2}' package/mx.require); \
	fi
	if [[ "$(ProdOSDist)" = "ubuntu" ]]; then \
		sudo apt-get install -y $$(awk '/%requires/ {print $$2}' package/ubuntu.require); \
	fi

# ----------------------------------------
mBeekeeperVer=3.9.17
mBeekeeper=Beekeeper-Studio-$(mBeekeeperVer).AppImage

/usr/local/bin/beekeeper : /usr/local/bin/$(mBeekeeper)
	cd /usr/local/bin; sudo ln -sf $(mBeekeeper) beekeeper

/usr/local/bin/$(mBeekeeper) :
	cd tmp; wget https://github.com/beekeeper-studio/beekeeper-studio/releases/download/v$(mBeekeeperVer)/$(mBeekeeper)
	sudo mv -f tmp/$(mBeekeeper) $@
	sudo chmod a+rx $@

# ----------------------------------------
# my-utility-scripts - multiple scripts
mMyUtil=tag-1-17-0
mMyUtilList = \
	bin/incver.sh \
	bin/org2html.sh \
	bin/rm-trailing-sp \
	bin/shunit2.1 \
	bin/sort-para.sh \
	src/bin/sort-para.sh

update-my-util : tmp/my-utility-scripts-$(mMyUtil) $(mMyUtilList)

tmp/my-utility-scripts-$(mMyUtil) : tmp/$(mMyUtil).zip
	cd tmp; unzip -o $(mMyUtil).zip

tmp/$(mMyUtil).zip :
	cd tmp; wget https://github.com/TurtleEngr/my-utility-scripts/archive/refs/tags/$(mMyUtil).zip

bin/incver.sh : tmp/my-utility-scripts-$(mMyUtil)
	cp tmp/my-utility-scripts-$(mMyUtil)/bin/$(notdir $@) $@

bin/org2html.sh : tmp/my-utility-scripts-$(mMyUtil)
	cp tmp/my-utility-scripts-$(mMyUtil)/bin/$(notdir $@) $@

bin/rm-trailing-sp : tmp/my-utility-scripts-$(mMyUtil)
	cp tmp/my-utility-scripts-$(mMyUtil)/bin/$(notdir $@) $@

bin/shunit2.1 : tmp/my-utility-scripts-$(mMyUtil)
	cp tmp/my-utility-scripts-$(mMyUtil)/bin/$(notdir $@) $@

bin/sort-para.sh : tmp/my-utility-scripts-$(mMyUtil)
	cp tmp/my-utility-scripts-$(mMyUtil)/bin/$(notdir $@) $@

src/bin/sort-para.sh : bin/sort-para.sh
	cp $? $@

# ----------------------------------------
# shfmt
mShFmt=v3.1.2

update-shfmt : bin/shfmt

bin/shfmt : tmp/shfmt_$(mShFmt)_linux_amd64
	cp $? $@
	chmod a+rx $@

tmp/shfmt_$(mShFmt)_linux_amd64 :
	cd tmp; wget https://github.com/mvdan/sh/releases/download/$(mShFmt)/shfmt_$(mShFmt)_linux_amd64

# ----------------------------------------
# phptidy.php phpunit.phar
mPhpTidy=3.3
# if php7.2
mPhpUnit = phpunit-8.phar
# if php7.3
#mPhpUnit = phpunit-9.phar

update-php-util : bin/phptidy.php bin/phpunit.phar

bin/phptidy.php : tmp/phptidy
	cp $?/phptidy.php $@
	chmod a+rx $@

tmp/phptidy : tmp/phptidy-$(mPhpTidy).tar.gz

tmp/phptidy-$(mPhpTidy).tar.gz :
	cd tmp; wget https://github.com/cmrcx/phptidy/releases/download/v$(mPhpTidy)/phptidy-$(mPhpTidy).tar.gz
	cd tmp; tar -xzf phptidy-$(mPhpTidy).tar.gz

bin/phpunit.phar : tmp/$(mPhpUnit)
	cp tmp/$(mPhpUnit) bin
	chmod a+rx bin/$(mPhpUnit)
	cd bin; ln -s $(mPhpUnit) phpunit.phar
	sudo apt-get install -y php7.2-xml php7.2-mbstring

tmp/$(mPhpUnit) :
	cd tmp; wget https://phar.phpunit.de/$(mPhpUnit)

# ----------------------------------------
# pre-commit hook
# The detault gitproj.hook.tab-include-list is '*"
#     Only text files are looked at.
# gitproj.hook.tab-exclude-list is a "grep -E" pattern

mGitProj=tag-0-7-6-1

update-pre-commit : .git/hooks/pre-commit

.git/hooks/pre-commit : bin/pre-commit
	cp $? $@
	git config --bool gitproj.hook.pre-commit-enabled true
	git config --bool gitproj.hook.check-file-names true
	git config --bool gitproj.hook.check-whitespace true
	git config --bool gitproj.hook.check-for-tabs true
	git config gitproj.hook.tab-include-list
	git config gitproj.hook.tab-exclude-list 'Makefile|*.mak'
	git config --bool gitproj.hook.check-in-raw false
	git config --bool gitproj.hook.check-for-big-files true
	git config --int gitproj.hook.binary-file-size 30000
	git config --bool gitproj.hook.verbose true

bin/pre-commit : tmp/gitproj-$(mGitProj)/doc/hooks/pre-commit
	cp $? $@

tmp/gitproj-$(mGitProj)/doc/hooks/pre-commit : tmp/$(mGitProj).zip
	cd tmp; unzip -o $(mGitProj).zip gitproj-$(mGitProj)/doc/hooks/pre-commit
	touch $@

tmp/$(mGitProj).zip :
	cd tmp; wget https://github.com/TurtleEngr/gitproj/archive/refs/tags/$(mGitProj).zip

# ----------------------------------------
# Note: these rules are also in src/bin/bib-cmd.mak

%.md : %.html
	pandoc -f html -t markdown < $<  > $@

%.odt : %.html
	libreoffice --headless --convert-to odt $<

%.html : %.org
	bin/org2html.sh $< $@

# ----------------------------------------
tmp-test dist pkg tmp :
	-mkdir $@

mkCore :
	mkdir -p $(mDirList)
	'rsync' -a $mCoreDir/* $(mRoot)/
	'rsync' -a ../LICENSE $(mRoot)/doc
	'rsync' -a ../README.md $(mRoot)/doc
	find dist -type d -exec chmod a+rx {} \;
	find dist -type f -exec chmod a+r {} \;
	find dist -type f -executable -exec chmod a+rx {} \;

# ln -s /opt/libre-bib/bin/bib /usr/local/bin/bib

# ========================================

$(mRoot)/bin/phptidy.php : bin/phptidy.php
	'rsync' -a $? $@

$(mRoot)/bin : bin/sort-para.sh
	'rsync' -a $? $@