| 1 | # Copyright 1999-2004 Gentoo Technologies, Inc. |
1 | # Copyright 1999-2006 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/webapp.eclass,v 1.20 2004/05/22 18:56:58 stuart Exp $ |
3 | # $Header: /var/cvsroot/gentoo-x86/eclass/webapp.eclass,v 1.42 2006/06/15 07:01:01 stuart Exp $ |
| 4 | # |
4 | # |
| 5 | # eclass/webapp.eclass |
5 | # eclass/webapp.eclass |
| 6 | # Eclass for installing applications to run under a web server |
6 | # Eclass for installing applications to run under a web server |
| 7 | # |
7 | # |
| 8 | # Part of the implementation of GLEP #11 |
8 | # Part of the implementation of GLEP #11 |
| 9 | # |
9 | # |
| 10 | # Author(s) Stuart Herbert <stuart@gentoo.org> |
10 | # Author(s) Stuart Herbert <stuart@gentoo.org> |
|
|
11 | # Renat Lumpau <rl03@gentoo.org> |
|
|
12 | # Gunnar Wrobel <wrobel@gentoo.org> |
| 11 | # |
13 | # |
| 12 | # ------------------------------------------------------------------------ |
14 | # ------------------------------------------------------------------------ |
| 13 | # |
15 | # |
| 14 | # The master copy of this eclass is held in Stu's subversion repository. |
16 | # The master copy of this eclass is held in our subversion repository. |
|
|
17 | # http://svn.gnqs.org/projects/vhost-tools/browser/ |
| 15 | # |
18 | # |
| 16 | # If you make changes to this file and don't tell Stu, chances are that |
19 | # If you make changes to this file and don't tell us, chances are that |
| 17 | # your changes will be overwritten the next time Stu releases a new version |
20 | # your changes will be overwritten the next time we release a new version |
| 18 | # of webapp-config. |
21 | # of webapp-config. |
| 19 | # |
22 | # |
| 20 | # ------------------------------------------------------------------------ |
23 | # ------------------------------------------------------------------------ |
| 21 | |
24 | |
| 22 | ECLASS=webapp |
|
|
| 23 | INHERITED="$INHERITED $ECLASS" |
|
|
| 24 | SLOT="${PVR}" |
25 | SLOT="${PVR}" |
| 25 | IUSE="$IUSE vhosts" |
26 | IUSE="vhosts" |
| 26 | DEPEND="$DEPEND >=net-www/webapp-config-1.7 app-portage/gentoolkit" |
27 | DEPEND="app-admin/webapp-config" |
|
|
28 | RDEPEND="${DEPEND}" |
| 27 | |
29 | |
| 28 | EXPORT_FUNCTIONS pkg_postinst pkg_setup src_install pkg_prerm |
30 | EXPORT_FUNCTIONS pkg_postinst pkg_setup src_install pkg_prerm |
| 29 | |
31 | |
| 30 | INSTALL_DIR="/$PN" |
32 | INSTALL_DIR="/${PN}" |
| 31 | IS_UPGRADE=0 |
33 | IS_UPGRADE=0 |
| 32 | IS_REPLACE=0 |
34 | IS_REPLACE=0 |
| 33 | |
35 | |
| 34 | INSTALL_CHECK_FILE="installed_by_webapp_eclass" |
36 | INSTALL_CHECK_FILE="installed_by_webapp_eclass" |
|
|
37 | |
|
|
38 | ETC_CONFIG="${ROOT}/etc/vhosts/webapp-config" |
|
|
39 | WEBAPP_CONFIG="${ROOT}/usr/sbin/webapp-config" |
|
|
40 | |
|
|
41 | # ------------------------------------------------------------------------ |
|
|
42 | # INTERNAL FUNCTION - USED BY THIS ECLASS ONLY |
|
|
43 | # |
|
|
44 | # Load the config file /etc/vhosts/webapp-config |
|
|
45 | # |
|
|
46 | # Supports both the old bash version, and the new python version |
|
|
47 | # |
|
|
48 | # ------------------------------------------------------------------------ |
|
|
49 | |
|
|
50 | function webapp_read_config () |
|
|
51 | { |
|
|
52 | if has_version '>=app-admin/webapp-config-1.50'; then |
|
|
53 | ENVVAR=$(${WEBAPP_CONFIG} --query ${PN} ${PVR}) || die "Could not read settings from webapp-config!" |
|
|
54 | eval ${ENVVAR} |
|
|
55 | else |
|
|
56 | . ${ETC_CONFIG} || die "Unable to read ${ETC_CONFIG}" |
|
|
57 | fi |
|
|
58 | } |
| 35 | |
59 | |
| 36 | # ------------------------------------------------------------------------ |
60 | # ------------------------------------------------------------------------ |
| 37 | # INTERNAL FUNCTION - USED BY THIS ECLASS ONLY |
61 | # INTERNAL FUNCTION - USED BY THIS ECLASS ONLY |
| 38 | # |
62 | # |
| 39 | # Check whether a specified file exists within the image/ directory |
63 | # Check whether a specified file exists within the image/ directory |
| … | |
… | |
| 46 | |
70 | |
| 47 | function webapp_checkfileexists () |
71 | function webapp_checkfileexists () |
| 48 | { |
72 | { |
| 49 | local my_prefix |
73 | local my_prefix |
| 50 | |
74 | |
| 51 | [ -n "$2" ] && my_prefix="$2/" || my_prefix= |
75 | [ -n "${2}" ] && my_prefix="${2}/" || my_prefix= |
| 52 | |
76 | |
| 53 | if [ ! -e ${my_prefix}$1 ]; then |
77 | if [ ! -e "${my_prefix}${1}" ]; then |
| 54 | msg="ebuild fault: file $1 not found" |
78 | msg="ebuild fault: file '${1}' not found" |
| 55 | eerror "$msg" |
79 | eerror "$msg" |
| 56 | eerror "Please report this as a bug at http://bugs.gentoo.org/" |
80 | eerror "Please report this as a bug at http://bugs.gentoo.org/" |
| 57 | die "$msg" |
81 | die "$msg" |
| 58 | fi |
82 | fi |
| 59 | } |
83 | } |
| … | |
… | |
| 64 | |
88 | |
| 65 | function webapp_check_installedat |
89 | function webapp_check_installedat |
| 66 | { |
90 | { |
| 67 | local my_output |
91 | local my_output |
| 68 | |
92 | |
| 69 | /usr/sbin/webapp-config --show-installed -h localhost -d $INSTALL_DIR 2> /dev/null |
93 | ${WEBAPP_CONFIG} --show-installed -h localhost -d "${INSTALL_DIR}" 2> /dev/null |
| 70 | } |
94 | } |
| 71 | |
95 | |
| 72 | # ------------------------------------------------------------------------ |
96 | # ------------------------------------------------------------------------ |
| 73 | # INTERNAL FUNCTION - USED BY THIS ECLASS ONLY |
97 | # INTERNAL FUNCTION - USED BY THIS ECLASS ONLY |
| 74 | # ------------------------------------------------------------------------ |
|
|
| 75 | |
|
|
| 76 | function webapp_import_config () |
|
|
| 77 | { |
|
|
| 78 | if [ -z "${MY_HTDOCSDIR}" ]; then |
|
|
| 79 | . /etc/conf.d/webapp-config |
|
|
| 80 | fi |
|
|
| 81 | |
|
|
| 82 | if [ -z "${MY_HTDOCSDIR}" ]; then |
|
|
| 83 | libsh_edie "/etc/conf.d/webapp-config not imported" |
|
|
| 84 | fi |
|
|
| 85 | } |
|
|
| 86 | |
|
|
| 87 | # ------------------------------------------------------------------------ |
|
|
| 88 | # INTERNAL FUNCTION - USED BY THIS ECLASS ONLY |
|
|
| 89 | # |
98 | # |
| 90 | # ------------------------------------------------------------------------ |
99 | # ------------------------------------------------------------------------ |
| 91 | |
100 | |
| 92 | function webapp_strip_appdir () |
101 | function webapp_strip_appdir () |
| 93 | { |
102 | { |
| 94 | local my_stripped="$1" |
103 | local my_stripped="${1}" |
| 95 | echo "$1" | sed -e "s|${MY_APPDIR}/||g;" |
104 | echo "${1}" | sed -e "s|${MY_APPDIR}/||g;" |
| 96 | } |
105 | } |
| 97 | |
106 | |
| 98 | function webapp_strip_d () |
107 | function webapp_strip_d () |
| 99 | { |
108 | { |
| 100 | echo "$1" | sed -e "s|${D}||g;" |
109 | echo "${1}" | sed -e "s|${D}||g;" |
| 101 | } |
110 | } |
| 102 | |
111 | |
| 103 | function webapp_strip_cwd () |
112 | function webapp_strip_cwd () |
| 104 | { |
113 | { |
| 105 | local my_stripped="$1" |
114 | local my_stripped="${1}" |
| 106 | echo "$1" | sed -e 's|/./|/|g;' |
115 | echo "${1}" | sed -e 's|/./|/|g;' |
| 107 | } |
116 | } |
| 108 | |
117 | |
| 109 | # ------------------------------------------------------------------------ |
118 | # ------------------------------------------------------------------------ |
| 110 | # EXPORTED FUNCTION - FOR USE IN EBUILDS |
119 | # EXPORTED FUNCTION - FOR USE IN EBUILDS |
| 111 | # |
120 | # |
| … | |
… | |
| 114 | # @param $1 - config file |
123 | # @param $1 - config file |
| 115 | # ------------------------------------------------------------------------ |
124 | # ------------------------------------------------------------------------ |
| 116 | |
125 | |
| 117 | function webapp_configfile () |
126 | function webapp_configfile () |
| 118 | { |
127 | { |
|
|
128 | local m="" |
|
|
129 | for m in "$@" ; do |
| 119 | webapp_checkfileexists "$1" "$D" |
130 | webapp_checkfileexists "${m}" "${D}" |
| 120 | echo $1 |
131 | |
| 121 | local MY_FILE="`webapp_strip_appdir $1`" |
132 | local MY_FILE="$(webapp_strip_appdir "${m}")" |
| 122 | echo $MY_FILE |
133 | MY_FILE="$(webapp_strip_cwd "${MY_FILE}")" |
| 123 | |
134 | |
| 124 | einfo "(config) $MY_FILE" |
135 | einfo "(config) ${MY_FILE}" |
| 125 | echo "$MY_FILE" >> ${D}${WA_CONFIGLIST} |
136 | echo "${MY_FILE}" >> ${D}/${WA_CONFIGLIST} |
|
|
137 | done |
| 126 | } |
138 | } |
| 127 | |
139 | |
| 128 | # ------------------------------------------------------------------------ |
140 | # ------------------------------------------------------------------------ |
| 129 | # EXPORTED FUNCTION - FOR USE IN EBUILDS |
141 | # EXPORTED FUNCTION - FOR USE IN EBUILDS |
| 130 | # |
142 | # |
| … | |
… | |
| 134 | # @param $1 - the script to run |
146 | # @param $1 - the script to run |
| 135 | # ------------------------------------------------------------------------ |
147 | # ------------------------------------------------------------------------ |
| 136 | |
148 | |
| 137 | function webapp_hook_script () |
149 | function webapp_hook_script () |
| 138 | { |
150 | { |
| 139 | webapp_checkfileexists "$2" |
151 | webapp_checkfileexists "${1}" |
| 140 | |
152 | |
| 141 | einfo "(hook) $1" |
153 | einfo "(hook) ${1}" |
| 142 | cp "$1" "${D}${MY_HOOKSCRIPTSDIR}/`basename $1`" || die "Unable to install $1 into ${D}${MY_HOOKSCRIPTSDIR}/" |
154 | cp "${1}" "${D}/${MY_HOOKSCRIPTSDIR}/$(basename "${1}")" || die "Unable to install ${1} into ${D}/${MY_HOOKSCRIPTSDIR}/" |
| 143 | chmod 555 "${D}${MY_HOOKSCRIPTSDIR}/`basename $1`" |
155 | chmod 555 "${D}/${MY_HOOKSCRIPTSDIR}/$(basename "${1}")" |
| 144 | } |
156 | } |
| 145 | |
157 | |
| 146 | # ------------------------------------------------------------------------ |
158 | # ------------------------------------------------------------------------ |
| 147 | # EXPORTED FUNCTION - FOR USE IN EBUILDS |
159 | # EXPORTED FUNCTION - FOR USE IN EBUILDS |
| 148 | # |
160 | # |
| … | |
… | |
| 150 | # |
162 | # |
| 151 | # @param $1 - language code (use 'en' for now) |
163 | # @param $1 - language code (use 'en' for now) |
| 152 | # @param $2 - the file to install |
164 | # @param $2 - the file to install |
| 153 | # ------------------------------------------------------------------------ |
165 | # ------------------------------------------------------------------------ |
| 154 | |
166 | |
| 155 | function webapp_postinst_txt |
167 | function webapp_postinst_txt () |
| 156 | { |
168 | { |
| 157 | webapp_checkfileexists "$2" |
169 | webapp_checkfileexists "${2}" |
| 158 | |
170 | |
| 159 | einfo "(rtfm) $2 (lang: $1)" |
171 | einfo "(info) ${2} (lang: ${1})" |
| 160 | cp "$2" "${D}${MY_APPDIR}/postinst-$1.txt" |
172 | cp "${2}" "${D}/${MY_APPDIR}/postinst-${1}.txt" |
| 161 | } |
173 | } |
| 162 | |
174 | |
| 163 | # ------------------------------------------------------------------------ |
175 | # ------------------------------------------------------------------------ |
| 164 | # EXPORTED FUNCTION - FOR USE IN EBUILDS |
176 | # EXPORTED FUNCTION - FOR USE IN EBUILDS |
| 165 | # |
177 | # |
| 166 | # Identify a script file (usually, but not always PHP or Perl) which is |
178 | # Install a text file containing post-upgrade instructions. |
| 167 | # |
179 | # |
| 168 | # Files in this list may be modified to #! the required CGI engine when |
180 | # @param $1 - language code (use 'en' for now) |
| 169 | # installed by webapp-config tool in the future. |
181 | # @param $2 - the file to install |
| 170 | # |
|
|
| 171 | # @param $1 - the cgi engine to use |
|
|
| 172 | # @param $2 - the script file that could run under a cgi-bin |
|
|
| 173 | # |
|
|
| 174 | # ------------------------------------------------------------------------ |
182 | # ------------------------------------------------------------------------ |
| 175 | |
183 | |
| 176 | function webapp_runbycgibin () |
184 | function webapp_postupgrade_txt () |
| 177 | { |
185 | { |
| 178 | webapp_checkfileexists "$2" "$D" |
186 | webapp_checkfileexists "${2}" |
| 179 | local MY_FILE="`webapp_strip_appdir $2`" |
|
|
| 180 | MY_FILE="`webapp_strip_cwd $MY_FILE`" |
|
|
| 181 | |
187 | |
| 182 | einfo "(cgi-bin) $1 - $MY_FILE" |
188 | einfo "(info) ${2} (lang: ${1})" |
| 183 | echo "$1 $MY_FILE" >> ${D}${WA_RUNBYCGIBINLIST} |
189 | cp "${2}" "${D}/${MY_APPDIR}/postupgrade-${1}.txt" |
| 184 | } |
190 | } |
| 185 | |
191 | |
| 186 | # ------------------------------------------------------------------------ |
192 | # ------------------------------------------------------------------------ |
| 187 | # EXPORTED FUNCTION - FOR USE IN EBUILDS |
193 | # EXPORTED FUNCTION - FOR USE IN EBUILDS |
| 188 | # |
194 | # |
| 189 | # Identify a file which must be owned by the webserver's user:group |
195 | # Identify a file which must be owned by the webserver's user:group |
| 190 | # settings. |
196 | # settings. |
| 191 | # |
197 | # |
| 192 | # The ownership of the file is NOT set until the application is installed |
198 | # The ownership of the file is NOT set until the application is installed |
| 193 | # using the webapp-config tool. |
199 | # using the webapp-config tool. |
| 194 | # |
200 | # |
| 195 | # @param $1 - file to be owned by the webserver user:group combo |
201 | # @param $1 - file to be owned by the webserver user:group combo |
| 196 | # |
202 | # |
| 197 | # ------------------------------------------------------------------------ |
203 | # ------------------------------------------------------------------------ |
| 198 | |
204 | |
| 199 | function webapp_serverowned () |
205 | function webapp_serverowned () |
| 200 | { |
206 | { |
|
|
207 | local a="" |
|
|
208 | local m="" |
|
|
209 | if [ "${1}" = "-R" ]; then |
|
|
210 | shift |
|
|
211 | for m in "$@" ; do |
|
|
212 | for a in $(find ${D}/${m}); do |
|
|
213 | a=${a/${D}\/\///} |
|
|
214 | webapp_checkfileexists "${a}" "$D" |
|
|
215 | local MY_FILE="$(webapp_strip_appdir "${a}")" |
|
|
216 | MY_FILE="$(webapp_strip_cwd "${MY_FILE}")" |
|
|
217 | |
|
|
218 | einfo "(server owned) ${MY_FILE}" |
|
|
219 | echo "${MY_FILE}" >> "${D}/${WA_SOLIST}" |
|
|
220 | done |
|
|
221 | done |
|
|
222 | else |
|
|
223 | for m in "$@" ; do |
| 201 | webapp_checkfileexists "$1" "$D" |
224 | webapp_checkfileexists "${m}" "$D" |
| 202 | local MY_FILE="`webapp_strip_appdir $1`" |
225 | local MY_FILE="$(webapp_strip_appdir "${m}")" |
| 203 | |
226 | MY_FILE="$(webapp_strip_cwd "${MY_FILE}")" |
|
|
227 | |
| 204 | einfo "(server owned) $MY_FILE" |
228 | einfo "(server owned) ${MY_FILE}" |
| 205 | echo "$MY_FILE" >> ${D}${WA_SOLIST} |
229 | echo "${MY_FILE}" >> "${D}/${WA_SOLIST}" |
|
|
230 | done |
|
|
231 | fi |
| 206 | } |
232 | } |
| 207 | |
233 | |
| 208 | # ------------------------------------------------------------------------ |
234 | # ------------------------------------------------------------------------ |
| 209 | # EXPORTED FUNCTION - FOR USE IN EBUILDS |
235 | # EXPORTED FUNCTION - FOR USE IN EBUILDS |
| 210 | # |
236 | # |
| … | |
… | |
| 217 | # NOTE: |
243 | # NOTE: |
| 218 | # this function will automagically prepend $1 to the front of your |
244 | # this function will automagically prepend $1 to the front of your |
| 219 | # config file's name |
245 | # config file's name |
| 220 | # ------------------------------------------------------------------------ |
246 | # ------------------------------------------------------------------------ |
| 221 | |
247 | |
| 222 | function webapp_server_config () |
248 | function webapp_server_configfile () |
| 223 | { |
249 | { |
| 224 | webapp_checkfileexists "$2" |
250 | webapp_checkfileexists "${2}" |
| 225 | |
251 | |
| 226 | # sort out what the name will be of the config file |
252 | # sort out what the name will be of the config file |
| 227 | |
253 | |
| 228 | local my_file |
254 | local my_file |
| 229 | |
255 | |
| 230 | if [ -z "$3" ]; then |
256 | if [ -z "${3}" ]; then |
| 231 | $my_file="$1-`basename $2`" |
257 | my_file="${1}-$(basename "${2}")" |
| 232 | else |
258 | else |
| 233 | $my_file="$1-$3" |
259 | my_file="${1}-${3}" |
| 234 | fi |
260 | fi |
| 235 | |
261 | |
| 236 | # warning: |
262 | # warning: |
| 237 | # |
263 | # |
| 238 | # do NOT change the naming convention used here without changing all |
264 | # do NOT change the naming convention used here without changing all |
| 239 | # the other scripts that also rely upon these names |
265 | # the other scripts that also rely upon these names |
| 240 | |
266 | |
| 241 | einfo "($1) config file '$my_file'" |
267 | einfo "(${1}) config file '${my_file}'" |
| 242 | cp "$2" "${D}${MY_SERVERCONFIGDIR}/${my_file}" |
268 | cp "${2}" "${D}/${MY_SERVERCONFIGDIR}/${my_file}" |
| 243 | } |
269 | } |
| 244 | |
270 | |
| 245 | # ------------------------------------------------------------------------ |
271 | # ------------------------------------------------------------------------ |
| 246 | # EXPORTED FUNCTION - FOR USE IN EBUILDS |
272 | # EXPORTED FUNCTION - FOR USE IN EBUILDS |
| 247 | # |
273 | # |
| … | |
… | |
| 254 | # a new db from scratch) |
280 | # a new db from scratch) |
| 255 | # ------------------------------------------------------------------------ |
281 | # ------------------------------------------------------------------------ |
| 256 | |
282 | |
| 257 | function webapp_sqlscript () |
283 | function webapp_sqlscript () |
| 258 | { |
284 | { |
| 259 | webapp_checkfileexists "$2" |
285 | webapp_checkfileexists "${2}" |
| 260 | |
286 | |
| 261 | # create the directory where this script will go |
287 | # create the directory where this script will go |
| 262 | # |
288 | # |
| 263 | # scripts for specific database engines go into their own subdirectory |
289 | # scripts for specific database engines go into their own subdirectory |
| 264 | # just to keep things readable on the filesystem |
290 | # just to keep things readable on the filesystem |
| 265 | |
291 | |
| 266 | if [ ! -d "${D}${MY_SQLSCRIPTSDIR}/$1" ]; then |
292 | if [ ! -d "${D}/${MY_SQLSCRIPTSDIR}/${1}" ]; then |
| 267 | mkdir -p "${D}${MY_SQLSCRIPTSDIR}/$1" || libsh_die "unable to create directory ${D}${MY_SQLSCRIPTSDIR}/$1" |
293 | mkdir -p "${D}/${MY_SQLSCRIPTSDIR}/${1}" || die "unable to create directory ${D}/${MY_SQLSCRIPTSDIR}/${1}" |
| 268 | fi |
294 | fi |
| 269 | |
295 | |
| 270 | # warning: |
296 | # warning: |
| 271 | # |
297 | # |
| 272 | # do NOT change the naming convention used here without changing all |
298 | # do NOT change the naming convention used here without changing all |
| 273 | # the other scripts that also rely upon these names |
299 | # the other scripts that also rely upon these names |
| 274 | |
300 | |
| 275 | # are we dealing with an 'upgrade'-type script? |
301 | # are we dealing with an 'upgrade'-type script? |
| 276 | if [ -n "$3" ]; then |
302 | if [ -n "${3}" ]; then |
| 277 | # yes we are |
303 | # yes we are |
| 278 | einfo "($1) upgrade script from ${PN}-${PVR} to $3" |
304 | einfo "(${1}) upgrade script from ${PN}-${PVR} to ${3}" |
| 279 | cp $2 ${D}${MY_SQLSCRIPTSDIR}/$1/${3}_to_${PVR}.sql |
305 | cp "${2}" "${D}${MY_SQLSCRIPTSDIR}/${1}/${3}_to_${PVR}.sql" |
|
|
306 | chmod 600 "${D}${MY_SQLSCRIPTSDIR}/${1}/${3}_to_${PVR}.sql" |
| 280 | else |
307 | else |
| 281 | # no, we are not |
308 | # no, we are not |
| 282 | einfo "($1) create script for ${PN}-${PVR}" |
309 | einfo "(${1}) create script for ${PN}-${PVR}" |
| 283 | cp $2 ${D}${MY_SQLSCRIPTSDIR}/$1/${PVR}_create.sql |
310 | cp "${2}" "${D}/${MY_SQLSCRIPTSDIR}/${1}/${PVR}_create.sql" |
|
|
311 | chmod 600 "${D}/${MY_SQLSCRIPTSDIR}/${1}/${PVR}_create.sql" |
| 284 | fi |
312 | fi |
| 285 | } |
313 | } |
| 286 | |
314 | |
| 287 | # ------------------------------------------------------------------------ |
315 | # ------------------------------------------------------------------------ |
| 288 | # EXPORTED FUNCTION - call from inside your ebuild's src_install AFTER |
316 | # EXPORTED FUNCTION - call from inside your ebuild's src_install AFTER |
| 289 | # everything else has run |
317 | # everything else has run |
| 290 | # |
318 | # |
| 291 | # For now, we just make sure that root owns everything, and that there |
319 | # For now, we just make sure that root owns everything, and that there |
| 292 | # are no setuid files. I'm sure this will change significantly before |
320 | # are no setuid files. |
| 293 | # the final version! |
|
|
| 294 | # ------------------------------------------------------------------------ |
321 | # ------------------------------------------------------------------------ |
| 295 | |
322 | |
| 296 | function webapp_src_install () |
323 | function webapp_src_install () |
| 297 | { |
324 | { |
| 298 | chown -R ${VHOST_DEFAULT_UID}:${VHOST_DEFAULT_GID} ${D}/ |
325 | chown -R "${VHOST_DEFAULT_UID}:${VHOST_DEFAULT_GID}" "${D}/" |
| 299 | chmod -R u-s ${D}/ |
326 | chmod -R u-s "${D}/" |
| 300 | chmod -R g-s ${D}/ |
327 | chmod -R g-s "${D}/" |
| 301 | |
328 | |
| 302 | keepdir ${MY_PERSISTDIR} |
329 | keepdir "${MY_PERSISTDIR}" |
| 303 | fowners root:root ${MY_PERSISTDIR} |
330 | fowners "root:0" "${MY_PERSISTDIR}" |
| 304 | fperms 755 ${MY_PERSISTDIR} |
331 | fperms 755 "${MY_PERSISTDIR}" |
| 305 | |
332 | |
| 306 | # to test whether or not the ebuild has correctly called this function |
333 | # to test whether or not the ebuild has correctly called this function |
| 307 | # we add an empty file to the filesystem |
334 | # we add an empty file to the filesystem |
| 308 | # |
335 | # |
| 309 | # we used to just set a variable in the shell script, but we can |
336 | # we used to just set a variable in the shell script, but we can |
| 310 | # no longer rely on Portage calling both webapp_src_install() and |
337 | # no longer rely on Portage calling both webapp_src_install() and |
| 311 | # webapp_pkg_postinst() within the same shell process |
338 | # webapp_pkg_postinst() within the same shell process |
| 312 | |
339 | |
| 313 | touch ${D}/${MY_APPDIR}/${INSTALL_CHECK_FILE} |
340 | touch "${D}/${MY_APPDIR}/${INSTALL_CHECK_FILE}" |
| 314 | } |
341 | } |
| 315 | |
342 | |
| 316 | # ------------------------------------------------------------------------ |
343 | # ------------------------------------------------------------------------ |
| 317 | # EXPORTED FUNCTION - call from inside your ebuild's pkg_config AFTER |
344 | # EXPORTED FUNCTION - call from inside your ebuild's pkg_config AFTER |
| 318 | # everything else has run |
345 | # everything else has run |
| … | |
… | |
| 323 | |
350 | |
| 324 | function webapp_pkg_setup () |
351 | function webapp_pkg_setup () |
| 325 | { |
352 | { |
| 326 | # add sanity checks here |
353 | # add sanity checks here |
| 327 | |
354 | |
| 328 | if [ "$SLOT+" != "${PVR}+" ]; then |
355 | if [ "${SLOT}+" != "${PVR}+" ]; then |
|
|
356 | # special case - some ebuilds *do* need to overwride the SLOT |
|
|
357 | if [ "${WEBAPP_MANUAL_SLOT}" != "yes" ]; then |
| 329 | die "ebuild sets SLOT, overrides webapp.eclass" |
358 | die "ebuild sets SLOT, overrides webapp.eclass" |
|
|
359 | else |
|
|
360 | ewarn |
|
|
361 | ewarn "This ebuild overrides the default SLOT behaviour for webapps" |
|
|
362 | ewarn "If this package installs files into the htdocs dir, this is" |
|
|
363 | ewarn "probably a bug in the ebuild." |
|
|
364 | ewarn |
|
|
365 | fi |
| 330 | fi |
366 | fi |
| 331 | |
367 | |
| 332 | # pull in the shared configuration file |
368 | # pull in the shared configuration file |
| 333 | |
369 | |
| 334 | G_HOSTNAME="localhost" |
370 | G_HOSTNAME="localhost" |
| 335 | . /etc/vhosts/webapp-config || die "Unable to open /etc/vhosts/webapp-config file" |
371 | webapp_read_config |
| 336 | |
372 | |
| 337 | # are we installing a webapp-config solution over the top of a |
373 | # are we installing a webapp-config solution over the top of a |
| 338 | # non-webapp-config solution? |
374 | # non-webapp-config solution? |
| 339 | |
375 | |
| 340 | if ! use vhosts ; then |
376 | if ! use vhosts ; then |
| 341 | local my_dir="$VHOST_ROOT/$MY_HTDOCSBASE/$PN" |
377 | local my_dir="${ROOT}${VHOST_ROOT}/${MY_HTDOCSBASE}/${PN}" |
| 342 | local my_output |
378 | local my_output |
| 343 | |
379 | |
| 344 | if [ -d "$my_dir" ] ; then |
380 | if [ -d "${my_dir}" ] ; then |
| 345 | einfo "You already have something installed in $my_dir" |
|
|
| 346 | einfo "Are you trying to install over the top of something I cannot upgrade?" |
|
|
| 347 | |
|
|
| 348 | my_output="`webapp_check_installedat`" |
381 | my_output="$(webapp_check_installedat)" |
| 349 | |
382 | |
| 350 | if [ "$?" != "0" ]; then |
383 | if [ "$?" != "0" ]; then |
| 351 | |
|
|
| 352 | # okay, whatever is there, it isn't webapp-config-compatible |
384 | # okay, whatever is there, it isn't webapp-config-compatible |
|
|
385 | ewarn "You already have something installed in ${my_dir}" |
| 353 | ewarn |
386 | ewarn |
| 354 | ewarn "Whatever is in $my_dir, it's not" |
387 | ewarn "Whatever is in ${my_dir}, it's not" |
| 355 | ewarn "compatible with webapp-config." |
388 | ewarn "compatible with webapp-config." |
| 356 | ewarn |
389 | ewarn |
| 357 | ewarn "This ebuild may be overwriting important files." |
390 | ewarn "This ebuild may be overwriting important files." |
| 358 | ewarn |
391 | ewarn |
| 359 | elif [ "`echo $my_output | awk '{ print $1 }'`" != "$PN" ]; then |
392 | elif [ "$(echo ${my_output} | awk '{ print $1 }')" != "${PN}" ]; then |
| 360 | eerror "$my_dir contains $my_output" |
393 | eerror "${my_dir} contains ${my_output}" |
| 361 | eerror "I cannot upgrade that" |
394 | eerror "I cannot upgrade that" |
| 362 | die "Cannot upgrade contents of $my_dir" |
395 | die "Cannot upgrade contents of ${my_dir}" |
| 363 | else |
|
|
| 364 | einfo |
|
|
| 365 | einfo "I can upgrade the contents of $my_dir" |
|
|
| 366 | einfo |
|
|
| 367 | fi |
396 | fi |
| 368 | fi |
397 | fi |
| 369 | fi |
398 | fi |
| 370 | } |
399 | } |
| 371 | |
400 | |
| 372 | function webapp_someunusedfunction () |
|
|
| 373 | { |
|
|
| 374 | # are we emerging something that is already installed? |
|
|
| 375 | |
|
|
| 376 | if [ -d "${D}${MY_APPROOT}/${MY_APPSUFFIX}" ]; then |
|
|
| 377 | # yes we are |
|
|
| 378 | ewarn "Removing existing copy of ${PN}-${PVR}" |
|
|
| 379 | rm -rf "${D}${MY_APPROOT}/${MY_APPSUFFIX}" |
|
|
| 380 | fi |
|
|
| 381 | } |
|
|
| 382 | |
|
|
| 383 | function webapp_getinstalltype () |
401 | function webapp_getinstalltype () |
| 384 | { |
402 | { |
| 385 | # or are we upgrading? |
403 | # or are we upgrading? |
| 386 | |
404 | |
| 387 | if ! use vhosts ; then |
405 | if ! use vhosts ; then |
| 388 | # we only run webapp-config if vhosts USE flag is not set |
406 | # we only run webapp-config if vhosts USE flag is not set |
| 389 | |
407 | |
| 390 | local my_output |
408 | local my_output |
| 391 | |
409 | |
| 392 | my_output="`webapp_check_installedat`" |
410 | my_output="$(webapp_check_installedat)" |
| 393 | |
411 | |
| 394 | if [ "$?" = "0" ] ; then |
412 | if [ "${?}" = "0" ] ; then |
| 395 | # something is already installed there |
413 | # something is already installed there |
| 396 | # |
414 | # |
| 397 | # make sure it isn't the same version |
415 | # make sure it isn't the same version |
| 398 | |
416 | |
| 399 | local my_pn="`echo $my_output | awk '{ print $1 }'`" |
417 | local my_pn="$(echo ${my_output} | awk '{ print $1 }')" |
| 400 | local my_pvr="`echo $my_output | awk '{ print $2 }'`" |
418 | local my_pvr="$(echo ${my_output} | awk '{ print $2 }')" |
| 401 | |
419 | |
| 402 | REMOVE_PKG="${my_pn}-${my_pvr}" |
420 | REMOVE_PKG="${my_pn}-${my_pvr}" |
| 403 | |
421 | |
| 404 | if [ "$my_pn" == "$PN" ]; then |
422 | if [ "${my_pn}" == "${PN}" ]; then |
| 405 | if [ "$my_pvr" != "$PVR" ]; then |
423 | if [ "${my_pvr}" != "${PVR}" ]; then |
| 406 | einfo "This is an upgrade" |
424 | einfo "This is an upgrade" |
| 407 | IS_UPGRADE=1 |
425 | IS_UPGRADE=1 |
| 408 | else |
426 | else |
| 409 | einfo "This is a re-installation" |
427 | einfo "This is a re-installation" |
| 410 | IS_REPLACE=1 |
428 | IS_REPLACE=1 |
| 411 | fi |
429 | fi |
| 412 | else |
430 | else |
| 413 | einfo "$my_ouptut is installed there" |
431 | einfo "${my_output} is installed there" |
| 414 | fi |
432 | fi |
| 415 | else |
433 | else |
| 416 | einfo "This is an installation" |
434 | einfo "This is an installation" |
| 417 | fi |
435 | fi |
| 418 | fi |
436 | fi |
| … | |
… | |
| 420 | |
438 | |
| 421 | function webapp_src_preinst () |
439 | function webapp_src_preinst () |
| 422 | { |
440 | { |
| 423 | # create the directories that we need |
441 | # create the directories that we need |
| 424 | |
442 | |
| 425 | dodir ${MY_HTDOCSDIR} |
443 | dodir "${MY_HTDOCSDIR}" |
| 426 | dodir ${MY_HOSTROOTDIR} |
444 | dodir "${MY_HOSTROOTDIR}" |
| 427 | dodir ${MY_CGIBINDIR} |
445 | dodir "${MY_CGIBINDIR}" |
| 428 | dodir ${MY_ICONSDIR} |
446 | dodir "${MY_ICONSDIR}" |
| 429 | dodir ${MY_ERRORSDIR} |
447 | dodir "${MY_ERRORSDIR}" |
| 430 | dodir ${MY_SQLSCRIPTSDIR} |
448 | dodir "${MY_SQLSCRIPTSDIR}" |
|
|
449 | dodir "${MY_HOOKSCRIPTSDIR}" |
|
|
450 | dodir "${MY_SERVERCONFIGDIR}" |
| 431 | } |
451 | } |
| 432 | |
452 | |
| 433 | function webapp_pkg_postinst () |
453 | function webapp_pkg_postinst () |
| 434 | { |
454 | { |
|
|
455 | webapp_read_config |
|
|
456 | |
| 435 | # sanity checks, to catch bugs in the ebuild |
457 | # sanity checks, to catch bugs in the ebuild |
| 436 | |
458 | |
| 437 | if [ ! -f ${MY_APPDIR}/${INSTALL_CHECK_FILE} ]; then |
459 | if [ ! -f "${ROOT}${MY_APPDIR}/${INSTALL_CHECK_FILE}" ]; then |
| 438 | eerror |
460 | eerror |
| 439 | eerror "This ebuild did not call webapp_src_install() at the end" |
461 | eerror "This ebuild did not call webapp_src_install() at the end" |
| 440 | eerror "of the src_install() function" |
462 | eerror "of the src_install() function" |
| 441 | eerror |
463 | eerror |
| 442 | eerror "Please log a bug on http://bugs.gentoo.org" |
464 | eerror "Please log a bug on http://bugs.gentoo.org" |
| … | |
… | |
| 446 | eerror |
468 | eerror |
| 447 | die "Ebuild did not call webapp_src_install() - report to http://bugs.gentoo.org" |
469 | die "Ebuild did not call webapp_src_install() - report to http://bugs.gentoo.org" |
| 448 | fi |
470 | fi |
| 449 | |
471 | |
| 450 | # if 'vhosts' is not set in your USE flags, we install a copy of |
472 | # if 'vhosts' is not set in your USE flags, we install a copy of |
| 451 | # this application in /var/www/localhost/htdocs/${PN}/ for you |
473 | # this application in ${ROOT}/var/www/localhost/htdocs/${PN}/ for you |
| 452 | |
474 | |
| 453 | if ! use vhosts ; then |
475 | if ! use vhosts ; then |
| 454 | echo |
476 | echo |
| 455 | einfo "vhosts USE flag not set - auto-installing using webapp-config" |
477 | einfo "vhosts USE flag not set - auto-installing using webapp-config" |
| 456 | |
478 | |
| 457 | webapp_getinstalltype |
479 | webapp_getinstalltype |
| 458 | |
480 | |
| 459 | G_HOSTNAME="localhost" |
481 | G_HOSTNAME="localhost" |
| 460 | . /etc/vhosts/webapp-config |
|
|
| 461 | |
|
|
| 462 | local my_mode=-I |
482 | local my_mode=-I |
|
|
483 | webapp_read_config |
| 463 | |
484 | |
| 464 | if [ "$IS_REPLACE" = "1" ]; then |
485 | if [ "${IS_REPLACE}" = "1" ]; then |
| 465 | einfo "${PN}-${PVR} is already installed - replacing" |
486 | einfo "${PN}-${PVR} is already installed - replacing" |
| 466 | /usr/sbin/webapp-config -C -d "$INSTALL_DIR" |
487 | my_mode=-I |
| 467 | elif [ "$IS_UPGRADE" = "1" ]; then |
488 | elif [ "${IS_UPGRADE}" = "1" ]; then |
| 468 | einfo "$REMOVE_PKG is already installed - upgrading" |
489 | einfo "${REMOVE_PKG} is already installed - upgrading" |
| 469 | my_mode=-U |
490 | my_mode=-U |
| 470 | else |
491 | else |
| 471 | einfo "${PN}-${PVR} is not installed - using install mode" |
492 | einfo "${PN}-${PVR} is not installed - using install mode" |
| 472 | fi |
493 | fi |
| 473 | |
494 | |
| 474 | my_cmd="/usr/sbin/webapp-config $my_mode -h localhost -u root -d $INSTALL_DIR ${PN} ${PVR}" |
495 | my_cmd="${WEBAPP_CONFIG} ${my_mode} -h localhost -u root -d ${INSTALL_DIR} ${PN} ${PVR}" |
| 475 | einfo "Running $my_cmd" |
496 | einfo "Running ${my_cmd}" |
| 476 | $my_cmd |
497 | ${my_cmd} |
| 477 | |
498 | |
| 478 | # remove the old version |
499 | # remove the old version |
| 479 | # |
500 | # |
| 480 | # why do we do this? well ... |
501 | # why do we do this? well ... |
| 481 | # |
502 | # |
| … | |
… | |
| 484 | # slot to the old version, then the old version gets left behind |
505 | # slot to the old version, then the old version gets left behind |
| 485 | # |
506 | # |
| 486 | # if USE=-vhosts, then we want to remove the old version, because |
507 | # if USE=-vhosts, then we want to remove the old version, because |
| 487 | # the user is relying on portage to do the magical thing for it |
508 | # the user is relying on portage to do the magical thing for it |
| 488 | |
509 | |
| 489 | if [ "$IS_UPGRADE" = "1" ] ; then |
510 | if [ "${IS_UPGRADE}" = "1" ] ; then |
| 490 | einfo "Removing old version $REMOVE_PKG" |
511 | einfo "Removing old version ${REMOVE_PKG}" |
| 491 | |
512 | |
| 492 | emerge -C $CATEGORY/$REMOVE_PKG |
513 | emerge -C "${REMOVE_PKG}" |
| 493 | fi |
514 | fi |
| 494 | else |
515 | else |
| 495 | # vhosts flag is on |
516 | # vhosts flag is on |
| 496 | # |
517 | # |
| 497 | # let's tell the administrator what to do next |
518 | # let's tell the administrator what to do next |
| … | |
… | |
| 499 | einfo |
520 | einfo |
| 500 | einfo "The 'vhosts' USE flag is switched ON" |
521 | einfo "The 'vhosts' USE flag is switched ON" |
| 501 | einfo "This means that Portage will not automatically run webapp-config to" |
522 | einfo "This means that Portage will not automatically run webapp-config to" |
| 502 | einfo "complete the installation." |
523 | einfo "complete the installation." |
| 503 | einfo |
524 | einfo |
| 504 | einfo "To install $PN-$PVR into a virtual host, run the following command:" |
525 | einfo "To install ${PN}-${PVR} into a virtual host, run the following command:" |
| 505 | einfo |
526 | einfo |
| 506 | einfo " webapp-config -I -h <host> -d $PN $PN $PVR" |
527 | einfo " webapp-config -I -h <host> -d ${PN} ${PN} ${PVR}" |
| 507 | einfo |
528 | einfo |
| 508 | einfo "For more details, see the webapp-config(8) man page" |
529 | einfo "For more details, see the webapp-config(8) man page" |
| 509 | fi |
530 | fi |
| 510 | |
531 | |
| 511 | return 0 |
532 | return 0 |
| … | |
… | |
| 516 | # remove any virtual installs that there are |
537 | # remove any virtual installs that there are |
| 517 | |
538 | |
| 518 | local my_output |
539 | local my_output |
| 519 | local x |
540 | local x |
| 520 | |
541 | |
| 521 | my_output="`webapp-config --list-installs $PN $PVR`" |
542 | my_output="$(${WEBAPP_CONFIG} --list-installs ${PN} ${PVR})" |
| 522 | |
543 | |
| 523 | if [ "$?" != "0" ]; then |
544 | if [ "${?}" != "0" ]; then |
| 524 | return |
545 | return |
| 525 | fi |
546 | fi |
| 526 | |
547 | |
| 527 | # the changes to IFS here are necessary to ensure that we can cope |
|
|
| 528 | # with directories that contain spaces in the file names |
|
|
| 529 | |
|
|
| 530 | # OLD_IFS="$IFS" |
|
|
| 531 | # IFS="
" |
|
|
| 532 | |
|
|
| 533 | for x in $my_output ; do |
548 | for x in ${my_output} ; do |
| 534 | # IFS="$OLD_IFS" |
|
|
| 535 | |
|
|
| 536 | [ -f $x/.webapp ] && . $x/.webapp || ewarn "Cannot find file $x/.webapp" |
549 | [ -f ${x}/.webapp ] && . ${x}/.webapp || ewarn "Cannot find file ${x}/.webapp" |
| 537 | |
550 | |
| 538 | if [ -z "WEB_HOSTNAME" -o -z "WEB_INSTALLDIR" ]; then |
551 | if [ -z "${WEB_HOSTNAME}" -o -z "${WEB_INSTALLDIR}" ]; then |
| 539 | ewarn "Don't forget to use webapp-config to remove the copy of" |
552 | ewarn "Don't forget to use webapp-config to remove the copy of" |
| 540 | ewarn "${PN}-${PVR} installed in" |
553 | ewarn "${PN}-${PVR} installed in" |
| 541 | ewarn |
554 | ewarn |
| 542 | ewarn " $x" |
555 | ewarn " ${x}" |
| 543 | ewarn |
556 | ewarn |
| 544 | else |
557 | else |
| 545 | # we have enough information to remove the virtual copy ourself |
558 | # we have enough information to remove the virtual copy ourself |
| 546 | |
559 | |
| 547 | webapp-config -C -h ${WEB_HOSTNAME} -d ${WEB_INSTALLDIR} |
560 | ${WEBAPP_CONFIG} -C -h ${WEB_HOSTNAME} -d ${WEB_INSTALLDIR} |
| 548 | |
561 | |
| 549 | # if the removal fails - we carry on anyway! |
562 | # if the removal fails - we carry on anyway! |
| 550 | fi |
563 | fi |
| 551 | # IFS="
" |
|
|
| 552 | done |
564 | done |
| 553 | |
|
|
| 554 | # IFS="$OLD_IFS" |
|
|
| 555 | } |
565 | } |