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

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

  ViewVC Help
Powered by ViewVC 1.1.20