magic-wormhole/src/wormhole/cli/cmd_send.py

from __future__ import print_function
import os, sys, json, binascii, six, tempfile, zipfile
from tqdm import tqdm
from twisted.protocols import basic
from twisted.internet import reactor
from twisted.internet.defer import inlineCallbacks, returnValue
from ..errors import TransferError
from ..wormhole import wormhole
from ..transit import TransitSender

APPID = u"lothar.com/wormhole/text-or-file-xfer"

@inlineCallbacks
def send(args, reactor=reactor):
    """I implement 'wormhole send'. I return a Deferred that fires with None
    (for success), or signals one of the following errors:
    * WrongPasswordError: the two sides didn't use matching passwords
    * Timeout: something didn't happen fast enough for our tastes
    * TransferError: the receiver rejected the transfer: verifier mismatch,
                     permission not granted, ack not successful.
    * any other error: something unexpected happened
    """
    assert isinstance(args.relay_url, type(u""))

    tor_manager = None
    if args.tor:
        with args.timing.add("import", which="tor_manager"):
            from ..tor_manager import TorManager
        tor_manager = TorManager(reactor, timing=args.timing)
        # For now, block everything until Tor has started. Soon: launch tor
        # in parallel with everything else, make sure the TorManager can
        # lazy-provide an endpoint, and overlap the startup process with the
        # user handing off the wormhole code
        yield tor_manager.start()

    w = wormhole(APPID, args.relay_url, reactor, tor_manager,
                 timing=args.timing)
    d = _send(reactor, w, args, tor_manager)
    d.addBoth(w.close)
    yield d

@inlineCallbacks
def _send(reactor, w, args, tor_manager):
    # TODO: run the blocking zip-the-directory IO in a thread, let the
    # wormhole exchange happen in parallel
    offer, fd_to_send = build_offer(args)

    other_cmd = "wormhole receive"
    if args.verify:
        other_cmd = "wormhole --verify receive"
    if args.zeromode:
        assert not args.code
        args.code = u"0-"
        other_cmd += " -0"

    print(u"On the other computer, please run: %s" % other_cmd,
          file=args.stdout)

    transit_sender = None
    if fd_to_send:
        transit_sender = TransitSender(args.transit_helper,
                                       no_listen=args.no_listen,
                                       tor_manager=tor_manager,
                                       reactor=reactor,
                                       timing=args.timing)
        offer["transit"] = transit_data = {}
        transit_data["relay_connection_hints"] = transit_sender.get_relay_hints()
        direct_hints = yield transit_sender.get_direct_hints()
        transit_data["direct_connection_hints"] = direct_hints

    if args.code:
        w.set_code(args.code)
        code = args.code
    else:
        code = yield w.get_code(args.code_length)

    if not args.zeromode:
        print(u"Wormhole code is: %s" % code, file=args.stdout)
    print(u"", file=args.stdout)

    # get the verifier, because that also lets us derive the transit key,
    # which we want to set before revealing the connection hints to the far
    # side, so we'll be ready for them when they connect
    verifier_bytes = yield w.verify()
    verifier = binascii.hexlify(verifier_bytes).decode("ascii")

    if args.verify:
        while True:
            ok = six.moves.input("Verifier %s. ok? (yes/no): " % verifier)
            if ok.lower() == "yes":
                break
            if ok.lower() == "no":
                err = "sender rejected verification check, abandoned transfer"
                reject_data = json.dumps({"error": err}).encode("utf-8")
                w.send(reject_data)
                raise TransferError(err)
    if fd_to_send is not None:
        transit_key = w.derive_key(APPID+"/transit-key",
                                   transit_sender.TRANSIT_KEY_LENGTH)
        transit_sender.set_transit_key(transit_key)

    my_offer_bytes = json.dumps(offer).encode("utf-8")
    w.send(my_offer_bytes)

    # this may raise WrongPasswordError
    them_answer_bytes = yield w.get()

    them_answer = json.loads(them_answer_bytes.decode("utf-8"))

    if fd_to_send is None:
        if them_answer["message_ack"] == "ok":
            print(u"text message sent", file=args.stdout)
            returnValue(None) # terminates this function
        raise TransferError("error sending text: %r" % (them_answer,))

    if "error" in them_answer:
        raise TransferError("remote error, transfer abandoned: %s"
                            % them_answer["error"])
    if them_answer.get("file_ack") != "ok":
        raise TransferError("ambiguous response from remote, "
                            "transfer abandoned: %s" % (them_answer,))
    tdata = them_answer["transit"]
    # XXX the downside of closing above, rather than here, is that it leaves
    # the channel claimed for a longer time
    #yield w.close()
    yield _send_file_twisted(tdata, transit_sender, fd_to_send,
                             args.stdout, args.hide_progress, args.timing)
    returnValue(None)

def build_offer(args):
    offer = {}

    text = args.text
    if text == "-":
        print(u"Reading text message from stdin..", file=args.stdout)
        text = sys.stdin.read()
    if not text and not args.what:
        text = six.moves.input("Text to send: ")

    if text is not None:
        print(u"Sending text message (%d bytes)" % len(text), file=args.stdout)
        offer = { "message": text }
        fd_to_send = None
        return offer, fd_to_send

    what = os.path.join(args.cwd, args.what)
    what = what.rstrip(os.sep)
    if not os.path.exists(what):
        raise TransferError("Cannot send: no file/directory named '%s'" %
                            args.what)
    basename = os.path.basename(what)

    if os.path.isfile(what):
        # we're sending a file
        filesize = os.stat(what).st_size
        offer["file"] = {
            "filename": basename,
            "filesize": filesize,
            }
        print(u"Sending %d byte file named '%s'" % (filesize, basename),
              file=args.stdout)
        fd_to_send = open(what, "rb")
        return offer, fd_to_send

    if os.path.isdir(what):
        print(u"Building zipfile..", file=args.stdout)
        # We're sending a directory. Create a zipfile in a tempdir and
        # send that.
        fd_to_send = tempfile.SpooledTemporaryFile()
        # TODO: I think ZIP_DEFLATED means compressed.. check it
        num_files = 0
        num_bytes = 0
        tostrip = len(what.split(os.sep))
        with zipfile.ZipFile(fd_to_send, "w", zipfile.ZIP_DEFLATED) as zf:
            for path,dirs,files in os.walk(what):
                # path always starts with args.what, then sometimes might
                # have "/subdir" appended. We want the zipfile to contain
                # "" or "subdir"
                localpath = list(path.split(os.sep)[tostrip:])
                for fn in files:
                    archivename = os.path.join(*tuple(localpath+[fn]))
                    localfilename = os.path.join(path, fn)
                    zf.write(localfilename, archivename)
                    num_bytes += os.stat(localfilename).st_size
                    num_files += 1
        fd_to_send.seek(0,2)
        filesize = fd_to_send.tell()
        fd_to_send.seek(0,0)
        offer["directory"] = {
            "mode": "zipfile/deflated",
            "dirname": basename,
            "zipsize": filesize,
            "numbytes": num_bytes,
            "numfiles": num_files,
            }
        print(u"Sending directory (%d bytes compressed) named '%s'"
              % (filesize, basename), file=args.stdout)
        return offer, fd_to_send

    raise TypeError("'%s' is neither file nor directory" % args.what)

@inlineCallbacks
def _send_file_twisted(tdata, transit_sender, fd_to_send,
                       stdout, hide_progress, timing):
    transit_sender.add_their_direct_hints(tdata["direct_connection_hints"])
    transit_sender.add_their_relay_hints(tdata["relay_connection_hints"])

    fd_to_send.seek(0,2)
    filesize = fd_to_send.tell()
    fd_to_send.seek(0,0)

    record_pipe = yield transit_sender.connect()
    timing.add("transit connected")
    # record_pipe should implement IConsumer, chunks are just records
    print(u"Sending (%s).." % record_pipe.describe(), file=stdout)

    progress = tqdm(file=stdout, disable=hide_progress,
                    unit="B", unit_scale=True,
                    total=filesize)
    def _count(data):
        progress.update(len(data))
        return data
    fs = basic.FileSender()

    with timing.add("tx file"):
        with progress:
            yield fs.beginFileTransfer(fd_to_send, record_pipe,
                                       transform=_count)

    print(u"File sent.. waiting for confirmation", file=stdout)
    with timing.add("get ack") as t:
        ack = yield record_pipe.receive_record()
        record_pipe.close()
        if ack != b"ok\n":
            t.detail(ack="failed")
            raise TransferError("Transfer failed (remote says: %r)" % ack)
        print(u"Confirmation received. Transfer complete.", file=stdout)
        t.detail(ack="ok")