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

Diff of /eclass/webapp.eclass

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

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

Legend:
Removed from v.1.1  
changed lines
  Added in v.1.31

  ViewVC Help
Powered by ViewVC 1.1.20