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

Diff of /eclass/webapp.eclass

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

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

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

  ViewVC Help
Powered by ViewVC 1.1.20