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

Diff of /eclass/webapp.eclass

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

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