[config-package-dev.git] / divert.mk

# -*- mode: makefile; coding: utf-8 -*-
# Copyright © 2007-2008 Anders Kaseorg <andersk@mit.edu> and
#                       Tim Abbott <tabbott@mit.edu>
#
# This program is free software; you can redistribute it and/or
# modify it under the terms of the GNU General Public License as
# published by the Free Software Foundation; either version 2, or (at
# your option) any later version.
#
# This program 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
# General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
# 02111-1307 USA.

# Don't include divert.mk in your rules files directly; instead use
# config-package.mk.

# divert.mk handles the low-level diversion logic.  It includes
# divert.sh.in in the postinst and prerm scripts, and adds calls to the
# functions in divert.sh.in to add and remove diversions and symlinks at
# the appropriate points.

ifndef _cdbs_rules_divert
_cdbs_rules_divert = 1

include /usr/share/cdbs/1/rules/debhelper.mk

CDBS_BUILD_DEPENDS := $(CDBS_BUILD_DEPENDS), config-package-dev (>= 4.5~)

# divert.sh.in is included in the postinst/prerm scripts of packages
# installing diversions using config-package-dev.
DEB_DIVERT_SCRIPT = /usr/share/config-package-dev/divert.sh.in
# script used to encode the path of a file uniquely in a valid virtual
# package name.
DEB_DIVERT_ENCODER = /usr/share/config-package-dev/encode

DEB_DIVERT_PACKAGES += $(foreach package,$(DEB_ALL_PACKAGES), \
    $(if $(DEB_TRANSFORM_FILES_$(package)),$(package), \
    $(if $(DEB_REMOVE_FILES_$(package)),$(package), \
    $(if $(DEB_UNREMOVE_FILES_$(package)),$(package), \
    $(if $(DEB_UNDIVERT_FILES_$(package)),$(package), \
    $(if $(DEB_DIVERT_FILES_$(package)),$(package)))))))

ifeq ($(DEB_DIVERT_EXTENSION),)
DEB_DIVERT_EXTENSION = .divert
endif

# Replace only the last instance of DEB_DIVERT_EXTENSION in the
# filename, to make it possible to divert /path/foo.divert to
# foo.divert.divert-orig
divert_files_replace_name = $(shell echo $(1) | perl -pe 's/(.*)\Q$(DEB_DIVERT_EXTENSION)\E/$$1$(2)/')

# Encode a full path into the path it should be diverted to if it's
# removed
remove_files_name = /usr/share/$(cdbs_curpkg)/$(shell $(DEB_DIVERT_ENCODER) $(1))

dh_compat_6 := $(shell if [ '$(DH_COMPAT)' -ge 6 ]; then echo y; fi)

reverse = $(foreach n,$(shell seq $(words $(1)) -1 1),$(word $(n),$(1)))
reverse_dh_compat_6 = $(if $(dh_compat_6),$(call reverse,$(1)),$(1))

debian-divert/%: package = $(subst debian-divert/,,$@)
debian-divert/%: divert_files = $(DEB_DIVERT_FILES_$(package)) $(DEB_TRANSFORM_FILES_$(package))
debian-divert/%: divert_remove_files = $(DEB_REMOVE_FILES_$(package))
debian-divert/%: divert_undivert_files = $(DEB_UNDIVERT_FILES_$(package))
debian-divert/%: divert_unremove_files = $(DEB_UNREMOVE_FILES_$(package))
debian-divert/%: divert_files_all = $(strip $(divert_files) $(divert_remove_files) $(divert_undivert_files) $(divert_unremove_files))
debian-divert/%: divert_files_thispkg = $(strip $(divert_files) $(divert_remove_files))
$(patsubst %,debian-divert/%,$(DEB_DIVERT_PACKAGES)) :: debian-divert/%:
#   Writing shell scripts in makefiles sucks.  Remember to $$ shell
#   variables and include \ at the end of each line.
# Add code to postinst to add/remove diversions as appropriate
	set -e; \
	{ \
	    sed 's/#PACKAGE#/$(cdbs_curpkg)/g; s/#DEB_DIVERT_EXTENSION#/$(DEB_DIVERT_EXTENSION)/g' $(DEB_DIVERT_SCRIPT); \
	    $(if $(divert_files_all), \
		echo 'if [ "$$1" = "configure" ]; then'; \
		$(foreach file,$(divert_undivert_files), \
		    echo "    check_undivert_unlink $(call divert_files_replace_name,$(file), )"; )\
		$(foreach file,$(divert_unremove_files), \
		    echo "    check_undivert_unremove $(file) $(call remove_files_name,$(file))"; )\
		$(foreach file,$(divert_files), \
		    echo "    divert_link $(call divert_files_replace_name,$(file), )";) \
		$(foreach file,$(divert_remove_files), \
		    mkdir -p debian/$(cdbs_curpkg)/usr/share/$(cdbs_curpkg); \
		    echo "    divert_remove $(file) $(call remove_files_name,$(file))";) \
		echo 'fi'; \
	    ) \
	} >> $(CURDIR)/debian/$(cdbs_curpkg).postinst.debhelper
# Add code to prerm script to undo diversions when package is removed.
	set -e; \
	{ \
	    $(if $(dh_compat_6),, \
		if [ -e $(CURDIR)/debian/$(cdbs_curpkg).prerm.debhelper ]; then \
		    cat $(CURDIR)/debian/$(cdbs_curpkg).prerm.debhelper; \
		fi;) \
	    sed 's/#PACKAGE#/$(cdbs_curpkg)/g; s/#DEB_DIVERT_EXTENSION#/$(DEB_DIVERT_EXTENSION)/g' $(DEB_DIVERT_SCRIPT); \
	    $(if $(divert_files_thispkg), \
		echo 'if [ "$$1" = "remove" ] || [ "$$1" = "deconfigure" ]; then'; \
		$(foreach file,$(call reverse_dh_compat_6,$(divert_files)), \
		    echo "    undivert_unlink $(call divert_files_replace_name,$(file), )";) \
		$(foreach file,$(call reverse_dh_compat_6,$(divert_remove_files)), \
		    echo "    undivert_unremove $(file) $(cdbs_curpkg)";) \
		echo 'fi'; \
	    ) \
	    $(if $(dh_compat_6), \
		if [ -e $(CURDIR)/debian/$(cdbs_curpkg).prerm.debhelper ]; then \
		    cat $(CURDIR)/debian/$(cdbs_curpkg).prerm.debhelper; \
		fi;) \
	} >> $(CURDIR)/debian/$(cdbs_curpkg).prerm.debhelper.new
	mv $(CURDIR)/debian/$(cdbs_curpkg).prerm.debhelper.new \
	    $(CURDIR)/debian/$(cdbs_curpkg).prerm.debhelper
# Add an encoding of the names of the diverted files to the Provides:
# and Conflicts: lists.  This prevents two packages diverting the same
# file from being installed simultaneously (it cannot work, and this
# produces a much less ugly error).  Requires in debian/control:
#   Provides: ${diverted-files}
#   Conflicts: ${diverted-files}
	set -e; \
	{ \
	    echo -n "diverted-files="; \
	    $(foreach file,$(divert_files_thispkg),\
		echo -n "diverts-"; \
		${DEB_DIVERT_ENCODER} "$(call divert_files_replace_name,$(file))"; \
		echo -n ", ";) \
	    echo; \
	} >> $(CURDIR)/debian/$(cdbs_curpkg).substvars

$(patsubst %,binary-post-install/%,$(DEB_DIVERT_PACKAGES)) :: binary-post-install/%: debian-divert/%

endif
Commit	Line	Data
ab8e2a67 TA	1	# -- mode: makefile; coding: utf-8 --
	2	# Copyright © 2007-2008 Anders Kaseorg <andersk@mit.edu> and
	3	# Tim Abbott <tabbott@mit.edu>
	4	#
	5	# This program is free software; you can redistribute it and/or
	6	# modify it under the terms of the GNU General Public License as
	7	# published by the Free Software Foundation; either version 2, or (at
	8	# your option) any later version.
	9	#
	10	# This program is distributed in the hope that it will be useful, but
	11	# WITHOUT ANY WARRANTY; without even the implied warranty of
	12	# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
	13	# General Public License for more details.
	14	#
	15	# You should have received a copy of the GNU General Public License
	16	# along with this program; if not, write to the Free Software
	17	# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
	18	# 02111-1307 USA.
	19
56709134 TA	20	# Don't include divert.mk in your rules files directly; instead use
	21	# config-package.mk.
	22
	23	# divert.mk handles the low-level diversion logic. It includes
02209392 GT	24	# divert.sh.in in the postinst and prerm scripts, and adds calls to the
	25	# functions in divert.sh.in to add and remove diversions and symlinks at
	26	# the appropriate points.
56709134	27
ab8e2a67 TA	28	ifndef _cdbs_rules_divert
	29	_cdbs_rules_divert = 1
	30
be43c288 TA	31	include /usr/share/cdbs/1/rules/debhelper.mk
be43c288 TA	32
02bde96f	33	CDBS_BUILD_DEPENDS := $(CDBS_BUILD_DEPENDS), config-package-dev (>= 4.5~)
ab8e2a67	34
56709134 TA	35	# divert.sh.in is included in the postinst/prerm scripts of packages
56709134 TA	36	# installing diversions using config-package-dev.
ab8e2a67	37	DEB_DIVERT_SCRIPT = /usr/share/config-package-dev/divert.sh.in
56709134 TA	38	# script used to encode the path of a file uniquely in a valid virtual
	39	# package name.
	40	DEB_DIVERT_ENCODER = /usr/share/config-package-dev/encode
ab8e2a67 TA	41
ab8e2a67 TA	42	DEB_DIVERT_PACKAGES += $(foreach package,$(DEB_ALL_PACKAGES), \
02bde96f	43	$(if $(DEB_TRANSFORM_FILES_$(package)),$(package), \
936cb21e TA	44	$(if $(DEB_REMOVE_FILES_$(package)),$(package), \
	45	$(if $(DEB_UNREMOVE_FILES_$(package)),$(package), \
	46	$(if $(DEB_UNDIVERT_FILES_$(package)),$(package), \
	47	$(if $(DEB_DIVERT_FILES_$(package)),$(package)))))))
ab8e2a67 TA	48
	49	ifeq ($(DEB_DIVERT_EXTENSION),)
	50	DEB_DIVERT_EXTENSION = .divert
	51	endif
	52
56709134 TA	53	# Replace only the last instance of DEB_DIVERT_EXTENSION in the
	54	# filename, to make it possible to divert /path/foo.divert to
	55	# foo.divert.divert-orig
936cb21e TA	56	divert_files_replace_name = $(shell echo $(1) \| perl -pe 's/(.*)\Q$(DEB_DIVERT_EXTENSION)\E/$$1$(2)/')
936cb21e TA	57
c94f42bb	58	# Encode a full path into the path it should be diverted to if it's
50bf7563 AK	59	# removed
	60	remove_files_name = /usr/share/$(cdbs_curpkg)/$(shell $(DEB_DIVERT_ENCODER) $(1))
	61
9350e976	62	dh_compat_6 := $(shell if [ '$(DH_COMPAT)' -ge 6 ]; then echo y; fi)
a06c63da AK	63
a06c63da AK	64	reverse = $(foreach n,$(shell seq $(words $(1)) -1 1),$(word $(n),$(1)))
9350e976	65	reverse_dh_compat_6 = $(if $(dh_compat_6),$(call reverse,$(1)),$(1))
a06c63da	66
ab8e2a67	67	debian-divert/%: package = $(subst debian-divert/,,$@)
02bde96f	68	debian-divert/%: divert_files = $(DEB_DIVERT_FILES_$(package)) $(DEB_TRANSFORM_FILES_$(package))
936cb21e TA	69	debian-divert/%: divert_remove_files = $(DEB_REMOVE_FILES_$(package))
	70	debian-divert/%: divert_undivert_files = $(DEB_UNDIVERT_FILES_$(package))
	71	debian-divert/%: divert_unremove_files = $(DEB_UNREMOVE_FILES_$(package))
	72	debian-divert/%: divert_files_all = $(strip $(divert_files) $(divert_remove_files) $(divert_undivert_files) $(divert_unremove_files))
	73	debian-divert/%: divert_files_thispkg = $(strip $(divert_files) $(divert_remove_files))
ab8e2a67	74	$(patsubst %,debian-divert/%,$(DEB_DIVERT_PACKAGES)) :: debian-divert/%:
56709134 TA	75	# Writing shell scripts in makefiles sucks. Remember to $$ shell
	76	# variables and include \ at the end of each line.
	77	# Add code to postinst to add/remove diversions as appropriate
3aab360a AK	78	set -e; \
3aab360a AK	79	{ \
ab8e2a67	80	sed 's/#PACKAGE#/$(cdbs_curpkg)/g; s/#DEB_DIVERT_EXTENSION#/$(DEB_DIVERT_EXTENSION)/g' $(DEB_DIVERT_SCRIPT); \
936cb21e	81	$(if $(divert_files_all), \
ab8e2a67	82	echo 'if [ "$$1" = "configure" ]; then'; \
936cb21e	83	$(foreach file,$(divert_undivert_files), \
50bf7563	84	echo " check_undivert_unlink $(call divert_files_replace_name,$(file), )"; )\
936cb21e	85	$(foreach file,$(divert_unremove_files), \
50bf7563	86	echo " check_undivert_unremove $(file) $(call remove_files_name,$(file))"; )\
ab8e2a67	87	$(foreach file,$(divert_files), \
936cb21e TA	88	echo " divert_link $(call divert_files_replace_name,$(file), )";) \
936cb21e TA	89	$(foreach file,$(divert_remove_files), \
a7a01014	90	mkdir -p debian/$(cdbs_curpkg)/usr/share/$(cdbs_curpkg); \
50bf7563	91	echo " divert_remove $(file) $(call remove_files_name,$(file))";) \
ab8e2a67 TA	92	echo 'fi'; \
ab8e2a67 TA	93	) \
3aab360a	94	} >> $(CURDIR)/debian/$(cdbs_curpkg).postinst.debhelper
56709134	95	# Add code to prerm script to undo diversions when package is removed.
3aab360a AK	96	set -e; \
3aab360a AK	97	{ \
9350e976	98	$(if $(dh_compat_6),, \
a06c63da AK	99	if [ -e $(CURDIR)/debian/$(cdbs_curpkg).prerm.debhelper ]; then \
	100	cat $(CURDIR)/debian/$(cdbs_curpkg).prerm.debhelper; \
	101	fi;) \
ab8e2a67	102	sed 's/#PACKAGE#/$(cdbs_curpkg)/g; s/#DEB_DIVERT_EXTENSION#/$(DEB_DIVERT_EXTENSION)/g' $(DEB_DIVERT_SCRIPT); \
936cb21e	103	$(if $(divert_files_thispkg), \
96d37386	104	echo 'if [ "$$1" = "remove" ] \|\| [ "$$1" = "deconfigure" ]; then'; \
9350e976	105	$(foreach file,$(call reverse_dh_compat_6,$(divert_files)), \
936cb21e	106	echo " undivert_unlink $(call divert_files_replace_name,$(file), )";) \
9350e976	107	$(foreach file,$(call reverse_dh_compat_6,$(divert_remove_files)), \
936cb21e	108	echo " undivert_unremove $(file) $(cdbs_curpkg)";) \
ab8e2a67 TA	109	echo 'fi'; \
ab8e2a67 TA	110	) \
9350e976	111	$(if $(dh_compat_6), \
a06c63da AK	112	if [ -e $(CURDIR)/debian/$(cdbs_curpkg).prerm.debhelper ]; then \
	113	cat $(CURDIR)/debian/$(cdbs_curpkg).prerm.debhelper; \
	114	fi;) \
	115	} >> $(CURDIR)/debian/$(cdbs_curpkg).prerm.debhelper.new
	116	mv $(CURDIR)/debian/$(cdbs_curpkg).prerm.debhelper.new \
	117	$(CURDIR)/debian/$(cdbs_curpkg).prerm.debhelper
56709134 TA	118	# Add an encoding of the names of the diverted files to the Provides:
	119	# and Conflicts: lists. This prevents two packages diverting the same
	120	# file from being installed simultaneously (it cannot work, and this
	121	# produces a much less ugly error). Requires in debian/control:
c94f42bb GT	122	# Provides: ${diverted-files}
c94f42bb GT	123	# Conflicts: ${diverted-files}
3aab360a AK	124	set -e; \
3aab360a AK	125	{ \
ab8e2a67	126	echo -n "diverted-files="; \
936cb21e	127	$(foreach file,$(divert_files_thispkg),\
56709134	128	echo -n "diverts-"; \
936cb21e	129	${DEB_DIVERT_ENCODER} "$(call divert_files_replace_name,$(file))"; \
ab8e2a67	130	echo -n ", ";) \
3aab360a AK	131	echo; \
3aab360a AK	132	} >> $(CURDIR)/debian/$(cdbs_curpkg).substvars
ab8e2a67	133
be43c288	134	$(patsubst %,binary-post-install/%,$(DEB_DIVERT_PACKAGES)) :: binary-post-install/%: debian-divert/%
ab8e2a67 TA	135
ab8e2a67 TA	136	endif