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

Diff of /eclass/webapp.eclass

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

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

Legend:
Removed from v.1.18  
changed lines
  Added in v.1.65

  ViewVC Help
Powered by ViewVC 1.1.20