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

Diff of /eclass/webapp.eclass

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

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

Legend:
Removed from v.1.47  
changed lines
  Added in v.1.53

  ViewVC Help
Powered by ViewVC 1.1.20