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

Diff of /eclass/webapp.eclass

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

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