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

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

  ViewVC Help
Powered by ViewVC 1.1.20