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

Diff of /eclass/webapp.eclass

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

Revision 1.18 Revision 1.30
1# Copyright 1999-2004 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.18 2004/05/17 22:44:35 stuart Exp $ 3# $Header: /var/cvsroot/gentoo-x86/eclass/webapp.eclass,v 1.30 2005/05/10 22:55:17 beu 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
21 21
22ECLASS=webapp 22ECLASS=webapp
23INHERITED="$INHERITED $ECLASS" 23INHERITED="$INHERITED $ECLASS"
24SLOT="${PVR}" 24SLOT="${PVR}"
25IUSE="$IUSE vhosts" 25IUSE="$IUSE vhosts"
26DEPEND="$DEPEND >=net-www/webapp-config-1.9 app-portage/gentoolkit" 26DEPEND="$DEPEND >=net-www/webapp-config-1.10-r14 app-portage/gentoolkit"
27 27
28EXPORT_FUNCTIONS pkg_postinst pkg_setup src_install pkg_prerm 28EXPORT_FUNCTIONS pkg_postinst pkg_setup src_install pkg_prerm
29 29
30INSTALL_DIR="/$PN" 30INSTALL_DIR="/$PN"
31IS_UPGRADE=0 31IS_UPGRADE=0
32IS_REPLACE=0 32IS_REPLACE=0
33 33
34INSTALL_CHECK_FILE="installed_by_webapp_eclass"
35
36ETC_CONFIG="/etc/vhosts/webapp-config"
37
34# ------------------------------------------------------------------------ 38# ------------------------------------------------------------------------
35# INTERNAL FUNCTION - USED BY THIS ECLASS ONLY 39# INTERNAL FUNCTION - USED BY THIS ECLASS ONLY
36# 40#
37# Check whether a specified file exists within the image/ directory 41# Check whether a specified file exists within the image/ directory
38# or not. 42# or not.
46{ 50{
47 local my_prefix 51 local my_prefix
48 52
49 [ -n "$2" ] && my_prefix="$2/" || my_prefix= 53 [ -n "$2" ] && my_prefix="$2/" || my_prefix=
50 54
51 if [ ! -e ${my_prefix}$1 ]; then 55 if [ ! -e "${my_prefix}$1" ]; then
52 msg="ebuild fault: file $1 not found" 56 msg="ebuild fault: file '$1' not found"
53 eerror "$msg" 57 eerror "$msg"
54 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/"
55 die "$msg" 59 die "$msg"
56 fi 60 fi
57} 61}
62 66
63function webapp_check_installedat 67function webapp_check_installedat
64{ 68{
65 local my_output 69 local my_output
66 70
67 /usr/sbin/webapp-config --show-installed -h localhost -d $INSTALL_DIR 2> /dev/null 71 /usr/sbin/webapp-config --show-installed -h localhost -d "$INSTALL_DIR" 2> /dev/null
68} 72}
69 73
70# ------------------------------------------------------------------------ 74# ------------------------------------------------------------------------
71# INTERNAL FUNCTION - USED BY THIS ECLASS ONLY 75# INTERNAL FUNCTION - USED BY THIS ECLASS ONLY
72# ------------------------------------------------------------------------ 76# ------------------------------------------------------------------------
113# ------------------------------------------------------------------------ 117# ------------------------------------------------------------------------
114 118
115function webapp_configfile () 119function webapp_configfile ()
116{ 120{
117 webapp_checkfileexists "$1" "$D" 121 webapp_checkfileexists "$1" "$D"
118 echo $1 122
119 local MY_FILE="`webapp_strip_appdir $1`" 123 local MY_FILE="`webapp_strip_appdir \"$1\"`"
120 echo $MY_FILE 124 MY_FILE="`webapp_strip_cwd \"$MY_FILE\"`"
121 125
122 einfo "(config) $MY_FILE" 126 einfo "(config) $MY_FILE"
123 echo "$MY_FILE" >> ${D}${WA_CONFIGLIST} 127 echo "$MY_FILE" >> ${D}${WA_CONFIGLIST}
124} 128}
125 129
132# @param $1 - the script to run 136# @param $1 - the script to run
133# ------------------------------------------------------------------------ 137# ------------------------------------------------------------------------
134 138
135function webapp_hook_script () 139function webapp_hook_script ()
136{ 140{
137 webapp_checkfileexists "$2" 141 webapp_checkfileexists "$1"
138 142
139 einfo "(hook) $1" 143 einfo "(hook) $1"
140 cp "$1" "${D}${MY_HOOKSCRIPTSDIR}/`basename $1`" || die "Unable to install $1 into ${D}${MY_HOOKSCRIPTSDIR}/" 144 cp "$1" "${D}${MY_HOOKSCRIPTSDIR}/`basename $1`" || die "Unable to install $1 into ${D}${MY_HOOKSCRIPTSDIR}/"
141 chmod 555 "${D}${MY_HOOKSCRIPTSDIR}/`basename $1`" 145 chmod 555 "${D}${MY_HOOKSCRIPTSDIR}/`basename $1`"
142} 146}
172# ------------------------------------------------------------------------ 176# ------------------------------------------------------------------------
173 177
174function webapp_runbycgibin () 178function webapp_runbycgibin ()
175{ 179{
176 webapp_checkfileexists "$2" "$D" 180 webapp_checkfileexists "$2" "$D"
177 local MY_FILE="`webapp_strip_appdir $2`" 181 local MY_FILE="`webapp_strip_appdir \"$2\"`"
178 MY_FILE="`webapp_strip_cwd $MY_FILE`" 182 MY_FILE="`webapp_strip_cwd \"$MY_FILE\"`"
179 183
180 einfo "(cgi-bin) $1 - $MY_FILE" 184 einfo "(cgi-bin) $1 - $MY_FILE"
181 echo "$1 $MY_FILE" >> ${D}${WA_RUNBYCGIBINLIST} 185 echo "\"$1\" \"$MY_FILE\"" >> "${D}${WA_RUNBYCGIBINLIST}"
182} 186}
183 187
184# ------------------------------------------------------------------------ 188# ------------------------------------------------------------------------
185# EXPORTED FUNCTION - FOR USE IN EBUILDS 189# EXPORTED FUNCTION - FOR USE IN EBUILDS
186# 190#
195# ------------------------------------------------------------------------ 199# ------------------------------------------------------------------------
196 200
197function webapp_serverowned () 201function webapp_serverowned ()
198{ 202{
199 webapp_checkfileexists "$1" "$D" 203 webapp_checkfileexists "$1" "$D"
200 local MY_FILE="`webapp_strip_appdir $1`" 204 local MY_FILE="`webapp_strip_appdir \"$1\"`"
205 MY_FILE="`webapp_strip_cwd \"$MY_FILE\"`"
201 206
202 einfo "(server owned) $MY_FILE" 207 einfo "(server owned) $MY_FILE"
203 echo "$MY_FILE" >> ${D}${WA_SOLIST} 208 echo "$MY_FILE" >> "${D}${WA_SOLIST}"
204} 209}
205 210
206# ------------------------------------------------------------------------ 211# ------------------------------------------------------------------------
207# EXPORTED FUNCTION - FOR USE IN EBUILDS 212# EXPORTED FUNCTION - FOR USE IN EBUILDS
208# 213#
215# NOTE: 220# NOTE:
216# this function will automagically prepend $1 to the front of your 221# this function will automagically prepend $1 to the front of your
217# config file's name 222# config file's name
218# ------------------------------------------------------------------------ 223# ------------------------------------------------------------------------
219 224
220function webapp_server_config () 225function webapp_server_configfile ()
221{ 226{
222 webapp_checkfileexists "$2" 227 webapp_checkfileexists "$2"
223 228
224 # sort out what the name will be of the config file 229 # sort out what the name will be of the config file
225 230
226 local my_file 231 local my_file
227 232
228 if [ -z "$3" ]; then 233 if [ -z "$3" ]; then
229 $my_file="$1-`basename $2`" 234 my_file="$1-`basename $2`"
230 else 235 else
231 $my_file="$1-$3" 236 my_file="$1-$3"
232 fi 237 fi
233 238
234 # warning: 239 # warning:
235 # 240 #
236 # do NOT change the naming convention used here without changing all 241 # do NOT change the naming convention used here without changing all
272 277
273 # are we dealing with an 'upgrade'-type script? 278 # are we dealing with an 'upgrade'-type script?
274 if [ -n "$3" ]; then 279 if [ -n "$3" ]; then
275 # yes we are 280 # yes we are
276 einfo "($1) upgrade script from ${PN}-${PVR} to $3" 281 einfo "($1) upgrade script from ${PN}-${PVR} to $3"
277 cp $2 ${D}${MY_SQLSCRIPTSDIR}/$1/${3}_to_${PVR}.sql 282 cp "$2" "${D}${MY_SQLSCRIPTSDIR}/$1/${3}_to_${PVR}.sql"
278 else 283 else
279 # no, we are not 284 # no, we are not
280 einfo "($1) create script for ${PN}-${PVR}" 285 einfo "($1) create script for ${PN}-${PVR}"
281 cp $2 ${D}${MY_SQLSCRIPTSDIR}/$1/${PVR}_create.sql 286 cp "$2" "${D}${MY_SQLSCRIPTSDIR}/$1/${PVR}_create.sql"
282 fi 287 fi
283} 288}
284 289
285# ------------------------------------------------------------------------ 290# ------------------------------------------------------------------------
286# EXPORTED FUNCTION - call from inside your ebuild's src_install AFTER 291# EXPORTED FUNCTION - call from inside your ebuild's src_install AFTER
291# the final version! 296# the final version!
292# ------------------------------------------------------------------------ 297# ------------------------------------------------------------------------
293 298
294function webapp_src_install () 299function webapp_src_install ()
295{ 300{
296 chown -R ${VHOST_DEFAULT_UID}:${VHOST_DEFAULT_GID} ${D}/ 301 chown -R "${VHOST_DEFAULT_UID}:${VHOST_DEFAULT_GID}" "${D}/"
297 chmod -R u-s ${D}/ 302 chmod -R u-s "${D}/"
298 chmod -R g-s ${D}/ 303 chmod -R g-s "${D}/"
299 304
300 keepdir ${MY_PERSISTDIR} 305 keepdir "${MY_PERSISTDIR}"
301 fowners root:root ${MY_PERSISTDIR} 306 fowners "root:root" "${MY_PERSISTDIR}"
302 fperms 755 ${MY_PERSISTDIR} 307 fperms 755 "${MY_PERSISTDIR}"
303 308
304 HAS_webapp_src_install=1 309 # to test whether or not the ebuild has correctly called this function
310 # we add an empty file to the filesystem
311 #
312 # we used to just set a variable in the shell script, but we can
313 # no longer rely on Portage calling both webapp_src_install() and
314 # webapp_pkg_postinst() within the same shell process
315
316 touch "${D}/${MY_APPDIR}/${INSTALL_CHECK_FILE}"
305} 317}
306 318
307# ------------------------------------------------------------------------ 319# ------------------------------------------------------------------------
308# EXPORTED FUNCTION - call from inside your ebuild's pkg_config AFTER 320# EXPORTED FUNCTION - call from inside your ebuild's pkg_config AFTER
309# everything else has run 321# everything else has run
321 fi 333 fi
322 334
323 # pull in the shared configuration file 335 # pull in the shared configuration file
324 336
325 G_HOSTNAME="localhost" 337 G_HOSTNAME="localhost"
326 . /etc/vhosts/webapp-config || die "Unable to open /etc/vhosts/webapp-config file" 338 . "${ETC_CONFIG}" || die "Unable to open file ${ETC_CONFIG}"
327 339
328 # are we installing a webapp-config solution over the top of a 340 # are we installing a webapp-config solution over the top of a
329 # non-webapp-config solution? 341 # non-webapp-config solution?
330 342
331 if ! use vhosts ; then 343 if ! use vhosts ; then
343 # okay, whatever is there, it isn't webapp-config-compatible 355 # okay, whatever is there, it isn't webapp-config-compatible
344 ewarn 356 ewarn
345 ewarn "Whatever is in $my_dir, it's not" 357 ewarn "Whatever is in $my_dir, it's not"
346 ewarn "compatible with webapp-config." 358 ewarn "compatible with webapp-config."
347 ewarn 359 ewarn
348 360 ewarn "This ebuild may be overwriting important files."
349 my_output="`qpkg -nc -v -f $my_dir`" 361 ewarn
350 if [ -n "$my_output" ]; then
351 eerror "Please remove $my_output and re-emerge."
352 else
353 eerror "Please remove the contents of $my_dir, and then re-emerge."
354 fi
355 die "Cannot upgrade contents of $my_dir"
356 elif [ "`echo $my_output | awk '{ print $1 }'`" != "$PN" ]; then 362 elif [ "`echo $my_output | awk '{ print $1 }'`" != "$PN" ]; then
357 eerror "$my_dir contains $my_output" 363 eerror "$my_dir contains $my_output"
358 eerror "I cannot upgrade that" 364 eerror "I cannot upgrade that"
359 die "Cannot upgrade contents of $my_dir" 365 die "Cannot upgrade contents of $my_dir"
360 else 366 else
417 423
418function webapp_src_preinst () 424function webapp_src_preinst ()
419{ 425{
420 # create the directories that we need 426 # create the directories that we need
421 427
422 dodir ${MY_HTDOCSDIR} 428 dodir "${MY_HTDOCSDIR}"
423 dodir ${MY_HOSTROOTDIR} 429 dodir "${MY_HOSTROOTDIR}"
424 dodir ${MY_CGIBINDIR} 430 dodir "${MY_CGIBINDIR}"
425 dodir ${MY_ICONSDIR} 431 dodir "${MY_ICONSDIR}"
426 dodir ${MY_ERRORSDIR} 432 dodir "${MY_ERRORSDIR}"
427 dodir ${MY_SQLSCRIPTSDIR} 433 dodir "${MY_SQLSCRIPTSDIR}"
434 dodir "${MY_HOOKSCRIPTSDIR}"
435 dodir "${MY_SERVERCONFIGDIR}"
428} 436}
429 437
430function webapp_pkg_postinst () 438function webapp_pkg_postinst ()
431{ 439{
440 . "${ETC_CONFIG}"
441
432 # sanity checks, to catch bugs in the ebuild 442 # sanity checks, to catch bugs in the ebuild
433 443
434 if [ "$HAS_webapp_src_install+" == "+" ]; then 444 if [ ! -f "${MY_APPDIR}/${INSTALL_CHECK_FILE}" ]; then
435 eerror 445 eerror
436 eerror "This ebuild did not call webapp_src_install() at the end" 446 eerror "This ebuild did not call webapp_src_install() at the end"
437 eerror "of the src_install() function" 447 eerror "of the src_install() function"
438 eerror 448 eerror
439 eerror "Please log a bug on http://bugs.gentoo.org" 449 eerror "Please log a bug on http://bugs.gentoo.org"
452 einfo "vhosts USE flag not set - auto-installing using webapp-config" 462 einfo "vhosts USE flag not set - auto-installing using webapp-config"
453 463
454 webapp_getinstalltype 464 webapp_getinstalltype
455 465
456 G_HOSTNAME="localhost" 466 G_HOSTNAME="localhost"
457 . /etc/vhosts/webapp-config 467 . "${ETC_CONFIG}"
458 468
459 local my_mode=-I 469 local my_mode=-I
460 470
461 if [ "$IS_REPLACE" = "1" ]; then 471 if [ "$IS_REPLACE" = "1" ]; then
462 einfo "${PN}-${PVR} is already installed - replacing" 472 einfo "${PN}-${PVR} is already installed - replacing"
463 /usr/sbin/webapp-config -C -d "$INSTALL_DIR" 473 my_mode=-I
464 elif [ "$IS_UPGRADE" = "1" ]; then 474 elif [ "$IS_UPGRADE" = "1" ]; then
465 einfo "$REMOVE_PKG is already installed - upgrading" 475 einfo "$REMOVE_PKG is already installed - upgrading"
466 my_mode=-U 476 my_mode=-U
467 else 477 else
468 einfo "${PN}-${PVR} is not installed - using install mode" 478 einfo "${PN}-${PVR} is not installed - using install mode"
484 # the user is relying on portage to do the magical thing for it 494 # the user is relying on portage to do the magical thing for it
485 495
486 if [ "$IS_UPGRADE" = "1" ] ; then 496 if [ "$IS_UPGRADE" = "1" ] ; then
487 einfo "Removing old version $REMOVE_PKG" 497 einfo "Removing old version $REMOVE_PKG"
488 498
489 emerge -C $CATEGORY/$REMOVE_PKG 499 emerge -C "$REMOVE_PKG"
490 fi 500 fi
491 else 501 else
492 # vhosts flag is on 502 # vhosts flag is on
493 # 503 #
494 # let's tell the administrator what to do next 504 # let's tell the administrator what to do next

Legend:
Removed from v.1.18  
changed lines
  Added in v.1.30

  ViewVC Help
Powered by ViewVC 1.1.20