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

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

  ViewVC Help
Powered by ViewVC 1.1.20