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

Diff of /eclass/webapp.eclass

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

Revision 1.44 Revision 1.72
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.44 2006/07/11 02:36:23 rl03 Exp $ 3# $Header: /var/cvsroot/gentoo-x86/eclass/webapp.eclass,v 1.72 2012/07/18 14:59:29 blueness 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 # special case - some ebuilds *do* need to overwride the SLOT
356 if [[ "${SLOT}+" != "${PVR}+" && "${WEBAPP_MANUAL_SLOT}" != "yes" ]]; then
357 die "Set WEBAPP_MANUAL_SLOT=\"yes\" if you need to SLOT manually"
358 fi
359
360 # pull in the shared configuration file
361
362 G_HOSTNAME="localhost"
363 webapp_read_config
364
365 # are we installing a webapp-config solution over the top of a
366 # non-webapp-config solution?
367
368 if ! use vhosts ; then
369 local my_dir="${ROOT}${VHOST_ROOT}/${MY_HTDOCSBASE}/${PN}"
370 local my_output
371
372 if [ -d "${my_dir}" ] ; then
373 my_output="$(webapp_check_installedat)"
374
375 if [ "$?" != "0" ]; then
376 # okay, whatever is there, it isn't webapp-config-compatible
377 ewarn "You already have something installed in ${my_dir}"
378 ewarn
379 ewarn "Whatever is in ${my_dir}, it's not"
380 ewarn "compatible with webapp-config."
381 ewarn
382 ewarn "This ebuild may be overwriting important files."
383 ewarn
384 elif [ "$(echo ${my_output} | awk '{ print $1 }')" != "${PN}" ]; then
385 eerror "${my_dir} contains ${my_output}"
386 eerror "I cannot upgrade that"
387 die "Cannot upgrade contents of ${my_dir}"
388 fi
389 fi 348 fi
390 fi
391}
392 349
393function webapp_getinstalltype () 350 # Hint, see the webapp_read_config() function to find where these are
394{ 351 # defined.
395 # or are we upgrading?
396
397 if ! use vhosts ; then
398 # we only run webapp-config if vhosts USE flag is not set
399
400 local my_output
401
402 my_output="$(webapp_check_installedat)"
403
404 if [ "${?}" = "0" ] ; then
405 # something is already installed there
406 #
407 # make sure it isn't the same version
408
409 local my_pn="$(echo ${my_output} | awk '{ print $1 }')"
410 local my_pvr="$(echo ${my_output} | awk '{ print $2 }')"
411
412 REMOVE_PKG="${my_pn}-${my_pvr}"
413
414 if [ "${my_pn}" == "${PN}" ]; then
415 if [ "${my_pvr}" != "${PVR}" ]; then
416 elog "This is an upgrade"
417 IS_UPGRADE=1
418 else
419 elog "This is a re-installation"
420 IS_REPLACE=1
421 fi
422 else
423 elog "${my_output} is installed there"
424 fi
425 else
426 elog "This is an installation"
427 fi
428 fi
429}
430
431function webapp_src_preinst ()
432{
433 # create the directories that we need
434
435 dodir "${MY_HTDOCSDIR}" 352 dodir "${MY_HTDOCSDIR}"
436 dodir "${MY_HOSTROOTDIR}" 353 dodir "${MY_HOSTROOTDIR}"
437 dodir "${MY_CGIBINDIR}" 354 dodir "${MY_CGIBINDIR}"
438 dodir "${MY_ICONSDIR}" 355 dodir "${MY_ICONSDIR}"
439 dodir "${MY_ERRORSDIR}" 356 dodir "${MY_ERRORSDIR}"
440 dodir "${MY_SQLSCRIPTSDIR}" 357 dodir "${MY_SQLSCRIPTSDIR}"
441 dodir "${MY_HOOKSCRIPTSDIR}" 358 dodir "${MY_HOOKSCRIPTSDIR}"
442 dodir "${MY_SERVERCONFIGDIR}" 359 dodir "${MY_SERVERCONFIGDIR}"
443} 360}
444 361
445function webapp_pkg_postinst () 362# ==============================================================================
446{ 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"
447 webapp_read_config 392 webapp_read_config
448 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 if has "${EAPI:-0}" 0 1 2; then
417 ebeep 10
418 fi
419 elif [[ "$(echo ${my_output} | awk '{ print $1 }')" != "${PN}" ]]; then
420 echo
421 eerror "You already have ${my_output} installed in ${my_dir}"
422 eerror
423 eerror "I cannot upgrade a different application"
424 eerror
425 echo
426 die "Cannot upgrade contents of ${my_dir}"
427 fi
428
429}
430
431# @FUNCTION: webapp_src_install
432# @DESCRIPTION:
433# This is the default src_install(). For now, we just make sure that root owns
434# everything, and that there are no setuid files.
435#
436# You need to call this function AFTER everything else has run in your custom
437# src_install().
438webapp_src_install() {
439 debug-print-function $FUNCNAME $*
440
441 # to test whether or not the ebuild has correctly called this function
442 # we add an empty file to the filesystem
443 #
444 # we used to just set a variable in the shell script, but we can
445 # no longer rely on Portage calling both webapp_src_install() and
446 # webapp_pkg_postinst() within the same shell process
447 touch "${D}/${MY_APPDIR}/${INSTALL_CHECK_FILE}"
448
449 chown -R "${VHOST_DEFAULT_UID}:${VHOST_DEFAULT_GID}" "${D}/"
450 chmod -R u-s "${D}/"
451 chmod -R g-s "${D}/"
452
453 keepdir "${MY_PERSISTDIR}"
454 fowners "root:0" "${MY_PERSISTDIR}"
455 fperms 755 "${MY_PERSISTDIR}"
456}
457
458# @FUNCTION: webapp_pkg_postinst
459# @DESCRIPTION:
460# The default pkg_postinst() for this eclass. This installs the web application to
461# `${ROOT}/var/www/localhost/htdocs/${PN}/' if USE=vhosts is not set. Otherwise
462# display a short notice how to install this application with webapp-config.
463#
464# You need to call this function AFTER everything else has run in your custom
465# pkg_postinst().
466webapp_pkg_postinst() {
467 debug-print-function $FUNCNAME $*
468
469 webapp_read_config
470
449 # sanity checks, to catch bugs in the ebuild 471 # sanity checks, to catch bugs in the ebuild
450
451 if [ ! -f "${ROOT}${MY_APPDIR}/${INSTALL_CHECK_FILE}" ]; then 472 if [[ ! -f "${ROOT}${MY_APPDIR}/${INSTALL_CHECK_FILE}" ]]; then
452 eerror 473 eerror
453 eerror "This ebuild did not call webapp_src_install() at the end" 474 eerror "This ebuild did not call webapp_src_install() at the end"
454 eerror "of the src_install() function" 475 eerror "of the src_install() function"
455 eerror 476 eerror
456 eerror "Please log a bug on http://bugs.gentoo.org" 477 eerror "Please log a bug on http://bugs.gentoo.org"
… …
459 eerror "installation is incomplete" 480 eerror "installation is incomplete"
460 eerror 481 eerror
461 die "Ebuild did not call webapp_src_install() - report to http://bugs.gentoo.org" 482 die "Ebuild did not call webapp_src_install() - report to http://bugs.gentoo.org"
462 fi 483 fi
463 484
464 # if 'vhosts' is not set in your USE flags, we install a copy of 485 if has vhosts ${IUSE}; then
465 # this application in ${ROOT}/var/www/localhost/htdocs/${PN}/ for you
466
467 if ! use vhosts ; then 486 if ! use vhosts; then
468 echo 487 echo
469 elog "vhosts USE flag not set - auto-installing using webapp-config" 488 elog "vhosts USE flag not set - auto-installing using webapp-config"
470 489
471 webapp_getinstalltype
472
473 G_HOSTNAME="localhost" 490 G_HOSTNAME="localhost"
474 local my_mode=-I
475 webapp_read_config 491 webapp_read_config
476 492
493 local my_mode=-I
494 webapp_getinstalltype
495
477 if [ "${IS_REPLACE}" = "1" ]; then 496 if [[ "${IS_REPLACE}" == "1" ]]; then
478 elog "${PN}-${PVR} is already installed - replacing" 497 elog "${PN}-${PVR} is already installed - replacing"
479 my_mode=-I 498 my_mode=-I
480 elif [ "${IS_UPGRADE}" = "1" ]; then 499 elif [[ "${IS_UPGRADE}" == "1" ]]; then
481 elog "${REMOVE_PKG} is already installed - upgrading" 500 elog "${REMOVE_PKG} is already installed - upgrading"
482 my_mode=-U 501 my_mode=-U
502 else
503 elog "${PN}-${PVR} is not installed - using install mode"
504 fi
505
506 my_cmd="${WEBAPP_CONFIG} ${my_mode} -h localhost -u root -d ${INSTALL_DIR} ${PN} ${PVR}"
507 elog "Running ${my_cmd}"
508 ${my_cmd}
509
510 echo
511 local cleaner="${WEBAPP_CLEANER} -p -C /${PN}"
512 einfo "Running ${cleaner}"
513 ${cleaner}
483 else 514 else
484 elog "${PN}-${PVR} is not installed - using install mode" 515 elog
485 fi 516 elog "The 'vhosts' USE flag is switched ON"
486 517 elog "This means that Portage will not automatically run webapp-config to"
487 my_cmd="${WEBAPP_CONFIG} ${my_mode} -h localhost -u root -d ${INSTALL_DIR} ${PN} ${PVR}" 518 elog "complete the installation."
488 elog "Running ${my_cmd}" 519 elog
489 ${my_cmd} 520 elog "To install ${PN}-${PVR} into a virtual host, run the following command:"
490 521 elog
491 # remove the old version 522 elog " webapp-config -I -h <host> -d ${PN} ${PN} ${PVR}"
492 # 523 elog
493 # why do we do this? well ... 524 elog "For more details, see the webapp-config(8) man page"
494 #
495 # normally, emerge -u installs a new version and then removes the
496 # old version. however, if the new version goes into a different
497 # slot to the old version, then the old version gets left behind
498 #
499 # if USE=-vhosts, then we want to remove the old version, because
500 # the user is relying on portage to do the magical thing for it
501
502 if [ "${IS_UPGRADE}" = "1" ] ; then
503 elog "Removing old version ${REMOVE_PKG}"
504
505 emerge -C "${REMOVE_PKG}"
506 fi 525 fi
507 else 526 else
508 # vhosts flag is on
509 #
510 # let's tell the administrator what to do next
511
512 elog 527 elog
513 elog "The 'vhosts' USE flag is switched ON" 528 elog "This ebuild does not support the 'vhosts' USE flag."
514 elog "This means that Portage will not automatically run webapp-config to" 529 elog "This means that Portage will not automatically run webapp-config to"
515 elog "complete the installation." 530 elog "complete the installation."
516 elog 531 elog
517 elog "To install ${PN}-${PVR} into a virtual host, run the following command:" 532 elog "To install ${PN}-${PVR} into a virtual host, run the following command:"
518 elog 533 elog
519 elog " webapp-config -I -h <host> -d ${PN} ${PN} ${PVR}" 534 elog " webapp-config -I -h <host> -d ${PN} ${PN} ${PVR}"
520 elog 535 elog
521 elog "For more details, see the webapp-config(8) man page" 536 elog "For more details, see the webapp-config(8) man page"
522 fi 537 fi
523
524 return 0
525} 538}
526 539
540# @FUNCTION: webapp_pkg_prerm
541# @DESCRIPTION:
542# This is the default pkg_prerm() for this eclass. If USE=vhosts is not set
543# remove all installed copies of this web application. Otherwise instruct the
544# user to manually remove those copies. See bug #136959.
527function webapp_pkg_prerm () 545webapp_pkg_prerm() {
528{ 546 debug-print-function $FUNCNAME $*
529 # remove any virtual installs that there are
530 547
531 local my_output 548 local my_output=
549 my_output="$(${WEBAPP_CONFIG} --list-installs ${PN} ${PVR})"
550 [[ $? -ne 0 ]] && return
551
532 local x 552 local x
533 553 if has vhosts ${IUSE} && ! use vhosts; then
534 my_output="$(${WEBAPP_CONFIG} --list-installs ${PN} ${PVR})" 554 echo "${my_output}" | while read x; do
535 555 if [[ -f "${x}"/.webapp ]]; then
536 if [ "${?}" != "0" ]; then 556 . "${x}"/.webapp
537 return
538 fi
539
540 for x in ${my_output} ; do
541 [ -f ${x}/.webapp ] && . ${x}/.webapp || ewarn "Cannot find file ${x}/.webapp"
542
543 if [ -z "${WEB_HOSTNAME}" -o -z "${WEB_INSTALLDIR}" ]; then 557 if [[ -n "${WEB_HOSTNAME}" && -n "${WEB_INSTALLDIR}" ]]; then
558 ${WEBAPP_CONFIG} -C -h ${WEB_HOSTNAME} -d ${WEB_INSTALLDIR} ${PN} ${PVR}
559 fi
560 else
561 ewarn "Cannot find file ${x}/.webapp"
562 fi
563 done
564 elif [[ "${my_output}" != "" ]]; then
565 echo
566 ewarn
544 ewarn "Don't forget to use webapp-config to remove the copy of" 567 ewarn "Don't forget to use webapp-config to remove any copies of"
545 ewarn "${PN}-${PVR} installed in" 568 ewarn "${PN}-${PVR} installed in"
546 ewarn 569 ewarn
570
571 echo "${my_output}" | while read x; do
572 if [[ -f "${x}"/.webapp ]]; then
547 ewarn " ${x}" 573 ewarn " ${x}"
574 else
575 ewarn "Cannot find file ${x}/.webapp"
576 fi
577 done
578
548 ewarn 579 ewarn
549 else 580 echo
550 # we have enough information to remove the virtual copy ourself
551
552 ${WEBAPP_CONFIG} -C -h ${WEB_HOSTNAME} -d ${WEB_INSTALLDIR}
553
554 # if the removal fails - we carry on anyway!
555 fi 581 fi
556 done
557} 582}
Legend:
Removed from v.1.44  
changed lines
  Added in v.1.72
  ViewVC Help
Powered by ViewVC 1.1.13