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

Contents of /eclass/cvs.eclass

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.51 - (show annotations) (download)
Fri Jun 25 00:39:48 2004 UTC (9 years, 10 months ago) by vapier
Branch: MAIN
Changes since 1.50: +2 -2 lines
update the copyright info

1 # Copyright 1999-2004 Gentoo Foundation
2 # Distributed under the terms of the GNU General Public License v2
3 # $Header: /home/cvsroot/gentoo-x86/eclass/cvs.eclass,v 1.50 2004/01/04 14:35:12 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 # SSH password authentication support and host key verification
11 # support by Jeremy Maitin-Shepard <jbms@gentoo.org>
12
13
14 # This eclass provides the generic cvs fetching functions. To use
15 # this from an ebuild, set the `ebuild-configurable settings' as
16 # specified below in your ebuild before inheriting. Then either leave
17 # the default src_unpack or extend over cvs_src_unpack. If you find
18 # that you need to call the cvs_* functions directly, I'd be
19 # interested to hear about it.
20
21 # TODO:
22
23 # Implement more auth types (gserver?, kserver?)
24
25 # Support additional remote shells with `ext' authentication (does
26 # anyone actually need to use it with anything other than SSH?)
27
28
29 ECLASS=cvs
30 INHERITED="$INHERITED $ECLASS"
31
32 # Users shouldn't change these settings! The ebuild/eclass inheriting
33 # this eclass will take care of that. If you want to set the global
34 # KDE cvs ebuilds' settings, see the comments in kde-source.eclass.
35
36 # --- begin ebuild-configurable settings
37
38 # ECVS_CVS_COMMAND -- CVS command to run
39 #
40 # You can set, for example, "cvs -t" for extensive debug information
41 # on the cvs connection. The default of "cvs -q -f -z4" means to be
42 # quiet, to disregard the ~/.cvsrc config file and to use maximum
43 # compression.
44
45 [ -z "$ECVS_CVS_COMMAND" ] && ECVS_CVS_COMMAND="cvs -q -f -z4"
46
47
48 # ECVS_UP_OPTS, ECVS_CO_OPTS -- CVS options given after the cvs
49 # command (update or checkout).
50 #
51 # Don't remove -dP from update or things won't work.
52
53 [ -z "$ECVS_UP_OPTS" ] && ECVS_UP_OPTS="-dP"
54 [ -z "$ECVS_CO_OPTS" ] && ECVS_CO_OPTS=""
55
56
57 # ECVS_LOCAL -- If this is set, the CVS module will be fetched
58 # non-recursively. Refer to the information in the CVS man page
59 # regarding the -l command option (not the -l global option).
60
61
62 # ECVS_LOCALNAME -- local name of checkout directory
63 #
64 # This is useful if the module on the server is called something
65 # common like 'driver' or is nested deep in a tree, and you don't like
66 # useless empty directories.
67 #
68 # WARNING: Set this only from within ebuilds! If set in your shell or
69 # some such, things will break because the ebuild won't expect it and
70 # have e.g. a wrong $S setting.
71
72
73 # ECVS_TOP_DIR -- The directory under which CVS modules are checked
74 # out.
75
76 [ -z "$ECVS_TOP_DIR" ] && ECVS_TOP_DIR="${DISTDIR}/cvs-src"
77
78 # ECVS_NAME -- CVS path
79 #
80 # The format is "server:/dir", e.g. "anoncvs.kde.org:/home/kde".
81 # Remove the other parts of the full CVSROOT, which might look like
82 # ":pserver:anonymous@anoncvs.kde.org:/home/kde"; this is generated
83 # using other settings also.
84 #
85 # Set this to "offline" to disable fetching (i.e. to assume the module
86 # is already checked out in ECVS_TOP_DIR).
87
88 [ -z "$ECVS_SERVER" ] && ECVS_SERVER="offline"
89
90
91 # ECVS_MODULE -- the name of the CVS module to be fetched
92 #
93 # This must be set when cvs_src_unpack is called. This can include
94 # several directory levels, i.e. "foo/bar/baz"
95
96 #[ -z "$ECVS_MODULE" ] && die "$ECLASS: error: ECVS_MODULE not set, cannot continue"
97
98
99 # ECVS_BRANCH -- the name of the branch/tag to use
100
101 # The default is "HEAD". The following default _will_ reset your
102 # branch checkout to head if used.
103
104 #[ -z "$ECVS_BRANCH" ] && ECVS_BRANCH="HEAD"
105
106
107 # ECVS_AUTH -- authentication method to use
108 #
109 # Possible values are "pserver" and "ext". If `ext' authentication is
110 # used, the remote shell to use can be specified in CVS_RSH (SSH is
111 # used by default). Currently, the only supported remote shell for
112 # `ext' authentication is SSH.
113 [ -z "$ECVS_AUTH" ] && ECVS_AUTH="pserver"
114
115 # ECVS_USER -- Username to use for authentication on the remote server
116 [ -z "$ECVS_USER" ] && ECVS_USER="anonymous"
117
118
119 # ECVS_PASS -- Password to use for authentication on the remote server
120 [ -z "$ECVS_PASS" ] && ECVS_PASS=""
121
122
123 # ECVS_SSH_HOST_KEY
124 #
125 # If SSH is used for `ext' authentication, use this variable to
126 # specify the host key of the remote server. The format of the value
127 # should be the same format that is used for the SSH known hosts file.
128 #
129 # WARNING: If a SSH host key is not specified using this variable, the
130 # remote host key will not be verified.
131
132
133 # ECVS_CLEAN -- Set this to get a clean copy when updating (passes the
134 # -C option to cvs update)
135
136
137 # ECVS_RUNAS
138 #
139 # Specifies an alternate (non-root) user to use to run cvs. Currently
140 # b0rked and wouldn't work with portage userpriv anyway without
141 # special magic.
142
143 # [ -z "$ECVS_RUNAS" ] && ECVS_RUNAS="`whoami`"
144
145
146 # ECVS_SUBDIR -- deprecated, do not use
147 [ -n "$ECVS_SUBDIR" ] && die "ERROR: deprecated ECVS_SUBDIR defined. Please fix this ebuild."
148
149
150 # --- end ebuild-configurable settings ---
151
152 # add cvs to deps
153 # ssh is used for ext auth
154 # sudo is used to run as a specified user
155 DEPEND="$DEPEND dev-util/cvs app-admin/sudo"
156
157 if [ "$ECVS_AUTH" == "ext" ]; then
158 #default to ssh
159 [ -z "$CVS_RSH" ] && export SSH_RSH="ssh"
160 if [ "$CVS_RSH" != "ssh" ]; then
161 die "Support for ext auth with clients other than ssh has not been implemented yet"
162 fi
163 DEPEND="$DEPEND net-misc/openssh"
164 fi
165
166 # called from cvs_src_unpack
167 cvs_fetch() {
168
169 # Make these options local variables so that the global values are
170 # not affected by modifications in this function.
171
172 local ECVS_COMMAND="${ECVS_COMMAND}"
173 local ECVS_UP_OPTS="${ECVS_UP_OPTS}"
174 local ECVS_CO_OPTS="${ECVS_CO_OPTS}"
175
176 # Fix for sourceforge which doesnt want -z>3 anymore.
177
178 (echo $ECVS_SERVER | grep -q sourceforge) \
179 && [ "$ECVS_CVS_COMMAND" == "cvs -q -f -z4" ] \
180 && ECVS_CVS_COMMAND="cvs -q -f -z3"
181
182 debug-print-function $FUNCNAME $*
183
184 # Update variables that are modified by ebuild parameters, which
185 # should be effective every time cvs_fetch is called, and not just
186 # every time cvs.eclass is inherited
187
188
189 # Handle parameter for local (non-recursive) fetching
190
191 if [ -n "$ECVS_LOCAL" ]; then
192 ECVS_UP_OPTS="$ECVS_UP_OPTS -l"
193 ECVS_CO_OPTS="$ECVS_CO_OPTS -l"
194 fi
195
196 # Handle ECVS_BRANCH option
197 #
198 # Because CVS auto-switches branches, we just have to pass the
199 # correct -rBRANCH option when updating.
200
201 if [ -n "$ECVS_BRANCH" ]; then
202 ECVS_UP_OPTS="$ECVS_UP_OPTS -r$ECVS_BRANCH"
203 ECVS_CO_OPTS="$ECVS_CO_OPTS -r$ECVS_BRANCH"
204 fi
205
206 # Handle ECVS_LOCALNAME, which specifies the local directory name
207 # to use. Note that the -d command option is not equivalent to
208 # the global -d option.
209
210 if [ "$ECVS_LOCALNAME" != "$ECVS_MODULE" ]; then
211 ECVS_CO_OPTS="$ECVS_CO_OPTS -d $ECVS_LOCALNAME"
212 fi
213
214
215 if [ -n "$ECVS_CLEAN" ]; then
216 ECVS_UP_OPTS="$ECVS_UP_OPTS -C"
217 fi
218
219
220 # It would be easiest to always be in "run-as mode", logic-wise,
221 # if sudo didn't ask for a password even when sudo'ing to `whoami`.
222
223 if [ -z "$ECVS_RUNAS" ]; then
224 run=""
225 else
226 run="sudo -u $ECVS_RUNAS"
227 fi
228
229 # Create the top dir if needed
230
231 if [ ! -d "$ECVS_TOP_DIR" ]; then
232
233 # Note that the addwrite statements in this block are only
234 # there to allow creating ECVS_TOP_DIR; we allow writing
235 # inside it separately.
236
237 # This is because it's simpler than trying to find out the
238 # parent path of the directory, which would need to be the
239 # real path and not a symlink for things to work (so we can't
240 # just remove the last path element in the string)
241
242 debug-print "$FUNCNAME: checkout mode. creating cvs directory"
243 addwrite /foobar
244 addwrite /
245 $run mkdir -p "/$ECVS_TOP_DIR"
246 export SANDBOX_WRITE="${SANDBOX_WRITE//:\/foobar:\/}"
247 fi
248
249 # In case ECVS_TOP_DIR is a symlink to a dir, get the real path,
250 # otherwise addwrite() doesn't work.
251
252 cd -P "$ECVS_TOP_DIR" > /dev/null
253 ECVS_TOP_DIR="`/bin/pwd`"
254
255 # Disable the sandbox for this dir
256 addwrite "$ECVS_TOP_DIR"
257
258 # Chown the directory and all of its contents
259 if [ -n "$ECVS_RUNAS" ]; then
260 $run chown -R "$ECVS_RUNAS" "/$ECVS_TOP_DIR"
261 fi
262
263 # Determine the CVS command mode (checkout or update)
264 if [ ! -d "$ECVS_TOP_DIR/$ECVS_LOCALNAME/CVS" ]; then
265 mode=checkout
266 else
267 mode=update
268 fi
269
270
271 # Our server string (i.e. CVSROOT) without the password so it can
272 # be put in Root
273 local server=":${ECVS_AUTH}:${ECVS_USER}@${ECVS_SERVER}"
274
275 # Switch servers automagically if needed
276 if [ "$mode" == "update" ]; then
277 cd /$ECVS_TOP_DIR/$ECVS_LOCALNAME
278 local oldserver="`$run cat CVS/Root`"
279 if [ "$server" != "$oldserver" ]; then
280
281 einfo "Changing the CVS server from $oldserver to $server:"
282 debug-print "$FUNCNAME: Changing the CVS server from $oldserver to $server:"
283
284 einfo "Searching for CVS directories..."
285 local cvsdirs="`$run find . -iname CVS -print`"
286 debug-print "$FUNCNAME: CVS directories found:"
287 debug-print "$cvsdirs"
288
289 einfo "Modifying CVS directories..."
290 for x in $cvsdirs; do
291 debug-print "In $x"
292 $run echo "$server" > "$x/Root"
293 done
294
295 fi
296 fi
297
298 # Prepare a cvspass file just for this session, we don't want to
299 # mess with ~/.cvspass
300 touch "${T}/cvspass"
301 export CVS_PASSFILE="${T}/cvspass"
302 if [ -n "$ECVS_RUNAS" ]; then
303 chown "$ECVS_RUNAS" "${T}/cvspass"
304 fi
305
306 # The server string with the password in it, for login
307 cvsroot_pass=":${ECVS_AUTH}:${ECVS_USER}:${ECVS_PASS}@${ECVS_SERVER}"
308
309 # Ditto without the password, for checkout/update after login, so
310 # that the CVS/Root files don't contain the password in plaintext
311 cvsroot_nopass=":${ECVS_AUTH}:${ECVS_USER}@${ECVS_SERVER}"
312
313 # Commands to run
314 cmdlogin="${run} ${ECVS_CVS_COMMAND} -d \"${cvsroot_pass}\" login"
315 cmdupdate="${run} ${ECVS_CVS_COMMAND} -d \"${cvsroot_nopass}\" update ${ECVS_UP_OPTS} ${ECVS_LOCALNAME}"
316 cmdcheckout="${run} ${ECVS_CVS_COMMAND} -d \"${cvsroot_nopass}\" checkout ${ECVS_CO_OPTS} ${ECVS_MODULE}"
317
318 # Execute commands
319
320 cd "${ECVS_TOP_DIR}"
321 if [ "${ECVS_AUTH}" == "pserver" ]; then
322 einfo "Running $cmdlogin"
323 eval $cmdlogin || die "cvs login command failed"
324 if [ "${mode}" == "update" ]; then
325 einfo "Running $cmdupdate"
326 eval $cmdupdate || die "cvs update command failed"
327 elif [ "${mode}" == "checkout" ]; then
328 einfo "Running $cmdcheckout"
329 eval $cmdcheckout|| die "cvs checkout command failed"
330 fi
331 elif [ "${ECVS_AUTH}" == "ext" ]; then
332
333 # Hack to support SSH password authentication
334
335 # Backup environment variable values
336 local CVS_ECLASS_ORIG_CVS_RSH="${CVS_RSH}"
337
338 if [ "${SSH_ASKPASS+set}" == "set" ]; then
339 local CVS_ECLASS_ORIG_SSH_ASKPASS="${SSH_ASKPASS}"
340 else
341 unset CVS_ECLASS_ORIG_SSH_ASKPASS
342 fi
343
344 if [ "${DISPLAY+set}" == "set" ]; then
345 local CVS_ECLASS_ORIG_DISPLAY="${DISPLAY}"
346 else
347 unset CVS_ECLASS_ORIG_DISPLAY
348 fi
349
350 if [ "${CVS_RSH}" == "ssh" ]; then
351
352 # Force SSH to use SSH_ASKPASS by creating python wrapper
353
354 export CVS_RSH="${T}/cvs_sshwrapper"
355 cat > "${CVS_RSH}"<<EOF
356 #!/usr/bin/python
357 import fcntl
358 import os
359 import sys
360 try:
361 fd = os.open('/dev/tty', 2)
362 TIOCNOTTY=0x5422
363 try:
364 fcntl.ioctl(fd, TIOCNOTTY)
365 except:
366 pass
367 os.close(fd)
368 except:
369 pass
370 newarglist = sys.argv[:]
371 EOF
372
373 # Handle SSH host key checking
374
375 local CVS_ECLASS_KNOWN_HOSTS="${T}/cvs_ssh_known_hosts"
376 echo "newarglist.insert(1, '-oUserKnownHostsFile=${CVS_ECLASS_KNOWN_HOSTS}')" \
377 >> "${CVS_RSH}"
378
379 if [ -z "${ECVS_SSH_HOST_KEY}" ]; then
380 ewarn "Warning: The SSH host key of the remote server will not be verified."
381 einfo "A temporary known hosts list will be used."
382 local CVS_ECLASS_STRICT_HOST_CHECKING="no"
383 touch "${CVS_ECLASS_KNOWN_HOSTS}"
384 echo "newarglist.insert(1, '-oStrictHostKeyChecking=no')" \
385 >> "${CVS_RSH}"
386 else
387 local CVS_ECLASS_STRICT_HOST_CHECKING="yes"
388 echo "${ECVS_SSH_HOST_KEY}" > "${CVS_ECLASS_KNOWN_HOSTS}"
389 fi
390
391 echo -n "newarglist.insert(1, '-oStrictHostKeyChecking=" \
392 >> "${CVS_RSH}"
393 echo "${CVS_ECLASS_STRICT_HOST_CHECKING}')" \
394 >> "${CVS_RSH}"
395 echo "os.execv('/usr/bin/ssh', newarglist)" \
396 >> "${CVS_RSH}"
397
398 chmod a+x "${CVS_RSH}"
399
400 # Make sure DISPLAY is set (SSH will not use SSH_ASKPASS
401 # if DISPLAY is not set)
402
403 [ -z "${DISPLAY}" ] && DISPLAY="DISPLAY"
404 export DISPLAY
405
406 # Create a dummy executable to echo $ECVS_PASS
407
408 export SSH_ASKPASS="${T}/cvs_sshechopass"
409
410 echo -en "#!/bin/bash\necho \"$ECVS_PASS\"\n" \
411 > "${SSH_ASKPASS}"
412
413 chmod a+x "${SSH_ASKPASS}"
414 fi
415
416 if [ "${mode}" == "update" ]; then
417 einfo "Running $cmdupdate"
418 eval $cmdupdate || die "cvs update command failed"
419 elif [ "${mode}" == "checkout" ]; then
420 einfo "Running $cmdcheckout"
421 eval $cmdcheckout|| die "cvs checkout command failed"
422 fi
423
424 # Restore environment variable values
425 export CVS_RSH="${CVS_ECLASS_ORIG_CVS_RSH}"
426 if [ "${CVS_ECLASS_ORIG_SSH_ASKPASS+set}" == "set" ]; then
427 export SSH_ASKPASS="${CVS_ECLASS_ORIG_SSH_ASKPASS}"
428 else
429 unset SSH_ASKPASS
430 fi
431
432 if [ "${CVS_ECLASS_ORIG_DISPLAY+set}" == "set" ]; then
433 export DISPLAY="${CVS_ECLASS_ORIG_DISPLAY}"
434 else
435 unset DISPLAY
436 fi
437 fi
438
439 # Restore ownership. Not sure why this is needed, but someone
440 # added it in the orig ECVS_RUNAS stuff.
441 if [ -n "$ECVS_RUNAS" ]; then
442 chown `whoami` "${T}/cvspass"
443 fi
444
445 }
446
447
448 cvs_src_unpack() {
449
450 debug-print-function $FUNCNAME $*
451
452 debug-print "$FUNCNAME: init:
453 ECVS_CVS_COMMAND=$ECVS_CVS_COMMAND
454 ECVS_UP_OPTS=$ECVS_UP_OPTS
455 ECVS_CO_OPTS=$ECVS_CO_OPTS
456 ECVS_TOP_DIR=$ECVS_TOP_DIR
457 ECVS_SERVER=$ECVS_SERVER
458 ECVS_USER=$ECVS_USER
459 ECVS_PASS=$ECVS_PASS
460 ECVS_MODULE=$ECVS_MODULE
461 ECVS_LOCAL=$ECVS_LOCAL
462 ECVS_RUNAS=$ECVS_RUNAS
463 ECVS_LOCALNAME=$ECVS_LOCALNAME"
464
465 [ -z "$ECVS_MODULE" ] && die "ERROR: CVS module not set, cannot continue."
466
467 local ECVS_LOCALNAME="${ECVS_LOCALNAME}"
468
469 if [ -z "$ECVS_LOCALNAME" ]; then
470 ECVS_LOCALNAME="$ECVS_MODULE"
471 fi
472
473 if [ "$ECVS_SERVER" == "offline" ]; then
474 # We're not required to fetch anything; the module already
475 # exists and shouldn't be updated.
476 if [ -d "${ECVS_TOP_DIR}/${ECVS_LOCALNAME}" ]; then
477 debug-print "$FUNCNAME: offline mode"
478 else
479 debug-print "$FUNCNAME: Offline mode specified but directory ${ECVS_TOP_DIR}/${ECVS_LOCALNAME} not found, exiting with error"
480 die "ERROR: Offline mode specified, but directory ${ECVS_TOP_DIR}/${ECVS_LOCALNAME} not found. Aborting."
481 fi
482 elif [ -n "$ECVS_SERVER" ]; then # ECVS_SERVER!=offline --> real fetching mode
483 einfo "Fetching CVS module $ECVS_MODULE into $ECVS_TOP_DIR..."
484 cvs_fetch
485 else # ECVS_SERVER not set
486 die "ERROR: CVS server not specified, cannot continue."
487 fi
488
489 einfo "Copying $ECVS_MODULE from $ECVS_TOP_DIR..."
490 debug-print "Copying module $ECVS_MODULE local_mode=$ECVS_LOCAL from $ECVS_TOP_DIR..."
491
492 # This is probably redundant, but best to make sure.
493 mkdir -p "$WORKDIR/$ECVS_LOCALNAME"
494
495 if [ -n "$ECVS_LOCAL" ]; then
496 cp -f "$ECVS_TOP_DIR/$ECVS_LOCALNAME"/* "$WORKDIR/$ECVS_LOCALNAME"
497 else
498 cp -Rf "$ECVS_TOP_DIR/$ECVS_LOCALNAME" "$WORKDIR/$ECVS_LOCALNAME/.."
499 fi
500
501 # If the directory is empty, remove it; empty directories cannot
502 # exist in cvs. This happens when, for example, kde-source
503 # requests module/doc/subdir which doesn't exist. Still create
504 # the empty directory in workdir though.
505 if [ "`ls -A \"${ECVS_TOP_DIR}/${ECVS_LOCALNAME}\"`" == "CVS" ]; then
506 debug-print "$FUNCNAME: removing empty CVS directory $ECVS_LOCALNAME"
507 rm -rf "${ECVS_TOP_DIR}/${ECVS_LOCALNAME}"
508 fi
509
510 # Implement some of base_src_unpack's functionality; note however
511 # that base.eclass may not have been inherited!
512 if [ -n "$PATCHES" ]; then
513 debug-print "$FUNCNAME: PATCHES=$PATCHES, S=$S, autopatching"
514 cd "$S"
515 for x in $PATCHES; do
516 debug-print "patching from $x"
517 patch -p0 < "$x"
518 done
519 # Make sure we don't try to apply patches more than once,
520 # since cvs_src_unpack is usually called several times from
521 # e.g. kde-source_src_unpack
522 export PATCHES=""
523 fi
524
525 einfo "CVS module ${ECVS_MODULE} is now in ${WORKDIR}"
526 }
527
528 EXPORT_FUNCTIONS src_unpack

  ViewVC Help
Powered by ViewVC 1.1.20