/[gentoo-x86]/eclass/gnome2-utils.eclass

Diff of /eclass/gnome2-utils.eclass

Parent Directory | Revision Log | View Patch Patch

Revision 1.4		Revision 1.27
1	# Copyright 1999-2006 Gentoo Foundation	1	# Copyright 1999-2012 Gentoo Foundation
2	# Distributed under the terms of the GNU General Public License v2	2	# Distributed under the terms of the GNU General Public License v2
3	# $Header: /var/cvsroot/gentoo-x86/eclass/gnome2-utils.eclass,v 1.4 2007/04/24 18:13:14 dang Exp $	3	# $Header: /var/cvsroot/gentoo-x86/eclass/gnome2-utils.eclass,v 1.27 2012/05/02 21:05:38 eva Exp $
4		4
5	#
6	# gnome2-utils.eclass	5	# @ECLASS: gnome2-utils.eclass
7	#	6	# @MAINTAINER:
8	# Set of auxiliary functions used to perform actions commonly needed by packages	7	# gnome@gentoo.org
9	# using the GNOME framework.	8	# @BLURB: Auxiliary functions commonly used by Gnome packages.
10	#	9	# @DESCRIPTION:
11	# Maintained by Gentoo's GNOME herd <gnome@gentoo.org>	10	# This eclass provides a set of auxiliary functions needed by most Gnome
12	#	11	# packages. It may be used by non-Gnome packages as needed for handling various
		12	# Gnome stack related functions such as:
		13	# * Gtk+ icon cache management
		14	# * GSettings schemas management
		15	# * GConf schemas management
		16	# * scrollkeeper (old Gnome help system) management
13		17
		18	case "${EAPI:-0}" in
		19	0\|1\|2\|3\|4) ;;
		20	*) die "EAPI=${EAPI} is not supported" ;;
		21	esac
14		22
15		23	# @ECLASS-VARIABLE: GCONFTOOL_BIN
		24	# @INTERNAL
		25	# @DESCRIPTION:
16	# Path to gconftool-2	26	# Path to gconftool-2
17	GCONFTOOL_BIN=${GCONFTOOL_BIN:="${ROOT}usr/bin/gconftool-2"}	27	: ${GCONFTOOL_BIN:="/usr/bin/gconftool-2"}
18		28
		29	# @ECLASS-VARIABLE: SCROLLKEEPER_DIR
		30	# @INTERNAL
		31	# @DESCRIPTION:
19	# Directory where scrollkeeper-update should do its work	32	# Directory where scrollkeeper-update should do its work
20	SCROLLKEEPER_DIR=${SCROLLKEEPER_DIR:="${ROOT}var/lib/scrollkeeper"}	33	: ${SCROLLKEEPER_DIR:="/var/lib/scrollkeeper"}
21		34
		35	# @ECLASS-VARIABLE: SCROLLKEEPER_UPDATE_BIN
		36	# @INTERNAL
		37	# @DESCRIPTION:
22	# Path to scrollkeeper-update	38	# Path to scrollkeeper-update
23	SCROLLKEEPER_UPDATE_BIN=${SCROLLKEEPER_UPDATE_BIN:="${ROOT}usr/bin/scrollkeeper-update"}	39	: ${SCROLLKEEPER_UPDATE_BIN:="/usr/bin/scrollkeeper-update"}
24		40
		41	# @ECLASS-VARIABLE: GTK_UPDATE_ICON_CACHE
		42	# @INTERNAL
		43	# @DESCRIPTION:
		44	# Path to gtk-update-icon-cache
		45	: ${GTK_UPDATE_ICON_CACHE:="/usr/bin/gtk-update-icon-cache"}
25		46
		47	# @ECLASS-VARIABLE: GLIB_COMPILE_SCHEMAS
		48	# @INTERNAL
		49	# @DESCRIPTION:
		50	# Path to glib-compile-schemas
		51	: ${GLIB_COMPILE_SCHEMAS:="/usr/bin/glib-compile-schemas"}
		52
		53	# @ECLASS-VARIABLE: GNOME2_ECLASS_SCHEMAS
		54	# @INTERNAL
		55	# @DEFAULT_UNSET
		56	# @DESCRIPTION:
		57	# List of GConf schemas provided by the package
		58
		59	# @ECLASS-VARIABLE: GNOME2_ECLASS_ICONS
		60	# @INTERNAL
		61	# @DEFAULT_UNSET
		62	# @DESCRIPTION:
		63	# List of icons provided by the package
		64
		65	# @ECLASS-VARIABLE: GNOME2_ECLASS_SCROLLS
		66	# @INTERNAL
		67	# @DEFAULT_UNSET
		68	# @DESCRIPTION:
		69	# List of scrolls (documentation files) provided by the package
		70
		71	# @ECLASS-VARIABLE: GNOME2_ECLASS_GLIB_SCHEMAS
		72	# @INTERNAL
		73	# @DEFAULT_UNSET
		74	# @DESCRIPTION:
		75	# List of GSettings schemas provided by the package
26		76
27	DEPEND=">=sys-apps/sed-4"	77	DEPEND=">=sys-apps/sed-4"
28		78
29		79
		80	# @FUNCTION: gnome2_environment_reset
		81	# @DESCRIPTION:
		82	# Reset various variables inherited from root's evironment to a reasonable
		83	# default for ebuilds to help avoid access violations and test failures.
		84	gnome2_environment_reset() {
		85	# Respected by >=glib-2.30.1-r1
		86	export G_HOME="${T}"
30		87
		88	# GST_REGISTRY is to work around gst utilities trying to read/write /root
		89	export GST_REGISTRY="${T}/registry.xml"
		90
		91	# XXX: code for resetting XDG_* directories should probably be moved into
		92	# a separate function in a non-gnome eclass
		93	export XDG_DATA_HOME="${T}/.local/share"
		94	export XDG_CONFIG_HOME="${T}/.config"
		95	export XDG_CACHE_HOME="${T}/.cache"
		96	export XDG_RUNTIME_DIR="${T}/run"
		97	mkdir -p "${XDG_DATA_HOME}" "${XDG_CONFIG_HOME}" "${XDG_CACHE_HOME}" \
		98	"${XDG_RUNTIME_DIR}"
		99	# This directory needs to be owned by the user, and chmod 0700
		100	# http://standards.freedesktop.org/basedir-spec/basedir-spec-latest.html
		101	chmod 0700 "${XDG_RUNTIME_DIR}"
		102	}
		103
		104	# @FUNCTION: gnome2_gconf_savelist
		105	# @DESCRIPTION:
		106	# Find the GConf schemas that are about to be installed and save their location
		107	# in the GNOME2_ECLASS_SCHEMAS environment variable.
		108	# This function should be called from pkg_preinst.
		109	gnome2_gconf_savelist() {
		110	has ${EAPI:-0} 0 1 2 && ! use prefix && ED="${D}"
		111	pushd "${ED}" &> /dev/null
		112	export GNOME2_ECLASS_SCHEMAS=$(find 'etc/gconf/schemas/' -name '*.schemas' 2> /dev/null)
		113	popd &> /dev/null
		114	}
		115
		116	# @FUNCTION: gnome2_gconf_install
		117	# @DESCRIPTION:
31	# Applies any schema files installed by the current ebuild to Gconf's database	118	# Applies any schema files installed by the current ebuild to Gconf's database
32	# using gconftool-2	119	# using gconftool-2.
		120	# This function should be called from pkg_postinst.
33	gnome2_gconf_install() {	121	gnome2_gconf_install() {
34	if [[ ! -x ${GCONFTOOL_BIN} ]]; then	122	has ${EAPI:-0} 0 1 2 && ! use prefix && EROOT="${ROOT}"
		123	local updater="${EROOT}${GCONFTOOL_BIN}"
		124
		125	if [[ ! -x "${updater}" ]]; then
		126	debug-print "${updater} is not executable"
		127	return
		128	fi
		129
		130	if [[ -z "${GNOME2_ECLASS_SCHEMAS}" ]]; then
		131	debug-print "No GNOME 2 GConf schemas found"
35	return	132	return
36	fi	133	fi
37		134
38	# We are ready to install the GCONF Scheme now	135	# We are ready to install the GCONF Scheme now
39	unset GCONF_DISABLE_MAKEFILE_SCHEMA_INSTALL	136	unset GCONF_DISABLE_MAKEFILE_SCHEMA_INSTALL
40	export GCONF_CONFIG_SOURCE=$(${GCONFTOOL_BIN} --get-default-source)	137	export GCONF_CONFIG_SOURCE="$("${updater}" --get-default-source \| sed "s;:/;:${ROOT};")"
41		138
42	einfo "Installing GNOME 2 GConf schemas"	139	einfo "Installing GNOME 2 GConf schemas"
43		140
44	local contents="${ROOT}var/db/pkg/*/${PN}-${PVR}/CONTENTS"
45	local F	141	local F
46		142	for F in ${GNOME2_ECLASS_SCHEMAS}; do
47	for F in $(grep "^obj /etc/gconf/schemas/.\+\.schemas\b" ${contents} \| gawk '{print $2}' ); do
48	if [[ -e "${F}" ]]; then	143	if [[ -e "${EROOT}${F}" ]]; then
49	# echo "DEBUG::gconf install ${F}"	144	debug-print "Installing schema: ${F}"
50	${GCONFTOOL_BIN} --makefile-install-rule ${F} 1>/dev/null	145	"${updater}" --makefile-install-rule "${EROOT}${F}" 1>/dev/null
51	fi	146	fi
52	done	147	done
53		148
54	# have gconf reload the new schemas	149	# have gconf reload the new schemas
55	pids=$(pidof gconfd-2)	150	pids=$(pgrep -x gconfd-2)
56	if [[ $? == 0 ]] ; then	151	if [[ $? == 0 ]] ; then
57	ebegin "Reloading GConf schemas"	152	ebegin "Reloading GConf schemas"
58	kill -HUP ${pids}	153	kill -HUP ${pids}
59	eend $?	154	eend $?
60	fi	155	fi
61	}	156	}
62		157
63		158	# @FUNCTION: gnome2_gconf_uninstall
		159	# @DESCRIPTION:
64	# Removes schema files previously installed by the current ebuild from Gconf's	160	# Removes schema files previously installed by the current ebuild from Gconf's
65	# database.	161	# database.
66	gnome2_gconf_uninstall() {	162	gnome2_gconf_uninstall() {
67	if [[ ! -x ${GCONFTOOL_BIN} ]]; then	163	has ${EAPI:-0} 0 1 2 && ! use prefix && EROOT="${ROOT}"
		164	local updater="${EROOT}${GCONFTOOL_BIN}"
		165
		166	if [[ ! -x "${updater}" ]]; then
		167	debug-print "${updater} is not executable"
		168	return
		169	fi
		170
		171	if [[ -z "${GNOME2_ECLASS_SCHEMAS}" ]]; then
		172	debug-print "No GNOME 2 GConf schemas found"
68	return	173	return
69	fi	174	fi
70		175
71	unset GCONF_DISABLE_MAKEFILE_SCHEMA_INSTALL	176	unset GCONF_DISABLE_MAKEFILE_SCHEMA_INSTALL
72	export GCONF_CONFIG_SOURCE=$(${GCONFTOOL_BIN} --get-default-source)	177	export GCONF_CONFIG_SOURCE="$("${updater}" --get-default-source \| sed "s;:/;:${ROOT};")"
73		178
74	einfo "Uninstalling GNOME 2 GConf schemas"	179	einfo "Uninstalling GNOME 2 GConf schemas"
75		180
76	local contents="${ROOT}/var/db/pkg/*/${PN}-${PVR}/CONTENTS"
77	local F	181	local F
78		182	for F in ${GNOME2_ECLASS_SCHEMAS}; do
79	for F in $(grep "obj /etc/gconf/schemas" ${contents} \| sed 's:obj $[^ ]$ .:\1:' ); do	183	if [[ -e "${EROOT}${F}" ]]; then
80	# echo "DEBUG::gconf install ${F}"	184	debug-print "Uninstalling gconf schema: ${F}"
81	${GCONFTOOL_BIN} --makefile-uninstall-rule ${F} 1>/dev/null	185	"${updater}" --makefile-uninstall-rule "${EROOT}${F}" 1>/dev/null
		186	fi
82	done	187	done
83	}
84		188
		189	# have gconf reload the new schemas
		190	pids=$(pgrep -x gconfd-2)
		191	if [[ $? == 0 ]] ; then
		192	ebegin "Reloading GConf schemas"
		193	kill -HUP ${pids}
		194	eend $?
		195	fi
		196	}
85		197
		198	# @FUNCTION: gnome2_icon_savelist
		199	# @DESCRIPTION:
		200	# Find the icons that are about to be installed and save their location
		201	# in the GNOME2_ECLASS_ICONS environment variable.
		202	# This function should be called from pkg_preinst.
		203	gnome2_icon_savelist() {
		204	has ${EAPI:-0} 0 1 2 && ! use prefix && ED="${D}"
		205	pushd "${ED}" &> /dev/null
		206	export GNOME2_ECLASS_ICONS=$(find 'usr/share/icons' -maxdepth 1 -mindepth 1 -type d 2> /dev/null)
		207	popd &> /dev/null
		208	}
		209
		210	# @FUNCTION: gnome2_icon_cache_update
		211	# @DESCRIPTION:
86	# Updates Gtk+ icon cache files under /usr/share/icons if the current ebuild	212	# Updates Gtk+ icon cache files under /usr/share/icons if the current ebuild
87	# have installed anything under that location.	213	# have installed anything under that location.
		214	# This function should be called from pkg_postinst and pkg_postrm.
88	gnome2_icon_cache_update() {	215	gnome2_icon_cache_update() {
89	local updater=$(type -p gtk-update-icon-cache 2> /dev/null)	216	has ${EAPI:-0} 0 1 2 && ! use prefix && EROOT="${ROOT}"
		217	local updater="${EROOT}${GTK_UPDATE_ICON_CACHE}"
90		218
91	if [[ ! -x ${updater} ]] ; then	219	if [[ ! -x "${updater}" ]] ; then
92	debug-print "${updater} is not executable"	220	debug-print "${updater} is not executable"
		221	return
		222	fi
93		223
		224	if [[ -z "${GNOME2_ECLASS_ICONS}" ]]; then
		225	debug-print "No icon cache to update"
94	return	226	return
95	fi	227	fi
96		228
97	ebegin "Updating icons cache"	229	ebegin "Updating icons cache"
98		230
99	local retval=0	231	local retval=0
100	local fails=( )	232	local fails=( )
101		233
102	for dir in $(find ${ROOT}/usr/share/icons -maxdepth 1 -mindepth 1 -type d)	234	for dir in ${GNOME2_ECLASS_ICONS}
103	do	235	do
104	if [[ -f "${dir}/index.theme" ]] ; then	236	if [[ -f "${EROOT}${dir}/index.theme" ]] ; then
105	local rv=0	237	local rv=0
106		238
107	${updater} -q ${dir}	239	"${updater}" -qf "${EROOT}${dir}"
108	rv=$?	240	rv=$?
109		241
110	if [[ ! $rv -eq 0 ]] ; then	242	if [[ ! $rv -eq 0 ]] ; then
111	debug-print "Updating cache failed on ${dir}"	243	debug-print "Updating cache failed on ${EROOT}${dir}"
112		244
113	# Add to the list of failures	245	# Add to the list of failures
114	fails[$(( ${#fails[@]} + 1 ))]=$dir	246	fails[$(( ${#fails[@]} + 1 ))]="${EROOT}${dir}"
115		247
116	retval=2	248	retval=2
117	fi	249	fi
		250	elif [[ $(ls "${EROOT}${dir}") = "icon-theme.cache" ]]; then
		251	# Clear stale cache files after theme uninstallation
		252	rm "${EROOT}${dir}/icon-theme.cache"
		253	fi
		254
		255	if [[ -z $(ls "${EROOT}${dir}") ]]; then
		256	# Clear empty theme directories after theme uninstallation
		257	rmdir "${EROOT}${dir}"
118	fi	258	fi
119	done	259	done
120		260
121	eend ${retval}	261	eend ${retval}
122		262
123	for (( i = 0 ; i < ${#fails[@]} ; i++ )) ; do	263	for f in "${fails[@]}" ; do
124	### HACK!! This is needed until bash 3.1 is unmasked.
125	## The current stable version of bash lists the sizeof fails to be 1
126	## when there are no elements in the list because it is declared local.
127	## In order to prevent the declaration from being in global scope, we
128	## this hack to prevent an empty error message being printed for stable
129	## users. -- compnerd && allanonjl
130	if [[ "${fails[i]}" != "" && "${fails[i]}" != "()" ]] ; then
131	eerror "Failed to update cache with icon ${fails[i]}"	264	eerror "Failed to update cache with icon $f"
132	fi
133	done	265	done
134	}	266	}
135		267
136		268	# @FUNCTION: gnome2_omf_fix
		269	# @DESCRIPTION:
137	# Workaround applied to Makefile rules in order to remove redundant	270	# Workaround applied to Makefile rules in order to remove redundant
138	# calls to scrollkeeper-update and sandbox violations.	271	# calls to scrollkeeper-update and sandbox violations.
		272	# This function should be called from src_prepare.
139	gnome2_omf_fix() {	273	gnome2_omf_fix() {
140	local omf_makefiles filename	274	local omf_makefiles filename
141		275
142	omf_makefiles="$@"	276	omf_makefiles="$@"
143		277
144	if [[ -f ${S}/omf.make ]] ; then	278	if [[ -f ${S}/omf.make ]] ; then
145	omf_makefiles="${omf_makefiles} ${S}/omf.make"	279	omf_makefiles="${omf_makefiles} ${S}/omf.make"
146	fi	280	fi
147		281
		282	if [[ -f ${S}/gnome-doc-utils.make ]] ; then
		283	omf_makefiles="${omf_makefiles} ${S}/gnome-doc-utils.make"
		284	fi
		285
148	# testing fixing of all makefiles found	286	# testing fixing of all makefiles found
		287	# The sort is important to ensure .am is listed before the respective .in for
		288	# maintainer mode regeneration not kicking in due to .am being newer than .in
149	for filename in $(find ./ -name "Makefile.in" -o -name "Makefile.am") ; do	289	for filename in $(find "${S}" -name "Makefile.in" -o -name "Makefile.am" \|sort) ; do
150	omf_makefiles="${omf_makefiles} ${filename}"	290	omf_makefiles="${omf_makefiles} ${filename}"
151	done	291	done
152		292
153	ebegin "Fixing OMF Makefiles"	293	ebegin "Fixing OMF Makefiles"
154		294
155	local retval=0	295	local retval=0
156	local fails=( )	296	local fails=( )
157		297
158	for omf in ${omf_makefiles} ; do	298	for omf in ${omf_makefiles} ; do
159	local rv=0
160
161	sed -i -e 's:scrollkeeper-update:true:' ${omf}	299	sed -i -e 's:scrollkeeper-update:true:' "${omf}"
162	retval=$?	300	retval=$?
163		301
164	if [[ ! $rv -eq 0 ]] ; then	302	if [[ $retval -ne 0 ]] ; then
165	debug-print "updating of ${omf} failed"	303	debug-print "updating of ${omf} failed"
166		304
167	# Add to the list of failures	305	# Add to the list of failures
168	fails[$(( ${#fails[@]} + 1 ))]=$omf	306	fails[$(( ${#fails[@]} + 1 ))]=$omf
169		307
…		…
171	fi	309	fi
172	done	310	done
173		311
174	eend $retval	312	eend $retval
175		313
176	for (( i = 0 ; i < ${#fails[@]} ; i++ )) ; do	314	for f in "${fails[@]}" ; do
177	### HACK!! This is needed until bash 3.1 is unmasked.
178	## The current stable version of bash lists the sizeof fails to be 1
179	## when there are no elements in the list because it is declared local.
180	## In order to prevent the declaration from being in global scope, we
181	## this hack to prevent an empty error message being printed for stable
182	## users. -- compnerd && allanonjl
183	if [[ "${fails[i]}" != "" && "${fails[i]}" != "()" ]] ; then
184	eerror "Failed to update OMF Makefile ${fails[i]}"	315	eerror "Failed to update OMF Makefile $f"
185	fi
186	done	316	done
187	}	317	}
188		318
		319	# @FUNCTION: gnome2_scrollkeeper_savelist
		320	# @DESCRIPTION:
		321	# Find the scrolls that are about to be installed and save their location
		322	# in the GNOME2_ECLASS_SCROLLS environment variable.
		323	# This function should be called from pkg_preinst.
		324	gnome2_scrollkeeper_savelist() {
		325	has ${EAPI:-0} 0 1 2 && ! use prefix && ED="${D}"
		326	pushd "${ED}" &> /dev/null
		327	export GNOME2_ECLASS_SCROLLS=$(find 'usr/share/omf' -type f -name "*.omf" 2> /dev/null)
		328	popd &> /dev/null
		329	}
189		330
		331	# @FUNCTION: gnome2_scrollkeeper_update
		332	# @DESCRIPTION:
190	# Updates the global scrollkeeper database.	333	# Updates the global scrollkeeper database.
		334	# This function should be called from pkg_postinst and pkg_postrm.
191	gnome2_scrollkeeper_update() {	335	gnome2_scrollkeeper_update() {
192	if [[ -x ${SCROLLKEEPER_UPDATE_BIN} ]]; then	336	has ${EAPI:-0} 0 1 2 && ! use prefix && EROOT="${ROOT}"
		337	local updater="${EROOT}${SCROLLKEEPER_UPDATE_BIN}"
		338
		339	if [[ ! -x "${updater}" ]] ; then
		340	debug-print "${updater} is not executable"
		341	return
		342	fi
		343
		344	if [[ -z "${GNOME2_ECLASS_SCROLLS}" ]]; then
		345	debug-print "No scroll cache to update"
		346	return
		347	fi
		348
193	einfo "Updating scrollkeeper database ..."	349	ebegin "Updating scrollkeeper database ..."
194	${SCROLLKEEPER_UPDATE_BIN} -q -p ${SCROLLKEEPER_DIR}	350	"${updater}" -q -p "${EROOT}${SCROLLKEEPER_DIR}"
195	fi	351	eend $?
196	}	352	}
197		353
		354	# @FUNCTION: gnome2_schemas_savelist
		355	# @DESCRIPTION:
		356	# Find if there is any GSettings schema to install and save the list in
		357	# GNOME2_ECLASS_GLIB_SCHEMAS variable.
		358	# This function should be called from pkg_preinst.
		359	gnome2_schemas_savelist() {
		360	has ${EAPI:-0} 0 1 2 && ! use prefix && ED="${D}"
		361	pushd "${ED}" &>/dev/null
		362	export GNOME2_ECLASS_GLIB_SCHEMAS=$(find 'usr/share/glib-2.0/schemas' -name '*.gschema.xml' 2>/dev/null)
		363	popd &>/dev/null
		364	}
		365
		366	# @FUNCTION: gnome2_schemas_update
		367	# @USAGE: gnome2_schemas_update
		368	# @DESCRIPTION:
		369	# Updates GSettings schemas if GNOME2_ECLASS_GLIB_SCHEMAS has some.
		370	# This function should be called from pkg_postinst and pkg_postrm.
		371	gnome2_schemas_update() {
		372	has ${EAPI:-0} 0 1 2 && ! use prefix && EROOT="${ROOT}"
		373	local updater="${EROOT}${GLIB_COMPILE_SCHEMAS}"
		374
		375	if [[ ! -x ${updater} ]]; then
		376	debug-print "${updater} is not executable"
		377	return
		378	fi
		379
		380	if [[ -z ${GNOME2_ECLASS_GLIB_SCHEMAS} ]]; then
		381	debug-print "No GSettings schemas to update"
		382	return
		383	fi
		384
		385	ebegin "Updating GSettings schemas"
		386	${updater} --allow-any-name "$@" "${EROOT%/}/usr/share/glib-2.0/schemas" &>/dev/null
		387	eend $?
		388	}

 Legend:



Removed from v.1.4
 


changed lines


 
Added in v.1.27
 Legend:



Removed from v.1.4
 


changed lines


 
Added in v.1.27
-Removed from v.1.4
+Added in v.1.27

	ViewVC Help
Powered by ViewVC 1.1.13