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

Diff of /eclass/webapp.eclass

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

Revision 1.21 Revision 1.31
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.21 2004/05/25 10:22:02 stuart Exp $ 3# $Header: /var/cvsroot/gentoo-x86/eclass/webapp.eclass,v 1.31 2005/05/30 21:44:17 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
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.7 app-portage/gentoolkit" 26DEPEND="$DEPEND net-www/webapp-config 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
50{ 50{
51 local my_prefix 51 local my_prefix
52 52
53 [ -n "$2" ] && my_prefix="$2/" || my_prefix= 53 [ -n "$2" ] && my_prefix="$2/" || my_prefix=
54 54
55 if [ ! -e ${my_prefix}$1 ]; then 55 if [ ! -e "${my_prefix}$1" ]; then
56 msg="ebuild fault: file $1 not found" 56 msg="ebuild fault: file '$1' not found"
57 eerror "$msg" 57 eerror "$msg"
58 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/"
59 die "$msg" 59 die "$msg"
60 fi 60 fi
61} 61}
66 66
67function webapp_check_installedat 67function webapp_check_installedat
68{ 68{
69 local my_output 69 local my_output
70 70
71 /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
72} 72}
73 73
74# ------------------------------------------------------------------------ 74# ------------------------------------------------------------------------
75# INTERNAL FUNCTION - USED BY THIS ECLASS ONLY 75# INTERNAL FUNCTION - USED BY THIS ECLASS ONLY
76# ------------------------------------------------------------------------ 76# ------------------------------------------------------------------------
117# ------------------------------------------------------------------------ 117# ------------------------------------------------------------------------
118 118
119function webapp_configfile () 119function webapp_configfile ()
120{ 120{
121 webapp_checkfileexists "$1" "$D" 121 webapp_checkfileexists "$1" "$D"
122 echo $1 122
123 local MY_FILE="`webapp_strip_appdir $1`" 123 local MY_FILE="`webapp_strip_appdir \"$1\"`"
124 echo $MY_FILE 124 MY_FILE="`webapp_strip_cwd \"$MY_FILE\"`"
125 125
126 einfo "(config) $MY_FILE" 126 einfo "(config) $MY_FILE"
127 echo "$MY_FILE" >> ${D}${WA_CONFIGLIST} 127 echo "$MY_FILE" >> ${D}${WA_CONFIGLIST}
128} 128}
129 129
136# @param $1 - the script to run 136# @param $1 - the script to run
137# ------------------------------------------------------------------------ 137# ------------------------------------------------------------------------
138 138
139function webapp_hook_script () 139function webapp_hook_script ()
140{ 140{
141 webapp_checkfileexists "$2" 141 webapp_checkfileexists "$1"
142 142
143 einfo "(hook) $1" 143 einfo "(hook) $1"
144 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}/"
145 chmod 555 "${D}${MY_HOOKSCRIPTSDIR}/`basename $1`" 145 chmod 555 "${D}${MY_HOOKSCRIPTSDIR}/`basename $1`"
146} 146}
152# 152#
153# @param $1 - language code (use 'en' for now) 153# @param $1 - language code (use 'en' for now)
154# @param $2 - the file to install 154# @param $2 - the file to install
155# ------------------------------------------------------------------------ 155# ------------------------------------------------------------------------
156 156
157function webapp_postinst_txt 157function webapp_postinst_txt ()
158{ 158{
159 webapp_checkfileexists "$2" 159 webapp_checkfileexists "$2"
160 160
161 einfo "(rtfm) $2 (lang: $1)" 161 einfo "(rtfm) $2 (lang: $1)"
162 cp "$2" "${D}${MY_APPDIR}/postinst-$1.txt" 162 cp "$2" "${D}${MY_APPDIR}/postinst-$1.txt"
163} 163}
164 164
165# ------------------------------------------------------------------------ 165# ------------------------------------------------------------------------
166# EXPORTED FUNCTION - FOR USE IN EBUILDS 166# EXPORTED FUNCTION - FOR USE IN EBUILDS
167# 167#
168# Identify a script file (usually, but not always PHP or Perl) which is 168# Install a text file containing post-upgrade instructions.
169# 169#
170# Files in this list may be modified to #! the required CGI engine when 170# @param $1 - language code (use 'en' for now)
171# installed by webapp-config tool in the future. 171# @param $2 - the file to install
172#
173# @param $1 - the cgi engine to use
174# @param $2 - the script file that could run under a cgi-bin
175#
176# ------------------------------------------------------------------------ 172# ------------------------------------------------------------------------
173
174function webapp_postupgrade_txt ()
175{
176 webapp_checkfileexists "$2"
177
178 einfo "(rtfm) $2 (lang: $1)"
179 cp "$2" "${D}${MY_APPDIR}/postupgrade-$1.txt"
180}
181
182# ------------------------------------------------------------------------
183# DEPRECATED FUNCTION
184#
185# It never worked anyway
177 186
178function webapp_runbycgibin () 187function webapp_runbycgibin ()
179{ 188{
180 webapp_checkfileexists "$2" "$D" 189 if [ -n "$WARN_RUNBYCGIBIN" ] ; then
181 local MY_FILE="`webapp_strip_appdir $2`" 190 return
182 MY_FILE="`webapp_strip_cwd $MY_FILE`" 191 fi
183 192
184 einfo "(cgi-bin) $1 - $MY_FILE" 193 ewarn "This ebuild uses webapp.eclass's webapp_runbycgibin, which is now"
185 echo "$1 $MY_FILE" >> ${D}${WA_RUNBYCGIBINLIST} 194 ewarn "deprecated. Please file a bug about this in Bugzilla."
195 WARN_RUNBYCGIBIN=1
186} 196}
187 197
188# ------------------------------------------------------------------------ 198# ------------------------------------------------------------------------
189# EXPORTED FUNCTION - FOR USE IN EBUILDS 199# EXPORTED FUNCTION - FOR USE IN EBUILDS
190# 200#
199# ------------------------------------------------------------------------ 209# ------------------------------------------------------------------------
200 210
201function webapp_serverowned () 211function webapp_serverowned ()
202{ 212{
203 webapp_checkfileexists "$1" "$D" 213 webapp_checkfileexists "$1" "$D"
204 local MY_FILE="`webapp_strip_appdir $1`" 214 local MY_FILE="`webapp_strip_appdir \"$1\"`"
215 MY_FILE="`webapp_strip_cwd \"$MY_FILE\"`"
205 216
206 einfo "(server owned) $MY_FILE" 217 einfo "(server owned) $MY_FILE"
207 echo "$MY_FILE" >> ${D}${WA_SOLIST} 218 echo "$MY_FILE" >> "${D}${WA_SOLIST}"
208} 219}
209 220
210# ------------------------------------------------------------------------ 221# ------------------------------------------------------------------------
211# EXPORTED FUNCTION - FOR USE IN EBUILDS 222# EXPORTED FUNCTION - FOR USE IN EBUILDS
212# 223#
219# NOTE: 230# NOTE:
220# this function will automagically prepend $1 to the front of your 231# this function will automagically prepend $1 to the front of your
221# config file's name 232# config file's name
222# ------------------------------------------------------------------------ 233# ------------------------------------------------------------------------
223 234
224function webapp_server_config () 235function webapp_server_configfile ()
225{ 236{
226 webapp_checkfileexists "$2" 237 webapp_checkfileexists "$2"
227 238
228 # sort out what the name will be of the config file 239 # sort out what the name will be of the config file
229 240
230 local my_file 241 local my_file
231 242
232 if [ -z "$3" ]; then 243 if [ -z "$3" ]; then
233 $my_file="$1-`basename $2`" 244 my_file="$1-`basename $2`"
234 else 245 else
235 $my_file="$1-$3" 246 my_file="$1-$3"
236 fi 247 fi
237 248
238 # warning: 249 # warning:
239 # 250 #
240 # do NOT change the naming convention used here without changing all 251 # do NOT change the naming convention used here without changing all
276 287
277 # are we dealing with an 'upgrade'-type script? 288 # are we dealing with an 'upgrade'-type script?
278 if [ -n "$3" ]; then 289 if [ -n "$3" ]; then
279 # yes we are 290 # yes we are
280 einfo "($1) upgrade script from ${PN}-${PVR} to $3" 291 einfo "($1) upgrade script from ${PN}-${PVR} to $3"
281 cp $2 ${D}${MY_SQLSCRIPTSDIR}/$1/${3}_to_${PVR}.sql 292 cp "$2" "${D}${MY_SQLSCRIPTSDIR}/$1/${3}_to_${PVR}.sql"
293 chmod 600 "${D}${MY_SQLSCRIPTSDIR}/$1/${3}_to_${PVR}.sql"
282 else 294 else
283 # no, we are not 295 # no, we are not
284 einfo "($1) create script for ${PN}-${PVR}" 296 einfo "($1) create script for ${PN}-${PVR}"
285 cp $2 ${D}${MY_SQLSCRIPTSDIR}/$1/${PVR}_create.sql 297 cp "$2" "${D}${MY_SQLSCRIPTSDIR}/$1/${PVR}_create.sql"
298 chmod 600 "${D}${MY_SQLSCRIPTSDIR}/$1/${PVR}_create.sql"
286 fi 299 fi
287} 300}
288 301
289# ------------------------------------------------------------------------ 302# ------------------------------------------------------------------------
290# EXPORTED FUNCTION - call from inside your ebuild's src_install AFTER 303# EXPORTED FUNCTION - call from inside your ebuild's src_install AFTER
295# the final version! 308# the final version!
296# ------------------------------------------------------------------------ 309# ------------------------------------------------------------------------
297 310
298function webapp_src_install () 311function webapp_src_install ()
299{ 312{
300 chown -R ${VHOST_DEFAULT_UID}:${VHOST_DEFAULT_GID} ${D}/ 313 chown -R "${VHOST_DEFAULT_UID}:${VHOST_DEFAULT_GID}" "${D}/"
301 chmod -R u-s ${D}/ 314 chmod -R u-s "${D}/"
302 chmod -R g-s ${D}/ 315 chmod -R g-s "${D}/"
303 316
304 keepdir ${MY_PERSISTDIR} 317 keepdir "${MY_PERSISTDIR}"
305 fowners root:root ${MY_PERSISTDIR} 318 fowners "root:root" "${MY_PERSISTDIR}"
306 fperms 755 ${MY_PERSISTDIR} 319 fperms 755 "${MY_PERSISTDIR}"
307 320
308 # to test whether or not the ebuild has correctly called this function 321 # to test whether or not the ebuild has correctly called this function
309 # we add an empty file to the filesystem 322 # we add an empty file to the filesystem
310 # 323 #
311 # we used to just set a variable in the shell script, but we can 324 # 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 325 # no longer rely on Portage calling both webapp_src_install() and
313 # webapp_pkg_postinst() within the same shell process 326 # webapp_pkg_postinst() within the same shell process
314 327
315 touch ${D}/${MY_APPDIR}/${INSTALL_CHECK_FILE} 328 touch "${D}/${MY_APPDIR}/${INSTALL_CHECK_FILE}"
316} 329}
317 330
318# ------------------------------------------------------------------------ 331# ------------------------------------------------------------------------
319# EXPORTED FUNCTION - call from inside your ebuild's pkg_config AFTER 332# EXPORTED FUNCTION - call from inside your ebuild's pkg_config AFTER
320# everything else has run 333# everything else has run
332 fi 345 fi
333 346
334 # pull in the shared configuration file 347 # pull in the shared configuration file
335 348
336 G_HOSTNAME="localhost" 349 G_HOSTNAME="localhost"
337 . ${ETC_CONFIG} || die "Unable to open /etc/vhosts/webapp-config file" 350 . "${ETC_CONFIG}" || die "Unable to open file ${ETC_CONFIG}"
338 351
339 # are we installing a webapp-config solution over the top of a 352 # are we installing a webapp-config solution over the top of a
340 # non-webapp-config solution? 353 # non-webapp-config solution?
341 354
342 if ! use vhosts ; then 355 if ! use vhosts ; then
422 435
423function webapp_src_preinst () 436function webapp_src_preinst ()
424{ 437{
425 # create the directories that we need 438 # create the directories that we need
426 439
427 dodir ${MY_HTDOCSDIR} 440 dodir "${MY_HTDOCSDIR}"
428 dodir ${MY_HOSTROOTDIR} 441 dodir "${MY_HOSTROOTDIR}"
429 dodir ${MY_CGIBINDIR} 442 dodir "${MY_CGIBINDIR}"
430 dodir ${MY_ICONSDIR} 443 dodir "${MY_ICONSDIR}"
431 dodir ${MY_ERRORSDIR} 444 dodir "${MY_ERRORSDIR}"
432 dodir ${MY_SQLSCRIPTSDIR} 445 dodir "${MY_SQLSCRIPTSDIR}"
446 dodir "${MY_HOOKSCRIPTSDIR}"
447 dodir "${MY_SERVERCONFIGDIR}"
433} 448}
434 449
435function webapp_pkg_postinst () 450function webapp_pkg_postinst ()
436{ 451{
437 . ${ETC_CONFIG} 452 . "${ETC_CONFIG}"
438 453
439 # sanity checks, to catch bugs in the ebuild 454 # sanity checks, to catch bugs in the ebuild
440 455
441 if [ ! -f ${MY_APPDIR}/${INSTALL_CHECK_FILE} ]; then 456 if [ ! -f "${MY_APPDIR}/${INSTALL_CHECK_FILE}" ]; then
442 eerror 457 eerror
443 eerror "This ebuild did not call webapp_src_install() at the end" 458 eerror "This ebuild did not call webapp_src_install() at the end"
444 eerror "of the src_install() function" 459 eerror "of the src_install() function"
445 eerror 460 eerror
446 eerror "Please log a bug on http://bugs.gentoo.org" 461 eerror "Please log a bug on http://bugs.gentoo.org"
459 einfo "vhosts USE flag not set - auto-installing using webapp-config" 474 einfo "vhosts USE flag not set - auto-installing using webapp-config"
460 475
461 webapp_getinstalltype 476 webapp_getinstalltype
462 477
463 G_HOSTNAME="localhost" 478 G_HOSTNAME="localhost"
464 . /etc/vhosts/webapp-config 479 . "${ETC_CONFIG}"
465 480
466 local my_mode=-I 481 local my_mode=-I
467 482
468 if [ "$IS_REPLACE" = "1" ]; then 483 if [ "$IS_REPLACE" = "1" ]; then
469 einfo "${PN}-${PVR} is already installed - replacing" 484 einfo "${PN}-${PVR} is already installed - replacing"
470 /usr/sbin/webapp-config -C -d "$INSTALL_DIR" 485 my_mode=-I
471 elif [ "$IS_UPGRADE" = "1" ]; then 486 elif [ "$IS_UPGRADE" = "1" ]; then
472 einfo "$REMOVE_PKG is already installed - upgrading" 487 einfo "$REMOVE_PKG is already installed - upgrading"
473 my_mode=-U 488 my_mode=-U
474 else 489 else
475 einfo "${PN}-${PVR} is not installed - using install mode" 490 einfo "${PN}-${PVR} is not installed - using install mode"
491 # the user is relying on portage to do the magical thing for it 506 # the user is relying on portage to do the magical thing for it
492 507
493 if [ "$IS_UPGRADE" = "1" ] ; then 508 if [ "$IS_UPGRADE" = "1" ] ; then
494 einfo "Removing old version $REMOVE_PKG" 509 einfo "Removing old version $REMOVE_PKG"
495 510
496 emerge -C $CATEGORY/$REMOVE_PKG 511 emerge -C "$REMOVE_PKG"
497 fi 512 fi
498 else 513 else
499 # vhosts flag is on 514 # vhosts flag is on
500 # 515 #
501 # let's tell the administrator what to do next 516 # let's tell the administrator what to do next

Legend:
Removed from v.1.21  
changed lines
  Added in v.1.31

  ViewVC Help
Powered by ViewVC 1.1.20