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

Diff of /eclass/webapp.eclass

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

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

Legend:
Removed from v.1.37  
changed lines
  Added in v.1.66

  ViewVC Help
Powered by ViewVC 1.1.20