| 1 | # Copyright 1999-2005 Gentoo Foundation |
1 | # Copyright 1999-2007 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/depend.apache.eclass,v 1.20 2005/09/04 10:54:53 stuart Exp $ |
3 | # $Header: /var/cvsroot/gentoo-x86/eclass/depend.apache.eclass,v 1.38 2008/02/03 11:51:36 hollow Exp $ |
| 4 | |
4 | |
| 5 | ###### |
5 | # @ECLASS: depend.apache.eclass |
| 6 | ## Apache Common Variables |
6 | # @MAINTAINER: apache-devs@gentoo.org |
| 7 | ## |
7 | # @BLURB: Functions to allow ebuilds to depend on apache |
| 8 | ## These are internal variables used by this, and other apache-related eclasses, |
8 | # @DESCRIPTION: |
| 9 | ## and thus should not need to be used by the ebuilds themselves (the ebuilds |
9 | # This eclass handles depending on apache in a sane way and providing |
| 10 | ## should know what version of Apache they are building against). |
10 | # information about where certain interfaces are located. |
| 11 | ###### |
11 | # |
|
|
12 | # @NOTE: If you use this, be sure you use the need_* call after you have defined |
|
|
13 | # DEPEND and RDEPEND. Also note that you can not rely on the automatic |
|
|
14 | # RDEPEND=DEPEND that portage does if you use this eclass. |
|
|
15 | # |
|
|
16 | # See bug 107127 for more information. |
| 12 | |
17 | |
| 13 | #### |
18 | inherit multilib |
| 14 | ## APACHE_VERSION |
|
|
| 15 | ## |
|
|
| 16 | ## Stores the version of apache we are going to be ebuilding. This variable is |
|
|
| 17 | ## set by the need_apache{|1|2} functions. |
|
|
| 18 | ## |
|
|
| 19 | ## This needs to stay as '1' until apache2 is on by default -- although it |
|
|
| 20 | ## doesn't matter much as it's set by the need_apache functions. |
|
|
| 21 | #### |
|
|
| 22 | APACHE_VERSION='1' |
|
|
| 23 | |
19 | |
| 24 | #### |
20 | # ============================================================================== |
| 25 | ## APXS1, APXS2 |
21 | # INTERNAL VARIABLES |
| 26 | ## |
22 | # ============================================================================== |
| 27 | ## Paths to the apxs tools |
|
|
| 28 | #### |
|
|
| 29 | APXS1="/usr/sbin/apxs" |
|
|
| 30 | APXS2="/usr/sbin/apxs2" |
|
|
| 31 | |
23 | |
| 32 | #### |
24 | # @ECLASS-VARIABLE: APACHE_VERSION |
| 33 | ## APACHECTL1, APACHECTL2 |
25 | # @DESCRIPTION: |
| 34 | ## |
26 | # Stores the version of apache we are going to be ebuilding. This variable is |
| 35 | ## Paths to the apachectl tools |
27 | # set by the need_apache functions. |
| 36 | #### |
|
|
| 37 | APACHECTL1="/usr/sbin/apachectl" |
|
|
| 38 | APACHECTL2="/usr/sbin/apache2ctl" |
|
|
| 39 | |
28 | |
| 40 | #### |
29 | # @ECLASS-VARIABLE: APXS |
| 41 | ## APACHE1_BASEDIR, APACHE2_BASEDIR |
30 | # @DESCRIPTION: |
| 42 | ## |
31 | # Paths to the apxs tool |
| 43 | ## Paths to the server root directories |
|
|
| 44 | #### |
|
|
| 45 | APACHE1_BASEDIR="/usr/lib/apache" |
|
|
| 46 | APACHE2_BASEDIR="/usr/lib/apache2" |
|
|
| 47 | |
32 | |
| 48 | #### |
33 | # @ECLASS-VARIABLE: APACHECTL |
| 49 | ## APACHE1_CONFDIR, APACHE2_CONFDIR |
34 | # @DESCRIPTION: |
| 50 | ## |
35 | # Path to the apachectl tool |
| 51 | ## Paths to the configuration file directories (usually under |
|
|
| 52 | ## $APACHE?_BASEDIR/conf) |
|
|
| 53 | #### |
|
|
| 54 | APACHE1_CONFDIR="/etc/apache" |
|
|
| 55 | APACHE2_CONFDIR="/etc/apache2" |
|
|
| 56 | |
36 | |
| 57 | #### |
37 | # @ECLASS-VARIABLE: APACHE_BASEDIR |
| 58 | ## APACHE1_MODULES_CONFDIR, APACHE2_MODULES_CONFDIR |
38 | # @DESCRIPTION: |
| 59 | ## |
39 | # Path to the server root directory |
| 60 | ## Paths where module configuration files are kept |
|
|
| 61 | #### |
|
|
| 62 | APACHE1_MODULES_CONFDIR="${APACHE1_CONFDIR}/modules.d" |
|
|
| 63 | APACHE2_MODULES_CONFDIR="${APACHE2_CONFDIR}/modules.d" |
|
|
| 64 | |
40 | |
| 65 | #### |
41 | # @ECLASS-VARIABLE: APACHE_CONFDIR |
| 66 | ## APACHE1_MODULES_VHOSTDIR, APACHE2_MODULES_VHOSTDIR |
42 | # @DESCRIPTION: |
| 67 | ## |
43 | # Path to the configuration file directory |
| 68 | ## Paths where virtual host configuration files are kept |
|
|
| 69 | #### |
|
|
| 70 | APACHE1_VHOSTDIR="${APACHE1_CONFDIR}/vhosts.d" |
|
|
| 71 | APACHE2_VHOSTDIR="${APACHE2_CONFDIR}/vhosts.d" |
|
|
| 72 | |
44 | |
| 73 | #### |
45 | # @ECLASS-VARIABLE: APACHE_MODULES_CONFDIR |
| 74 | ## APACHE1_MODULESDIR, APACHE2_MODULESDIR |
46 | # @DESCRIPTION: |
| 75 | ## |
47 | # Path where module configuration files are kept |
| 76 | ## Paths where we install modules |
|
|
| 77 | #### |
|
|
| 78 | APACHE1_MODULESDIR="${APACHE1_BASEDIR}/modules" |
|
|
| 79 | APACHE2_MODULESDIR="${APACHE2_BASEDIR}/modules" |
|
|
| 80 | |
48 | |
| 81 | #### |
49 | # @ECLASS-VARIABLE: APACHE_VHOSTS_CONFDIR |
| 82 | ## APACHE1_DEPEND, APACHE2_DEPEND |
50 | # @DESCRIPTION: |
| 83 | ## |
51 | # Path where virtual host configuration files are kept |
| 84 | ## Dependencies for apache 1.x and apache 2.x |
|
|
| 85 | ## - apache2 must be at least version 2.0.52-r3, this is lowest version |
|
|
| 86 | ## containing our new overall changes -- trapni (Jan 21 2005) |
|
|
| 87 | ## - apache1 must be at least version 1.3.33-r1, but how to |
|
|
| 88 | ## define the DEPEND here? (FIXME) -- trapni (Jan 21 2005) |
|
|
| 89 | ## - currently not possible - bug #4315 -- vericgar (Jan 21 2005) |
|
|
| 90 | #### |
|
|
| 91 | APACHE1_DEPEND="=net-www/apache-1*" |
|
|
| 92 | APACHE2_DEPEND=">=net-www/apache-2.0.54-r10" |
|
|
| 93 | |
52 | |
| 94 | #### |
53 | # @ECLASS-VARIABLE: APACHE_MODULESDIR |
| 95 | ## APACHE_DEPEND |
54 | # @DESCRIPTION: |
| 96 | ## |
55 | # Path where we install modules |
| 97 | ## Dependency magic based on useflags to use the right DEPEND |
|
|
| 98 | #### |
|
|
| 99 | |
56 | |
| 100 | NEED_APACHE_DEPEND="apache2? ( ${APACHE2_DEPEND} ) !apache2? ( ${APACHE1_DEPEND} )" |
57 | # @ECLASS-VARIABLE: APACHE_DEPEND |
| 101 | WANT_APACHE_DEPEND="apache2? ( ${APACHE2_DEPEND} ) !apache2? ( apache? ( ${APACHE1_DEPEND} ) )" |
58 | # @DESCRIPTION: |
|
|
59 | # Dependencies for Apache |
|
|
60 | APACHE_DEPEND="www-servers/apache" |
| 102 | |
61 | |
| 103 | #### |
62 | # @ECLASS-VARIABLE: APACHE2_DEPEND |
| 104 | # uses_apache1() |
63 | # @DESCRIPTION: |
| 105 | # |
64 | # Dependencies for Apache 2.x |
| 106 | # sets up all of the environment variables required by an apache1 module |
65 | APACHE2_DEPEND="=www-servers/apache-2*" |
| 107 | #### |
|
|
| 108 | |
66 | |
| 109 | uses_apache1() { |
67 | # @ECLASS-VARIABLE: APACHE2_2_DEPEND |
|
|
68 | # @DESCRIPTION: |
|
|
69 | # Dependencies for Apache 2.2.x |
|
|
70 | APACHE2_2_DEPEND="=www-servers/apache-2.2*" |
|
|
71 | |
|
|
72 | # @ECLASS-VARIABLE: WANT_APACHE_DEPEND |
|
|
73 | # @DESCRIPTION: |
|
|
74 | # Dependency magic based on useflag to use the right DEPEND |
|
|
75 | WANT_APACHE_DEPEND="apache2? ( ${APACHE_DEPEND} )" |
|
|
76 | |
|
|
77 | # @ECLASS-VARIABLE: WANT_APACHE2_DEPEND |
|
|
78 | # @DESCRIPTION: |
|
|
79 | # Dependency magic based on useflag to use the right DEPEND |
|
|
80 | WANT_APACHE2_DEPEND="apache2? ( ${APACHE2_DEPEND} )" |
|
|
81 | |
|
|
82 | # @ECLASS-VARIABLE: WANT_APACHE2_2_DEPEND |
|
|
83 | # @DESCRIPTION: |
|
|
84 | # Dependency magic based on useflag to use the right DEPEND |
|
|
85 | WANT_APACHE2_2_DEPEND="apache2? ( ${APACHE2_2_DEPEND} )" |
|
|
86 | |
|
|
87 | # ============================================================================== |
|
|
88 | # INTERNAL FUNCTIONS |
|
|
89 | # ============================================================================== |
|
|
90 | |
|
|
91 | _init_apache2() { |
|
|
92 | debug-print-function $FUNCNAME $* |
|
|
93 | |
|
|
94 | # WARNING: Do not use these variables with anything that is put |
|
|
95 | # into the dependency cache (DEPEND/RDEPEND/etc) |
| 110 | APACHE_VERSION='1' |
96 | APACHE_VERSION="2" |
| 111 | APXS="$APXS1" |
97 | APXS="/usr/sbin/apxs2" |
| 112 | USE_APACHE2= |
98 | APACHE_BIN="/usr/sbin/apache2" |
|
|
99 | APACHE_CTL="/usr/sbin/apache2ctl" |
|
|
100 | # legacy alias |
| 113 | APACHECTL="${APACHECTL1}" |
101 | APACHECTL="${APACHE_CTL}" |
| 114 | APACHE_BASEDIR="${APACHE1_BASEDIR}" |
102 | APACHE_BASEDIR="/usr/$(get_libdir)/apache2" |
| 115 | APACHE_CONFDIR="${APACHE1_CONFDIR}" |
103 | APACHE_CONFDIR="/etc/apache2" |
| 116 | APACHE_MODULES_CONFDIR="${APACHE1_MODULES_CONFDIR}" |
104 | APACHE_MODULES_CONFDIR="${APACHE_CONFDIR}/modules.d" |
| 117 | APACHE_VHOSTSDIR="${APACHE1_VHOSTSDIR}" |
105 | APACHE_VHOSTS_CONFDIR="${APACHE_CONFDIR}/vhosts.d" |
| 118 | APACHE_MODULESDIR="${APACHE1_MODULESDIR}" |
106 | APACHE_MODULESDIR="${APACHE_BASEDIR}/modules" |
| 119 | } |
107 | } |
| 120 | |
108 | |
| 121 | #### |
109 | _init_no_apache() { |
| 122 | # uses_apache2() |
110 | debug-print-function $FUNCNAME $* |
| 123 | # |
|
|
| 124 | # sets up all of the environment variables required by an apache2 module |
|
|
| 125 | #### |
|
|
| 126 | |
|
|
| 127 | uses_apache2() { |
|
|
| 128 | APACHE_VERSION='2' |
111 | APACHE_VERSION="0" |
| 129 | USE_APACHE2=2 |
|
|
| 130 | APXS="$APXS2" |
|
|
| 131 | APACHECTL="${APACHECTL2}" |
|
|
| 132 | APACHE_BASEDIR="${APACHE2_BASEDIR}" |
|
|
| 133 | APACHE_CONFDIR="${APACHE2_CONFDIR}" |
|
|
| 134 | APACHE_MODULES_CONFDIR="${APACHE2_MODULES_CONFDIR}" |
|
|
| 135 | APACHE_VHOSTSDIR="${APACHE2_VHOSTSDIR}" |
|
|
| 136 | APACHE_MODULESDIR="${APACHE2_MODULESDIR}" |
|
|
| 137 | } |
112 | } |
| 138 | |
113 | |
| 139 | doesnt_use_apache() { |
114 | # ============================================================================== |
| 140 | APACHE_VERSION='0' |
115 | # PUBLIC FUNCTIONS |
| 141 | USE_APACHE= |
116 | # ============================================================================== |
|
|
117 | |
|
|
118 | # @FUNCTION: want_apache |
|
|
119 | # @DESCRIPTION: |
|
|
120 | # An ebuild calls this to get the dependency information for optional apache-2.x |
|
|
121 | # support. |
|
|
122 | want_apache2() { |
|
|
123 | debug-print-function $FUNCNAME $* |
|
|
124 | |
|
|
125 | IUSE="${IUSE} apache2" |
|
|
126 | DEPEND="${DEPEND} ${WANT_APACHE2_DEPEND}" |
|
|
127 | RDEPEND="${RDEPEND} ${WANT_APACHE2_DEPEND}" |
|
|
128 | |
|
|
129 | if use apache2 ; then |
|
|
130 | _init_apache2 |
|
|
131 | else |
|
|
132 | _init_no_apache |
|
|
133 | fi |
| 142 | } |
134 | } |
| 143 | |
135 | |
| 144 | #### |
136 | # @FUNCTION: want_apache |
| 145 | ## need_apache1 |
137 | # @DESCRIPTION: |
| 146 | ## |
|
|
| 147 | ## An ebuild calls this to get the dependency information |
138 | # An ebuild calls this to get the dependency information for optional |
| 148 | ## for apache-1.x. An ebuild should use this in order for |
139 | # apache-2.2.x support. |
| 149 | ## future changes to the build infrastructure to happen |
140 | want_apache2_2() { |
| 150 | ## seamlessly. All an ebuild needs to do is include the |
141 | debug-print-function $FUNCNAME $* |
| 151 | ## line need_apache1 somewhere. |
|
|
| 152 | #### |
|
|
| 153 | need_apache1() { |
|
|
| 154 | debug-print-function need_apache1 |
|
|
| 155 | |
142 | |
|
|
143 | IUSE="${IUSE} apache2" |
| 156 | DEPEND="${DEPEND} ${APACHE1_DEPEND}" |
144 | DEPEND="${DEPEND} ${WANT_APACHE2_2_DEPEND}" |
| 157 | RDEPEND="${RDEPEND} ${APACHE1_DEPEND}" |
145 | RDEPEND="${RDEPEND} ${WANT_APACHE2_2_DEPEND}" |
| 158 | APACHE_VERSION='1' |
146 | |
|
|
147 | if use apache2 ; then |
|
|
148 | _init_apache2 |
|
|
149 | else |
|
|
150 | _init_no_apache |
|
|
151 | fi |
| 159 | } |
152 | } |
| 160 | |
153 | |
| 161 | #### |
154 | # @FUNCTION: want_apache |
| 162 | ## need_apache2 |
155 | # @DESCRIPTION: |
| 163 | ## |
|
|
| 164 | ## An ebuild calls this to get the dependency information |
156 | # An ebuild calls this to get the dependency information for optional apache |
| 165 | ## for apache-2.x. An ebuild should use this in order for |
157 | # support. |
| 166 | ## future changes to the build infrastructure to happen |
158 | want_apache() { |
| 167 | ## seamlessly. All an ebuild needs to do is include the |
159 | want_apache2 |
| 168 | ## line need_apache1 somewhere. |
160 | } |
| 169 | #### |
161 | |
|
|
162 | # @FUNCTION: need_apache2 |
|
|
163 | # @DESCRIPTION: |
|
|
164 | # Works like need_apache, but its used by modules that only support |
|
|
165 | # apache 2.x and do not work with other versions. |
| 170 | need_apache2() { |
166 | need_apache2() { |
| 171 | debug-print-function need_apache2 |
167 | debug-print-function $FUNCNAME $* |
| 172 | |
168 | |
| 173 | DEPEND="${DEPEND} ${APACHE2_DEPEND}" |
169 | DEPEND="${DEPEND} ${APACHE2_DEPEND}" |
| 174 | RDEPEND="${RDEPEND} ${APACHE2_DEPEND}" |
170 | RDEPEND="${RDEPEND} ${APACHE2_DEPEND}" |
| 175 | APACHE_VERSION='2' |
171 | _init_apache2 |
| 176 | } |
172 | } |
| 177 | |
173 | |
| 178 | #### |
174 | # @FUNCTION: need_apache2_2 |
| 179 | ## DO NOT CHANGE THIS FUNCTION UNLESS YOU UNDERSTAND THE CONSEQUENCES IT |
175 | # @DESCRIPTION: |
| 180 | ## WILL HAVE ON THE CACHE! There MUST be a apache2? () block in DEPEND for |
176 | # Works like need_apache, but its used by modules that only support |
| 181 | ## things to work correct in the dependency calculation stage. |
177 | # apache 2.2.x and do not work with other versions. |
| 182 | #### |
|
|
| 183 | need_apache() { |
178 | need_apache2_2() { |
| 184 | debug-print-function need_apache |
179 | debug-print-function $FUNCNAME $* |
| 185 | |
180 | |
| 186 | IUSE="${IUSE} apache2" |
|
|
| 187 | DEPEND="${DEPEND} ${NEED_APACHE_DEPEND}" |
181 | DEPEND="${DEPEND} ${APACHE2_2_DEPEND}" |
| 188 | RDEPEND="${RDEPEND} ${NEED_APACHE_DEPEND}" |
182 | RDEPEND="${RDEPEND} ${APACHE2_2_DEPEND}" |
| 189 | if useq apache2; then |
183 | _init_apache2 |
| 190 | uses_apache2 |
|
|
| 191 | else |
|
|
| 192 | uses_apache1 |
|
|
| 193 | fi |
|
|
| 194 | } |
184 | } |
| 195 | |
185 | |
|
|
186 | # @FUNCTION: need_apache |
|
|
187 | # @DESCRIPTION: |
|
|
188 | # An ebuild calls this to get the dependency information for apache. An |
|
|
189 | # ebuild should use this in order for future changes to the build infrastructure |
|
|
190 | # to happen seamlessly. All an ebuild needs to do is include the line |
|
|
191 | # need_apache somewhere. |
| 196 | want_apache() { |
192 | need_apache() { |
| 197 | debug-print-function want_apache |
193 | need_apache2 |
| 198 | |
|
|
| 199 | IUSE="${IUSE} apache apache2" |
|
|
| 200 | DEPEND="${DEPEND} ${WANT_APACHE_DEPEND}" |
|
|
| 201 | RDEPEND="${DEPEND} ${WANT_APACHE_DEPEND}" |
|
|
| 202 | if useq apache2 ; then |
|
|
| 203 | uses_apache2 |
|
|
| 204 | elif useq apache ; then |
|
|
| 205 | uses_apache1 |
|
|
| 206 | else |
|
|
| 207 | doesnt_use_apache |
|
|
| 208 | fi |
|
|
| 209 | } |
194 | } |