/[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.24
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.24 2004/06/25 00:39:48 vapier 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-1.7 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 echo $1
123 local MY_FILE="`webapp_strip_appdir \"$1\"`"
124 echo $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# Identify a script file (usually, but not always PHP or Perl) which is
169#
170# Files in this list may be modified to #! the required CGI engine when
171# installed by webapp-config tool in the future.
172#
173# @param $1 - the cgi engine to use
174# @param $2 - the script file that could run under a cgi-bin
175#
176# ------------------------------------------------------------------------
177
178function webapp_runbycgibin ()
179{
180 webapp_checkfileexists "$2" "$D"
181 local MY_FILE="`webapp_strip_appdir \"$2\"`"
182 MY_FILE="`webapp_strip_cwd \"$MY_FILE\"`"
183
184 einfo "(cgi-bin) $1 - $MY_FILE"
185 echo "\"$1\" \"$MY_FILE\"" >> "${D}${WA_RUNBYCGIBINLIST}"
54} 186}
55 187
56# ------------------------------------------------------------------------ 188# ------------------------------------------------------------------------
57# EXPORTED FUNCTION - FOR USE IN EBUILDS 189# EXPORTED FUNCTION - FOR USE IN EBUILDS
58# 190#
… …
66# 198#
67# ------------------------------------------------------------------------ 199# ------------------------------------------------------------------------
68 200
69function webapp_serverowned () 201function webapp_serverowned ()
70{ 202{
71 webapp_checkfileexists $1 203 webapp_checkfileexists "$1" "$D"
72 echo "$1" >> $WA_SOLIST 204 local MY_FILE="`webapp_strip_appdir \"$1\"`"
205
206 einfo "(server owned) $MY_FILE"
207 echo "$MY_FILE" >> "${D}${WA_SOLIST}"
73} 208}
74 209
75# ------------------------------------------------------------------------ 210# ------------------------------------------------------------------------
76# EXPORTED FUNCTION - FOR USE IN EBUILDS 211# EXPORTED FUNCTION - FOR USE IN EBUILDS
77# 212#
78# Identify a config file for a web-based application. 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
79# 218#
80# @param $1 - config file 219# NOTE:
220# this function will automagically prepend $1 to the front of your
221# config file's name
81# ------------------------------------------------------------------------ 222# ------------------------------------------------------------------------
82 223
83function webapp_configfile () 224function webapp_server_config ()
84{ 225{
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 226 webapp_checkfileexists "$2"
105 echo "$1 $2" >> $WA_RUNBYCGIBINLIST 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
249#
250# @param $1 - the db engine that the script is for
251# (one of: mysql|postgres)
252# @param $2 - the sql script to be installed
253# @param $3 - the older version of the app that this db script
254# will upgrade from
255# (do not pass this option if your SQL script only creates
256# a new db from scratch)
257# ------------------------------------------------------------------------
258
259function webapp_sqlscript ()
260{
261 webapp_checkfileexists "$2"
262
263 # create the directory where this script will go
264 #
265 # scripts for specific database engines go into their own subdirectory
266 # just to keep things readable on the filesystem
267
268 if [ ! -d "${D}${MY_SQLSCRIPTSDIR}/$1" ]; then
269 mkdir -p "${D}${MY_SQLSCRIPTSDIR}/$1" || libsh_die "unable to create directory ${D}${MY_SQLSCRIPTSDIR}/$1"
270 fi
271
272 # warning:
273 #
274 # do NOT change the naming convention used here without changing all
275 # the other scripts that also rely upon these names
276
277 # are we dealing with an 'upgrade'-type script?
278 if [ -n "$3" ]; then
279 # yes we are
280 einfo "($1) upgrade script from ${PN}-${PVR} to $3"
281 cp "$2" "${D}${MY_SQLSCRIPTSDIR}/$1/${3}_to_${PVR}.sql"
282 else
283 # no, we are not
284 einfo "($1) create script for ${PN}-${PVR}"
285 cp "$2" "${D}${MY_SQLSCRIPTSDIR}/$1/${PVR}_create.sql"
286 fi
106} 287}
107 288
108# ------------------------------------------------------------------------ 289# ------------------------------------------------------------------------
109# EXPORTED FUNCTION - call from inside your ebuild's src_install AFTER 290# EXPORTED FUNCTION - call from inside your ebuild's src_install AFTER
110# everything else has run 291# everything else has run
… …
114# the final version! 295# the final version!
115# ------------------------------------------------------------------------ 296# ------------------------------------------------------------------------
116 297
117function webapp_src_install () 298function webapp_src_install ()
118{ 299{
119 chown -R root:root ${D}/ 300 chown -R "${VHOST_DEFAULT_UID}:${VHOST_DEFAULT_GID}" "${D}/"
120 chmod -R u-s ${D}/ 301 chmod -R u-s "${D}/"
121 chmod -R g-s ${D}/ 302 chmod -R g-s "${D}/"
122}
123 303
304 keepdir "${MY_PERSISTDIR}"
305 fowners "root:root" "${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}"
316}
317
124# ------------------------------------------------------------------------ 318# ------------------------------------------------------------------------
125# EXPORTED FUNCTION - call from inside your ebuild's pkg_setup AFTER 319# EXPORTED FUNCTION - call from inside your ebuild's pkg_config AFTER
126# everything else has run 320# everything else has run
127# 321#
128# If 'vhosts' USE flag is not set, auto-install this app 322# If 'vhosts' USE flag is not set, auto-install this app
129# 323#
130# ------------------------------------------------------------------------ 324# ------------------------------------------------------------------------
131 325
132function webapp_pkg_setup () 326function webapp_pkg_setup ()
133{ 327{
134 use vhosts || webapp-config -u root -d /var/www/localhost/htdocs/${PN}/ ${PN} 328 # add sanity checks here
329
330 if [ "$SLOT+" != "${PVR}+" ]; then
331 die "ebuild sets SLOT, overrides webapp.eclass"
332 fi
333
334 # pull in the shared configuration file
335
336 G_HOSTNAME="localhost"
337 . "${ETC_CONFIG}" || die "Unable to open file ${ETC_CONFIG}"
338
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 ()
375{
376 # are we emerging something that is already installed?
377
378 if [ -d "${D}${MY_APPROOT}/${MY_APPSUFFIX}" ]; then
379 # yes we are
380 ewarn "Removing existing copy of ${PN}-${PVR}"
381 rm -rf "${D}${MY_APPROOT}/${MY_APPSUFFIX}"
382 fi
383}
384
385function webapp_getinstalltype ()
386{
387 # or are we upgrading?
388
389 if ! use vhosts ; then
390 # we only run webapp-config if vhosts USE flag is not set
391
392 local my_output
393
394 my_output="`webapp_check_installedat`"
395
396 if [ "$?" = "0" ] ; then
397 # something is already installed there
398 #
399 # make sure it isn't the same version
400
401 local my_pn="`echo $my_output | awk '{ print $1 }'`"
402 local my_pvr="`echo $my_output | awk '{ print $2 }'`"
403
404 REMOVE_PKG="${my_pn}-${my_pvr}"
405
406 if [ "$my_pn" == "$PN" ]; then
407 if [ "$my_pvr" != "$PVR" ]; then
408 einfo "This is an upgrade"
409 IS_UPGRADE=1
410 else
411 einfo "This is a re-installation"
412 IS_REPLACE=1
413 fi
414 else
415 einfo "$my_ouptut is installed there"
416 fi
417 else
418 einfo "This is an installation"
419 fi
420 fi
421}
422
423function webapp_src_preinst ()
424{
425 # create the directories that we need
426
427 dodir "${MY_HTDOCSDIR}"
428 dodir "${MY_HOSTROOTDIR}"
429 dodir "${MY_CGIBINDIR}"
430 dodir "${MY_ICONSDIR}"
431 dodir "${MY_ERRORSDIR}"
432 dodir "${MY_SQLSCRIPTSDIR}"
433}
434
435function webapp_pkg_postinst ()
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
454 # if 'vhosts' is not set in your USE flags, we install a copy of
455 # this application in /var/www/localhost/htdocs/${PN}/ for you
456
457 if ! use vhosts ; then
458 echo
459 einfo "vhosts USE flag not set - auto-installing using webapp-config"
460
461 webapp_getinstalltype
462
463 G_HOSTNAME="localhost"
464 . "${ETC_CONFIG}"
465
466 local my_mode=-I
467
468 if [ "$IS_REPLACE" = "1" ]; then
469 einfo "${PN}-${PVR} is already installed - replacing"
470 /usr/sbin/webapp-config -C -d "$INSTALL_DIR"
471 elif [ "$IS_UPGRADE" = "1" ]; then
472 einfo "$REMOVE_PKG is already installed - upgrading"
473 my_mode=-U
474 else
475 einfo "${PN}-${PVR} is not installed - using install mode"
476 fi
477
478 my_cmd="/usr/sbin/webapp-config $my_mode -h localhost -u root -d $INSTALL_DIR ${PN} ${PVR}"
479 einfo "Running $my_cmd"
480 $my_cmd
481
482 # remove the old version
483 #
484 # why do we do this? well ...
485 #
486 # normally, emerge -u installs a new version and then removes the
487 # old version. however, if the new version goes into a different
488 # slot to the old version, then the old version gets left behind
489 #
490 # if USE=-vhosts, then we want to remove the old version, because
491 # the user is relying on portage to do the magical thing for it
492
493 if [ "$IS_UPGRADE" = "1" ] ; then
494 einfo "Removing old version $REMOVE_PKG"
495
496 emerge -C "$CATEGORY/$REMOVE_PKG"
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"
513 fi
514
515 return 0
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.1  
changed lines
  Added in v.1.24
  ViewVC Help
Powered by ViewVC 1.1.13