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

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

  ViewVC Help
Powered by ViewVC 1.1.20