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

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

  ViewVC Help
Powered by ViewVC 1.1.20