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

Diff of /eclass/webapp.eclass

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

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

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

  ViewVC Help
Powered by ViewVC 1.1.20