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

Diff of /eclass/webapp.eclass

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

Revision 1.43 Revision 1.66
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.43 2006/07/10 00:52:34 rl03 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 <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
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
128 local m="" 174 local m
129 for m in "$@" ; do 175 for m in "$@"; do
130 webapp_checkfileexists "${m}" "${D}" 176 webapp_checkfileexists "${m}" "${D}"
131 177
132 local MY_FILE="$(webapp_strip_appdir "${m}")" 178 local my_file="$(webapp_strip_appdir "${m}")"
133 MY_FILE="$(webapp_strip_cwd "${MY_FILE}")" 179 my_file="$(webapp_strip_cwd "${my_file}")"
134 180
135 elog "(config) ${MY_FILE}" 181 elog "(config) ${my_file}"
136 echo "${MY_FILE}" >> ${D}/${WA_CONFIGLIST} 182 echo "${my_file}" >> ${D}/${WA_CONFIGLIST}
137 done 183 done
138} 184}
139 185
140# ------------------------------------------------------------------------ 186# @FUNCTION: webapp_hook_script
141# EXPORTED FUNCTION - FOR USE IN EBUILDS 187# @USAGE: <file>
142# 188# @DESCRIPTION:
143# Install a script that will run after a virtual copy is created, and 189# Install a script that will run after a virtual copy is created, and
144# before a virtual copy has been removed 190# before a virtual copy has been removed.
145#
146# @param $1 - the script to run
147# ------------------------------------------------------------------------
148
149function webapp_hook_script () 191webapp_hook_script() {
150{ 192 debug-print-function $FUNCNAME $*
193
151 webapp_checkfileexists "${1}" 194 webapp_checkfileexists "${1}"
152 195
153 elog "(hook) ${1}" 196 elog "(hook) ${1}"
154 cp "${1}" "${D}/${MY_HOOKSCRIPTSDIR}/$(basename "${1}")" || die "Unable to install ${1} into ${D}/${MY_HOOKSCRIPTSDIR}/" 197 cp "${1}" "${D}/${MY_HOOKSCRIPTSDIR}/$(basename "${1}")" || die "Unable to install ${1} into ${D}/${MY_HOOKSCRIPTSDIR}/"
155 chmod 555 "${D}/${MY_HOOKSCRIPTSDIR}/$(basename "${1}")" 198 chmod 555 "${D}/${MY_HOOKSCRIPTSDIR}/$(basename "${1}")"
156} 199}
157 200
158# ------------------------------------------------------------------------ 201# @FUNCTION: webapp_postinst_txt
159# EXPORTED FUNCTION - FOR USE IN EBUILDS 202# @USAGE: <lang> <file>
160# 203# @DESCRIPTION:
161# Install a text file containing post-installation instructions. 204# 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 () 205webapp_postinst_txt() {
168{ 206 debug-print-function $FUNCNAME $*
207
169 webapp_checkfileexists "${2}" 208 webapp_checkfileexists "${2}"
170 209
171 elog "(info) ${2} (lang: ${1})" 210 elog "(info) ${2} (lang: ${1})"
172 cp "${2}" "${D}/${MY_APPDIR}/postinst-${1}.txt" 211 cp "${2}" "${D}/${MY_APPDIR}/postinst-${1}.txt"
173} 212}
174 213
175# ------------------------------------------------------------------------ 214# @FUNCTION: webapp_postupgrade_txt
176# EXPORTED FUNCTION - FOR USE IN EBUILDS 215# @USAGE: <lang> <file>
177# 216# @DESCRIPTION:
178# Install a text file containing post-upgrade instructions. 217# 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 () 218webapp_postupgrade_txt() {
185{ 219 debug-print-function $FUNCNAME $*
220
186 webapp_checkfileexists "${2}" 221 webapp_checkfileexists "${2}"
187 222
188 elog "(info) ${2} (lang: ${1})" 223 elog "(info) ${2} (lang: ${1})"
189 cp "${2}" "${D}/${MY_APPDIR}/postupgrade-${1}.txt" 224 cp "${2}" "${D}/${MY_APPDIR}/postupgrade-${1}.txt"
190} 225}
191 226
192# ------------------------------------------------------------------------ 227# helper for webapp_serverowned()
193# EXPORTED FUNCTION - FOR USE IN EBUILDS 228_webapp_serverowned() {
194# 229 debug-print-function $FUNCNAME $*
230
231 webapp_checkfileexists "${1}" "${D}"
232 local my_file="$(webapp_strip_appdir "${1}")"
233 my_file="$(webapp_strip_cwd "${my_file}")"
234
235 elog "(server owned) ${my_file}"
236 echo "${my_file}" >> "${D}/${WA_SOLIST}"
237}
238
239# @FUNCTION: webapp_serverowned
240# @USAGE: [-R] <file> [more files ...]
241# @DESCRIPTION:
195# Identify a file which must be owned by the webserver's user:group 242# 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 243# The ownership of the file is NOT set until the application is installed using
199# using the webapp-config tool. 244# 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 () 245webapp_serverowned() {
206{ 246 debug-print-function $FUNCNAME $*
247
207 local a="" 248 local a m
208 local m=""
209 if [ "${1}" = "-R" ]; then 249 if [[ "${1}" == "-R" ]]; then
210 shift 250 shift
211 for m in "$@" ; do 251 for m in "$@"; do
212 for a in $(find ${D}/${m}); do 252 find "${D}${m}" | while read a; do
213 a=${a/${D}\/\///}
214 webapp_checkfileexists "${a}" "$D"
215 local MY_FILE="$(webapp_strip_appdir "${a}")" 253 a=$(webapp_strip_d "${a}")
216 MY_FILE="$(webapp_strip_cwd "${MY_FILE}")" 254 _webapp_serverowned "${a}"
217
218 elog "(server owned) ${MY_FILE}"
219 echo "${MY_FILE}" >> "${D}/${WA_SOLIST}"
220 done 255 done
221 done 256 done
222 else 257 else
223 for m in "$@" ; do 258 for m in "$@"; do
224 webapp_checkfileexists "${m}" "$D" 259 _webapp_serverowned "${m}"
225 local MY_FILE="$(webapp_strip_appdir "${m}")"
226 MY_FILE="$(webapp_strip_cwd "${MY_FILE}")"
227
228 elog "(server owned) ${MY_FILE}"
229 echo "${MY_FILE}" >> "${D}/${WA_SOLIST}"
230 done 260 done
231 fi 261 fi
232} 262}
233 263
234# ------------------------------------------------------------------------ 264# @FUNCTION: webapp_server_configfile
235# EXPORTED FUNCTION - FOR USE IN EBUILDS 265# @USAGE: <server> <file> [new name]
236# 266# @DESCRIPTION:
237# @param $1 - the webserver to install the config file for 267# Install a configuration file for the webserver. You need to specify a
238# (one of apache1, apache2, cherokee) 268# webapp-config supported <server>. if no new name is given `basename $2' is
239# @param $2 - the config file to install 269# 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`) 270# 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 () 271webapp_server_configfile() {
249{ 272 debug-print-function $FUNCNAME $*
273
250 webapp_checkfileexists "${2}" 274 webapp_checkfileexists "${2}"
251 275
252 # sort out what the name will be of the config file 276 # 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 # 277 #
264 # do NOT change the naming convention used here without changing all 278 # do NOT change the naming convention used here without changing all
265 # the other scripts that also rely upon these names 279 # the other scripts that also rely upon these names
266 280
281 local my_file="${1}-${3:-$(basename "${2}")}"
282
267 elog "(${1}) config file '${my_file}'" 283 elog "(${1}) config file '${my_file}'"
268 cp "${2}" "${D}/${MY_SERVERCONFIGDIR}/${my_file}" 284 cp "${2}" "${D}/${MY_SERVERCONFIGDIR}/${my_file}"
269} 285}
270 286
271# ------------------------------------------------------------------------ 287# @FUNCTION: webapp_sqlscript
272# EXPORTED FUNCTION - FOR USE IN EBUILDS 288# @USAGE: <db> <file> [version]
273# 289# @DESCRIPTION:
274# @param $1 - the db engine that the script is for 290# Install a SQL script that creates/upgrades a database schema for the web
275# (one of: mysql|postgres) 291# application. Currently supported database engines are mysql and postgres.
276# @param $2 - the sql script to be installed 292# 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 293# 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 () 294webapp_sqlscript() {
284{ 295 debug-print-function $FUNCNAME $*
296
285 webapp_checkfileexists "${2}" 297 webapp_checkfileexists "${2}"
286 298
287 # create the directory where this script will go 299 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 300
292 if [ ! -d "${D}/${MY_SQLSCRIPTSDIR}/${1}" ]; then 301 # WARNING:
293 mkdir -p "${D}/${MY_SQLSCRIPTSDIR}/${1}" || die "unable to create directory ${D}/${MY_SQLSCRIPTSDIR}/${1}"
294 fi
295
296 # warning:
297 # 302 #
298 # do NOT change the naming convention used here without changing all 303 # do NOT change the naming convention used here without changing all
299 # the other scripts that also rely upon these names 304 # the other scripts that also rely upon these names
300 305
301 # are we dealing with an 'upgrade'-type script?
302 if [ -n "${3}" ]; then 306 if [[ -n "${3}" ]]; then
303 # yes we are
304 elog "(${1}) upgrade script from ${PN}-${PVR} to ${3}" 307 elog "(${1}) upgrade script for ${PN}-${3} to ${PVR}"
305 cp "${2}" "${D}${MY_SQLSCRIPTSDIR}/${1}/${3}_to_${PVR}.sql" 308 cp "${2}" "${D}${MY_SQLSCRIPTSDIR}/${1}/${3}_to_${PVR}.sql"
306 chmod 600 "${D}${MY_SQLSCRIPTSDIR}/${1}/${3}_to_${PVR}.sql" 309 chmod 600 "${D}${MY_SQLSCRIPTSDIR}/${1}/${3}_to_${PVR}.sql"
307 else 310 else
308 # no, we are not
309 elog "(${1}) create script for ${PN}-${PVR}" 311 elog "(${1}) create script for ${PN}-${PVR}"
310 cp "${2}" "${D}/${MY_SQLSCRIPTSDIR}/${1}/${PVR}_create.sql" 312 cp "${2}" "${D}/${MY_SQLSCRIPTSDIR}/${1}/${PVR}_create.sql"
311 chmod 600 "${D}/${MY_SQLSCRIPTSDIR}/${1}/${PVR}_create.sql" 313 chmod 600 "${D}/${MY_SQLSCRIPTSDIR}/${1}/${PVR}_create.sql"
312 fi 314 fi
313} 315}
314 316
315# ------------------------------------------------------------------------ 317# @FUNCTION: webapp_src_preinst
316# EXPORTED FUNCTION - call from inside your ebuild's src_install AFTER 318# @DESCRIPTION:
317# everything else has run 319# You need to call this function in src_install() BEFORE anything else has run.
318# 320# For now we just create required webapp-config directories.
319# For now, we just make sure that root owns everything, and that there 321webapp_src_preinst() {
320# are no setuid files. 322 debug-print-function $FUNCNAME $*
321# ------------------------------------------------------------------------
322 323
323function webapp_src_install () 324 # sanity checks, to catch bugs in the ebuild
324{ 325 if [[ ! -f "${T}/${SETUP_CHECK_FILE}" ]]; then
325 chown -R "${VHOST_DEFAULT_UID}:${VHOST_DEFAULT_GID}" "${D}/" 326 eerror
326 chmod -R u-s "${D}/" 327 eerror "This ebuild did not call webapp_pkg_setup() at the beginning"
327 chmod -R g-s "${D}/" 328 eerror "of the pkg_setup() function"
328 329 eerror
329 keepdir "${MY_PERSISTDIR}" 330 eerror "Please log a bug on http://bugs.gentoo.org"
330 fowners "root:0" "${MY_PERSISTDIR}" 331 eerror
331 fperms 755 "${MY_PERSISTDIR}" 332 eerror "You should use emerge -C to remove this package, as the"
332 333 eerror "installation is incomplete"
333 # to test whether or not the ebuild has correctly called this function 334 eerror
334 # we add an empty file to the filesystem 335 die "Ebuild did not call webapp_pkg_setup() - report to http://bugs.gentoo.org"
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 336 fi
366 fi
367 337
368 # pull in the shared configuration file 338 # Hint, see the webapp_read_config() function to find where these are
369 339 # defined.
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 my_output="$(webapp_check_installedat)"
382
383 if [ "$?" != "0" ]; then
384 # okay, whatever is there, it isn't webapp-config-compatible
385 ewarn "You already have something installed in ${my_dir}"
386 ewarn
387 ewarn "Whatever is in ${my_dir}, it's not"
388 ewarn "compatible with webapp-config."
389 ewarn
390 ewarn "This ebuild may be overwriting important files."
391 ewarn
392 elif [ "$(echo ${my_output} | awk '{ print $1 }')" != "${PN}" ]; then
393 eerror "${my_dir} contains ${my_output}"
394 eerror "I cannot upgrade that"
395 die "Cannot upgrade contents of ${my_dir}"
396 fi
397 fi
398 fi
399}
400
401function webapp_getinstalltype ()
402{
403 # or are we upgrading?
404
405 if ! use vhosts ; then
406 # we only run webapp-config if vhosts USE flag is not set
407
408 local my_output
409
410 my_output="$(webapp_check_installedat)"
411
412 if [ "${?}" = "0" ] ; then
413 # something is already installed there
414 #
415 # make sure it isn't the same version
416
417 local my_pn="$(echo ${my_output} | awk '{ print $1 }')"
418 local my_pvr="$(echo ${my_output} | awk '{ print $2 }')"
419
420 REMOVE_PKG="${my_pn}-${my_pvr}"
421
422 if [ "${my_pn}" == "${PN}" ]; then
423 if [ "${my_pvr}" != "${PVR}" ]; then
424 elog "This is an upgrade"
425 IS_UPGRADE=1
426 else
427 elog "This is a re-installation"
428 IS_REPLACE=1
429 fi
430 else
431 elog "${my_output} is installed there"
432 fi
433 else
434 elog "This is an installation"
435 fi
436 fi
437}
438
439function webapp_src_preinst ()
440{
441 # create the directories that we need
442
443 dodir "${MY_HTDOCSDIR}" 340 dodir "${MY_HTDOCSDIR}"
444 dodir "${MY_HOSTROOTDIR}" 341 dodir "${MY_HOSTROOTDIR}"
445 dodir "${MY_CGIBINDIR}" 342 dodir "${MY_CGIBINDIR}"
446 dodir "${MY_ICONSDIR}" 343 dodir "${MY_ICONSDIR}"
447 dodir "${MY_ERRORSDIR}" 344 dodir "${MY_ERRORSDIR}"
448 dodir "${MY_SQLSCRIPTSDIR}" 345 dodir "${MY_SQLSCRIPTSDIR}"
449 dodir "${MY_HOOKSCRIPTSDIR}" 346 dodir "${MY_HOOKSCRIPTSDIR}"
450 dodir "${MY_SERVERCONFIGDIR}" 347 dodir "${MY_SERVERCONFIGDIR}"
451} 348}
452 349
453function webapp_pkg_postinst () 350# ==============================================================================
454{ 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"
455 webapp_read_config 380 webapp_read_config
456 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
457 # sanity checks, to catch bugs in the ebuild 457 # sanity checks, to catch bugs in the ebuild
458
459 if [ ! -f "${ROOT}${MY_APPDIR}/${INSTALL_CHECK_FILE}" ]; then 458 if [[ ! -f "${ROOT}${MY_APPDIR}/${INSTALL_CHECK_FILE}" ]]; then
460 eerror 459 eerror
461 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"
462 eerror "of the src_install() function" 461 eerror "of the src_install() function"
463 eerror 462 eerror
464 eerror "Please log a bug on http://bugs.gentoo.org" 463 eerror "Please log a bug on http://bugs.gentoo.org"
467 eerror "installation is incomplete" 466 eerror "installation is incomplete"
468 eerror 467 eerror
469 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"
470 fi 469 fi
471 470
472 # if 'vhosts' is not set in your USE flags, we install a copy of 471 if has vhosts ${IUSE}; then
473 # this application in ${ROOT}/var/www/localhost/htdocs/${PN}/ for you
474
475 if ! use vhosts ; then 472 if ! use vhosts; then
476 echo 473 echo
477 elog "vhosts USE flag not set - auto-installing using webapp-config" 474 elog "vhosts USE flag not set - auto-installing using webapp-config"
478 475
479 webapp_getinstalltype
480
481 G_HOSTNAME="localhost" 476 G_HOSTNAME="localhost"
482 local my_mode=-I
483 webapp_read_config 477 webapp_read_config
484 478
479 local my_mode=-I
480 webapp_getinstalltype
481
485 if [ "${IS_REPLACE}" = "1" ]; then 482 if [[ "${IS_REPLACE}" == "1" ]]; then
486 elog "${PN}-${PVR} is already installed - replacing" 483 elog "${PN}-${PVR} is already installed - replacing"
487 my_mode=-I 484 my_mode=-I
488 elif [ "${IS_UPGRADE}" = "1" ]; then 485 elif [[ "${IS_UPGRADE}" == "1" ]]; then
489 elog "${REMOVE_PKG} is already installed - upgrading" 486 elog "${REMOVE_PKG} is already installed - upgrading"
490 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}
491 else 500 else
492 elog "${PN}-${PVR} is not installed - using install mode" 501 elog
493 fi 502 elog "The 'vhosts' USE flag is switched ON"
494 503 elog "This means that Portage will not automatically run webapp-config to"
495 my_cmd="${WEBAPP_CONFIG} ${my_mode} -h localhost -u root -d ${INSTALL_DIR} ${PN} ${PVR}" 504 elog "complete the installation."
496 elog "Running ${my_cmd}" 505 elog
497 ${my_cmd} 506 elog "To install ${PN}-${PVR} into a virtual host, run the following command:"
498 507 elog
499 # remove the old version 508 elog " webapp-config -I -h <host> -d ${PN} ${PN} ${PVR}"
500 # 509 elog
501 # why do we do this? well ... 510 elog "For more details, see the webapp-config(8) man page"
502 #
503 # normally, emerge -u installs a new version and then removes the
504 # old version. however, if the new version goes into a different
505 # slot to the old version, then the old version gets left behind
506 #
507 # if USE=-vhosts, then we want to remove the old version, because
508 # the user is relying on portage to do the magical thing for it
509
510 if [ "${IS_UPGRADE}" = "1" ] ; then
511 elog "Removing old version ${REMOVE_PKG}"
512
513 emerge -C "${REMOVE_PKG}"
514 fi 511 fi
515 else 512 else
516 # vhosts flag is on
517 #
518 # let's tell the administrator what to do next
519
520 elog 513 elog
521 elog "The 'vhosts' USE flag is switched ON" 514 elog "This ebuild does not support the 'vhosts' USE flag."
522 elog "This means that Portage will not automatically run webapp-config to" 515 elog "This means that Portage will not automatically run webapp-config to"
523 elog "complete the installation." 516 elog "complete the installation."
524 elog 517 elog
525 elog "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:"
526 elog 519 elog
527 elog " webapp-config -I -h <host> -d ${PN} ${PN} ${PVR}" 520 elog " webapp-config -I -h <host> -d ${PN} ${PN} ${PVR}"
528 elog 521 elog
529 elog "For more details, see the webapp-config(8) man page" 522 elog "For more details, see the webapp-config(8) man page"
530 fi 523 fi
531
532 return 0
533} 524}
534 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.
535function webapp_pkg_prerm () 531webapp_pkg_prerm() {
536{ 532 debug-print-function $FUNCNAME $*
537 # remove any virtual installs that there are
538 533
539 local my_output 534 local my_output=
535 my_output="$(${WEBAPP_CONFIG} --list-installs ${PN} ${PVR})"
536 [[ $? -ne 0 ]] && return
537
540 local x 538 local x
541 539 if has vhosts ${IUSE} && ! use vhosts; then
542 my_output="$(${WEBAPP_CONFIG} --list-installs ${PN} ${PVR})" 540 echo "${my_output}" | while read x; do
543 541 if [[ -f "${x}"/.webapp ]]; then
544 if [ "${?}" != "0" ]; then 542 . "${x}"/.webapp
545 return
546 fi
547
548 for x in ${my_output} ; do
549 [ -f ${x}/.webapp ] && . ${x}/.webapp || ewarn "Cannot find file ${x}/.webapp"
550
551 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
552 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"
553 ewarn "${PN}-${PVR} installed in" 554 ewarn "${PN}-${PVR} installed in"
554 ewarn 555 ewarn
556
557 echo "${my_output}" | while read x; do
558 if [[ -f "${x}"/.webapp ]]; then
555 ewarn " ${x}" 559 ewarn " ${x}"
560 else
561 ewarn "Cannot find file ${x}/.webapp"
562 fi
563 done
564
556 ewarn 565 ewarn
557 else 566 echo
558 # we have enough information to remove the virtual copy ourself
559
560 ${WEBAPP_CONFIG} -C -h ${WEB_HOSTNAME} -d ${WEB_INSTALLDIR}
561
562 # if the removal fails - we carry on anyway!
563 fi 567 fi
564 done
565} 568}

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

  ViewVC Help
Powered by ViewVC 1.1.20