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

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

  ViewVC Help
Powered by ViewVC 1.1.20