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

Diff of /eclass/webapp.eclass

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

Revision 1.36 Revision 1.70
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.36 2005/08/23 14:55:11 swegener Exp $ 3# $Header: /var/cvsroot/gentoo-x86/eclass/webapp.eclass,v 1.70 2011/12/27 17:55:12 fauli 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="vhosts" 33 DEPEND="${WEBAPP_DEPEND}"
24DEPEND="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 if [ "$WEBAPP_MANUAL_SLOT" != "yes" ]; then
343 die "ebuild sets SLOT, overrides webapp.eclass"
344 fi 326 fi
345 fi 327}
346 328
347 # pull in the shared configuration file 329# @FUNCTION: webapp_src_preinst
330# @DESCRIPTION:
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 $*
348 335
349 G_HOSTNAME="localhost" 336 # sanity checks, to catch bugs in the ebuild
350 . "${ETC_CONFIG}" || die "Unable to open file ${ETC_CONFIG}" 337 if [[ ! -f "${T}/${SETUP_CHECK_FILE}" ]]; then
351 338 eerror
352 # are we installing a webapp-config solution over the top of a 339 eerror "This ebuild did not call webapp_pkg_setup() at the beginning"
353 # non-webapp-config solution? 340 eerror "of the pkg_setup() function"
354 341 eerror
355 if ! use vhosts ; then 342 eerror "Please log a bug on http://bugs.gentoo.org"
356 local my_dir="$VHOST_ROOT/$MY_HTDOCSBASE/$PN" 343 eerror
357 local my_output 344 eerror "You should use emerge -C to remove this package, as the"
358 345 eerror "installation is incomplete"
359 if [ -d "$my_dir" ] ; then 346 eerror
360 einfo "You already have something installed in $my_dir" 347 die "Ebuild did not call webapp_pkg_setup() - report to http://bugs.gentoo.org"
361 einfo "Are you trying to install over the top of something I cannot upgrade?"
362
363 my_output="`webapp_check_installedat`"
364
365 if [ "$?" != "0" ]; then
366
367 # okay, whatever is there, it isn't webapp-config-compatible
368 ewarn
369 ewarn "Whatever is in $my_dir, it's not"
370 ewarn "compatible with webapp-config."
371 ewarn
372 ewarn "This ebuild may be overwriting important files."
373 ewarn
374 elif [ "`echo $my_output | awk '{ print $1 }'`" != "$PN" ]; then
375 eerror "$my_dir contains $my_output"
376 eerror "I cannot upgrade that"
377 die "Cannot upgrade contents of $my_dir"
378 else
379 einfo
380 einfo "I can upgrade the contents of $my_dir"
381 einfo
382 fi
383 fi 348 fi
384 fi
385}
386 349
387function webapp_someunusedfunction () 350 # Hint, see the webapp_read_config() function to find where these are
388{ 351 # defined.
389 # are we emerging something that is already installed?
390
391 if [ -d "${D}${MY_APPROOT}/${MY_APPSUFFIX}" ]; then
392 # yes we are
393 ewarn "Removing existing copy of ${PN}-${PVR}"
394 rm -rf "${D}${MY_APPROOT}/${MY_APPSUFFIX}"
395 fi
396}
397
398function webapp_getinstalltype ()
399{
400 # or are we upgrading?
401
402 if ! use vhosts ; then
403 # we only run webapp-config if vhosts USE flag is not set
404
405 local my_output
406
407 my_output="`webapp_check_installedat`"
408
409 if [ "$?" = "0" ] ; then
410 # something is already installed there
411 #
412 # make sure it isn't the same version
413
414 local my_pn="`echo $my_output | awk '{ print $1 }'`"
415 local my_pvr="`echo $my_output | awk '{ print $2 }'`"
416
417 REMOVE_PKG="${my_pn}-${my_pvr}"
418
419 if [ "$my_pn" == "$PN" ]; then
420 if [ "$my_pvr" != "$PVR" ]; then
421 einfo "This is an upgrade"
422 IS_UPGRADE=1
423 else
424 einfo "This is a re-installation"
425 IS_REPLACE=1
426 fi
427 else
428 einfo "$my_ouptut is installed there"
429 fi
430 else
431 einfo "This is an installation"
432 fi
433 fi
434}
435
436function webapp_src_preinst ()
437{
438 # create the directories that we need
439
440 dodir "${MY_HTDOCSDIR}" 352 dodir "${MY_HTDOCSDIR}"
441 dodir "${MY_HOSTROOTDIR}" 353 dodir "${MY_HOSTROOTDIR}"
442 dodir "${MY_CGIBINDIR}" 354 dodir "${MY_CGIBINDIR}"
443 dodir "${MY_ICONSDIR}" 355 dodir "${MY_ICONSDIR}"
444 dodir "${MY_ERRORSDIR}" 356 dodir "${MY_ERRORSDIR}"
445 dodir "${MY_SQLSCRIPTSDIR}" 357 dodir "${MY_SQLSCRIPTSDIR}"
446 dodir "${MY_HOOKSCRIPTSDIR}" 358 dodir "${MY_HOOKSCRIPTSDIR}"
447 dodir "${MY_SERVERCONFIGDIR}" 359 dodir "${MY_SERVERCONFIGDIR}"
448} 360}
449 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 ebeep 10
417 elif [[ "$(echo ${my_output} | awk '{ print $1 }')" != "${PN}" ]]; then
418 echo
419 eerror "You already have ${my_output} installed in ${my_dir}"
420 eerror
421 eerror "I cannot upgrade a different application"
422 eerror
423 echo
424 die "Cannot upgrade contents of ${my_dir}"
425 fi
426
427}
428
429# @FUNCTION: webapp_src_install
430# @DESCRIPTION:
431# This is the default src_install(). For now, we just make sure that root owns
432# everything, and that there are no setuid files.
433#
434# You need to call this function AFTER everything else has run in your custom
435# src_install().
436webapp_src_install() {
437 debug-print-function $FUNCNAME $*
438
439 # to test whether or not the ebuild has correctly called this function
440 # we add an empty file to the filesystem
441 #
442 # we used to just set a variable in the shell script, but we can
443 # no longer rely on Portage calling both webapp_src_install() and
444 # webapp_pkg_postinst() within the same shell process
445 touch "${D}/${MY_APPDIR}/${INSTALL_CHECK_FILE}"
446
447 chown -R "${VHOST_DEFAULT_UID}:${VHOST_DEFAULT_GID}" "${D}/"
448 chmod -R u-s "${D}/"
449 chmod -R g-s "${D}/"
450
451 keepdir "${MY_PERSISTDIR}"
452 fowners "root:0" "${MY_PERSISTDIR}"
453 fperms 755 "${MY_PERSISTDIR}"
454}
455
456# @FUNCTION: webapp_pkg_postinst
457# @DESCRIPTION:
458# The default pkg_postinst() for this eclass. This installs the web application to
459# `${ROOT}/var/www/localhost/htdocs/${PN}/' if USE=vhosts is not set. Otherwise
460# display a short notice how to install this application with webapp-config.
461#
462# You need to call this function AFTER everything else has run in your custom
463# pkg_postinst().
450function webapp_pkg_postinst () 464webapp_pkg_postinst() {
451{ 465 debug-print-function $FUNCNAME $*
452 . "${ETC_CONFIG}" 466
467 webapp_read_config
453 468
454 # sanity checks, to catch bugs in the ebuild 469 # sanity checks, to catch bugs in the ebuild
455
456 if [ ! -f "${MY_APPDIR}/${INSTALL_CHECK_FILE}" ]; then 470 if [[ ! -f "${ROOT}${MY_APPDIR}/${INSTALL_CHECK_FILE}" ]]; then
457 eerror 471 eerror
458 eerror "This ebuild did not call webapp_src_install() at the end" 472 eerror "This ebuild did not call webapp_src_install() at the end"
459 eerror "of the src_install() function" 473 eerror "of the src_install() function"
460 eerror 474 eerror
461 eerror "Please log a bug on http://bugs.gentoo.org" 475 eerror "Please log a bug on http://bugs.gentoo.org"
… …
464 eerror "installation is incomplete" 478 eerror "installation is incomplete"
465 eerror 479 eerror
466 die "Ebuild did not call webapp_src_install() - report to http://bugs.gentoo.org" 480 die "Ebuild did not call webapp_src_install() - report to http://bugs.gentoo.org"
467 fi 481 fi
468 482
469 # if 'vhosts' is not set in your USE flags, we install a copy of 483 if has vhosts ${IUSE}; then
470 # this application in /var/www/localhost/htdocs/${PN}/ for you
471
472 if ! use vhosts ; then 484 if ! use vhosts; then
473 echo 485 echo
474 einfo "vhosts USE flag not set - auto-installing using webapp-config" 486 elog "vhosts USE flag not set - auto-installing using webapp-config"
475 487
476 webapp_getinstalltype
477
478 G_HOSTNAME="localhost" 488 G_HOSTNAME="localhost"
479 . "${ETC_CONFIG}" 489 webapp_read_config
480 490
481 local my_mode=-I 491 local my_mode=-I
492 webapp_getinstalltype
482 493
483 if [ "$IS_REPLACE" = "1" ]; then 494 if [[ "${IS_REPLACE}" == "1" ]]; then
484 einfo "${PN}-${PVR} is already installed - replacing" 495 elog "${PN}-${PVR} is already installed - replacing"
485 my_mode=-I 496 my_mode=-I
486 elif [ "$IS_UPGRADE" = "1" ]; then 497 elif [[ "${IS_UPGRADE}" == "1" ]]; then
487 einfo "$REMOVE_PKG is already installed - upgrading" 498 elog "${REMOVE_PKG} is already installed - upgrading"
488 my_mode=-U 499 my_mode=-U
500 else
501 elog "${PN}-${PVR} is not installed - using install mode"
502 fi
503
504 my_cmd="${WEBAPP_CONFIG} ${my_mode} -h localhost -u root -d ${INSTALL_DIR} ${PN} ${PVR}"
505 elog "Running ${my_cmd}"
506 ${my_cmd}
507
508 echo
509 local cleaner="${WEBAPP_CLEANER} -p -C /${PN}"
510 einfo "Running ${cleaner}"
511 ${cleaner}
489 else 512 else
490 einfo "${PN}-${PVR} is not installed - using install mode" 513 elog
491 fi 514 elog "The 'vhosts' USE flag is switched ON"
492 515 elog "This means that Portage will not automatically run webapp-config to"
493 my_cmd="/usr/sbin/webapp-config $my_mode -h localhost -u root -d $INSTALL_DIR ${PN} ${PVR}" 516 elog "complete the installation."
494 einfo "Running $my_cmd" 517 elog
495 $my_cmd 518 elog "To install ${PN}-${PVR} into a virtual host, run the following command:"
496 519 elog
497 # remove the old version 520 elog " webapp-config -I -h <host> -d ${PN} ${PN} ${PVR}"
498 # 521 elog
499 # why do we do this? well ... 522 elog "For more details, see the webapp-config(8) man page"
500 #
501 # normally, emerge -u installs a new version and then removes the
502 # old version. however, if the new version goes into a different
503 # slot to the old version, then the old version gets left behind
504 #
505 # if USE=-vhosts, then we want to remove the old version, because
506 # the user is relying on portage to do the magical thing for it
507
508 if [ "$IS_UPGRADE" = "1" ] ; then
509 einfo "Removing old version $REMOVE_PKG"
510
511 emerge -C "$REMOVE_PKG"
512 fi 523 fi
513 else 524 else
514 # vhosts flag is on 525 elog
515 # 526 elog "This ebuild does not support the 'vhosts' USE flag."
516 # let's tell the administrator what to do next
517
518 einfo
519 einfo "The 'vhosts' USE flag is switched ON"
520 einfo "This means that Portage will not automatically run webapp-config to" 527 elog "This means that Portage will not automatically run webapp-config to"
521 einfo "complete the installation." 528 elog "complete the installation."
522 einfo 529 elog
523 einfo "To install $PN-$PVR into a virtual host, run the following command:" 530 elog "To install ${PN}-${PVR} into a virtual host, run the following command:"
524 einfo 531 elog
525 einfo " webapp-config -I -h <host> -d $PN $PN $PVR" 532 elog " webapp-config -I -h <host> -d ${PN} ${PN} ${PVR}"
526 einfo 533 elog
527 einfo "For more details, see the webapp-config(8) man page" 534 elog "For more details, see the webapp-config(8) man page"
528 fi 535 fi
529
530 return 0
531} 536}
532 537
538# @FUNCTION: webapp_pkg_prerm
539# @DESCRIPTION:
540# This is the default pkg_prerm() for this eclass. If USE=vhosts is not set
541# remove all installed copies of this web application. Otherwise instruct the
542# user to manually remove those copies. See bug #136959.
533function webapp_pkg_prerm () 543webapp_pkg_prerm() {
534{ 544 debug-print-function $FUNCNAME $*
535 # remove any virtual installs that there are
536 545
537 local my_output 546 local my_output=
547 my_output="$(${WEBAPP_CONFIG} --list-installs ${PN} ${PVR})"
548 [[ $? -ne 0 ]] && return
549
538 local x 550 local x
539 551 if has vhosts ${IUSE} && ! use vhosts; then
540 my_output="`webapp-config --list-installs $PN $PVR`" 552 echo "${my_output}" | while read x; do
541 553 if [[ -f "${x}"/.webapp ]]; then
542 if [ "$?" != "0" ]; then 554 . "${x}"/.webapp
543 return
544 fi
545
546 # the changes to IFS here are necessary to ensure that we can cope
547 # with directories that contain spaces in the file names
548
549 # OLD_IFS="$IFS"
550 # IFS=" "
551
552 for x in $my_output ; do
553 # IFS="$OLD_IFS"
554
555 [ -f $x/.webapp ] && . $x/.webapp || ewarn "Cannot find file $x/.webapp"
556
557 if [ -z "WEB_HOSTNAME" -o -z "WEB_INSTALLDIR" ]; then 555 if [[ -n "${WEB_HOSTNAME}" && -n "${WEB_INSTALLDIR}" ]]; then
556 ${WEBAPP_CONFIG} -C -h ${WEB_HOSTNAME} -d ${WEB_INSTALLDIR} ${PN} ${PVR}
557 fi
558 else
559 ewarn "Cannot find file ${x}/.webapp"
560 fi
561 done
562 elif [[ "${my_output}" != "" ]]; then
563 echo
564 ewarn
558 ewarn "Don't forget to use webapp-config to remove the copy of" 565 ewarn "Don't forget to use webapp-config to remove any copies of"
559 ewarn "${PN}-${PVR} installed in" 566 ewarn "${PN}-${PVR} installed in"
560 ewarn 567 ewarn
568
569 echo "${my_output}" | while read x; do
570 if [[ -f "${x}"/.webapp ]]; then
561 ewarn " $x" 571 ewarn " ${x}"
572 else
573 ewarn "Cannot find file ${x}/.webapp"
574 fi
575 done
576
562 ewarn 577 ewarn
563 else 578 echo
564 # we have enough information to remove the virtual copy ourself
565
566 webapp-config -C -h ${WEB_HOSTNAME} -d ${WEB_INSTALLDIR}
567
568 # if the removal fails - we carry on anyway!
569 fi 579 fi
570 # IFS=" "
571 done
572
573 # IFS="$OLD_IFS"
574} 580}
Legend:
Removed from v.1.36  
changed lines
  Added in v.1.70
  ViewVC Help
Powered by ViewVC 1.1.20