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

Contents of /eclass/webapp.eclass

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.18 - (hide annotations) (download)
Mon May 17 22:44:35 2004 UTC (10 years, 3 months ago) by stuart
Branch: MAIN
Changes since 1.17: +170 -7 lines
Version bump; emerge -C support

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

  ViewVC Help
Powered by ViewVC 1.1.20