/[gentoo-x86]/eclass/savedconfig.eclass
Gentoo

Contents of /eclass/savedconfig.eclass

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.20 - (show annotations) (download)
Wed Jan 4 08:23:51 2012 UTC (2 years, 9 months ago) by vapier
Branch: MAIN
Changes since 1.19: +18 -1 lines
force mtime changes on config files so they get left behind when USE=savedconfig is active; see #396169 for the full story

1 # Copyright 1999-2011 Gentoo Foundation
2 # Distributed under the terms of the GNU General Public License v2
3 # $Header: /var/cvsroot/gentoo-x86/eclass/savedconfig.eclass,v 1.19 2012/01/04 07:45:16 vapier Exp $
4
5 # @ECLASS: savedconfig.eclass
6 # @MAINTAINER:
7 # base-system@gentoo.org
8 # @BLURB: common API for saving/restoring complex configuration files
9 # @DESCRIPTION:
10 # It is not uncommon to come across a package which has a very fine
11 # grained level of configuration options that go way beyond what
12 # USE flags can properly describe. For this purpose, a common API
13 # of saving and restoring the configuration files was developed
14 # so users can modify these config files and the ebuild will take it
15 # into account as needed.
16
17 inherit portability
18
19 IUSE="savedconfig"
20
21 # @FUNCTION: save_config
22 # @USAGE: <config files to save>
23 # @DESCRIPTION:
24 # Use this function to save the package's configuration file into the
25 # right location. You may specify any number of configuration files,
26 # but just make sure you call save_config with all of them at the same
27 # time in order for things to work properly.
28 save_config() {
29 if [[ ${EBUILD_PHASE} != "install" ]]; then
30 die "Bad package! save_config only for use in src_install functions!"
31 fi
32 [[ $# -eq 0 ]] && die "Usage: save_config <files>"
33
34 # Be lazy in our EAPI compat
35 : ${ED:=${D}}
36
37 local dest="/etc/portage/savedconfig/${CATEGORY}"
38 if [[ $# -eq 1 && -f $1 ]] ; then
39 # Just one file, so have the ${PF} be that config file
40 dodir "${dest}"
41 cp "$@" "${ED}/${dest}/${PF}" || die "failed to save $*"
42 else
43 # A dir, or multiple files, so have the ${PF} be a dir
44 # with all the saved stuff below it
45 dodir "${dest}/${PF}"
46 treecopy "$@" "${ED}/${dest}/${PF}" || die "failed to save $*"
47 fi
48
49 elog "Your configuration for ${CATEGORY}/${PF} has been saved in "
50 elog "/etc/portage/savedconfig/${CATEGORY}/${PF} for your editing pleasure."
51 elog "You can edit these files by hand and remerge this package with"
52 elog "USE=savedconfig to customise the configuration."
53 elog "You can rename this file/directory to one of the following for"
54 elog "its configuration to apply to multiple versions:"
55 elog '${PORTAGE_CONFIGROOT}/etc/portage/savedconfig/'
56 elog '[${CTARGET}|${CHOST}|""]/${CATEGORY}/[${PF}|${P}|${PN}]'
57 }
58
59 # @FUNCTION: restore_config
60 # @USAGE: <config files to restore>
61 # @DESCRIPTION:
62 # Restores the configuation saved ebuild previously potentially with user edits.
63 # You can restore a single file or a whole bunch, just make sure you call
64 # restore_config with all of the files to restore at the same time.
65 #
66 # Config files can be laid out as:
67 # @CODE
68 # ${PORTAGE_CONFIGROOT}/etc/portage/savedconfig/${CTARGET}/${CATEGORY}/${PF}
69 # ${PORTAGE_CONFIGROOT}/etc/portage/savedconfig/${CHOST}/${CATEGORY}/${PF}
70 # ${PORTAGE_CONFIGROOT}/etc/portage/savedconfig/${CATEGORY}/${PF}
71 # ${PORTAGE_CONFIGROOT}/etc/portage/savedconfig/${CTARGET}/${CATEGORY}/${P}
72 # ${PORTAGE_CONFIGROOT}/etc/portage/savedconfig/${CHOST}/${CATEGORY}/${P}
73 # ${PORTAGE_CONFIGROOT}/etc/portage/savedconfig/${CATEGORY}/${P}
74 # ${PORTAGE_CONFIGROOT}/etc/portage/savedconfig/${CTARGET}/${CATEGORY}/${PN}
75 # ${PORTAGE_CONFIGROOT}/etc/portage/savedconfig/${CHOST}/${CATEGORY}/${PN}
76 # ${PORTAGE_CONFIGROOT}/etc/portage/savedconfig/${CATEGORY}/${PN}
77 # @CODE
78 restore_config() {
79 case ${EBUILD_PHASE} in
80 unpack|compile|configure|prepare) ;;
81 *) die "Bad package! restore_config only for use in src_{unpack,compile,configure,prepare} functions!" ;;
82 esac
83
84 use savedconfig || return
85
86 local found check configfile
87 local base=${PORTAGE_CONFIGROOT}/etc/portage/savedconfig
88 for check in {${CATEGORY}/${PF},${CATEGORY}/${P},${CATEGORY}/${PN}}; do
89 configfile=${base}/${CTARGET}/${check}
90 [[ -r ${configfile} ]] || configfile=${base}/${CHOST}/${check}
91 [[ -r ${configfile} ]] || configfile=${base}/${check}
92 einfo "Checking existence of ${configfile} ..."
93 if [[ -r "${configfile}" ]]; then
94 einfo "found ${configfile}"
95 found=${configfile};
96 break;
97 fi
98 done
99 if [[ -f ${found} ]]; then
100 elog "Building using saved configfile ${found}"
101 if [ $# -gt 0 ]; then
102 cp -pPR "${found}" "$1" || die "Failed to restore ${found} to $1"
103 else
104 die "need to know the restoration filename"
105 fi
106 elif [[ -d ${found} ]]; then
107 elog "Building using saved config directory ${found}"
108 local dest=${PWD}
109 pushd "${found}" > /dev/null
110 treecopy . "${dest}" || die "Failed to restore ${found} to $1"
111 popd > /dev/null
112 else
113 # maybe the user is screwing around with perms they shouldnt #289168
114 if [[ ! -r ${base} ]] ; then
115 eerror "Unable to read ${base} -- please check its permissions."
116 die "Reading config files failed"
117 fi
118 ewarn "No saved config to restore - please remove USE=savedconfig or"
119 ewarn "provide a configuration file in ${PORTAGE_CONFIGROOT}/etc/portage/savedconfig/${CATEGORY}/${PN}"
120 ewarn "Your config file(s) will not be used this time"
121 fi
122 }
123
124 savedconfig_pkg_postinst() {
125 # If the user has USE=savedconfig, then chances are they
126 # are modifying these files, so keep them around. #396169
127 # This might lead to cruft build up, but the alternatives
128 # are worse :/.
129
130 if use savedconfig ; then
131 # Be lazy in our EAPI compat
132 : ${EROOT:=${ROOT}}
133
134 find "${EROOT}/etc/portage/savedconfig/${CATEGORY}/${PF}" \
135 -exec touch {} + 2>/dev/null
136 fi
137 }
138
139 EXPORT_FUNCTIONS pkg_postinst

  ViewVC Help
Powered by ViewVC 1.1.20