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

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

  ViewVC Help
Powered by ViewVC 1.1.20