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

Diff of /eclass/webapp.eclass

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

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

Legend:
Removed from v.1.1.1.1  
changed lines
  Added in v.1.75

  ViewVC Help
Powered by ViewVC 1.1.20