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