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

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

  ViewVC Help
Powered by ViewVC 1.1.20