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

Diff of /eclass/webapp.eclass

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

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

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

  ViewVC Help
Powered by ViewVC 1.1.20