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

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

  ViewVC Help
Powered by ViewVC 1.1.20