| 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.13 2004/04/30 08:25:38 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 | # Please do not make modifications to this file without checking with a |
|
|
| 15 | # member of the web-apps herd first! |
|
|
| 16 | # |
|
|
| 17 | # ------------------------------------------------------------------------ |
|
|
| 18 | |
12 | |
| 19 | ECLASS=webapp |
|
|
| 20 | INHERITED="$INHERITED $ECLASS" |
|
|
| 21 | SLOT="${PVR}" |
13 | SLOT="${PVR}" |
| 22 | IUSE="$IUSE vhosts" |
14 | IUSE="vhosts" |
| 23 | DEPEND="$DEPEND >=net-www/webapp-config-1.6" |
15 | DEPEND=">=app-admin/webapp-config-1.50.15" |
|
|
16 | RDEPEND="${DEPEND}" |
| 24 | |
17 | |
| 25 | EXPORT_FUNCTIONS pkg_postinst pkg_setup src_install |
18 | EXPORT_FUNCTIONS pkg_postinst pkg_setup src_install pkg_prerm |
| 26 | |
19 | |
| 27 | # ------------------------------------------------------------------------ |
20 | INSTALL_DIR="/${PN}" |
| 28 | # INTERNAL FUNCTION - USED BY THIS ECLASS ONLY |
21 | IS_UPGRADE=0 |
| 29 | # |
22 | IS_REPLACE=0 |
|
|
23 | |
|
|
24 | INSTALL_CHECK_FILE="installed_by_webapp_eclass" |
|
|
25 | SETUP_CHECK_FILE="setup_by_webapp_eclass" |
|
|
26 | |
|
|
27 | ETC_CONFIG="${ROOT}etc/vhosts/webapp-config" |
|
|
28 | WEBAPP_CONFIG="${ROOT}usr/sbin/webapp-config" |
|
|
29 | WEBAPP_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 |
|
|
37 | webapp_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 | |
| 30 | # Check whether a specified file exists within the image/ directory |
48 | # Check whether a specified file exists in the given directory (`.' by default) |
| 31 | # or not. |
|
|
| 32 | # |
|
|
| 33 | # @param $1 - file to look for |
|
|
| 34 | # @param $2 - prefix directory to use |
|
|
| 35 | # @return 0 on success, never returns on an error |
|
|
| 36 | # ------------------------------------------------------------------------ |
|
|
| 37 | |
|
|
| 38 | function webapp_checkfileexists () |
49 | webapp_checkfileexists() { |
| 39 | { |
50 | debug-print-function $FUNCNAME $* |
| 40 | local my_prefix |
|
|
| 41 | |
51 | |
| 42 | [ -n "$2" ] && my_prefix="$2/" || my_prefix= |
52 | local my_prefix=${2:+${2}/} |
| 43 | |
53 | |
| 44 | if [ ! -e ${my_prefix}$1 ]; then |
54 | if [[ ! -e "${my_prefix}${1}" ]]; then |
| 45 | msg="ebuild fault: file $1 not found" |
55 | msg="ebuild fault: file '${1}' not found" |
| 46 | eerror "$msg" |
56 | eerror "$msg" |
| 47 | 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/" |
| 48 | die "$msg" |
58 | die "$msg" |
| 49 | fi |
59 | fi |
| 50 | } |
60 | } |
| 51 | |
61 | |
| 52 | # ------------------------------------------------------------------------ |
62 | webapp_check_installedat() { |
| 53 | # INTERNAL FUNCTION - USED BY THIS ECLASS ONLY |
63 | debug-print-function $FUNCNAME $* |
| 54 | # ------------------------------------------------------------------------ |
64 | ${WEBAPP_CONFIG} --show-installed -h localhost -d "${INSTALL_DIR}" 2> /dev/null |
|
|
65 | } |
| 55 | |
66 | |
| 56 | function webapp_import_config () |
67 | webapp_strip_appdir() { |
| 57 | { |
68 | debug-print-function $FUNCNAME $* |
| 58 | if [ -z "${MY_HTDOCSDIR}" ]; then |
69 | echo "${1#${MY_APPDIR}/}" |
| 59 | . /etc/conf.d/webapp-config |
70 | } |
|
|
71 | |
|
|
72 | webapp_strip_d() { |
|
|
73 | debug-print-function $FUNCNAME $* |
|
|
74 | echo "${1#${D}}" |
|
|
75 | } |
|
|
76 | |
|
|
77 | webapp_strip_cwd() { |
|
|
78 | debug-print-function $FUNCNAME $* |
|
|
79 | echo "${1/#.\///}" |
|
|
80 | } |
|
|
81 | |
|
|
82 | webapp_getinstalltype() { |
|
|
83 | debug-print-function $FUNCNAME $* |
|
|
84 | use vhosts && return |
|
|
85 | |
|
|
86 | local my_output |
|
|
87 | my_output="$(webapp_check_installedat)" |
|
|
88 | |
|
|
89 | if [[ $? -eq 0 ]]; then |
|
|
90 | # something is already installed there |
|
|
91 | # make sure it isn't the same version |
|
|
92 | |
|
|
93 | local my_pn="$(echo ${my_output} | awk '{ print $1 }')" |
|
|
94 | local my_pvr="$(echo ${my_output} | awk '{ print $2 }')" |
|
|
95 | |
|
|
96 | REMOVE_PKG="${my_pn}-${my_pvr}" |
|
|
97 | |
|
|
98 | if [[ "${my_pn}" == "${PN}" ]]; then |
|
|
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" |
| 60 | fi |
108 | fi |
| 61 | |
109 | else |
| 62 | if [ -z "${MY_HTDOCSDIR}" ]; then |
110 | elog "This is an installation" |
| 63 | libsh_edie "/etc/conf.d/webapp-config not imported" |
|
|
| 64 | fi |
111 | fi |
| 65 | } |
112 | } |
| 66 | |
113 | |
| 67 | # ------------------------------------------------------------------------ |
114 | # ============================================================================== |
| 68 | # INTERNAL FUNCTION - USED BY THIS ECLASS ONLY |
115 | # PUBLIC FUNCTIONS |
| 69 | # |
116 | # ============================================================================== |
| 70 | # ------------------------------------------------------------------------ |
|
|
| 71 | |
117 | |
| 72 | function webapp_strip_appdir () |
118 | # @FUNCTION: webapp_configfile |
| 73 | { |
119 | # @USAGE: <file> [more files ...] |
| 74 | echo "$1" | sed -e "s|${MY_APPDIR}/||g;" |
120 | # @DESCRIPTION: |
| 75 | } |
121 | # Mark a file config-protected for a web-based application. |
| 76 | |
|
|
| 77 | function webapp_strip_d () |
|
|
| 78 | { |
|
|
| 79 | echo "$1" | sed -e "s|${D}||g;" |
|
|
| 80 | } |
|
|
| 81 | |
|
|
| 82 | function webapp_strip_cwd () |
|
|
| 83 | { |
|
|
| 84 | echo "$1" | sed -e 's|/./|/|g;' |
|
|
| 85 | } |
|
|
| 86 | |
|
|
| 87 | # ------------------------------------------------------------------------ |
|
|
| 88 | # EXPORTED FUNCTION - FOR USE IN EBUILDS |
|
|
| 89 | # |
|
|
| 90 | # Identify a config file for a web-based application. |
|
|
| 91 | # |
|
|
| 92 | # @param $1 - config file |
|
|
| 93 | # ------------------------------------------------------------------------ |
|
|
| 94 | |
|
|
| 95 | function webapp_configfile () |
122 | webapp_configfile() { |
| 96 | { |
123 | debug-print-function $FUNCNAME $* |
|
|
124 | |
|
|
125 | local m |
|
|
126 | for m in "$@"; do |
| 97 | webapp_checkfileexists "$1" "$D" |
127 | webapp_checkfileexists "${m}" "${D}" |
| 98 | echo $1 |
|
|
| 99 | local MY_FILE="`webapp_strip_appdir $1`" |
|
|
| 100 | echo $MY_FILE |
|
|
| 101 | |
128 | |
| 102 | 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}" |
| 103 | echo "$MY_FILE" >> ${D}${WA_CONFIGLIST} |
133 | echo "${my_file}" >> ${D}/${WA_CONFIGLIST} |
|
|
134 | done |
| 104 | } |
135 | } |
| 105 | |
136 | |
| 106 | # ------------------------------------------------------------------------ |
137 | # @FUNCTION: webapp_hook_script |
| 107 | # EXPORTED FUNCTION - FOR USE IN EBUILDS |
138 | # @USAGE: <file> |
| 108 | # |
139 | # @DESCRIPTION: |
|
|
140 | # Install a script that will run after a virtual copy is created, and |
|
|
141 | # before a virtual copy has been removed. |
|
|
142 | webapp_hook_script() { |
|
|
143 | debug-print-function $FUNCNAME $* |
|
|
144 | |
|
|
145 | webapp_checkfileexists "${1}" |
|
|
146 | |
|
|
147 | elog "(hook) ${1}" |
|
|
148 | cp "${1}" "${D}/${MY_HOOKSCRIPTSDIR}/$(basename "${1}")" || die "Unable to install ${1} into ${D}/${MY_HOOKSCRIPTSDIR}/" |
|
|
149 | chmod 555 "${D}/${MY_HOOKSCRIPTSDIR}/$(basename "${1}")" |
|
|
150 | } |
|
|
151 | |
|
|
152 | # @FUNCTION: webapp_postinst_txt |
|
|
153 | # @USAGE: <lang> <file> |
|
|
154 | # @DESCRIPTION: |
| 109 | # Install a text file containing post-installation instructions. |
155 | # Install a text file containing post-installation instructions. |
| 110 | # |
156 | webapp_postinst_txt() { |
| 111 | # @param $1 - language code (use 'en' for now) |
157 | debug-print-function $FUNCNAME $* |
| 112 | # @param $2 - the file to install |
|
|
| 113 | # ------------------------------------------------------------------------ |
|
|
| 114 | |
158 | |
| 115 | function webapp_postinst_txt |
|
|
| 116 | { |
|
|
| 117 | webapp_checkfileexists "$2" |
159 | webapp_checkfileexists "${2}" |
| 118 | |
160 | |
| 119 | einfo "(rtfm) $2 (lang: $1)" |
161 | elog "(info) ${2} (lang: ${1})" |
| 120 | cp "$2" "${D}${MY_APPDIR}/postinst-$1.txt" |
162 | cp "${2}" "${D}/${MY_APPDIR}/postinst-${1}.txt" |
| 121 | } |
163 | } |
| 122 | |
164 | |
| 123 | # ------------------------------------------------------------------------ |
165 | # @FUNCTION: webapp_postupgrade_txt |
| 124 | # EXPORTED FUNCTION - FOR USE IN EBUILDS |
166 | # @USAGE: <lang> <file> |
| 125 | # |
167 | # @DESCRIPTION: |
| 126 | # Identify a script file (usually, but not always PHP or Perl) which is |
168 | # Install a text file containing post-upgrade instructions. |
| 127 | # |
169 | webapp_postupgrade_txt() { |
| 128 | # Files in this list may be modified to #! the required CGI engine when |
170 | debug-print-function $FUNCNAME $* |
| 129 | # installed by webapp-config tool in the future. |
|
|
| 130 | # |
|
|
| 131 | # @param $1 - the cgi engine to use |
|
|
| 132 | # @param $2 - the script file that could run under a cgi-bin |
|
|
| 133 | # |
|
|
| 134 | # ------------------------------------------------------------------------ |
|
|
| 135 | |
171 | |
| 136 | function webapp_runbycgibin () |
|
|
| 137 | { |
|
|
| 138 | webapp_checkfileexists "$2" "$D" |
|
|
| 139 | local MY_FILE="`webapp_strip_appdir $2`" |
|
|
| 140 | MY_FILE="`webapp_strip_cwd $MY_FILE`" |
|
|
| 141 | |
|
|
| 142 | einfo "(cgi-bin) $1 - $MY_FILE" |
|
|
| 143 | echo "$1 $MY_FILE" >> ${D}${WA_RUNBYCGIBINLIST} |
|
|
| 144 | } |
|
|
| 145 | |
|
|
| 146 | # ------------------------------------------------------------------------ |
|
|
| 147 | # EXPORTED FUNCTION - FOR USE IN EBUILDS |
|
|
| 148 | # |
|
|
| 149 | # Identify a file which must be owned by the webserver's user:group |
|
|
| 150 | # settings. |
|
|
| 151 | # |
|
|
| 152 | # The ownership of the file is NOT set until the application is installed |
|
|
| 153 | # using the webapp-config tool. |
|
|
| 154 | # |
|
|
| 155 | # @param $1 - file to be owned by the webserver user:group combo |
|
|
| 156 | # |
|
|
| 157 | # ------------------------------------------------------------------------ |
|
|
| 158 | |
|
|
| 159 | function webapp_serverowned () |
|
|
| 160 | { |
|
|
| 161 | webapp_checkfileexists "$1" "$D" |
|
|
| 162 | local MY_FILE="`webapp_strip_appdir $1`" |
|
|
| 163 | |
|
|
| 164 | einfo "(server owned) $MY_FILE" |
|
|
| 165 | echo "$MY_FILE" >> ${D}${WA_SOLIST} |
|
|
| 166 | } |
|
|
| 167 | |
|
|
| 168 | # ------------------------------------------------------------------------ |
|
|
| 169 | # EXPORTED FUNCTION - FOR USE IN EBUILDS |
|
|
| 170 | # |
|
|
| 171 | # |
|
|
| 172 | # @param $1 - the db engine that the script is for |
|
|
| 173 | # (one of: mysql|postgres) |
|
|
| 174 | # @param $2 - the sql script to be installed |
|
|
| 175 | # @param $3 - the older version of the app that this db script |
|
|
| 176 | # will upgrade from |
|
|
| 177 | # (do not pass this option if your SQL script only creates |
|
|
| 178 | # a new db from scratch) |
|
|
| 179 | # ------------------------------------------------------------------------ |
|
|
| 180 | |
|
|
| 181 | function webapp_sqlscript () |
|
|
| 182 | { |
|
|
| 183 | webapp_checkfileexists "$2" |
172 | webapp_checkfileexists "${2}" |
| 184 | |
173 | |
| 185 | # create the directory where this script will go |
174 | elog "(info) ${2} (lang: ${1})" |
| 186 | # |
175 | cp "${2}" "${D}/${MY_APPDIR}/postupgrade-${1}.txt" |
| 187 | # scripts for specific database engines go into their own subdirectory |
176 | } |
| 188 | # just to keep things readable on the filesystem |
|
|
| 189 | |
177 | |
| 190 | if [ ! -d "${D}${MY_SQLSCRIPTSDIR}/$1" ]; then |
178 | # helper for webapp_serverowned() |
| 191 | mkdir -p "${D}${MY_SQLSCRIPTSDIR}/$1" || libsh_die "unable to create directory ${D}${MY_SQLSCRIPTSDIR}/$1" |
179 | _webapp_serverowned() { |
| 192 | fi |
180 | debug-print-function $FUNCNAME $* |
| 193 | |
181 | |
| 194 | # warning: |
182 | webapp_checkfileexists "${1}" "${D}" |
|
|
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. |
|
|
196 | webapp_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 |
|
|
208 | else |
|
|
209 | for m in "$@"; do |
|
|
210 | _webapp_serverowned "${m}" |
|
|
211 | done |
|
|
212 | fi |
|
|
213 | } |
|
|
214 | |
|
|
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. |
|
|
222 | webapp_server_configfile() { |
|
|
223 | debug-print-function $FUNCNAME $* |
|
|
224 | |
|
|
225 | webapp_checkfileexists "${2}" |
|
|
226 | |
|
|
227 | # WARNING: |
| 195 | # |
228 | # |
| 196 | # do NOT change the naming convention used here without changing all |
229 | # do NOT change the naming convention used here without changing all |
| 197 | # the other scripts that also rely upon these names |
230 | # the other scripts that also rely upon these names |
| 198 | |
231 | |
| 199 | # are we dealing with an 'upgrade'-type script? |
232 | local my_file="${1}-${3:-$(basename "${2}")}" |
|
|
233 | |
|
|
234 | elog "(${1}) config file '${my_file}'" |
|
|
235 | cp "${2}" "${D}/${MY_SERVERCONFIGDIR}/${my_file}" |
|
|
236 | } |
|
|
237 | |
|
|
238 | # @FUNCTION: webapp_sqlscript |
|
|
239 | # @USAGE: <db> <file> [version] |
|
|
240 | # @DESCRIPTION: |
|
|
241 | # Install a SQL script that creates/upgrades a database schema for the web |
|
|
242 | # application. Currently supported database engines are mysql and postgres. |
|
|
243 | # If a version is given the script should upgrade the database schema from |
|
|
244 | # the given version to $PVR. |
|
|
245 | webapp_sqlscript() { |
|
|
246 | debug-print-function $FUNCNAME $* |
|
|
247 | |
|
|
248 | webapp_checkfileexists "${2}" |
|
|
249 | |
|
|
250 | dodir "${MY_SQLSCRIPTSDIR}/${1}" |
|
|
251 | |
|
|
252 | # WARNING: |
|
|
253 | # |
|
|
254 | # do NOT change the naming convention used here without changing all |
|
|
255 | # the other scripts that also rely upon these names |
|
|
256 | |
| 200 | if [ -n "$3" ]; then |
257 | if [[ -n "${3}" ]]; then |
| 201 | # yes we are |
|
|
| 202 | einfo "($1) upgrade script from ${PN}-${PVR} to $3" |
258 | elog "(${1}) upgrade script for ${PN}-${3} to ${PVR}" |
| 203 | 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" |
| 204 | else |
261 | else |
| 205 | # no, we are not |
|
|
| 206 | einfo "($1) create script for ${PN}-${PVR}" |
262 | elog "(${1}) create script for ${PN}-${PVR}" |
| 207 | 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" |
| 208 | fi |
265 | fi |
| 209 | } |
266 | } |
| 210 | |
267 | |
| 211 | # ------------------------------------------------------------------------ |
268 | # @FUNCTION: webapp_src_preinst |
| 212 | # EXPORTED FUNCTION - call from inside your ebuild's src_install AFTER |
269 | # @DESCRIPTION: |
| 213 | # 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. |
|
|
272 | webapp_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. |
| 214 | # |
294 | # |
| 215 | # 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 |
| 216 | # are no setuid files. I'm sure this will change significantly before |
296 | # pkg_setup(). |
| 217 | # the final version! |
297 | webapp_pkg_setup() { |
| 218 | # ------------------------------------------------------------------------ |
298 | debug-print-function $FUNCNAME $* |
| 219 | |
299 | |
| 220 | function webapp_src_install () |
300 | # to test whether or not the ebuild has correctly called this function |
| 221 | { |
301 | # we add an empty file to the filesystem |
| 222 | chown -R root:root ${D}/ |
302 | # |
| 223 | chmod -R u-s ${D}/ |
303 | # we used to just set a variable in the shell script, but we can |
| 224 | 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}" |
| 225 | |
307 | |
| 226 | keepdir ${MY_PERSISTDIR} |
308 | # special case - some ebuilds *do* need to overwride the SLOT |
| 227 | fowners root:root ${MY_PERSISTDIR} |
309 | if [[ "${SLOT}+" != "${PVR}+" && "${WEBAPP_MANUAL_SLOT}" != "yes" ]]; then |
| 228 | fperms 755 ${MY_PERSISTDIR} |
310 | die "Set WEBAPP_MANUAL_SLOT=\"yes\" if you need to SLOT manually" |
| 229 | } |
311 | fi |
| 230 | |
312 | |
| 231 | # ------------------------------------------------------------------------ |
313 | # pull in the shared configuration file |
| 232 | # EXPORTED FUNCTION - call from inside your ebuild's pkg_config AFTER |
314 | G_HOSTNAME="localhost" |
| 233 | # everything else has run |
315 | webapp_read_config |
|
|
316 | |
|
|
317 | local my_dir="${ROOT}${VHOST_ROOT}/${MY_HTDOCSBASE}/${PN}" |
|
|
318 | |
|
|
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. |
| 234 | # |
354 | # |
| 235 | # 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(). |
|
|
357 | webapp_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. |
| 236 | # |
396 | # |
| 237 | # ------------------------------------------------------------------------ |
397 | # You need to call this function AFTER everything else has run in your custom |
| 238 | |
398 | # pkg_postinst(). |
| 239 | function webapp_pkg_setup () |
|
|
| 240 | { |
|
|
| 241 | # pull in the shared configuration file |
|
|
| 242 | |
|
|
| 243 | . /etc/vhosts/webapp-config || die "Unable to open /etc/vhosts/webapp-config file" |
|
|
| 244 | |
|
|
| 245 | # are we emerging something that is already installed? |
|
|
| 246 | |
|
|
| 247 | if [ -d "${D}${MY_APPROOT}/${MY_APPSUFFIX}" ]; then |
|
|
| 248 | # yes we are |
|
|
| 249 | ewarn "Removing existing copy of ${PN}-${PVR}" |
|
|
| 250 | rm -rf "${D}${MY_APPROOT}/${MY_APPSUFFIX}" |
|
|
| 251 | fi |
|
|
| 252 | } |
|
|
| 253 | |
|
|
| 254 | function webapp_src_preinst () |
|
|
| 255 | { |
|
|
| 256 | # create the directories that we need |
|
|
| 257 | |
|
|
| 258 | dodir ${MY_HTDOCSDIR} |
|
|
| 259 | dodir ${MY_HOSTROOTDIR} |
|
|
| 260 | dodir ${MY_CGIBINDIR} |
|
|
| 261 | dodir ${MY_ICONSDIR} |
|
|
| 262 | dodir ${MY_ERRORSDIR} |
|
|
| 263 | dodir ${MY_SQLSCRIPTSDIR} |
|
|
| 264 | } |
|
|
| 265 | |
|
|
| 266 | function webapp_pkg_postinst () |
399 | webapp_pkg_postinst() { |
| 267 | { |
400 | debug-print-function $FUNCNAME $* |
| 268 | einfo "webapp_pkg_postinst() called" |
|
|
| 269 | |
401 | |
| 270 | # if 'vhosts' is not set in your USE flags, we install a copy of |
402 | webapp_read_config |
| 271 | # this application in /var/www/localhost/htdocs/${PN}/ for you |
|
|
| 272 | |
403 | |
| 273 | |
404 | # sanity checks, to catch bugs in the ebuild |
|
|
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" |
|
|
416 | fi |
|
|
417 | |
| 274 | if ! use vhosts ; then |
418 | if ! use vhosts; then |
|
|
419 | echo |
| 275 | einfo "vhosts USE flag not set - auto-installing using webapp-config" |
420 | elog "vhosts USE flag not set - auto-installing using webapp-config" |
| 276 | |
421 | |
| 277 | G_HOSTNAME="localhost" |
422 | G_HOSTNAME="localhost" |
| 278 | . /etc/vhosts/webapp-config |
423 | webapp_read_config |
| 279 | |
424 | |
| 280 | local my_mode=-I |
425 | local my_mode=-I |
| 281 | local my_dir="/${PN}" |
426 | webapp_getinstalltype |
| 282 | |
427 | |
| 283 | # are we installing afresh - or are we upgrading? |
428 | if [[ "${IS_REPLACE}" == "1" ]]; then |
| 284 | # find out by looking to see what (if anything) is installed |
429 | elog "${PN}-${PVR} is already installed - replacing" |
| 285 | # in there already |
430 | my_mode=-I |
| 286 | |
431 | elif [[ "${IS_UPGRADE}" == "1" ]]; then |
| 287 | my_cmd="/usr/sbin/webapp-config --show-installed -d $my_dir 2> /dev/null" |
432 | elog "${REMOVE_PKG} is already installed - upgrading" |
| 288 | einfo "$my_cmd" |
|
|
| 289 | |
|
|
| 290 | my_output="`/usr/sbin/webapp-config --show-installed -d $my_dir 2> /dev/null`" |
|
|
| 291 | |
|
|
| 292 | # we can't use the exit status from webapp-config |
|
|
| 293 | |
|
|
| 294 | if [ "$?" = "0" ]; then |
|
|
| 295 | |
|
|
| 296 | # something is in there - but the question has to be ... what? |
|
|
| 297 | |
|
|
| 298 | ewarn "$my_output already installed" |
|
|
| 299 | |
|
|
| 300 | if [ "`echo $my_output | awk '{ print $1 }'`" = "${PN}" ]; then |
|
|
| 301 | einfo "$my_output is a copy of ${PN}" |
|
|
| 302 | if [ "`echo $my_output | awk '{ print $2 }'`" = "${PVR}" ]; then |
|
|
| 303 | # this version is already installed |
|
|
| 304 | # we need to remove it first |
|
|
| 305 | |
|
|
| 306 | /usr/sbin/webapp-config -C -d $my_dir |
|
|
| 307 | else |
|
|
| 308 | # we have an older version of whatever it is our ebuild is |
|
|
| 309 | # trying to install ;-) |
|
|
| 310 | # |
|
|
| 311 | # this is the situation we can deal with |
|
|
| 312 | |
|
|
| 313 | einfo "selecting upgrade mode" |
|
|
| 314 | my_mode=-U |
433 | my_mode=-U |
|
|
434 | else |
|
|
435 | elog "${PN}-${PVR} is not installed - using install mode" |
|
|
436 | fi |
|
|
437 | |
|
|
438 | my_cmd="${WEBAPP_CONFIG} ${my_mode} -h localhost -u root -d ${INSTALL_DIR} ${PN} ${PVR}" |
|
|
439 | elog "Running ${my_cmd}" |
|
|
440 | ${my_cmd} |
|
|
441 | |
|
|
442 | echo |
|
|
443 | local cleaner="${WEBAPP_CLEANER} -p -C ${PN}" |
|
|
444 | einfo "Running ${cleaner}" |
|
|
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" |
|
|
457 | fi |
|
|
458 | } |
|
|
459 | |
|
|
460 | # @FUNCTION: webapp_pkg_prerm |
|
|
461 | # @DESCRIPTION: |
|
|
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. |
|
|
465 | webapp_pkg_prerm() { |
|
|
466 | debug-print-function $FUNCNAME $* |
|
|
467 | |
|
|
468 | local my_output= |
|
|
469 | my_output="$(${WEBAPP_CONFIG} --list-installs ${PN} ${PVR})" |
|
|
470 | [[ $? -ne 0 ]] && return |
|
|
471 | |
|
|
472 | local x |
|
|
473 | if ! use vhosts; then |
|
|
474 | echo "${my_output}" | while read x; do |
|
|
475 | if [[ -f "${x}"/.webapp ]]; then |
|
|
476 | . "${x}"/.webapp |
|
|
477 | if [[ -n "${WEB_HOSTNAME}" && -n "${WEB_INSTALLDIR}" ]]; then |
|
|
478 | ${WEBAPP_CONFIG} -C -h ${WEB_HOSTNAME} -d ${WEB_INSTALLDIR} |
| 315 | fi |
479 | fi |
| 316 | else |
480 | else |
| 317 | # this should never happen - but just in case ... |
481 | ewarn "Cannot find file ${x}/.webapp" |
| 318 | # |
|
|
| 319 | # whatever is in that directory, it isn't the application |
|
|
| 320 | # that we are currently trying to install |
|
|
| 321 | # |
|
|
| 322 | # rather than overwrite the contents, we bail with an error |
|
|
| 323 | # instead |
|
|
| 324 | |
|
|
| 325 | die "$my_output is already installed in $my_dir" |
|
|
| 326 | fi |
482 | fi |
|
|
483 | done |
|
|
484 | elif [[ "${my_output}" != "" ]]; then |
|
|
485 | echo |
|
|
486 | ewarn |
|
|
487 | ewarn "Don't forget to use webapp-config to remove any copies of" |
|
|
488 | ewarn "${PN}-${PVR} installed in" |
|
|
489 | ewarn |
|
|
490 | |
|
|
491 | echo "${my_output}" | while read x; do |
|
|
492 | if [[ -f "${x}"/.webapp ]]; then |
|
|
493 | ewarn " ${x}" |
| 327 | else |
494 | else |
| 328 | einfo "${PN}-${PVR} is not installed - using install mode" |
495 | ewarn "Cannot find file ${x}/.webapp" |
| 329 | fi |
496 | fi |
| 330 | |
497 | done |
| 331 | my_cmd="/usr/sbin/webapp-config $my_mode -h localhost -u root -d $my_dir ${PN} ${PVR}" |
|
|
| 332 | einfo "Running $my_cmd" |
|
|
| 333 | $my_cmd |
|
|
| 334 | fi |
|
|
| 335 | |
498 | |
| 336 | return 0 |
499 | ewarn |
|
|
500 | echo |
|
|
501 | fi |
| 337 | } |
502 | } |