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

Diff of /eclass/gnome2-utils.eclass

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

Revision 1.1 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.1 2006/12/13 02:25:02 leonardop 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
18case "${EAPI:-0}" in
19 0|1|2|3|4) ;;
20 *) die "EAPI=${EAPI} is not supported" ;;
21esac
14 22
15 23# @ECLASS-VARIABLE: GCONFTOOL_BIN
24# @INTERNAL
25# @DESCRIPTION:
16# Path to gconftool-2 26# Path to gconftool-2
17GCONFTOOL_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
20SCROLLKEEPER_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
23SCROLLKEEPER_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
27DEPEND=">=sys-apps/sed-4" 77DEPEND=">=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.
84gnome2_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.
109gnome2_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.
33gnome2_gconf_install() { 121gnome2_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
150 pids=$(pgrep -x gconfd-2)
151 if [[ $? == 0 ]] ; then
55 ebegin "Reloading GConf schemas" 152 ebegin "Reloading GConf schemas"
56 killall -HUP gconfd-2 153 kill -HUP ${pids}
57 eend $? 154 eend $?
155 fi
58} 156}
59 157
60 158# @FUNCTION: gnome2_gconf_uninstall
159# @DESCRIPTION:
61# 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
62# database. 161# database.
63gnome2_gconf_uninstall() { 162gnome2_gconf_uninstall() {
64 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"
65 return 173 return
66 fi 174 fi
67 175
68 unset GCONF_DISABLE_MAKEFILE_SCHEMA_INSTALL 176 unset GCONF_DISABLE_MAKEFILE_SCHEMA_INSTALL
69 export GCONF_CONFIG_SOURCE=$(${GCONFTOOL_BIN} --get-default-source) 177 export GCONF_CONFIG_SOURCE="$("${updater}" --get-default-source | sed "s;:/;:${ROOT};")"
70 178
71 einfo "Uninstalling GNOME 2 GConf schemas" 179 einfo "Uninstalling GNOME 2 GConf schemas"
72 180
73 local contents="${ROOT}/var/db/pkg/*/${PN}-${PVR}/CONTENTS"
74 local F 181 local F
75 182 for F in ${GNOME2_ECLASS_SCHEMAS}; do
76 for F in $(grep "obj /etc/gconf/schemas" ${contents} | sed 's:obj \([^ ]*\) .*:\1:' ); do 183 if [[ -e "${EROOT}${F}" ]]; then
77 # echo "DEBUG::gconf install ${F}" 184 debug-print "Uninstalling gconf schema: ${F}"
78 ${GCONFTOOL_BIN} --makefile-uninstall-rule ${F} 1>/dev/null 185 "${updater}" --makefile-uninstall-rule "${EROOT}${F}" 1>/dev/null
186 fi
79 done 187 done
80}
81 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}
82 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.
203gnome2_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:
83# 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
84# 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.
85gnome2_icon_cache_update() { 215gnome2_icon_cache_update() {
86 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}"
87 218
88 if [[ ! -x ${updater} ]] ; then 219 if [[ ! -x "${updater}" ]] ; then
89 debug-print "${updater} is not executable" 220 debug-print "${updater} is not executable"
90
91 return 221 return
92 fi 222 fi
93 223
94 if ! grep -q "obj /usr/share/icons" ${ROOT}var/db/pkg/*/${PF}/CONTENTS 224 if [[ -z "${GNOME2_ECLASS_ICONS}" ]]; then
95 then
96 debug-print "No items to update" 225 debug-print "No icon cache to update"
97
98 return 226 return
99 fi 227 fi
100 228
101 ebegin "Updating icons cache" 229 ebegin "Updating icons cache"
102 230
103 local retval=0 231 local retval=0
104 local fails=( ) 232 local fails=( )
105 233
106 for dir in $(find ${ROOT}/usr/share/icons -maxdepth 1 -mindepth 1 -type d) 234 for dir in ${GNOME2_ECLASS_ICONS}
107 do 235 do
108 if [[ -f "${dir}/index.theme" ]] ; then 236 if [[ -f "${EROOT}${dir}/index.theme" ]] ; then
109 local rv=0 237 local rv=0
110 238
111 ${updater} -qf ${dir} 239 "${updater}" -qf "${EROOT}${dir}"
112 rv=$? 240 rv=$?
113 241
114 if [[ ! $rv -eq 0 ]] ; then 242 if [[ ! $rv -eq 0 ]] ; then
115 debug-print "Updating cache failed on ${dir}" 243 debug-print "Updating cache failed on ${EROOT}${dir}"
116 244
117 # Add to the list of failures 245 # Add to the list of failures
118 fails[$(( ${#fails[@]} + 1 ))]=$dir 246 fails[$(( ${#fails[@]} + 1 ))]="${EROOT}${dir}"
119 247
120 retval=2 248 retval=2
121 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}"
122 fi 258 fi
123 done 259 done
124 260
125 eend ${retval} 261 eend ${retval}
126 262
127 for (( i = 0 ; i < ${#fails[@]} ; i++ )) ; do 263 for f in "${fails[@]}" ; do
128 ### HACK!! This is needed until bash 3.1 is unmasked.
129 ## The current stable version of bash lists the sizeof fails to be 1
130 ## when there are no elements in the list because it is declared local.
131 ## In order to prevent the declaration from being in global scope, we
132 ## this hack to prevent an empty error message being printed for stable
133 ## users. -- compnerd && allanonjl
134 if [[ "${fails[i]}" != "" && "${fails[i]}" != "()" ]] ; then
135 eerror "Failed to update cache with icon ${fails[i]}" 264 eerror "Failed to update cache with icon $f"
136 fi
137 done 265 done
138} 266}
139 267
140 268# @FUNCTION: gnome2_omf_fix
269# @DESCRIPTION:
141# Workaround applied to Makefile rules in order to remove redundant 270# Workaround applied to Makefile rules in order to remove redundant
142# calls to scrollkeeper-update and sandbox violations. 271# calls to scrollkeeper-update and sandbox violations.
272# This function should be called from src_prepare.
143gnome2_omf_fix() { 273gnome2_omf_fix() {
144 local omf_makefiles filename 274 local omf_makefiles filename
145 275
146 omf_makefiles="$@" 276 omf_makefiles="$@"
147 277
148 if [[ -f ${S}/omf.make ]] ; then 278 if [[ -f ${S}/omf.make ]] ; then
149 omf_makefiles="${omf_makefiles} ${S}/omf.make" 279 omf_makefiles="${omf_makefiles} ${S}/omf.make"
150 fi 280 fi
151 281
282 if [[ -f ${S}/gnome-doc-utils.make ]] ; then
283 omf_makefiles="${omf_makefiles} ${S}/gnome-doc-utils.make"
284 fi
285
152 # 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
153 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
154 omf_makefiles="${omf_makefiles} ${filename}" 290 omf_makefiles="${omf_makefiles} ${filename}"
155 done 291 done
156 292
157 ebegin "Fixing OMF Makefiles" 293 ebegin "Fixing OMF Makefiles"
158 294
159 local retval=0 295 local retval=0
160 local fails=( ) 296 local fails=( )
161 297
162 for omf in ${omf_makefiles} ; do 298 for omf in ${omf_makefiles} ; do
163 local rv=0
164
165 sed -i -e 's:scrollkeeper-update:true:' ${omf} 299 sed -i -e 's:scrollkeeper-update:true:' "${omf}"
166 retval=$? 300 retval=$?
167 301
168 if [[ ! $rv -eq 0 ]] ; then 302 if [[ $retval -ne 0 ]] ; then
169 debug-print "updating of ${omf} failed" 303 debug-print "updating of ${omf} failed"
170 304
171 # Add to the list of failures 305 # Add to the list of failures
172 fails[$(( ${#fails[@]} + 1 ))]=$omf 306 fails[$(( ${#fails[@]} + 1 ))]=$omf
173 307
175 fi 309 fi
176 done 310 done
177 311
178 eend $retval 312 eend $retval
179 313
180 for (( i = 0 ; i < ${#fails[@]} ; i++ )) ; do 314 for f in "${fails[@]}" ; do
181 ### HACK!! This is needed until bash 3.1 is unmasked.
182 ## The current stable version of bash lists the sizeof fails to be 1
183 ## when there are no elements in the list because it is declared local.
184 ## In order to prevent the declaration from being in global scope, we
185 ## this hack to prevent an empty error message being printed for stable
186 ## users. -- compnerd && allanonjl
187 if [[ "${fails[i]}" != "" && "${fails[i]}" != "()" ]] ; then
188 eerror "Failed to update OMF Makefile ${fails[i]}" 315 eerror "Failed to update OMF Makefile $f"
189 fi
190 done 316 done
191} 317}
192 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.
324gnome2_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}
193 330
331# @FUNCTION: gnome2_scrollkeeper_update
332# @DESCRIPTION:
194# Updates the global scrollkeeper database. 333# Updates the global scrollkeeper database.
334# This function should be called from pkg_postinst and pkg_postrm.
195gnome2_scrollkeeper_update() { 335gnome2_scrollkeeper_update() {
196 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
197 einfo "Updating scrollkeeper database ..." 349 ebegin "Updating scrollkeeper database ..."
198 ${SCROLLKEEPER_UPDATE_BIN} -q -p ${SCROLLKEEPER_DIR} 350 "${updater}" -q -p "${EROOT}${SCROLLKEEPER_DIR}"
199 fi 351 eend $?
200} 352}
201 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.
359gnome2_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.
371gnome2_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.1  
changed lines
  Added in v.1.27

  ViewVC Help
Powered by ViewVC 1.1.20