| 1 | # Copyright 1999-2006 Gentoo Foundation |
1 | # Copyright 1999-2011 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.21 2011/01/31 17:03:45 eva Exp $ |
3 | # $Header: /var/cvsroot/gentoo-x86/eclass/gnome2-utils.eclass,v 1.24 2011/11/14 06:10:32 tetromino 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 | |
| 14 | case "${EAPI:-0}" in |
18 | case "${EAPI:-0}" in |
| 15 | 0|1|2|3|4) ;; |
19 | 0|1|2|3|4) ;; |
| 16 | *) die "EAPI=${EAPI} is not supported" ;; |
20 | *) die "EAPI=${EAPI} is not supported" ;; |
| 17 | esac |
21 | esac |
| 18 | |
22 | |
|
|
23 | # @ECLASS-VARIABLE: GCONFTOOL_BIN |
|
|
24 | # @INTERNAL |
|
|
25 | # @DESCRIPTION: |
| 19 | # Path to gconftool-2 |
26 | # Path to gconftool-2 |
| 20 | : ${GCONFTOOL_BIN:="/usr/bin/gconftool-2"} |
27 | : ${GCONFTOOL_BIN:="/usr/bin/gconftool-2"} |
| 21 | |
28 | |
|
|
29 | # @ECLASS-VARIABLE: SCROLLKEEPER_DIR |
|
|
30 | # @INTERNAL |
|
|
31 | # @DESCRIPTION: |
| 22 | # Directory where scrollkeeper-update should do its work |
32 | # Directory where scrollkeeper-update should do its work |
| 23 | : ${SCROLLKEEPER_DIR:="/var/lib/scrollkeeper"} |
33 | : ${SCROLLKEEPER_DIR:="/var/lib/scrollkeeper"} |
| 24 | |
34 | |
|
|
35 | # @ECLASS-VARIABLE: SCROLLKEEPER_UPDATE_BIN |
|
|
36 | # @INTERNAL |
|
|
37 | # @DESCRIPTION: |
| 25 | # Path to scrollkeeper-update |
38 | # Path to scrollkeeper-update |
| 26 | : ${SCROLLKEEPER_UPDATE_BIN:="/usr/bin/scrollkeeper-update"} |
39 | : ${SCROLLKEEPER_UPDATE_BIN:="/usr/bin/scrollkeeper-update"} |
| 27 | |
40 | |
|
|
41 | # @ECLASS-VARIABLE: GTK_UPDATE_ICON_CACHE |
|
|
42 | # @INTERNAL |
|
|
43 | # @DESCRIPTION: |
| 28 | # Path to gtk-update-icon-cache |
44 | # Path to gtk-update-icon-cache |
| 29 | : ${GTK_UPDATE_ICON_CACHE:="/usr/bin/gtk-update-icon-cache"} |
45 | : ${GTK_UPDATE_ICON_CACHE:="/usr/bin/gtk-update-icon-cache"} |
| 30 | |
46 | |
|
|
47 | # @ECLASS-VARIABLE: GLIB_COMPILE_SCHEMAS |
|
|
48 | # @INTERNAL |
|
|
49 | # @DESCRIPTION: |
| 31 | # Path to glib-compile-schemas |
50 | # Path to glib-compile-schemas |
| 32 | : ${GLIB_COMPILE_SCHEMAS:="/usr/bin/glib-compile-schemas"} |
51 | : ${GLIB_COMPILE_SCHEMAS:="/usr/bin/glib-compile-schemas"} |
| 33 | |
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_GLIB_SCHEMAS |
|
|
66 | # @INTERNAL |
|
|
67 | # @DEFAULT_UNSET |
|
|
68 | # @DESCRIPTION: |
|
|
69 | # List of GSettings schemas provided by the package |
| 34 | |
70 | |
| 35 | |
71 | |
| 36 | DEPEND=">=sys-apps/sed-4" |
72 | DEPEND=">=sys-apps/sed-4" |
| 37 | |
73 | |
| 38 | |
74 | |
|
|
75 | # @FUNCTION: gnome2_environment_reset |
|
|
76 | # @DESCRIPTION: |
|
|
77 | # Reset various variables inherited from root's evironment to a reasonable |
|
|
78 | # default for ebuilds to help avoid access violations and test failures. |
|
|
79 | gnome2_environment_reset() { |
|
|
80 | # Respected by >=glib-2.30.1-r1 |
|
|
81 | export G_HOME="${T}" |
| 39 | |
82 | |
|
|
83 | # GST_REGISTRY is to work around gst utilities trying to read/write /root |
|
|
84 | export GST_REGISTRY="${T}/registry.xml" |
|
|
85 | |
|
|
86 | # XXX: code for resetting XDG_* directories should probably be moved into |
|
|
87 | # a separate function in a non-gnome eclass |
|
|
88 | export XDG_DATA_HOME="${T}/.local/share" |
|
|
89 | export XDG_CONFIG_HOME="${T}/.config" |
|
|
90 | export XDG_CACHE_HOME="${T}/.cache" |
|
|
91 | export XDG_RUNTIME_DIR="${T}/run" |
|
|
92 | mkdir -p "${XDG_DATA_HOME}" "${XDG_CONFIG_HOME}" "${XDG_CACHE_HOME}" \ |
|
|
93 | "${XDG_RUNTIME_DIR}" |
|
|
94 | # This directory needs to be owned by the user, and chmod 0700 |
|
|
95 | # http://standards.freedesktop.org/basedir-spec/basedir-spec-latest.html |
|
|
96 | chmod 0700 "${XDG_RUNTIME_DIR}" |
|
|
97 | } |
|
|
98 | |
|
|
99 | # @FUNCTION: gnome2_gconf_savelist |
|
|
100 | # @DESCRIPTION: |
| 40 | # Find the GConf schemas that are about to be installed and save their location |
101 | # Find the GConf schemas that are about to be installed and save their location |
| 41 | # in the GNOME2_ECLASS_SCHEMAS environment variable |
102 | # in the GNOME2_ECLASS_SCHEMAS environment variable. |
|
|
103 | # This function should be called from pkg_preinst. |
| 42 | gnome2_gconf_savelist() { |
104 | gnome2_gconf_savelist() { |
| 43 | has ${EAPI:-0} 0 1 2 && ! use prefix && ED="${D}" |
105 | has ${EAPI:-0} 0 1 2 && ! use prefix && ED="${D}" |
| 44 | pushd "${ED}" &> /dev/null |
106 | pushd "${ED}" &> /dev/null |
| 45 | export GNOME2_ECLASS_SCHEMAS=$(find 'etc/gconf/schemas/' -name '*.schemas' 2> /dev/null) |
107 | export GNOME2_ECLASS_SCHEMAS=$(find 'etc/gconf/schemas/' -name '*.schemas' 2> /dev/null) |
| 46 | popd &> /dev/null |
108 | popd &> /dev/null |
| 47 | } |
109 | } |
| 48 | |
110 | |
| 49 | |
111 | # @FUNCTION: gnome2_gconf_install |
|
|
112 | # @DESCRIPTION: |
| 50 | # Applies any schema files installed by the current ebuild to Gconf's database |
113 | # Applies any schema files installed by the current ebuild to Gconf's database |
| 51 | # using gconftool-2 |
114 | # using gconftool-2. |
|
|
115 | # This function should be called from pkg_postinst. |
| 52 | gnome2_gconf_install() { |
116 | gnome2_gconf_install() { |
| 53 | has ${EAPI:-0} 0 1 2 && ! use prefix && EROOT="${ROOT}" |
117 | has ${EAPI:-0} 0 1 2 && ! use prefix && EROOT="${ROOT}" |
| 54 | local updater="${EROOT}${GCONFTOOL_BIN}" |
118 | local updater="${EROOT}${GCONFTOOL_BIN}" |
| 55 | |
119 | |
| 56 | if [[ ! -x "${updater}" ]]; then |
120 | if [[ ! -x "${updater}" ]]; then |
| … | |
… | |
| 84 | kill -HUP ${pids} |
148 | kill -HUP ${pids} |
| 85 | eend $? |
149 | eend $? |
| 86 | fi |
150 | fi |
| 87 | } |
151 | } |
| 88 | |
152 | |
| 89 | |
153 | # @FUNCTION: gnome2_gconf_uninstall |
|
|
154 | # @DESCRIPTION: |
| 90 | # Removes schema files previously installed by the current ebuild from Gconf's |
155 | # Removes schema files previously installed by the current ebuild from Gconf's |
| 91 | # database. |
156 | # database. |
| 92 | gnome2_gconf_uninstall() { |
157 | gnome2_gconf_uninstall() { |
| 93 | has ${EAPI:-0} 0 1 2 && ! use prefix && EROOT="${ROOT}" |
158 | has ${EAPI:-0} 0 1 2 && ! use prefix && EROOT="${ROOT}" |
| 94 | local updater="${EROOT}${GCONFTOOL_BIN}" |
159 | local updater="${EROOT}${GCONFTOOL_BIN}" |
| … | |
… | |
| 123 | kill -HUP ${pids} |
188 | kill -HUP ${pids} |
| 124 | eend $? |
189 | eend $? |
| 125 | fi |
190 | fi |
| 126 | } |
191 | } |
| 127 | |
192 | |
| 128 | |
193 | # @FUNCTION: gnome2_icon_savelist |
|
|
194 | # @DESCRIPTION: |
| 129 | # Find the icons that are about to be installed and save their location |
195 | # Find the icons that are about to be installed and save their location |
| 130 | # in the GNOME2_ECLASS_ICONS environment variable |
196 | # in the GNOME2_ECLASS_ICONS environment variable. |
| 131 | # That function should be called from pkg_preinst |
197 | # This function should be called from pkg_preinst. |
| 132 | gnome2_icon_savelist() { |
198 | gnome2_icon_savelist() { |
| 133 | has ${EAPI:-0} 0 1 2 && ! use prefix && ED="${D}" |
199 | has ${EAPI:-0} 0 1 2 && ! use prefix && ED="${D}" |
| 134 | pushd "${ED}" &> /dev/null |
200 | pushd "${ED}" &> /dev/null |
| 135 | export GNOME2_ECLASS_ICONS=$(find 'usr/share/icons' -maxdepth 1 -mindepth 1 -type d 2> /dev/null) |
201 | export GNOME2_ECLASS_ICONS=$(find 'usr/share/icons' -maxdepth 1 -mindepth 1 -type d 2> /dev/null) |
| 136 | popd &> /dev/null |
202 | popd &> /dev/null |
| 137 | } |
203 | } |
| 138 | |
204 | |
| 139 | |
205 | # @FUNCTION: gnome2_icon_cache_update |
|
|
206 | # @DESCRIPTION: |
| 140 | # Updates Gtk+ icon cache files under /usr/share/icons if the current ebuild |
207 | # Updates Gtk+ icon cache files under /usr/share/icons if the current ebuild |
| 141 | # have installed anything under that location. |
208 | # have installed anything under that location. |
|
|
209 | # This function should be called from pkg_postinst and pkg_postrm. |
| 142 | gnome2_icon_cache_update() { |
210 | gnome2_icon_cache_update() { |
| 143 | has ${EAPI:-0} 0 1 2 && ! use prefix && EROOT="${ROOT}" |
211 | has ${EAPI:-0} 0 1 2 && ! use prefix && EROOT="${ROOT}" |
| 144 | local updater="${EROOT}${GTK_UPDATE_ICON_CACHE}" |
212 | local updater="${EROOT}${GTK_UPDATE_ICON_CACHE}" |
| 145 | |
213 | |
| 146 | if [[ ! -x "${updater}" ]] ; then |
214 | if [[ ! -x "${updater}" ]] ; then |
| … | |
… | |
| 182 | for f in "${fails[@]}" ; do |
250 | for f in "${fails[@]}" ; do |
| 183 | eerror "Failed to update cache with icon $f" |
251 | eerror "Failed to update cache with icon $f" |
| 184 | done |
252 | done |
| 185 | } |
253 | } |
| 186 | |
254 | |
| 187 | |
255 | # @FUNCTION: gnome2_omf_fix |
|
|
256 | # @DESCRIPTION: |
| 188 | # Workaround applied to Makefile rules in order to remove redundant |
257 | # Workaround applied to Makefile rules in order to remove redundant |
| 189 | # calls to scrollkeeper-update and sandbox violations. |
258 | # calls to scrollkeeper-update and sandbox violations. |
|
|
259 | # This function should be called from src_prepare. |
| 190 | gnome2_omf_fix() { |
260 | gnome2_omf_fix() { |
| 191 | local omf_makefiles filename |
261 | local omf_makefiles filename |
| 192 | |
262 | |
| 193 | omf_makefiles="$@" |
263 | omf_makefiles="$@" |
| 194 | |
264 | |
| … | |
… | |
| 229 | for f in "${fails[@]}" ; do |
299 | for f in "${fails[@]}" ; do |
| 230 | eerror "Failed to update OMF Makefile $f" |
300 | eerror "Failed to update OMF Makefile $f" |
| 231 | done |
301 | done |
| 232 | } |
302 | } |
| 233 | |
303 | |
| 234 | |
304 | # @FUNCTION: gnome2_scrollkeeper_update |
|
|
305 | # @DESCRIPTION: |
| 235 | # Updates the global scrollkeeper database. |
306 | # Updates the global scrollkeeper database. |
|
|
307 | # This function should be called from pkg_postinst and pkg_postrm. |
| 236 | gnome2_scrollkeeper_update() { |
308 | gnome2_scrollkeeper_update() { |
| 237 | has ${EAPI:-0} 0 1 2 && ! use prefix && EROOT="${ROOT}" |
309 | has ${EAPI:-0} 0 1 2 && ! use prefix && EROOT="${ROOT}" |
| 238 | if [[ -x "${EROOT}${SCROLLKEEPER_UPDATE_BIN}" ]]; then |
310 | if [[ -x "${EROOT}${SCROLLKEEPER_UPDATE_BIN}" ]]; then |
| 239 | einfo "Updating scrollkeeper database ..." |
311 | einfo "Updating scrollkeeper database ..." |
| 240 | "${EROOT}${SCROLLKEEPER_UPDATE_BIN}" -q -p "${EROOT}${SCROLLKEEPER_DIR}" |
312 | "${EROOT}${SCROLLKEEPER_UPDATE_BIN}" -q -p "${EROOT}${SCROLLKEEPER_DIR}" |
| 241 | fi |
313 | fi |
| 242 | } |
314 | } |
| 243 | |
315 | |
|
|
316 | # @FUNCTION: gnome2_schemas_savelist |
|
|
317 | # @DESCRIPTION: |
|
|
318 | # Find if there is any GSettings schema to install and save the list in |
|
|
319 | # GNOME2_ECLASS_GLIB_SCHEMAS variable. |
|
|
320 | # This function should be called from pkg_preinst. |
| 244 | gnome2_schemas_savelist() { |
321 | gnome2_schemas_savelist() { |
| 245 | has ${EAPI:-0} 0 1 2 && ! use prefix && ED="${D}" |
322 | has ${EAPI:-0} 0 1 2 && ! use prefix && ED="${D}" |
| 246 | pushd "${ED}" &>/dev/null |
323 | pushd "${ED}" &>/dev/null |
| 247 | export GNOME2_ECLASS_GLIB_SCHEMAS=$(find 'usr/share/glib-2.0/schemas' -name '*.gschema.xml' 2>/dev/null) |
324 | export GNOME2_ECLASS_GLIB_SCHEMAS=$(find 'usr/share/glib-2.0/schemas' -name '*.gschema.xml' 2>/dev/null) |
| 248 | popd &>/dev/null |
325 | popd &>/dev/null |
| 249 | } |
326 | } |
| 250 | |
327 | |
|
|
328 | # @FUNCTION: gnome2_schemas_update |
|
|
329 | # @USAGE: gnome2_schemas_update [--uninstall] |
|
|
330 | # @DESCRIPTION: |
|
|
331 | # Updates GSettings schemas if GNOME2_ECLASS_GLIB_SCHEMAS has some. |
|
|
332 | # This function should be called from pkg_postinst and pkg_postrm with --uninstall. |
| 251 | gnome2_schemas_update() { |
333 | gnome2_schemas_update() { |
| 252 | has ${EAPI:-0} 0 1 2 && ! use prefix && EROOT="${ROOT}" |
334 | has ${EAPI:-0} 0 1 2 && ! use prefix && EROOT="${ROOT}" |
| 253 | local updater="${EROOT}${GLIB_COMPILE_SCHEMAS}" |
335 | local updater="${EROOT}${GLIB_COMPILE_SCHEMAS}" |
| 254 | |
336 | |
| 255 | if [[ ! -x ${updater} ]]; then |
337 | if [[ ! -x ${updater} ]]; then |