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

Diff of /eclass/webapp.eclass

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

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