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

Diff of /eclass/webapp.eclass

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

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

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

  ViewVC Help
Powered by ViewVC 1.1.20