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

Contents of /eclass/webapp.eclass

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.44 - (show annotations) (download)
Tue Jul 11 02:36:23 2006 UTC (8 years, 5 months ago) by rl03
Branch: MAIN
Changes since 1.43: +4 -12 lines
Remove user-visible SLOT warning from webapp.eclass

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

  ViewVC Help
Powered by ViewVC 1.1.20