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

Diff of /eclass/webapp.eclass

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

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

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

  ViewVC Help
Powered by ViewVC 1.1.20