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

Diff of /eclass/webapp.eclass

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

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

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

  ViewVC Help
Powered by ViewVC 1.1.20