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

Contents of /eclass/cvs.eclass

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.1.1.1 - (show annotations) (download) (vendor branch)
Wed Nov 30 09:59:33 2005 UTC (8 years, 10 months ago) by chriswhite
Changes since 1.1: +501 -110 lines
*** empty log message ***

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

  ViewVC Help
Powered by ViewVC 1.1.20