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

Diff of /eclass/webapp.eclass

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

Revision 1.2 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.2 2003/12/22 23:15:46 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!
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 /etc/conf.d/webapp-config ] ; then
31 . /etc/conf.d/webapp-config
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 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
59}
60
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 echo $1
121 local MY_FILE="`webapp_strip_appdir $1`"
122 echo $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 "$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`"
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# Identify a script file (usually, but not always PHP or Perl) which is
167#
168# Files in this list may be modified to #! the required CGI engine when
169# installed by webapp-config tool in the future.
170#
171# @param $1 - the cgi engine to use
172# @param $2 - the script file that could run under a cgi-bin
173#
174# ------------------------------------------------------------------------
175
176function webapp_runbycgibin ()
177{
178 webapp_checkfileexists "$2" "$D"
179 local MY_FILE="`webapp_strip_appdir $2`"
180 MY_FILE="`webapp_strip_cwd $MY_FILE`"
181
182 einfo "(cgi-bin) $1 - $MY_FILE"
183 echo "$1 $MY_FILE" >> ${D}${WA_RUNBYCGIBINLIST}
54} 184}
55 185
56# ------------------------------------------------------------------------ 186# ------------------------------------------------------------------------
57# EXPORTED FUNCTION - FOR USE IN EBUILDS 187# EXPORTED FUNCTION - FOR USE IN EBUILDS
58# 188#
66# 196#
67# ------------------------------------------------------------------------ 197# ------------------------------------------------------------------------
68 198
69function webapp_serverowned () 199function webapp_serverowned ()
70{ 200{
71 webapp_checkfileexists $1 201 webapp_checkfileexists "$1" "$D"
202 local MY_FILE="`webapp_strip_appdir $1`"
203
204 einfo "(server owned) $MY_FILE"
72 echo "$1" >> $WA_SOLIST 205 echo "$MY_FILE" >> ${D}${WA_SOLIST}
73} 206}
74 207
75# ------------------------------------------------------------------------ 208# ------------------------------------------------------------------------
76# EXPORTED FUNCTION - FOR USE IN EBUILDS 209# EXPORTED FUNCTION - FOR USE IN EBUILDS
77# 210#
78# Identify a config file for a web-based application. 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
79# 216#
80# @param $1 - config file 217# NOTE:
218# this function will automagically prepend $1 to the front of your
219# config file's name
81# ------------------------------------------------------------------------ 220# ------------------------------------------------------------------------
82 221
83function webapp_configfile () 222function webapp_server_config ()
84{ 223{
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 224 webapp_checkfileexists "$2"
105 echo "$1 $2" >> $WA_RUNBYCGIBINLIST 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
247#
248# @param $1 - the db engine that the script is for
249# (one of: mysql|postgres)
250# @param $2 - the sql script to be installed
251# @param $3 - the older version of the app that this db script
252# will upgrade from
253# (do not pass this option if your SQL script only creates
254# a new db from scratch)
255# ------------------------------------------------------------------------
256
257function webapp_sqlscript ()
258{
259 webapp_checkfileexists "$2"
260
261 # create the directory where this script will go
262 #
263 # scripts for specific database engines go into their own subdirectory
264 # just to keep things readable on the filesystem
265
266 if [ ! -d "${D}${MY_SQLSCRIPTSDIR}/$1" ]; then
267 mkdir -p "${D}${MY_SQLSCRIPTSDIR}/$1" || libsh_die "unable to create directory ${D}${MY_SQLSCRIPTSDIR}/$1"
268 fi
269
270 # warning:
271 #
272 # do NOT change the naming convention used here without changing all
273 # the other scripts that also rely upon these names
274
275 # are we dealing with an 'upgrade'-type script?
276 if [ -n "$3" ]; then
277 # yes we are
278 einfo "($1) upgrade script from ${PN}-${PVR} to $3"
279 cp $2 ${D}${MY_SQLSCRIPTSDIR}/$1/${3}_to_${PVR}.sql
280 else
281 # no, we are not
282 einfo "($1) create script for ${PN}-${PVR}"
283 cp $2 ${D}${MY_SQLSCRIPTSDIR}/$1/${PVR}_create.sql
284 fi
106} 285}
107 286
108# ------------------------------------------------------------------------ 287# ------------------------------------------------------------------------
109# EXPORTED FUNCTION - call from inside your ebuild's src_install AFTER 288# EXPORTED FUNCTION - call from inside your ebuild's src_install AFTER
110# everything else has run 289# everything else has run
114# the final version! 293# the final version!
115# ------------------------------------------------------------------------ 294# ------------------------------------------------------------------------
116 295
117function webapp_src_install () 296function webapp_src_install ()
118{ 297{
119 chown -R root:root ${D}/ 298 chown -R ${VHOST_DEFAULT_UID}:${VHOST_DEFAULT_GID} ${D}/
120 chmod -R u-s ${D}/ 299 chmod -R u-s ${D}/
121 chmod -R g-s ${D}/ 300 chmod -R g-s ${D}/
122}
123 301
302 keepdir ${MY_PERSISTDIR}
303 fowners root:root ${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}
314}
315
124# ------------------------------------------------------------------------ 316# ------------------------------------------------------------------------
125# EXPORTED FUNCTION - call from inside your ebuild's pkg_setup AFTER 317# EXPORTED FUNCTION - call from inside your ebuild's pkg_config AFTER
126# everything else has run 318# everything else has run
127# 319#
128# If 'vhosts' USE flag is not set, auto-install this app 320# If 'vhosts' USE flag is not set, auto-install this app
129# 321#
130# ------------------------------------------------------------------------ 322# ------------------------------------------------------------------------
131 323
132function webapp_pkg_setup () 324function webapp_pkg_setup ()
133{ 325{
134 use vhosts || webapp-config -u root -d /var/www/localhost/htdocs/${PN}/ ${PN} 326 # add sanity checks here
327
328 if [ "$SLOT+" != "${PVR}+" ]; then
329 die "ebuild sets SLOT, overrides webapp.eclass"
330 fi
331
332 # pull in the shared configuration file
333
334 G_HOSTNAME="localhost"
335 . /etc/vhosts/webapp-config || die "Unable to open /etc/vhosts/webapp-config file"
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
135} 370}
371
372function webapp_someunusedfunction ()
373{
374 # are we emerging something that is already installed?
375
376 if [ -d "${D}${MY_APPROOT}/${MY_APPSUFFIX}" ]; then
377 # yes we are
378 ewarn "Removing existing copy of ${PN}-${PVR}"
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
418 fi
419}
420
421function webapp_src_preinst ()
422{
423 # create the directories that we need
424
425 dodir ${MY_HTDOCSDIR}
426 dodir ${MY_HOSTROOTDIR}
427 dodir ${MY_CGIBINDIR}
428 dodir ${MY_ICONSDIR}
429 dodir ${MY_ERRORSDIR}
430 dodir ${MY_SQLSCRIPTSDIR}
431}
432
433function webapp_pkg_postinst ()
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
459 G_HOSTNAME="localhost"
460 . /etc/vhosts/webapp-config
461
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
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.2  
changed lines
  Added in v.1.20

  ViewVC Help
Powered by ViewVC 1.1.20