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

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

  ViewVC Help
Powered by ViewVC 1.1.20