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

Contents of /eclass/webapp.eclass

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.19 - (hide annotations) (download)
Sat May 22 18:45:13 2004 UTC (9 years, 10 months ago) by stuart
Branch: MAIN
Changes since 1.18: +12 -3 lines
Portage-2.0.51 compatibility

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.19 DEPEND="$DEPEND >=net-www/webapp-config-1.7 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.19 INSTALL_CHECK_FILE="installed_by_webapp_eclass"
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     if [ ! -e ${my_prefix}$1 ]; then
54 stuart 1.3 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     /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 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.11 echo $1
121 stuart 1.3 local MY_FILE="`webapp_strip_appdir $1`"
122 stuart 1.11 echo $MY_FILE
123 stuart 1.3
124     einfo "(config) $MY_FILE"
125 stuart 1.8 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     webapp_checkfileexists "$2"
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 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     function webapp_postinst_txt
156     {
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.1 # Identify a script file (usually, but not always PHP or Perl) which is
167     #
168     # Files in this list may be modified to #! the required CGI engine when
169     # installed by webapp-config tool in the future.
170     #
171     # @param $1 - the cgi engine to use
172     # @param $2 - the script file that could run under a cgi-bin
173     #
174     # ------------------------------------------------------------------------
175    
176     function webapp_runbycgibin ()
177     {
178 stuart 1.3 webapp_checkfileexists "$2" "$D"
179     local MY_FILE="`webapp_strip_appdir $2`"
180     MY_FILE="`webapp_strip_cwd $MY_FILE`"
181    
182     einfo "(cgi-bin) $1 - $MY_FILE"
183 stuart 1.8 echo "$1 $MY_FILE" >> ${D}${WA_RUNBYCGIBINLIST}
184 stuart 1.3 }
185    
186     # ------------------------------------------------------------------------
187     # EXPORTED FUNCTION - FOR USE IN EBUILDS
188     #
189     # Identify a file which must be owned by the webserver's user:group
190     # settings.
191     #
192     # The ownership of the file is NOT set until the application is installed
193     # using the webapp-config tool.
194     #
195     # @param $1 - file to be owned by the webserver user:group combo
196     #
197     # ------------------------------------------------------------------------
198    
199     function webapp_serverowned ()
200     {
201     webapp_checkfileexists "$1" "$D"
202     local MY_FILE="`webapp_strip_appdir $1`"
203    
204     einfo "(server owned) $MY_FILE"
205 stuart 1.8 echo "$MY_FILE" >> ${D}${WA_SOLIST}
206 stuart 1.3 }
207    
208     # ------------------------------------------------------------------------
209     # EXPORTED FUNCTION - FOR USE IN EBUILDS
210     #
211 stuart 1.18 # @param $1 - the webserver to install the config file for
212     # (one of apache1, apache2, cherokee)
213     # @param $2 - the config file to install
214     # @param $3 - new name for the config file (default is `basename $2`)
215     # this is an optional parameter
216     #
217     # NOTE:
218     # this function will automagically prepend $1 to the front of your
219     # config file's name
220     # ------------------------------------------------------------------------
221    
222     function webapp_server_config ()
223     {
224     webapp_checkfileexists "$2"
225    
226     # sort out what the name will be of the config file
227    
228     local my_file
229    
230     if [ -z "$3" ]; then
231     $my_file="$1-`basename $2`"
232     else
233     $my_file="$1-$3"
234     fi
235    
236     # warning:
237     #
238     # do NOT change the naming convention used here without changing all
239     # the other scripts that also rely upon these names
240    
241     einfo "($1) config file '$my_file'"
242     cp "$2" "${D}${MY_SERVERCONFIGDIR}/${my_file}"
243     }
244    
245     # ------------------------------------------------------------------------
246     # EXPORTED FUNCTION - FOR USE IN EBUILDS
247 stuart 1.3 #
248     # @param $1 - the db engine that the script is for
249     # (one of: mysql|postgres)
250     # @param $2 - the sql script to be installed
251     # @param $3 - the older version of the app that this db script
252     # will upgrade from
253     # (do not pass this option if your SQL script only creates
254     # a new db from scratch)
255     # ------------------------------------------------------------------------
256    
257     function webapp_sqlscript ()
258     {
259     webapp_checkfileexists "$2"
260    
261     # create the directory where this script will go
262     #
263     # scripts for specific database engines go into their own subdirectory
264     # just to keep things readable on the filesystem
265    
266 stuart 1.8 if [ ! -d "${D}${MY_SQLSCRIPTSDIR}/$1" ]; then
267     mkdir -p "${D}${MY_SQLSCRIPTSDIR}/$1" || libsh_die "unable to create directory ${D}${MY_SQLSCRIPTSDIR}/$1"
268 stuart 1.3 fi
269    
270     # warning:
271     #
272     # do NOT change the naming convention used here without changing all
273     # the other scripts that also rely upon these names
274    
275     # are we dealing with an 'upgrade'-type script?
276     if [ -n "$3" ]; then
277     # yes we are
278     einfo "($1) upgrade script from ${PN}-${PVR} to $3"
279 stuart 1.8 cp $2 ${D}${MY_SQLSCRIPTSDIR}/$1/${3}_to_${PVR}.sql
280 stuart 1.3 else
281     # no, we are not
282     einfo "($1) create script for ${PN}-${PVR}"
283 stuart 1.8 cp $2 ${D}${MY_SQLSCRIPTSDIR}/$1/${PVR}_create.sql
284 stuart 1.3 fi
285 stuart 1.1 }
286    
287     # ------------------------------------------------------------------------
288     # EXPORTED FUNCTION - call from inside your ebuild's src_install AFTER
289     # everything else has run
290     #
291     # For now, we just make sure that root owns everything, and that there
292     # are no setuid files. I'm sure this will change significantly before
293     # the final version!
294     # ------------------------------------------------------------------------
295    
296     function webapp_src_install ()
297     {
298 stuart 1.18 chown -R ${VHOST_DEFAULT_UID}:${VHOST_DEFAULT_GID} ${D}/
299 stuart 1.1 chmod -R u-s ${D}/
300     chmod -R g-s ${D}/
301 stuart 1.5
302     keepdir ${MY_PERSISTDIR}
303     fowners root:root ${MY_PERSISTDIR}
304     fperms 755 ${MY_PERSISTDIR}
305 stuart 1.15
306 stuart 1.19 # to test whether or not the ebuild has correctly called this function
307     # we add an empty file to the filesystem
308     #
309     # we used to just set a variable in the shell script, but we can
310     # no longer rely on Portage calling both webapp_src_install() and
311     # webapp_pkg_postinst() within the same shell process
312    
313     touch ${D}/${MY_APPDIR}/${INSTALL_CHECK_FILE}
314 stuart 1.1 }
315    
316     # ------------------------------------------------------------------------
317 stuart 1.3 # EXPORTED FUNCTION - call from inside your ebuild's pkg_config AFTER
318 stuart 1.1 # everything else has run
319     #
320     # If 'vhosts' USE flag is not set, auto-install this app
321     #
322     # ------------------------------------------------------------------------
323    
324     function webapp_pkg_setup ()
325     {
326 stuart 1.15 # add sanity checks here
327    
328     if [ "$SLOT+" != "${PVR}+" ]; then
329     die "ebuild sets SLOT, overrides webapp.eclass"
330     fi
331    
332 stuart 1.8 # pull in the shared configuration file
333    
334 stuart 1.18 G_HOSTNAME="localhost"
335 stuart 1.8 . /etc/vhosts/webapp-config || die "Unable to open /etc/vhosts/webapp-config file"
336 stuart 1.18
337     # are we installing a webapp-config solution over the top of a
338     # non-webapp-config solution?
339    
340     if ! use vhosts ; then
341     local my_dir="$VHOST_ROOT/$MY_HTDOCSBASE/$PN"
342     local my_output
343    
344     if [ -d "$my_dir" ] ; then
345     einfo "You already have something installed in $my_dir"
346     einfo "Are you trying to install over the top of something I cannot upgrade?"
347    
348     my_output="`webapp_check_installedat`"
349    
350     if [ "$?" != "0" ]; then
351    
352     # okay, whatever is there, it isn't webapp-config-compatible
353     ewarn
354     ewarn "Whatever is in $my_dir, it's not"
355     ewarn "compatible with webapp-config."
356     ewarn
357    
358     my_output="`qpkg -nc -v -f $my_dir`"
359     if [ -n "$my_output" ]; then
360     eerror "Please remove $my_output and re-emerge."
361     else
362     eerror "Please remove the contents of $my_dir, and then re-emerge."
363     fi
364     die "Cannot upgrade contents of $my_dir"
365     elif [ "`echo $my_output | awk '{ print $1 }'`" != "$PN" ]; then
366     eerror "$my_dir contains $my_output"
367     eerror "I cannot upgrade that"
368     die "Cannot upgrade contents of $my_dir"
369     else
370     einfo
371     einfo "I can upgrade the contents of $my_dir"
372     einfo
373     fi
374     fi
375     fi
376 stuart 1.14 }
377 stuart 1.6
378 stuart 1.18 function webapp_someunusedfunction ()
379 stuart 1.14 {
380 stuart 1.3 # are we emerging something that is already installed?
381    
382 stuart 1.8 if [ -d "${D}${MY_APPROOT}/${MY_APPSUFFIX}" ]; then
383 stuart 1.3 # yes we are
384     ewarn "Removing existing copy of ${PN}-${PVR}"
385 stuart 1.8 rm -rf "${D}${MY_APPROOT}/${MY_APPSUFFIX}"
386 stuart 1.3 fi
387 stuart 1.18 }
388 stuart 1.14
389 stuart 1.18 function webapp_getinstalltype ()
390     {
391 stuart 1.14 # or are we upgrading?
392    
393     if ! use vhosts ; then
394     # we only run webapp-config if vhosts USE flag is not set
395    
396     local my_output
397    
398     my_output="`webapp_check_installedat`"
399    
400     if [ "$?" = "0" ] ; then
401     # something is already installed there
402     #
403     # make sure it isn't the same version
404    
405     local my_pn="`echo $my_output | awk '{ print $1 }'`"
406     local my_pvr="`echo $my_output | awk '{ print $2 }'`"
407    
408     REMOVE_PKG="${my_pn}-${my_pvr}"
409    
410     if [ "$my_pn" == "$PN" ]; then
411     if [ "$my_pvr" != "$PVR" ]; then
412     einfo "This is an upgrade"
413     IS_UPGRADE=1
414     else
415     einfo "This is a re-installation"
416     IS_REPLACE=1
417     fi
418 stuart 1.18 else
419     einfo "$my_ouptut is installed there"
420 stuart 1.14 fi
421 stuart 1.18 else
422     einfo "This is an installation"
423 stuart 1.14 fi
424     fi
425 stuart 1.9 }
426 stuart 1.3
427 stuart 1.9 function webapp_src_preinst ()
428     {
429 stuart 1.3 # create the directories that we need
430    
431 stuart 1.9 dodir ${MY_HTDOCSDIR}
432     dodir ${MY_HOSTROOTDIR}
433     dodir ${MY_CGIBINDIR}
434     dodir ${MY_ICONSDIR}
435     dodir ${MY_ERRORSDIR}
436     dodir ${MY_SQLSCRIPTSDIR}
437 stuart 1.3 }
438    
439 stuart 1.5 function webapp_pkg_postinst ()
440 stuart 1.3 {
441 stuart 1.15 # sanity checks, to catch bugs in the ebuild
442    
443 stuart 1.19 if [ ! -f ${MY_APPDIR}/${INSTALL_CHECK_FILE} ]; then
444 stuart 1.15 eerror
445     eerror "This ebuild did not call webapp_src_install() at the end"
446     eerror "of the src_install() function"
447     eerror
448     eerror "Please log a bug on http://bugs.gentoo.org"
449     eerror
450     eerror "You should use emerge -C to remove this package, as the"
451     eerror "installation is incomplete"
452     eerror
453     die "Ebuild did not call webapp_src_install() - report to http://bugs.gentoo.org"
454     fi
455    
456 stuart 1.10 # if 'vhosts' is not set in your USE flags, we install a copy of
457     # this application in /var/www/localhost/htdocs/${PN}/ for you
458 stuart 1.11
459 stuart 1.10 if ! use vhosts ; then
460 stuart 1.14 echo
461 stuart 1.11 einfo "vhosts USE flag not set - auto-installing using webapp-config"
462    
463 stuart 1.14 webapp_getinstalltype
464    
465 stuart 1.10 G_HOSTNAME="localhost"
466     . /etc/vhosts/webapp-config
467    
468     local my_mode=-I
469    
470 stuart 1.14 if [ "$IS_REPLACE" = "1" ]; then
471     einfo "${PN}-${PVR} is already installed - replacing"
472     /usr/sbin/webapp-config -C -d "$INSTALL_DIR"
473     elif [ "$IS_UPGRADE" = "1" ]; then
474     einfo "$REMOVE_PKG is already installed - upgrading"
475     my_mode=-U
476 stuart 1.11 else
477     einfo "${PN}-${PVR} is not installed - using install mode"
478 stuart 1.10 fi
479    
480 stuart 1.14 my_cmd="/usr/sbin/webapp-config $my_mode -h localhost -u root -d $INSTALL_DIR ${PN} ${PVR}"
481 stuart 1.11 einfo "Running $my_cmd"
482     $my_cmd
483 stuart 1.14
484     # remove the old version
485     #
486     # why do we do this? well ...
487     #
488     # normally, emerge -u installs a new version and then removes the
489     # old version. however, if the new version goes into a different
490     # slot to the old version, then the old version gets left behind
491     #
492     # if USE=-vhosts, then we want to remove the old version, because
493     # the user is relying on portage to do the magical thing for it
494    
495     if [ "$IS_UPGRADE" = "1" ] ; then
496     einfo "Removing old version $REMOVE_PKG"
497    
498 stuart 1.18 emerge -C $CATEGORY/$REMOVE_PKG
499 stuart 1.14 fi
500 stuart 1.18 else
501     # vhosts flag is on
502     #
503     # let's tell the administrator what to do next
504    
505     einfo
506     einfo "The 'vhosts' USE flag is switched ON"
507     einfo "This means that Portage will not automatically run webapp-config to"
508     einfo "complete the installation."
509     einfo
510     einfo "To install $PN-$PVR into a virtual host, run the following command:"
511     einfo
512     einfo " webapp-config -I -h <host> -d $PN $PN $PVR"
513     einfo
514     einfo "For more details, see the webapp-config(8) man page"
515 stuart 1.10 fi
516 stuart 1.11
517     return 0
518 stuart 1.2 }
519 stuart 1.18
520     function webapp_pkg_prerm ()
521     {
522     # remove any virtual installs that there are
523    
524     local my_output
525     local x
526    
527     my_output="`webapp-config --list-installs $PN $PVR`"
528    
529     if [ "$?" != "0" ]; then
530     return
531     fi
532    
533     # the changes to IFS here are necessary to ensure that we can cope
534     # with directories that contain spaces in the file names
535    
536     # OLD_IFS="$IFS"
537     # IFS=" "
538    
539     for x in $my_output ; do
540     # IFS="$OLD_IFS"
541    
542     [ -f $x/.webapp ] && . $x/.webapp || ewarn "Cannot find file $x/.webapp"
543    
544     if [ -z "WEB_HOSTNAME" -o -z "WEB_INSTALLDIR" ]; then
545     ewarn "Don't forget to use webapp-config to remove the copy of"
546     ewarn "${PN}-${PVR} installed in"
547     ewarn
548     ewarn " $x"
549     ewarn
550     else
551     # we have enough information to remove the virtual copy ourself
552    
553     webapp-config -C -h ${WEB_HOSTNAME} -d ${WEB_INSTALLDIR}
554    
555     # if the removal fails - we carry on anyway!
556     fi
557     # IFS=" "
558     done
559    
560     # IFS="$OLD_IFS"
561     }

  ViewVC Help
Powered by ViewVC 1.1.20