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

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

  ViewVC Help
Powered by ViewVC 1.1.20