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

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

  ViewVC Help
Powered by ViewVC 1.1.20