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

Legend:
Removed from v.1.2  
changed lines
  Added in v.1.47

  ViewVC Help
Powered by ViewVC 1.1.20