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

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

  ViewVC Help
Powered by ViewVC 1.1.20