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

Diff of /eclass/webapp.eclass

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

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

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

  ViewVC Help
Powered by ViewVC 1.1.20