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