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

Contents of /eclass/apache-module.eclass

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.1 - (show annotations) (download)
Sun Nov 21 01:51:58 2004 UTC (9 years, 9 months ago) by urilith
Branch: MAIN
Adding apache-module.eclass and new version of depend.apache.eclass

1 # Copyright 2004 Gentoo Foundation
2 # Distributed under the terms of the GNU General Public License, v2 or later
3 # Author Michael Tindal <urilith@gentoo.org>
4 # $Header: $
5 ECLASS=apache-module
6 INHERITED="$INHERITED $ECLASS"
7
8 inherit depend.apache
9
10 # This eclass provides a common set of functions for Apache modules.
11
12 ######
13 ## Common ebuild variables
14 ######
15
16 ####
17 ## APXS1_S, APXS2_S
18 ##
19 ## Paths to temporary build directories
20 ####
21 APXS1_S=""
22 APXS2_S=""
23
24 ####
25 ## APXS1_ARGS, APXS2_ARGS
26 ##
27 ## Arguments to pass to the apxs tool
28 ####
29 APXS1_ARGS=""
30 APXS2_ARGS=""
31
32 ####
33 ## APACHE1_MOD_FILE, APACHE2_MOD_FILE
34 ##
35 ## Name of the module that src_install installs (only, minus the .so)
36 ####
37 APACHE1_MOD_FILE=""
38 APACHE2_MOD_FILE=""
39
40 ####
41 ## APACHE1_MOD_CONF, APACHE2_MOD_CONF
42 ##
43 ## Configuration file installed by src_install
44 ####
45 APACHE1_MOD_CONF=""
46 APACHE2_MOD_CONF=""
47
48 ####
49 ## APACHE1_MOD_DEFINE, APACHE2_MOD_DEFINE
50 ##
51 ## Name of define (eg FOO) to use in conditional loading of the installed
52 ## module/it's config file
53 ####
54 APACHE1_MOD_DEFINE=""
55 APACHE2_MOD_DEFINE=""
56
57 ####
58 ## DOCFILES
59 ##
60 ## If the exported src_install() is being used, and ${DOCFILES} is non-zero,
61 ## some sed-fu is applied to split out html documentation (if any) from normal
62 ## documentation, and dodoc'd or dohtml'd
63 ####
64 DOCFILES=""
65
66 ######
67 ## Utility functions
68 ######
69
70 ####
71 ## apache_cd_dir
72 ##
73 ## Return the path to our temporary build dir
74 ####
75 apache_cd_dir() {
76 debug-print-function apache_cd_dir
77
78 if [ "${APACHE_VERSION}" == "1" ]; then
79 [ -n "${APXS1_S}" ] && CD_DIR="${APXS1_S}"
80 else
81 [ -n "${APXS2_S}" ] && CD_DIR="${APXS2_S}"
82 fi
83
84 # XXX - is this really needed? can't we just return ${S}?
85 if [ -z "${CD_DIR}" ]; then
86 if [ -d ${S}/src ] ; then
87 CD_DIR="${S}/src"
88 else
89 CD_DIR="${S}"
90 fi
91 fi
92
93 debug-print apache_cd_dir: "CD_DIR=${CD_DIR}"
94 echo ${CD_DIR}
95 }
96
97 ####
98 ## apache_mod_file
99 ##
100 ## Return the path to the module file
101 ####
102 apache_mod_file() {
103 debug-print-function apache_mod_file
104
105 if [ "${APACHE_VERSION}" == "1" ]; then
106 [ -n "${APACHE1_MOD_FILE}" ] && MOD_FILE="${APACHE1_MOD_FILE}"
107 [ -z "${MOD_FILE}" ] && MOD_FILE="$(apache_cd_dir)/${PN}.so"
108 else
109 [ -n "${APACHE2_MOD_FILE}" ] && MOD_FILE="${APACHE2_MOD_FILE}"
110 [ -z "${MOD_FILE}" ] && MOD_FILE="$(apache_cd_dir)/.libs/${PN}.so"
111 fi
112
113 debug-print apache_mod_file: MOD_FILE=${MOD_FILE}
114 echo ${MOD_FILE}
115 }
116
117 ####
118 ## apache_doc_magic
119 ##
120 ## Some magic for picking out html files from ${DOCFILES}. It takes
121 ## an optional first argument `html'; if the first argument is equals
122 ## `html', only html files are returned, otherwise normal (non-html)
123 ## docs are returned.
124 ####
125 apache_doc_magic() {
126 debug-print-function apache_doc_magic $*
127
128 if [ -n "${DOCFILES}" ]; then
129 if [ "x$1" == "xhtml" ]; then
130 DOCS="`echo ${DOCFILES} | sed -e 's/ /\n/g' | sed -e '/^[^ ]*.html$/ !d'`"
131 else
132 DOCS="`echo ${DOCFILES} | sed 's, *[^ ]*\+.html, ,g'`"
133 fi
134
135 debug-print apache_doc_magic: DOCS=${DOCS}
136 echo ${DOCS}
137 fi
138 }
139
140 ######
141 ## Apache 1.x ebuild functions
142 ######
143
144 ####
145 ## apache1_src_compile
146 ## The default action is to call ${APXS11} with the value of
147 ## ${APXS1_ARGS}. If a module requires a different build setup
148 ## than this, use ${APXS1} in your own src_compile routine.
149 ####
150 apache1_src_compile () {
151 debug-print-function apache1_src_compile
152
153 CD_DIR=$(apache_cd_dir)
154 cd ${CD_DIR} || die "cd ${CD_DIR} failed"
155 APXS1_ARGS="${APXS1_ARGS:--c ${PN}.c}"
156 ${APXS1} ${APXS1_ARGS} || die "${APXS1} ${APXS1_ARGS} failed"
157 }
158
159 ####
160 ## apache1_src_install
161 ##
162 ## This installs the files into apache's directories. The module is installed
163 ## from a directory chosen as above (APXS2_S or ${S}/src). In addition,
164 ## this function can also set the executable permission on files listed in EXECFILES.
165 ## The configuration file name is listed in APACHE1_MOD_CONF without the .conf extensions,
166 ## so if you configuration is 55_mod_foo.conf, APACHE1_MOD_CONF would be 55_mod_foo.
167 ## DOCFILES contains the list of files you want filed as documentation. The name of the
168 ## module can also be specified using the APACHE1_MOD_FILE or defaults to
169 ## .libs/${PN}.so.
170 ####
171 apache1_src_install() {
172 debug-print-function apache1_src_install
173
174 CD_DIR=$(apache_cd_dir)
175 cd ${CD_DIR} || die "cd ${CD_DIR} failed"
176
177 MOD_FILE=$(apache_mod_file)
178
179 exeinto ${APACHE1_MODULESDIR}
180 doexe ${MOD_FILE} || die "internal ebuild error: \'${MOD_FILE}\' not found"
181 [ -n "${APACHE1_EXECFILES}" ] && doexe ${APACHE1_EXECFILES}
182
183 if [ -n "${APACHE1_MOD_CONF}" ] ; then
184 insinto ${APACHE1_MODULES_CONFDIR}
185 doins ${FILESDIR}/${APACHE1_MOD_CONF}.conf || die "internal ebuild error: \'${APACHE2_MOD_CONF}.conf\' not found."
186
187 einfo
188 einfo "Configuration file installed as ${APACHE1_MODULES_CONFDIR}/${APACHE1_MOD_CONF}.conf"
189 einfo "You may want to edit it before turning the module on in /etc/conf.d/apache"
190 einfo
191 fi
192
193 cd ${S}
194
195 if [ -n "${DOCFILES}" ] ; then
196 OTHER_DOCS=$(apache_doc_magic)
197 HTML_DOCS=$(apache_doc_magic html)
198
199 [ -n "${OTHER_DOCS}" ] && dodoc ${OTHER_DOCS}
200 [ -n "${HTML_DOCS}" ] && dohtml ${HTML_DOCS}
201 fi
202 }
203
204 ####
205 ## apache1_pkg_postinst
206 ##
207 ## Prints the standard config message, unless APACHE1_NO_CONFIG is set to yes.
208 ####
209 apache1_pkg_postinst() {
210 debug-print-function apache1_pkg_postinst
211
212 if [ -n "${APACHE1_MOD_DEFINE}" ]; then
213 einfo
214 einfo "To enable ${PN}, you need to edit your /etc/conf.d/apache file and"
215 einfo "add '-D ${APACHE1_MOD_DEFINE}' to APACHE_OPTS."
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 ####
231 apache2_pkg_setup () {
232 debug-print-function apache2_pkg_setup
233
234 if [ -n "${APACHE2_MT_UNSAFEE}" ]; then
235 if [ "x${APACHE2_MT_UNSAFE}" != "no" ]; then
236 APACHE2_MPM_STYLE=`/usr/sbin/apxs2 -q MPM_NAME`
237 if [ "x$APACHE2_MPM_STYLE" != "xprefork" ]; then
238 eerror "You currently have Apache configured to use the."
239 eerror "$APACHE2_MPM_STYLE MPM style. The module you are"
240 eerror "trying to install is not currently thread-safe,"
241 eerror "and will not work under your current configuraiton."
242 echo
243 eerror "If you still want to use the module, please reinstall"
244 eerror "Apache with mpm-prefork set."
245
246 epause
247 ebeep
248 die Invalid Apache MPM style.
249 fi
250 fi
251 fi
252 }
253
254 ####
255 ## apache2_src_compile
256 ##
257 ## The default action is to call ${APXS2} with the value of
258 ## ${APXS2_ARGS}. If a module requires a different build setup
259 ## than this, use ${APXS2} in your own src_compile routine.
260 ####
261 apache2_src_compile () {
262 debug-print-function apache2_src_compile
263
264 CD_DIR=$(apache_cd_dir)
265 cd ${CD_DIR} || die "cd ${CD_DIR} failed"
266 APXS2_ARGS="${APXS2_ARGS:--c ${PN}.c}"
267 ${APXS2} ${APXS2_ARGS} || die "${APXS2} ${APXS2_ARGS} failed"
268 }
269
270 ####
271 ## apache2_src_install
272 ##
273 ## This installs the files into apache's directories. The module is installed
274 ## from a directory chosen as above (APXS2_S or ${S}/src). In addition,
275 ## this function can also set the executable permission on files listed in EXECFILES.
276 ## The configuration file name is listed in CONFFILE without the .conf extensions,
277 ## so if you configuration is 55_mod_foo.conf, CONFFILE would be 55_mod_foo.
278 ## DOCFILES contains the list of files you want filed as documentation.
279 ####
280 apache2_src_install() {
281 debug-print-function apache2_src_install
282
283 CD_DIR=$(apache_cd_dir)
284 cd ${CD_DIR} || die "cd ${CD_DIR} failed"
285
286 MOD_FILE=$(apache_mod_file)
287
288 exeinto ${APACHE2_MODULESDIR}
289 doexe ${MOD_FILE} || die "internal ebuild error: \'${MOD_FILE}\' not found"
290 [ -n "${APACHE2_EXECFILES}" ] && doexe ${APACHE2_EXECFILES}
291
292 if [ -n "${APACHE2_MOD_CONF}" ] ; then
293 insinto ${APACHE2_MODULES_CONFDIR}
294 doins ${FILESDIR}/${APACHE2_MOD_CONF}.conf || die "internal ebuild error: \'${APACHE2_MOD_CONF}.conf\' not found."
295
296 einfo
297 einfo "Configuration file installed as ${APACHE2_MODULES_CONFDIR}/${APACHE2_MOD_CONF}.conf"
298 einfo "You may want to edit it before turning the module on in /etc/conf.d/apache2"
299 einfo
300 fi
301
302 if [ -n "${APACHE2_VHOSTFILE}" ]; then
303 insinto ${APACHE2_MODULES_VHOSTDIR}
304 doins ${FILESDIR}/${APACHE2_VHOSTFILE}.conf
305 fi
306
307 cd ${S}
308
309 if [ -n "${DOCFILES}" ] ; then
310 OTHER_DOCS=$(apache_doc_magic)
311 HTML_DOCS=$(apache_doc_magic html)
312
313 [ -n "${OTHER_DOCS}" ] && dodoc ${OTHER_DOCS}
314 [ -n "${HTML_DOCS}" ] && dohtml ${HTML_DOCS}
315 fi
316 }
317
318 apache2_pkg_postinst() {
319 debug-print-function apache2_pkg_postinst
320
321 if [ -n "${APACHE2_MOD_DEFINE}" ]; then
322 einfo
323 einfo "To enable ${PN}, you need to edit your /etc/conf.d/apache2 file and"
324 einfo "add '-D ${APACHE2_MOD_DEFINE}' to APACHE2_OPTS."
325 einfo
326 fi
327 }
328
329 ######
330 ## Apache dual (1.x or 2.x) ebuild functions
331 ##
332 ## This is where the magic happens. We provide dummy routines of all of the functions
333 ## provided by all of the specifics. We use APACHE_ECLASS_VER_* to see which versions
334 ## to call. If a function is provided by a given section (ie pkg_postinst in Apache 2.x)
335 ## the exported routine simply does nothing.
336 ######
337
338 apache-module_pkg_setup() {
339 debug-print-function apache-module_pkg_setup
340
341 if [ ${APACHE_VERSION} -eq '2' ]; then
342 apache2_pkg_setup
343 fi
344 }
345
346 apache-module_src_compile() {
347 debug-print-function apache-module_src_compile
348
349 if [ ${APACHE_VERSION} -eq '1' ]; then
350 apache1_src_compile
351 else
352 apache2_src_compile
353 fi
354 }
355
356 apache-module_src_install() {
357 debug-print-function apache-module_src_install
358
359 if [ ${APACHE_VERSION} -eq '1' ]; then
360 apache1_src_install
361 else
362 apache2_src_install
363 fi
364 }
365
366 apache-module_pkg_postinst() {
367 debug-print-function apache-module_pkg_postinst
368
369 if [ ${APACHE_VERSION} -eq '1' ]; then
370 apache1_pkg_postinst
371 else
372 apache2_pkg_postinst
373 fi
374 }
375
376 EXPORT_FUNCTIONS pkg_setup src_compile src_install pkg_postinst
377
378 # vim:ts=4

  ViewVC Help
Powered by ViewVC 1.1.20