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

Diff of /eclass/webapp.eclass

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

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

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

  ViewVC Help
Powered by ViewVC 1.1.20