/[gentoo-x86]/eclass/cvs.eclass
Gentoo

Contents of /eclass/cvs.eclass

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.49 - (show annotations) (download)
Sun Sep 28 17:24:18 2003 UTC (10 years, 10 months ago) by coredumb
Branch: MAIN
Changes since 1.48: +4 -2 lines
Clarify things a bit

1 # Copyright 1999-2003 Gentoo Technologies, Inc.
2 # Distributed under the terms of the GNU General Public License v2
3 # $Header: /home/cvsroot/gentoo-x86/eclass/cvs.eclass,v 1.48 2003/09/28 17:19:43 coredumb Exp $
4 #
5 # Current Maintainer: Tal Peer <coredumb@gentoo.org>
6 # Original Author: Dan Armak <danarmak@gentoo.org>
7 #
8 # SSH auth code by Danny <danny.milo@gmx.net>
9 #
10 # This eclass provides the generic cvs fetching functions.
11 # to use from an ebuild, set the 'ebuild-configurable settings' below in your ebuild before inheriting.
12 # then either leave the default src_unpack or extend over cvs_src_unpack.
13 # if you find that you need to call the cvs_* functions directly, i'd be interested to hear about it.
14
15 # TODO:
16 # Implement more auth types (gserver?, kserver?)
17 # Implement more 'ext' auth methods (do anyone actually use it with anything other than ssh?)
18 # Add support for password-based ssh (only keys supported now)
19
20 ECLASS=cvs
21 INHERITED="$INHERITED $ECLASS"
22
23 # You shouldn't change these settings yourself! The ebuild/eclass inheriting this eclass
24 # will take care of that. If you want to set the global KDE cvs ebuilds' settings,
25 # see the comments in kde-source.eclass.
26
27 # --- begin ebuild-configurable settings
28
29 # cvs command to run. you can set fex. "cvs -t" for extensive debug information
30 # on the cvs onnection. the default of "cvs -q -f -z4" means to be quiet, to disregard
31 # the ~/.cvsrc config file and to use maximum compression.
32 [ -z "$ECVS_CVS_COMMAND" ] && ECVS_CVS_COMMAND="cvs -q -f -z4"
33
34 # cvs options given after the cvs command (update or checkout)
35 # don't remove -dP from update or things won't work
36 [ -z "$ECVS_UP_OPTS" ] && ECVS_UP_OPTS="-dP"
37 [ -z "$ECVS_CO_OPTS" ] && ECVS_CO_OPTS=""
38
39 # set this to some value for the module/subdir to be fetched non-recursively: ECVS_LOCAL
40
41 # local name of module. useful if the module on the server is called
42 # something common like 'driver' or is nested deep in a tree, and you don't
43 # like useless empty directories.
44 # WARNING: to be set only from within ebuilds! if set in your shell or some such,
45 # things wil break because the ebuild won't expect it and have e.g. a wrong $S setting.
46 # ECVS_LOCALNAME
47
48 # Where the cvs modules are stored/accessed
49 [ -z "$ECVS_TOP_DIR" ] && ECVS_TOP_DIR="${DISTDIR}/cvs-src"
50
51 # Name of cvs server, set to "offline" to disable fetching
52 # (i.e. to assume module is checked out already and don't update it).
53 # Format is server:/dir e.g. "anoncvs.kde.org:/home/kde". remove the other
54 # parts of the full CVSROOT (which looks like
55 # ":pserver:anonymous@anoncvs.kde.org:/home/kde"); these are added from
56 # other settings
57 # the special value 'offline' disables fetching, assumes sources are alread in ECVS_TOP_DIR
58 [ -z "$ECVS_SERVER" ] && ECVS_SERVER="offline"
59
60 # Authentication method to use - possible values are "pserver" and "ext"
61 # Currently, only method for 'ext' is ssh, please note that it doesn't
62 # work with passwords, only with keys.
63 [ -z "$ECVS_AUTH" ] && ECVS_AUTH="pserver"
64
65 # Use su to run cvs as user
66 # Currently b0rked and wouldn't work with portage userpriv anyway without special magic
67 # [ -z "$ECVS_RUNAS" ] && ECVS_RUNAS="`whoami`"
68
69 # Username to give to the server
70 [ -z "$ECVS_USER" ] && ECVS_USER="anonymous"
71
72 # Password to use
73 [ -z "$ECVS_PASS" ] && ECVS_PASS=""
74
75 # Module to be fetched, must be set when kde_src_unpack is called
76 # can include several directory levels, ie foo/bar/baz
77 #[ -z "$ECVS_MODULE" ] && die "$ECLASS: error: ECVS_MODULE not set, cannot continue"
78
79 # Branch/tag to use, default is HEAD
80 # the following default _will_ reset your branch checkout to head if used
81 #[ -z "$ECVS_BRANCH" ] && ECVS_BRANCH="HEAD"
82
83 # deprecated - do not use
84 [ -n "$ECVS_SUBDIR" ] && die "ERROR: deprecated ECVS_SUBDIR defined. Please fix this ebuild."
85
86 # ECVS_CLEAN: set this to something to get a clean copy when updating (passes the -C option to cvs update)
87
88 # --- end ebuild-configurable settings ---
89
90 # add cvs to deps
91 # ssh is used for ext auth
92 # sudo is used to run as a specified user
93 DEPEND="$DEPEND dev-util/cvs app-admin/sudo"
94
95 if [ "$ECVS_AUTH" == "ext" ]; then
96 #default to ssh
97 [ -z "$CVS_RSH" ] && export SSH_RSH="ssh"
98 if [ "$CVS_RSH" != "ssh" ]; then
99 die "Support for ext auth with clients other than ssh has not been implemented yet"
100 fi
101 DEPEND="$DEPEND net-misc/openssh"
102 fi
103
104 # calls cvs_contorl, is called from cvs_src_unpack
105 cvs_fetch() {
106
107 # fix for sourceforge which doesnt want -z>3 anymore.
108
109 (echo $ECVS_SERVER | grep sourceforge) && [ "$ECVS_CVS_COMMAND" == "cvs -q -f -z4" ] && ECVS_CVS_COMMAND="cvs -q -f -z3"
110
111 debug-print-function $FUNCNAME $*
112
113 # parameters modifying other parameters that should be effective every time cvs_fetch is called,
114 # and not just every time cvs.eclas is inherited
115 # 1. parameter for local (non-recursive) fetching
116 if [ -n "$ECVS_LOCAL" ]; then
117 ECVS_UP_OPTS="$ECVS_UP_OPTS -l"
118 ECVS_CO_OPTS="$ECVS_CO_OPTS -l"
119 fi
120 # 2. cvs auto-switches branches, we just have to pass the correct -rBRANCH option to it when updating.
121 # doing it this way we get multiple -rX options - harmless afaik
122 if [ -n "$ECVS_BRANCH" ]; then
123 ECVS_UP_OPTS="$ECVS_UP_OPTS -r$ECVS_BRANCH"
124 ECVS_CO_OPTS="$ECVS_CO_OPTS -r$ECVS_BRANCH"
125 fi
126
127 if [ "$ECVS_LOCALNAME" != "$ECVS_MODULE" ]; then
128 # the option to cvs on which this is based. note this isn't the same as the
129 # global -d option to cvs, which specifies the cvs server. ugh @ cvs syntax.
130 ECVS_CO_OPTS="$ECVS_CO_OPTS -d $ECVS_LOCALNAME"
131 fi
132
133 if [ -n "$ECVS_CLEAN" ]; then
134 ECVS_UP_OPTS="$ECVS_UP_OPTS -C"
135 fi
136
137 # it's easiest to always be in "run-as mode", logic-wise
138 # or would be if sudo didn't ask for a password even when sudo'ing to `whoami`
139 if [ -z "$ECVS_RUNAS" ]; then
140 run=""
141 else
142 run="sudo -u $ECVS_RUNAS"
143 fi
144
145 # create the top dir if needed
146 if [ ! -d "$ECVS_TOP_DIR" ]; then
147 # note that the addwrite statements in this block are only there to allow creating ECVS_TOP_DIR;
148 # we've already allowed writing inside it
149 # this is because it's simpler than trying to find out the parent path of the directory, which
150 # would need to be the real path and not a symlink for things to work (so we can't just remove
151 # the last path element in the string)
152 debug-print "$FUNCNAME: checkout mode. creating cvs directory"
153 addwrite /foobar
154 addwrite /
155 $run mkdir -p "/$ECVS_TOP_DIR"
156 export SANDBOX_WRITE="${SANDBOX_WRITE//:\/foobar:\/}"
157 fi
158
159 # in case ECVS_TOP_DIR is a symlink to a dir, get the real dir's path,
160 # otherwise addwrite() doesn't work.
161 cd -P "$ECVS_TOP_DIR" > /dev/null
162 ECVS_TOP_DIR="`/bin/pwd`"
163
164 # determine checkout or update mode
165 if [ ! -d "$ECVS_TOP_DIR/$ECVS_LOCALNAME/CVS" ]; then
166 mode=checkout
167 else
168 mode=update
169 fi
170
171 # disable the sandbox for this dir
172 addwrite "$ECVS_TOP_DIR"
173
174 # chowning the directory and all contents
175 if [ -n "$ECVS_RUNAS" ]; then
176 $run chown -R "$ECVS_RUNAS" "/$ECVS_TOP_DIR"
177 fi
178
179 # our server string (aka CVSROOT), without the password so it can be put in Root
180 server=":${ECVS_AUTH}:${ECVS_USER}@${ECVS_SERVER}"
181
182 # switch servers automagically if needed
183 if [ "$mode" == "update" ]; then
184 cd /$ECVS_TOP_DIR/$ECVS_LOCALNAME
185 oldserver="`$run cat CVS/Root`"
186 if [ "$server" != "$oldserver" ]; then
187
188 einfo "Changing CVS server from $oldserver to $server:"
189 debug-print "$FUNCNAME: Changing CVS server from $oldserver to $server:"
190
191 einfo "Searching for CVS dirs..."
192 cvsdirs="`$run find . -iname CVS -print`"
193 debug-print "$FUNCNAME: CVS dirs found:"
194 debug-print "$cvsdirs"
195
196 einfo "Modifying CVS dirs..."
197 for x in $cvsdirs; do
198 debug-print "In $x"
199 $run echo "$server" > "$x/Root"
200 done
201
202 fi
203 fi
204
205 # prepare a cvspass file just for this session, we don't want to mess with ~/.cvspass
206 touch "${T}/cvspass"
207 export CVS_PASSFILE="${T}/cvspass"
208 if [ -n "$ECVS_RUNAS" ]; then
209 chown "$ECVS_RUNAS" "${T}/cvspass"
210 fi
211
212 # the server string with the password in it, for login
213 cvsroot_pass=":${ECVS_AUTH}:${ECVS_USER}:${ECVS_PASS}@${ECVS_SERVER}"
214 # ditto without the password, for checkout/update after login, so that
215 # the CVS/Root files don't contain the password in plaintext
216 cvsroot_nopass=":${ECVS_AUTH}:${ECVS_USER}@${ECVS_SERVER}"
217
218 # commands to run
219 cmdlogin="${run} ${ECVS_CVS_COMMAND} -d \"${cvsroot_pass}\" login"
220 cmdupdate="${run} ${ECVS_CVS_COMMAND} -d \"${cvsroot_nopass}\" update ${ECVS_UP_OPTS} ${ECVS_LOCALNAME}"
221 cmdcheckout="${run} ${ECVS_CVS_COMMAND} -d \"${cvsroot_nopass}\" checkout ${ECVS_CO_OPTS} ${ECVS_MODULE}"
222
223 cd "${ECVS_TOP_DIR}"
224 if [ "${ECVS_AUTH}" == "pserver" ]; then
225 einfo "Running $cmdlogin"
226 eval $cmdlogin || die "cvs login command failed"
227 if [ "${mode}" == "update" ]; then
228 einfo "Running $cmdupdate"
229 eval $cmdupdate || die "cvs update command failed"
230 elif [ "${mode}" == "checkout" ]; then
231 einfo "Running $cmdcheckout"
232 eval $cmdcheckout|| die "cvs checkout command failed"
233 fi
234 elif [ "${ECVS_AUTH}" == "ext" ]; then
235 #no login needed for ext
236 if [ "${mode}" == "update" ]; then
237 einfo "Running $cmdupdate"
238 eval $cmdupdate || die "cvs update command failed"
239 elif [ "${mode}" == "checkout" ]; then
240 einfo "Running $cmdcheckout"
241 eval $cmdcheckout|| die "cvs checkout command failed"
242 fi
243 fi
244
245 # restore ownership. not sure why this is needed, but someone added it in the orig ECVS_RUNAS stuff.
246 if [ -n "$ECVS_RUNAS" ]; then
247 chown `whoami` "${T}/cvspass"
248 fi
249
250 }
251
252
253 cvs_src_unpack() {
254
255 debug-print-function $FUNCNAME $*
256
257 debug-print "$FUNCNAME: init:
258 ECVS_CVS_COMMAND=$ECVS_CVS_COMMAND
259 ECVS_UP_OPTS=$ECVS_UP_OPTS
260 ECVS_CO_OPTS=$ECVS_CO_OPTS
261 ECVS_TOP_DIR=$ECVS_TOP_DIR
262 ECVS_SERVER=$ECVS_SERVER
263 ECVS_USER=$ECVS_USER
264 ECVS_PASS=$ECVS_PASS
265 ECVS_MODULE=$ECVS_MODULE
266 ECVS_LOCAL=$ECVS_LOCAL
267 ECVS_RUNAS=$ECVS_RUNAS
268 ECVS_LOCALNAME=$ECVS_LOCALNAME"
269
270 [ -z "$ECVS_MODULE" ] && die "ERROR: CVS module not set, cannot continue."
271
272 # merely setting this default value makes things fail when cvs_src_unpack is called
273 # more than once per ebuild (eg kdenonbeta submodules); so if we set a default value,
274 # we disable it again at the function's end.
275 # of course, we could instead always reference it with the bash syntax for 'take default
276 # value from this other variable if undefined', but i'm lazy.
277 if [ -z "$ECVS_LOCALNAME" ]; then
278 ECVS_LOCALNAME="$ECVS_MODULE"
279 ECVS_LOCALNAME_SETDEFAULT=true
280 fi
281
282
283 if [ "$ECVS_SERVER" == "offline" ]; then
284 # we're not required to fetch anything, the module already exists and shouldn't be updated
285 if [ -d "${ECVS_TOP_DIR}/${ECVS_LOCALNAME}" ]; then
286 debug-print "$FUNCNAME: offline mode"
287 else
288 debug-print "$FUNCNAME: offline mode specified but directory ${ECVS_TOP_DIR}/${ECVS_LOCALNAME} not found, exiting with error"
289 die "ERROR: Offline mode specified, but dir ${ECVS_TOP_DIR}/${ECVS_LOCALNAME} not found. Aborting."
290 fi
291 elif [ -n "$ECVS_SERVER" ]; then # ECVS_SERVER!=offline --> real fetching mode
292 einfo "Fetching cvs module $ECVS_MODULE into $ECVS_TOP_DIR..."
293 cvs_fetch
294 else # ECVS_SERVER not set
295 die "ERROR: CVS server not set, cannot continue."
296 fi
297
298 einfo "Copying $ECVS_MODULE from $ECVS_TOP_DIR..."
299 debug-print "Copying module $ECVS_MODULE local_mode=$ECVS_LOCAL from $ECVS_TOP_DIR..."
300
301 # probably redundant, but best to make sure
302 mkdir -p "$WORKDIR/$ECVS_LOCALNAME"
303
304 if [ -n "$ECVS_LOCAL" ]; then
305 cp -f "$ECVS_TOP_DIR/$ECVS_LOCALNAME"/* "$WORKDIR/$ECVS_LOCALNAME"
306 else
307 cp -Rf "$ECVS_TOP_DIR/$ECVS_LOCALNAME" "$WORKDIR/$ECVS_LOCALNAME/.."
308 fi
309
310 # if the directory is empty, remove it; empty directories cannot exist in cvs.
311 # this happens when fex. kde-source requests module/doc/subdir which doesn't exist.
312 # still create the empty directory in workdir though.
313 if [ "`ls -A \"${ECVS_TOP_DIR}/${ECVS_LOCALNAME}\"`" == "CVS" ]; then
314 debug-print "$FUNCNAME: removing cvs-empty directory $ECVS_LOCALNAME"
315 rm -rf "${ECVS_TOP_DIR}/${ECVS_LOCALNAME}"
316 fi
317
318 # implement some of base_src_unpack's functionality;
319 # note however that base.eclass may not have been inherited!
320 if [ -n "$PATCHES" ]; then
321 debug-print "$FUNCNAME: PATCHES=$PATCHES, S=$S, autopatching"
322 cd "$S"
323 for x in $PATCHES; do
324 debug-print "patching from $x"
325 patch -p0 < "$x"
326 done
327 # make sure we don't try to apply patches more than once, since
328 # cvs_src_unpack is usually called several times from e.g. kde-source_src_unpack
329 export PATCHES=""
330 fi
331
332 if [ -n "$ECVS_LOCALNAME_SETDEFAULT" ]; then
333 unset ECVS_LOCALNAME
334 unset ECVS_LOCALNAME_SETDEFAULT
335 fi
336
337 einfo "Module ${ECVS_MODULE} is now in ${WORKDIR}"
338
339 }
340
341 EXPORT_FUNCTIONS src_unpack

  ViewVC Help
Powered by ViewVC 1.1.20