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

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

  ViewVC Help
Powered by ViewVC 1.1.20