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

Diff of /eclass/webapp.eclass

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

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

Legend:
Removed from v.1.18  
changed lines
  Added in v.1.57

  ViewVC Help
Powered by ViewVC 1.1.20