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

Contents of /eclass/webapp.eclass

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.72 - (show annotations) (download)
Wed Jul 18 14:59:29 2012 UTC (23 months, 3 weeks ago) by blueness
Branch: MAIN
CVS Tags: HEAD
Changes since 1.71: +2 -2 lines
Don't ebeep at even EAPI=3, bug #386555.

1 # Copyright 1999-2011 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.71 2012/07/15 22:45:12 cardoe Exp $
4
5 # @ECLASS: webapp.eclass
6 # @MAINTAINER:
7 # web-apps@gentoo.org
8 # @BLURB: functions for installing applications to run under a web server
9 # @DESCRIPTION:
10 # The webapp eclass contains functions to handle web applications with
11 # webapp-config. Part of the implementation of GLEP #11
12
13 # @ECLASS-VARIABLE: WEBAPP_DEPEND
14 # @DESCRIPTION:
15 # An ebuild should use WEBAPP_DEPEND if a custom DEPEND needs to be built, most
16 # notably in combination with WEBAPP_OPTIONAL.
17 WEBAPP_DEPEND=">=app-admin/webapp-config-1.50.15"
18
19 # @ECLASS-VARIABLE: WEBAPP_NO_AUTO_INSTALL
20 # @DESCRIPTION:
21 # An ebuild sets this to `yes' if an automatic installation and/or upgrade is
22 # not possible. The ebuild should overwrite pkg_postinst() and explain the
23 # reason for this BEFORE calling webapp_pkg_postinst().
24
25 # @ECLASS-VARIABLE: WEBAPP_OPTIONAL
26 # @DESCRIPTION:
27 # An ebuild sets this to `yes' to make webapp support optional, in which case
28 # you also need to take care of USE-flags and dependencies.
29
30 if [[ "${WEBAPP_OPTIONAL}" != "yes" ]]; then
31 [[ "${WEBAPP_NO_AUTO_INSTALL}" == "yes" ]] || IUSE="vhosts"
32 SLOT="${PVR}"
33 DEPEND="${WEBAPP_DEPEND}"
34 RDEPEND="${DEPEND}"
35 fi
36
37 EXPORT_FUNCTIONS pkg_postinst pkg_setup src_install pkg_prerm
38
39 INSTALL_DIR="/${PN}"
40 IS_UPGRADE=0
41 IS_REPLACE=0
42
43 INSTALL_CHECK_FILE="installed_by_webapp_eclass"
44 SETUP_CHECK_FILE="setup_by_webapp_eclass"
45
46 ETC_CONFIG="${ROOT}etc/vhosts/webapp-config"
47 WEBAPP_CONFIG="${ROOT}usr/sbin/webapp-config"
48 WEBAPP_CLEANER="${ROOT}usr/sbin/webapp-cleaner"
49
50 # ==============================================================================
51 # INTERNAL FUNCTIONS
52 # ==============================================================================
53
54 # Load the config file /etc/vhosts/webapp-config
55 # Supports both the old bash version, and the new python version
56 webapp_read_config() {
57 debug-print-function $FUNCNAME $*
58
59 if has_version '>=app-admin/webapp-config-1.50'; then
60 ENVVAR=$(${WEBAPP_CONFIG} --query ${PN} ${PVR}) || die "Could not read settings from webapp-config!"
61 eval ${ENVVAR}
62 elif [[ "${WEBAPP_OPTIONAL}" != "yes" ]]; then
63 # ETC_CONFIG might not be available
64 . ${ETC_CONFIG} || die "Unable to read ${ETC_CONFIG}"
65 elif [[ -f "${ETC_CONFIG}" ]]; then
66 # WEBAPP_OPTIONAL is set to yes
67 # and this must run only if ETC_CONFIG actually exists
68 . ${ETC_CONFIG} || die "Unable to read ${ETC_CONFIG}"
69 fi
70 }
71
72 # Check whether a specified file exists in the given directory (`.' by default)
73 webapp_checkfileexists() {
74 debug-print-function $FUNCNAME $*
75
76 local my_prefix=${2:+${2}/}
77
78 if [[ ! -e "${my_prefix}${1}" ]]; then
79 msg="ebuild fault: file '${1}' not found"
80 eerror "$msg"
81 eerror "Please report this as a bug at http://bugs.gentoo.org/"
82 die "$msg"
83 fi
84 }
85
86 webapp_check_installedat() {
87 debug-print-function $FUNCNAME $*
88 ${WEBAPP_CONFIG} --show-installed -h localhost -d "${INSTALL_DIR}" 2> /dev/null
89 }
90
91 webapp_strip_appdir() {
92 debug-print-function $FUNCNAME $*
93 echo "${1#${MY_APPDIR}/}"
94 }
95
96 webapp_strip_d() {
97 debug-print-function $FUNCNAME $*
98 echo "${1#${D}}"
99 }
100
101 webapp_strip_cwd() {
102 debug-print-function $FUNCNAME $*
103 echo "${1/#.\///}"
104 }
105
106 webapp_getinstalltype() {
107 debug-print-function $FUNCNAME $*
108
109 if ! has vhosts ${IUSE} || use vhosts; then
110 return
111 fi
112
113 local my_output
114 my_output="$(webapp_check_installedat)"
115
116 if [[ $? -eq 0 ]]; then
117 # something is already installed there
118 # make sure it isn't the same version
119
120 local my_pn="$(echo ${my_output} | awk '{ print $1 }')"
121 local my_pvr="$(echo ${my_output} | awk '{ print $2 }')"
122
123 REMOVE_PKG="${my_pn}-${my_pvr}"
124
125 if [[ "${my_pn}" == "${PN}" ]]; then
126 if [[ "${my_pvr}" != "${PVR}" ]]; then
127 elog "This is an upgrade"
128 IS_UPGRADE=1
129 # for binpkgs, reset status, var declared in global scope
130 IS_REPLACE=0
131 else
132 elog "This is a re-installation"
133 IS_REPLACE=1
134 # for binpkgs, reset status, var declared in global scope
135 IS_UPGRADE=0
136 fi
137 else
138 elog "${my_output} is installed there"
139 fi
140 else
141 # for binpkgs, reset status, var declared in global scope
142 IS_REPLACE=0
143 IS_UPGRADE=0
144 elog "This is an installation"
145 fi
146 }
147
148 # ==============================================================================
149 # PUBLIC FUNCTIONS
150 # ==============================================================================
151
152 # @FUNCTION: need_httpd
153 # @DESCRIPTION:
154 # Call this function AFTER your ebuilds DEPEND line if any of the available
155 # webservers are able to run this application.
156 need_httpd() {
157 DEPEND="${DEPEND}
158 || ( virtual/httpd-basic virtual/httpd-cgi virtual/httpd-fastcgi )"
159 }
160
161 # @FUNCTION: need_httpd_cgi
162 # @DESCRIPTION:
163 # Call this function AFTER your ebuilds DEPEND line if any of the available
164 # CGI-capable webservers are able to run this application.
165 need_httpd_cgi() {
166 DEPEND="${DEPEND}
167 || ( virtual/httpd-cgi virtual/httpd-fastcgi )"
168 }
169
170 # @FUNCTION: need_httpd_fastcgi
171 # @DESCRIPTION:
172 # Call this function AFTER your ebuilds DEPEND line if any of the available
173 # FastCGI-capabale webservers are able to run this application.
174 need_httpd_fastcgi() {
175 DEPEND="${DEPEND}
176 virtual/httpd-fastcgi"
177 }
178
179 # @FUNCTION: webapp_configfile
180 # @USAGE: <file> [more files ...]
181 # @DESCRIPTION:
182 # Mark a file config-protected for a web-based application.
183 webapp_configfile() {
184 debug-print-function $FUNCNAME $*
185
186 local m
187 for m in "$@"; do
188 webapp_checkfileexists "${m}" "${D}"
189
190 local my_file="$(webapp_strip_appdir "${m}")"
191 my_file="$(webapp_strip_cwd "${my_file}")"
192
193 elog "(config) ${my_file}"
194 echo "${my_file}" >> ${D}/${WA_CONFIGLIST}
195 done
196 }
197
198 # @FUNCTION: webapp_hook_script
199 # @USAGE: <file>
200 # @DESCRIPTION:
201 # Install a script that will run after a virtual copy is created, and
202 # before a virtual copy has been removed.
203 webapp_hook_script() {
204 debug-print-function $FUNCNAME $*
205
206 webapp_checkfileexists "${1}"
207
208 elog "(hook) ${1}"
209 cp "${1}" "${D}/${MY_HOOKSCRIPTSDIR}/$(basename "${1}")" || die "Unable to install ${1} into ${D}/${MY_HOOKSCRIPTSDIR}/"
210 chmod 555 "${D}/${MY_HOOKSCRIPTSDIR}/$(basename "${1}")"
211 }
212
213 # @FUNCTION: webapp_postinst_txt
214 # @USAGE: <lang> <file>
215 # @DESCRIPTION:
216 # Install a text file containing post-installation instructions.
217 webapp_postinst_txt() {
218 debug-print-function $FUNCNAME $*
219
220 webapp_checkfileexists "${2}"
221
222 elog "(info) ${2} (lang: ${1})"
223 cp "${2}" "${D}/${MY_APPDIR}/postinst-${1}.txt"
224 }
225
226 # @FUNCTION: webapp_postupgrade_txt
227 # @USAGE: <lang> <file>
228 # @DESCRIPTION:
229 # Install a text file containing post-upgrade instructions.
230 webapp_postupgrade_txt() {
231 debug-print-function $FUNCNAME $*
232
233 webapp_checkfileexists "${2}"
234
235 elog "(info) ${2} (lang: ${1})"
236 cp "${2}" "${D}/${MY_APPDIR}/postupgrade-${1}.txt"
237 }
238
239 # helper for webapp_serverowned()
240 _webapp_serverowned() {
241 debug-print-function $FUNCNAME $*
242
243 webapp_checkfileexists "${1}" "${D}"
244 local my_file="$(webapp_strip_appdir "${1}")"
245 my_file="$(webapp_strip_cwd "${my_file}")"
246
247 elog "(server owned) ${my_file}"
248 echo "${my_file}" >> "${D}/${WA_SOLIST}"
249 }
250
251 # @FUNCTION: webapp_serverowned
252 # @USAGE: [-R] <file> [more files ...]
253 # @DESCRIPTION:
254 # Identify a file which must be owned by the webserver's user:group settings.
255 # The ownership of the file is NOT set until the application is installed using
256 # the webapp-config tool. If -R is given directories are handled recursively.
257 webapp_serverowned() {
258 debug-print-function $FUNCNAME $*
259
260 local a m
261 if [[ "${1}" == "-R" ]]; then
262 shift
263 for m in "$@"; do
264 find "${D}${m}" | while read a; do
265 a=$(webapp_strip_d "${a}")
266 _webapp_serverowned "${a}"
267 done
268 done
269 else
270 for m in "$@"; do
271 _webapp_serverowned "${m}"
272 done
273 fi
274 }
275
276 # @FUNCTION: webapp_server_configfile
277 # @USAGE: <server> <file> [new name]
278 # @DESCRIPTION:
279 # Install a configuration file for the webserver. You need to specify a
280 # webapp-config supported <server>. if no new name is given `basename $2' is
281 # used by default. Note: this function will automagically prepend $1 to the
282 # front of your config file's name.
283 webapp_server_configfile() {
284 debug-print-function $FUNCNAME $*
285
286 webapp_checkfileexists "${2}"
287
288 # WARNING:
289 #
290 # do NOT change the naming convention used here without changing all
291 # the other scripts that also rely upon these names
292
293 local my_file="${1}-${3:-$(basename "${2}")}"
294
295 elog "(${1}) config file '${my_file}'"
296 cp "${2}" "${D}/${MY_SERVERCONFIGDIR}/${my_file}"
297 }
298
299 # @FUNCTION: webapp_sqlscript
300 # @USAGE: <db> <file> [version]
301 # @DESCRIPTION:
302 # Install a SQL script that creates/upgrades a database schema for the web
303 # application. Currently supported database engines are mysql and postgres.
304 # If a version is given the script should upgrade the database schema from
305 # the given version to $PVR.
306 webapp_sqlscript() {
307 debug-print-function $FUNCNAME $*
308
309 webapp_checkfileexists "${2}"
310
311 dodir "${MY_SQLSCRIPTSDIR}/${1}"
312
313 # WARNING:
314 #
315 # do NOT change the naming convention used here without changing all
316 # the other scripts that also rely upon these names
317
318 if [[ -n "${3}" ]]; then
319 elog "(${1}) upgrade script for ${PN}-${3} to ${PVR}"
320 cp "${2}" "${D}${MY_SQLSCRIPTSDIR}/${1}/${3}_to_${PVR}.sql"
321 chmod 600 "${D}${MY_SQLSCRIPTSDIR}/${1}/${3}_to_${PVR}.sql"
322 else
323 elog "(${1}) create script for ${PN}-${PVR}"
324 cp "${2}" "${D}/${MY_SQLSCRIPTSDIR}/${1}/${PVR}_create.sql"
325 chmod 600 "${D}/${MY_SQLSCRIPTSDIR}/${1}/${PVR}_create.sql"
326 fi
327 }
328
329 # @FUNCTION: webapp_src_preinst
330 # @DESCRIPTION:
331 # You need to call this function in src_install() BEFORE anything else has run.
332 # For now we just create required webapp-config directories.
333 webapp_src_preinst() {
334 debug-print-function $FUNCNAME $*
335
336 # sanity checks, to catch bugs in the ebuild
337 if [[ ! -f "${T}/${SETUP_CHECK_FILE}" ]]; then
338 eerror
339 eerror "This ebuild did not call webapp_pkg_setup() at the beginning"
340 eerror "of the pkg_setup() function"
341 eerror
342 eerror "Please log a bug on http://bugs.gentoo.org"
343 eerror
344 eerror "You should use emerge -C to remove this package, as the"
345 eerror "installation is incomplete"
346 eerror
347 die "Ebuild did not call webapp_pkg_setup() - report to http://bugs.gentoo.org"
348 fi
349
350 # Hint, see the webapp_read_config() function to find where these are
351 # defined.
352 dodir "${MY_HTDOCSDIR}"
353 dodir "${MY_HOSTROOTDIR}"
354 dodir "${MY_CGIBINDIR}"
355 dodir "${MY_ICONSDIR}"
356 dodir "${MY_ERRORSDIR}"
357 dodir "${MY_SQLSCRIPTSDIR}"
358 dodir "${MY_HOOKSCRIPTSDIR}"
359 dodir "${MY_SERVERCONFIGDIR}"
360 }
361
362 # ==============================================================================
363 # EXPORTED FUNCTIONS
364 # ==============================================================================
365
366 # @FUNCTION: webapp_pkg_setup
367 # @DESCRIPTION:
368 # The default pkg_setup() for this eclass. This will gather required variables
369 # from webapp-config and check if there is an application installed to
370 # `${ROOT}/var/www/localhost/htdocs/${PN}/' if USE=vhosts is not set.
371 #
372 # You need to call this function BEFORE anything else has run in your custom
373 # pkg_setup().
374 webapp_pkg_setup() {
375 debug-print-function $FUNCNAME $*
376
377 # to test whether or not the ebuild has correctly called this function
378 # we add an empty file to the filesystem
379 #
380 # we used to just set a variable in the shell script, but we can
381 # no longer rely on Portage calling both webapp_pkg_setup() and
382 # webapp_src_install() within the same shell process
383 touch "${T}/${SETUP_CHECK_FILE}"
384
385 # special case - some ebuilds *do* need to overwride the SLOT
386 if [[ "${SLOT}+" != "${PVR}+" && "${WEBAPP_MANUAL_SLOT}" != "yes" ]]; then
387 die "Set WEBAPP_MANUAL_SLOT=\"yes\" if you need to SLOT manually"
388 fi
389
390 # pull in the shared configuration file
391 G_HOSTNAME="localhost"
392 webapp_read_config
393
394 local my_dir="${ROOT}${VHOST_ROOT}/${MY_HTDOCSBASE}/${PN}"
395
396 # if USE=vhosts is enabled OR no application is installed we're done here
397 if ! has vhosts ${IUSE} || use vhosts || [[ ! -d "${my_dir}" ]]; then
398 return
399 fi
400
401 local my_output
402 my_output="$(webapp_check_installedat)"
403
404 if [[ $? -ne 0 ]]; then
405 # okay, whatever is there, it isn't webapp-config-compatible
406 echo
407 ewarn
408 ewarn "You already have something installed in ${my_dir}"
409 ewarn
410 ewarn "Whatever is in ${my_dir}, it's not"
411 ewarn "compatible with webapp-config."
412 ewarn
413 ewarn "This ebuild may be overwriting important files."
414 ewarn
415 echo
416 if has "${EAPI:-0}" 0 1 2; then
417 ebeep 10
418 fi
419 elif [[ "$(echo ${my_output} | awk '{ print $1 }')" != "${PN}" ]]; then
420 echo
421 eerror "You already have ${my_output} installed in ${my_dir}"
422 eerror
423 eerror "I cannot upgrade a different application"
424 eerror
425 echo
426 die "Cannot upgrade contents of ${my_dir}"
427 fi
428
429 }
430
431 # @FUNCTION: webapp_src_install
432 # @DESCRIPTION:
433 # This is the default src_install(). For now, we just make sure that root owns
434 # everything, and that there are no setuid files.
435 #
436 # You need to call this function AFTER everything else has run in your custom
437 # src_install().
438 webapp_src_install() {
439 debug-print-function $FUNCNAME $*
440
441 # to test whether or not the ebuild has correctly called this function
442 # we add an empty file to the filesystem
443 #
444 # we used to just set a variable in the shell script, but we can
445 # no longer rely on Portage calling both webapp_src_install() and
446 # webapp_pkg_postinst() within the same shell process
447 touch "${D}/${MY_APPDIR}/${INSTALL_CHECK_FILE}"
448
449 chown -R "${VHOST_DEFAULT_UID}:${VHOST_DEFAULT_GID}" "${D}/"
450 chmod -R u-s "${D}/"
451 chmod -R g-s "${D}/"
452
453 keepdir "${MY_PERSISTDIR}"
454 fowners "root:0" "${MY_PERSISTDIR}"
455 fperms 755 "${MY_PERSISTDIR}"
456 }
457
458 # @FUNCTION: webapp_pkg_postinst
459 # @DESCRIPTION:
460 # The default pkg_postinst() for this eclass. This installs the web application to
461 # `${ROOT}/var/www/localhost/htdocs/${PN}/' if USE=vhosts is not set. Otherwise
462 # display a short notice how to install this application with webapp-config.
463 #
464 # You need to call this function AFTER everything else has run in your custom
465 # pkg_postinst().
466 webapp_pkg_postinst() {
467 debug-print-function $FUNCNAME $*
468
469 webapp_read_config
470
471 # sanity checks, to catch bugs in the ebuild
472 if [[ ! -f "${ROOT}${MY_APPDIR}/${INSTALL_CHECK_FILE}" ]]; then
473 eerror
474 eerror "This ebuild did not call webapp_src_install() at the end"
475 eerror "of the src_install() function"
476 eerror
477 eerror "Please log a bug on http://bugs.gentoo.org"
478 eerror
479 eerror "You should use emerge -C to remove this package, as the"
480 eerror "installation is incomplete"
481 eerror
482 die "Ebuild did not call webapp_src_install() - report to http://bugs.gentoo.org"
483 fi
484
485 if has vhosts ${IUSE}; then
486 if ! use vhosts; then
487 echo
488 elog "vhosts USE flag not set - auto-installing using webapp-config"
489
490 G_HOSTNAME="localhost"
491 webapp_read_config
492
493 local my_mode=-I
494 webapp_getinstalltype
495
496 if [[ "${IS_REPLACE}" == "1" ]]; then
497 elog "${PN}-${PVR} is already installed - replacing"
498 my_mode=-I
499 elif [[ "${IS_UPGRADE}" == "1" ]]; then
500 elog "${REMOVE_PKG} is already installed - upgrading"
501 my_mode=-U
502 else
503 elog "${PN}-${PVR} is not installed - using install mode"
504 fi
505
506 my_cmd="${WEBAPP_CONFIG} ${my_mode} -h localhost -u root -d ${INSTALL_DIR} ${PN} ${PVR}"
507 elog "Running ${my_cmd}"
508 ${my_cmd}
509
510 echo
511 local cleaner="${WEBAPP_CLEANER} -p -C /${PN}"
512 einfo "Running ${cleaner}"
513 ${cleaner}
514 else
515 elog
516 elog "The 'vhosts' USE flag is switched ON"
517 elog "This means that Portage will not automatically run webapp-config to"
518 elog "complete the installation."
519 elog
520 elog "To install ${PN}-${PVR} into a virtual host, run the following command:"
521 elog
522 elog " webapp-config -I -h <host> -d ${PN} ${PN} ${PVR}"
523 elog
524 elog "For more details, see the webapp-config(8) man page"
525 fi
526 else
527 elog
528 elog "This ebuild does not support the 'vhosts' USE flag."
529 elog "This means that Portage will not automatically run webapp-config to"
530 elog "complete the installation."
531 elog
532 elog "To install ${PN}-${PVR} into a virtual host, run the following command:"
533 elog
534 elog " webapp-config -I -h <host> -d ${PN} ${PN} ${PVR}"
535 elog
536 elog "For more details, see the webapp-config(8) man page"
537 fi
538 }
539
540 # @FUNCTION: webapp_pkg_prerm
541 # @DESCRIPTION:
542 # This is the default pkg_prerm() for this eclass. If USE=vhosts is not set
543 # remove all installed copies of this web application. Otherwise instruct the
544 # user to manually remove those copies. See bug #136959.
545 webapp_pkg_prerm() {
546 debug-print-function $FUNCNAME $*
547
548 local my_output=
549 my_output="$(${WEBAPP_CONFIG} --list-installs ${PN} ${PVR})"
550 [[ $? -ne 0 ]] && return
551
552 local x
553 if has vhosts ${IUSE} && ! use vhosts; then
554 echo "${my_output}" | while read x; do
555 if [[ -f "${x}"/.webapp ]]; then
556 . "${x}"/.webapp
557 if [[ -n "${WEB_HOSTNAME}" && -n "${WEB_INSTALLDIR}" ]]; then
558 ${WEBAPP_CONFIG} -C -h ${WEB_HOSTNAME} -d ${WEB_INSTALLDIR} ${PN} ${PVR}
559 fi
560 else
561 ewarn "Cannot find file ${x}/.webapp"
562 fi
563 done
564 elif [[ "${my_output}" != "" ]]; then
565 echo
566 ewarn
567 ewarn "Don't forget to use webapp-config to remove any copies of"
568 ewarn "${PN}-${PVR} installed in"
569 ewarn
570
571 echo "${my_output}" | while read x; do
572 if [[ -f "${x}"/.webapp ]]; then
573 ewarn " ${x}"
574 else
575 ewarn "Cannot find file ${x}/.webapp"
576 fi
577 done
578
579 ewarn
580 echo
581 fi
582 }

  ViewVC Help
Powered by ViewVC 1.1.20