/[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.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.20 2004/05/22 18:56:58 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.7 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
34INSTALL_CHECK_FILE="installed_by_webapp_eclass" 37INSTALL_CHECK_FILE="installed_by_webapp_eclass"
38SETUP_CHECK_FILE="setup_by_webapp_eclass"
35 39
36# ------------------------------------------------------------------------ 40ETC_CONFIG="${ROOT}etc/vhosts/webapp-config"
37# INTERNAL FUNCTION - USED BY THIS ECLASS ONLY 41WEBAPP_CONFIG="${ROOT}usr/sbin/webapp-config"
38# 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
39# Check whether a specified file exists within the image/ directory 61# 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 () 62webapp_checkfileexists() {
48{ 63 debug-print-function $FUNCNAME $*
49 local my_prefix
50 64
51 [ -n "$2" ] && my_prefix="$2/" || my_prefix= 65 local my_prefix=${2:+${2}/}
52 66
53 if [ ! -e ${my_prefix}$1 ]; then 67 if [[ ! -e "${my_prefix}${1}" ]]; then
54 msg="ebuild fault: file $1 not found" 68 msg="ebuild fault: file '${1}' not found"
55 eerror "$msg" 69 eerror "$msg"
56 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/"
57 die "$msg" 71 die "$msg"
58 fi 72 fi
59} 73}
60 74
61# ------------------------------------------------------------------------
62# INTERNAL FUNCTION - USED BY THIS ECLASS ONLY
63# ------------------------------------------------------------------------
64
65function webapp_check_installedat 75webapp_check_installedat() {
66{ 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
67 local my_output 102 local my_output
103 my_output="$(webapp_check_installedat)"
68 104
69 /usr/sbin/webapp-config --show-installed -h localhost -d $INSTALL_DIR 2> /dev/null 105 if [[ $? -eq 0 ]]; then
70} 106 # something is already installed there
107 # make sure it isn't the same version
71 108
72# ------------------------------------------------------------------------ 109 local my_pn="$(echo ${my_output} | awk '{ print $1 }')"
73# INTERNAL FUNCTION - USED BY THIS ECLASS ONLY 110 local my_pvr="$(echo ${my_output} | awk '{ print $2 }')"
74# ------------------------------------------------------------------------
75 111
76function webapp_import_config () 112 REMOVE_PKG="${my_pn}-${my_pvr}"
77{ 113
78 if [ -z "${MY_HTDOCSDIR}" ]; then 114 if [[ "${my_pn}" == "${PN}" ]]; then
79 . /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"
80 fi 124 fi
81 125 else
82 if [ -z "${MY_HTDOCSDIR}" ]; then 126 elog "This is an installation"
83 libsh_edie "/etc/conf.d/webapp-config not imported"
84 fi 127 fi
85} 128}
86 129
87# ------------------------------------------------------------------------ 130# ==============================================================================
88# INTERNAL FUNCTION - USED BY THIS ECLASS ONLY 131# PUBLIC FUNCTIONS
89# 132# ==============================================================================
90# ------------------------------------------------------------------------
91 133
92function webapp_strip_appdir () 134# @FUNCTION: need_httpd
93{ 135# @DESCRIPTION:
94 local my_stripped="$1" 136# Call this function AFTER your ebuild's DEPEND line if any of the available
95 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 )"
96} 141}
97 142
98function webapp_strip_d () 143# @FUNCTION: need_httpd_cgi
99{ 144# @DESCRIPTION:
100 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 )"
101} 150}
102 151
103function webapp_strip_cwd () 152# @FUNCTION: need_httpd_fastcgi
104{ 153# @DESCRIPTION:
105 local my_stripped="$1" 154# Call this function AFTER your ebuild's DEPEND line if any of the available
106 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"
107} 159}
108 160
109# ------------------------------------------------------------------------ 161# @FUNCTION: webapp_configfile
110# EXPORTED FUNCTION - FOR USE IN EBUILDS 162# @USAGE: <file> [more files ...]
111# 163# @DESCRIPTION:
112# Identify a config file for a web-based application. 164# Mark a file config-protected for a web-based application.
113#
114# @param $1 - config file
115# ------------------------------------------------------------------------
116
117function webapp_configfile () 165webapp_configfile() {
118{ 166 debug-print-function $FUNCNAME $*
167
168 local m
169 for m in "$@"; do
119 webapp_checkfileexists "$1" "$D" 170 webapp_checkfileexists "${m}" "${D}"
120 echo $1
121 local MY_FILE="`webapp_strip_appdir $1`"
122 echo $MY_FILE
123 171
124 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}"
125 echo "$MY_FILE" >> ${D}${WA_CONFIGLIST} 176 echo "${my_file}" >> ${D}/${WA_CONFIGLIST}
177 done
126} 178}
127 179
128# ------------------------------------------------------------------------ 180# @FUNCTION: webapp_hook_script
129# EXPORTED FUNCTION - FOR USE IN EBUILDS 181# @USAGE: <file>
130# 182# @DESCRIPTION:
131# 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
132# before a virtual copy has been removed 184# before a virtual copy has been removed.
133#
134# @param $1 - the script to run
135# ------------------------------------------------------------------------
136
137function webapp_hook_script () 185webapp_hook_script() {
138{ 186 debug-print-function $FUNCNAME $*
187
139 webapp_checkfileexists "$2" 188 webapp_checkfileexists "${1}"
140 189
141 einfo "(hook) $1" 190 elog "(hook) ${1}"
142 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}/"
143 chmod 555 "${D}${MY_HOOKSCRIPTSDIR}/`basename $1`" 192 chmod 555 "${D}/${MY_HOOKSCRIPTSDIR}/$(basename "${1}")"
144} 193}
145 194
146# ------------------------------------------------------------------------ 195# @FUNCTION: webapp_postinst_txt
147# EXPORTED FUNCTION - FOR USE IN EBUILDS 196# @USAGE: <lang> <file>
148# 197# @DESCRIPTION:
149# Install a text file containing post-installation instructions. 198# Install a text file containing post-installation instructions.
150# 199webapp_postinst_txt() {
151# @param $1 - language code (use 'en' for now) 200 debug-print-function $FUNCNAME $*
152# @param $2 - the file to install
153# ------------------------------------------------------------------------
154 201
155function webapp_postinst_txt
156{
157 webapp_checkfileexists "$2" 202 webapp_checkfileexists "${2}"
158 203
159 einfo "(rtfm) $2 (lang: $1)" 204 elog "(info) ${2} (lang: ${1})"
160 cp "$2" "${D}${MY_APPDIR}/postinst-$1.txt" 205 cp "${2}" "${D}/${MY_APPDIR}/postinst-${1}.txt"
161} 206}
162 207
163# ------------------------------------------------------------------------ 208# @FUNCTION: webapp_postupgrade_txt
164# EXPORTED FUNCTION - FOR USE IN EBUILDS 209# @USAGE: <lang> <file>
165# 210# @DESCRIPTION:
166# Identify a script file (usually, but not always PHP or Perl) which is 211# Install a text file containing post-upgrade instructions.
167# 212webapp_postupgrade_txt() {
168# Files in this list may be modified to #! the required CGI engine when 213 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 214
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" 215 webapp_checkfileexists "${2}"
225 216
226 # 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}
227 220
228 local my_file 221# helper for webapp_serverowned()
222_webapp_serverowned() {
223 debug-print-function $FUNCNAME $*
229 224
230 if [ -z "$3" ]; then 225 webapp_checkfileexists "${1}" "${D}"
231 $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
232 else 251 else
233 $my_file="$1-$3" 252 for m in "$@"; do
253 _webapp_serverowned "${m}"
254 done
234 fi 255 fi
256}
235 257
236 # 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:
237 # 271 #
238 # do NOT change the naming convention used here without changing all 272 # do NOT change the naming convention used here without changing all
239 # the other scripts that also rely upon these names 273 # the other scripts that also rely upon these names
240 274
275 local my_file="${1}-${3:-$(basename "${2}")}"
276
241 einfo "($1) config file '$my_file'" 277 elog "(${1}) config file '${my_file}'"
242 cp "$2" "${D}${MY_SERVERCONFIGDIR}/${my_file}" 278 cp "${2}" "${D}/${MY_SERVERCONFIGDIR}/${my_file}"
243} 279}
244 280
245# ------------------------------------------------------------------------ 281# @FUNCTION: webapp_sqlscript
246# EXPORTED FUNCTION - FOR USE IN EBUILDS 282# @USAGE: <db> <file> [version]
247# 283# @DESCRIPTION:
248# @param $1 - the db engine that the script is for 284# Install a SQL script that creates/upgrades a database schema for the web
249# (one of: mysql|postgres) 285# application. Currently supported database engines are mysql and postgres.
250# @param $2 - the sql script to be installed 286# 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 287# 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 () 288webapp_sqlscript() {
258{ 289 debug-print-function $FUNCNAME $*
290
259 webapp_checkfileexists "$2" 291 webapp_checkfileexists "${2}"
260 292
261 # create the directory where this script will go 293 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 294
266 if [ ! -d "${D}${MY_SQLSCRIPTSDIR}/$1" ]; then 295 # WARNING:
267 mkdir -p "${D}${MY_SQLSCRIPTSDIR}/$1" || libsh_die "unable to create directory ${D}${MY_SQLSCRIPTSDIR}/$1"
268 fi
269
270 # warning:
271 # 296 #
272 # do NOT change the naming convention used here without changing all 297 # do NOT change the naming convention used here without changing all
273 # the other scripts that also rely upon these names 298 # the other scripts that also rely upon these names
274 299
275 # are we dealing with an 'upgrade'-type script?
276 if [ -n "$3" ]; then 300 if [[ -n "${3}" ]]; then
277 # yes we are
278 einfo "($1) upgrade script from ${PN}-${PVR} to $3" 301 elog "(${1}) upgrade script for ${PN}-${3} to ${PVR}"
279 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"
280 else 304 else
281 # no, we are not
282 einfo "($1) create script for ${PN}-${PVR}" 305 elog "(${1}) create script for ${PN}-${PVR}"
283 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"
284 fi 308 fi
285} 309}
286 310
287# ------------------------------------------------------------------------ 311# @FUNCTION: webapp_src_preinst
288# EXPORTED FUNCTION - call from inside your ebuild's src_install AFTER 312# @DESCRIPTION:
289# 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.
290# 337#
291# 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
292# are no setuid files. I'm sure this will change significantly before 339# pkg_setup().
293# the final version! 340webapp_pkg_setup() {
294# ------------------------------------------------------------------------ 341 debug-print-function $FUNCNAME $*
295 342
343 # to test whether or not the ebuild has correctly called this function
344 # we add an empty file to the filesystem
345 #
346 # we used to just set a variable in the shell script, but we can
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}"
350
351 # special case - some ebuilds *do* need to overwride the SLOT
352 if [[ "${SLOT}+" != "${PVR}+" && "${WEBAPP_MANUAL_SLOT}" != "yes" ]]; then
353 die "Set WEBAPP_MANUAL_SLOT=\"yes\" if you need to SLOT manually"
354 fi
355
356 # pull in the shared configuration file
357 G_HOSTNAME="localhost"
358 webapp_read_config
359
360 local my_dir="${ROOT}${VHOST_ROOT}/${MY_HTDOCSBASE}/${PN}"
361
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.
399#
400# You need to call this function AFTER everything else has run in your custom
401# src_install().
296function webapp_src_install () 402webapp_src_install() {
297{ 403 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 404
306 # to test whether or not the ebuild has correctly called this function 405 # to test whether or not the ebuild has correctly called this function
307 # we add an empty file to the filesystem 406 # we add an empty file to the filesystem
308 # 407 #
309 # we used to just set a variable in the shell script, but we can 408 # 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 409 # no longer rely on Portage calling both webapp_src_install() and
311 # webapp_pkg_postinst() within the same shell process 410 # webapp_pkg_postinst() within the same shell process
312
313 touch ${D}/${MY_APPDIR}/${INSTALL_CHECK_FILE} 411 touch "${D}/${MY_APPDIR}/${INSTALL_CHECK_FILE}"
314}
315 412
316# ------------------------------------------------------------------------ 413 # sanity checks, to catch bugs in the ebuild
317# EXPORTED FUNCTION - call from inside your ebuild's pkg_config AFTER 414 if [[ ! -f "${T}/${SETUP_CHECK_FILE}" ]]; then
318# everything else has run 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.
319# 441#
320# If 'vhosts' USE flag is not set, auto-install this app 442# You need to call this function AFTER everything else has run in your custom
321# 443# pkg_postinst().
322# ------------------------------------------------------------------------ 444webapp_pkg_postinst() {
445 debug-print-function $FUNCNAME $*
323 446
324function webapp_pkg_setup () 447 webapp_read_config
325{
326 # add sanity checks here
327 448
328 if [ "$SLOT+" != "${PVR}+" ]; then 449 # sanity checks, to catch bugs in the ebuild
329 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"
330 fi 461 fi
331 462
332 # 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"
333 467
334 G_HOSTNAME="localhost" 468 G_HOSTNAME="localhost"
335 . /etc/vhosts/webapp-config || die "Unable to open /etc/vhosts/webapp-config file" 469 webapp_read_config
336 470
337 # are we installing a webapp-config solution over the top of a 471 local my_mode=-I
338 # non-webapp-config solution? 472 webapp_getinstalltype
339 473
340 if ! use vhosts ; then 474 if [[ "${IS_REPLACE}" == "1" ]]; then
341 local my_dir="$VHOST_ROOT/$MY_HTDOCSBASE/$PN" 475 elog "${PN}-${PVR} is already installed - replacing"
342 local my_output 476 my_mode=-I
343 477 elif [[ "${IS_UPGRADE}" == "1" ]]; then
344 if [ -d "$my_dir" ] ; then 478 elog "${REMOVE_PKG} is already installed - upgrading"
345 einfo "You already have something installed in $my_dir" 479 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 480 else
364 einfo 481 elog "${PN}-${PVR} is not installed - using install mode"
365 einfo "I can upgrade the contents of $my_dir"
366 einfo
367 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"
368 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"
369 fi 515 fi
370} 516}
371 517
372function webapp_someunusedfunction () 518# @FUNCTION: webapp_pkg_prerm
373{ 519# @DESCRIPTION:
374 # 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 $*
375 525
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 526 local my_output=
527 my_output="$(${WEBAPP_CONFIG} --list-installs ${PN} ${PVR})"
528 [[ $? -ne 0 ]] && return
391 529
392 my_output="`webapp_check_installedat`" 530 local x
393 531 if has vhosts ${IUSE} && ! use vhosts; then
394 if [ "$?" = "0" ] ; then 532 echo "${my_output}" | while read x; do
395 # something is already installed there 533 if [[ -f "${x}"/.webapp ]]; then
396 # 534 . "${x}"/.webapp
397 # make sure it isn't the same version 535 if [[ -n "${WEB_HOSTNAME}" && -n "${WEB_INSTALLDIR}" ]]; then
398 536 ${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 537 fi
412 else 538 else
413 einfo "$my_ouptut is installed there" 539 ewarn "Cannot find file ${x}/.webapp"
414 fi 540 fi
415 else 541 done
416 einfo "This is an installation" 542 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 543 echo
455 einfo "vhosts USE flag not set - auto-installing using webapp-config" 544 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" 545 ewarn "Don't forget to use webapp-config to remove any copies of"
540 ewarn "${PN}-${PVR} installed in" 546 ewarn "${PN}-${PVR} installed in"
541 ewarn 547 ewarn
548
549 echo "${my_output}" | while read x; do
550 if [[ -f "${x}"/.webapp ]]; then
542 ewarn " $x" 551 ewarn " ${x}"
552 else
553 ewarn "Cannot find file ${x}/.webapp"
554 fi
555 done
556
543 ewarn 557 ewarn
544 else 558 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 559 fi
551 # IFS=" "
552 done
553
554 # IFS="$OLD_IFS"
555} 560}

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

  ViewVC Help
Powered by ViewVC 1.1.20