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

Diff of /eclass/webapp.eclass

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

Revision 1.14 Revision 1.21
1# Copyright 1999-2004 Gentoo Technologies, Inc. 1# Copyright 1999-2004 Gentoo Technologies, Inc.
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.14 2004/05/01 00:45:45 stuart Exp $ 3# $Header: /var/cvsroot/gentoo-x86/eclass/webapp.eclass,v 1.21 2004/05/25 10:22:02 stuart Exp $
4# 4#
5# eclass/webapp.eclass 5# eclass/webapp.eclass
6# Eclass for installing applications to run under a web server 6# Eclass for installing applications to run under a web server
7# 7#
8# Part of the implementation of GLEP #11 8# Part of the implementation of GLEP #11
9# 9#
10# Author(s) Stuart Herbert <stuart@gentoo.org> 10# Author(s) Stuart Herbert <stuart@gentoo.org>
11# 11#
12# ------------------------------------------------------------------------ 12# ------------------------------------------------------------------------
13# 13#
14# Please do not make modifications to this file without checking with a 14# The master copy of this eclass is held in Stu's subversion repository.
15# member of the web-apps herd first! 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.
16# 19#
17# ------------------------------------------------------------------------ 20# ------------------------------------------------------------------------
18 21
19ECLASS=webapp 22ECLASS=webapp
20INHERITED="$INHERITED $ECLASS" 23INHERITED="$INHERITED $ECLASS"
21SLOT="${PVR}" 24SLOT="${PVR}"
22IUSE="$IUSE vhosts" 25IUSE="$IUSE vhosts"
23DEPEND="$DEPEND >=net-www/webapp-config-1.7" 26DEPEND="$DEPEND >=net-www/webapp-config-1.7 app-portage/gentoolkit"
24 27
25EXPORT_FUNCTIONS pkg_postinst pkg_setup src_install 28EXPORT_FUNCTIONS pkg_postinst pkg_setup src_install pkg_prerm
26 29
27INSTALL_DIR="/$PN" 30INSTALL_DIR="/$PN"
28IS_UPGRADE=0 31IS_UPGRADE=0
29IS_REPLACE=0 32IS_REPLACE=0
33
34INSTALL_CHECK_FILE="installed_by_webapp_eclass"
35
36ETC_CONFIG="/etc/vhosts/webapp-config"
30 37
31# ------------------------------------------------------------------------ 38# ------------------------------------------------------------------------
32# INTERNAL FUNCTION - USED BY THIS ECLASS ONLY 39# INTERNAL FUNCTION - USED BY THIS ECLASS ONLY
33# 40#
34# Check whether a specified file exists within the image/ directory 41# Check whether a specified file exists within the image/ directory
121} 128}
122 129
123# ------------------------------------------------------------------------ 130# ------------------------------------------------------------------------
124# EXPORTED FUNCTION - FOR USE IN EBUILDS 131# EXPORTED FUNCTION - FOR USE IN EBUILDS
125# 132#
133# Install a script that will run after a virtual copy is created, and
134# before a virtual copy has been removed
135#
136# @param $1 - the script to run
137# ------------------------------------------------------------------------
138
139function webapp_hook_script ()
140{
141 webapp_checkfileexists "$2"
142
143 einfo "(hook) $1"
144 cp "$1" "${D}${MY_HOOKSCRIPTSDIR}/`basename $1`" || die "Unable to install $1 into ${D}${MY_HOOKSCRIPTSDIR}/"
145 chmod 555 "${D}${MY_HOOKSCRIPTSDIR}/`basename $1`"
146}
147
148# ------------------------------------------------------------------------
149# EXPORTED FUNCTION - FOR USE IN EBUILDS
150#
126# Install a text file containing post-installation instructions. 151# Install a text file containing post-installation instructions.
127# 152#
128# @param $1 - language code (use 'en' for now) 153# @param $1 - language code (use 'en' for now)
129# @param $2 - the file to install 154# @param $2 - the file to install
130# ------------------------------------------------------------------------ 155# ------------------------------------------------------------------------
183} 208}
184 209
185# ------------------------------------------------------------------------ 210# ------------------------------------------------------------------------
186# EXPORTED FUNCTION - FOR USE IN EBUILDS 211# EXPORTED FUNCTION - FOR USE IN EBUILDS
187# 212#
213# @param $1 - the webserver to install the config file for
214# (one of apache1, apache2, cherokee)
215# @param $2 - the config file to install
216# @param $3 - new name for the config file (default is `basename $2`)
217# this is an optional parameter
218#
219# NOTE:
220# this function will automagically prepend $1 to the front of your
221# config file's name
222# ------------------------------------------------------------------------
223
224function webapp_server_config ()
225{
226 webapp_checkfileexists "$2"
227
228 # sort out what the name will be of the config file
229
230 local my_file
231
232 if [ -z "$3" ]; then
233 $my_file="$1-`basename $2`"
234 else
235 $my_file="$1-$3"
236 fi
237
238 # warning:
239 #
240 # do NOT change the naming convention used here without changing all
241 # the other scripts that also rely upon these names
242
243 einfo "($1) config file '$my_file'"
244 cp "$2" "${D}${MY_SERVERCONFIGDIR}/${my_file}"
245}
246
247# ------------------------------------------------------------------------
248# EXPORTED FUNCTION - FOR USE IN EBUILDS
188# 249#
189# @param $1 - the db engine that the script is for 250# @param $1 - the db engine that the script is for
190# (one of: mysql|postgres) 251# (one of: mysql|postgres)
191# @param $2 - the sql script to be installed 252# @param $2 - the sql script to be installed
192# @param $3 - the older version of the app that this db script 253# @param $3 - the older version of the app that this db script
234# the final version! 295# the final version!
235# ------------------------------------------------------------------------ 296# ------------------------------------------------------------------------
236 297
237function webapp_src_install () 298function webapp_src_install ()
238{ 299{
239 chown -R root:root ${D}/ 300 chown -R ${VHOST_DEFAULT_UID}:${VHOST_DEFAULT_GID} ${D}/
240 chmod -R u-s ${D}/ 301 chmod -R u-s ${D}/
241 chmod -R g-s ${D}/ 302 chmod -R g-s ${D}/
242 303
243 keepdir ${MY_PERSISTDIR} 304 keepdir ${MY_PERSISTDIR}
244 fowners root:root ${MY_PERSISTDIR} 305 fowners root:root ${MY_PERSISTDIR}
245 fperms 755 ${MY_PERSISTDIR} 306 fperms 755 ${MY_PERSISTDIR}
307
308 # to test whether or not the ebuild has correctly called this function
309 # we add an empty file to the filesystem
310 #
311 # we used to just set a variable in the shell script, but we can
312 # no longer rely on Portage calling both webapp_src_install() and
313 # webapp_pkg_postinst() within the same shell process
314
315 touch ${D}/${MY_APPDIR}/${INSTALL_CHECK_FILE}
246} 316}
247 317
248# ------------------------------------------------------------------------ 318# ------------------------------------------------------------------------
249# EXPORTED FUNCTION - call from inside your ebuild's pkg_config AFTER 319# EXPORTED FUNCTION - call from inside your ebuild's pkg_config AFTER
250# everything else has run 320# everything else has run
253# 323#
254# ------------------------------------------------------------------------ 324# ------------------------------------------------------------------------
255 325
256function webapp_pkg_setup () 326function webapp_pkg_setup ()
257{ 327{
328 # add sanity checks here
329
330 if [ "$SLOT+" != "${PVR}+" ]; then
331 die "ebuild sets SLOT, overrides webapp.eclass"
332 fi
333
258 # pull in the shared configuration file 334 # pull in the shared configuration file
259 335
260 . /etc/vhosts/webapp-config || die "Unable to open /etc/vhosts/webapp-config file" 336 G_HOSTNAME="localhost"
261} 337 . ${ETC_CONFIG} || die "Unable to open /etc/vhosts/webapp-config file"
262 338
263function webapp_getinstalltype () 339 # are we installing a webapp-config solution over the top of a
340 # non-webapp-config solution?
341
342 if ! use vhosts ; then
343 local my_dir="$VHOST_ROOT/$MY_HTDOCSBASE/$PN"
344 local my_output
345
346 if [ -d "$my_dir" ] ; then
347 einfo "You already have something installed in $my_dir"
348 einfo "Are you trying to install over the top of something I cannot upgrade?"
349
350 my_output="`webapp_check_installedat`"
351
352 if [ "$?" != "0" ]; then
353
354 # okay, whatever is there, it isn't webapp-config-compatible
355 ewarn
356 ewarn "Whatever is in $my_dir, it's not"
357 ewarn "compatible with webapp-config."
358 ewarn
359 ewarn "This ebuild may be overwriting important files."
360 ewarn
361 elif [ "`echo $my_output | awk '{ print $1 }'`" != "$PN" ]; then
362 eerror "$my_dir contains $my_output"
363 eerror "I cannot upgrade that"
364 die "Cannot upgrade contents of $my_dir"
365 else
366 einfo
367 einfo "I can upgrade the contents of $my_dir"
368 einfo
369 fi
370 fi
371 fi
372}
373
374function webapp_someunusedfunction ()
264{ 375{
265 # are we emerging something that is already installed? 376 # are we emerging something that is already installed?
266 377
267 if [ -d "${D}${MY_APPROOT}/${MY_APPSUFFIX}" ]; then 378 if [ -d "${D}${MY_APPROOT}/${MY_APPSUFFIX}" ]; then
268 # yes we are 379 # yes we are
269 ewarn "Removing existing copy of ${PN}-${PVR}" 380 ewarn "Removing existing copy of ${PN}-${PVR}"
270 rm -rf "${D}${MY_APPROOT}/${MY_APPSUFFIX}" 381 rm -rf "${D}${MY_APPROOT}/${MY_APPSUFFIX}"
271 fi 382 fi
383}
272 384
385function webapp_getinstalltype ()
386{
273 # or are we upgrading? 387 # or are we upgrading?
274 388
275 if ! use vhosts ; then 389 if ! use vhosts ; then
276 # we only run webapp-config if vhosts USE flag is not set 390 # we only run webapp-config if vhosts USE flag is not set
277 391
295 IS_UPGRADE=1 409 IS_UPGRADE=1
296 else 410 else
297 einfo "This is a re-installation" 411 einfo "This is a re-installation"
298 IS_REPLACE=1 412 IS_REPLACE=1
299 fi 413 fi
414 else
415 einfo "$my_ouptut is installed there"
300 fi 416 fi
417 else
418 einfo "This is an installation"
301 fi 419 fi
302 fi 420 fi
303} 421}
304 422
305function webapp_src_preinst () 423function webapp_src_preinst ()
314 dodir ${MY_SQLSCRIPTSDIR} 432 dodir ${MY_SQLSCRIPTSDIR}
315} 433}
316 434
317function webapp_pkg_postinst () 435function webapp_pkg_postinst ()
318{ 436{
437 . ${ETC_CONFIG}
438
439 # sanity checks, to catch bugs in the ebuild
440
441 if [ ! -f ${MY_APPDIR}/${INSTALL_CHECK_FILE} ]; then
442 eerror
443 eerror "This ebuild did not call webapp_src_install() at the end"
444 eerror "of the src_install() function"
445 eerror
446 eerror "Please log a bug on http://bugs.gentoo.org"
447 eerror
448 eerror "You should use emerge -C to remove this package, as the"
449 eerror "installation is incomplete"
450 eerror
451 die "Ebuild did not call webapp_src_install() - report to http://bugs.gentoo.org"
452 fi
453
319 # if 'vhosts' is not set in your USE flags, we install a copy of 454 # if 'vhosts' is not set in your USE flags, we install a copy of
320 # this application in /var/www/localhost/htdocs/${PN}/ for you 455 # this application in /var/www/localhost/htdocs/${PN}/ for you
321 456
322 if ! use vhosts ; then 457 if ! use vhosts ; then
323 echo 458 echo
356 # the user is relying on portage to do the magical thing for it 491 # the user is relying on portage to do the magical thing for it
357 492
358 if [ "$IS_UPGRADE" = "1" ] ; then 493 if [ "$IS_UPGRADE" = "1" ] ; then
359 einfo "Removing old version $REMOVE_PKG" 494 einfo "Removing old version $REMOVE_PKG"
360 495
361 echo emerge -C $CATEGORY/$REMOVE_PKG 496 emerge -C $CATEGORY/$REMOVE_PKG
362 fi 497 fi
498 else
499 # vhosts flag is on
500 #
501 # let's tell the administrator what to do next
502
503 einfo
504 einfo "The 'vhosts' USE flag is switched ON"
505 einfo "This means that Portage will not automatically run webapp-config to"
506 einfo "complete the installation."
507 einfo
508 einfo "To install $PN-$PVR into a virtual host, run the following command:"
509 einfo
510 einfo " webapp-config -I -h <host> -d $PN $PN $PVR"
511 einfo
512 einfo "For more details, see the webapp-config(8) man page"
363 fi 513 fi
364 514
365 return 0 515 return 0
366} 516}
517
518function webapp_pkg_prerm ()
519{
520 # remove any virtual installs that there are
521
522 local my_output
523 local x
524
525 my_output="`webapp-config --list-installs $PN $PVR`"
526
527 if [ "$?" != "0" ]; then
528 return
529 fi
530
531 # the changes to IFS here are necessary to ensure that we can cope
532 # with directories that contain spaces in the file names
533
534 # OLD_IFS="$IFS"
535 # IFS=" "
536
537 for x in $my_output ; do
538 # IFS="$OLD_IFS"
539
540 [ -f $x/.webapp ] && . $x/.webapp || ewarn "Cannot find file $x/.webapp"
541
542 if [ -z "WEB_HOSTNAME" -o -z "WEB_INSTALLDIR" ]; then
543 ewarn "Don't forget to use webapp-config to remove the copy of"
544 ewarn "${PN}-${PVR} installed in"
545 ewarn
546 ewarn " $x"
547 ewarn
548 else
549 # we have enough information to remove the virtual copy ourself
550
551 webapp-config -C -h ${WEB_HOSTNAME} -d ${WEB_INSTALLDIR}
552
553 # if the removal fails - we carry on anyway!
554 fi
555 # IFS=" "
556 done
557
558 # IFS="$OLD_IFS"
559}

Legend:
Removed from v.1.14  
changed lines
  Added in v.1.21

  ViewVC Help
Powered by ViewVC 1.1.20