/[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.35
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.35 2005/07/14 15:38:16 dju 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
17# your changes will be overwritten the next time Stu releases a new version
18# of webapp-config.
18# 19#
19# THIS IS A BETA RELEASE ONLY. ALL DETAILS ARE SUBJECT TO CHANGE BEFORE
20# WE ARE READY TO START PORTING EVERYTHING TO THIS ECLASS
21#
22# ------------------------------------------------------------------------ 20# ------------------------------------------------------------------------
23 21
24ECLASS=webapp
25INHERITED="$INHERITED $ECLASS"
26#DEPEND="${DEPEND} net-www/apache"
27SLOT="${PVR}" 22SLOT="${PVR}"
28IUSE="$IUSE vhosts" 23IUSE="$IUSE vhosts"
24DEPEND="$DEPEND net-www/webapp-config app-portage/gentoolkit"
29 25
30if [ -f /usr/share/webapp-config/settings.sh ] ; then
31 . /usr/share/webapp-config/settings.sh
32fi
33
34EXPORT_FUNCTIONS pkg_setup src_install 26EXPORT_FUNCTIONS pkg_postinst pkg_setup src_install pkg_prerm
27
28INSTALL_DIR="/$PN"
29IS_UPGRADE=0
30IS_REPLACE=0
31
32INSTALL_CHECK_FILE="installed_by_webapp_eclass"
33
34ETC_CONFIG="/etc/vhosts/webapp-config"
35 35
36# ------------------------------------------------------------------------ 36# ------------------------------------------------------------------------
37# INTERNAL FUNCTION - USED BY THIS ECLASS ONLY 37# INTERNAL FUNCTION - USED BY THIS ECLASS ONLY
38# 38#
39# Check whether a specified file exists within the image/ directory 39# Check whether a specified file exists within the image/ directory
40# or not. 40# or not.
41# 41#
42# @param $1 - file to look for 42# @param $1 - file to look for
43# @param $2 - prefix directory to use
43# @return 0 on success, never returns on an error 44# @return 0 on success, never returns on an error
44# ------------------------------------------------------------------------ 45# ------------------------------------------------------------------------
45 46
46function webapp_checkfileexists () 47function webapp_checkfileexists ()
47{ 48{
49 local my_prefix
50
51 [ -n "$2" ] && my_prefix="$2/" || my_prefix=
52
48 if [ ! -e ${D}/$1 ]; then 53 if [ ! -e "${my_prefix}$1" ]; then
49 msg="ebuild fault: file $1 not found in ${D}" 54 msg="ebuild fault: file '$1' not found"
50 eerror "$msg" 55 eerror "$msg"
51 eerror "Please report this as a bug at http://bugs.gentoo.org/" 56 eerror "Please report this as a bug at http://bugs.gentoo.org/"
52 die "$msg" 57 die "$msg"
53 fi 58 fi
54} 59}
55 60
56# ------------------------------------------------------------------------ 61# ------------------------------------------------------------------------
62# INTERNAL FUNCTION - USED BY THIS ECLASS ONLY
63# ------------------------------------------------------------------------
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
76function webapp_import_config ()
77{
78 if [ -z "${MY_HTDOCSDIR}" ]; then
79 . /etc/conf.d/webapp-config
80 fi
81
82 if [ -z "${MY_HTDOCSDIR}" ]; then
83 libsh_edie "/etc/conf.d/webapp-config not imported"
84 fi
85}
86
87# ------------------------------------------------------------------------
88# INTERNAL FUNCTION - USED BY THIS ECLASS ONLY
89#
90# ------------------------------------------------------------------------
91
92function webapp_strip_appdir ()
93{
94 local my_stripped="$1"
95 echo "$1" | sed -e "s|${MY_APPDIR}/||g;"
96}
97
98function webapp_strip_d ()
99{
100 echo "$1" | sed -e "s|${D}||g;"
101}
102
103function webapp_strip_cwd ()
104{
105 local my_stripped="$1"
106 echo "$1" | sed -e 's|/./|/|g;'
107}
108
109# ------------------------------------------------------------------------
110# EXPORTED FUNCTION - FOR USE IN EBUILDS
111#
112# Identify a config file for a web-based application.
113#
114# @param $1 - config file
115# ------------------------------------------------------------------------
116
117function webapp_configfile ()
118{
119 webapp_checkfileexists "$1" "$D"
120
121 local MY_FILE="`webapp_strip_appdir \"$1\"`"
122 MY_FILE="`webapp_strip_cwd \"$MY_FILE\"`"
123
124 einfo "(config) $MY_FILE"
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 "$1"
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`"
144}
145
146# ------------------------------------------------------------------------
147# EXPORTED FUNCTION - FOR USE IN EBUILDS
148#
149# Install a text file containing post-installation instructions.
150#
151# @param $1 - language code (use 'en' for now)
152# @param $2 - the file to install
153# ------------------------------------------------------------------------
154
155function webapp_postinst_txt ()
156{
157 webapp_checkfileexists "$2"
158
159 einfo "(rtfm) $2 (lang: $1)"
160 cp "$2" "${D}${MY_APPDIR}/postinst-$1.txt"
161}
162
163# ------------------------------------------------------------------------
164# EXPORTED FUNCTION - FOR USE IN EBUILDS
165#
166# Install a text file containing post-upgrade instructions.
167#
168# @param $1 - language code (use 'en' for now)
169# @param $2 - the file to install
170# ------------------------------------------------------------------------
171
172function webapp_postupgrade_txt ()
173{
174 webapp_checkfileexists "$2"
175
176 einfo "(rtfm) $2 (lang: $1)"
177 cp "$2" "${D}${MY_APPDIR}/postupgrade-$1.txt"
178}
179
180# ------------------------------------------------------------------------
181# DEPRECATED FUNCTION
182#
183# It never worked anyway
184
185function webapp_runbycgibin ()
186{
187 if [ -n "$WARN_RUNBYCGIBIN" ] ; then
188 return
189 fi
190
191 ewarn "This ebuild uses webapp.eclass's webapp_runbycgibin, which is now"
192 ewarn "deprecated. Please file a bug about this in Bugzilla."
193 WARN_RUNBYCGIBIN=1
194}
195
196# ------------------------------------------------------------------------
57# EXPORTED FUNCTION - FOR USE IN EBUILDS 197# EXPORTED FUNCTION - FOR USE IN EBUILDS
58# 198#
59# Identify a file which must be owned by the webserver's user:group 199# Identify a file which must be owned by the webserver's user:group
60# settings. 200# settings.
61# 201#
62# The ownership of the file is NOT set until the application is installed 202# The ownership of the file is NOT set until the application is installed
63# using the webapp-config tool. 203# using the webapp-config tool.
64# 204#
65# @param $1 - file to be owned by the webserver user:group combo 205# @param $1 - file to be owned by the webserver user:group combo
66# 206#
67# ------------------------------------------------------------------------ 207# ------------------------------------------------------------------------
68 208
69function webapp_serverowned () 209function webapp_serverowned ()
70{ 210{
71 webapp_checkfileexists $1 211 webapp_checkfileexists "$1" "$D"
72 echo "$1" >> $WA_SOLIST 212 local MY_FILE="`webapp_strip_appdir \"$1\"`"
73} 213 MY_FILE="`webapp_strip_cwd \"$MY_FILE\"`"
74 214
75# ------------------------------------------------------------------------ 215 einfo "(server owned) $MY_FILE"
76# EXPORTED FUNCTION - FOR USE IN EBUILDS 216 echo "$MY_FILE" >> "${D}${WA_SOLIST}"
77# 217}
78# Identify a config file for a web-based application.
79#
80# @param $1 - config file
81# ------------------------------------------------------------------------
82 218
219# ------------------------------------------------------------------------
220# EXPORTED FUNCTION - FOR USE IN EBUILDS
221#
222# @param $1 - the webserver to install the config file for
223# (one of apache1, apache2, cherokee)
224# @param $2 - the config file to install
225# @param $3 - new name for the config file (default is `basename $2`)
226# this is an optional parameter
227#
228# NOTE:
229# this function will automagically prepend $1 to the front of your
230# config file's name
231# ------------------------------------------------------------------------
232
83function webapp_configfile () 233function webapp_server_configfile ()
84{ 234{
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 235 webapp_checkfileexists "$2"
105 echo "$1 $2" >> $WA_RUNBYCGIBINLIST 236
237 # sort out what the name will be of the config file
238
239 local my_file
240
241 if [ -z "$3" ]; then
242 my_file="$1-`basename $2`"
243 else
244 my_file="$1-$3"
245 fi
246
247 # warning:
248 #
249 # do NOT change the naming convention used here without changing all
250 # the other scripts that also rely upon these names
251
252 einfo "($1) config file '$my_file'"
253 cp "$2" "${D}${MY_SERVERCONFIGDIR}/${my_file}"
254}
255
256# ------------------------------------------------------------------------
257# EXPORTED FUNCTION - FOR USE IN EBUILDS
258#
259# @param $1 - the db engine that the script is for
260# (one of: mysql|postgres)
261# @param $2 - the sql script to be installed
262# @param $3 - the older version of the app that this db script
263# will upgrade from
264# (do not pass this option if your SQL script only creates
265# a new db from scratch)
266# ------------------------------------------------------------------------
267
268function webapp_sqlscript ()
269{
270 webapp_checkfileexists "$2"
271
272 # create the directory where this script will go
273 #
274 # scripts for specific database engines go into their own subdirectory
275 # just to keep things readable on the filesystem
276
277 if [ ! -d "${D}${MY_SQLSCRIPTSDIR}/$1" ]; then
278 mkdir -p "${D}${MY_SQLSCRIPTSDIR}/$1" || libsh_die "unable to create directory ${D}${MY_SQLSCRIPTSDIR}/$1"
279 fi
280
281 # warning:
282 #
283 # do NOT change the naming convention used here without changing all
284 # the other scripts that also rely upon these names
285
286 # are we dealing with an 'upgrade'-type script?
287 if [ -n "$3" ]; then
288 # yes we are
289 einfo "($1) upgrade script from ${PN}-${PVR} to $3"
290 cp "$2" "${D}${MY_SQLSCRIPTSDIR}/$1/${3}_to_${PVR}.sql"
291 chmod 600 "${D}${MY_SQLSCRIPTSDIR}/$1/${3}_to_${PVR}.sql"
292 else
293 # no, we are not
294 einfo "($1) create script for ${PN}-${PVR}"
295 cp "$2" "${D}${MY_SQLSCRIPTSDIR}/$1/${PVR}_create.sql"
296 chmod 600 "${D}${MY_SQLSCRIPTSDIR}/$1/${PVR}_create.sql"
297 fi
106} 298}
107 299
108# ------------------------------------------------------------------------ 300# ------------------------------------------------------------------------
109# EXPORTED FUNCTION - call from inside your ebuild's src_install AFTER 301# EXPORTED FUNCTION - call from inside your ebuild's src_install AFTER
110# everything else has run 302# everything else has run
… …
114# the final version! 306# the final version!
115# ------------------------------------------------------------------------ 307# ------------------------------------------------------------------------
116 308
117function webapp_src_install () 309function webapp_src_install ()
118{ 310{
119 chown -R root:root ${D}/ 311 chown -R "${VHOST_DEFAULT_UID}:${VHOST_DEFAULT_GID}" "${D}/"
120 chmod -R u-s ${D}/ 312 chmod -R u-s "${D}/"
121 chmod -R g-s ${D}/ 313 chmod -R g-s "${D}/"
122}
123 314
315 keepdir "${MY_PERSISTDIR}"
316 fowners "root:root" "${MY_PERSISTDIR}"
317 fperms 755 "${MY_PERSISTDIR}"
318
319 # to test whether or not the ebuild has correctly called this function
320 # we add an empty file to the filesystem
321 #
322 # we used to just set a variable in the shell script, but we can
323 # no longer rely on Portage calling both webapp_src_install() and
324 # webapp_pkg_postinst() within the same shell process
325
326 touch "${D}/${MY_APPDIR}/${INSTALL_CHECK_FILE}"
327}
328
124# ------------------------------------------------------------------------ 329# ------------------------------------------------------------------------
125# EXPORTED FUNCTION - call from inside your ebuild's pkg_setup AFTER 330# EXPORTED FUNCTION - call from inside your ebuild's pkg_config AFTER
126# everything else has run 331# everything else has run
127# 332#
128# If 'vhosts' USE flag is not set, auto-install this app 333# If 'vhosts' USE flag is not set, auto-install this app
129# 334#
130# ------------------------------------------------------------------------ 335# ------------------------------------------------------------------------
131 336
132function webapp_pkg_setup () 337function webapp_pkg_setup ()
133{ 338{
134 use vhosts || webapp-config -u root -d /var/www/localhost/htdocs/${PN}/ ${PN} 339 # add sanity checks here
340
341 if [ "$SLOT+" != "${PVR}+" ]; then
342 if [ "$WEBAPP_MANUAL_SLOT" != "yes" ]; then
343 die "ebuild sets SLOT, overrides webapp.eclass"
344 fi
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.35
  ViewVC Help
Powered by ViewVC 1.1.17