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

Diff of /eclass/webapp.eclass

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

Revision 1.9 Revision 1.20
1# Copyright 1999-2003 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.9 2004/04/23 22:02:27 stuart Exp $ 3# $Header: /var/cvsroot/gentoo-x86/eclass/webapp.eclass,v 1.20 2004/05/22 18:56:58 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.4" 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
29
30INSTALL_DIR="/$PN"
31IS_UPGRADE=0
32IS_REPLACE=0
33
34INSTALL_CHECK_FILE="installed_by_webapp_eclass"
26 35
27# ------------------------------------------------------------------------ 36# ------------------------------------------------------------------------
28# INTERNAL FUNCTION - USED BY THIS ECLASS ONLY 37# INTERNAL FUNCTION - USED BY THIS ECLASS ONLY
29# 38#
30# Check whether a specified file exists within the image/ directory 39# Check whether a specified file exists within the image/ directory
51 60
52# ------------------------------------------------------------------------ 61# ------------------------------------------------------------------------
53# INTERNAL FUNCTION - USED BY THIS ECLASS ONLY 62# INTERNAL FUNCTION - USED BY THIS ECLASS ONLY
54# ------------------------------------------------------------------------ 63# ------------------------------------------------------------------------
55 64
65function webapp_check_installedat
66{
67 local my_output
68
69 /usr/sbin/webapp-config --show-installed -h localhost -d $INSTALL_DIR 2> /dev/null
70}
71
72# ------------------------------------------------------------------------
73# INTERNAL FUNCTION - USED BY THIS ECLASS ONLY
74# ------------------------------------------------------------------------
75
56function webapp_import_config () 76function webapp_import_config ()
57{ 77{
58 if [ -z "${MY_HTDOCSDIR}" ]; then 78 if [ -z "${MY_HTDOCSDIR}" ]; then
59 . /etc/conf.d/webapp-config 79 . /etc/conf.d/webapp-config
60 fi 80 fi
69# 89#
70# ------------------------------------------------------------------------ 90# ------------------------------------------------------------------------
71 91
72function webapp_strip_appdir () 92function webapp_strip_appdir ()
73{ 93{
94 local my_stripped="$1"
74 echo "$1" | sed -e "s|${D}${MY_APPDIR}/||g;" 95 echo "$1" | sed -e "s|${MY_APPDIR}/||g;"
75} 96}
76 97
77function webapp_strip_d () 98function webapp_strip_d ()
78{ 99{
79 echo "$1" | sed -e "s|${D}||g;" 100 echo "$1" | sed -e "s|${D}||g;"
80} 101}
81 102
82function webapp_strip_cwd () 103function webapp_strip_cwd ()
83{ 104{
105 local my_stripped="$1"
84 echo "$1" | sed -e 's|/./|/|g;' 106 echo "$1" | sed -e 's|/./|/|g;'
85} 107}
86 108
87# ------------------------------------------------------------------------ 109# ------------------------------------------------------------------------
88# EXPORTED FUNCTION - FOR USE IN EBUILDS 110# EXPORTED FUNCTION - FOR USE IN EBUILDS
93# ------------------------------------------------------------------------ 115# ------------------------------------------------------------------------
94 116
95function webapp_configfile () 117function webapp_configfile ()
96{ 118{
97 webapp_checkfileexists "$1" "$D" 119 webapp_checkfileexists "$1" "$D"
120 echo $1
98 local MY_FILE="`webapp_strip_appdir $1`" 121 local MY_FILE="`webapp_strip_appdir $1`"
122 echo $MY_FILE
99 123
100 einfo "(config) $MY_FILE" 124 einfo "(config) $MY_FILE"
101 echo "$MY_FILE" >> ${D}${WA_CONFIGLIST} 125 echo "$MY_FILE" >> ${D}${WA_CONFIGLIST}
126}
127
128# ------------------------------------------------------------------------
129# EXPORTED FUNCTION - FOR USE IN EBUILDS
130#
131# Install a script that will run after a virtual copy is created, and
132# before a virtual copy has been removed
133#
134# @param $1 - the script to run
135# ------------------------------------------------------------------------
136
137function webapp_hook_script ()
138{
139 webapp_checkfileexists "$2"
140
141 einfo "(hook) $1"
142 cp "$1" "${D}${MY_HOOKSCRIPTSDIR}/`basename $1`" || die "Unable to install $1 into ${D}${MY_HOOKSCRIPTSDIR}/"
143 chmod 555 "${D}${MY_HOOKSCRIPTSDIR}/`basename $1`"
102} 144}
103 145
104# ------------------------------------------------------------------------ 146# ------------------------------------------------------------------------
105# EXPORTED FUNCTION - FOR USE IN EBUILDS 147# EXPORTED FUNCTION - FOR USE IN EBUILDS
106# 148#
164} 206}
165 207
166# ------------------------------------------------------------------------ 208# ------------------------------------------------------------------------
167# EXPORTED FUNCTION - FOR USE IN EBUILDS 209# EXPORTED FUNCTION - FOR USE IN EBUILDS
168# 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"
225
226 # sort out what the name will be of the config file
227
228 local my_file
229
230 if [ -z "$3" ]; then
231 $my_file="$1-`basename $2`"
232 else
233 $my_file="$1-$3"
234 fi
235
236 # warning:
237 #
238 # do NOT change the naming convention used here without changing all
239 # the other scripts that also rely upon these names
240
241 einfo "($1) config file '$my_file'"
242 cp "$2" "${D}${MY_SERVERCONFIGDIR}/${my_file}"
243}
244
245# ------------------------------------------------------------------------
246# EXPORTED FUNCTION - FOR USE IN EBUILDS
169# 247#
170# @param $1 - the db engine that the script is for 248# @param $1 - the db engine that the script is for
171# (one of: mysql|postgres) 249# (one of: mysql|postgres)
172# @param $2 - the sql script to be installed 250# @param $2 - the sql script to be installed
173# @param $3 - the older version of the app that this db script 251# @param $3 - the older version of the app that this db script
215# the final version! 293# the final version!
216# ------------------------------------------------------------------------ 294# ------------------------------------------------------------------------
217 295
218function webapp_src_install () 296function webapp_src_install ()
219{ 297{
220 chown -R root:root ${D}/ 298 chown -R ${VHOST_DEFAULT_UID}:${VHOST_DEFAULT_GID} ${D}/
221 chmod -R u-s ${D}/ 299 chmod -R u-s ${D}/
222 chmod -R g-s ${D}/ 300 chmod -R g-s ${D}/
223 301
224 keepdir ${MY_PERSISTDIR} 302 keepdir ${MY_PERSISTDIR}
225 fowners root:root ${MY_PERSISTDIR} 303 fowners root:root ${MY_PERSISTDIR}
226 fperms 755 ${MY_PERSISTDIR} 304 fperms 755 ${MY_PERSISTDIR}
305
306 # to test whether or not the ebuild has correctly called this function
307 # we add an empty file to the filesystem
308 #
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
311 # webapp_pkg_postinst() within the same shell process
312
313 touch ${D}/${MY_APPDIR}/${INSTALL_CHECK_FILE}
227} 314}
228 315
229# ------------------------------------------------------------------------ 316# ------------------------------------------------------------------------
230# EXPORTED FUNCTION - call from inside your ebuild's pkg_config AFTER 317# EXPORTED FUNCTION - call from inside your ebuild's pkg_config AFTER
231# everything else has run 318# everything else has run
234# 321#
235# ------------------------------------------------------------------------ 322# ------------------------------------------------------------------------
236 323
237function webapp_pkg_setup () 324function webapp_pkg_setup ()
238{ 325{
326 # add sanity checks here
327
328 if [ "$SLOT+" != "${PVR}+" ]; then
329 die "ebuild sets SLOT, overrides webapp.eclass"
330 fi
331
239 # pull in the shared configuration file 332 # pull in the shared configuration file
240 333
334 G_HOSTNAME="localhost"
241 . /etc/vhosts/webapp-config || die "Unable to open /etc/vhosts/webapp-config file" 335 . /etc/vhosts/webapp-config || die "Unable to open /etc/vhosts/webapp-config file"
242 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{
243 # are we emerging something that is already installed? 374 # are we emerging something that is already installed?
244 375
245 if [ -d "${D}${MY_APPROOT}/${MY_APPSUFFIX}" ]; then 376 if [ -d "${D}${MY_APPROOT}/${MY_APPSUFFIX}" ]; then
246 # yes we are 377 # yes we are
247 ewarn "Removing existing copy of ${PN}-${PVR}" 378 ewarn "Removing existing copy of ${PN}-${PVR}"
248 rm -rf "${D}${MY_APPROOT}/${MY_APPSUFFIX}" 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
249 fi 418 fi
250} 419}
251 420
252function webapp_src_preinst () 421function webapp_src_preinst ()
253{ 422{
261 dodir ${MY_SQLSCRIPTSDIR} 430 dodir ${MY_SQLSCRIPTSDIR}
262} 431}
263 432
264function webapp_pkg_postinst () 433function webapp_pkg_postinst ()
265{ 434{
435 # sanity checks, to catch bugs in the ebuild
436
437 if [ ! -f ${MY_APPDIR}/${INSTALL_CHECK_FILE} ]; then
438 eerror
439 eerror "This ebuild did not call webapp_src_install() at the end"
440 eerror "of the src_install() function"
441 eerror
442 eerror "Please log a bug on http://bugs.gentoo.org"
443 eerror
444 eerror "You should use emerge -C to remove this package, as the"
445 eerror "installation is incomplete"
446 eerror
447 die "Ebuild did not call webapp_src_install() - report to http://bugs.gentoo.org"
448 fi
449
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
454 echo
455 einfo "vhosts USE flag not set - auto-installing using webapp-config"
456
457 webapp_getinstalltype
458
266 G_HOSTNAME="localhost" 459 G_HOSTNAME="localhost"
267 . /etc/vhosts/webapp-config 460 . /etc/vhosts/webapp-config
268 461
269 use vhosts || /usr/sbin/webapp-config -I -u root -h localhost -d "${VHOST_ROOT}/htdocs/${PN}/" ${PN} ${PVR} 462 local my_mode=-I
463
464 if [ "$IS_REPLACE" = "1" ]; then
465 einfo "${PN}-${PVR} is already installed - replacing"
466 /usr/sbin/webapp-config -C -d "$INSTALL_DIR"
467 elif [ "$IS_UPGRADE" = "1" ]; then
468 einfo "$REMOVE_PKG is already installed - upgrading"
469 my_mode=-U
470 else
471 einfo "${PN}-${PVR} is not installed - using install mode"
472 fi
473
474 my_cmd="/usr/sbin/webapp-config $my_mode -h localhost -u root -d $INSTALL_DIR ${PN} ${PVR}"
475 einfo "Running $my_cmd"
476 $my_cmd
477
478 # remove the old version
479 #
480 # why do we do this? well ...
481 #
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
495 # vhosts flag is on
496 #
497 # let's tell the administrator what to do next
498
499 einfo
500 einfo "The 'vhosts' USE flag is switched ON"
501 einfo "This means that Portage will not automatically run webapp-config to"
502 einfo "complete the installation."
503 einfo
504 einfo "To install $PN-$PVR into a virtual host, run the following command:"
505 einfo
506 einfo " webapp-config -I -h <host> -d $PN $PN $PVR"
507 einfo
508 einfo "For more details, see the webapp-config(8) man page"
509 fi
510
511 return 0
270} 512}
513
514function webapp_pkg_prerm ()
515{
516 # remove any virtual installs that there are
517
518 local my_output
519 local x
520
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
534 # IFS="$OLD_IFS"
535
536 [ -f $x/.webapp ] && . $x/.webapp || ewarn "Cannot find file $x/.webapp"
537
538 if [ -z "WEB_HOSTNAME" -o -z "WEB_INSTALLDIR" ]; then
539 ewarn "Don't forget to use webapp-config to remove the copy of"
540 ewarn "${PN}-${PVR} installed in"
541 ewarn
542 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
553
554 # IFS="$OLD_IFS"
555}

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

  ViewVC Help
Powered by ViewVC 1.1.20