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

Diff of /eclass/webapp.eclass

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

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

Legend:
Removed from v.1.41  
changed lines
  Added in v.1.51

  ViewVC Help
Powered by ViewVC 1.1.20