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

Diff of /eclass/webapp.eclass

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

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

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

  ViewVC Help
Powered by ViewVC 1.1.20