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

Diff of /eclass/webapp.eclass

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

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

Legend:
Removed from v.1.20  
changed lines
  Added in v.1.59

  ViewVC Help
Powered by ViewVC 1.1.20