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

Diff of /eclass/webapp.eclass

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

Revision 1.13 Revision 1.19
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.13 2004/04/30 08:25:38 stuart Exp $ 3# $Header: /var/cvsroot/gentoo-x86/eclass/webapp.eclass,v 1.19 2004/05/22 18:45:13 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.6" 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|${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
99 local MY_FILE="`webapp_strip_appdir $1`" 121 local MY_FILE="`webapp_strip_appdir $1`"
100 echo $MY_FILE 122 echo $MY_FILE
101 123
102 einfo "(config) $MY_FILE" 124 einfo "(config) $MY_FILE"
103 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`"
104} 144}
105 145
106# ------------------------------------------------------------------------ 146# ------------------------------------------------------------------------
107# EXPORTED FUNCTION - FOR USE IN EBUILDS 147# EXPORTED FUNCTION - FOR USE IN EBUILDS
108# 148#
166} 206}
167 207
168# ------------------------------------------------------------------------ 208# ------------------------------------------------------------------------
169# EXPORTED FUNCTION - FOR USE IN EBUILDS 209# EXPORTED FUNCTION - FOR USE IN EBUILDS
170# 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
171# 247#
172# @param $1 - the db engine that the script is for 248# @param $1 - the db engine that the script is for
173# (one of: mysql|postgres) 249# (one of: mysql|postgres)
174# @param $2 - the sql script to be installed 250# @param $2 - the sql script to be installed
175# @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
217# the final version! 293# the final version!
218# ------------------------------------------------------------------------ 294# ------------------------------------------------------------------------
219 295
220function webapp_src_install () 296function webapp_src_install ()
221{ 297{
222 chown -R root:root ${D}/ 298 chown -R ${VHOST_DEFAULT_UID}:${VHOST_DEFAULT_GID} ${D}/
223 chmod -R u-s ${D}/ 299 chmod -R u-s ${D}/
224 chmod -R g-s ${D}/ 300 chmod -R g-s ${D}/
225 301
226 keepdir ${MY_PERSISTDIR} 302 keepdir ${MY_PERSISTDIR}
227 fowners root:root ${MY_PERSISTDIR} 303 fowners root:root ${MY_PERSISTDIR}
228 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}
229} 314}
230 315
231# ------------------------------------------------------------------------ 316# ------------------------------------------------------------------------
232# EXPORTED FUNCTION - call from inside your ebuild's pkg_config AFTER 317# EXPORTED FUNCTION - call from inside your ebuild's pkg_config AFTER
233# everything else has run 318# everything else has run
236# 321#
237# ------------------------------------------------------------------------ 322# ------------------------------------------------------------------------
238 323
239function webapp_pkg_setup () 324function webapp_pkg_setup ()
240{ 325{
326 # add sanity checks here
327
328 if [ "$SLOT+" != "${PVR}+" ]; then
329 die "ebuild sets SLOT, overrides webapp.eclass"
330 fi
331
241 # pull in the shared configuration file 332 # pull in the shared configuration file
242 333
334 G_HOSTNAME="localhost"
243 . /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"
244 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
358 my_output="`qpkg -nc -v -f $my_dir`"
359 if [ -n "$my_output" ]; then
360 eerror "Please remove $my_output and re-emerge."
361 else
362 eerror "Please remove the contents of $my_dir, and then re-emerge."
363 fi
364 die "Cannot upgrade contents of $my_dir"
365 elif [ "`echo $my_output | awk '{ print $1 }'`" != "$PN" ]; then
366 eerror "$my_dir contains $my_output"
367 eerror "I cannot upgrade that"
368 die "Cannot upgrade contents of $my_dir"
369 else
370 einfo
371 einfo "I can upgrade the contents of $my_dir"
372 einfo
373 fi
374 fi
375 fi
376}
377
378function webapp_someunusedfunction ()
379{
245 # are we emerging something that is already installed? 380 # are we emerging something that is already installed?
246 381
247 if [ -d "${D}${MY_APPROOT}/${MY_APPSUFFIX}" ]; then 382 if [ -d "${D}${MY_APPROOT}/${MY_APPSUFFIX}" ]; then
248 # yes we are 383 # yes we are
249 ewarn "Removing existing copy of ${PN}-${PVR}" 384 ewarn "Removing existing copy of ${PN}-${PVR}"
250 rm -rf "${D}${MY_APPROOT}/${MY_APPSUFFIX}" 385 rm -rf "${D}${MY_APPROOT}/${MY_APPSUFFIX}"
386 fi
387}
388
389function webapp_getinstalltype ()
390{
391 # or are we upgrading?
392
393 if ! use vhosts ; then
394 # we only run webapp-config if vhosts USE flag is not set
395
396 local my_output
397
398 my_output="`webapp_check_installedat`"
399
400 if [ "$?" = "0" ] ; then
401 # something is already installed there
402 #
403 # make sure it isn't the same version
404
405 local my_pn="`echo $my_output | awk '{ print $1 }'`"
406 local my_pvr="`echo $my_output | awk '{ print $2 }'`"
407
408 REMOVE_PKG="${my_pn}-${my_pvr}"
409
410 if [ "$my_pn" == "$PN" ]; then
411 if [ "$my_pvr" != "$PVR" ]; then
412 einfo "This is an upgrade"
413 IS_UPGRADE=1
414 else
415 einfo "This is a re-installation"
416 IS_REPLACE=1
417 fi
418 else
419 einfo "$my_ouptut is installed there"
420 fi
421 else
422 einfo "This is an installation"
423 fi
251 fi 424 fi
252} 425}
253 426
254function webapp_src_preinst () 427function webapp_src_preinst ()
255{ 428{
263 dodir ${MY_SQLSCRIPTSDIR} 436 dodir ${MY_SQLSCRIPTSDIR}
264} 437}
265 438
266function webapp_pkg_postinst () 439function webapp_pkg_postinst ()
267{ 440{
268 einfo "webapp_pkg_postinst() called" 441 # sanity checks, to catch bugs in the ebuild
442
443 if [ ! -f ${MY_APPDIR}/${INSTALL_CHECK_FILE} ]; then
444 eerror
445 eerror "This ebuild did not call webapp_src_install() at the end"
446 eerror "of the src_install() function"
447 eerror
448 eerror "Please log a bug on http://bugs.gentoo.org"
449 eerror
450 eerror "You should use emerge -C to remove this package, as the"
451 eerror "installation is incomplete"
452 eerror
453 die "Ebuild did not call webapp_src_install() - report to http://bugs.gentoo.org"
454 fi
269 455
270 # if 'vhosts' is not set in your USE flags, we install a copy of 456 # if 'vhosts' is not set in your USE flags, we install a copy of
271 # this application in /var/www/localhost/htdocs/${PN}/ for you 457 # this application in /var/www/localhost/htdocs/${PN}/ for you
272
273 458
274 if ! use vhosts ; then 459 if ! use vhosts ; then
460 echo
275 einfo "vhosts USE flag not set - auto-installing using webapp-config" 461 einfo "vhosts USE flag not set - auto-installing using webapp-config"
462
463 webapp_getinstalltype
276 464
277 G_HOSTNAME="localhost" 465 G_HOSTNAME="localhost"
278 . /etc/vhosts/webapp-config 466 . /etc/vhosts/webapp-config
279 467
280 local my_mode=-I 468 local my_mode=-I
281 local my_dir="/${PN}"
282 469
283 # are we installing afresh - or are we upgrading?
284 # find out by looking to see what (if anything) is installed
285 # in there already
286
287 my_cmd="/usr/sbin/webapp-config --show-installed -d $my_dir 2> /dev/null"
288 einfo "$my_cmd"
289
290 my_output="`/usr/sbin/webapp-config --show-installed -d $my_dir 2> /dev/null`"
291
292 # we can't use the exit status from webapp-config
293
294 if [ "$?" = "0" ]; then 470 if [ "$IS_REPLACE" = "1" ]; then
295 471 einfo "${PN}-${PVR} is already installed - replacing"
296 # something is in there - but the question has to be ... what?
297
298 ewarn "$my_output already installed"
299
300 if [ "`echo $my_output | awk '{ print $1 }'`" = "${PN}" ]; then
301 einfo "$my_output is a copy of ${PN}"
302 if [ "`echo $my_output | awk '{ print $2 }'`" = "${PVR}" ]; then
303 # this version is already installed
304 # we need to remove it first
305
306 /usr/sbin/webapp-config -C -d $my_dir 472 /usr/sbin/webapp-config -C -d "$INSTALL_DIR"
307 else 473 elif [ "$IS_UPGRADE" = "1" ]; then
308 # we have an older version of whatever it is our ebuild is 474 einfo "$REMOVE_PKG is already installed - upgrading"
309 # trying to install ;-)
310 #
311 # this is the situation we can deal with
312
313 einfo "selecting upgrade mode"
314 my_mode=-U 475 my_mode=-U
315 fi
316 else
317 # this should never happen - but just in case ...
318 #
319 # whatever is in that directory, it isn't the application
320 # that we are currently trying to install
321 #
322 # rather than overwrite the contents, we bail with an error
323 # instead
324
325 die "$my_output is already installed in $my_dir"
326 fi
327 else 476 else
328 einfo "${PN}-${PVR} is not installed - using install mode" 477 einfo "${PN}-${PVR} is not installed - using install mode"
329 fi 478 fi
330 479
331 my_cmd="/usr/sbin/webapp-config $my_mode -h localhost -u root -d $my_dir ${PN} ${PVR}" 480 my_cmd="/usr/sbin/webapp-config $my_mode -h localhost -u root -d $INSTALL_DIR ${PN} ${PVR}"
332 einfo "Running $my_cmd" 481 einfo "Running $my_cmd"
333 $my_cmd 482 $my_cmd
483
484 # remove the old version
485 #
486 # why do we do this? well ...
487 #
488 # normally, emerge -u installs a new version and then removes the
489 # old version. however, if the new version goes into a different
490 # slot to the old version, then the old version gets left behind
491 #
492 # if USE=-vhosts, then we want to remove the old version, because
493 # the user is relying on portage to do the magical thing for it
494
495 if [ "$IS_UPGRADE" = "1" ] ; then
496 einfo "Removing old version $REMOVE_PKG"
497
498 emerge -C $CATEGORY/$REMOVE_PKG
499 fi
500 else
501 # vhosts flag is on
502 #
503 # let's tell the administrator what to do next
504
505 einfo
506 einfo "The 'vhosts' USE flag is switched ON"
507 einfo "This means that Portage will not automatically run webapp-config to"
508 einfo "complete the installation."
509 einfo
510 einfo "To install $PN-$PVR into a virtual host, run the following command:"
511 einfo
512 einfo " webapp-config -I -h <host> -d $PN $PN $PVR"
513 einfo
514 einfo "For more details, see the webapp-config(8) man page"
334 fi 515 fi
335 516
336 return 0 517 return 0
337} 518}
519
520function webapp_pkg_prerm ()
521{
522 # remove any virtual installs that there are
523
524 local my_output
525 local x
526
527 my_output="`webapp-config --list-installs $PN $PVR`"
528
529 if [ "$?" != "0" ]; then
530 return
531 fi
532
533 # the changes to IFS here are necessary to ensure that we can cope
534 # with directories that contain spaces in the file names
535
536 # OLD_IFS="$IFS"
537 # IFS=" "
538
539 for x in $my_output ; do
540 # IFS="$OLD_IFS"
541
542 [ -f $x/.webapp ] && . $x/.webapp || ewarn "Cannot find file $x/.webapp"
543
544 if [ -z "WEB_HOSTNAME" -o -z "WEB_INSTALLDIR" ]; then
545 ewarn "Don't forget to use webapp-config to remove the copy of"
546 ewarn "${PN}-${PVR} installed in"
547 ewarn
548 ewarn " $x"
549 ewarn
550 else
551 # we have enough information to remove the virtual copy ourself
552
553 webapp-config -C -h ${WEB_HOSTNAME} -d ${WEB_INSTALLDIR}
554
555 # if the removal fails - we carry on anyway!
556 fi
557 # IFS=" "
558 done
559
560 # IFS="$OLD_IFS"
561}

Legend:
Removed from v.1.13  
changed lines
  Added in v.1.19

  ViewVC Help
Powered by ViewVC 1.1.20