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

Diff of /eclass/webapp.eclass

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

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

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

  ViewVC Help
Powered by ViewVC 1.1.20