gentoo-x86/eclass/cvs.eclass

# Copyright 1999-2006 Gentoo Foundation
# Distributed under the terms of the GNU General Public License v2
# $Header: /var/cvsroot/gentoo-x86/eclass/cvs.eclass,v 1.65 2006/10/14 20:27:21 swegener Exp $
#
# Maintainer: vapier@gentoo.org (and anyone who wants to help)

inherit eutils

# This eclass provides the generic cvs fetching functions.  To use
# this from an ebuild, set the `ebuild-configurable settings' as
# specified 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?)

# Support additional remote shells with `ext' authentication (does
# anyone actually need to use it with anything other than SSH?)


# Users shouldn't change these settings!  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

# ECVS_CVS_COMMAND -- CVS command to run
#
# You can set, for example, "cvs -t" for extensive debug information
# on the cvs connection.  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"


# ECVS_UP_OPTS, ECVS_CO_OPTS -- 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=""


# ECVS_LOCAL -- If this is set, the CVS module will be fetched
# non-recursively.  Refer to the information in the CVS man page
# regarding the -l command option (not the -l global option).


# ECVS_LOCALNAME -- local name of checkout directory
#
# This is 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: Set this only from within ebuilds!  If set in your shell or
# some such, things will break because the ebuild won't expect it and
# have e.g. a wrong $S setting.


# ECVS_TOP_DIR -- The directory under which CVS modules are checked
# out.

[ -z "$ECVS_TOP_DIR" ] && ECVS_TOP_DIR="${PORTAGE_ACTUAL_DISTDIR-${DISTDIR}}/cvs-src"

# ECVS_SERVER -- CVS path
#
# The format is "server:/dir", e.g. "anoncvs.kde.org:/home/kde".
# Remove the other parts of the full CVSROOT, which might look like
# ":pserver:anonymous@anoncvs.kde.org:/home/kde"; this is generated
# using other settings also.
#
# Set this to "offline" to disable fetching (i.e. to assume the module
# is already checked out in ECVS_TOP_DIR).

[ -z "$ECVS_SERVER" ] && ECVS_SERVER="offline"


# ECVS_MODULE -- the name of the CVS module to be fetched
#
# This must be set when cvs_src_unpack is called.  This can include
# several directory levels, i.e. "foo/bar/baz"

#[ -z "$ECVS_MODULE" ] && die "$ECLASS: error: ECVS_MODULE not set, cannot continue"


# ECVS_BRANCH -- the name of the branch/tag to use

# The default is "HEAD".  The following default _will_ reset your
# branch checkout to head if used.

#[ -z "$ECVS_BRANCH" ] && ECVS_BRANCH="HEAD"


# ECVS_AUTH -- authentication method to use
#
# Possible values are "pserver" and "ext".  If `ext' authentication is
# used, the remote shell to use can be specified in CVS_RSH (SSH is
# used by default).  Currently, the only supported remote shell for
# `ext' authentication is SSH.
#
# Armando Di Cianno <fafhrd@gentoo.org> 2004/09/27
# - Added "no" as a server type, which uses no AUTH method, nor
#    does it login
#  e.g.
#   "cvs -danoncvs@savannah.gnu.org:/cvsroot/backbone co System"
#   ( from gnustep-apps/textedit )
[ -z "$ECVS_AUTH" ] && ECVS_AUTH="pserver"

# ECVS_USER -- Username to use for authentication on the remote server
[ -z "$ECVS_USER" ] && ECVS_USER="anonymous"

# ECVS_PASS -- Password to use for authentication on the remote server
[ -z "$ECVS_PASS" ] && ECVS_PASS=""


# ECVS_SSH_HOST_KEY
#
# If SSH is used for `ext' authentication, use this variable to
# specify the host key of the remote server.  The format of the value
# should be the same format that is used for the SSH known hosts file.
#
# WARNING: If a SSH host key is not specified using this variable, the
# remote host key will not be verified.


# ECVS_CLEAN -- Set this to get a clean copy when updating (passes the
# -C option to cvs update)


# ECVS_RUNAS
#
# Specifies an alternate (non-root) user to use to run cvs.  Currently
# b0rked and wouldn't work with portage userpriv anyway without
# special magic.

# [ -z "$ECVS_RUNAS" ] && ECVS_RUNAS="`whoami`"


# ECVS_SUBDIR -- deprecated, do not use
[ -n "$ECVS_SUBDIR" ] && die "ERROR: deprecated ECVS_SUBDIR defined. Please fix this ebuild."


# --- end ebuild-configurable settings ---

# add cvs to deps
# ssh is used for ext auth
# sudo is used to run as a specified user
DEPEND="dev-util/cvs"

[ -n "$ECVS_RUNAS" ] && DEPEND="$DEPEND app-admin/sudo"

if [ "$ECVS_AUTH" == "ext" ]; then
        #default to ssh
        [ -z "$CVS_RSH" ] && export CVS_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

# called from cvs_src_unpack
cvs_fetch() {

        # Make these options local variables so that the global values are
        # not affected by modifications in this function.

        local ECVS_COMMAND="${ECVS_COMMAND}"
        local ECVS_UP_OPTS="${ECVS_UP_OPTS}"
        local ECVS_CO_OPTS="${ECVS_CO_OPTS}"

        # Fix for sourceforge which doesnt want -z>3 anymore.

        (echo $ECVS_SERVER | grep -q sourceforge) \
                && [ "$ECVS_CVS_COMMAND" == "cvs -q -f -z4" ] \
                && ECVS_CVS_COMMAND="cvs -q -f -z3"

        debug-print-function $FUNCNAME $*

        # Update variables that are modified by ebuild parameters, which
        # should be effective every time cvs_fetch is called, and not just
        # every time cvs.eclass is inherited

        # Handle 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

        # Handle ECVS_BRANCH option
        #
        # Because CVS auto-switches branches, we just have to pass the
        # correct -rBRANCH option when updating.

        if [ -n "$ECVS_BRANCH" ]; then
                ECVS_UP_OPTS="$ECVS_UP_OPTS -r$ECVS_BRANCH"
                ECVS_CO_OPTS="$ECVS_CO_OPTS -r$ECVS_BRANCH"
        fi

        # Handle ECVS_LOCALNAME, which specifies the local directory name
        # to use.  Note that the -d command option is not equivalent to
        # the global -d option.

        if [ "$ECVS_LOCALNAME" != "$ECVS_MODULE" ]; then
                ECVS_CO_OPTS="$ECVS_CO_OPTS -d $ECVS_LOCALNAME"
        fi


        if [ -n "$ECVS_CLEAN" ]; then
                ECVS_UP_OPTS="$ECVS_UP_OPTS -C"
        fi


        # It would be easiest to always be in "run-as mode", logic-wise,
        # 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 allow writing
                # inside it separately.

                # 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 path,
        # otherwise addwrite() doesn't work.

        cd -P "$ECVS_TOP_DIR" > /dev/null
        ECVS_TOP_DIR="`/bin/pwd`"

        # Disable the sandbox for this dir
        addwrite "$ECVS_TOP_DIR"

        # Chown the directory and all of its contents
        if [ -n "$ECVS_RUNAS" ]; then
                $run chown -R "$ECVS_RUNAS" "/$ECVS_TOP_DIR"
        fi

        # Determine the CVS command mode (checkout or update)
        if [ ! -d "$ECVS_TOP_DIR/$ECVS_LOCALNAME/CVS" ]; then
                mode=checkout
        else
                mode=update
        fi


        # Our server string (i.e. CVSROOT) without the password so it can
        # be put in Root
        if [ "$ECVS_AUTH" == "no" ]
        then
                local server="${ECVS_USER}@${ECVS_SERVER}"
        else
                local connection="${ECVS_AUTH}"
                [[ -n ${ECVS_PROXY} ]] && connection="${connection};proxy=${ECVS_PROXY}"
                [[ -n ${ECVS_PROXY_PORT} ]] && connection="${connection};proxyport=${ECVS_PROXY_PORT}"
                local server=":${connection}:${ECVS_USER}@${ECVS_SERVER}"
        fi

        # Switch servers automagically if needed
        if [ "$mode" == "update" ]; then
                cd /$ECVS_TOP_DIR/$ECVS_LOCALNAME
                local oldserver="`$run cat CVS/Root`"
                if [ "$server" != "$oldserver" ]; then

                        einfo "Changing the CVS server from $oldserver to $server:"
                        debug-print "$FUNCNAME: Changing the CVS server from $oldserver to $server:"

                        einfo "Searching for CVS directories ..."
                        local cvsdirs="`$run find . -iname CVS -print`"
                        debug-print "$FUNCNAME: CVS directories found:"
                        debug-print "$cvsdirs"

                        einfo "Modifying CVS directories ..."
                        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
        if [ "$ECVS_AUTH" == "no" ]
        then
                cvsroot_nopass="${ECVS_USER}@${ECVS_SERVER}"
        else
                cvsroot_nopass=":${ECVS_AUTH}:${ECVS_USER}@${ECVS_SERVER}"
        fi

        # 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}"

        # Execute commands

        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" ] || [ "${ECVS_AUTH}" == "no" ]; then

                # Hack to support SSH password authentication

                # Backup environment variable values
                local CVS_ECLASS_ORIG_CVS_RSH="${CVS_RSH}"

                if [ "${SSH_ASKPASS+set}" == "set" ]; then
                        local CVS_ECLASS_ORIG_SSH_ASKPASS="${SSH_ASKPASS}"
                else
                        unset CVS_ECLASS_ORIG_SSH_ASKPASS
                fi

                if [ "${DISPLAY+set}" == "set" ]; then
                        local CVS_ECLASS_ORIG_DISPLAY="${DISPLAY}"
                else
                        unset CVS_ECLASS_ORIG_DISPLAY
                fi

                if [ "${CVS_RSH}" == "ssh" ]; then

                        # Force SSH to use SSH_ASKPASS by creating python wrapper

                        export CVS_RSH="${T}/cvs_sshwrapper"
                        cat > "${CVS_RSH}"<<EOF
#!/usr/bin/python
import fcntl
import os
import sys
try:
        fd = os.open('/dev/tty', 2)
        TIOCNOTTY=0x5422
        try:
                fcntl.ioctl(fd, TIOCNOTTY)
        except:
                pass
        os.close(fd)
except:
        pass
newarglist = sys.argv[:]
EOF

                        # disable X11 forwarding which causes .xauth access violations
                        # - 20041205 Armando Di Cianno <fafhrd@gentoo.org>
                        echo "newarglist.insert(1, '-oClearAllForwardings=yes')" \
                                >> "${CVS_RSH}"
                        echo "newarglist.insert(1, '-oForwardX11=no')" \
                                >> "${CVS_RSH}"

                        # Handle SSH host key checking

                        local CVS_ECLASS_KNOWN_HOSTS="${T}/cvs_ssh_known_hosts"
                        echo "newarglist.insert(1, '-oUserKnownHostsFile=${CVS_ECLASS_KNOWN_HOSTS}')" \
                                >> "${CVS_RSH}"

                        if [ -z "${ECVS_SSH_HOST_KEY}" ]; then
                                ewarn "Warning: The SSH host key of the remote server will not be verified."
                                einfo "A temporary known hosts list will be used."
                                local CVS_ECLASS_STRICT_HOST_CHECKING="no"
                                touch "${CVS_ECLASS_KNOWN_HOSTS}"
                        else
                                local CVS_ECLASS_STRICT_HOST_CHECKING="yes"
                                echo "${ECVS_SSH_HOST_KEY}" > "${CVS_ECLASS_KNOWN_HOSTS}"
                        fi

                        echo -n "newarglist.insert(1, '-oStrictHostKeyChecking=" \
                                >> "${CVS_RSH}"
                        echo "${CVS_ECLASS_STRICT_HOST_CHECKING}')" \
                                >> "${CVS_RSH}"
                        echo "os.execv('/usr/bin/ssh', newarglist)" \
                                >> "${CVS_RSH}"

                        chmod a+x "${CVS_RSH}"

                        # Make sure DISPLAY is set (SSH will not use SSH_ASKPASS
                        # if DISPLAY is not set)

                        [ -z "${DISPLAY}" ] && DISPLAY="DISPLAY"
                        export DISPLAY

                        # Create a dummy executable to echo $ECVS_PASS

                        export SSH_ASKPASS="${T}/cvs_sshechopass"
                        if [ "${ECVS_AUTH}" != "no" ]; then
                                echo -en "#!/bin/bash\necho \"$ECVS_PASS\"\n" \
                                        > "${SSH_ASKPASS}"
                        else
                                echo -en "#!/bin/bash\nreturn\n" \
                                        > "${SSH_ASKPASS}"

                        fi
                        chmod a+x "${SSH_ASKPASS}"
                fi

                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

                # Restore environment variable values
                export CVS_RSH="${CVS_ECLASS_ORIG_CVS_RSH}"
                if [ "${CVS_ECLASS_ORIG_SSH_ASKPASS+set}" == "set" ]; then
                        export SSH_ASKPASS="${CVS_ECLASS_ORIG_SSH_ASKPASS}"
                else
                        unset SSH_ASKPASS
                fi

                if [ "${CVS_ECLASS_ORIG_DISPLAY+set}" == "set" ]; then
                        export DISPLAY="${CVS_ECLASS_ORIG_DISPLAY}"
                else
                        unset DISPLAY
                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."

        local ECVS_LOCALNAME="${ECVS_LOCALNAME}"

        if [ -z "$ECVS_LOCALNAME" ]; then
                ECVS_LOCALNAME="$ECVS_MODULE"
        fi

        local offline_pkg_var="ECVS_OFFLINE_${PN}"
        if [ "${!offline_pkg_var}" == "1" -o "$ECVS_OFFLINE" == "1" -o "$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 directory ${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 specified, 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 ..."

        # This is 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, for example, 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 empty CVS 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"
                epatch ${PATCHES}
                # 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

        einfo "CVS module ${ECVS_MODULE} is now in ${WORKDIR}"
}

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