# Copyright 1999-2003 Gentoo Technologies, Inc. # Distributed under the terms of the GNU General Public License v2 # $Header: /var/cvsroot/gentoo-x86/eclass/cvs.eclass,v 1.49 2003/09/28 17:24:18 coredumb Exp $ # # Current Maintainer: Tal Peer <coredumb@gentoo.org> # Original Author: Dan Armak <danarmak@gentoo.org> # # SSH auth code by Danny <danny.milo@gmx.net> # # This eclass provides the generic cvs fetching functions. # to use from an ebuild, set the 'ebuild-configurable settings' below in your ebuild before inheriting. # then either leave the default src_unpack or extend over cvs_src_unpack. # if you find that you need to call the cvs_* functions directly, i'd be interested to hear about it. # TODO: # Implement more auth types (gserver?, kserver?) # Implement more 'ext' auth methods (do anyone actually use it with anything other than ssh?) # Add support for password-based ssh (only keys supported now) ECLASS=cvs INHERITED="$INHERITED $ECLASS" # You shouldn't change these settings yourself! The ebuild/eclass inheriting this eclass # will take care of that. If you want to set the global KDE cvs ebuilds' settings, # see the comments in kde-source.eclass. # --- begin ebuild-configurable settings # cvs command to run. you can set fex. "cvs -t" for extensive debug information # on the cvs onnection. the default of "cvs -q -f -z4" means to be quiet, to disregard # the ~/.cvsrc config file and to use maximum compression. [ -z "$ECVS_CVS_COMMAND" ] && ECVS_CVS_COMMAND="cvs -q -f -z4" # cvs options given after the cvs command (update or checkout) # don't remove -dP from update or things won't work [ -z "$ECVS_UP_OPTS" ] && ECVS_UP_OPTS="-dP" [ -z "$ECVS_CO_OPTS" ] && ECVS_CO_OPTS="" # set this to some value for the module/subdir to be fetched non-recursively: ECVS_LOCAL # local name of module. useful if the module on the server is called # something common like 'driver' or is nested deep in a tree, and you don't # like useless empty directories. # WARNING: to be set only from within ebuilds! if set in your shell or some such, # things wil break because the ebuild won't expect it and have e.g. a wrong $S setting. # ECVS_LOCALNAME # Where the cvs modules are stored/accessed [ -z "$ECVS_TOP_DIR" ] && ECVS_TOP_DIR="${DISTDIR}/cvs-src" # Name of cvs server, set to "offline" to disable fetching # (i.e. to assume module is checked out already and don't update it). # Format is server:/dir e.g. "anoncvs.kde.org:/home/kde". remove the other # parts of the full CVSROOT (which looks like # ":pserver:anonymous@anoncvs.kde.org:/home/kde"); these are added from # other settings # the special value 'offline' disables fetching, assumes sources are alread in ECVS_TOP_DIR [ -z "$ECVS_SERVER" ] && ECVS_SERVER="offline" # Authentication method to use - possible values are "pserver" and "ext" # Currently, only method for 'ext' is ssh, please note that it doesn't # work with passwords, only with keys. [ -z "$ECVS_AUTH" ] && ECVS_AUTH="pserver" # Use su to run cvs as user # Currently b0rked and wouldn't work with portage userpriv anyway without special magic # [ -z "$ECVS_RUNAS" ] && ECVS_RUNAS="`whoami`" # Username to give to the server [ -z "$ECVS_USER" ] && ECVS_USER="anonymous" # Password to use [ -z "$ECVS_PASS" ] && ECVS_PASS="" # Module to be fetched, must be set when kde_src_unpack is called # can include several directory levels, ie foo/bar/baz #[ -z "$ECVS_MODULE" ] && die "$ECLASS: error: ECVS_MODULE not set, cannot continue" # Branch/tag to use, default is HEAD # the following default _will_ reset your branch checkout to head if used #[ -z "$ECVS_BRANCH" ] && ECVS_BRANCH="HEAD" # deprecated - do not use [ -n "$ECVS_SUBDIR" ] && die "ERROR: deprecated ECVS_SUBDIR defined. Please fix this ebuild." # ECVS_CLEAN: set this to something to get a clean copy when updating (passes the -C option to cvs update) # --- end ebuild-configurable settings --- # add cvs to deps # ssh is used for ext auth # sudo is used to run as a specified user DEPEND="$DEPEND dev-util/cvs app-admin/sudo" if [ "$ECVS_AUTH" == "ext" ]; then #default to ssh [ -z "$CVS_RSH" ] && export SSH_RSH="ssh" if [ "$CVS_RSH" != "ssh" ]; then die "Support for ext auth with clients other than ssh has not been implemented yet" fi DEPEND="$DEPEND net-misc/openssh" fi # calls cvs_contorl, is called from cvs_src_unpack cvs_fetch() { # fix for sourceforge which doesnt want -z>3 anymore. (echo $ECVS_SERVER | grep sourceforge) && [ "$ECVS_CVS_COMMAND" == "cvs -q -f -z4" ] && ECVS_CVS_COMMAND="cvs -q -f -z3" debug-print-function $FUNCNAME $* # parameters modifying other parameters that should be effective every time cvs_fetch is called, # and not just every time cvs.eclas is inherited # 1. parameter for local (non-recursive) fetching if [ -n "$ECVS_LOCAL" ]; then ECVS_UP_OPTS="$ECVS_UP_OPTS -l" ECVS_CO_OPTS="$ECVS_CO_OPTS -l" fi # 2. cvs auto-switches branches, we just have to pass the correct -rBRANCH option to it when updating. # doing it this way we get multiple -rX options - harmless afaik if [ -n "$ECVS_BRANCH" ]; then ECVS_UP_OPTS="$ECVS_UP_OPTS -r$ECVS_BRANCH" ECVS_CO_OPTS="$ECVS_CO_OPTS -r$ECVS_BRANCH" fi if [ "$ECVS_LOCALNAME" != "$ECVS_MODULE" ]; then # the option to cvs on which this is based. note this isn't the same as the # global -d option to cvs, which specifies the cvs server. ugh @ cvs syntax. ECVS_CO_OPTS="$ECVS_CO_OPTS -d $ECVS_LOCALNAME" fi if [ -n "$ECVS_CLEAN" ]; then ECVS_UP_OPTS="$ECVS_UP_OPTS -C" fi # it's easiest to always be in "run-as mode", logic-wise # or would be if sudo didn't ask for a password even when sudo'ing to `whoami` if [ -z "$ECVS_RUNAS" ]; then run="" else run="sudo -u $ECVS_RUNAS" fi # create the top dir if needed if [ ! -d "$ECVS_TOP_DIR" ]; then # note that the addwrite statements in this block are only there to allow creating ECVS_TOP_DIR; # we've already allowed writing inside it # this is because it's simpler than trying to find out the parent path of the directory, which # would need to be the real path and not a symlink for things to work (so we can't just remove # the last path element in the string) debug-print "$FUNCNAME: checkout mode. creating cvs directory" addwrite /foobar addwrite / $run mkdir -p "/$ECVS_TOP_DIR" export SANDBOX_WRITE="${SANDBOX_WRITE//:\/foobar:\/}" fi # in case ECVS_TOP_DIR is a symlink to a dir, get the real dir's path, # otherwise addwrite() doesn't work. cd -P "$ECVS_TOP_DIR" > /dev/null ECVS_TOP_DIR="`/bin/pwd`" # determine checkout or update mode if [ ! -d "$ECVS_TOP_DIR/$ECVS_LOCALNAME/CVS" ]; then mode=checkout else mode=update fi # disable the sandbox for this dir addwrite "$ECVS_TOP_DIR" # chowning the directory and all contents if [ -n "$ECVS_RUNAS" ]; then $run chown -R "$ECVS_RUNAS" "/$ECVS_TOP_DIR" fi # our server string (aka CVSROOT), without the password so it can be put in Root server=":${ECVS_AUTH}:${ECVS_USER}@${ECVS_SERVER}" # switch servers automagically if needed if [ "$mode" == "update" ]; then cd /$ECVS_TOP_DIR/$ECVS_LOCALNAME oldserver="`$run cat CVS/Root`" if [ "$server" != "$oldserver" ]; then einfo "Changing CVS server from $oldserver to $server:" debug-print "$FUNCNAME: Changing CVS server from $oldserver to $server:" einfo "Searching for CVS dirs..." cvsdirs="`$run find . -iname CVS -print`" debug-print "$FUNCNAME: CVS dirs found:" debug-print "$cvsdirs" einfo "Modifying CVS dirs..." for x in $cvsdirs; do debug-print "In $x" $run echo "$server" > "$x/Root" done fi fi # prepare a cvspass file just for this session, we don't want to mess with ~/.cvspass touch "${T}/cvspass" export CVS_PASSFILE="${T}/cvspass" if [ -n "$ECVS_RUNAS" ]; then chown "$ECVS_RUNAS" "${T}/cvspass" fi # the server string with the password in it, for login cvsroot_pass=":${ECVS_AUTH}:${ECVS_USER}:${ECVS_PASS}@${ECVS_SERVER}" # ditto without the password, for checkout/update after login, so that # the CVS/Root files don't contain the password in plaintext cvsroot_nopass=":${ECVS_AUTH}:${ECVS_USER}@${ECVS_SERVER}" # commands to run cmdlogin="${run} ${ECVS_CVS_COMMAND} -d \"${cvsroot_pass}\" login" cmdupdate="${run} ${ECVS_CVS_COMMAND} -d \"${cvsroot_nopass}\" update ${ECVS_UP_OPTS} ${ECVS_LOCALNAME}" cmdcheckout="${run} ${ECVS_CVS_COMMAND} -d \"${cvsroot_nopass}\" checkout ${ECVS_CO_OPTS} ${ECVS_MODULE}" cd "${ECVS_TOP_DIR}" if [ "${ECVS_AUTH}" == "pserver" ]; then einfo "Running $cmdlogin" eval $cmdlogin || die "cvs login command failed" if [ "${mode}" == "update" ]; then einfo "Running $cmdupdate" eval $cmdupdate || die "cvs update command failed" elif [ "${mode}" == "checkout" ]; then einfo "Running $cmdcheckout" eval $cmdcheckout|| die "cvs checkout command failed" fi elif [ "${ECVS_AUTH}" == "ext" ]; then #no login needed for ext if [ "${mode}" == "update" ]; then einfo "Running $cmdupdate" eval $cmdupdate || die "cvs update command failed" elif [ "${mode}" == "checkout" ]; then einfo "Running $cmdcheckout" eval $cmdcheckout|| die "cvs checkout command failed" fi fi # restore ownership. not sure why this is needed, but someone added it in the orig ECVS_RUNAS stuff. if [ -n "$ECVS_RUNAS" ]; then chown `whoami` "${T}/cvspass" fi } cvs_src_unpack() { debug-print-function $FUNCNAME $* debug-print "$FUNCNAME: init: ECVS_CVS_COMMAND=$ECVS_CVS_COMMAND ECVS_UP_OPTS=$ECVS_UP_OPTS ECVS_CO_OPTS=$ECVS_CO_OPTS ECVS_TOP_DIR=$ECVS_TOP_DIR ECVS_SERVER=$ECVS_SERVER ECVS_USER=$ECVS_USER ECVS_PASS=$ECVS_PASS ECVS_MODULE=$ECVS_MODULE ECVS_LOCAL=$ECVS_LOCAL ECVS_RUNAS=$ECVS_RUNAS ECVS_LOCALNAME=$ECVS_LOCALNAME" [ -z "$ECVS_MODULE" ] && die "ERROR: CVS module not set, cannot continue." # merely setting this default value makes things fail when cvs_src_unpack is called # more than once per ebuild (eg kdenonbeta submodules); so if we set a default value, # we disable it again at the function's end. # of course, we could instead always reference it with the bash syntax for 'take default # value from this other variable if undefined', but i'm lazy. if [ -z "$ECVS_LOCALNAME" ]; then ECVS_LOCALNAME="$ECVS_MODULE" ECVS_LOCALNAME_SETDEFAULT=true fi if [ "$ECVS_SERVER" == "offline" ]; then # we're not required to fetch anything, the module already exists and shouldn't be updated if [ -d "${ECVS_TOP_DIR}/${ECVS_LOCALNAME}" ]; then debug-print "$FUNCNAME: offline mode" else debug-print "$FUNCNAME: offline mode specified but directory ${ECVS_TOP_DIR}/${ECVS_LOCALNAME} not found, exiting with error" die "ERROR: Offline mode specified, but dir ${ECVS_TOP_DIR}/${ECVS_LOCALNAME} not found. Aborting." fi elif [ -n "$ECVS_SERVER" ]; then # ECVS_SERVER!=offline --> real fetching mode einfo "Fetching cvs module $ECVS_MODULE into $ECVS_TOP_DIR..." cvs_fetch else # ECVS_SERVER not set die "ERROR: CVS server not set, cannot continue." fi einfo "Copying $ECVS_MODULE from $ECVS_TOP_DIR..." debug-print "Copying module $ECVS_MODULE local_mode=$ECVS_LOCAL from $ECVS_TOP_DIR..." # probably redundant, but best to make sure mkdir -p "$WORKDIR/$ECVS_LOCALNAME" if [ -n "$ECVS_LOCAL" ]; then cp -f "$ECVS_TOP_DIR/$ECVS_LOCALNAME"/* "$WORKDIR/$ECVS_LOCALNAME" else cp -Rf "$ECVS_TOP_DIR/$ECVS_LOCALNAME" "$WORKDIR/$ECVS_LOCALNAME/.." fi # if the directory is empty, remove it; empty directories cannot exist in cvs. # this happens when fex. kde-source requests module/doc/subdir which doesn't exist. # still create the empty directory in workdir though. if [ "`ls -A \"${ECVS_TOP_DIR}/${ECVS_LOCALNAME}\"`" == "CVS" ]; then debug-print "$FUNCNAME: removing cvs-empty directory $ECVS_LOCALNAME" rm -rf "${ECVS_TOP_DIR}/${ECVS_LOCALNAME}" fi # implement some of base_src_unpack's functionality; # note however that base.eclass may not have been inherited! if [ -n "$PATCHES" ]; then debug-print "$FUNCNAME: PATCHES=$PATCHES, S=$S, autopatching" cd "$S" for x in $PATCHES; do debug-print "patching from $x" patch -p0 < "$x" done # make sure we don't try to apply patches more than once, since # cvs_src_unpack is usually called several times from e.g. kde-source_src_unpack export PATCHES="" fi if [ -n "$ECVS_LOCALNAME_SETDEFAULT" ]; then unset ECVS_LOCALNAME unset ECVS_LOCALNAME_SETDEFAULT fi einfo "Module ${ECVS_MODULE} is now in ${WORKDIR}" } EXPORT_FUNCTIONS src_unpack