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

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

  ViewVC Help
Powered by ViewVC 1.1.20