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

Diff of /eclass/webapp.eclass

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

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

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

  ViewVC Help
Powered by ViewVC 1.1.20