/[gentoo-x86]/eclass/apache-module.eclass
Gentoo

Diff of /eclass/apache-module.eclass

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

Revision 1.13 Revision 1.25
1# Copyright 2004 Gentoo Foundation 1# Copyright 1999-2011 Gentoo Foundation
2# Distributed under the terms of the GNU General Public License, v2 or later 2# Distributed under the terms of the GNU General Public License v2
3# Author Michael Tindal <urilith@gentoo.org>
4# $Header: /var/cvsroot/gentoo-x86/eclass/apache-module.eclass,v 1.13 2005/08/02 23:26:14 vericgar Exp $ 3# $Header: /var/cvsroot/gentoo-x86/eclass/apache-module.eclass,v 1.25 2011/12/27 17:55:12 fauli Exp $
4
5# @ECLASS: apache-module.eclass
6# @MAINTAINER:
7# apache-devs@gentoo.org
8# @BLURB: Provides a common set of functions for apache modules
9# @DESCRIPTION:
10# This eclass handles apache modules in a sane way.
11#
12# To make use of this eclass simply call one of the need/want_apache functions
13# described in depend.apache.eclass. Make sure you use the need/want_apache call
14# after you have defined DEPEND and RDEPEND. Also note that you can not rely on
15# the automatic RDEPEND=DEPEND that portage does if you use this eclass.
16#
17# See Bug 107127 for more information.
18#
19# @EXAMPLE:
20#
21# Here is a simple example of an ebuild for mod_foo:
22#
23# @CODE
24# APACHE2_MOD_CONF="42_mod_foo"
25# APACHE2_MOD_DEFINE="FOO"
26# need_apache2
27# @CODE
28#
29# A more complicated example for a module with non-standard locations:
30#
31# @CODE
32# APXS2_S="${S}/apache22/src"
33# APACHE2_MOD_FILE="${APXS2_S}/${PN}.so"
34# APACHE2_MOD_CONF="42_${PN}"
35# APACHE2_MOD_DEFINE="FOO"
36# DOCFILES="docs/*.html"
37# need_apache2_2
38# @CODE
39#
40# A basic module configuration which just loads the module into apache:
41#
42# @CODE
43# <IfDefine FOO>
44# LoadModule foo_module modules/mod_foo.so
45# </IfDefine>
46# @CODE
5 47
6inherit depend.apache 48inherit depend.apache
7 49
8# This eclass provides a common set of functions for Apache modules. 50# ==============================================================================
51# PUBLIC VARIABLES
52# ==============================================================================
9 53
10###### 54# @VARIABLE: APXS2_S
11## Common ebuild variables 55# @DESCRIPTION:
12###### 56# Path to temporary build directory. (Defaults to `${S}/src' if it exists,
57# `${S}' otherwise)
13 58
14#### 59# @VARIABLE: APXS2_ARGS
15## APXS1_S, APXS2_S 60# @DESCRIPTION:
16## 61# Arguments to pass to the apxs tool. (Defaults to `-c ${PN}.c')
17## Paths to temporary build directories
18####
19APXS1_S=""
20APXS2_S=""
21 62
22#### 63# @VARIABLE: APACHE2_EXECFILES
23## APXS1_ARGS, APXS2_ARGS 64# @DESCRIPTION:
24## 65# List of files that will be installed into ${APACHE_MODULE_DIR} beside
25## Arguments to pass to the apxs tool 66# ${APACHE2_MOD_FILE}. In addition, this function also sets the executable
26#### 67# permission on those files.
27APXS1_ARGS=""
28APXS2_ARGS=""
29 68
30#### 69# @VARIABLE: APACHE2_MOD_CONF
31## APACHE1_MOD_FILE, APACHE2_MOD_FILE 70# @DESCRIPTION:
32## 71# Module configuration file installed by src_install (minus the .conf suffix and
33## Name of the module that src_install installs (only, minus the .so) 72# relative to ${FILESDIR}).
34####
35APACHE1_MOD_FILE=""
36APACHE2_MOD_FILE=""
37 73
38#### 74# @VARIABLE: APACHE2_MOD_DEFINE
39## APACHE1_MOD_CONF, APACHE2_MOD_CONF 75# @DESCRIPTION:
40##
41## Configuration file installed by src_install
42####
43APACHE1_MOD_CONF=""
44APACHE2_MOD_CONF=""
45
46####
47## APACHE1_MOD_DEFINE, APACHE2_MOD_DEFINE
48##
49## Name of define (eg FOO) to use in conditional loading of the installed 76# Name of define (e.g. FOO) to use in conditional loading of the installed
50## module/it's config file 77# module/its config file, multiple defines should be space separated.
51####
52APACHE1_MOD_DEFINE=""
53APACHE2_MOD_DEFINE=""
54 78
55#### 79# @VARIABLE: APACHE2_MOD_FILE
56## DOCFILES 80# @DESCRIPTION:
57## 81# Name of the module that src_install installs minus the .so suffix. (Defaults
82# to `${APXS2_S}/.libs/${PN}.so')
83
84# @VARIABLE: APACHE2_VHOST_CONF
85# @DESCRIPTION:
86# Virtual host configuration file installed by src_install (minus the .conf
87# suffix and relative to ${FILESDIR}).
88
89# @VARIABLE: DOCFILES
90# @DESCRIPTION:
58## If the exported src_install() is being used, and ${DOCFILES} is non-zero, 91# If the exported src_install() is being used, and ${DOCFILES} is non-zero, some
59## some sed-fu is applied to split out html documentation (if any) from normal 92# sed-fu is applied to split out html documentation (if any) from normal
60## documentation, and dodoc'd or dohtml'd 93# documentation, and dodoc'd or dohtml'd.
61####
62DOCFILES=""
63 94
64###### 95# ==============================================================================
65## Utility functions 96# INTERNAL FUNCTIONS
66###### 97# ==============================================================================
67 98
68#### 99# Internal function to construct the default ${APXS2_S} path if required.
69## apache_cd_dir
70##
71## Return the path to our temporary build dir
72####
73apache_cd_dir() { 100apache_cd_dir() {
74 debug-print-function apache_cd_dir 101 debug-print-function $FUNCNAME $*
75 102
76 if [ "${APACHE_VERSION}" == "1" ]; then 103 local CD_DIR="${APXS2_S}"
77 [ -n "${APXS1_S}" ] && CD_DIR="${APXS1_S}"
78 else
79 [ -n "${APXS2_S}" ] && CD_DIR="${APXS2_S}"
80 fi
81 104
82 # XXX - is this really needed? can't we just return ${S}?
83 if [ -z "${CD_DIR}" ]; then 105 if [[ -z "${CD_DIR}" ]] ; then
84 if [ -d ${S}/src ] ; then 106 if [[ -d "${S}/src" ]] ; then
85 CD_DIR="${S}/src" 107 CD_DIR="${S}/src"
86 else 108 else
87 CD_DIR="${S}" 109 CD_DIR="${S}"
88 fi 110 fi
89 fi 111 fi
90 112
91 debug-print apache_cd_dir: "CD_DIR=${CD_DIR}" 113 debug-print $FUNCNAME "CD_DIR=${CD_DIR}"
92 echo ${CD_DIR} 114 echo "${CD_DIR}"
93} 115}
94 116
95#### 117# Internal function to construct the default ${APACHE2_MOD_FILE} if required.
96## apache_mod_file
97##
98## Return the path to the module file
99####
100apache_mod_file() { 118apache_mod_file() {
101 debug-print-function apache_mod_file 119 debug-print-function $FUNCNAME $*
102 120
103 if [ "${APACHE_VERSION}" == "1" ]; then 121 local MOD_FILE="${APACHE2_MOD_FILE:-$(apache_cd_dir)/.libs/${PN}.so}"
104 [ -n "${APACHE1_MOD_FILE}" ] && MOD_FILE="${APACHE1_MOD_FILE}"
105 [ -z "${MOD_FILE}" ] && MOD_FILE="$(apache_cd_dir)/${PN}.so"
106 else
107 [ -n "${APACHE2_MOD_FILE}" ] && MOD_FILE="${APACHE2_MOD_FILE}"
108 [ -z "${MOD_FILE}" ] && MOD_FILE="$(apache_cd_dir)/.libs/${PN}.so"
109 fi
110 122
111 debug-print apache_mod_file: MOD_FILE=${MOD_FILE} 123 debug-print $FUNCNAME "MOD_FILE=${MOD_FILE}"
112 echo ${MOD_FILE} 124 echo "${MOD_FILE}"
113} 125}
114 126
115####
116## apache_doc_magic
117##
118## Some magic for picking out html files from ${DOCFILES}. It takes 127# Internal function for picking out html files from ${DOCFILES}. It takes an
119## an optional first argument `html'; if the first argument is equals 128# optional first argument `html'; if the first argument is equals `html', only
120## `html', only html files are returned, otherwise normal (non-html) 129# html files are returned, otherwise normal (non-html) docs are returned.
121## docs are returned.
122####
123apache_doc_magic() { 130apache_doc_magic() {
124 debug-print-function apache_doc_magic $* 131 debug-print-function $FUNCNAME $*
125 132
133 local DOCS=
134
126 if [ -n "${DOCFILES}" ]; then 135 if [[ -n "${DOCFILES}" ]] ; then
127 if [ "x$1" == "xhtml" ]; then 136 if [[ "x$1" == "xhtml" ]] ; then
128 DOCS="`echo ${DOCFILES} | sed -e 's/ /\n/g' | sed -e '/^[^ ]*.html$/ !d'`" 137 DOCS="`echo ${DOCFILES} | sed -e 's/ /\n/g' | sed -e '/^[^ ]*.html$/ !d'`"
129 else 138 else
130 DOCS="`echo ${DOCFILES} | sed 's, *[^ ]*\+.html, ,g'`" 139 DOCS="`echo ${DOCFILES} | sed 's, *[^ ]*\+.html, ,g'`"
131 fi 140 fi
141 fi
132 142
133 debug-print apache_doc_magic: DOCS=${DOCS} 143 debug-print $FUNCNAME "DOCS=${DOCS}"
134 echo ${DOCS} 144 echo "${DOCS}"
135 fi
136} 145}
137 146
138###### 147# ==============================================================================
139## Apache 1.x ebuild functions 148# EXPORTED FUNCTIONS
140###### 149# ==============================================================================
141 150
142#### 151# @FUNCTION: apache-module_src_compile
143## apache1_src_compile 152# @DESCRIPTION:
144## The default action is to call ${APXS11} with the value of 153# The default action is to call ${APXS} with the value of ${APXS2_ARGS}. If a
145## ${APXS1_ARGS}. If a module requires a different build setup 154# module requires a different build setup than this, use ${APXS} in your own
146## than this, use ${APXS1} in your own src_compile routine. 155# src_compile routine.
147####
148apache1_src_compile() { 156apache-module_src_compile() {
149 debug-print-function apache1_src_compile 157 debug-print-function $FUNCNAME $*
150 158
151 CD_DIR=$(apache_cd_dir) 159 local CD_DIR=$(apache_cd_dir)
152 cd ${CD_DIR} || die "cd ${CD_DIR} failed" 160 cd "${CD_DIR}" || die "cd ${CD_DIR} failed"
161
153 APXS1_ARGS="${APXS1_ARGS:--c ${PN}.c}" 162 APXS2_ARGS="${APXS2_ARGS:--c ${PN}.c}"
154 ${APXS1} ${APXS1_ARGS} || die "${APXS1} ${APXS1_ARGS} failed" 163 ${APXS} ${APXS2_ARGS} || die "${APXS} ${APXS2_ARGS} failed"
155} 164}
156 165
157#### 166# @FUNCTION: apache-module_src_install
158## apache1_src_install 167# @DESCRIPTION:
159##
160## This installs the files into apache's directories. The module is installed 168# This installs the files into apache's directories. The module is installed
161## from a directory chosen as above (APXS2_S or ${S}/src). In addition, 169# from a directory chosen as above (apache_cd_dir). In addition, this function
162## this function can also set the executable permission on files listed in EXECFILES. 170# can also set the executable permission on files listed in
163## The configuration file name is listed in APACHE1_MOD_CONF without the .conf extensions, 171# ${APACHE2_EXECFILES}. The configuration file name is listed in
164## so if you configuration is 55_mod_foo.conf, APACHE1_MOD_CONF would be 55_mod_foo. 172# ${APACHE2_MOD_CONF} without the .conf extensions, so if you configuration is
165## DOCFILES contains the list of files you want filed as documentation. The name of the 173# 55_mod_foo.conf, APACHE2_MOD_CONF would be 55_mod_foo. ${DOCFILES} contains
166## module can also be specified using the APACHE1_MOD_FILE or defaults to 174# the list of files you want filed as documentation.
167## .libs/${PN}.so.
168####
169apache1_src_install() { 175apache-module_src_install() {
170 debug-print-function apache1_src_install 176 debug-print-function $FUNCNAME $*
171 177
172 CD_DIR=$(apache_cd_dir) 178 local CD_DIR=$(apache_cd_dir)
173 cd ${CD_DIR} || die "cd ${CD_DIR} failed" 179 cd "${CD_DIR}" || die "cd ${CD_DIR} failed"
174 180
175 MOD_FILE=$(apache_mod_file) 181 local MOD_FILE=$(apache_mod_file)
176 182
177 exeinto ${APACHE1_MODULESDIR} 183 exeinto "${APACHE_MODULESDIR}"
178 doexe ${MOD_FILE} || die "internal ebuild error: '${MOD_FILE}' not found" 184 doexe ${MOD_FILE} || die "internal ebuild error: '${MOD_FILE}' not found"
179 [ -n "${APACHE1_EXECFILES}" ] && doexe ${APACHE1_EXECFILES} 185 [[ -n "${APACHE2_EXECFILES}" ]] && doexe ${APACHE2_EXECFILES}
180 186
181 if [ -n "${APACHE1_MOD_CONF}" ] ; then 187 if [[ -n "${APACHE2_MOD_CONF}" ]] ; then
182 insinto ${APACHE1_MODULES_CONFDIR} 188 insinto "${APACHE_MODULES_CONFDIR}"
183 doins ${FILESDIR}/${APACHE1_MOD_CONF}.conf || die "internal ebuild error: '${FILESDIR}/${APACHE1_MOD_CONF}.conf' not found." 189 set -- ${APACHE2_MOD_CONF}
190 newins "${FILESDIR}/${1}.conf" "$(basename ${2:-$1}).conf" \
191 || die "internal ebuild error: '${FILESDIR}/${1}.conf' not found"
184 fi 192 fi
185 193
194 if [[ -n "${APACHE2_VHOST_CONF}" ]] ; then
195 insinto "${APACHE_VHOSTS_CONFDIR}"
196 set -- ${APACHE2_VHOST_CONF}
197 newins "${FILESDIR}/${1}.conf" "$(basename ${2:-$1}).conf " \
198 || die "internal ebuild error: '${FILESDIR}/${1}.conf' not found"
199 fi
200
186 cd ${S} 201 cd "${S}"
187 202
188 if [ -n "${DOCFILES}" ] ; then 203 if [[ -n "${DOCFILES}" ]] ; then
189 OTHER_DOCS=$(apache_doc_magic) 204 local OTHER_DOCS=$(apache_doc_magic)
190 HTML_DOCS=$(apache_doc_magic html) 205 local HTML_DOCS=$(apache_doc_magic html)
191 206
192 [ -n "${OTHER_DOCS}" ] && dodoc ${OTHER_DOCS} 207 [[ -n "${OTHER_DOCS}" ]] && dodoc ${OTHER_DOCS}
193 [ -n "${HTML_DOCS}" ] && dohtml ${HTML_DOCS} 208 [[ -n "${HTML_DOCS}" ]] && dohtml ${HTML_DOCS}
194 fi 209 fi
195} 210}
196 211
197#### 212# @FUNCTION: apache-module_pkg_postinst
198## apache1_pkg_postinst 213# @DESCRIPTION:
199## 214# This prints out information about the installed module and how to enable it.
200## Prints the standard config message, unless APACHE1_NO_CONFIG is set to yes.
201####
202apache1_pkg_postinst() { 215apache-module_pkg_postinst() {
203 debug-print-function apache1_pkg_postinst 216 debug-print-function $FUNCNAME $*
204 217
205 if [ -n "${APACHE1_MOD_DEFINE}" ]; then 218 if [[ -n "${APACHE2_MOD_DEFINE}" ]] ; then
219 local my_opts="-D ${APACHE2_MOD_DEFINE// / -D }"
220
206 einfo 221 einfo
207 einfo "To enable ${PN}, you need to edit your /etc/conf.d/apache file and" 222 einfo "To enable ${PN}, you need to edit your /etc/conf.d/apache2 file and"
208 einfo "add '-D ${APACHE1_MOD_DEFINE}' to APACHE_OPTS." 223 einfo "add '${my_opts}' to APACHE2_OPTS."
209 einfo 224 einfo
210 fi 225 fi
226
211 if [ -n "${APACHE1_MOD_CONF}" ] ; then 227 if [[ -n "${APACHE2_MOD_CONF}" ]] ; then
228 set -- ${APACHE2_MOD_CONF}
212 einfo 229 einfo
213 einfo "Configuration file installed as" 230 einfo "Configuration file installed as"
214 einfo " ${APACHE1_MODULES_CONFDIR}/$(basename ${APACHE1_MOD_CONF}).conf" 231 einfo " ${APACHE_MODULES_CONFDIR}/$(basename ${2:-$1}).conf"
215 einfo "You may want to edit it before turning the module on in /etc/conf.d/apache"
216 einfo
217 fi
218}
219
220######
221## Apache 2.x ebuild functions
222######
223
224####
225## apache2_pkg_setup
226##
227## Checks to see if APACHE2_MT_UNSAFE is set to anything other than "no". If it is, then
228## we check what the MPM style used by Apache is, if it isnt prefork, we let the user
229## know they need prefork, and then exit the build.
230####
231apache2_pkg_setup() {
232 debug-print-function apache2_pkg_setup
233
234 if [ -n "${APACHE2_SAFE_MPMS}" ]; then
235
236 INSTALLED_MPM="$(${ROOT}/usr/sbin/apxs2 -q MPM_NAME)"
237
238 if hasq ${INSTALLED_MPM} ${APACHE2_SAFE_MPMS} ; then
239 INSTALLED_MPM_SAFE="yes"
240 fi
241
242 if [ -z "${INSTALLED_MPM_SAFE}" ] ; then
243 eerror "The module you are trying to install (${PN})"
244 eerror "will only work with one of the following MPMs:"
245 eerror " ${APACHE2_SAFE_MPMS}"
246 eerror "You do not currently have any of these MPMs installed."
247 eerror "Please re-install apache with the correct mpm-* USE flag set."
248 die "No safe MPM installed."
249 fi
250
251 fi
252
253}
254
255####
256## apache2_src_compile
257##
258## The default action is to call ${APXS2} with the value of
259## ${APXS2_ARGS}. If a module requires a different build setup
260## than this, use ${APXS2} in your own src_compile routine.
261####
262apache2_src_compile() {
263 debug-print-function apache2_src_compile
264
265 CD_DIR=$(apache_cd_dir)
266 cd ${CD_DIR} || die "cd ${CD_DIR} failed"
267 APXS2_ARGS="${APXS2_ARGS:--c ${PN}.c}"
268 ${APXS2} ${APXS2_ARGS} || die "${APXS2} ${APXS2_ARGS} failed"
269}
270
271####
272## apache2_src_install
273##
274## This installs the files into apache's directories. The module is installed
275## from a directory chosen as above (APXS2_S or ${S}/src). In addition,
276## this function can also set the executable permission on files listed in EXECFILES.
277## The configuration file name is listed in CONFFILE without the .conf extensions,
278## so if you configuration is 55_mod_foo.conf, CONFFILE would be 55_mod_foo.
279## DOCFILES contains the list of files you want filed as documentation.
280####
281apache2_src_install() {
282 debug-print-function apache2_src_install
283
284 CD_DIR=$(apache_cd_dir)
285 cd ${CD_DIR} || die "cd ${CD_DIR} failed"
286
287 MOD_FILE=$(apache_mod_file)
288
289 exeinto ${APACHE2_MODULESDIR}
290 doexe ${MOD_FILE} || die "internal ebuild error: '${MOD_FILE}' not found"
291 [ -n "${APACHE2_EXECFILES}" ] && doexe ${APACHE2_EXECFILES}
292
293 if [ -n "${APACHE2_MOD_CONF}" ] ; then
294 insinto ${APACHE2_MODULES_CONFDIR}
295 doins ${FILESDIR}/${APACHE2_MOD_CONF}.conf || die "internal ebuild error: '${FILESDIR}/${APACHE2_MOD_CONF}.conf' not found."
296 fi
297
298 if [ -n "${APACHE2_VHOSTFILE}" ]; then
299 insinto ${APACHE2_VHOSTDIR}
300 doins ${FILESDIR}/${APACHE2_VHOSTFILE}.conf
301 fi
302
303 cd ${S}
304
305 if [ -n "${DOCFILES}" ] ; then
306 OTHER_DOCS=$(apache_doc_magic)
307 HTML_DOCS=$(apache_doc_magic html)
308
309 [ -n "${OTHER_DOCS}" ] && dodoc ${OTHER_DOCS}
310 [ -n "${HTML_DOCS}" ] && dohtml ${HTML_DOCS}
311 fi
312}
313
314apache2_pkg_postinst() {
315 debug-print-function apache2_pkg_postinst
316
317 if [ -n "${APACHE2_MOD_DEFINE}" ]; then
318 einfo
319 einfo "To enable ${PN}, you need to edit your /etc/conf.d/apache2 file and"
320 einfo "add '-D ${APACHE2_MOD_DEFINE}' to APACHE2_OPTS."
321 einfo
322 fi
323 if [ -n "${APACHE2_MOD_CONF}" ] ; then
324 einfo
325 einfo "Configuration file installed as"
326 einfo " ${APACHE2_MODULES_CONFDIR}/$(basename ${APACHE2_MOD_CONF}).conf"
327 einfo "You may want to edit it before turning the module on in /etc/conf.d/apache2" 232 einfo "You may want to edit it before turning the module on in /etc/conf.d/apache2"
328 einfo 233 einfo
329 fi 234 fi
330
331 if [ -n "${APACHE2_SAFE_MPMS}" ]; then
332
333 INSTALLED_MPM="$(${ROOT}/usr/sbin/apxs2 -q MPM_NAME)"
334
335 if ! hasq ${INSTALLED_MPM} ${APACHE2_SAFE_MPMS} ; then
336 INSTALLED_MPM_UNSAFE="${INSTALLED_MPM_UNSAFE} ${mpm}"
337 else
338 INSTALLED_MPM_SAFE="${INSTALLED_MPM_SAFE} ${mpm}"
339 fi
340
341 if [ -n "${INSTALLED_MPM_UNSAFE}" ] ; then
342 ewarn "You have one or more MPMs installed that will not work with"
343 ewarn "this module (${PN}). Please make sure that you only enable"
344 ewarn "this module if you are using one of the following MPMs:"
345 ewarn " ${INSTALLED_MPM_SAFE}"
346 fi
347
348 fi
349
350} 235}
351 236
352######
353## Apache dual (1.x or 2.x) ebuild functions
354##
355## This is where the magic happens. We provide dummy routines of all of the functions
356## provided by all of the specifics. We use APACHE_ECLASS_VER_* to see which versions
357## to call. If a function is provided by a given section (ie pkg_postinst in Apache 2.x)
358## the exported routine simply does nothing.
359######
360
361apache-module_pkg_setup() {
362 debug-print-function apache-module_pkg_setup
363
364 if [ ${APACHE_VERSION} -eq '2' ]; then
365 apache2_pkg_setup
366 fi
367}
368
369apache-module_src_compile() {
370 debug-print-function apache-module_src_compile
371
372 if [ ${APACHE_VERSION} -eq '1' ]; then
373 apache1_src_compile
374 else
375 apache2_src_compile
376 fi
377}
378
379apache-module_src_install() {
380 debug-print-function apache-module_src_install
381
382 if [ ${APACHE_VERSION} -eq '1' ]; then
383 apache1_src_install
384 else
385 apache2_src_install
386 fi
387}
388
389apache-module_pkg_postinst() {
390 debug-print-function apache-module_pkg_postinst
391
392 if [ ${APACHE_VERSION} -eq '1' ]; then
393 apache1_pkg_postinst
394 else
395 apache2_pkg_postinst
396 fi
397}
398
399EXPORT_FUNCTIONS pkg_setup src_compile src_install pkg_postinst 237EXPORT_FUNCTIONS src_compile src_install pkg_postinst
400
401# vim:ts=4

Legend:
Removed from v.1.13  
changed lines
  Added in v.1.25

  ViewVC Help
Powered by ViewVC 1.1.20