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

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

  ViewVC Help
Powered by ViewVC 1.1.20