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

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

  ViewVC Help
Powered by ViewVC 1.1.20