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

Diff of /eclass/webapp.eclass

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

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

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

  ViewVC Help
Powered by ViewVC 1.1.20