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