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

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

  ViewVC Help
Powered by ViewVC 1.1.20