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

Contents of /eclass/webapp.eclass

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.34 - (show annotations) (download)
Mon Jul 11 15:08:06 2005 UTC (9 years, 2 months ago) by swegener
Branch: MAIN
Changes since 1.33: +9 -9 lines
QA: Apply whitespace checks from repoman to eclasses.

1 # Copyright 1999-2004 Gentoo Foundation
2 # Distributed under the terms of the GNU General Public License v2
3 # $Header: /var/cvsroot/gentoo-x86/eclass/webapp.eclass,v 1.33 2005/07/06 20:23:20 agriffis Exp $
4 #
5 # eclass/webapp.eclass
6 # Eclass for installing applications to run under a web server
7 #
8 # Part of the implementation of GLEP #11
9 #
10 # Author(s) Stuart Herbert <stuart@gentoo.org>
11 #
12 # ------------------------------------------------------------------------
13 #
14 # The master copy of this eclass is held in Stu's subversion repository.
15 #
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.
19 #
20 # ------------------------------------------------------------------------
21
22 SLOT="${PVR}"
23 IUSE="$IUSE vhosts"
24 DEPEND="$DEPEND net-www/webapp-config app-portage/gentoolkit"
25
26 EXPORT_FUNCTIONS pkg_postinst pkg_setup src_install pkg_prerm
27
28 INSTALL_DIR="/$PN"
29 IS_UPGRADE=0
30 IS_REPLACE=0
31
32 INSTALL_CHECK_FILE="installed_by_webapp_eclass"
33
34 ETC_CONFIG="/etc/vhosts/webapp-config"
35
36 # ------------------------------------------------------------------------
37 # INTERNAL FUNCTION - USED BY THIS ECLASS ONLY
38 #
39 # Check whether a specified file exists within the image/ directory
40 # or not.
41 #
42 # @param $1 - file to look for
43 # @param $2 - prefix directory to use
44 # @return 0 on success, never returns on an error
45 # ------------------------------------------------------------------------
46
47 function webapp_checkfileexists ()
48 {
49 local my_prefix
50
51 [ -n "$2" ] && my_prefix="$2/" || my_prefix=
52
53 if [ ! -e "${my_prefix}$1" ]; then
54 msg="ebuild fault: file '$1' not found"
55 eerror "$msg"
56 eerror "Please report this as a bug at http://bugs.gentoo.org/"
57 die "$msg"
58 fi
59 }
60
61 # ------------------------------------------------------------------------
62 # INTERNAL FUNCTION - USED BY THIS ECLASS ONLY
63 # ------------------------------------------------------------------------
64
65 function 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
76 function 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
92 function webapp_strip_appdir ()
93 {
94 local my_stripped="$1"
95 echo "$1" | sed -e "s|${MY_APPDIR}/||g;"
96 }
97
98 function webapp_strip_d ()
99 {
100 echo "$1" | sed -e "s|${D}||g;"
101 }
102
103 function 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
117 function 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
137 function 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
155 function 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
172 function 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
185 function 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 # ------------------------------------------------------------------------
197 # EXPORTED FUNCTION - FOR USE IN EBUILDS
198 #
199 # Identify a file which must be owned by the webserver's user:group
200 # settings.
201 #
202 # The ownership of the file is NOT set until the application is installed
203 # using the webapp-config tool.
204 #
205 # @param $1 - file to be owned by the webserver user:group combo
206 #
207 # ------------------------------------------------------------------------
208
209 function webapp_serverowned ()
210 {
211 webapp_checkfileexists "$1" "$D"
212 local MY_FILE="`webapp_strip_appdir \"$1\"`"
213 MY_FILE="`webapp_strip_cwd \"$MY_FILE\"`"
214
215 einfo "(server owned) $MY_FILE"
216 echo "$MY_FILE" >> "${D}${WA_SOLIST}"
217 }
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
233 function webapp_server_configfile ()
234 {
235 webapp_checkfileexists "$2"
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
268 function 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
298 }
299
300 # ------------------------------------------------------------------------
301 # EXPORTED FUNCTION - call from inside your ebuild's src_install AFTER
302 # everything else has run
303 #
304 # For now, we just make sure that root owns everything, and that there
305 # are no setuid files. I'm sure this will change significantly before
306 # the final version!
307 # ------------------------------------------------------------------------
308
309 function webapp_src_install ()
310 {
311 chown -R "${VHOST_DEFAULT_UID}:${VHOST_DEFAULT_GID}" "${D}/"
312 chmod -R u-s "${D}/"
313 chmod -R g-s "${D}/"
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
329 # ------------------------------------------------------------------------
330 # EXPORTED FUNCTION - call from inside your ebuild's pkg_config AFTER
331 # everything else has run
332 #
333 # If 'vhosts' USE flag is not set, auto-install this app
334 #
335 # ------------------------------------------------------------------------
336
337 function webapp_pkg_setup ()
338 {
339 # add sanity checks here
340
341 if [ "$SLOT+" != "${PVR}+" ]; then
342 die "ebuild sets SLOT, overrides webapp.eclass"
343 fi
344
345 # pull in the shared configuration file
346
347 G_HOSTNAME="localhost"
348 . "${ETC_CONFIG}" || die "Unable to open file ${ETC_CONFIG}"
349
350 # are we installing a webapp-config solution over the top of a
351 # non-webapp-config solution?
352
353 if ! use vhosts ; then
354 local my_dir="$VHOST_ROOT/$MY_HTDOCSBASE/$PN"
355 local my_output
356
357 if [ -d "$my_dir" ] ; then
358 einfo "You already have something installed in $my_dir"
359 einfo "Are you trying to install over the top of something I cannot upgrade?"
360
361 my_output="`webapp_check_installedat`"
362
363 if [ "$?" != "0" ]; then
364
365 # okay, whatever is there, it isn't webapp-config-compatible
366 ewarn
367 ewarn "Whatever is in $my_dir, it's not"
368 ewarn "compatible with webapp-config."
369 ewarn
370 ewarn "This ebuild may be overwriting important files."
371 ewarn
372 elif [ "`echo $my_output | awk '{ print $1 }'`" != "$PN" ]; then
373 eerror "$my_dir contains $my_output"
374 eerror "I cannot upgrade that"
375 die "Cannot upgrade contents of $my_dir"
376 else
377 einfo
378 einfo "I can upgrade the contents of $my_dir"
379 einfo
380 fi
381 fi
382 fi
383 }
384
385 function webapp_someunusedfunction ()
386 {
387 # are we emerging something that is already installed?
388
389 if [ -d "${D}${MY_APPROOT}/${MY_APPSUFFIX}" ]; then
390 # yes we are
391 ewarn "Removing existing copy of ${PN}-${PVR}"
392 rm -rf "${D}${MY_APPROOT}/${MY_APPSUFFIX}"
393 fi
394 }
395
396 function webapp_getinstalltype ()
397 {
398 # or are we upgrading?
399
400 if ! use vhosts ; then
401 # we only run webapp-config if vhosts USE flag is not set
402
403 local my_output
404
405 my_output="`webapp_check_installedat`"
406
407 if [ "$?" = "0" ] ; then
408 # something is already installed there
409 #
410 # make sure it isn't the same version
411
412 local my_pn="`echo $my_output | awk '{ print $1 }'`"
413 local my_pvr="`echo $my_output | awk '{ print $2 }'`"
414
415 REMOVE_PKG="${my_pn}-${my_pvr}"
416
417 if [ "$my_pn" == "$PN" ]; then
418 if [ "$my_pvr" != "$PVR" ]; then
419 einfo "This is an upgrade"
420 IS_UPGRADE=1
421 else
422 einfo "This is a re-installation"
423 IS_REPLACE=1
424 fi
425 else
426 einfo "$my_ouptut is installed there"
427 fi
428 else
429 einfo "This is an installation"
430 fi
431 fi
432 }
433
434 function webapp_src_preinst ()
435 {
436 # create the directories that we need
437
438 dodir "${MY_HTDOCSDIR}"
439 dodir "${MY_HOSTROOTDIR}"
440 dodir "${MY_CGIBINDIR}"
441 dodir "${MY_ICONSDIR}"
442 dodir "${MY_ERRORSDIR}"
443 dodir "${MY_SQLSCRIPTSDIR}"
444 dodir "${MY_HOOKSCRIPTSDIR}"
445 dodir "${MY_SERVERCONFIGDIR}"
446 }
447
448 function webapp_pkg_postinst ()
449 {
450 . "${ETC_CONFIG}"
451
452 # sanity checks, to catch bugs in the ebuild
453
454 if [ ! -f "${MY_APPDIR}/${INSTALL_CHECK_FILE}" ]; then
455 eerror
456 eerror "This ebuild did not call webapp_src_install() at the end"
457 eerror "of the src_install() function"
458 eerror
459 eerror "Please log a bug on http://bugs.gentoo.org"
460 eerror
461 eerror "You should use emerge -C to remove this package, as the"
462 eerror "installation is incomplete"
463 eerror
464 die "Ebuild did not call webapp_src_install() - report to http://bugs.gentoo.org"
465 fi
466
467 # if 'vhosts' is not set in your USE flags, we install a copy of
468 # this application in /var/www/localhost/htdocs/${PN}/ for you
469
470 if ! use vhosts ; then
471 echo
472 einfo "vhosts USE flag not set - auto-installing using webapp-config"
473
474 webapp_getinstalltype
475
476 G_HOSTNAME="localhost"
477 . "${ETC_CONFIG}"
478
479 local my_mode=-I
480
481 if [ "$IS_REPLACE" = "1" ]; then
482 einfo "${PN}-${PVR} is already installed - replacing"
483 my_mode=-I
484 elif [ "$IS_UPGRADE" = "1" ]; then
485 einfo "$REMOVE_PKG is already installed - upgrading"
486 my_mode=-U
487 else
488 einfo "${PN}-${PVR} is not installed - using install mode"
489 fi
490
491 my_cmd="/usr/sbin/webapp-config $my_mode -h localhost -u root -d $INSTALL_DIR ${PN} ${PVR}"
492 einfo "Running $my_cmd"
493 $my_cmd
494
495 # remove the old version
496 #
497 # why do we do this? well ...
498 #
499 # normally, emerge -u installs a new version and then removes the
500 # old version. however, if the new version goes into a different
501 # slot to the old version, then the old version gets left behind
502 #
503 # if USE=-vhosts, then we want to remove the old version, because
504 # the user is relying on portage to do the magical thing for it
505
506 if [ "$IS_UPGRADE" = "1" ] ; then
507 einfo "Removing old version $REMOVE_PKG"
508
509 emerge -C "$REMOVE_PKG"
510 fi
511 else
512 # vhosts flag is on
513 #
514 # let's tell the administrator what to do next
515
516 einfo
517 einfo "The 'vhosts' USE flag is switched ON"
518 einfo "This means that Portage will not automatically run webapp-config to"
519 einfo "complete the installation."
520 einfo
521 einfo "To install $PN-$PVR into a virtual host, run the following command:"
522 einfo
523 einfo " webapp-config -I -h <host> -d $PN $PN $PVR"
524 einfo
525 einfo "For more details, see the webapp-config(8) man page"
526 fi
527
528 return 0
529 }
530
531 function webapp_pkg_prerm ()
532 {
533 # remove any virtual installs that there are
534
535 local my_output
536 local x
537
538 my_output="`webapp-config --list-installs $PN $PVR`"
539
540 if [ "$?" != "0" ]; then
541 return
542 fi
543
544 # the changes to IFS here are necessary to ensure that we can cope
545 # with directories that contain spaces in the file names
546
547 # OLD_IFS="$IFS"
548 # IFS=" "
549
550 for x in $my_output ; do
551 # IFS="$OLD_IFS"
552
553 [ -f $x/.webapp ] && . $x/.webapp || ewarn "Cannot find file $x/.webapp"
554
555 if [ -z "WEB_HOSTNAME" -o -z "WEB_INSTALLDIR" ]; then
556 ewarn "Don't forget to use webapp-config to remove the copy of"
557 ewarn "${PN}-${PVR} installed in"
558 ewarn
559 ewarn " $x"
560 ewarn
561 else
562 # we have enough information to remove the virtual copy ourself
563
564 webapp-config -C -h ${WEB_HOSTNAME} -d ${WEB_INSTALLDIR}
565
566 # if the removal fails - we carry on anyway!
567 fi
568 # IFS=" "
569 done
570
571 # IFS="$OLD_IFS"
572 }

  ViewVC Help
Powered by ViewVC 1.1.20