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

Diff of /eclass/webapp.eclass

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

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

Legend:
Removed from v.1.18  
changed lines
  Added in v.1.60

  ViewVC Help
Powered by ViewVC 1.1.20