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

Diff of /eclass/webapp.eclass

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

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

Legend:
Removed from v.1.20  
changed lines
  Added in v.1.69

  ViewVC Help
Powered by ViewVC 1.1.20