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

Diff of /eclass/webapp.eclass

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

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

Legend:
Removed from v.1.18  
changed lines
  Added in v.1.61

  ViewVC Help
Powered by ViewVC 1.1.20