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

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

  ViewVC Help
Powered by ViewVC 1.1.20