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

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

  ViewVC Help
Powered by ViewVC 1.1.20