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

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

  ViewVC Help
Powered by ViewVC 1.1.20