slixmpp/examples/http_upload.py

#!/usr/bin/env python3

# Slixmpp: The Slick XMPP Library
# Copyright (C) 2018 Emmanuel Gil Peyrot
# This file is part of Slixmpp.
# See the file LICENSE for copying permission.

import logging
from getpass import getpass
from argparse import ArgumentParser

import slixmpp
from slixmpp.exceptions import IqTimeout

log = logging.getLogger(__name__)


class HttpUpload(slixmpp.ClientXMPP):

    """
    A basic client asking an entity if they confirm the access to an HTTP URL.
    """

    def __init__(self, jid, password, recipient, filename, domain=None):
        slixmpp.ClientXMPP.__init__(self, jid, password)

        self.recipient = recipient
        self.filename = filename
        self.domain = domain

        self.add_event_handler("session_start", self.start)

    async def start(self, event):
        log.info('Uploading file %s...', self.filename)
        try:
            url = await self['xep_0363'].upload_file(
                self.filename, domain=self.domain, timeout=10
            )
        except IqTimeout:
            raise TimeoutError('Could not send message in time')
        log.info('Upload success!')

        log.info('Sending file to %s', self.recipient)
        html = (
            f'<body xmlns="http://www.w3.org/1999/xhtml">'
            f'<a href="{url}">{url}</a></body>'
        )
        message = self.make_message(mto=self.recipient, mbody=url, mhtml=html)
        message['oob']['url'] = url
        message.send()
        self.disconnect()


if __name__ == '__main__':
    # Setup the command line arguments.
    parser = ArgumentParser()
    parser.add_argument("-q","--quiet", help="set logging to ERROR",
                        action="store_const",
                        dest="loglevel",
                        const=logging.ERROR,
                        default=logging.INFO)
    parser.add_argument("-d","--debug", help="set logging to DEBUG",
                        action="store_const",
                        dest="loglevel",
                        const=logging.DEBUG,
                        default=logging.INFO)

    # JID and password options.
    parser.add_argument("-j", "--jid", dest="jid",
                        help="JID to use")
    parser.add_argument("-p", "--password", dest="password",
                        help="password to use")

    # Other options.
    parser.add_argument("-r", "--recipient", required=True,
                        help="Recipient JID")
    parser.add_argument("-f", "--file", required=True,
                        help="File to send")
    parser.add_argument("--domain",
                        help="Domain to use for HTTP File Upload (leave out for your own server’s)")

    args = parser.parse_args()

    # Setup logging.
    logging.basicConfig(level=args.loglevel,
                        format='%(levelname)-8s %(message)s')

    if args.jid is None:
        args.jid = input("Username: ")
    if args.password is None:
        args.password = getpass("Password: ")

    xmpp = HttpUpload(args.jid, args.password, args.recipient, args.file, args.domain)
    xmpp.register_plugin('xep_0066')
    xmpp.register_plugin('xep_0071')
    xmpp.register_plugin('xep_0128')
    xmpp.register_plugin('xep_0363')

    # Connect to the XMPP server and start processing XMPP stanzas.
    xmpp.connect()
    xmpp.process(forever=False)
-												Add an HTTP File Upload example.

											
										
										
											2018-03-08 02:39:23 +00:00
+								#!/usr/bin/env python3
-												examples: rewrite copyright notices

											
										
										
											2021-02-05 19:51:15 +00:00
+								# Slixmpp: The Slick XMPP Library
 								# Copyright (C) 2018 Emmanuel Gil Peyrot
 								# This file is part of Slixmpp.
 								# See the file LICENSE for copying permission.
-												Add an HTTP File Upload example.

											
										
										
											2018-03-08 02:39:23 +00:00
 								import logging
 								from getpass import getpass
 								from argparse import ArgumentParser
 								import slixmpp
-												examples: add oob to httpupload example

many people ask how to do this, might as well do this by default

											
										
										
											2021-02-24 19:43:21 +00:00
+								from slixmpp.exceptions import IqTimeout
-												Add an HTTP File Upload example.

											
										
										
											2018-03-08 02:39:23 +00:00
 								log = logging.getLogger(__name__)
 								class HttpUpload(slixmpp.ClientXMPP):
 								    """
 								    A basic client asking an entity if they confirm the access to an HTTP URL.
 								    """
-												examples: Add the possibility to use another HTTP File Upload domain.

											
										
										
											2018-10-27 21:25:59 +00:00
+								    def __init__(self, jid, password, recipient, filename, domain=None):
-												Add an HTTP File Upload example.

											
										
										
											2018-03-08 02:39:23 +00:00
+								        slixmpp.ClientXMPP.__init__(self, jid, password)
 								        self.recipient = recipient
-												Simplify usage of HTTP File Upload plugin.

This makes it usable only on Python 3.5, as documented.

											
										
										
											2018-03-08 13:28:55 +00:00
+								        self.filename = filename
-												examples: Add the possibility to use another HTTP File Upload domain.

											
										
										
											2018-10-27 21:25:59 +00:00
+								        self.domain = domain
-												Add an HTTP File Upload example.

											
										
										
											2018-03-08 02:39:23 +00:00
 								        self.add_event_handler("session_start", self.start)
-												examples, tests: Replace all @asyncio.coroutines with proper async functions.

											
										
										
											2018-08-19 16:47:26 +00:00
+								    async def start(self, event):
-												Simplify usage of HTTP File Upload plugin.

This makes it usable only on Python 3.5, as documented.

											
										
										
											2018-03-08 13:28:55 +00:00
+								        log.info('Uploading file %s...', self.filename)
-												examples: add oob to httpupload example

many people ask how to do this, might as well do this by default

											
										
										
											2021-02-24 19:43:21 +00:00
+								        try:
 								            url = await self['xep_0363'].upload_file(
 								                self.filename, domain=self.domain, timeout=10
 								            )
 								        except IqTimeout:
 								            raise TimeoutError('Could not send message in time')
-												Simplify usage of HTTP File Upload plugin.

This makes it usable only on Python 3.5, as documented.

											
										
										
											2018-03-08 13:28:55 +00:00
+								        log.info('Upload success!')
-												Add an HTTP File Upload example.

											
										
										
											2018-03-08 02:39:23 +00:00
 								        log.info('Sending file to %s', self.recipient)
-												examples: add oob to httpupload example

many people ask how to do this, might as well do this by default

											
										
										
											2021-02-24 19:43:21 +00:00
+								        html = (
 								            f'<body xmlns="http://www.w3.org/1999/xhtml">'
 								            f'<a href="{url}">{url}</a></body>'
 								        )
 								        message = self.make_message(mto=self.recipient, mbody=url, mhtml=html)
 								        message['oob']['url'] = url
 								        message.send()
-												Add an HTTP File Upload example.

											
										
										
											2018-03-08 02:39:23 +00:00
+								        self.disconnect()
 								if __name__ == '__main__':
 								    # Setup the command line arguments.
 								    parser = ArgumentParser()
 								    parser.add_argument("-q","--quiet", help="set logging to ERROR",
 								                        action="store_const",
 								                        dest="loglevel",
 								                        const=logging.ERROR,
 								                        default=logging.INFO)
 								    parser.add_argument("-d","--debug", help="set logging to DEBUG",
 								                        action="store_const",
 								                        dest="loglevel",
 								                        const=logging.DEBUG,
 								                        default=logging.INFO)
 								    # JID and password options.
 								    parser.add_argument("-j", "--jid", dest="jid",
 								                        help="JID to use")
 								    parser.add_argument("-p", "--password", dest="password",
 								                        help="password to use")
 								    # Other options.
 								    parser.add_argument("-r", "--recipient", required=True,
 								                        help="Recipient JID")
 								    parser.add_argument("-f", "--file", required=True,
 								                        help="File to send")
-												examples: Add the possibility to use another HTTP File Upload domain.

											
										
										
											2018-10-27 21:25:59 +00:00
+								    parser.add_argument("--domain",
 								                        help="Domain to use for HTTP File Upload (leave out for your own server’s)")
-												Add an HTTP File Upload example.

											
										
										
											2018-03-08 02:39:23 +00:00
 								    args = parser.parse_args()
 								    # Setup logging.
 								    logging.basicConfig(level=args.loglevel,
 								                        format='%(levelname)-8s %(message)s')
 								    if args.jid is None:
 								        args.jid = input("Username: ")
 								    if args.password is None:
 								        args.password = getpass("Password: ")
-												examples: Add the possibility to use another HTTP File Upload domain.

											
										
										
											2018-10-27 21:25:59 +00:00
+								    xmpp = HttpUpload(args.jid, args.password, args.recipient, args.file, args.domain)
-												examples: add oob to httpupload example

many people ask how to do this, might as well do this by default

											
										
										
											2021-02-24 19:43:21 +00:00
+								    xmpp.register_plugin('xep_0066')
-												Add an HTTP File Upload example.

											
										
										
											2018-03-08 02:39:23 +00:00
+								    xmpp.register_plugin('xep_0071')
-												Add max-file-size support to HTTP File Upload example.

											
										
										
											2018-03-08 11:11:26 +00:00
+								    xmpp.register_plugin('xep_0128')
-												Add an HTTP File Upload example.

											
										
										
											2018-03-08 02:39:23 +00:00
+								    xmpp.register_plugin('xep_0363')
 								    # Connect to the XMPP server and start processing XMPP stanzas.
 								    xmpp.connect()
 								    xmpp.process(forever=False)