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

Diff of /eclass/webapp.eclass

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

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

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

  ViewVC Help
Powered by ViewVC 1.1.20