/[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.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.21 2004/05/25 10:22:02 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
36ETC_CONFIG="/etc/vhosts/webapp-config" 27ETC_CONFIG="${ROOT}etc/vhosts/webapp-config"
28WEBAPP_CONFIG="${ROOT}usr/sbin/webapp-config"
29WEBAPP_CLEANER="${ROOT}usr/sbin/webapp-cleaner"
37 30
38# ------------------------------------------------------------------------ 31# ==============================================================================
39# INTERNAL FUNCTION - USED BY THIS ECLASS ONLY 32# INTERNAL FUNCTIONS
40# 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
41# Check whether a specified file exists within the image/ directory 48# 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 () 49webapp_checkfileexists() {
50{ 50 debug-print-function $FUNCNAME $*
51 local my_prefix
52 51
53 [ -n "$2" ] && my_prefix="$2/" || my_prefix= 52 local my_prefix=${2:+${2}/}
54 53
55 if [ ! -e ${my_prefix}$1 ]; then 54 if [[ ! -e "${my_prefix}${1}" ]]; then
56 msg="ebuild fault: file $1 not found" 55 msg="ebuild fault: file '${1}' not found"
57 eerror "$msg" 56 eerror "$msg"
58 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/"
59 die "$msg" 58 die "$msg"
60 fi 59 fi
61} 60}
62 61
63# ------------------------------------------------------------------------
64# INTERNAL FUNCTION - USED BY THIS ECLASS ONLY
65# ------------------------------------------------------------------------
66
67function webapp_check_installedat 62webapp_check_installedat() {
68{ 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
69 local my_output 86 local my_output
87 my_output="$(webapp_check_installedat)"
70 88
71 /usr/sbin/webapp-config --show-installed -h localhost -d $INSTALL_DIR 2> /dev/null 89 if [[ $? -eq 0 ]]; then
72} 90 # something is already installed there
91 # make sure it isn't the same version
73 92
74# ------------------------------------------------------------------------ 93 local my_pn="$(echo ${my_output} | awk '{ print $1 }')"
75# INTERNAL FUNCTION - USED BY THIS ECLASS ONLY 94 local my_pvr="$(echo ${my_output} | awk '{ print $2 }')"
76# ------------------------------------------------------------------------
77 95
78function webapp_import_config () 96 REMOVE_PKG="${my_pn}-${my_pvr}"
79{ 97
80 if [ -z "${MY_HTDOCSDIR}" ]; then 98 if [[ "${my_pn}" == "${PN}" ]]; then
81 . /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"
82 fi 108 fi
83 109 else
84 if [ -z "${MY_HTDOCSDIR}" ]; then 110 elog "This is an installation"
85 libsh_edie "/etc/conf.d/webapp-config not imported"
86 fi 111 fi
87} 112}
88 113
89# ------------------------------------------------------------------------ 114# ==============================================================================
90# INTERNAL FUNCTION - USED BY THIS ECLASS ONLY 115# PUBLIC FUNCTIONS
91# 116# ==============================================================================
92# ------------------------------------------------------------------------
93 117
94function webapp_strip_appdir () 118# @FUNCTION: need_httpd
95{ 119# @DESCRIPTION:
96 local my_stripped="$1" 120# Call this function AFTER your ebuild's DEPEND line if any of the available
97 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 )"
98} 125}
99 126
100function webapp_strip_d () 127# @FUNCTION: need_httpd_cgi
101{ 128# @DESCRIPTION:
102 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 )"
103} 134}
104 135
105function webapp_strip_cwd () 136# @FUNCTION: need_httpd_fastcgi
106{ 137# @DESCRIPTION:
107 local my_stripped="$1" 138# Call this function AFTER your ebuild's DEPEND line if any of the available
108 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"
109} 143}
110 144
111# ------------------------------------------------------------------------ 145# @FUNCTION: webapp_configfile
112# EXPORTED FUNCTION - FOR USE IN EBUILDS 146# @USAGE: <file> [more files ...]
113# 147# @DESCRIPTION:
114# Identify a config file for a web-based application. 148# Mark a file config-protected for a web-based application.
115#
116# @param $1 - config file
117# ------------------------------------------------------------------------
118
119function webapp_configfile () 149webapp_configfile() {
120{ 150 debug-print-function $FUNCNAME $*
151
152 local m
153 for m in "$@"; do
121 webapp_checkfileexists "$1" "$D" 154 webapp_checkfileexists "${m}" "${D}"
122 echo $1
123 local MY_FILE="`webapp_strip_appdir $1`"
124 echo $MY_FILE
125 155
126 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}"
127 echo "$MY_FILE" >> ${D}${WA_CONFIGLIST} 160 echo "${my_file}" >> ${D}/${WA_CONFIGLIST}
161 done
128} 162}
129 163
130# ------------------------------------------------------------------------ 164# @FUNCTION: webapp_hook_script
131# EXPORTED FUNCTION - FOR USE IN EBUILDS 165# @USAGE: <file>
132# 166# @DESCRIPTION:
133# 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
134# before a virtual copy has been removed 168# before a virtual copy has been removed.
135#
136# @param $1 - the script to run
137# ------------------------------------------------------------------------
138
139function webapp_hook_script () 169webapp_hook_script() {
140{ 170 debug-print-function $FUNCNAME $*
171
141 webapp_checkfileexists "$2" 172 webapp_checkfileexists "${1}"
142 173
143 einfo "(hook) $1" 174 elog "(hook) ${1}"
144 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}/"
145 chmod 555 "${D}${MY_HOOKSCRIPTSDIR}/`basename $1`" 176 chmod 555 "${D}/${MY_HOOKSCRIPTSDIR}/$(basename "${1}")"
146} 177}
147 178
148# ------------------------------------------------------------------------ 179# @FUNCTION: webapp_postinst_txt
149# EXPORTED FUNCTION - FOR USE IN EBUILDS 180# @USAGE: <lang> <file>
150# 181# @DESCRIPTION:
151# Install a text file containing post-installation instructions. 182# Install a text file containing post-installation instructions.
152# 183webapp_postinst_txt() {
153# @param $1 - language code (use 'en' for now) 184 debug-print-function $FUNCNAME $*
154# @param $2 - the file to install
155# ------------------------------------------------------------------------
156 185
157function webapp_postinst_txt
158{
159 webapp_checkfileexists "$2" 186 webapp_checkfileexists "${2}"
160 187
161 einfo "(rtfm) $2 (lang: $1)" 188 elog "(info) ${2} (lang: ${1})"
162 cp "$2" "${D}${MY_APPDIR}/postinst-$1.txt" 189 cp "${2}" "${D}/${MY_APPDIR}/postinst-${1}.txt"
163} 190}
164 191
165# ------------------------------------------------------------------------ 192# @FUNCTION: webapp_postupgrade_txt
166# EXPORTED FUNCTION - FOR USE IN EBUILDS 193# @USAGE: <lang> <file>
167# 194# @DESCRIPTION:
168# Identify a script file (usually, but not always PHP or Perl) which is 195# Install a text file containing post-upgrade instructions.
169# 196webapp_postupgrade_txt() {
170# Files in this list may be modified to #! the required CGI engine when 197 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 198
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" 199 webapp_checkfileexists "${2}"
227 200
228 # 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}
229 204
230 local my_file 205# helper for webapp_serverowned()
206_webapp_serverowned() {
207 debug-print-function $FUNCNAME $*
231 208
232 if [ -z "$3" ]; then 209 webapp_checkfileexists "${1}" "${D}"
233 $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
234 else 235 else
235 $my_file="$1-$3" 236 for m in "$@"; do
237 _webapp_serverowned "${m}"
238 done
236 fi 239 fi
240}
237 241
238 # 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:
239 # 255 #
240 # do NOT change the naming convention used here without changing all 256 # do NOT change the naming convention used here without changing all
241 # the other scripts that also rely upon these names 257 # the other scripts that also rely upon these names
242 258
259 local my_file="${1}-${3:-$(basename "${2}")}"
260
243 einfo "($1) config file '$my_file'" 261 elog "(${1}) config file '${my_file}'"
244 cp "$2" "${D}${MY_SERVERCONFIGDIR}/${my_file}" 262 cp "${2}" "${D}/${MY_SERVERCONFIGDIR}/${my_file}"
245} 263}
246 264
247# ------------------------------------------------------------------------ 265# @FUNCTION: webapp_sqlscript
248# EXPORTED FUNCTION - FOR USE IN EBUILDS 266# @USAGE: <db> <file> [version]
249# 267# @DESCRIPTION:
250# @param $1 - the db engine that the script is for 268# Install a SQL script that creates/upgrades a database schema for the web
251# (one of: mysql|postgres) 269# application. Currently supported database engines are mysql and postgres.
252# @param $2 - the sql script to be installed 270# 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 271# 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 () 272webapp_sqlscript() {
260{ 273 debug-print-function $FUNCNAME $*
274
261 webapp_checkfileexists "$2" 275 webapp_checkfileexists "${2}"
262 276
263 # create the directory where this script will go 277 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 278
268 if [ ! -d "${D}${MY_SQLSCRIPTSDIR}/$1" ]; then 279 # WARNING:
269 mkdir -p "${D}${MY_SQLSCRIPTSDIR}/$1" || libsh_die "unable to create directory ${D}${MY_SQLSCRIPTSDIR}/$1"
270 fi
271
272 # warning:
273 # 280 #
274 # do NOT change the naming convention used here without changing all 281 # do NOT change the naming convention used here without changing all
275 # the other scripts that also rely upon these names 282 # the other scripts that also rely upon these names
276 283
277 # are we dealing with an 'upgrade'-type script?
278 if [ -n "$3" ]; then 284 if [[ -n "${3}" ]]; then
279 # yes we are
280 einfo "($1) upgrade script from ${PN}-${PVR} to $3" 285 elog "(${1}) upgrade script for ${PN}-${3} to ${PVR}"
281 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"
282 else 288 else
283 # no, we are not
284 einfo "($1) create script for ${PN}-${PVR}" 289 elog "(${1}) create script for ${PN}-${PVR}"
285 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"
286 fi 292 fi
287} 293}
288 294
289# ------------------------------------------------------------------------ 295# @FUNCTION: webapp_src_preinst
290# EXPORTED FUNCTION - call from inside your ebuild's src_install AFTER 296# @DESCRIPTION:
291# 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.
292# 321#
293# 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
294# are no setuid files. I'm sure this will change significantly before 323# pkg_setup().
295# the final version! 324webapp_pkg_setup() {
296# ------------------------------------------------------------------------ 325 debug-print-function $FUNCNAME $*
297 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().
298function webapp_src_install () 384webapp_src_install() {
299{ 385 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 386
308 # 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
309 # we add an empty file to the filesystem 388 # we add an empty file to the filesystem
310 # 389 #
311 # 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
312 # no longer rely on Portage calling both webapp_src_install() and 391 # no longer rely on Portage calling both webapp_src_install() and
313 # webapp_pkg_postinst() within the same shell process 392 # webapp_pkg_postinst() within the same shell process
314
315 touch ${D}/${MY_APPDIR}/${INSTALL_CHECK_FILE} 393 touch "${D}/${MY_APPDIR}/${INSTALL_CHECK_FILE}"
316}
317 394
318# ------------------------------------------------------------------------ 395 # sanity checks, to catch bugs in the ebuild
319# EXPORTED FUNCTION - call from inside your ebuild's pkg_config AFTER 396 if [[ ! -f "${T}/${SETUP_CHECK_FILE}" ]]; then
320# 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.
321# 423#
322# 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
323# 425# pkg_postinst().
324# ------------------------------------------------------------------------ 426webapp_pkg_postinst() {
427 debug-print-function $FUNCNAME $*
325 428
326function webapp_pkg_setup () 429 webapp_read_config
327{
328 # add sanity checks here
329 430
330 if [ "$SLOT+" != "${PVR}+" ]; then 431 # sanity checks, to catch bugs in the ebuild
331 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"
332 fi 443 fi
333 444
334 # 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"
335 448
336 G_HOSTNAME="localhost" 449 G_HOSTNAME="localhost"
337 . ${ETC_CONFIG} || die "Unable to open /etc/vhosts/webapp-config file" 450 webapp_read_config
338 451
339 # are we installing a webapp-config solution over the top of a 452 local my_mode=-I
340 # non-webapp-config solution? 453 webapp_getinstalltype
341 454
342 if ! use vhosts ; then 455 if [[ "${IS_REPLACE}" == "1" ]]; then
343 local my_dir="$VHOST_ROOT/$MY_HTDOCSBASE/$PN" 456 elog "${PN}-${PVR} is already installed - replacing"
344 local my_output 457 my_mode=-I
345 458 elif [[ "${IS_UPGRADE}" == "1" ]]; then
346 if [ -d "$my_dir" ] ; then 459 elog "${REMOVE_PKG} is already installed - upgrading"
347 einfo "You already have something installed in $my_dir" 460 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 461 else
366 einfo 462 elog "${PN}-${PVR} is not installed - using install mode"
367 einfo "I can upgrade the contents of $my_dir"
368 einfo
369 fi
370 fi 463 fi
371 fi
372}
373 464
374function webapp_someunusedfunction () 465 my_cmd="${WEBAPP_CONFIG} ${my_mode} -h localhost -u root -d ${INSTALL_DIR} ${PN} ${PVR}"
375{ 466 elog "Running ${my_cmd}"
376 # are we emerging something that is already installed? 467 ${my_cmd}
377 468
378 if [ -d "${D}${MY_APPROOT}/${MY_APPSUFFIX}" ]; then 469 echo
379 # yes we are 470 local cleaner="${WEBAPP_CLEANER} -p -C ${PN}"
380 ewarn "Removing existing copy of ${PN}-${PVR}" 471 einfo "Running ${cleaner}"
381 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"
382 fi 484 fi
383} 485}
384 486
385function webapp_getinstalltype () 487# @FUNCTION: webapp_pkg_prerm
386{ 488# @DESCRIPTION:
387 # 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 $*
388 494
495 local my_output=
496 my_output="$(${WEBAPP_CONFIG} --list-installs ${PN} ${PVR})"
497 [[ $? -ne 0 ]] && return
498
499 local x
389 if ! use vhosts ; then 500 if ! use vhosts; then
390 # we only run webapp-config if vhosts USE flag is not set 501 echo "${my_output}" | while read x; do
391 502 if [[ -f "${x}"/.webapp ]]; then
392 local my_output 503 . "${x}"/.webapp
393 504 if [[ -n "${WEB_HOSTNAME}" && -n "${WEB_INSTALLDIR}" ]]; then
394 my_output="`webapp_check_installedat`" 505 ${WEBAPP_CONFIG} -C -h ${WEB_HOSTNAME} -d ${WEB_INSTALLDIR}
395
396 if [ "$?" = "0" ] ; then
397 # something is already installed there
398 #
399 # make sure it isn't the same version
400
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 506 fi
414 else 507 else
415 einfo "$my_ouptut is installed there" 508 ewarn "Cannot find file ${x}/.webapp"
416 fi 509 fi
417 else 510 done
418 einfo "This is an installation" 511 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 512 echo
459 einfo "vhosts USE flag not set - auto-installing using webapp-config" 513 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" 514 ewarn "Don't forget to use webapp-config to remove any copies of"
544 ewarn "${PN}-${PVR} installed in" 515 ewarn "${PN}-${PVR} installed in"
545 ewarn 516 ewarn
517
518 echo "${my_output}" | while read x; do
519 if [[ -f "${x}"/.webapp ]]; then
546 ewarn " $x" 520 ewarn " ${x}"
521 else
522 ewarn "Cannot find file ${x}/.webapp"
523 fi
524 done
525
547 ewarn 526 ewarn
548 else 527 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 528 fi
555 # IFS=" "
556 done
557
558 # IFS="$OLD_IFS"
559} 529}

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

  ViewVC Help
Powered by ViewVC 1.1.20