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

Contents of /eclass/webapp.eclass

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.34 - (hide 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 vapier 1.24 # Copyright 1999-2004 Gentoo Foundation
2 stuart 1.1 # Distributed under the terms of the GNU General Public License v2
3 swegener 1.34 # $Header: /var/cvsroot/gentoo-x86/eclass/webapp.eclass,v 1.33 2005/07/06 20:23:20 agriffis Exp $
4 stuart 1.1 #
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 stuart 1.18 # 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 stuart 1.1 #
20     # ------------------------------------------------------------------------
21    
22     SLOT="${PVR}"
23     IUSE="$IUSE vhosts"
24 stuart 1.31 DEPEND="$DEPEND net-www/webapp-config app-portage/gentoolkit"
25 stuart 1.1
26 stuart 1.18 EXPORT_FUNCTIONS pkg_postinst pkg_setup src_install pkg_prerm
27 stuart 1.1
28 stuart 1.14 INSTALL_DIR="/$PN"
29     IS_UPGRADE=0
30     IS_REPLACE=0
31    
32 stuart 1.19 INSTALL_CHECK_FILE="installed_by_webapp_eclass"
33    
34 stuart 1.21 ETC_CONFIG="/etc/vhosts/webapp-config"
35    
36 stuart 1.1 # ------------------------------------------------------------------------
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 stuart 1.3 # @param $2 - prefix directory to use
44 stuart 1.1 # @return 0 on success, never returns on an error
45     # ------------------------------------------------------------------------
46    
47     function webapp_checkfileexists ()
48     {
49 stuart 1.9 local my_prefix
50    
51     [ -n "$2" ] && my_prefix="$2/" || my_prefix=
52    
53 stuart 1.22 if [ ! -e "${my_prefix}$1" ]; then
54 stuart 1.23 msg="ebuild fault: file '$1' not found"
55 stuart 1.1 eerror "$msg"
56     eerror "Please report this as a bug at http://bugs.gentoo.org/"
57     die "$msg"
58     fi
59     }
60    
61     # ------------------------------------------------------------------------
62 stuart 1.3 # INTERNAL FUNCTION - USED BY THIS ECLASS ONLY
63     # ------------------------------------------------------------------------
64    
65 stuart 1.14 function webapp_check_installedat
66     {
67     local my_output
68    
69 stuart 1.22 /usr/sbin/webapp-config --show-installed -h localhost -d "$INSTALL_DIR" 2> /dev/null
70 stuart 1.14 }
71    
72     # ------------------------------------------------------------------------
73     # INTERNAL FUNCTION - USED BY THIS ECLASS ONLY
74     # ------------------------------------------------------------------------
75    
76 stuart 1.3 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 stuart 1.1 #
90     # ------------------------------------------------------------------------
91    
92 stuart 1.3 function webapp_strip_appdir ()
93     {
94 stuart 1.14 local my_stripped="$1"
95 stuart 1.11 echo "$1" | sed -e "s|${MY_APPDIR}/||g;"
96 stuart 1.3 }
97    
98     function webapp_strip_d ()
99     {
100     echo "$1" | sed -e "s|${D}||g;"
101     }
102    
103     function webapp_strip_cwd ()
104 stuart 1.1 {
105 stuart 1.14 local my_stripped="$1"
106 stuart 1.3 echo "$1" | sed -e 's|/./|/|g;'
107 stuart 1.1 }
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 stuart 1.3 webapp_checkfileexists "$1" "$D"
120 stuart 1.27
121 stuart 1.22 local MY_FILE="`webapp_strip_appdir \"$1\"`"
122 stuart 1.29 MY_FILE="`webapp_strip_cwd \"$MY_FILE\"`"
123 stuart 1.3
124     einfo "(config) $MY_FILE"
125 stuart 1.23 echo "$MY_FILE" >> ${D}${WA_CONFIGLIST}
126 stuart 1.1 }
127    
128     # ------------------------------------------------------------------------
129     # EXPORTED FUNCTION - FOR USE IN EBUILDS
130     #
131 stuart 1.18 # 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 stuart 1.23 webapp_checkfileexists "$1"
140 stuart 1.18
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 stuart 1.5 # 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 stuart 1.31 function webapp_postinst_txt ()
156 stuart 1.5 {
157     webapp_checkfileexists "$2"
158    
159     einfo "(rtfm) $2 (lang: $1)"
160 stuart 1.8 cp "$2" "${D}${MY_APPDIR}/postinst-$1.txt"
161 stuart 1.5 }
162    
163     # ------------------------------------------------------------------------
164     # EXPORTED FUNCTION - FOR USE IN EBUILDS
165     #
166 stuart 1.31 # Install a text file containing post-upgrade instructions.
167 stuart 1.1 #
168 stuart 1.31 # @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 stuart 1.1 #
183 stuart 1.31 # It never worked anyway
184 stuart 1.1
185     function webapp_runbycgibin ()
186     {
187 stuart 1.31 if [ -n "$WARN_RUNBYCGIBIN" ] ; then
188     return
189     fi
190 stuart 1.3
191 stuart 1.31 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 stuart 1.3 }
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 swegener 1.34 #
205 stuart 1.3 # @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 swegener 1.34 local MY_FILE="`webapp_strip_appdir \"$1\"`"
213 stuart 1.29 MY_FILE="`webapp_strip_cwd \"$MY_FILE\"`"
214 swegener 1.34
215 stuart 1.3 einfo "(server owned) $MY_FILE"
216 stuart 1.23 echo "$MY_FILE" >> "${D}${WA_SOLIST}"
217 stuart 1.3 }
218    
219     # ------------------------------------------------------------------------
220     # EXPORTED FUNCTION - FOR USE IN EBUILDS
221     #
222 stuart 1.18 # @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 stuart 1.26 function webapp_server_configfile ()
234 stuart 1.18 {
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 stuart 1.22 my_file="$1-`basename $2`"
243 stuart 1.18 else
244 stuart 1.22 my_file="$1-$3"
245 stuart 1.18 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 swegener 1.34
252 stuart 1.18 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 stuart 1.3 #
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 stuart 1.8 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 stuart 1.3 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 swegener 1.34
286 stuart 1.3 # 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 stuart 1.22 cp "$2" "${D}${MY_SQLSCRIPTSDIR}/$1/${3}_to_${PVR}.sql"
291 stuart 1.31 chmod 600 "${D}${MY_SQLSCRIPTSDIR}/$1/${3}_to_${PVR}.sql"
292 stuart 1.3 else
293     # no, we are not
294     einfo "($1) create script for ${PN}-${PVR}"
295 stuart 1.22 cp "$2" "${D}${MY_SQLSCRIPTSDIR}/$1/${PVR}_create.sql"
296 stuart 1.31 chmod 600 "${D}${MY_SQLSCRIPTSDIR}/$1/${PVR}_create.sql"
297 stuart 1.3 fi
298 stuart 1.1 }
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 stuart 1.22 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 stuart 1.15
319 stuart 1.19 # 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 stuart 1.22 touch "${D}/${MY_APPDIR}/${INSTALL_CHECK_FILE}"
327 stuart 1.1 }
328    
329     # ------------------------------------------------------------------------
330 stuart 1.3 # EXPORTED FUNCTION - call from inside your ebuild's pkg_config AFTER
331 stuart 1.1 # 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 stuart 1.15 # add sanity checks here
340    
341     if [ "$SLOT+" != "${PVR}+" ]; then
342     die "ebuild sets SLOT, overrides webapp.eclass"
343     fi
344    
345 stuart 1.8 # pull in the shared configuration file
346    
347 stuart 1.18 G_HOSTNAME="localhost"
348 stuart 1.22 . "${ETC_CONFIG}" || die "Unable to open file ${ETC_CONFIG}"
349 stuart 1.18
350 swegener 1.34 # are we installing a webapp-config solution over the top of a
351 stuart 1.18 # 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 stuart 1.20 ewarn "This ebuild may be overwriting important files."
371     ewarn
372 stuart 1.18 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 stuart 1.14 }
384 stuart 1.6
385 stuart 1.18 function webapp_someunusedfunction ()
386 stuart 1.14 {
387 stuart 1.3 # are we emerging something that is already installed?
388    
389 stuart 1.8 if [ -d "${D}${MY_APPROOT}/${MY_APPSUFFIX}" ]; then
390 stuart 1.3 # yes we are
391     ewarn "Removing existing copy of ${PN}-${PVR}"
392 stuart 1.8 rm -rf "${D}${MY_APPROOT}/${MY_APPSUFFIX}"
393 stuart 1.3 fi
394 stuart 1.18 }
395 stuart 1.14
396 stuart 1.18 function webapp_getinstalltype ()
397     {
398 stuart 1.14 # 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 stuart 1.18 else
426     einfo "$my_ouptut is installed there"
427 stuart 1.14 fi
428 stuart 1.18 else
429     einfo "This is an installation"
430 stuart 1.14 fi
431     fi
432 stuart 1.9 }
433 stuart 1.3
434 stuart 1.9 function webapp_src_preinst ()
435     {
436 stuart 1.3 # create the directories that we need
437    
438 stuart 1.22 dodir "${MY_HTDOCSDIR}"
439     dodir "${MY_HOSTROOTDIR}"
440     dodir "${MY_CGIBINDIR}"
441     dodir "${MY_ICONSDIR}"
442     dodir "${MY_ERRORSDIR}"
443     dodir "${MY_SQLSCRIPTSDIR}"
444 stuart 1.25 dodir "${MY_HOOKSCRIPTSDIR}"
445 stuart 1.26 dodir "${MY_SERVERCONFIGDIR}"
446 stuart 1.3 }
447    
448 stuart 1.5 function webapp_pkg_postinst ()
449 stuart 1.3 {
450 stuart 1.22 . "${ETC_CONFIG}"
451 stuart 1.21
452 stuart 1.15 # sanity checks, to catch bugs in the ebuild
453    
454 stuart 1.22 if [ ! -f "${MY_APPDIR}/${INSTALL_CHECK_FILE}" ]; then
455 stuart 1.15 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 stuart 1.10 # 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 swegener 1.34
470 stuart 1.10 if ! use vhosts ; then
471 stuart 1.14 echo
472 stuart 1.11 einfo "vhosts USE flag not set - auto-installing using webapp-config"
473    
474 stuart 1.14 webapp_getinstalltype
475    
476 stuart 1.10 G_HOSTNAME="localhost"
477 stuart 1.22 . "${ETC_CONFIG}"
478 stuart 1.10
479     local my_mode=-I
480    
481 stuart 1.14 if [ "$IS_REPLACE" = "1" ]; then
482     einfo "${PN}-${PVR} is already installed - replacing"
483 stuart 1.27 my_mode=-I
484 stuart 1.14 elif [ "$IS_UPGRADE" = "1" ]; then
485     einfo "$REMOVE_PKG is already installed - upgrading"
486     my_mode=-U
487 stuart 1.11 else
488     einfo "${PN}-${PVR} is not installed - using install mode"
489 stuart 1.10 fi
490 swegener 1.34
491 stuart 1.14 my_cmd="/usr/sbin/webapp-config $my_mode -h localhost -u root -d $INSTALL_DIR ${PN} ${PVR}"
492 stuart 1.11 einfo "Running $my_cmd"
493     $my_cmd
494 stuart 1.14
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 stuart 1.28 emerge -C "$REMOVE_PKG"
510 stuart 1.14 fi
511 stuart 1.18 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 stuart 1.10 fi
527 stuart 1.11
528     return 0
529 stuart 1.2 }
530 stuart 1.18
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