/[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.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.20 2004/05/22 18:56:58 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.7 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
34INSTALL_CHECK_FILE="installed_by_webapp_eclass" 36INSTALL_CHECK_FILE="installed_by_webapp_eclass"
37SETUP_CHECK_FILE="setup_by_webapp_eclass"
35 38
36# ------------------------------------------------------------------------ 39ETC_CONFIG="${ROOT}etc/vhosts/webapp-config"
37# INTERNAL FUNCTION - USED BY THIS ECLASS ONLY 40WEBAPP_CONFIG="${ROOT}usr/sbin/webapp-config"
38# 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
39# Check whether a specified file exists within the image/ directory 60# 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 () 61webapp_checkfileexists() {
48{ 62 debug-print-function $FUNCNAME $*
49 local my_prefix
50 63
51 [ -n "$2" ] && my_prefix="$2/" || my_prefix= 64 local my_prefix=${2:+${2}/}
52 65
53 if [ ! -e ${my_prefix}$1 ]; then 66 if [[ ! -e "${my_prefix}${1}" ]]; then
54 msg="ebuild fault: file $1 not found" 67 msg="ebuild fault: file '${1}' not found"
55 eerror "$msg" 68 eerror "$msg"
56 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/"
57 die "$msg" 70 die "$msg"
58 fi 71 fi
59} 72}
60 73
61# ------------------------------------------------------------------------
62# INTERNAL FUNCTION - USED BY THIS ECLASS ONLY
63# ------------------------------------------------------------------------
64
65function webapp_check_installedat 74webapp_check_installedat() {
66{ 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
67 local my_output 101 local my_output
102 my_output="$(webapp_check_installedat)"
68 103
69 /usr/sbin/webapp-config --show-installed -h localhost -d $INSTALL_DIR 2> /dev/null 104 if [[ $? -eq 0 ]]; then
70} 105 # something is already installed there
106 # make sure it isn't the same version
71 107
72# ------------------------------------------------------------------------ 108 local my_pn="$(echo ${my_output} | awk '{ print $1 }')"
73# INTERNAL FUNCTION - USED BY THIS ECLASS ONLY 109 local my_pvr="$(echo ${my_output} | awk '{ print $2 }')"
74# ------------------------------------------------------------------------
75 110
76function webapp_import_config () 111 REMOVE_PKG="${my_pn}-${my_pvr}"
77{ 112
78 if [ -z "${MY_HTDOCSDIR}" ]; then 113 if [[ "${my_pn}" == "${PN}" ]]; then
79 . /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"
80 fi 123 fi
81 124 else
82 if [ -z "${MY_HTDOCSDIR}" ]; then 125 elog "This is an installation"
83 libsh_edie "/etc/conf.d/webapp-config not imported"
84 fi 126 fi
85} 127}
86 128
87# ------------------------------------------------------------------------ 129# ==============================================================================
88# INTERNAL FUNCTION - USED BY THIS ECLASS ONLY 130# PUBLIC FUNCTIONS
89# 131# ==============================================================================
90# ------------------------------------------------------------------------
91 132
92function webapp_strip_appdir () 133# @FUNCTION: need_httpd
93{ 134# @DESCRIPTION:
94 local my_stripped="$1" 135# Call this function AFTER your ebuild's DEPEND line if any of the available
95 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 )"
96} 140}
97 141
98function webapp_strip_d () 142# @FUNCTION: need_httpd_cgi
99{ 143# @DESCRIPTION:
100 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 )"
101} 149}
102 150
103function webapp_strip_cwd () 151# @FUNCTION: need_httpd_fastcgi
104{ 152# @DESCRIPTION:
105 local my_stripped="$1" 153# Call this function AFTER your ebuild's DEPEND line if any of the available
106 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"
107} 158}
108 159
109# ------------------------------------------------------------------------ 160# @FUNCTION: webapp_configfile
110# EXPORTED FUNCTION - FOR USE IN EBUILDS 161# @USAGE: <file> [more files ...]
111# 162# @DESCRIPTION:
112# Identify a config file for a web-based application. 163# Mark a file config-protected for a web-based application.
113#
114# @param $1 - config file
115# ------------------------------------------------------------------------
116
117function webapp_configfile () 164webapp_configfile() {
118{ 165 debug-print-function $FUNCNAME $*
166
167 local m
168 for m in "$@"; do
119 webapp_checkfileexists "$1" "$D" 169 webapp_checkfileexists "${m}" "${D}"
120 echo $1
121 local MY_FILE="`webapp_strip_appdir $1`"
122 echo $MY_FILE
123 170
124 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}"
125 echo "$MY_FILE" >> ${D}${WA_CONFIGLIST} 175 echo "${my_file}" >> ${D}/${WA_CONFIGLIST}
176 done
126} 177}
127 178
128# ------------------------------------------------------------------------ 179# @FUNCTION: webapp_hook_script
129# EXPORTED FUNCTION - FOR USE IN EBUILDS 180# @USAGE: <file>
130# 181# @DESCRIPTION:
131# 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
132# before a virtual copy has been removed 183# before a virtual copy has been removed.
133#
134# @param $1 - the script to run
135# ------------------------------------------------------------------------
136
137function webapp_hook_script () 184webapp_hook_script() {
138{ 185 debug-print-function $FUNCNAME $*
186
139 webapp_checkfileexists "$2" 187 webapp_checkfileexists "${1}"
140 188
141 einfo "(hook) $1" 189 elog "(hook) ${1}"
142 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}/"
143 chmod 555 "${D}${MY_HOOKSCRIPTSDIR}/`basename $1`" 191 chmod 555 "${D}/${MY_HOOKSCRIPTSDIR}/$(basename "${1}")"
144} 192}
145 193
146# ------------------------------------------------------------------------ 194# @FUNCTION: webapp_postinst_txt
147# EXPORTED FUNCTION - FOR USE IN EBUILDS 195# @USAGE: <lang> <file>
148# 196# @DESCRIPTION:
149# Install a text file containing post-installation instructions. 197# Install a text file containing post-installation instructions.
150# 198webapp_postinst_txt() {
151# @param $1 - language code (use 'en' for now) 199 debug-print-function $FUNCNAME $*
152# @param $2 - the file to install
153# ------------------------------------------------------------------------
154 200
155function webapp_postinst_txt
156{
157 webapp_checkfileexists "$2" 201 webapp_checkfileexists "${2}"
158 202
159 einfo "(rtfm) $2 (lang: $1)" 203 elog "(info) ${2} (lang: ${1})"
160 cp "$2" "${D}${MY_APPDIR}/postinst-$1.txt" 204 cp "${2}" "${D}/${MY_APPDIR}/postinst-${1}.txt"
161} 205}
162 206
163# ------------------------------------------------------------------------ 207# @FUNCTION: webapp_postupgrade_txt
164# EXPORTED FUNCTION - FOR USE IN EBUILDS 208# @USAGE: <lang> <file>
165# 209# @DESCRIPTION:
166# Identify a script file (usually, but not always PHP or Perl) which is 210# Install a text file containing post-upgrade instructions.
167# 211webapp_postupgrade_txt() {
168# Files in this list may be modified to #! the required CGI engine when 212 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 213
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" 214 webapp_checkfileexists "${2}"
225 215
226 # 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}
227 219
228 local my_file 220# helper for webapp_serverowned()
221_webapp_serverowned() {
222 debug-print-function $FUNCNAME $*
229 223
230 if [ -z "$3" ]; then 224 webapp_checkfileexists "${1}" "${D}"
231 $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
232 else 250 else
233 $my_file="$1-$3" 251 for m in "$@"; do
252 _webapp_serverowned "${m}"
253 done
234 fi 254 fi
255}
235 256
236 # 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:
237 # 270 #
238 # do NOT change the naming convention used here without changing all 271 # do NOT change the naming convention used here without changing all
239 # the other scripts that also rely upon these names 272 # the other scripts that also rely upon these names
240 273
274 local my_file="${1}-${3:-$(basename "${2}")}"
275
241 einfo "($1) config file '$my_file'" 276 elog "(${1}) config file '${my_file}'"
242 cp "$2" "${D}${MY_SERVERCONFIGDIR}/${my_file}" 277 cp "${2}" "${D}/${MY_SERVERCONFIGDIR}/${my_file}"
243} 278}
244 279
245# ------------------------------------------------------------------------ 280# @FUNCTION: webapp_sqlscript
246# EXPORTED FUNCTION - FOR USE IN EBUILDS 281# @USAGE: <db> <file> [version]
247# 282# @DESCRIPTION:
248# @param $1 - the db engine that the script is for 283# Install a SQL script that creates/upgrades a database schema for the web
249# (one of: mysql|postgres) 284# application. Currently supported database engines are mysql and postgres.
250# @param $2 - the sql script to be installed 285# 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 286# 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 () 287webapp_sqlscript() {
258{ 288 debug-print-function $FUNCNAME $*
289
259 webapp_checkfileexists "$2" 290 webapp_checkfileexists "${2}"
260 291
261 # create the directory where this script will go 292 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 293
266 if [ ! -d "${D}${MY_SQLSCRIPTSDIR}/$1" ]; then 294 # WARNING:
267 mkdir -p "${D}${MY_SQLSCRIPTSDIR}/$1" || libsh_die "unable to create directory ${D}${MY_SQLSCRIPTSDIR}/$1"
268 fi
269
270 # warning:
271 # 295 #
272 # do NOT change the naming convention used here without changing all 296 # do NOT change the naming convention used here without changing all
273 # the other scripts that also rely upon these names 297 # the other scripts that also rely upon these names
274 298
275 # are we dealing with an 'upgrade'-type script?
276 if [ -n "$3" ]; then 299 if [[ -n "${3}" ]]; then
277 # yes we are
278 einfo "($1) upgrade script from ${PN}-${PVR} to $3" 300 elog "(${1}) upgrade script for ${PN}-${3} to ${PVR}"
279 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"
280 else 303 else
281 # no, we are not
282 einfo "($1) create script for ${PN}-${PVR}" 304 elog "(${1}) create script for ${PN}-${PVR}"
283 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"
284 fi 307 fi
285} 308}
286 309
287# ------------------------------------------------------------------------ 310# @FUNCTION: webapp_src_preinst
288# EXPORTED FUNCTION - call from inside your ebuild's src_install AFTER 311# @DESCRIPTION:
289# 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.
290# 336#
291# 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
292# are no setuid files. I'm sure this will change significantly before 338# pkg_setup().
293# the final version! 339webapp_pkg_setup() {
294# ------------------------------------------------------------------------ 340 debug-print-function $FUNCNAME $*
295 341
342 # to test whether or not the ebuild has correctly called this function
343 # we add an empty file to the filesystem
344 #
345 # we used to just set a variable in the shell script, but we can
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}"
349
350 # special case - some ebuilds *do* need to overwride the SLOT
351 if [[ "${SLOT}+" != "${PVR}+" && "${WEBAPP_MANUAL_SLOT}" != "yes" ]]; then
352 die "Set WEBAPP_MANUAL_SLOT=\"yes\" if you need to SLOT manually"
353 fi
354
355 # pull in the shared configuration file
356 G_HOSTNAME="localhost"
357 webapp_read_config
358
359 local my_dir="${ROOT}${VHOST_ROOT}/${MY_HTDOCSBASE}/${PN}"
360
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.
398#
399# You need to call this function AFTER everything else has run in your custom
400# src_install().
296function webapp_src_install () 401webapp_src_install() {
297{ 402 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 403
306 # to test whether or not the ebuild has correctly called this function 404 # to test whether or not the ebuild has correctly called this function
307 # we add an empty file to the filesystem 405 # we add an empty file to the filesystem
308 # 406 #
309 # we used to just set a variable in the shell script, but we can 407 # 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 408 # no longer rely on Portage calling both webapp_src_install() and
311 # webapp_pkg_postinst() within the same shell process 409 # webapp_pkg_postinst() within the same shell process
312
313 touch ${D}/${MY_APPDIR}/${INSTALL_CHECK_FILE} 410 touch "${D}/${MY_APPDIR}/${INSTALL_CHECK_FILE}"
314}
315 411
316# ------------------------------------------------------------------------ 412 # sanity checks, to catch bugs in the ebuild
317# EXPORTED FUNCTION - call from inside your ebuild's pkg_config AFTER 413 if [[ ! -f "${T}/${SETUP_CHECK_FILE}" ]]; then
318# everything else has run 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.
319# 440#
320# If 'vhosts' USE flag is not set, auto-install this app 441# You need to call this function AFTER everything else has run in your custom
321# 442# pkg_postinst().
322# ------------------------------------------------------------------------ 443webapp_pkg_postinst() {
444 debug-print-function $FUNCNAME $*
323 445
324function webapp_pkg_setup () 446 webapp_read_config
325{
326 # add sanity checks here
327 447
328 if [ "$SLOT+" != "${PVR}+" ]; then 448 # sanity checks, to catch bugs in the ebuild
329 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"
330 fi 460 fi
331 461
332 # 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"
333 466
334 G_HOSTNAME="localhost" 467 G_HOSTNAME="localhost"
335 . /etc/vhosts/webapp-config || die "Unable to open /etc/vhosts/webapp-config file" 468 webapp_read_config
336 469
337 # are we installing a webapp-config solution over the top of a 470 local my_mode=-I
338 # non-webapp-config solution? 471 webapp_getinstalltype
339 472
340 if ! use vhosts ; then 473 if [[ "${IS_REPLACE}" == "1" ]]; then
341 local my_dir="$VHOST_ROOT/$MY_HTDOCSBASE/$PN" 474 elog "${PN}-${PVR} is already installed - replacing"
342 local my_output 475 my_mode=-I
343 476 elif [[ "${IS_UPGRADE}" == "1" ]]; then
344 if [ -d "$my_dir" ] ; then 477 elog "${REMOVE_PKG} is already installed - upgrading"
345 einfo "You already have something installed in $my_dir" 478 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 479 else
364 einfo 480 elog "${PN}-${PVR} is not installed - using install mode"
365 einfo "I can upgrade the contents of $my_dir"
366 einfo
367 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"
368 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"
369 fi 514 fi
370} 515}
371 516
372function webapp_someunusedfunction () 517# @FUNCTION: webapp_pkg_prerm
373{ 518# @DESCRIPTION:
374 # 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 $*
375 524
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 525 local my_output=
526 my_output="$(${WEBAPP_CONFIG} --list-installs ${PN} ${PVR})"
527 [[ $? -ne 0 ]] && return
391 528
392 my_output="`webapp_check_installedat`" 529 local x
393 530 if has vhosts ${IUSE} && ! use vhosts; then
394 if [ "$?" = "0" ] ; then 531 echo "${my_output}" | while read x; do
395 # something is already installed there 532 if [[ -f "${x}"/.webapp ]]; then
396 # 533 . "${x}"/.webapp
397 # make sure it isn't the same version 534 if [[ -n "${WEB_HOSTNAME}" && -n "${WEB_INSTALLDIR}" ]]; then
398 535 ${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 536 fi
412 else 537 else
413 einfo "$my_ouptut is installed there" 538 ewarn "Cannot find file ${x}/.webapp"
414 fi 539 fi
415 else 540 done
416 einfo "This is an installation" 541 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 542 echo
455 einfo "vhosts USE flag not set - auto-installing using webapp-config" 543 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" 544 ewarn "Don't forget to use webapp-config to remove any copies of"
540 ewarn "${PN}-${PVR} installed in" 545 ewarn "${PN}-${PVR} installed in"
541 ewarn 546 ewarn
547
548 echo "${my_output}" | while read x; do
549 if [[ -f "${x}"/.webapp ]]; then
542 ewarn " $x" 550 ewarn " ${x}"
551 else
552 ewarn "Cannot find file ${x}/.webapp"
553 fi
554 done
555
543 ewarn 556 ewarn
544 else 557 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 558 fi
551 # IFS=" "
552 done
553
554 # IFS="$OLD_IFS"
555} 559}

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

  ViewVC Help
Powered by ViewVC 1.1.20