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

Legend:
Removed from v.1.13  
changed lines
  Added in v.1.67

  ViewVC Help
Powered by ViewVC 1.1.20