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

Diff of /eclass/webapp.eclass

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

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