LightBlue - a simple bluetooth library.
Performs a device discovery and returns the found devices as a list of
(address, name, class-of-device) tuples. Raises BluetoothError if an error
occurs.
Arguments:
- getnames=True: True if device names should be retrieved during
discovery. If false, None will be returned instead of the device
name.
- length=10: the number of seconds to spend discovering devices
(this argument has no effect on Python for Series 60)
Do not invoke a new discovery before a previous discovery has finished.
Also, to minimise interference with other wireless and bluetooth traffic,
and to conserve battery power on the local device, discoveries should not
be invoked too frequently (an interval of at least 20 seconds is
recommended).
Performs a service discovery and returns the found services as a list of
(device-address, service-port, service-name) tuples. Raises BluetoothError
if an error occurs.
Arguments:
- addr=None: a device address, to search only for services on a
specific device
- name=None: a service name string, to search only for a service with a
specific name
- servicetype=None: can be RFCOMM or OBEX to search only for RFCOMM or
OBEX-type services. (OBEX services are not returned from an RFCOMM
search)
If more than one criteria is specified, this returns services that match
all criteria.
Currently the Python for Series 60 implementation will only find RFCOMM and
OBEX services.
Returns the name of the device with the given bluetooth address.
finddevicename(gethostaddr()) returns the local device name.
Arguments:
- address: the address of the device to look up
- usecache=True: if True, the device name will be fetched from a local
cache if possible. If False, or if the device name is not in the
cache, the remote device will be contacted to request its name.
Raise BluetoothError if the name cannot be retrieved.
Displays a GUI which allows the end user to select a device from a list of
discovered devices.
Returns the selected device as an (address, name, class-of-device) tuple.
Returns None if the selection was cancelled.
(On Python For Series 60, the device selection will fail if there are any
open bluetooth connections.)
Displays a GUI which allows the end user to select a service from a list of
discovered devices and their services.
Returns the selected service as a (device-address, service-port, service-
name) tuple. Returns None if the selection was cancelled.
(On Python For Series 60, the device selection will fail if there are any
open bluetooth connections.)
Currently the Python for Series 60 implementation will only find RFCOMM and
OBEX services.
Returns the address of the local bluetooth device.
Raise BluetoothError if the local device is not available.
Returns the class of device of the local bluetooth device.
These values indicate the device's major services and the type of the
device (e.g. mobile phone, laptop, etc.). If you google for
"assigned numbers bluetooth baseband" you might find some documents
that discuss how to extract this information from the class of device.
Raise BluetoothError if the local device is not available.
socket(proto=RFCOMM) -> socket object
Returns a new socket object.
Arguments:
- proto=RFCOMM: the type of socket to be created - either L2CAP or
RFCOMM.
Note that L2CAP sockets are not available on Python For Series 60, and
only L2CAP client sockets are supported on Mac OS X and Linux (i.e. you can
connect() the socket but not bind(), accept(), etc.).
Starts advertising a service with the given name, using the given server
socket. Raises BluetoothError if the service cannot be advertised.
Arguments:
- name: name of the service to be advertised
- sock: the socket object that will serve this service. The socket must
be already bound to a channel. If a RFCOMM service is being
advertised, the socket should also be listening.
- servicetype: the type of service to advertise - either RFCOMM or
OBEX. (L2CAP services are not currently supported.)
(If the servicetype is RFCOMM, the service will be advertised with the
Serial Port Profile; if the servicetype is OBEX, the service will be
advertised with the OBEX Object Push Profile.)
Stops advertising the service on the given socket. Raises BluetoothError if
no service is advertised on the socket.
This will error if the given socket is already closed.
Splits the given class of device to return a 3-item tuple with the
major service class, major device class and minor device class values.
These values indicate the device's major services and the type of the
device (e.g. mobile phone, laptop, etc.). If you google for
"assigned numbers bluetooth baseband" you might find some documents
that discuss how to extract this information from the class of device.
Example:
>>> splitclass(1057036)
(129, 1, 3)
>>>
Generic exception raised for Bluetooth errors. This is not raised for
socket-related errors; socket objects raise the socket.error and
socket.timeout exceptions from the standard library socket module.
Note that error codes are currently platform-independent. In particular,
the Mac OS X implementation returns IOReturn error values from the IOKit
framework, and OBEXError codes from <IOBluetooth/OBEX.h> for OBEX operations.
A Bluetooth socket object has the same interface as a socket object from
the Python standard library <socket> module. It also uses the same
exceptions, raising socket.error for general errors and socket.timeout for
timeout errors.
Note that L2CAP sockets are not available on Python For Series 60, and
only L2CAP client sockets are supported on Mac OS X and Linux.
A simple client socket example:
>>> from lightblue import *
>>> s = socket() # or socket(L2CAP) to create an L2CAP socket
>>> s.connect(("00:12:2c:45:8a:7b", 5))
>>> s.send("hello")
5
>>> s.close()
A simple server socket example:
>>> from lightblue import *
>>> s = socket()
>>> s.bind(("", 0))
>>> s.listen(1)
>>> advertise("My RFCOMM Service", s, RFCOMM)
>>> conn, addr = s.accept()
>>> print "Connected by", addr
Connected by ('00:0D:93:19:C8:68', 5)
>>> conn.recv(1024)
"hello"
>>> conn.close()
>>> s.close()
accept() -> (socket object, address info)
Wait for an incoming connection. Return a new socket representing the
connection, and the address of the client. For RFCOMM sockets, the address
info is a pair (hostaddr, channel).
The socket must be bound and listening before calling this method.
bind(address)
Bind the socket to a local address. For RFCOMM sockets, the address is a
pair (host, channel); the host must refer to the local host.
A port value of 0 binds the socket to a dynamically assigned port.
(Note that on Mac OS X, the port value must always be 0.)
The socket must not already be bound.
close()
Close the socket. It cannot be used after this call.
connect(address)
Connect the socket to a remote address. The address should be a
(host, channel) pair for RFCOMM sockets, and a (host, PSM) pair for L2CAP
sockets.
The socket must not be already connected.
connect_ex(address) -> errno
This is like connect(address), but returns an error code instead of raising
an exception when an error occurs.
dup() -> socket object
Returns a new socket object connected to the same system resource.
fileno() -> integer
Return the integer file descriptor of the socket.
Raises NotImplementedError on Mac OS X and Python For Series 60.
getpeername() -> address info
Return the address of the remote endpoint. The address info is a
(host, channel) pair for RFCOMM sockets, and a (host, PSM) pair for L2CAP
sockets.
If the socket has not been connected, socket.error will be raised.
getsockname() -> address info
Return the address of the local endpoint. The address info is a
(host, channel) pair for RFCOMM sockets, and a (host, PSM) pair for L2CAP
sockets.
If the socket has not been connected nor bound, this returns the tuple
("00:00:00:00:00:00", 0).
getsockopt(level, option[, bufsize]) -> value
Get a socket option. See the Unix manual for level and option.
If a nonzero buffersize argument is given, the return value is a
string of that length; otherwise it is an integer.
Currently support for socket options are platform independent -- i.e.
depends on the underlying Series 60 or BlueZ socket options support.
The Mac OS X implementation currently does not support any options at
all and automatically raises socket.error.
gettimeout() -> timeout
Returns the timeout in floating seconds associated with socket
operations. A timeout of None indicates that timeouts on socket
operations are disabled.
Currently not supported on Python For Series 60 implementation, which
will always return None.
listen(backlog)
Enable a server to accept connections. The backlog argument must be at
least 1; it specifies the number of unaccepted connection that the system
will allow before refusing new connections.
The socket must not be already listening.
Currently not implemented on Mac OS X.
makefile([mode[, bufsize]]) -> file object
Returns a regular file object corresponding to the socket. The mode
and bufsize arguments are as for the built-in open() function.
recv(bufsize[, flags]) -> data
Receive up to bufsize bytes from the socket. For the optional flags
argument, see the Unix manual. When no data is available, block until
at least one byte is available or until the remote end is closed. When
the remote end is closed and all data is read, return the empty string.
Currently the flags argument has no effect on Mac OS X.
recvfrom(bufsize[, flags]) -> (data, address info)
Like recv(buffersize, flags) but also return the sender's address info.
send(data[, flags]) -> count
Send a data string to the socket. For the optional flags
argument, see the Unix manual. Return the number of bytes
sent.
The socket must be connected to a remote socket.
Currently the flags argument has no effect on Mac OS X.
sendall(data[, flags])
Send a data string to the socket. For the optional flags
argument, see the Unix manual. This calls send() repeatedly
until all data is sent. If an error occurs, it's impossible
to tell how much data has been sent.
sendto(data[, flags], address) -> count
Like send(data, flags) but allows specifying the destination address.
For RFCOMM sockets, the address is a pair (hostaddr, channel).
setblocking(flag)
Set the socket to blocking (flag is true) or non-blocking (false).
setblocking(True) is equivalent to settimeout(None);
setblocking(False) is equivalent to settimeout(0.0).
Initially a socket is in blocking mode. In non-blocking mode, if a
socket operation cannot be performed immediately, socket.error is raised.
setsockopt(level, option, value)
Set a socket option. See the Unix manual for level and option.
The value argument can either be an integer or a string.
Currently support for socket options are platform independent -- i.e.
depends on the underlying Series 60 or BlueZ socket options support.
The Mac OS X implementation currently does not support any options at
all and automatically raise socket.error.
settimeout(timeout)
Set a timeout on socket operations. 'timeout' can be a float,
giving in seconds, or None. Setting a timeout of None disables
the timeout feature and is equivalent to setblocking(1).
Setting a timeout of zero is the same as setblocking(0).
If a timeout is set, the connect, accept, send and receive operations will
raise socket.timeout if a timeout occurs.
Raises NotImplementedError on Python For Series 60.
shutdown(how)
Shut down the reading side of the socket (flag == socket.SHUT_RD), the
writing side of the socket (flag == socket.SHUT_WR), or both ends
(flag == socket.SHUT_RDWR).
An OBEX client class. (Note this is not available on Python for Series 60.)
For example, to connect to an OBEX server and send a file:
>>> import lightblue
>>> client = lightblue.obex.OBEXClient("aa:bb:cc:dd:ee:ff", 10)
>>> client.connect()
<OBEXResponse reason='OK' code=0x20 (0xa0) headers={}>
>>> client.put({"name": "photo.jpg"}, file("photo.jpg", "rb"))
<OBEXResponse reason='OK' code=0x20 (0xa0) headers={}>
>>> client.disconnect()
<OBEXResponse reason='OK' code=0x20 (0xa0) headers={}>
>>>
A client must call connect() to establish a connection before it can send
any other requests.
The connect(), disconnect(), put(), delete(), get() and setpath() methods
all accept the request headers as a dictionary of header-value mappings. The
request headers are used to provide the server with additional information
for the request. For example, this sends a Put request that includes Name,
Type and Length headers in the request headers, to provide details about
the transferred file:
>>> f = file("file.txt")
>>> client.put({"name": "file.txt", "type": "text/plain",
... "length": 5192}, f)
>>>
Here is a list of all the different string header keys that you can use in
the request headers, and the expected type of the value for each header:
- "name" -> a string
- "type" -> a string
- "length" -> an int
- "time" -> a datetime object from the datetime module
- "description" -> a string
- "target" -> a string or buffer
- "http" -> a string or buffer
- "who" -> a string or buffer
- "connection-id" -> an int
- "application-parameters" -> a string or buffer
- "authentication-challenge" -> a string or buffer
- "authentication-response" -> a string or buffer
- "creator-id" -> an int
- "wan-uuid" -> a string or buffer
- "object-class" -> a string or buffer
- "session-parameters" -> a string or buffer
- "session-sequence-number" -> an int less than 256
(The string header keys are not case-sensitive.)
Alternatively, you can use raw header ID values instead of the above
convenience strings. So, the previous example can be rewritten as:
>>> client.put({0x01: "file.txt", 0x42: "text/plain", 0xC3: 5192},
... fileobject)
>>>
This is also useful for inserting custom headers. For example, a PutImage
request for a Basic Imaging client requires the Img-Descriptor (0x71)
header:
>>> client.put({"type": "x-bt/img-img",
... "name": "photo.jpg",
... 0x71: '<image-descriptor version="1.0"><image encoding="JPEG" pixel="160*120" size="37600"/></image-descriptor>'},
... file('photo.jpg', 'rb'))
>>>
Notice that the connection-id header is not sent, because this is
automatically included by OBEXClient in the request headers if a
connection-id was received in a previous Connect response.
See the included src/examples/obex_ftp_client.py for an example of using
OBEXClient to implement a File Transfer client for browsing the files on a
remote device.
Creates an OBEX client.
Arguments:
- address: the address of the remote device
- channel: the RFCOMM channel of the remote OBEX service
Establishes the Bluetooth connection to the remote OBEX server and sends
a Connect request to open the OBEX session. Returns an OBEXResponse
instance containing the server response.
Raises lightblue.obex.OBEXError if the session is already connected, or if
an error occurs during the request.
If the server refuses the Connect request (i.e. if it sends a response code
other than OK/Success), the Bluetooth connection will be closed.
Arguments:
- headers={}: the headers to send for the Connect request
Sends a Disconnect request to end the OBEX session and closes the Bluetooth
connection to the remote OBEX server. Returns an OBEXResponse
instance containing the server response.
Raises lightblue.obex.OBEXError if connect() has not been called, or if an
error occurs during the request.
Note that you don't need to send any connection-id headers - this is
automatically included if the client received one in a Connect response.
Arguments:
- headers={}: the headers to send for the request
Sends a Put request. Returns an OBEXResponse instance containing the
server response.
Raises lightblue.obex.OBEXError if connect() has not been called, or if an
error occurs during the request.
Note that you don't need to send any connection-id headers - this is
automatically included if the client received one in a Connect response.
Arguments:
- headers: the headers to send for the request
- fileobj: a file-like object containing the file data to be sent for
the request
For example, to send a file named 'photo.jpg', using the request headers
to notify the server of the file's name, MIME type and length:
>>> client = lightblue.obex.OBEXClient("aa:bb:cc:dd:ee:ff", 10)
>>> client.connect()
<OBEXResponse reason='OK' code=0x20 (0xa0) headers={}>
>>> client.put({"name": "photo.jpg", "type": "image/jpeg",
"length": 28566}, file("photo.jpg", "rb"))
<OBEXResponse reason='OK' code=0x20 (0xa0) headers={}>
>>>
Sends a Put-Delete request in order to delete a file or folder on the remote
server. Returns an OBEXResponse instance containing the server response.
Raises lightblue.obex.OBEXError if connect() has not been called, or if an
error occurs during the request.
Note that you don't need to send any connection-id headers - this is
automatically included if the client received one in a Connect response.
Arguments:
- headers: the headers to send for the request - you should use the
'name' header to specify the file you want to delete
If the file on the server can't be deleted because it's a read-only file,
you might get an 'Unauthorized' response, like this:
>>> client = lightblue.obex.OBEXClient("aa:bb:cc:dd:ee:ff", 10)
>>> client.connect()
<OBEXResponse reason='OK' code=0x20 (0xa0) headers={}>
>>> client.delete({"name": "random_file.txt"})
<OBEXResponse reason='Unauthorized' code=0x41 (0xc1) headers={}>
>>>
Sends a Get request. Returns an OBEXResponse instance containing the server
response.
Raises lightblue.obex.OBEXError if connect() has not been called, or if an
error occurs during the request.
Note that you don't need to send any connection-id headers - this is
automatically included if the client received one in a Connect response.
Arguments:
- headers: the headers to send for the request - you should use these
to specify the file you want to retrieve
- fileobj: a file-like object, to which the received data will be
written
An example:
>>> client.connect()
<OBEXResponse reason='OK' code=0x20 (0xa0) headers={}>
>>> f = file("received_file.txt", "w+")
>>> client.get({"name": "testfile.txt"}, f)
<OBEXResponse reason='OK' code=0x20 (0xa0) headers={'length':9}>
>>> f.seek(0)
>>> f.read()
'test file'
>>>
Sends a SetPath request in order to set the "current path" on the remote
server for file transfers. Returns an OBEXResponse instance containing the
server response.
Raises lightblue.obex.OBEXError if connect() has not been called, or if an
error occurs during the request.
Note that you don't need to send any connection-id headers - this is
automatically included if the client received one in a Connect response.
Arguments:
- headers: the headers to send for the request - you should use the
'name' header to specify the directory you want to change to
- cdtoparent=False: True if the remote server should move up one
directory before applying the specified directory (i.e. 'cd
../dirname')
- createdirs=False: True if the specified directory should be created
if it doesn't exist (if False, the server will return an error
response if the directory doesn't exist)
For example:
# change to the "images" subdirectory
>>> client.setpath({"name": "images"})
<OBEXResponse reason='OK' code=0x20 (0xa0) headers={}>
>>>
# change to the parent directory
>>> client.setpath({}, cdtoparent=True)
<OBEXResponse reason='OK' code=0x20 (0xa0) headers={}>
>>>
# make a directory "My_Files"
>>> client.setpath({"name": "My_Files"}, createdirs=True)
<OBEXResponse reason='OK' code=0x20 (0xa0) headers={}>
>>>
# change to the root directory - you can use an empty "name" header
# to specify this
>>> client.setpath({"name": ""})
<OBEXResponse reason='OK' code=0x20 (0xa0) headers={}>
>>>
Generic exception raised for OBEX-related errors.
Contains the OBEX response received from an OBEX server.
When an OBEX client sends a request, the OBEX server sends back a response
code (to indicate whether the request was successful) and a set of response
headers (to provide other useful information).
For example, if a client sends a 'Get' request to retrieve a file, the
client might get a response like this:
>>> import lightblue
>>> client = lightblue.obex.OBEXClient("aa:bb:cc:dd:ee:ff", 10)
>>> response = client.get({"name": "file.txt"}, file("file.txt", "w"))
>>> print response
<OBEXResponse reason='OK' code=0x20 (0xa0) headers={'length': 35288}>
You can get the response code and response headers in different formats:
>>> print response.reason
'OK' # a string description of the response code
>>> print response.code
32 # the response code
>>> print response.headers
{'length': 35288} # the headers, with string keys
>>> print response.rawheaders
{195: 35288} # the headers, with raw header ID keys
>>>
Note how the 'code' attribute does not have the final bit set - e.g. for
OK/Success, the response code is 0x20, not 0xA0.
The lightblue.obex module defines constants for response code values (e.g.
lightblue.obex.OK, lightblue.obex.FORBIDDEN, etc.).
The response code, without the final bit set.
The response headers, as a dictionary with string keys.
The response headers, as a dictionary with header ID (unsigned byte) keys.
A string description of the response code.
Provides an OBEX client class and convenience functions for sending and receiving files over OBEX. This module also defines constants for response code values (without the final bit set). For example:>>> import lightblue >>> lightblue.obex.OK 32 # the OK/Success response 0x20 (i.e. 0xA0 without the final bit) >>> lightblue.obex.FORBIDDEN 67 # the Forbidden response 0x43 (i.e. 0xC3 without the final bit)
Sends a file to a remote device.
Raises lightblue.obex.OBEXError if an error occurred during the request, or
if the request was refused by the remote device.
Arguments:
- address: the address of the remote device
- channel: the RFCOMM channel of the remote OBEX service
- source: a filename or file-like object, containing the data to be
sent. If a file object is given, it must be opened for reading.
Note you can achieve the same thing using OBEXClient with something like
this:
>>> import lightblue
>>> client = lightblue.obex.OBEXClient(address, channel)
>>> client.connect()
<OBEXResponse reason='OK' code=0x20 (0xa0) headers={}>
>>> putresponse = client.put({"name": "MyFile.txt"}, file("MyFile.txt", 'rb'))
>>> client.disconnect()
<OBEXResponse reason='OK' code=0x20 (0xa0) headers={}>
>>> if putresponse.code != lightblue.obex.OK:
... raise lightblue.obex.OBEXError("request denied")
>>>
Receives a file through an OBEX service.
Arguments:
- sock: the server socket on which the file is to be received. Note
this socket must *not* be listening. Also, an OBEX service should
have been advertised on this socket.
- dest: a filename or file-like object, to which the received data will
be written. If a filename is given, any existing file will be
overwritten. If a file object is given, it must be opened for writing.
For example, to receive a file and save it as "MyFile.txt":
>>> from lightblue import *
>>> s = socket()
>>> s.bind(("", 0))
>>> advertise("My OBEX Service", s, OBEX)
>>> obex.recvfile(s, "MyFile.txt")
error during process()s error while running servers -> process() timed outs -> got file!s -> server error detected...i ( s timeouts Falses selfs _OBEXObjectPushServer__gotfiles# _OBEXObjectPushServer__disconnecteds Nones _OBEXObjectPushServer__errors Trues _OBEXObjectPushServer__servers processs results IOErrors _OBEXObjectPushServer__busys excs msg( s selfs excs results timeouts msg( ( sE /Users/bea/bluetooth-api/lightblue/lightblue/trunk/src/linux/_obex.pys runÀ s< c C s† d G| G| G| G| GHt | _ | t i j o t i h | i f Sn> | t i t i f j o t i h t f Sn t i h t f Sd S( Ns -> newrequest( s opcodes reqheaderss nonheaderdatas hasbodys Trues selfs _OBEXObjectPushServer__busys _lightblueobexs PUTs SUCCESSs! _OBEXObjectPushServer__fileobjects CONNECTs DISCONNECTs Nones NOT_IMPLEMENTED( s selfs opcodes reqheaderss nonheaderdatas hasbody( ( sE /Users/bea/bluetooth-api/lightblue/lightblue/trunk/src/linux/_obex.pys newrequestã s c C sP d G| GH| t i j o t | _ n | t i j o t | _ n t | _ d S( Ns -> requestdone( s opcodes _lightblueobexs DISCONNECTs Trues selfs# _OBEXObjectPushServer__disconnecteds PUTs _OBEXObjectPushServer__gotfiles Falses _OBEXObjectPushServer__busy( s selfs opcode( ( sE /Users/bea/bluetooth-api/lightblue/lightblue/trunk/src/linux/_obex.pys requestdoneî s c C s= d G| G| GH| i t j o d GHd Sn | | f | _ d S( Ns -> error:s -> (keeping previous error)( s excs msgs selfs _OBEXObjectPushServer__errors None( s selfs excs msg( ( sE /Users/bea/bluetooth-api/lightblue/lightblue/trunk/src/linux/_obex.pys errorö s ( s __name__s __module__s __init__s runs newrequests requestdones error( ( ( sE /Users/bea/bluetooth-api/lightblue/lightblue/trunk/src/linux/_obex.pys OBEXObjectPushServer· s # c C sÞ | t j o t d ƒ ‚ n t | t i t i f ƒ o t d ƒ ‚ n t | t i ƒ o t | d ƒ } t } n | } t } z? | i ƒ \ } } t | i ƒ | ƒ } | i ƒ | i ƒ Wd | o | i ƒ n Xd S( Ns Given socket is Nones; dest must be string or file-like object with write() methods wb( s socks Nones TypeErrors isinstances dests typess StringTypess FileTypes opens fileobjs Trues closefileobjs Falses accepts conns addrs OBEXObjectPushServers filenos servers runs close( s socks dests addrs closefileobjs servers conns fileobj( ( sE /Users/bea/bluetooth-api/lightblue/lightblue/trunk/src/linux/_obex.pys recvfile s" ( s typess _lightbluecommons _lightblueobexs __all__s objects OBEXClients sendfiles OBEXObjectPushServers recvfile( s sendfiles recvfiles _lightblueobexs OBEXObjectPushServers __all__s _lightbluecommons typess OBEXClient( ( sE /Users/bea/bluetooth-api/lightblue/lightblue/trunk/src/linux/_obex.pys ? s z K lightblue-0.3.2/src/linux/.__obexcommon.py 0000755 0000765 0000000 00000000122 10750556342 020367 0 ustar bea wheel 0000000 0000000 Mac OS X 2 R TEXT lightblue-0.3.2/src/linux/_obexcommon.py 0000755 0000765 0000765 00000044343 10750556342 017634 0 ustar bea bea 0000000 0000000 # Copyright (c) 2006 Bea Lam. All rights reserved. # # Permission is hereby granted, free of charge, to any person # obtaining a copy of this software and associated documentation files # (the "Software"), to deal in the Software without restriction, # including without limitation the rights to use, copy, modify, merge, # publish, distribute, sublicense, and/or sell copies of the Software, # and to permit persons to whom the Software is furnished to do so, # subject to the following conditions: # # The above copyright notice and this permission notice shall be # included in all copies or substantial portions of the Software. # # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, # EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF # MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. # IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY # CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, # TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE # SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. import _lightbluecommon __all__ = ('OBEXResponse', 'OBEXError', 'CONTINUE', 'OK', 'CREATED', 'ACCEPTED', 'NON_AUTHORITATIVE_INFORMATION', 'NO_CONTENT', 'RESET_CONTENT', 'PARTIAL_CONTENT', 'MULTIPLE_CHOICES', 'MOVED_PERMANENTLY', 'MOVED_TEMPORARILY', 'SEE_OTHER', 'NOT_MODIFIED', 'USE_PROXY', 'BAD_REQUEST', 'UNAUTHORIZED', 'PAYMENT_REQUIRED', 'FORBIDDEN', 'NOT_FOUND', 'METHOD_NOT_ALLOWED', 'NOT_ACCEPTABLE', 'PROXY_AUTHENTICATION_REQUIRED', 'REQUEST_TIME_OUT', 'CONFLICT', 'GONE', 'LENGTH_REQUIRED', 'PRECONDITION_FAILED', 'REQUESTED_ENTITY_TOO_LARGE', 'REQUEST_URL_TOO_LARGE', 'UNSUPPORTED_MEDIA_TYPE', 'INTERNAL_SERVER_ERROR', 'NOT_IMPLEMENTED', 'BAD_GATEWAY', 'SERVICE_UNAVAILABLE', 'GATEWAY_TIMEOUT', 'HTTP_VERSION_NOT_SUPPORTED', 'DATABASE_FULL', 'DATABASE_LOCKED') class OBEXError(_lightbluecommon.BluetoothError): """ Generic exception raised for OBEX-related errors. """ pass class OBEXResponse: """ Contains the OBEX response received from an OBEX server. When an OBEX client sends a request, the OBEX server sends back a response code (to indicate whether the request was successful) and a set of response headers (to provide other useful information). For example, if a client sends a 'Get' request to retrieve a file, the client might get a response like this: >>> import lightblue >>> client = lightblue.obex.OBEXClient("aa:bb:cc:dd:ee:ff", 10) >>> response = client.get({"name": "file.txt"}, file("file.txt", "w")) >>> print responseYou can get the response code and response headers in different formats: >>> print response.reason 'OK' # a string description of the response code >>> print response.code 32 # the response code (e.g. this is 0x20) >>> print response.headers {'length': 35288} # the headers, with string keys >>> print response.rawheaders {195: 35288} # the headers, with raw header ID keys >>> Note how the 'code' attribute does not have the final bit set - e.g. for OK/Success, the response code is 0x20, not 0xA0. The lightblue.obex module defines constants for response code values (e.g. lightblue.obex.OK, lightblue.obex.FORBIDDEN, etc.). """ def __init__(self, code, rawheaders): self.__code = code self.__reason = _OBEX_RESPONSES.get(code, "Unknown response code") self.__rawheaders = rawheaders self.__headers = None code = property(lambda self: self.__code, doc='The response code, without the final bit set.') reason = property(lambda self: self.__reason, doc='A string description of the response code.') rawheaders = property(lambda self: self.__rawheaders, doc='The response headers, as a dictionary with header ID (unsigned byte) keys.') def getheader(self, header, default=None): ''' Returns the response header value for the given header, which may either be a string (not case-sensitive) or the raw byte value of the header ID. Returns the specified default value if the header is not present. ''' if isinstance(header, types.StringTypes): return self.headers.get(header.lower(), default) return self.__rawheaders.get(header, default) def __getheaders(self): if self.__headers is None: self.__headers = {} for headerid, value in self.__rawheaders.items(): if headerid in _HEADER_IDS_TO_STRINGS: self.__headers[_HEADER_IDS_TO_STRINGS[headerid]] = value else: self.__headers["0x%02x" % headerid] = value return self.__headers headers = property(__getheaders, doc='The response headers, as a dictionary with string keys.') def __repr__(self): return " " % \ (self.__reason, self.__code, (self.__code | 0x80), str(self.headers)) try: import datetime # as from python docs example class UTC(datetime.tzinfo): """UTC""" def utcoffset(self, dt): return datetime.timedelta(0) def tzname(self, dt): return "UTC" def dst(self, dt): return datetime.timedelta(0) except: pass # no datetime on pys60 _LOCAL_TIME_FORMAT = "%Y%m%dT%H%M%S" _UTC_TIME_FORMAT = _LOCAL_TIME_FORMAT + "Z" def _datetimefromstring(s): import time if s[-1:] == "Z": # add UTC() instance as tzinfo args = (time.strptime(s, _UTC_TIME_FORMAT)[0:6]) + (0, UTC()) return datetime.datetime(*args) else: return datetime.datetime(*(time.strptime(s, _LOCAL_TIME_FORMAT)[0:6])) _HEADER_STRINGS_TO_IDS = { "count": 0xc0, "name": 0x01, "type": 0x42, "length": 0xc3, "time": 0x44, "description": 0x05, "target": 0x46, "http": 0x47, "who": 0x4a, "connection-id": 0xcb, "application-parameters": 0x4c, "authentication-challenge": 0x4d, "authentication-response": 0x4e, "creator-id": 0xcf, "wan-uuid": 0x50, "object-class": 0x51, "session-parameters": 0x52, "session-sequence-number": 0x93 } _HEADER_IDS_TO_STRINGS = {} for key, value in _HEADER_STRINGS_TO_IDS.items(): _HEADER_IDS_TO_STRINGS[value] = key assert len(_HEADER_IDS_TO_STRINGS) == len(_HEADER_STRINGS_TO_IDS) # These match the associated strings in httplib.responses, since OBEX response # codes are matched to HTTP status codes (except for 0x60 and 0x61). # Note these are the responses *without* the final bit set. _OBEX_RESPONSES = { 0x10: "Continue", 0x20: "OK", 0x21: "Created", 0x22: "Accepted", 0x23: "Non-Authoritative Information", 0x24: "No Content", 0x25: "Reset Content", 0x26: "Partial Content", 0x30: "Multiple Choices", 0x31: "Moved Permanently", 0x32: "Moved Temporarily", # but is 'Found' (302) in httplib.response??? 0x33: "See Other", 0x34: "Not Modified", 0x35: "Use Proxy", 0x40: "Bad Request", 0x41: "Unauthorized", 0x42: "Payment Required", 0x43: "Forbidden", 0x44: "Not Found", 0x45: "Method Not Allowed", 0x46: "Not Acceptable", 0x47: "Proxy Authentication Required", 0x48: "Request Timeout", 0x49: "Conflict", 0x4A: "Gone", 0x48: "Length Required", 0x4C: "Precondition Failed", 0x4D: "Request Entity Too Large", 0x4E: "Request-URI Too Long", 0x4F: "Unsupported Media Type", 0x50: "Internal Server Error", 0x51: "Not Implemented", 0x52: "Bad Gateway", 0x53: "Service Unavailable", 0x54: "Gateway Timeout", 0x55: "HTTP Version Not Supported", 0x60: "Database Full", 0x61: "Database Locked" } _obexclientclassdoc = \ """ An OBEX client class. (Note this is not available on Python for Series 60.) For example, to connect to an OBEX server and send a file: >>> import lightblue >>> client = lightblue.obex.OBEXClient("aa:bb:cc:dd:ee:ff", 10) >>> client.connect() >>> client.put({"name": "photo.jpg"}, file("photo.jpg", "rb")) >>> client.disconnect() >>> A client must call connect() to establish a connection before it can send any other requests. The connect(), disconnect(), put(), delete(), get() and setpath() methods all accept the request headers as a dictionary of header-value mappings. The request headers are used to provide the server with additional information for the request. For example, this sends a Put request that includes Name, Type and Length headers in the request headers, to provide details about the transferred file: >>> f = file("file.txt") >>> client.put({"name": "file.txt", "type": "text/plain", ... "length": 5192}, f) >>> Here is a list of all the different string header keys that you can use in the request headers, and the expected type of the value for each header: - "name" -> a string - "type" -> a string - "length" -> an int - "time" -> a datetime object from the datetime module - "description" -> a string - "target" -> a string or buffer - "http" -> a string or buffer - "who" -> a string or buffer - "connection-id" -> an int - "application-parameters" -> a string or buffer - "authentication-challenge" -> a string or buffer - "authentication-response" -> a string or buffer - "creator-id" -> an int - "wan-uuid" -> a string or buffer - "object-class" -> a string or buffer - "session-parameters" -> a string or buffer - "session-sequence-number" -> an int less than 256 (The string header keys are not case-sensitive.) Alternatively, you can use raw header ID values instead of the above convenience strings. So, the previous example can be rewritten as: >>> client.put({0x01: "file.txt", 0x42: "text/plain", 0xC3: 5192}, ... fileobject) >>> This is also useful for inserting custom headers. For example, a PutImage request for a Basic Imaging client requires the Img-Descriptor (0x71) header: >>> client.put({"type": "x-bt/img-img", ... "name": "photo.jpg", ... 0x71: ' '}, ... file('photo.jpg', 'rb')) >>> Notice that the connection-id header is not sent, because this is automatically included by OBEXClient in the request headers if a connection-id was received in a previous Connect response. See the included src/examples/obex_ftp_client.py for an example of using OBEXClient to implement a File Transfer client for browsing the files on a remote device. """ _obexclientdocs = { "__init__": """ Creates an OBEX client. Arguments: - address: the address of the remote device - channel: the RFCOMM channel of the remote OBEX service """, "connect": """ Establishes the Bluetooth connection to the remote OBEX server and sends a Connect request to open the OBEX session. Returns an OBEXResponse instance containing the server response. Raises lightblue.obex.OBEXError if the session is already connected, or if an error occurs during the request. If the server refuses the Connect request (i.e. if it sends a response code other than OK/Success), the Bluetooth connection will be closed. Arguments: - headers={}: the headers to send for the Connect request """, "disconnect": """ Sends a Disconnect request to end the OBEX session and closes the Bluetooth connection to the remote OBEX server. Returns an OBEXResponse instance containing the server response. Raises lightblue.obex.OBEXError if connect() has not been called, or if an error occurs during the request. Note that you don't need to send any connection-id headers - this is automatically included if the client received one in a Connect response. Arguments: - headers={}: the headers to send for the request """, "put": """ Sends a Put request. Returns an OBEXResponse instance containing the server response. Raises lightblue.obex.OBEXError if connect() has not been called, or if an error occurs during the request. Note that you don't need to send any connection-id headers - this is automatically included if the client received one in a Connect response. Arguments: - headers: the headers to send for the request - fileobj: a file-like object containing the file data to be sent for the request For example, to send a file named 'photo.jpg', using the request headers to notify the server of the file's name, MIME type and length: >>> client = lightblue.obex.OBEXClient("aa:bb:cc:dd:ee:ff", 10) >>> client.connect() >>> client.put({"name": "photo.jpg", "type": "image/jpeg", "length": 28566}, file("photo.jpg", "rb")) >>> """, "delete": """ Sends a Put-Delete request in order to delete a file or folder on the remote server. Returns an OBEXResponse instance containing the server response. Raises lightblue.obex.OBEXError if connect() has not been called, or if an error occurs during the request. Note that you don't need to send any connection-id headers - this is automatically included if the client received one in a Connect response. Arguments: - headers: the headers to send for the request - you should use the 'name' header to specify the file you want to delete If the file on the server can't be deleted because it's a read-only file, you might get an 'Unauthorized' response, like this: >>> client = lightblue.obex.OBEXClient("aa:bb:cc:dd:ee:ff", 10) >>> client.connect() >>> client.delete({"name": "random_file.txt"}) >>> """, "get": """ Sends a Get request. Returns an OBEXResponse instance containing the server response. Raises lightblue.obex.OBEXError if connect() has not been called, or if an error occurs during the request. Note that you don't need to send any connection-id headers - this is automatically included if the client received one in a Connect response. Arguments: - headers: the headers to send for the request - you should use these to specify the file you want to retrieve - fileobj: a file-like object, to which the received data will be written An example: >>> client = lightblue.obex.OBEXClient("aa:bb:cc:dd:ee:ff", 10) >>> client.connect() >>> f = file("received_file.txt", "w+") >>> client.get({"name": "testfile.txt"}, f) >>> f.seek(0) >>> f.read() 'test file' >>> """, "setpath": """ Sends a SetPath request in order to set the "current path" on the remote server for file transfers. Returns an OBEXResponse instance containing the server response. Raises lightblue.obex.OBEXError if connect() has not been called, or if an error occurs during the request. Note that you don't need to send any connection-id headers - this is automatically included if the client received one in a Connect response. Arguments: - headers: the headers to send for the request - you should use the 'name' header to specify the directory you want to change to - cdtoparent=False: True if the remote server should move up one directory before applying the specified directory (i.e. 'cd ../dirname') - createdirs=False: True if the specified directory should be created if it doesn't exist (if False, the server will return an error response if the directory doesn't exist) For example: # change to the "images" subdirectory >>> client.setpath({"name": "images"}) >>> # change to the parent directory >>> client.setpath({}, cdtoparent=True) >>> # create a subdirectory "My_Files" >>> client.setpath({"name": "My_Files"}, createdirs=True) >>> # change to the root directory - you can use an empty "name" header # to specify this >>> client.setpath({"name": ""}) >>> """ } # response constants CONTINUE = 0x10 OK = 0x20 CREATED = 0x21 ACCEPTED = 0x22 NON_AUTHORITATIVE_INFORMATION = 0x23 NO_CONTENT = 0x24 RESET_CONTENT = 0x25 PARTIAL_CONTENT = 0x26 MULTIPLE_CHOICES = 0x30 MOVED_PERMANENTLY = 0x31 MOVED_TEMPORARILY = 0x32 SEE_OTHER = 0x33 NOT_MODIFIED = 0x34 USE_PROXY = 0x35 BAD_REQUEST = 0x40 UNAUTHORIZED = 0x41 PAYMENT_REQUIRED = 0x42 FORBIDDEN = 0x43 NOT_FOUND = 0x44 METHOD_NOT_ALLOWED = 0x45 NOT_ACCEPTABLE = 0x46 PROXY_AUTHENTICATION_REQUIRED = 0x47 REQUEST_TIME_OUT = 0x48 CONFLICT = 0x49 GONE = 0x4A LENGTH_REQUIRED = 0x4B PRECONDITION_FAILED = 0x4C REQUESTED_ENTITY_TOO_LARGE = 0x4D REQUEST_URL_TOO_LARGE = 0x4E UNSUPPORTED_MEDIA_TYPE = 0x4F INTERNAL_SERVER_ERROR = 0x50 NOT_IMPLEMENTED = 0x51 BAD_GATEWAY = 0x52 SERVICE_UNAVAILABLE = 0x53 GATEWAY_TIMEOUT = 0x54 HTTP_VERSION_NOT_SUPPORTED = 0x55 DATABASE_FULL = 0x60 DATABASE_LOCKED = 0x61 lightblue-0.3.2/src/linux/lightblue_util.c 0000644 0000765 0000765 00000006476 10533016740 020127 0 ustar bea bea 0000000 0000000 /* * Copyright (c) 2006 Bea Lam. All rights reserved. * * Permission is hereby granted, free of charge, to any person * obtaining a copy of this software and associated documentation files * (the "Software"), to deal in the Software without restriction, * including without limitation the rights to use, copy, modify, merge, * publish, distribute, sublicense, and/or sell copies of the Software, * and to permit persons to whom the Software is furnished to do so, * subject to the following conditions: * * The above copyright notice and this permission notice shall be * included in all copies or substantial portions of the Software. * * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */ /* * Extension module to access BlueZ operations not provided in PyBluez. */ #include "Python.h" #include #include #include /* * Returns name of local device */ static PyObject* lb_hci_read_local_name(PyObject *self, PyObject *args) { int err = 0; int timeout = 0; int fd = 0; char name[249]; if (!PyArg_ParseTuple(args, "ii", &fd, &timeout)) return NULL; Py_BEGIN_ALLOW_THREADS err = hci_read_local_name(fd, sizeof(name)-1, name, timeout); Py_END_ALLOW_THREADS if (err != 0) return PyErr_SetFromErrno(PyExc_IOError); return PyString_FromString(name); } /* * Returns address of local device */ static PyObject* lb_hci_read_bd_addr(PyObject *self, PyObject *args) { int err = 0; int timeout = 0; int fd = 0; bdaddr_t ba; char addrstr[19] = {0}; if (!PyArg_ParseTuple(args, "ii", &fd, &timeout)) return NULL; Py_BEGIN_ALLOW_THREADS err = hci_read_bd_addr(fd, &ba, timeout); Py_END_ALLOW_THREADS if (err != 0) return PyErr_SetFromErrno(PyExc_IOError); ba2str(&ba, addrstr); return PyString_FromString(addrstr); } /* * Returns class of device of local device as a * (service, major, minor) tuple */ static PyObject* lb_hci_read_class_of_dev(PyObject *self, PyObject *args) { int err = 0; int timeout = 0; int fd = 0; uint8_t cod[3]; if (!PyArg_ParseTuple(args, "ii", &fd, &timeout)) return NULL; Py_BEGIN_ALLOW_THREADS err = hci_read_class_of_dev(fd, cod, timeout); Py_END_ALLOW_THREADS if (err != 0) return PyErr_SetFromErrno(PyExc_IOError); return Py_BuildValue("(B,B,B)", cod[2] << 3, cod[1] & 0x1f, cod[0] >> 2); } /* list of all functions in this module */ static PyMethodDef utilmethods[] = { {"hci_read_local_name", lb_hci_read_local_name, METH_VARARGS }, {"hci_read_bd_addr", lb_hci_read_bd_addr, METH_VARARGS}, {"hci_read_class_of_dev", lb_hci_read_class_of_dev, METH_VARARGS}, { NULL, NULL } /* sentinel */ }; /* module initialization functions */ void init_lightblueutil(void) { Py_InitModule("_lightblueutil", utilmethods); } lightblue-0.3.2/src/linux/lightblueobex_client.c 0000644 0000765 0000000 00000031152 10751225135 021630 0 ustar bea wheel 0000000 0000000 #include "lightblueobex_client.h" #include "lightblueobex_main.h" #include "structmember.h" typedef struct { PyObject_HEAD obex_t *obex; int busy; int timeout; int sendbufsize; int resp; PyObject *resp_headers; PyObject *error; PyObject *error_msg; PyObject *fileobj; PyObject *tempbuf; } OBEXClient; static void obexclient_requestcleanup(OBEXClient *self) { DEBUG("%s()\n", __func__); Py_XDECREF(self->fileobj); self->fileobj = NULL; Py_XDECREF(self->tempbuf); self->tempbuf = NULL; } static void obexclient_seterror(OBEXClient *self, PyObject *exc, char *message) { DEBUG("%s()\n", __func__); if (exc == NULL) DEBUG("\t(resetting error)\n"); else DEBUG("\tError: %s\n", (message == NULL ? "(unknown)" : message)); if (self->error != NULL) { DEBUG("\tIgnore new error, error already set!\n"); return; } Py_XDECREF(self->error); Py_XINCREF(exc); self->error = exc; Py_XDECREF(self->error_msg); self->error_msg = ( message == NULL ? PyString_FromString("error") : PyString_FromString(message) ); } static void obexclient_feedstream(OBEXClient *self, obex_object_t *obj) { /* self->fileobj shouldn't be NULL since startrequest() doesn't set OBEX_FL_STREAM_START (and so this shouldn't be called) if fileobj is null */ Py_XDECREF(self->tempbuf); self->tempbuf = lightblueobex_filetostream(self->obex, obj, self->fileobj, self->sendbufsize); if (self->tempbuf == NULL) { obexclient_seterror(self, PyExc_IOError, "error reading file object"); } } static void obexclient_readstream(OBEXClient *self, obex_object_t *obj) { int result; result = lightblueobex_streamtofile(self->obex, obj, self->fileobj); if (result < 0) { obexclient_seterror(self, PyExc_IOError, "error writing to file object"); } } static void obexclient_requestdone(OBEXClient *self, obex_object_t *obj, int obex_cmd, int obex_rsp) { DEBUG("%s()\n", __func__); DEBUG("\tCommand: %d Response: 0x%02x\n", obex_cmd, obex_rsp); self->resp = obex_rsp; Py_XDECREF(self->resp_headers); self->resp_headers = lightblueobex_readheaders(self->obex, obj); if (self->resp_headers == NULL) PyErr_SetString(PyExc_IOError, "error reading response headers"); obexclient_requestcleanup(self); self->busy = 0; } /* can this be static? */ void obexclient_event(obex_t *handle, obex_object_t *obj, int mode, int event, int obex_cmd, int obex_rsp) { DEBUG("%s()\n", __func__); DEBUG("\tEvent: %d Command: %d\n", event, obex_cmd); OBEXClient *self = (OBEXClient *)OBEX_GetUserData(handle); switch (event) { case OBEX_EV_LINKERR: case OBEX_EV_PARSEERR: obexclient_seterror(self, PyExc_IOError, (event == OBEX_EV_LINKERR ? "connection error" : "parse error")); if (obj != NULL) { /* check a request is in progress */ obexclient_requestdone(self, obj, obex_cmd, obex_rsp); } break; case OBEX_EV_STREAMEMPTY: obexclient_feedstream(self, obj); break; case OBEX_EV_STREAMAVAIL: obexclient_readstream(self, obj); break; case OBEX_EV_REQDONE: obexclient_requestdone(self, obj, obex_cmd, obex_rsp); break; default: /* ignore abort for now - can't be done with synchronous requests */ break; } } static int obexclient_startrequest(OBEXClient *self, int cmd, PyObject *headers, PyObject *nonhdrdata) { const uint8_t *nonhdrdata_raw; Py_ssize_t nonhdrdata_len; DEBUG("%s()\n", __func__); if (!PyDict_Check(headers)) { PyErr_Format(PyExc_TypeError, "headers must be dict, was %s", headers->ob_type->tp_name); return -1; } if (nonhdrdata != Py_None && !PyBuffer_Check(nonhdrdata)) { PyErr_Format(PyExc_TypeError, "nonhdrdata must be buffer or None, was %s", nonhdrdata->ob_type->tp_name); return -1; } if (self->busy) { PyErr_SetString(PyExc_IOError, "another request is in progress"); return -1; } obex_object_t *obj = OBEX_ObjectNew(self->obex, cmd); if (obj == NULL) { PyErr_SetString(PyExc_IOError, "error starting new request"); return -1; } if (lightblueobex_addheaders(self->obex, headers, obj) < 0) { OBEX_ObjectDelete(self->obex, obj); PyErr_SetString(PyExc_IOError, "error setting request headers"); return -1; } if (nonhdrdata != Py_None) { if (PyObject_AsReadBuffer(nonhdrdata, (const void **)&nonhdrdata_raw, &nonhdrdata_len) < 0) { /* PyObject_AsReadBuffer() sets exception if error */ OBEX_ObjectDelete(self->obex, obj); return -1; } if (OBEX_ObjectSetNonHdrData(obj, nonhdrdata_raw, nonhdrdata_len) < 0) { OBEX_ObjectDelete(self->obex, obj); PyErr_SetString(PyExc_IOError, "error setting request non-header data"); return -1; } } if (self->fileobj != NULL) { if (cmd == OBEX_CMD_PUT) { /* don't stream data if there is no fileobj (i.e. a Put-Delete) */ obex_headerdata_t hv; if (OBEX_ObjectAddHeader(self->obex, obj, OBEX_HDR_BODY, hv, 0, OBEX_FL_STREAM_START) < 0) { PyErr_SetString(PyExc_IOError, "error setting streaming mode for Put"); return -1; } } else if (cmd == OBEX_CMD_GET) { if (OBEX_ObjectReadStream(self->obex, obj, NULL) < 0) { PyErr_SetString(PyExc_IOError, "error setting streaming mode for Get"); return -1; } } } /* reset data for the new request */ self->busy = 1; obexclient_seterror(self, NULL, NULL); self->resp = 0x20; Py_XDECREF(self->resp_headers); self->resp_headers = NULL; if (OBEX_Request(self->obex, obj) < 0) { PyErr_SetString(PyExc_IOError, "error sending request"); return -1; } return 1; } static PyObject * OBEXClient_request(OBEXClient *self, PyObject *args) { PyObject *tmp; int result; int cmd; PyObject *headers; PyObject *nonhdrdata; PyObject *fileobj = NULL; /* optional */ DEBUG("%s()\n", __func__); if (!PyArg_ParseTuple(args, "iO!O|O", &cmd, &PyDict_Type, &headers, &nonhdrdata, &fileobj)) { return NULL; } if (fileobj != NULL) { char *method; method = ( cmd == OBEX_CMD_PUT ? "read" : "write" ); if (!PyObject_HasAttrString(fileobj, method)) { PyErr_Format(PyExc_AttributeError, "file-like object must have %s() method", method); return NULL; } tmp = self->fileobj; Py_INCREF(fileobj); self->fileobj = fileobj; Py_XDECREF(tmp); } if (obexclient_startrequest(self, cmd, headers, nonhdrdata) < 0) { obexclient_requestcleanup(self); return NULL; } /* wait until request is complete */ while (self->busy) { result = OBEX_HandleInput(self->obex, self->timeout); if (result < 0) { obexclient_requestcleanup(self); obexclient_seterror(self, PyExc_IOError, "error processing input"); break; } else if (result == 0) { obexclient_requestcleanup(self); obexclient_seterror(self, PyExc_IOError, "input processing timed out"); break; } } /* request is now complete, obexclient_requestcleanup() will have been called */ if (self->error) { PyErr_SetObject(self->error, self->error_msg); return NULL; } /* Don't throw exceptions for non-success responses. The caller can decide whether that should be done. */ return Py_BuildValue("(iO)", self->resp, self->resp_headers); } PyDoc_STRVAR(OBEXClient_request__doc__, "request(opcode, headers, nonheaderdata [, fileobj]) -> response\n\n\ Sends an OBEX request and returns the server response code. \ Provide a file-like object if performing a Put or Get request. \ The nonheaderdata is really only useful for specifying the flags for SetPath \ requests. For other requests, set this value to None."); static PyObject * OBEXClient_new(PyTypeObject *type, PyObject *args, PyObject *kwds) { OBEXClient *self; self = (OBEXClient *)type->tp_alloc(type, 0); if (self != NULL) { self->obex = NULL; self->busy = 0; self->timeout = 10; /* seconds */ self->sendbufsize = 4096; self->resp = 0; self->resp_headers = NULL; self->error = NULL; self->error_msg = PyString_FromString(""); if (self->error_msg == NULL) { Py_DECREF(self); return NULL; } self->fileobj = NULL; self->tempbuf = NULL; } return (PyObject *)self; } static int OBEXClient_init(OBEXClient *self, PyObject *args, PyObject *kwds) { int fd = -1; int writefd = -1; int mtu = 1024; unsigned int flags = 0; static char *kwlist[] = { "fd", "writefd", "mtu", "flags", NULL }; if (!PyArg_ParseTupleAndKeywords(args, kwds, "i|iiI", kwlist, &fd, &writefd, &mtu, &flags)) { return -1; } if (self->obex == NULL) { self->obex = OBEX_Init(OBEX_TRANS_FD, obexclient_event, flags); if (self->obex == NULL) { PyErr_SetString(PyExc_IOError, "error creating OBEX object"); return -1; } if (writefd == -1) writefd = fd; if (FdOBEX_TransportSetup(self->obex, fd, writefd, mtu) < 0) { PyErr_SetString(PyExc_IOError, "error initialising transport"); return -1; } } OBEX_SetUserData(self->obex, self); return 0; } static void OBEXClient_dealloc(OBEXClient *self) { DEBUG("%s()\n", __func__); if (self->obex) OBEX_Cleanup(self->obex); Py_XDECREF(self->error); Py_XDECREF(self->error_msg); Py_XDECREF(self->fileobj); Py_XDECREF(self->tempbuf); self->ob_type->tp_free((PyObject *)self); } static PyMemberDef OBEXClient_members[] = { {"timeout", T_INT, offsetof(OBEXClient, timeout), 0, "timeout for each request"}, {"sendbufsize", T_INT, offsetof(OBEXClient, sendbufsize), 0, "size of each data chunk to read from the file object for a Put request"}, {NULL} /* Sentinel */ }; static PyMethodDef OBEXClient_methods[] = { { "request", (PyCFunction)OBEXClient_request, METH_VARARGS, OBEXClient_request__doc__, }, {NULL} /* Sentinel */ }; static PyTypeObject OBEXClientType = { PyObject_HEAD_INIT(NULL) 0, /*ob_size*/ "obexclient.OBEXClient", /*tp_name*/ sizeof(OBEXClient), /*tp_basicsize*/ 0, /*tp_itemsize*/ (destructor)OBEXClient_dealloc, /*tp_dealloc*/ 0, /*tp_print*/ 0, /*tp_getattr*/ 0, /*tp_setattr*/ 0, /*tp_compare*/ 0, /*tp_repr*/ 0, /*tp_as_number*/ 0, /*tp_as_sequence*/ 0, /*tp_as_mapping*/ 0, /*tp_hash */ 0, /*tp_call*/ 0, /*tp_str*/ 0, /*tp_getattro*/ 0, /*tp_setattro*/ 0, /*tp_as_buffer*/ Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE, /*tp_flags*/ "An OBEX client class.", /* tp_doc */ 0, /* tp_traverse */ 0, /* tp_clear */ 0, /* tp_richcompare */ 0, /* tp_weaklistoffset */ 0, /* tp_iter */ 0, /* tp_iternext */ OBEXClient_methods, /* tp_methods */ OBEXClient_members, /* tp_members */ 0, /* tp_getset */ 0, /* tp_base */ 0, /* tp_dict */ 0, /* tp_descr_get */ 0, /* tp_descr_set */ 0, /* tp_dictoffset */ (initproc)OBEXClient_init, /* tp_init */ 0, /* tp_alloc */ OBEXClient_new, /* tp_new */ }; PyTypeObject *lightblueobex_getclienttype(void) { return &OBEXClientType; } lightblue-0.3.2/src/linux/._lightblueobex_client.h 0000644 0000765 0000000 00000000122 10717030255 022042 0 ustar bea wheel 0000000 0000000 Mac OS X 2 R TEXT!Rch lightblue-0.3.2/src/linux/lightblueobex_client.h 0000644 0000765 0000765 00000000216 10717030255 021276 0 ustar bea bea 0000000 0000000 #ifndef LIGHTBLUEOBEX_CLIENT_H #define LIGHTBLUEOBEX_CLIENT_H #include "Python.h" PyTypeObject *lightblueobex_getclienttype(void); #endif lightblue-0.3.2/src/linux/lightblueobex_main.c 0000644 0000765 0000000 00000041320 10765211704 021276 0 ustar bea wheel 0000000 0000000 #include "lightblueobex_main.h" #include "lightblueobex_client.h" #include "lightblueobex_server.h" #include #include "Python.h" #define OBEX_HI_MASK 0xc0 #define OBEX_UNICODE 0x00 #define OBEX_BYTE_STREAM 0x40 #define OBEX_BYTE 0x80 #define OBEX_INT 0xc0 /* OBEX unicode strings are UTF-16, big-endian. */ #define OBEX_BIG_ENDIAN 1 /* for encoding/decoding unicode strings */ PyObject *lightblueobex_readheaders(obex_t *obex, obex_object_t *obj) { PyObject *headers; uint8_t hi; obex_headerdata_t hv; uint32_t hv_size; int r; PyObject *value = NULL; DEBUG("%s()\n", __func__); headers = PyDict_New(); if (headers == NULL) return NULL; if (obex == NULL || obj == NULL || headers == NULL) { DEBUG("\treadheaders() got null argument\n"); return NULL; } if (!PyDict_Check(headers)) { DEBUG("\treadheaders() arg must be dict\n"); return NULL; } while (OBEX_ObjectGetNextHeader(obex, obj, &hi, &hv, &hv_size)) { DEBUG("\tread header: 0x%02x\n", hi); switch (hi & OBEX_HI_MASK) { case OBEX_UNICODE: { if (hv_size < 2) { value = PyUnicode_FromUnicode(NULL, 0); } else { /* hv_size-2 for 2-byte null terminator */ int byteorder = OBEX_BIG_ENDIAN; value = PyUnicode_DecodeUTF16((const char*)hv.bs, hv_size-2, NULL, &byteorder); if (value == NULL) { DEBUG("\terror reading unicode header 0x%02x\n", hi); if (PyErr_Occurred()) { PyErr_Print(); PyErr_Clear(); /* let caller set exception */ } return NULL; } } break; } case OBEX_BYTE_STREAM: { value = PyBuffer_New(hv_size); if (value != NULL) { void *buf; Py_ssize_t buflen; if (PyObject_AsWriteBuffer(value, &buf, &buflen) < 0) { Py_DECREF(value); DEBUG("\terror writing to buffer for header 0x%02x\n", hi); return NULL; } memcpy(buf, hv.bs, buflen); } break; } case OBEX_BYTE: { value = PyInt_FromLong(hv.bq1); break; } case OBEX_INT: { value = PyLong_FromUnsignedLong(hv.bq4); break; } default: DEBUG("\tunknown header id encoding %d\n", (hi & OBEX_HI_MASK)); return NULL; } if (value == NULL) { if (PyErr_Occurred() == NULL) DEBUG("\terror reading headers\n"); return NULL; } r = PyDict_SetItem(headers, PyInt_FromLong((long)hi), value); Py_DECREF(value); if (r < 0) { DEBUG("\tPyDict_SetItem() error\n"); if (PyErr_Occurred()) { PyErr_Print(); PyErr_Clear(); /* let caller set exception */ } return NULL; } } return headers; } static int lightblueobex_add4byteheader(obex_t *obex, obex_object_t *obj, uint8_t hi, PyObject *value) { obex_headerdata_t hv; uint32_t intvalue; DEBUG("%s()\n", __func__); if (value == NULL) return -1; if (PyInt_Check(value)) { intvalue = PyInt_AsLong(value); if (PyErr_Occurred()) { DEBUG("\tcan't convert header 0x%02x int value to long", hi); PyErr_Clear(); return -1; } } else if (PyLong_Check(value)) { intvalue = PyLong_AsUnsignedLong(value); if (PyErr_Occurred()) { DEBUG("\tcan't convert header 0x%02x long value to long", hi); PyErr_Clear(); return -1; } } else { DEBUG("\theader value for id 0x%02x must be int or long, was %s\n", hi, value->ob_type->tp_name); return -1; } hv.bq4 = intvalue; return OBEX_ObjectAddHeader(obex, obj, hi, hv, 4, OBEX_FL_FIT_ONE_PACKET); } static int lightblueobex_addbytestreamheader(obex_t *obex, obex_object_t *obj, uint8_t hi, PyObject *bufObject) { obex_headerdata_t hv; uint32_t hv_size; DEBUG("%s()\n", __func__); if (PyObject_AsReadBuffer(bufObject, (const void**)&hv.bs, (Py_ssize_t*)&hv_size) < 0) { DEBUG("\theader value for id 0x%02x must be readable buffer\n", hi); return -1; } return OBEX_ObjectAddHeader(obex, obj, hi, hv, hv_size, OBEX_FL_FIT_ONE_PACKET); } static int lightblueobex_addunicodeheader(obex_t *obex, obex_object_t *obj, uint8_t hi, PyObject *utf16string) { obex_headerdata_t hv; Py_ssize_t len = PyUnicode_GET_SIZE(utf16string); uint8_t bytes[len+2]; DEBUG("%s()\n", __func__); /* need to add 2-byte null terminator */ memcpy(bytes, (const uint8_t*)PyString_AsString(utf16string), len); bytes[len] = 0x00; bytes[len+1] = 0x00; hv.bs = bytes; return OBEX_ObjectAddHeader(obex, obj, (uint8_t)hi, hv, len+2, OBEX_FL_FIT_ONE_PACKET); } int lightblueobex_addheaders(obex_t *obex, PyObject *headers, obex_object_t *obj) { uint8_t hi; obex_headerdata_t hv; PyObject *key, *value; Py_ssize_t pos = 0; int r = -1; DEBUG("%s()\n", __func__); if (headers == NULL || !PyDict_Check(headers)) { DEBUG("\taddheaders() arg must be dict\n"); return -1; } /* add connection-id first */ key = PyInt_FromLong(OBEX_HDR_CONNECTION); if (key != NULL) { value = PyDict_GetItem(headers, key); /* don't decref! */ Py_DECREF(key); key = NULL; if (value != NULL) { DEBUG("\tadding connection-id\n"); r = lightblueobex_add4byteheader(obex, obj, OBEX_HDR_CONNECTION, value); if (r < 0) { DEBUG("\terror adding connection-id header\n"); return -1; } } } /* add target header first (shouldn't have both conn-id and target) */ key = PyInt_FromLong(OBEX_HDR_TARGET); if (key != NULL) { value = PyDict_GetItem(headers, key); /* don't decref! */ Py_DECREF(key); key = NULL; if (value != NULL) { DEBUG("\tadding target\n"); r = lightblueobex_addbytestreamheader(obex, obj, OBEX_HDR_TARGET, value); if (r < 0) { DEBUG("\terror adding target header\n"); return -1; } } } while (PyDict_Next(headers, &pos, &key, &value)) { if (key == NULL || value == NULL) { DEBUG("\terror reading headers dict\n"); return -1; } if (!PyInt_Check(key)) { DEBUG("\theader id must be int, was %s\n", key->ob_type->tp_name); return -1; } hi = (uint8_t)PyInt_AsUnsignedLongMask(key); if (hi == OBEX_HDR_CONNECTION || hi == OBEX_HDR_TARGET) { /* these are already added */ continue; } DEBUG("\tadding header: 0x%02x\n", hi); switch (hi & OBEX_HI_MASK) { case OBEX_UNICODE: { PyObject *encoded = NULL; if (PyUnicode_Check(value)) { encoded = PyUnicode_EncodeUTF16(PyUnicode_AS_UNICODE(value), PyUnicode_GET_SIZE(value), NULL, OBEX_BIG_ENDIAN); } else { /* try converting to unicode */ PyObject *tmp = NULL; tmp = PyUnicode_FromObject(value); if (tmp == NULL) { if (PyErr_Occurred()) { PyErr_Print(); PyErr_Clear(); /* let caller set exception */ } DEBUG("\tfailed to convert header value for id 0x%02x to unicode\n", hi); return -1; } encoded = PyUnicode_EncodeUTF16(PyUnicode_AS_UNICODE(tmp), PyUnicode_GET_SIZE(tmp), NULL, OBEX_BIG_ENDIAN); Py_DECREF(tmp); } if (encoded == NULL) { if (PyErr_Occurred()) { PyErr_Print(); PyErr_Clear(); /* let caller set exception */ } DEBUG("\tfailed to encode value for header 0x%02x to UTF-16 big endian\n", hi); return -1; } r = lightblueobex_addunicodeheader(obex, obj, hi, encoded); Py_DECREF(encoded); break; } case OBEX_BYTE_STREAM: { r = lightblueobex_addbytestreamheader(obex, obj, hi, value); break; } case OBEX_BYTE: { long intvalue; if (!PyInt_Check(value)) { DEBUG("\theader value for id 0x%02x must be int, was %s\n", hi, value->ob_type->tp_name); return -1; } intvalue = PyInt_AsLong(value); if (PyErr_Occurred()) { DEBUG("\terror reading int value for 0x%02x\n", hi); PyErr_Clear(); return -1; } hv.bq1 = (uint8_t)intvalue; r = OBEX_ObjectAddHeader(obex, obj, hi, hv, 1, OBEX_FL_FIT_ONE_PACKET); break; } case OBEX_INT: { r = lightblueobex_add4byteheader(obex, obj, hi, value); break; } default: DEBUG("\tunknown header id encoding %d\n", (hi & OBEX_HI_MASK)); return -1; } if (r < 0) { DEBUG("\terror adding header 0x%02x\n", hi); return -1; } } return 1; } PyObject *lightblueobex_filetostream(obex_t *obex, obex_object_t *obj, PyObject *fileobj, int bufsize) { const void *data; Py_ssize_t datalen; /* or unsigned int? */ obex_headerdata_t hv; PyObject *buf; DEBUG("%s()\n", __func__); if (fileobj == NULL) { DEBUG("\tgiven file object is NULL\n"); hv.bs = NULL; OBEX_ObjectAddHeader(obex, obj, OBEX_HDR_BODY, hv, 0, OBEX_FL_STREAM_DATAEND); return NULL; } buf = PyObject_CallMethod(fileobj, "read", "i", bufsize); if (buf == NULL) { if (PyErr_Occurred()) { PyErr_Print(); PyErr_Clear(); /* let caller set exception */ } DEBUG("\terror calling file object read()\n"); } if (buf != NULL && !PyObject_CheckReadBuffer(buf)) { DEBUG("\tfile object read() returned non-buffer object\n"); Py_DECREF(buf); buf = NULL; } if (buf != NULL && PyObject_AsReadBuffer(buf, &data, &datalen) < 0) { DEBUG("\terror reading file object contents\n"); Py_DECREF(buf); buf = NULL; } if (buf == NULL) { hv.bs = NULL; OBEX_ObjectAddHeader(obex, obj, OBEX_HDR_BODY, hv, 0, OBEX_FL_STREAM_DATAEND); return NULL; } hv.bs = (uint8_t*)data; if (OBEX_ObjectAddHeader(obex, obj, OBEX_HDR_BODY, hv, datalen, (datalen == 0 ? OBEX_FL_STREAM_DATAEND : OBEX_FL_STREAM_DATA)) < 0) { DEBUG("\terror adding body data\n"); Py_DECREF(buf); buf = NULL; } return buf; } int lightblueobex_streamtofile(obex_t *obex, obex_object_t *obj, PyObject *fileobj) { const uint8_t *buf; int buflen; DEBUG("%s()\n", __func__); if (fileobj == NULL) return -1; buflen = OBEX_ObjectReadStream(obex, obj, &buf); if (buflen == 0) return 0; if (buflen < 0) { DEBUG("\tunable to read body data from request\n"); return -1; } DEBUG("\treading %d bytes\n", buflen); PyObject *pybuf = PyBuffer_FromMemory((void*)buf, buflen); if (pybuf == NULL) { DEBUG("\terror reading received body\n"); return -1; } PyObject *result = PyObject_CallMethod(fileobj, "write", "O", pybuf); Py_DECREF(pybuf); if (result == NULL) { if (PyErr_Occurred()) { PyErr_Print(); PyErr_Clear(); /* let caller set exception */ } DEBUG("error calling write() on file object\n"); return -1; } Py_DECREF(result); return buflen; } static PyMethodDef module_methods[] = { {NULL} /* Sentinel */ }; #ifndef PyMODINIT_FUNC /* declarations for DLL import/export */ #define PyMODINIT_FUNC void #endif PyMODINIT_FUNC init_lightblueobex(void) { PyObject *m; PyTypeObject *clientType; PyTypeObject *serverType; clientType = lightblueobex_getclienttype(); serverType = lightblueobex_getservertype(); if ( (PyType_Ready(clientType) < 0) || (PyType_Ready(serverType) < 0) ) { return; } m = Py_InitModule3("_lightblueobex", module_methods, "Module containing the OBEXClient and OBEXServer classes."); if (m == NULL) return; PyModule_AddIntConstant(m, "CONNECT", 0x00); PyModule_AddIntConstant(m, "DISCONNECT", 0x01); PyModule_AddIntConstant(m, "PUT", 0x02); PyModule_AddIntConstant(m, "GET", 0x03); PyModule_AddIntConstant(m, "SETPATH", 0x05); PyModule_AddIntConstant(m, "SESSION", 0x07); PyModule_AddIntConstant(m, "ABORT", 0x7f); /* or should these constants be in the linux obex module? */ PyModule_AddIntConstant(m, "COUNT", 0xc0); PyModule_AddIntConstant(m, "NAME", 0x01); PyModule_AddIntConstant(m, "TYPE", 0x42); PyModule_AddIntConstant(m, "LENGTH", 0xc3); PyModule_AddIntConstant(m, "TIME", 0x44); PyModule_AddIntConstant(m, "DESCRIPTION", 0x05); PyModule_AddIntConstant(m, "TARGET", 0x46); PyModule_AddIntConstant(m, "HTTP", 0x47); PyModule_AddIntConstant(m, "BODY", 0x48); PyModule_AddIntConstant(m, "END_OF_BODY", 0x49); PyModule_AddIntConstant(m, "WHO", 0x4a); PyModule_AddIntConstant(m, "CONNECTION_ID", 0xcb); PyModule_AddIntConstant(m, "APP_PARAMETERS", 0x4c); PyModule_AddIntConstant(m, "AUTH_CHALLENGE", 0x4d); PyModule_AddIntConstant(m, "AUTH_RESPONSE", 0x4e); PyModule_AddIntConstant(m, "CREATOR", 0xcf); PyModule_AddIntConstant(m, "WAN_UUID", 0x50); PyModule_AddIntConstant(m, "OBJECT_CLASS", 0x51); PyModule_AddIntConstant(m, "SESSION_PARAMETERS", 0x52); PyModule_AddIntConstant(m, "SESSION_SEQUENCE_NUMBER", 0x93); PyModule_AddIntConstant(m, "CONTINUE", 0x10); PyModule_AddIntConstant(m, "SWITCH_PRO", 0x11); PyModule_AddIntConstant(m, "SUCCESS", 0x20); PyModule_AddIntConstant(m, "CREATED", 0x21); PyModule_AddIntConstant(m, "ACCEPTED", 0x22); PyModule_AddIntConstant(m, "NON_AUTHORITATIVE", 0x23); PyModule_AddIntConstant(m, "NO_CONTENT", 0x24); PyModule_AddIntConstant(m, "RESET_CONTENT", 0x25); PyModule_AddIntConstant(m, "PARTIAL_CONTENT", 0x26); PyModule_AddIntConstant(m, "MULTIPLE_CHOICES", 0x30); PyModule_AddIntConstant(m, "MOVED_PERMANENTLY", 0x31); PyModule_AddIntConstant(m, "MOVED_TEMPORARILY", 0x32); PyModule_AddIntConstant(m, "SEE_OTHER", 0x33); PyModule_AddIntConstant(m, "NOT_MODIFIED", 0x34); PyModule_AddIntConstant(m, "USE_PROXY", 0x35); PyModule_AddIntConstant(m, "BAD_REQUEST", 0x40); PyModule_AddIntConstant(m, "UNAUTHORIZED", 0x41); PyModule_AddIntConstant(m, "PAYMENT_REQUIRED", 0x42); PyModule_AddIntConstant(m, "FORBIDDEN", 0x43); PyModule_AddIntConstant(m, "NOT_FOUND", 0x44); PyModule_AddIntConstant(m, "METHOD_NOT_ALLOWED", 0x45); PyModule_AddIntConstant(m, "NOT_ACCEPTABLE", 0x46); PyModule_AddIntConstant(m, "PROXY_AUTH_REQUIRED", 0x47); PyModule_AddIntConstant(m, "REQUEST_TIME_OUT", 0x48); PyModule_AddIntConstant(m, "CONFLICT", 0x49); PyModule_AddIntConstant(m, "GONE", 0x4a); PyModule_AddIntConstant(m, "LENGTH_REQUIRED", 0x4b); PyModule_AddIntConstant(m, "PRECONDITION_FAILED", 0x4c); PyModule_AddIntConstant(m, "REQ_ENTITY_TOO_LARGE", 0x4d); PyModule_AddIntConstant(m, "REQ_URL_TOO_LARGE", 0x4e); PyModule_AddIntConstant(m, "UNSUPPORTED_MEDIA_TYPE", 0x4f); PyModule_AddIntConstant(m, "INTERNAL_SERVER_ERROR", 0x50); PyModule_AddIntConstant(m, "NOT_IMPLEMENTED", 0x51); PyModule_AddIntConstant(m, "BAD_GATEWAY", 0x52); PyModule_AddIntConstant(m, "SERVICE_UNAVAILABLE", 0x53); PyModule_AddIntConstant(m, "GATEWAY_TIMEOUT", 0x54); PyModule_AddIntConstant(m, "VERSION_NOT_SUPPORTED", 0x55); PyModule_AddIntConstant(m, "DATABASE_FULL", 0x60); PyModule_AddIntConstant(m, "DATABASE_LOCKED", 0x61); Py_INCREF(clientType); PyModule_AddObject(m, "OBEXClient", (PyObject *)clientType); Py_INCREF(serverType); PyModule_AddObject(m, "OBEXServer", (PyObject *)serverType); } lightblue-0.3.2/src/linux/._lightblueobex_main.h 0000644 0000765 0000000 00000000122 10747221507 021515 0 ustar bea wheel 0000000 0000000 Mac OS X 2 R TEXT!Rch lightblue-0.3.2/src/linux/lightblueobex_main.h 0000644 0000765 0000765 00000001541 10747221507 020753 0 ustar bea bea 0000000 0000000 #ifndef LIGHTBLUEOBEX_MAIN_H #define LIGHTBLUEOBEX_MAIN_H #include "Python.h" #include /* compatibility with python versions before 2.5 (PEP 353) */ #if PY_VERSION_HEX < 0x02050000 && !defined(PY_SSIZE_T_MIN) typedef int Py_ssize_t; #define PY_SSIZE_T_MAX INT_MAX #define PY_SSIZE_T_MIN INT_MIN #endif #ifndef LIGHTBLUE_DEBUG #define LIGHTBLUE_DEBUG 0 #endif #if LIGHTBLUE_DEBUG #define DEBUG(format, args...) fprintf(stderr, format, ##args) #else #define DEBUG(format, args...) #endif PyObject *lightblueobex_readheaders(obex_t *obex, obex_object_t *obj); int lightblueobex_addheaders(obex_t *obex, PyObject *headers, obex_object_t *obj); PyObject *lightblueobex_filetostream(obex_t *obex, obex_object_t *obj, PyObject *fileobj, int bufsize); int lightblueobex_streamtofile(obex_t *obex, obex_object_t *obj, PyObject *fileobj); #endif lightblue-0.3.2/src/linux/lightblueobex_server.c 0000644 0000765 0000000 00000040473 10765211706 021672 0 ustar bea wheel 0000000 0000000 #include "lightblueobex_server.h" #include "lightblueobex_main.h" #include "structmember.h" //#define LIGHTBLUEOBEX_SERVER_TEST typedef struct { PyObject_HEAD obex_t *obex; int sendbufsize; PyObject *cb_error; PyObject *cb_newrequest; PyObject *cb_requestdone; int notifiednewrequest; int hasbodydata; PyObject *fileobj; PyObject *tempbuf; #ifdef LIGHTBLUEOBEX_SERVER_TEST uint32_t puttotal; #endif } OBEXServer; static void obexserver_error(OBEXServer *self, PyObject *type, PyObject *value) { PyObject *result; PyObject *tmpValue; DEBUG("%s()\n", __func__); if (self->cb_error == NULL) { /* shouldn't happen, checked in init */ DEBUG("\tcb_error() is NULL"); return; } tmpValue = (value == NULL ? PyString_FromString("server error") : value); result = PyObject_CallFunctionObjArgs(self->cb_error, (type == NULL ? PyExc_IOError : type), value, NULL); if (result == NULL) DEBUG("\tfailed to call cb_error()\n"); else Py_DECREF(result); /* don't want exceptions to be raised */ /*PyErr_Clear();*/ DEBUG("\terror was:\n"); PyErr_Print(); /* clears the error indicator */ } static void obexserver_errorstr(OBEXServer *self, PyObject *exc, char *message) { PyObject *msgobj; DEBUG("%s() - error with string msg\n", __func__); msgobj = PyString_FromString(message); obexserver_error(self, exc, msgobj); Py_XDECREF(msgobj); } static void obexserver_errorfetch(OBEXServer *self) { DEBUG("%s() - load from set error\n", __func__); if (!PyErr_Occurred()) { DEBUG("\tno error set, raise generic error\n"); obexserver_error(self, NULL, NULL); } else { PyObject *pType; PyObject *pValue; PyObject *pTraceback; PyErr_Fetch(&pType, &pValue, &pTraceback); /* value, TB can be null */ obexserver_error(self, pType, pValue); Py_XDECREF(pType); Py_XDECREF(pValue); Py_XDECREF(pTraceback); } } /* Returns new reference that must be decref'd. */ static PyObject* obexserver_notifynewrequest(OBEXServer *self, obex_object_t *obj, int obex_cmd, int *respcode) { PyObject *resp; PyObject *respheaders; PyObject *tmpfileobj; PyObject *reqheaders; int nonhdrdata_len; PyObject *nonhdrdata_obj; uint8_t *nonhdrdata; DEBUG("%s() cmd=%d\n", __func__, obex_cmd); if (self->notifiednewrequest) { DEBUG("\tAlready called cb_newrequest"); return NULL; } if (self->cb_newrequest == NULL) { /* shouldn't happen */ obexserver_errorstr(self, PyExc_IOError, "cb_newrequest is NULL"); return NULL; } reqheaders = lightblueobex_readheaders(self->obex, obj); if (reqheaders == NULL) { obexserver_errorstr(self, PyExc_IOError, "error reading request headers"); return NULL; } nonhdrdata_len = OBEX_ObjectGetNonHdrData(obj, &nonhdrdata); if (nonhdrdata_len < 0) { obexserver_errorstr(self, PyExc_IOError, "error reading non-header data"); return NULL; } nonhdrdata_obj = PyBuffer_FromMemory(nonhdrdata, (Py_ssize_t)nonhdrdata_len); if (nonhdrdata_obj == NULL) { obexserver_errorstr(self, PyExc_IOError, "error reading non-header buffer"); return NULL; } resp = PyObject_CallFunction(self->cb_newrequest, "iOOO", obex_cmd, reqheaders, nonhdrdata_obj, (self->hasbodydata ? Py_True : Py_False)); Py_DECREF(nonhdrdata_obj); self->notifiednewrequest = 1; if (resp == NULL) { DEBUG("\terror calling cb_newrequest\n"); obexserver_errorfetch(self); return NULL; } if ( !PyTuple_Check(resp) || PyTuple_Size(resp) < 3 || !PyInt_Check(PyTuple_GetItem(resp, 0)) || !PyDict_Check(PyTuple_GetItem(resp, 1)) ) { obexserver_errorstr(self, PyExc_TypeError, "callback must return (int, dict, fileobj | None) tuple"); return NULL; } tmpfileobj = PyTuple_GetItem(resp, 2); if (obex_cmd == OBEX_CMD_PUT && self->hasbodydata && !PyObject_HasAttrString(tmpfileobj, "write")) { obexserver_errorstr(self, PyExc_ValueError, "specified file object does not have 'write' method for Put request"); return NULL; } if (obex_cmd == OBEX_CMD_GET && !PyObject_HasAttrString(tmpfileobj, "read")) { obexserver_errorstr(self, PyExc_ValueError, "specified file object does not have 'read' method for Get request"); return NULL; } *respcode = PyInt_AsLong(PyTuple_GetItem(resp, 0)); if (PyErr_Occurred()) { PyErr_Clear(); obexserver_errorstr(self, PyExc_IOError, "error reading returned response code"); return NULL; } Py_XDECREF(self->fileobj); Py_INCREF(tmpfileobj); self->fileobj = tmpfileobj; respheaders = PyTuple_GetItem(resp, 1); Py_INCREF(respheaders); return respheaders; } static int obexserver_setresponse(OBEXServer *self, obex_object_t *obj, int responsecode, PyObject *responseheaders) { DEBUG("%s()\n", __func__); if (responseheaders != NULL) { if (lightblueobex_addheaders(self->obex, responseheaders, obj) < 0) { obexserver_errorstr(self, PyExc_IOError, "error setting response headers"); OBEX_ObjectSetRsp(obj, OBEX_RSP_INTERNAL_SERVER_ERROR, OBEX_RSP_INTERNAL_SERVER_ERROR); return -1; } } if (responsecode == OBEX_RSP_SUCCESS || responsecode == OBEX_RSP_CONTINUE) { DEBUG("\tAccepting request...\n"); OBEX_ObjectSetRsp(obj, OBEX_RSP_CONTINUE, OBEX_RSP_SUCCESS); } else { DEBUG("\tRefusing request (%s)...\n", OBEX_ResponseToString(responsecode)); OBEX_ObjectSetRsp(obj, responsecode, responsecode); } return 1; } static void obexserver_receivedrequest(OBEXServer *self, obex_object_t *obj, int obex_cmd) { int respcode; PyObject *respheaders; DEBUG("%s()\n", __func__); // Put requests are taken care of in obexserver_streamavailable() if (obex_cmd == OBEX_CMD_PUT && self->hasbodydata) { #ifdef LIGHTBLUEOBEX_SERVER_TEST obex_headerdata_t hv; hv.bq4 = self->puttotal; OBEX_ObjectAddHeader(self->obex, obj, OBEX_HDR_LENGTH, hv, 4, 0); #endif return; } respheaders = obexserver_notifynewrequest(self, obj, obex_cmd, &respcode); if (respheaders == NULL) { obexserver_setresponse(self, obj, OBEX_RSP_INTERNAL_SERVER_ERROR, NULL); } else { int result; result = obexserver_setresponse(self, obj, respcode, respheaders); /* for Get requests, indicate we want OBEX_EV_STREAMEMPTY events */ if (result >= 0 && obex_cmd == OBEX_CMD_GET && (respcode == OBEX_RSP_CONTINUE || respcode == OBEX_RSP_SUCCESS)) { obex_headerdata_t hv; hv.bs = NULL; OBEX_ObjectAddHeader(self->obex, obj, OBEX_HDR_BODY, hv, 0, OBEX_FL_STREAM_START); } } Py_XDECREF(respheaders); } static void obexserver_streamavailable(OBEXServer *self, obex_object_t *obj) { DEBUG("%s()\n", __func__); /* if got OBEX_EV_STREAMAVAIL, it means the request contains body data (and therefore is not a Put-Delete) */ self->hasbodydata = 1; if (!self->notifiednewrequest) { PyObject *respheaders; int respcode; respheaders = obexserver_notifynewrequest(self, obj, OBEX_CMD_PUT, &respcode); if (respheaders == NULL) { obexserver_setresponse(self, obj, OBEX_RSP_INTERNAL_SERVER_ERROR, NULL); return; } obexserver_setresponse(self, obj, respcode, respheaders); Py_DECREF(respheaders); if (respcode != OBEX_RSP_CONTINUE && respcode != OBEX_RSP_SUCCESS) return; } if (self->fileobj == NULL) { obexserver_errorstr(self, PyExc_IOError, "file object is null"); return; } int result; result = lightblueobex_streamtofile(self->obex, obj, self->fileobj); if (result < 0) { obexserver_errorstr(self, PyExc_IOError, "error reading body data or writing to file object"); OBEX_ObjectSetRsp(obj, OBEX_RSP_INTERNAL_SERVER_ERROR, OBEX_RSP_INTERNAL_SERVER_ERROR); } #ifdef LIGHTBLUEOBEX_SERVER_TEST if (result > 0) self->puttotal += result; #endif } static void obexserver_streamempty(OBEXServer *self, obex_object_t *obj) { DEBUG("%s()\n", __func__); Py_XDECREF(self->tempbuf); self->tempbuf = lightblueobex_filetostream(self->obex, obj, self->fileobj, self->sendbufsize); if (self->tempbuf == NULL) { obexserver_errorstr(self, PyExc_IOError, "error reading file object"); OBEX_ObjectSetRsp(obj, OBEX_RSP_INTERNAL_SERVER_ERROR, OBEX_RSP_INTERNAL_SERVER_ERROR); } } static void obexserver_requestdone(OBEXServer *self, obex_object_t *obj, int obex_cmd) { PyObject *result; if (self->cb_requestdone == NULL) { /* shouldn't happen */ obexserver_errorstr(self, PyExc_IOError, "cb_requestdone is NULL"); return; } result = PyObject_CallFunction(self->cb_requestdone, "i", obex_cmd); if (result == NULL) { obexserver_errorfetch(self); } else { Py_DECREF(result); } /* clean up */ Py_XDECREF(self->tempbuf); self->tempbuf = NULL; Py_XDECREF(self->fileobj); self->fileobj = NULL; } static void obexserver_incomingrequest(OBEXServer *self, obex_object_t *obj, int obex_cmd) { self->notifiednewrequest = 0; self->hasbodydata = 0; Py_XDECREF(self->tempbuf); Py_XDECREF(self->fileobj); // signal we want to stream body data if (obex_cmd == OBEX_CMD_PUT) { if (OBEX_ObjectReadStream(self->obex, obj, NULL) < 0) { DEBUG("\tUnable to stream body data\n"); OBEX_ObjectSetRsp(obj, OBEX_RSP_INTERNAL_SERVER_ERROR, OBEX_RSP_INTERNAL_SERVER_ERROR); return; } } OBEX_ObjectSetRsp(obj, OBEX_RSP_CONTINUE, OBEX_RSP_SUCCESS); #ifdef LIGHTBLUEOBEX_SERVER_TEST self->puttotal = 0; #endif } /* can this be static? */ void obexserver_event(obex_t *handle, obex_object_t *obj, int mode, int event, int obex_cmd, int obex_rsp) { DEBUG("%s()\n", __func__); DEBUG("\tEvent: %d Command: %d\n", event, obex_cmd); OBEXServer *self = (OBEXServer *)OBEX_GetUserData(handle); switch (event) { case OBEX_EV_LINKERR: case OBEX_EV_PARSEERR: DEBUG("\tOBEX_EV_LINKERR or OBEX_EV_PARSEERR\n"); obexserver_errorstr(self, PyExc_IOError, (event == OBEX_EV_LINKERR ? "connection error" : "parse error")); break; case OBEX_EV_REQHINT: DEBUG("\tOBEX_EV_REQHINT\n"); obexserver_incomingrequest(self, obj, obex_cmd); break; case OBEX_EV_REQ: DEBUG("\tOBEX_EV_REQ\n"); obexserver_receivedrequest(self, obj, obex_cmd); break; case OBEX_EV_STREAMAVAIL: DEBUG("\tOBEX_EV_STREAMAVAIL\n"); obexserver_streamavailable(self, obj); break; case OBEX_EV_STREAMEMPTY: DEBUG("\tOBEX_EV_STREAMEMPTY\n"); obexserver_streamempty(self, obj); break; case OBEX_EV_REQDONE: DEBUG("\tOBEX_EV_REQDONE\n"); obexserver_requestdone(self, obj, obex_cmd); break; default: DEBUG("\tNot handling event\n"); break; } } static PyObject * OBEXServer_process(OBEXServer *self, PyObject *args) { int timeout; int result; DEBUG("%s()\n", __func__); if (!PyArg_ParseTuple(args, "i", &timeout)) return NULL; result = OBEX_HandleInput(self->obex, timeout); return PyInt_FromLong(result); } PyDoc_STRVAR(OBEXServer_process__doc__, "process(timeout) -> result\n\n\ Processes and reads incoming data with the given timeout (in seconds). \ Blocks if no data is available. Returns -1 on error and 0 on timeout."); static PyObject * OBEXServer_new(PyTypeObject *type, PyObject *args, PyObject *kwds) { OBEXServer *self; self = (OBEXServer *)type->tp_alloc(type, 0); if (self != NULL) { self->obex = NULL; self->sendbufsize = 1024; self->cb_error = NULL; self->cb_newrequest = NULL; self->cb_requestdone = NULL; self->notifiednewrequest = 0; self->hasbodydata = 0; self->fileobj = NULL; self->tempbuf = NULL; } return (PyObject *)self; } static int OBEXServer_init(OBEXServer *self, PyObject *args) { int fd; PyObject *cb_error; PyObject *cb_newrequest; PyObject *cb_requestdone; int mtu = 1024; /* todo make this a keyword arg */ if (!PyArg_ParseTuple(args, "iOOO", &fd, &cb_error, &cb_newrequest, &cb_requestdone)) { return -1; } if (!PyCallable_Check(cb_error) || !PyCallable_Check(cb_newrequest) || !PyCallable_Check(cb_requestdone)) { PyErr_SetString(PyExc_TypeError, "given callback is not callable"); return -1; } if (self->cb_error == NULL) { Py_INCREF(cb_error); self->cb_error = cb_error; } if (self->cb_newrequest == NULL) { Py_INCREF(cb_newrequest); self->cb_newrequest = cb_newrequest; } if (self->cb_requestdone == NULL) { Py_INCREF(cb_requestdone); self->cb_requestdone = cb_requestdone; } if (self->obex == NULL) { self->obex = OBEX_Init(OBEX_TRANS_FD, obexserver_event, 0); if (self->obex == NULL) { PyErr_SetString(PyExc_IOError, "error creating OBEX object"); return -1; } if (FdOBEX_TransportSetup(self->obex, fd, fd, mtu) < 0) { PyErr_SetString(PyExc_IOError, "error initialising transport"); return -1; } } OBEX_SetUserData(self->obex, self); return 0; } static void OBEXServer_dealloc(OBEXServer *self) { if (self->obex) OBEX_Cleanup(self->obex); Py_XDECREF(self->fileobj); Py_XDECREF(self->tempbuf); self->ob_type->tp_free((PyObject *)self); } static PyMemberDef OBEXServer_members[] = { {NULL} /* Sentinel */ }; static PyMethodDef OBEXServer_methods[] = { { "process", (PyCFunction)OBEXServer_process, METH_VARARGS, OBEXServer_process__doc__, }, {NULL} /* Sentinel */ }; static PyTypeObject OBEXServerType = { PyObject_HEAD_INIT(NULL) 0, /*ob_size*/ "obexserver.OBEXServer", /*tp_name*/ sizeof(OBEXServer), /*tp_basicsize*/ 0, /*tp_itemsize*/ (destructor)OBEXServer_dealloc, /*tp_dealloc*/ 0, /*tp_print*/ 0, /*tp_getattr*/ 0, /*tp_setattr*/ 0, /*tp_compare*/ 0, /*tp_repr*/ 0, /*tp_as_number*/ 0, /*tp_as_sequence*/ 0, /*tp_as_mapping*/ 0, /*tp_hash */ 0, /*tp_call*/ 0, /*tp_str*/ 0, /*tp_getattro*/ 0, /*tp_setattro*/ 0, /*tp_as_buffer*/ Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE, /*tp_flags*/ "An OBEX server class.", /* tp_doc */ 0, /* tp_traverse */ 0, /* tp_clear */ 0, /* tp_richcompare */ 0, /* tp_weaklistoffset */ 0, /* tp_iter */ 0, /* tp_iternext */ OBEXServer_methods, /* tp_methods */ OBEXServer_members, /* tp_members */ 0, /* tp_getset */ 0, /* tp_base */ 0, /* tp_dict */ 0, /* tp_descr_get */ 0, /* tp_descr_set */ 0, /* tp_dictoffset */ (initproc)OBEXServer_init, /* tp_init */ 0, /* tp_alloc */ OBEXServer_new, /* tp_new */ }; PyTypeObject *lightblueobex_getservertype(void) { return &OBEXServerType; } lightblue-0.3.2/src/linux/._lightblueobex_server.h 0000644 0000765 0000000 00000000122 10717031044 022067 0 ustar bea wheel 0000000 0000000 Mac OS X 2 R TEXT!Rch lightblue-0.3.2/src/linux/lightblueobex_server.h 0000644 0000765 0000765 00000000216 10717031044 021323 0 ustar bea bea 0000000 0000000 #ifndef LIGHTBLUEOBEX_SERVER_H #define LIGHTBLUEOBEX_SERVER_H #include "Python.h" PyTypeObject *lightblueobex_getservertype(void); #endif lightblue-0.3.2/src/linux/._obex.py 0000644 0000765 0000000 00000000122 10750744236 017015 0 ustar bea wheel 0000000 0000000 Mac OS X 2 R TEXT lightblue-0.3.2/src/linux/obex.py 0000644 0000765 0000765 00000007352 10750744236 016261 0 ustar bea bea 0000000 0000000 # Copyright (c) 2006 Bea Lam. All rights reserved. # # Permission is hereby granted, free of charge, to any person # obtaining a copy of this software and associated documentation files # (the "Software"), to deal in the Software without restriction, # including without limitation the rights to use, copy, modify, merge, # publish, distribute, sublicense, and/or sell copies of the Software, # and to permit persons to whom the Software is furnished to do so, # subject to the following conditions: # # The above copyright notice and this permission notice shall be # included in all copies or substantial portions of the Software. # # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, # EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF # MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. # IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY # CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, # TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE # SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. """ Provides an OBEX client class and convenience functions for sending and receiving files over OBEX. This module also defines constants for response code values (without the final bit set). For example: >>> import lightblue >>> lightblue.obex.OK 32 # the OK/Success response 0x20 (i.e. 0xA0 without the final bit) >>> lightblue.obex.FORBIDDEN 67 # the Forbidden response 0x43 (i.e. 0xC3 without the final bit) """ # Docstrings for attributes in this module. _docstrings = { "sendfile": """ Sends a file to a remote device. Raises lightblue.obex.OBEXError if an error occurred during the request, or if the request was refused by the remote device. Arguments: - address: the address of the remote device - channel: the RFCOMM channel of the remote OBEX service - source: a filename or file-like object, containing the data to be sent. If a file object is given, it must be opened for reading. Note you can achieve the same thing using OBEXClient with something like this: >>> import lightblue >>> client = lightblue.obex.OBEXClient(address, channel) >>> client.connect() >>> putresponse = client.put({"name": "MyFile.txt"}, file("MyFile.txt", 'rb')) >>> client.disconnect() >>> if putresponse.code != lightblue.obex.OK: ... raise lightblue.obex.OBEXError("server denied the Put request") >>> """, "recvfile": """ Receives a file through an OBEX service. Arguments: - sock: the server socket on which the file is to be received. Note this socket must *not* be listening. Also, an OBEX service should have been advertised on this socket. - dest: a filename or file-like object, to which the received data will be written. If a filename is given, any existing file will be overwritten. If a file object is given, it must be opened for writing. For example, to receive a file and save it as "MyFile.txt": >>> from lightblue import * >>> s = socket() >>> s.bind(("", 0)) >>> advertise("My OBEX Service", s, OBEX) >>> obex.recvfile(s, "MyFile.txt") """ } # import implementation modules from _obex import * from _obexcommon import * import _obex import _obexcommon __all__ = _obex.__all__ + _obexcommon.__all__ # set docstrings localattrs = locals() for attr in _obex.__all__: try: localattrs[attr].__doc__ = _docstrings[attr] except KeyError: pass del attr, localattrs lightblue-0.3.2/src/mac/ 0000755 0000765 0000765 00000000000 10770565177 014353 5 ustar bea bea 0000000 0000000 lightblue-0.3.2/src/mac/.___init__.py 0000755 0000765 0000000 00000000122 10767432712 017224 0 ustar bea wheel 0000000 0000000 Mac OS X 2 R TEXT lightblue-0.3.2/src/mac/__init__.py 0000755 0000765 0000765 00000015152 10767432712 016465 0 ustar bea bea 0000000 0000000 # Copyright (c) 2006 Bea Lam. All rights reserved. # # Permission is hereby granted, free of charge, to any person # obtaining a copy of this software and associated documentation files # (the "Software"), to deal in the Software without restriction, # including without limitation the rights to use, copy, modify, merge, # publish, distribute, sublicense, and/or sell copies of the Software, # and to permit persons to whom the Software is furnished to do so, # subject to the following conditions: # # The above copyright notice and this permission notice shall be # included in all copies or substantial portions of the Software. # # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, # EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF # MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. # IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY # CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, # TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE # SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. "LightBlue - a simple bluetooth library." # Docstrings for attributes in this module. _docstrings = { "finddevices": """ Performs a device discovery and returns the found devices as a list of (address, name, class-of-device) tuples. Raises BluetoothError if an error occurs. Arguments: - getnames=True: True if device names should be retrieved during discovery. If false, None will be returned instead of the device name. - length=10: the number of seconds to spend discovering devices (this argument has no effect on Python for Series 60) Do not invoke a new discovery before a previous discovery has finished. Also, to minimise interference with other wireless and bluetooth traffic, and to conserve battery power on the local device, discoveries should not be invoked too frequently (an interval of at least 20 seconds is recommended). """, "findservices": """ Performs a service discovery and returns the found services as a list of (device-address, service-port, service-name) tuples. Raises BluetoothError if an error occurs. Arguments: - addr=None: a device address, to search only for services on a specific device - name=None: a service name string, to search only for a service with a specific name - servicetype=None: can be RFCOMM or OBEX to search only for RFCOMM or OBEX-type services. (OBEX services are not returned from an RFCOMM search) If more than one criteria is specified, this returns services that match all criteria. Currently the Python for Series 60 implementation will only find RFCOMM and OBEX services. """, "finddevicename": """ Returns the name of the device with the given bluetooth address. finddevicename(gethostaddr()) returns the local device name. Arguments: - address: the address of the device to look up - usecache=True: if True, the device name will be fetched from a local cache if possible. If False, or if the device name is not in the cache, the remote device will be contacted to request its name. Raise BluetoothError if the name cannot be retrieved. """, "gethostaddr": """ Returns the address of the local bluetooth device. Raise BluetoothError if the local device is not available. """, "gethostclass": """ Returns the class of device of the local bluetooth device. These values indicate the device's major services and the type of the device (e.g. mobile phone, laptop, etc.). If you google for "assigned numbers bluetooth baseband" you might find some documents that discuss how to extract this information from the class of device. Raise BluetoothError if the local device is not available. """, "socket": """ socket(proto=RFCOMM) -> socket object Returns a new socket object. Arguments: - proto=RFCOMM: the type of socket to be created - either L2CAP or RFCOMM. Note that L2CAP sockets are not available on Python For Series 60, and only L2CAP client sockets are supported on Mac OS X and Linux (i.e. you can connect() the socket but not bind(), accept(), etc.). """, "advertise": """ Starts advertising a service with the given name, using the given server socket. Raises BluetoothError if the service cannot be advertised. Arguments: - name: name of the service to be advertised - sock: the socket object that will serve this service. The socket must be already bound to a channel. If a RFCOMM service is being advertised, the socket should also be listening. - servicetype: the type of service to advertise - either RFCOMM or OBEX. (L2CAP services are not currently supported.) (If the servicetype is RFCOMM, the service will be advertised with the Serial Port Profile; if the servicetype is OBEX, the service will be advertised with the OBEX Object Push Profile.) """, "stopadvertise": """ Stops advertising the service on the given socket. Raises BluetoothError if no service is advertised on the socket. This will error if the given socket is already closed. """, "selectdevice": """ Displays a GUI which allows the end user to select a device from a list of discovered devices. Returns the selected device as an (address, name, class-of-device) tuple. Returns None if the selection was cancelled. (On Python For Series 60, the device selection will fail if there are any open bluetooth connections.) """, "selectservice": """ Displays a GUI which allows the end user to select a service from a list of discovered devices and their services. Returns the selected service as a (device-address, service-port, service- name) tuple. Returns None if the selection was cancelled. (On Python For Series 60, the device selection will fail if there are any open bluetooth connections.) Currently the Python for Series 60 implementation will only find RFCOMM and OBEX services. """ } # import implementation modules from _lightblue import * from _lightbluecommon import * import obex # plus submodule # set docstrings import _lightblue localattrs = locals() for attr in _lightblue.__all__: try: localattrs[attr].__doc__ = _docstrings[attr] except KeyError: pass del attr, localattrs lightblue-0.3.2/src/mac/.__bluetoothsockets.py 0000755 0000765 0000000 00000000122 10750613031 021210 0 ustar bea wheel 0000000 0000000 Mac OS X 2 R TEXT lightblue-0.3.2/src/mac/_bluetoothsockets.py 0000755 0000765 0000000 00000110265 10750613031 021005 0 ustar bea wheel 0000000 0000000 # Copyright (c) 2006 Bea Lam. All rights reserved. # # Permission is hereby granted, free of charge, to any person # obtaining a copy of this software and associated documentation files # (the "Software"), to deal in the Software without restriction, # including without limitation the rights to use, copy, modify, merge, # publish, distribute, sublicense, and/or sell copies of the Software, # and to permit persons to whom the Software is furnished to do so, # subject to the following conditions: # # The above copyright notice and this permission notice shall be # included in all copies or substantial portions of the Software. # # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, # EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF # MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. # IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY # CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, # TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE # SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. # Mac OS X bluetooth sockets implementation. # # To-do: # - allow socket options # # if doing security AUTH, should set bool arg when calling # openConnection_withPageTimeout_authenticationRequired_() in connect() import time import socket as _socket import threading import os import errno import types import objc import Foundation import _IOBluetooth import _lightbluecommon import _macutil from _LightAquaBlue import BBServiceAdvertiser, BBBluetoothChannelDelegate import sets # python 2.3 try: SHUT_RD, SHUT_WR, SHUT_RDWR = \ _socket.SHUT_RD, _socket.SHUT_WR, _socket.SHUT_RDWR except AttributeError: # python 2.3 SHUT_RD, SHUT_WR, SHUT_RDWR = (0, 1, 2) def _getavailableport(proto): # Just advertise a service and see what channel it was assigned, then # stop advertising the service and return the channel. # It's a hacky way of doing it, but IOBluetooth doesn't seem to provide # functionality for just getting an available channel. if proto == _lightbluecommon.RFCOMM: try: result, channelID, servicerecordhandle = BBServiceAdvertiser.addRFCOMMServiceDictionary_withName_UUID_channelID_serviceRecordHandle_(BBServiceAdvertiser.serialPortProfileDictionary(), "DummyService", None, None, None) except: result, channelID, servicerecordhandle = BBServiceAdvertiser.addRFCOMMServiceDictionary_withName_UUID_channelID_serviceRecordHandle_(BBServiceAdvertiser.serialPortProfileDictionary(), "DummyService", None) if result != _macutil.kIOReturnSuccess: raise _lightbluecommon.BluetoothError(result, \ "Could not retrieve an available service channel") result = BBServiceAdvertiser.removeService_(servicerecordhandle) if result != _macutil.kIOReturnSuccess: raise _lightbluecommon.BluetoothError(result, \ "Could not retrieve an available service channel") return channelID else: raise NotImplementedError("L2CAP server sockets not currently supported") def _checkaddrpair(address, checkbtaddr=True): # will want checkbtaddr=False if the address might be empty string # (for binding to a server address) if not isinstance(address, tuple): raise TypeError("address must be (address, port) tuple, was %s" % \ type(address)) if len(address) != 2: raise TypeError("address tuple must have 2 items (has %d)" % \ len(address)) if not isinstance(address[0], types.StringTypes): raise TypeError("address host value must be string, was %s" % \ type(address[0])) if checkbtaddr: if not _lightbluecommon._isbtaddr(address[0]): raise TypeError("address '%s' is not a bluetooth address" % \ address[0]) if not isinstance(address[1], int): raise TypeError("address port value must be int, was %s" % \ type(address[1])) # from std lib socket module class _closedsocket(object): __slots__ = [] def _dummy(*args): raise _socket.error(errno.EBADF, 'Bad file descriptor') send = recv = sendto = recvfrom = __getattr__ = _dummy # Thanks to Simon Wittber for string queue recipe # http://aspn.activestate.com/ASPN/Cookbook/Python/Recipe/426060 # (this is a modified version) class _StringQueue(object): def __init__(self): self.l_buffer = [] self.s_buffer = "" self.lock = threading.RLock() self.bufempty = True def empty(self): return self.bufempty def write(self, data): # no type check, and assumes data is not empty! #append data to list, no need to "".join just yet. self.lock.acquire() try: self.l_buffer.append(data) self.bufempty = False finally: self.lock.release() def _build_str(self): #build a new string out of list new_string = "".join(self.l_buffer) #join string buffer and new string self.s_buffer = "".join((self.s_buffer, new_string)) #clear list self.l_buffer = [] def __len__(self): #calculate length without needing to _build_str return sum([len(i) for i in self.l_buffer]) + len(self.s_buffer) def read(self, count): self.lock.acquire() try: #if string doesn't have enough chars to satisfy caller if count > len(self.s_buffer): self._build_str() #get data requested by caller result = self.s_buffer[:count] #remove requested data from string buffer self.s_buffer = self.s_buffer[len(result):] self.bufempty = (len(self.s_buffer) == 0) finally: self.lock.release() return result #class _SocketWrapper(_socket._socketobject): class _SocketWrapper(object): """ A Bluetooth socket object has the same interface as a socket object from the Python standard library module. It also uses the same exceptions, raising socket.error for general errors and socket.timeout for timeout errors. Note that L2CAP sockets are not available on Python For Series 60, and only L2CAP client sockets are supported on Mac OS X and Linux. A simple client socket example: >>> from lightblue import * >>> s = socket() # or socket(L2CAP) to create an L2CAP socket >>> s.connect(("00:12:2c:45:8a:7b", 5)) >>> s.send("hello") 5 >>> s.close() A simple server socket example: >>> from lightblue import * >>> s = socket() >>> s.bind(("", 0)) >>> s.listen(1) >>> advertise("My RFCOMM Service", s, RFCOMM) >>> conn, addr = s.accept() >>> print "Connected by", addr Connected by ('00:0D:93:19:C8:68', 5) >>> conn.recv(1024) "hello" >>> conn.close() >>> s.close() """ def __init__(self, sock): self._sock = sock def accept(self): sock, addr = self._sock.accept() return _SocketWrapper(sock), addr accept.__doc__ = _lightbluecommon._socketdocs["accept"] def dup(self): return _SocketWrapper(self._sock) dup.__doc__ = _lightbluecommon._socketdocs["dup"] def close(self): self._sock.close() self._sock = _closedsocket() self.send = self.recv = self.sendto = self.recvfrom = self._sock._dummy try: import lightblue lightblue.stopadvertise(self) except: pass close.__doc__ = _lightbluecommon._socketdocs["close"] def makefile(self, mode='r', bufsize=-1): # use std lib socket's _fileobject return _socket._fileobject(self._sock, mode, bufsize) makefile.__doc__ = _lightbluecommon._socketdocs["makefile"] # delegate all other method calls to internal sock obj def __getattr__(self, attr): return getattr(self._sock, attr) # internal _sock object for RFCOMM and L2CAP sockets class _BluetoothSocket(object): _boundports = { _lightbluecommon.L2CAP: sets.Set(), _lightbluecommon.RFCOMM: sets.Set() } # conn is the associated _RFCOMMConnection or _L2CAPConnection def __init__(self, conn): self.__conn = conn if conn is not None and conn.channel is not None: self.__remotedevice = conn.channel.getDevice() else: self.__remotedevice = None # timeout=None cos sockets default to blocking mode self.__timeout = None #self.__isserverspawned = (conn.channel is not None) self.__port = 0 self.__eventlistener = None self.__closed = False self.__maxqueuedconns = 0 self.__incomingdata = _StringQueue() self.__queuedchannels = [] self.__queuedchannels_lock = threading.RLock() # whether send or recv has been shut down # set initial value to be other than SHUT_WR/SHUT_RD/SHUT_RDWR self.__commstate = -1 def accept(self): if not self.__isbound(): raise _socket.error('Socket not bound') if not self.__islistening(): raise _socket.error('Socket must be listening first') def clientconnected(): return len(self.__queuedchannels) > 0 if not clientconnected(): self.__waituntil(clientconnected, "accept timed out") self.__queuedchannels_lock.acquire() try: newchannel = self.__queuedchannels.pop(0) finally: self.__queuedchannels_lock.release() # return (new-socket, addr) pair using the new channel newconn = _SOCKET_CLASSES[self.__conn.proto](newchannel) sock = _SocketWrapper(_BluetoothSocket(newconn)) sock.__startevents() return (sock, sock.getpeername()) def bind(self, address): _checkaddrpair(address, False) if self.__isbound(): raise _socket.error('Socket is already bound') elif self.__isconnected(): raise _socket.error("Socket is already connected, cannot be bound") if self.__conn.proto == _lightbluecommon.L2CAP: raise NotImplementedError("L2CAP server sockets not currently supported") if address[1] != 0: raise _socket.error("must bind to port 0, other ports not supported on Mac OS X") address = (address[0], _getavailableport(self.__conn.proto)) # address must be either empty string or local device address if address[0] != "": try: import lightblue localaddr = lightblue.gethostaddr() except: localaddr = None if localaddr is None or address[0] != localaddr: raise _socket.error( errno.EADDRNOTAVAIL, os.strerror(errno.EADDRNOTAVAIL)) # is this port already in use? if address[1] in self._boundports[self.__conn.proto]: raise _socket.error(errno.EADDRINUSE, os.strerror(errno.EADDRINUSE)) self._boundports[self.__conn.proto].add(address[1]) self.__port = address[1] def close(self): wasconnected = self.__isconnected() or self.__isbound() self.__stopevents() if self.__conn is not None: if self.__isbound(): self._boundports[self.__conn.proto].discard(self.__port) else: if self.__conn.channel is not None: self.__conn.channel.setDelegate_(None) self.__conn.channel.closeChannel() # disconnect the baseband connection. # This will fail if other RFCOMM channels to the remote device are # still open (which is what we want, cos we don't know if another # process is talking to the device) if self.__remotedevice is not None: self.__remotedevice.closeConnection() # returns err code # if you don't run the event loop a little here, it's likely you won't # be able to reconnect to the same remote device later if wasconnected: _macutil.waitfor(0.5) def connect(self, address): if self.__isbound(): raise _socket.error("Can't connect, socket has been bound") elif self.__isconnected(): raise _socket.error("Socket is already connected") _checkaddrpair(address) # open a connection to device self.__remotedevice = _IOBluetooth.IOBluetoothDevice.withAddress_( _macutil.createbtdevaddr(address[0])) if not self.__remotedevice.isConnected(): if self.__timeout is None: result = self.__remotedevice.openConnection() else: result = self.__remotedevice.openConnection_withPageTimeout_authenticationRequired_( None, self.__timeout*1000, False) if result != _macutil.kIOReturnSuccess: if result == _macutil.kBluetoothHCIErrorPageTimeout: if self.__timeout == 0: raise _socket.error(errno.EAGAIN, "Resource temporarily unavailable") else: raise _socket.timeout("connect timed out") else: raise _socket.error(result, "Cannot connect to %s, can't open connection." \ % str(address[0])) # open RFCOMM or L2CAP channel self.__eventlistener = self.__createlistener() result = self.__conn.connect(self.__remotedevice, address[1], self.__eventlistener) # pass listener as cocoa delegate if result != _macutil.kIOReturnSuccess: self.__remotedevice.closeConnection() self.__stopevents() self.__eventlistener = None raise _socket.error(result, "Cannot connect to %d on %s" % (address[1], address[0])) return # if you don't run the event loop a little here, it's likely you won't # be able to reconnect to the same remote device later _macutil.waitfor(0.5) def connect_ex(self, address): try: self.connect(address) except _socket.error, err: if len(err.args) > 1: return err.args[0] else: # there's no error code, just a message, so this error wasn't # from a system call -- so re-raise the exception raise _socket.error(err) return 0 def getpeername(self): self.__checkconnected() addr = _macutil.formatdevaddr(self.__remotedevice.getAddressString()) return (addr, self._getport()) def getsockname(self): if self.__isbound() or self.__isconnected(): import lightblue return (lightblue.gethostaddr(), self._getport()) else: return ("00:00:00:00:00:00", 0) def listen(self, backlog): if self.__islistening(): return if not self.__isbound(): raise _socket.error('Socket not bound') if not isinstance(backlog, int): raise TypeError("backlog must be int, was %s" % type(backlog)) if backlog < 0: raise ValueError("backlog cannot be negative, was %d" % backlog) self.__maxqueuedconns = backlog # start listening for client connections self.__startevents() def _isclosed(self): # isOpen() check doesn't work for incoming (server-spawned) channels if (self.__conn.proto == _lightbluecommon.RFCOMM and self.__conn.channel is not None and not self.__conn.channel.isIncoming()): return not self.__conn.channel.isOpen() return self.__closed def recv(self, bufsize, flags=0): if self.__commstate in (SHUT_RD, SHUT_RDWR): return "" self.__checkconnected() if not isinstance(bufsize, int): raise TypeError("buffer size must be int, was %s" % type(bufsize)) if bufsize < 0: raise ValueError("negative buffersize in recv") # as for tcp if bufsize == 0: return "" # need this to ensure the _isclosed() check is up-to-date _macutil.looponce() if self._isclosed(): if len(self.__incomingdata) == 0: raise _socket.error(errno.ECONNRESET, os.strerror(errno.ECONNRESET)) return self.__incomingdata.read(bufsize) # if incoming data buffer is empty, wait until data is available or # channel is closed def gotdata(): return not self.__incomingdata.empty() or self._isclosed() if not gotdata(): self.__waituntil(gotdata, "recv timed out") # other side closed connection while waiting? if self._isclosed() and len(self.__incomingdata) == 0: raise _socket.error(errno.ECONNRESET, os.strerror(errno.ECONNRESET)) return self.__incomingdata.read(bufsize) # recvfrom() is really for datagram sockets not stream sockets but it # can be implemented anyway. def recvfrom(self, bufsize, flags=0): # stream sockets return None, instead of address return (self.recv(bufsize, flags), None) def sendall(self, data, flags=0): sentbytescount = self.send(data, flags) while sentbytescount < len(data): sentbytescount += self.send(data[sentbytescount:], flags) return None def send(self, data, flags=0): if not isinstance(data, types.StringTypes): raise TypeError("data must be string, was %s" % type(data)) if self.__commstate in (SHUT_WR, SHUT_RDWR): raise _socket.error(errno.EPIPE, os.strerror(errno.EPIPE)) self.__checkconnected() # do setup for if sock is in non-blocking mode if self.__timeout is not None: if self.__timeout == 0: # in non-blocking mode # isTransmissionPaused() is not available for L2CAP sockets, # what to do for that? if self.__conn.proto == _lightbluecommon.RFCOMM and \ self.__conn.channel.isTransmissionPaused(): # sending data now will block raise _socket.error(errno.EAGAIN, "Resource temporarily unavailable") elif self.__timeout > 0: # non-blocking with timeout starttime = time.time() # loop until all data is sent writebuf = data bytesleft = len(data) mtu = self.__conn.getwritemtu() while bytesleft > 0: if self.__timeout is not None and self.__timeout > 0: if time.time() - starttime > self.__timeout: raise _socket.timeout("send timed out") # write the data to the channel (only the allowed amount) # the method/selector is the same for L2CAP and RFCOMM channels if bytesleft > mtu: sendbytecount = mtu else: sendbytecount = bytesleft #result = self.__conn.channel.writeSync_length_( # writebuf[:sendbytecount], sendbytecount) result = self.__conn.write(writebuf[:sendbytecount]) # normal tcp sockets don't seem to actually error on the first # send() after a connection has broken; if you try a second time, # then you get the (32, 'Broken pipe') socket.error if result != _macutil.kIOReturnSuccess: raise _socket.error(result, "Error sending data") bytesleft -= sendbytecount writebuf = writebuf[sendbytecount:] # remove the data just sent return len(data) - bytesleft # sendto args may be one of: # - data, address # - data, flags, address # # The standard behaviour seems to be to ignore the given address if already # connected. # sendto() is really for datagram sockets not stream sockets but it # can be implemented anyway. def sendto(self, data, *args): if len(args) == 1: address = args[0] flags = 0 elif len(args) == 2: flags, address = args else: raise TypeError("sendto takes at most 3 arguments (%d given)" % \ (len(args) + 1)) _checkaddrpair(address) # must already be connected, cos this is stream socket self.__checkconnected() return self.send(data, flags) def fileno(self): raise NotImplementedError def getsockopt(self, level, optname, buflen=0): # see what options on Linux+s60 # possibly have socket security option. raise _socket.error( errno.ENOPROTOOPT, os.strerror(errno.ENOPROTOOPT)) def setsockopt(self, level, optname, value): # see what options on Linux+s60 # possibly have socket security option. raise _socket.error( errno.ENOPROTOOPT, os.strerror(errno.ENOPROTOOPT)) def setblocking(self, flag): if flag == 0: self.__timeout = 0 # non-blocking else: self.__timeout = None # blocking def gettimeout(self): return self.__timeout def settimeout(self, value): if value is not None and not isinstance(value, (float, int)): msg = "timeout value must be a number or None, was %s" % \ type(value) raise TypeError(msg) if value < 0: msg = "timeout value cannot be negative, was %d" % value raise ValueError(msg) self.__timeout = value def shutdown(self, how): if how not in (SHUT_RD, SHUT_WR, SHUT_RDWR): raise _socket.error(22, "Invalid argument") self.__commstate = how # This method is called from outside this file. def _getport(self): if self.__isconnected(): return self.__conn.getport() if self.__isbound(): return self.__port raise _lightbluecommon.BluetoothError("socket is neither connected nor bound") # This method is called from outside this file. def _getchannel(self): if self.__conn is None: return None return self.__conn.channel # Called by the event listener when data is available # 'channel' is IOBluetoothRFCOMMChannel or IOBluetoothL2CAPChannel object def _handle_channeldata(self, channel, data): self.__incomingdata.write(data) _macutil.interruptwait() # Called by the event listener when a client connects to a server socket def _handle_channelopened(self, channel): # put new channels into a queue, which 'accept' can then pull out self.__queuedchannels_lock.acquire() try: # need to implement max connections #if len(self.__queuedchannels) < self.__maxqueuedconns: self.__queuedchannels.append(channel) _macutil.interruptwait() finally: self.__queuedchannels_lock.release() # Called by the event listener when the channel is closed. def _handle_channelclosed(self, channel): # beware that this value won't actually be set until the event loop # has been driven so that this method is actually called self.__closed = True _macutil.interruptwait() def __waituntil(self, stopwaiting, timeoutmsg): """ Waits until stopwaiting() returns True, or until the wait times out (according to the self.__timeout value). This is to make a function wait until a buffer has been filled. i.e. stopwaiting() should return True when the buffer is no longer empty. """ if not stopwaiting(): if self.__timeout == 0: # in non-blocking mode (immediate timeout) # push event loop to really be sure there is no data available _macutil.looponce() if not stopwaiting(): # trying to perform operation now would block raise _socket.error(errno.EAGAIN, os.strerror(errno.EAGAIN)) else: # block and wait until we get data, or time out if not _macutil.waituntil(stopwaiting, self.__timeout): raise _socket.timeout(timeoutmsg) def __createlistener(self): if self.__isbound(): return _ChannelServerEventListener.alloc().initWithDelegate_port_protocol_(self, self._getport(), self.__conn.proto) else: listener = _ChannelEventListener.alloc().initWithDelegate_(self) if self.__conn.channel is not None: self.__conn.channel.setDelegate_(listener.delegate()) listener.registerclosenotif(self.__conn.channel) return listener # should not call this if connect() has been called to connect this socket def __startevents(self): if self.__eventlistener is not None: raise _lightbluecommon.BluetoothError("socket already listening") self.__eventlistener = self.__createlistener() def __stopevents(self): if self.__eventlistener is not None: self.__eventlistener.close() def __islistening(self): return self.__eventlistener is not None def __checkconnected(self): if not self._sock.isconnected(): # i.e. is connected, non-server socket # not connected, raise "socket not connected" raise _socket.error(errno.ENOTCONN, os.strerror(errno.ENOTCONN)) # returns whether socket is a bound server socket def __isbound(self): return self.__port != 0 def __isconnected(self): return self.__conn.channel is not None def __checkconnected(self): if not self.__isconnected(): # not connected, raise "socket not connected" raise _socket.error(errno.ENOTCONN, os.strerror(errno.ENOTCONN)) # set method docstrings definedmethods = locals() # i.e. defined methods in _SocketWrapper for name, doc in _lightbluecommon._socketdocs.items(): try: definedmethods[name].__doc__ = doc except KeyError: pass class _RFCOMMConnection(object): proto = _lightbluecommon.RFCOMM def __init__(self, channel=None): # self.channel is accessed by _BluetoothSocket parent self.channel = channel def connect(self, device, port, listener): # open RFCOMM channel (should timeout actually apply to opening of # channel as well? if so need to do timeout with async callbacks) try: # pyobjc 2.0 result, self.channel = device.openRFCOMMChannelSync_withChannelID_delegate_(None, port, listener.delegate()) except TypeError: result, self.channel = device.openRFCOMMChannelSync_withChannelID_delegate_(port, listener.delegate()) if result == _macutil.kIOReturnSuccess: self.channel.setDelegate_(listener.delegate()) listener.registerclosenotif(self.channel) else: self.channel = None return result def write(self, data): if self.channel is None: raise _socket.error("socket not connected") return \ BBBluetoothChannelDelegate.synchronouslyWriteData_toRFCOMMChannel_( buffer(data), self.channel) def getwritemtu(self): return self.channel.getMTU() def getport(self): return self.channel.getChannelID() class _L2CAPConnection(object): proto = _lightbluecommon.L2CAP def __init__(self, channel=None): # self.channel is accessed by _BluetoothSocket parent self.channel = channel def connect(self, device, port, listener): try: # pyobjc 2.0 result, self.channel = device.openL2CAPChannelSync_withPSM_delegate_(None, port, listener.delegate()) except TypeError: result, self.channel = device.openL2CAPChannelSync_withPSM_delegate_(port, listener.delegate()) if result == _macutil.kIOReturnSuccess: self.channel.setDelegate_(listener.delegate()) listener.registerclosenotif(self.channel) else: self.channel = None return result def write(self, data): if self.channel is None: raise _socket.error("socket not connected") return \ BBBluetoothChannelDelegate.synchronouslyWriteData_toL2CAPChannel_( buffer(data), self.channel) def getwritemtu(self): return self.channel.getOutgoingMTU() def getport(self): return self.channel.getPSM() class _ChannelEventListener(Foundation.NSObject): """ Uses a BBBluetoothChannelDelegate to listen for events on an IOBluetoothRFCOMMChannel or IOBluetoothL2CAPChannel, and makes callbacks to a specified object when events occur. """ # note this is a NSObject "init", not a python object "__init__" def initWithDelegate_(self, cb_obj): """ Arguments: - cb_obj: An object that receives callbacks when events occur. This object should have: - a method '_handle_channeldata' which takes the related channel (a IOBluetoothRFCOMMChannel or IOBluetoothL2CAPChannel) and the new data (a string) as the arguments. - a method '_handle_channelclosed' which takes the related channel as the argument. If this listener's delegate is passed to the openRFCOMMChannel... or openL2CAPChannel... selectors as the delegate, the delegate (and therefore this listener) will automatically start receiving events. Otherwise, call setDelegate_() on the channel with this listener's delegate as the argument to allow this listener to start receiving channel events. (This is the only option for server-spawned sockets.) """ self = super(_ChannelEventListener, self).init() if cb_obj is None: raise TypeError("callback object is None") self.__cb_obj = cb_obj self.__closenotif = None self.__channelDelegate = \ BBBluetoothChannelDelegate.alloc().initWithDelegate_(self) return self initWithDelegate_ = objc.selector(initWithDelegate_, signature="@@:@") def delegate(self): return self.__channelDelegate def registerclosenotif(self, channel): # oddly enough, sometimes the channelClosed: selector doesn't get called # (maybe if there's a lot of data being passed?) but this seems to work notif = channel.registerForChannelCloseNotification_selector_(self, "channelClosedEvent:channel:") if notif is not None: self.__closenotif = notif def close(self): if self.__closenotif is not None: self.__closenotif.unregister() def channelClosedEvent_channel_(self, notif, channel): if hasattr(self.__cb_obj, '_handle_channelclosed'): self.__cb_obj._handle_channelclosed(channel) channelClosedEvent_channel_ = objc.selector( channelClosedEvent_channel_, signature="v@:@@") # implement method from BBBluetoothChannelDelegateObserver protocol: # - (void)channelData:(id)channel data:(NSData *)data; def channelData_data_(self, channel, data): if hasattr(self.__cb_obj, '_handle_channeldata'): self.__cb_obj._handle_channeldata(channel, data[:]) channelData_data_ = objc.selector(channelData_data_, signature="v@:@@") # implement method from BBBluetoothChannelDelegateObserver protocol: # - (void)channelClosed:(id)channel; def channelClosed_(self, channel): if hasattr(self.__cb_obj, '_handle_channelclosed'): self.__cb_obj._handle_channelclosed(channel) channelClosed_ = objc.selector(channelClosed_, signature="v@:@") class _ChannelServerEventListener(Foundation.NSObject): """ Listens for server-specific events on a RFCOMM or L2CAP channel (i.e. when a client connects) and makes callbacks to a specified object when events occur. """ # note this is a NSObject "init", not a python object "__init__" def initWithDelegate_port_protocol_(self, cb_obj, port, proto): """ Arguments: - cb_obj: to receive callbacks when a client connects to to the channel, the callback object should have a method '_handle_channelopened' which takes the newly opened IOBluetoothRFCOMMChannel or IOBluetoothL2CAPChannel as its argument. - port: the channel or PSM that the server is listening on - proto: L2CAP or RFCOMM. """ self = super(_ChannelServerEventListener, self).init() if cb_obj is None: raise TypeError("callback object is None") self.__cb_obj = cb_obj self.__usernotif = None if proto == _lightbluecommon.RFCOMM: usernotif = _IOBluetooth.IOBluetoothRFCOMMChannel.registerForChannelOpenNotifications_selector_withChannelID_direction_(self, "newChannelOpened:channel:", port, _macutil.kIOBluetoothUserNotificationChannelDirectionIncoming) elif proto == _lightbluecommon.L2CAP: usernotif = _IOBluetooth.IOBluetoothL2CAPChannel.registerForChannelOpenNotifications_selector_withPSM_direction_(self, "newChannelOpened:channel:", port, _macutil.kIOBluetoothUserNotificationChannelDirectionIncoming) if usernotif is None: raise _socket.error("Unable to register for channel-" + \ "opened notifications on server socket on channel/PSM %d" % \ port) self.__usernotif = usernotif return self initWithDelegate_port_protocol_ = objc.selector( initWithDelegate_port_protocol_, signature="@@:@ii") def close(self): if self.__usernotif is not None: self.__usernotif.unregister() def newChannelOpened_channel_(self, notif, newChannel): """ Handle when a client connects to the server channel. (This method is called for both RFCOMM and L2CAP channels.) """ if newChannel is not None and newChannel.isIncoming(): # not sure if delegate really needs to be set newChannel.setDelegate_(self) if hasattr(self.__cb_obj, '_handle_channelopened'): self.__cb_obj._handle_channelopened(newChannel) # makes this method receive notif and channel as objects newChannelOpened_channel_ = objc.selector( newChannelOpened_channel_, signature="v@:@@") # ----------------------------------------------------------- # protocol-specific classes _SOCKET_CLASSES = { _lightbluecommon.RFCOMM: _RFCOMMConnection, _lightbluecommon.L2CAP: _L2CAPConnection } def _getsocketobject(proto): if proto not in _SOCKET_CLASSES.keys(): raise ValueError("Unknown socket protocol, must be L2CAP or RFCOMM") return _SocketWrapper(_BluetoothSocket(_SOCKET_CLASSES[proto]())) lightblue-0.3.2/src/mac/.__IOBluetooth.py 0000755 0000765 0000000 00000000122 10746345143 020017 0 ustar bea wheel 0000000 0000000 Mac OS X 2 R TEXT lightblue-0.3.2/src/mac/_IOBluetooth.py 0000755 0000765 0000000 00000007564 10746345143 017623 0 ustar bea wheel 0000000 0000000 # Copyright (c) 2006 Bea Lam. All rights reserved. # # Permission is hereby granted, free of charge, to any person # obtaining a copy of this software and associated documentation files # (the "Software"), to deal in the Software without restriction, # including without limitation the rights to use, copy, modify, merge, # publish, distribute, sublicense, and/or sell copies of the Software, # and to permit persons to whom the Software is furnished to do so, # subject to the following conditions: # # The above copyright notice and this permission notice shall be # included in all copies or substantial portions of the Software. # # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, # EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF # MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. # IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY # CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, # TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE # SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. """ Provides a python interface to the Mac OSX IOBluetooth Framework classes, through PyObjC. For example: >>> from lightblue import _IOBluetooth >>> for d in _IOBluetooth.IOBluetoothDevice.recentDevices_(0): ... print d.getName() ... Munkey Adam My Nokia 6600 >>> See http://developer.apple.com/documentation/DeviceDrivers/Reference/IOBluetooth/index.html for Apple's IOBluetooth documentation. See http://pyobjc.sourceforge.net for details on how to access Objective-C classes through PyObjC. """ import objc try: # mac os 10.5 loads frameworks using bridgesupport metadata __bundle__ = objc.initFrameworkWrapper("IOBluetooth", frameworkIdentifier="com.apple.IOBluetooth", frameworkPath=objc.pathForFramework( "/System/Library/Frameworks/IOBluetooth.framework"), globals=globals()) except AttributeError: # earlier versions use loadBundle() and setSignatureForSelector() objc.loadBundle("IOBluetooth", globals(), bundle_path=objc.pathForFramework(u'/System/Library/Frameworks/IOBluetooth.framework')) # Sets selector signatures in order to receive arguments correctly from # PyObjC methods. These MUST be set, otherwise the method calls won't work # at all, mostly because you can't pass by pointers in Python. # set to return int, and take an unsigned char output arg # i.e. in python: return (int, unsigned char) and accept no args objc.setSignatureForSelector("IOBluetoothSDPServiceRecord", "getRFCOMMChannelID:", "i12@0:o^C") # set to return int, and take an unsigned int output arg # i.e. in python: return (int, unsigned int) and accept no args objc.setSignatureForSelector("IOBluetoothSDPServiceRecord", "getL2CAPPSM:", "i12@0:o^S") # set to return int, and take (output object, unsigned char, object) args # i.e. in python: return (int, object) and accept (unsigned char, object) objc.setSignatureForSelector("IOBluetoothDevice", "openRFCOMMChannelSync:withChannelID:delegate:", "i16@0:o^@C@") # set to return int, and take (output object, unsigned int, object) args # i.e. in python: return (int, object) and accept (unsigned int, object) objc.setSignatureForSelector("IOBluetoothDevice", "openL2CAPChannelSync:withPSM:delegate:", "i20@0:o^@I@") # set to return int, take a const 6-char array arg # i.e. in python: return object and accept 6-char list # this seems to work even though the selector doesn't take a char aray, # it takes a struct 'BluetoothDeviceAddress' which contains a char array. objc.setSignatureForSelector("IOBluetoothDevice", "withAddress:", '@12@0:r^[6C]') del objc lightblue-0.3.2/src/mac/.__IOBluetoothUI.py 0000644 0000765 0000000 00000000122 10746316036 020251 0 ustar bea wheel 0000000 0000000 Mac OS X 2 R TEXT lightblue-0.3.2/src/mac/_IOBluetoothUI.py 0000644 0000765 0000765 00000004635 10746316036 017516 0 ustar bea bea 0000000 0000000 # Copyright (c) 2006 Bea Lam. All rights reserved. # # Permission is hereby granted, free of charge, to any person # obtaining a copy of this software and associated documentation files # (the "Software"), to deal in the Software without restriction, # including without limitation the rights to use, copy, modify, merge, # publish, distribute, sublicense, and/or sell copies of the Software, # and to permit persons to whom the Software is furnished to do so, # subject to the following conditions: # # The above copyright notice and this permission notice shall be # included in all copies or substantial portions of the Software. # # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, # EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF # MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. # IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY # CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, # TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE # SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. """ Provides a python interface to the Mac OSX IOBluetoothUI Framework classes, through PyObjC. For example: >>> from lightblue import _IOBluetoothUI >>> selector = _IOBluetoothUI.IOBluetoothDeviceSelectorController.deviceSelector() >>> selector.runModal() # ask user to select a device -1000 >>> for device in selector.getResults(): ... print device.getName() # show name of selected device ... Nokia 6600 >>> See http://developer.apple.com/documentation/DeviceDrivers/Reference/IOBluetoothUI/index.html for Apple's IOBluetoothUI documentation. See http://pyobjc.sourceforge.net for details on how to access Objective-C classes through PyObjC. """ import objc try: # mac os 10.5 loads frameworks using bridgesupport metadata __bundle__ = objc.initFrameworkWrapper("IOBluetoothUI", frameworkIdentifier="com.apple.IOBluetoothUI", frameworkPath=objc.pathForFramework( "/System/Library/Frameworks/IOBluetoothUI.framework"), globals=globals()) except AttributeError: # earlier versions use loadBundle() and setSignatureForSelector() objc.loadBundle("IOBluetoothUI", globals(), bundle_path=objc.pathForFramework(u'/System/Library/Frameworks/IOBluetoothUI.framework')) del objc lightblue-0.3.2/src/mac/.__LightAquaBlue.py 0000755 0000765 0000000 00000000122 10747265251 020313 0 ustar bea wheel 0000000 0000000 Mac OS X 2 R TEXT lightblue-0.3.2/src/mac/_LightAquaBlue.py 0000755 0000765 0000000 00000004613 10747265251 020107 0 ustar bea wheel 0000000 0000000 # Copyright (c) 2006 Bea Lam. All rights reserved. # # Permission is hereby granted, free of charge, to any person # obtaining a copy of this software and associated documentation files # (the "Software"), to deal in the Software without restriction, # including without limitation the rights to use, copy, modify, merge, # publish, distribute, sublicense, and/or sell copies of the Software, # and to permit persons to whom the Software is furnished to do so, # subject to the following conditions: # # The above copyright notice and this permission notice shall be # included in all copies or substantial portions of the Software. # # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, # EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF # MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. # IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY # CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, # TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE # SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. """ Provides a python interface to the LightAquaBlue Framework classes, through PyObjC. See http://pyobjc.sourceforge.net for details on how to access Objective-C classes through PyObjC. """ _FRAMEWORK_PATH = u'/Library/Frameworks/LightAquaBlue.framework' import os.path if not os.path.isdir(_FRAMEWORK_PATH): raise ImportError("Cannot load LightAquaBlue framework, not found at" + \ _FRAMEWORK_PATH) import objc objc.loadBundle("LightAquaBlue", globals(), bundle_path=objc.pathForFramework(_FRAMEWORK_PATH)) def _setmethodsignatures(): # return int, take (object, object, object, output unsigned char, output int) # i.e. in python: return (int, char, int), take (object, object, object) objc.setSignatureForSelector("BBServiceAdvertiser", "addRFCOMMServiceDictionary:withName:UUID:channelID:serviceRecordHandle:", "i@0:@@@o^Co^I") # set to take (6-char array, unsigned char, object) # this seems to work even though the selector doesn't take a char aray, # it takes a struct 'BluetoothDeviceAddress' which contains a char array. objc.setSignatureForSelector("BBBluetoothOBEXClient", "initWithRemoteDeviceAddress:channelID:delegate:", '@@:r^[6C]C@') _setmethodsignatures() del objc lightblue-0.3.2/src/mac/.__lightblue.py 0000755 0000765 0000000 00000000122 10750613250 017571 0 ustar bea wheel 0000000 0000000 Mac OS X 2 R TEXT lightblue-0.3.2/src/mac/_lightblue.py 0000755 0000765 0000000 00000046735 10750613250 017400 0 ustar bea wheel 0000000 0000000 # Copyright (c) 2006 Bea Lam. All rights reserved. # # Permission is hereby granted, free of charge, to any person # obtaining a copy of this software and associated documentation files # (the "Software"), to deal in the Software without restriction, # including without limitation the rights to use, copy, modify, merge, # publish, distribute, sublicense, and/or sell copies of the Software, # and to permit persons to whom the Software is furnished to do so, # subject to the following conditions: # # The above copyright notice and this permission notice shall be # included in all copies or substantial portions of the Software. # # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, # EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF # MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. # IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY # CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, # TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE # SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. # Mac OS X main module implementation. import types import warnings import Foundation import AppKit import objc import _IOBluetooth import _LightAquaBlue import _lightbluecommon import _macutil import _bluetoothsockets # public attributes __all__ = ("finddevices", "findservices", "finddevicename", "selectdevice", "selectservice", "gethostaddr", "gethostclass", "socket", "advertise", "stopadvertise") # details of advertised services __advertised = {} def finddevices(getnames=True, length=10): inquiry = _SyncDeviceInquiry() inquiry.run(getnames, length) return inquiry.getfounddevices() def findservices(addr=None, name=None, servicetype=None): if servicetype not in (_lightbluecommon.RFCOMM, _lightbluecommon.OBEX, None): raise ValueError("servicetype must be RFCOMM, OBEX or None, was %s" % \ servicetype) if addr is None: try: founddevices = finddevices() except _lightbluecommon.BluetoothError, e: msg = "findservices() failed, " +\ "error while finding devices: " + str(e) raise _lightbluecommon.BluetoothError(msg) #print founddevices addresses = [dev[0] for dev in founddevices] else: addresses = [addr] services = [] for devaddr in addresses: iobtdevice = _IOBluetooth.IOBluetoothDevice.withAddress_( _macutil.createbtdevaddr(devaddr)) try: lastseen = iobtdevice.getLastServicesUpdate() if lastseen is None or lastseen.timeIntervalSinceNow() < -2: # perform SDP query to update known services. # wait at least a few seconds between service discovery cos # sometimes it doesn't work if doing updates too often. # In future should have option to not do updates. serviceupdater = _SDPQueryRunner.alloc().init() try: serviceupdater.query(iobtdevice) # blocks until updated except _lightbluecommon.BluetoothError, e: msg = "findservices() couldn't get services for %s: %s" % \ (iobtdevice.getNameOrAddress(), str(e)) warnings.warn(msg) # or should I use cached services instead of warning? # but sometimes the cached ones are totally wrong. # if searching for RFCOMM, exclude OBEX services if servicetype == _lightbluecommon.RFCOMM: uuidbad = _macutil.PROTO_UUIDS.get(_lightbluecommon.OBEX) else: uuidbad = None filtered = _searchservices(iobtdevice, name=name, uuid=_macutil.PROTO_UUIDS.get(servicetype), uuidbad=uuidbad) #print "unfiltered:", iobtdevice.getServices() services.extend([_getservicetuple(s) for s in filtered]) finally: # close baseband connection (not sure if this is necessary, but # sometimes the transport connection seems to stay open?) iobtdevice.closeConnection() return services def finddevicename(address, usecache=True): if not _lightbluecommon._isbtaddr(address): raise TypeError("%s is not a valid bluetooth address" % str(address)) if address == gethostaddr(): return _gethostname() device = _IOBluetooth.IOBluetoothDevice.withAddress_( _macutil.createbtdevaddr(address)) if usecache: name = device.getName() if name is not None: return name # do name request with timeout of 10 seconds result = device.remoteNameRequest_withPageTimeout_(None, 10000) if result == _macutil.kIOReturnSuccess: return device.getName() raise _lightbluecommon.BluetoothError( "Could not find device name for %s" % address) ### local device ### def gethostaddr(): addr = _LightAquaBlue.BBLocalDevice.getAddressString() if addr is not None: # PyObjC returns all strings as unicode, but the address doesn't need # to be unicode cos it's just hex values return _macutil.formatdevaddr(addr) raise _lightbluecommon.BluetoothError("Cannot read local device address") def gethostclass(): cod = _LightAquaBlue.BBLocalDevice.getClassOfDevice() if cod != -1: return int(cod) raise _lightbluecommon.BluetoothError("Cannot read local device class") def _gethostname(): name = _LightAquaBlue.BBLocalDevice.getName() if name is not None: return name raise _lightbluecommon.BluetoothError("Cannot read local device name") ### socket ### def socket(proto=_lightbluecommon.RFCOMM): return _bluetoothsockets._getsocketobject(proto) ### advertising services ### def advertise(name, sock, servicetype): if not isinstance(name, types.StringTypes): raise TypeError("name must be string, was %s" % \ type(name)) # raises exception if socket is not bound boundchannelID = sock._getport() # advertise the service if servicetype == _lightbluecommon.RFCOMM: try: result, finalchannelID, servicerecordhandle = _LightAquaBlue.BBServiceAdvertiser.addRFCOMMServiceDictionary_withName_UUID_channelID_serviceRecordHandle_( _LightAquaBlue.BBServiceAdvertiser.serialPortProfileDictionary(), name, None, None, None) except: result, finalchannelID, servicerecordhandle = _LightAquaBlue.BBServiceAdvertiser.addRFCOMMServiceDictionary_withName_UUID_channelID_serviceRecordHandle_( _LightAquaBlue.BBServiceAdvertiser.serialPortProfileDictionary(), name, None) elif servicetype == _lightbluecommon.OBEX: try: result, finalchannelID, servicerecordhandle = _LightAquaBlue.BBServiceAdvertiser.addRFCOMMServiceDictionary_withName_UUID_channelID_serviceRecordHandle_( _LightAquaBlue.BBServiceAdvertiser.objectPushProfileDictionary(), name, None, None, None) except: result, finalchannelID, servicerecordhandle = _LightAquaBlue.BBServiceAdvertiser.addRFCOMMServiceDictionary_withName_UUID_channelID_serviceRecordHandle_( _LightAquaBlue.BBServiceAdvertiser.objectPushProfileDictionary(), name, None) else: raise ValueError("servicetype must be either RFCOMM or OBEX") if result != _macutil.kIOReturnSuccess: raise _lightbluecommon.BluetoothError( result, "Error advertising service") if boundchannelID != finalchannelID: msg = "socket bound to unavailable channel (%d), " % boundchannelID +\ "use channel value of 0 to bind to dynamically assigned channel" raise _lightbluecommon.BluetoothError(msg) # note service record handle, so that the service can be stopped later __advertised[id(sock)] = servicerecordhandle def stopadvertise(sock): if sock is None: raise TypeError("Given socket is None") servicerecordhandle = __advertised.get(id(sock)) if servicerecordhandle is None: raise _lightbluecommon.BluetoothError("no service advertised") result = _LightAquaBlue.BBServiceAdvertiser.removeService_(servicerecordhandle) if result != _macutil.kIOReturnSuccess: raise _lightbluecommon.BluetoothError( result, "Error stopping advertising of service") ### GUI ### def selectdevice(): import _IOBluetoothUI gui = _IOBluetoothUI.IOBluetoothDeviceSelectorController.deviceSelector() # try to bring GUI to foreground by setting it as floating panel # (if this is called from pyobjc app, it would automatically be in foreground) try: gui.window().setFloatingPanel_(True) except: pass # show the window and wait for user's selection response = gui.runModal() # problems here if transferring a lot of data?? if response == AppKit.NSRunStoppedResponse: results = gui.getResults() if len(results) > 0: # should always be > 0, but check anyway devinfo = _getdevicetuple(results[0]) # sometimes the baseband connection stays open which causes # problems with connections w so close it here, see if this fixes # it dev = _IOBluetooth.IOBluetoothDevice.withAddress_( _macutil.createbtdevaddr(devinfo[0])) if dev.isConnected(): dev.closeConnection() return devinfo # user cancelled selection return None def selectservice(): import _IOBluetoothUI gui = _IOBluetoothUI.IOBluetoothServiceBrowserController.serviceBrowserController_( _macutil.kIOBluetoothServiceBrowserControllerOptionsNone) # try to bring GUI to foreground by setting it as floating panel # (if this is called from pyobjc app, it would automatically be in foreground) try: gui.window().setFloatingPanel_(True) except: pass # show the window and wait for user's selection response = gui.runModal() if response == AppKit.NSRunStoppedResponse: results = gui.getResults() if len(results) > 0: # should always be > 0, but check anyway serviceinfo = _getservicetuple(results[0]) # sometimes the baseband connection stays open which causes # problems with connections ... so close it here, see if this fixes # it dev = _IOBluetooth.IOBluetoothDevice.withAddress_( _macutil.createbtdevaddr(serviceinfo[0])) if dev.isConnected(): dev.closeConnection() return serviceinfo # user cancelled selection return None ### classes ### class _SDPQueryRunner(Foundation.NSObject): """ Convenience class for performing a synchronous or asynchronous SDP query on an IOBluetoothDevice. """ def query(self, device, timeout=10.0): # do SDP query err = device.performSDPQuery_(self) if err != _macutil.kIOReturnSuccess: raise _lightbluecommon.BluetoothError(err, self._errmsg(device)) # performSDPQuery_ is async, so block-wait self._queryresult = None if not _macutil.waituntil(lambda: self._queryresult is not None, timeout): raise _lightbluecommon.BluetoothError( "Timed out getting services for %s" % \ device.getNameOrAddress()) # query is now complete if self._queryresult != _macutil.kIOReturnSuccess: raise _lightbluecommon.BluetoothError( self._queryresult, self._errmsg(device)) def sdpQueryComplete_status_(self, device, status): # can't raise exception during a callback, so just keep the err value self._queryresult = status _macutil.interruptwait() sdpQueryComplete_status_ = objc.selector( sdpQueryComplete_status_, signature="v@:@i") # accept object, int def _errmsg(self, device): return "Error getting services for %s" % device.getNameOrAddress() class _SyncDeviceInquiry(object): def __init__(self): super(_SyncDeviceInquiry, self).__init__() self._inquiry = _AsyncDeviceInquiry.alloc().init() self._inquiry.cb_completed = self._inquirycomplete self._inquiring = False def run(self, getnames, duration): if self._inquiring: raise _lightbluecommon.BluetoothError( "Another inquiry in progress") # set inquiry attributes self._inquiry.updatenames = getnames self._inquiry.length = duration # start the inquiry err = self._inquiry.start() if err != _macutil.kIOReturnSuccess: raise _lightbluecommon.BluetoothError( err, "Error starting device inquiry") # if error occurs during inquiry, set _inquiryerr to the error code self._inquiryerr = _macutil.kIOReturnSuccess # wait until the inquiry is complete self._inquiring = True _macutil.waituntil(lambda: not self._inquiring) # if error occured during inquiry, raise exception if self._inquiryerr != _macutil.kIOReturnSuccess: raise _lightbluecommon.BluetoothError(self._inquiryerr, "Error during device inquiry") def getfounddevices(self): # return as list of device-info tuples return [_getdevicetuple(device) for device in \ self._inquiry.getfounddevices()] def _inquirycomplete(self, err, aborted): self._inquiryerr = err self._inquiring = False _macutil.interruptwait() # Wrapper around IOBluetoothDeviceInquiry, with python callbacks that you can # set to receive callbacks when the inquiry is started or stopped, or when it # finds a device. # # This discovery doesn't block, so it could be used in a PyObjC application # that is running an event loop. # # Properties: # - 'length': the inquiry length (seconds) # - 'updatenames': whether to update device names during the inquiry # (i.e. perform remote name requests, which will take a little longer) # class _AsyncDeviceInquiry(Foundation.NSObject): # NSObject init, not python __init__ def init(self): try: attr = _IOBluetooth.IOBluetoothDeviceInquiry except AttributeError: raise ImportError("Cannot find IOBluetoothDeviceInquiry class " +\ "to perform device discovery. This class was introduced in " +\ "Mac OS X 10.4, are you running an earlier version?") self = super(_AsyncDeviceInquiry, self).init() self._inquiry = \ _IOBluetooth.IOBluetoothDeviceInquiry.inquiryWithDelegate_(self) # callbacks self.cb_started = None self.cb_completed = None self.cb_founddevice = None return self # length property def _setlength(self, length): self._inquiry.setInquiryLength_(length) length = property( lambda self: self._inquiry.inquiryLength(), _setlength) # updatenames property def _setupdatenames(self, update): self._inquiry.setUpdateNewDeviceNames_(update) updatenames = property( lambda self: self._inquiry.updateNewDeviceNames(), _setupdatenames) # returns error code def start(self): return self._inquiry.start() # returns error code def stop(self): return self._inquiry.stop() # returns list of IOBluetoothDevice objects def getfounddevices(self): return self._inquiry.foundDevices() # # delegate methods follow (these are called by the internal # IOBluetoothDeviceInquiry object when inquiry events occur) # # - (void)deviceInquiryDeviceFound:(IOBluetoothDeviceInquiry*)sender # device:(IOBluetoothDevice*)device; def deviceInquiryDeviceFound_device_(self, inquiry, device): if self.cb_founddevice: self.cb_founddevice(device) deviceInquiryDeviceFound_device_ = objc.selector( deviceInquiryDeviceFound_device_, signature="v@:@@") # - (void)deviceInquiryComplete:error:aborted; def deviceInquiryComplete_error_aborted_(self, inquiry, err, aborted): if self.cb_completed: self.cb_completed(err, aborted) deviceInquiryComplete_error_aborted_ = objc.selector( deviceInquiryComplete_error_aborted_, signature="v@:@iB") # - (void)deviceInquiryStarted:(IOBluetoothDeviceInquiry*)sender; def deviceInquiryStarted_(self, inquiry): if self.cb_started: self.cb_started() ### utility methods ### def _searchservices(device, name=None, uuid=None, uuidbad=None): """ Searches the given IOBluetoothDevice using the specified parameters. Returns an empty list if the device has no services. uuid should be IOBluetoothSDPUUID object. """ if not isinstance(device, _IOBluetooth.IOBluetoothDevice): raise ValueError("device must be IOBluetoothDevice, was %s" % \ type(device)) services = [] allservices = device.getServices() if uuid: gooduuids = (uuid, ) else: gooduuids = () if uuidbad: baduuids = (uuidbad, ) else: baduuids = () if allservices is not None: for s in allservices: if gooduuids and not s.hasServiceFromArray_(gooduuids): continue if baduuids and s.hasServiceFromArray_(baduuids): continue if name is None or s.getServiceName() == name: services.append(s) return services def _getdevicetuple(iobtdevice): """ Returns an (addr, name, COD) device tuple from a IOBluetoothDevice object. """ addr = _macutil.formatdevaddr(iobtdevice.getAddressString()) name = iobtdevice.getName() cod = iobtdevice.getClassOfDevice() return (addr, name, cod) def _getservicetuple(servicerecord): """ Returns a (device-addr, service-channel, service-name) tuple from the given IOBluetoothSDPServiceRecord. """ addr = _macutil.formatdevaddr(servicerecord.getDevice().getAddressString()) name = servicerecord.getServiceName() try: result, channel = servicerecord.getRFCOMMChannelID_(None) # pyobjc 2.0 except TypeError: result, channel = servicerecord.getRFCOMMChannelID_() if result != _macutil.kIOReturnSuccess: try: result, channel = servicerecord.getL2CAPPSM_(None) # pyobjc 2.0 except: result, channel = servicerecord.getL2CAPPSM_() if result != _macutil.kIOReturnSuccess: channel = None return (addr, channel, name) lightblue-0.3.2/src/mac/.__lightbluecommon.py 0000755 0000765 0000000 00000000122 10770142100 020773 0 ustar bea wheel 0000000 0000000 Mac OS X 2 R TEXT lightblue-0.3.2/src/mac/_lightbluecommon.py 0000755 0000765 0000765 00000025737 10770142100 020246 0 ustar bea bea 0000000 0000000 # Copyright (c) 2006 Bea Lam. All rights reserved. # # Permission is hereby granted, free of charge, to any person # obtaining a copy of this software and associated documentation files # (the "Software"), to deal in the Software without restriction, # including without limitation the rights to use, copy, modify, merge, # publish, distribute, sublicense, and/or sell copies of the Software, # and to permit persons to whom the Software is furnished to do so, # subject to the following conditions: # # The above copyright notice and this permission notice shall be # included in all copies or substantial portions of the Software. # # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, # EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF # MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. # IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY # CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, # TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE # SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. # Defines attributes with common implementations across the different # platforms. # public attributes __all__ = ("L2CAP", "RFCOMM", "OBEX", "BluetoothError", "splitclass") # Protocol/service class types, used for sockets and advertising services L2CAP, RFCOMM, OBEX = (10, 11, 12) class BluetoothError(IOError): """ Generic exception raised for Bluetooth errors. This is not raised for socket-related errors; socket objects raise the socket.error and socket.timeout exceptions from the standard library socket module. Note that error codes are currently platform-independent. In particular, the Mac OS X implementation returns IOReturn error values from the IOKit framework, and OBEXError codes from for OBEX operations. """ pass def splitclass(classofdevice): """ Splits the given class of device to return a 3-item tuple with the major service class, major device class and minor device class values. These values indicate the device's major services and the type of the device (e.g. mobile phone, laptop, etc.). If you google for "assigned numbers bluetooth baseband" you might find some documents that discuss how to extract this information from the class of device. Example: >>> splitclass(1057036) (129, 1, 3) >>> """ if not isinstance(classofdevice, int): try: classofdevice = int(classofdevice) except (TypeError, ValueError): raise TypeError("Given device class '%s' cannot be split" % \ str(classofdevice)) data = classofdevice >> 2 # skip over the 2 "format" bits service = data >> 11 major = (data >> 6) & 0x1F minor = data & 0x3F return (service, major, minor) _validbtaddr = None def _isbtaddr(address): """ Returns whether the given address is a valid bluetooth address. For example, "00:0e:6d:7b:a2:0a" is a valid address. Returns False if the argument is None or is not a string. """ # Define validity regex. Accept either ":" or "-" as separators. global _validbtaddr if _validbtaddr is None: import re _validbtaddr = re.compile("((\d|[a-f]){2}(:|-)){5}(\d|[a-f]){2}", re.IGNORECASE) import types if not isinstance(address, types.StringTypes): return False return _validbtaddr.match(address) is not None # --------- other attributes --------- def _joinclass(codtuple): """ The opposite of splitclass(). Joins a (service, major, minor) class-of- device tuple into a whole class of device value. """ if not isinstance(codtuple, tuple): raise TypeError("argument must be tuple, was %s" % type(codtuple)) if len(codtuple) != 3: raise ValueError("tuple must have 3 items, has %d" % len(codtuple)) serviceclass = codtuple[0] << 2 << 11 majorclass = codtuple[1] << 2 << 6 minorclass = codtuple[2] << 2 return (serviceclass | majorclass | minorclass) # Docstrings for socket objects. # Based on std lib socket docs. _socketdocs = { "accept": """ accept() -> (socket object, address info) Wait for an incoming connection. Return a new socket representing the connection, and the address of the client. For RFCOMM sockets, the address info is a pair (hostaddr, channel). The socket must be bound and listening before calling this method. """, "bind": """ bind(address) Bind the socket to a local address. For RFCOMM sockets, the address is a pair (host, channel); the host must refer to the local host. A port value of 0 binds the socket to a dynamically assigned port. (Note that on Mac OS X, the port value must always be 0.) The socket must not already be bound. """, "close": """ close() Close the socket. It cannot be used after this call. """, "connect": """ connect(address) Connect the socket to a remote address. The address should be a (host, channel) pair for RFCOMM sockets, and a (host, PSM) pair for L2CAP sockets. The socket must not be already connected. """, "connect_ex": """ connect_ex(address) -> errno This is like connect(address), but returns an error code instead of raising an exception when an error occurs. """, "dup": """ dup() -> socket object Returns a new socket object connected to the same system resource. """, "fileno": """ fileno() -> integer Return the integer file descriptor of the socket. Raises NotImplementedError on Mac OS X and Python For Series 60. """, "getpeername": """ getpeername() -> address info Return the address of the remote endpoint. The address info is a (host, channel) pair for RFCOMM sockets, and a (host, PSM) pair for L2CAP sockets. If the socket has not been connected, socket.error will be raised. """, "getsockname": """ getsockname() -> address info Return the address of the local endpoint. The address info is a (host, channel) pair for RFCOMM sockets, and a (host, PSM) pair for L2CAP sockets. If the socket has not been connected nor bound, this returns the tuple ("00:00:00:00:00:00", 0). """, "getsockopt": """ getsockopt(level, option[, bufsize]) -> value Get a socket option. See the Unix manual for level and option. If a nonzero buffersize argument is given, the return value is a string of that length; otherwise it is an integer. Currently support for socket options are platform independent -- i.e. depends on the underlying Series 60 or BlueZ socket options support. The Mac OS X implementation currently does not support any options at all and automatically raises socket.error. """, "gettimeout": """ gettimeout() -> timeout Returns the timeout in floating seconds associated with socket operations. A timeout of None indicates that timeouts on socket operations are disabled. Currently not supported on Python For Series 60 implementation, which will always return None. """, "listen": """ listen(backlog) Enable a server to accept connections. The backlog argument must be at least 1; it specifies the number of unaccepted connection that the system will allow before refusing new connections. The socket must not be already listening. Currently not implemented on Mac OS X. """, "makefile": """ makefile([mode[, bufsize]]) -> file object Returns a regular file object corresponding to the socket. The mode and bufsize arguments are as for the built-in open() function. """, "recv": """ recv(bufsize[, flags]) -> data Receive up to bufsize bytes from the socket. For the optional flags argument, see the Unix manual. When no data is available, block until at least one byte is available or until the remote end is closed. When the remote end is closed and all data is read, return the empty string. Currently the flags argument has no effect on Mac OS X. """, "recvfrom": """ recvfrom(bufsize[, flags]) -> (data, address info) Like recv(buffersize, flags) but also return the sender's address info. """, "send": """ send(data[, flags]) -> count Send a data string to the socket. For the optional flags argument, see the Unix manual. Return the number of bytes sent. The socket must be connected to a remote socket. Currently the flags argument has no effect on Mac OS X. """, "sendall": """ sendall(data[, flags]) Send a data string to the socket. For the optional flags argument, see the Unix manual. This calls send() repeatedly until all data is sent. If an error occurs, it's impossible to tell how much data has been sent. """, "sendto": """ sendto(data[, flags], address) -> count Like send(data, flags) but allows specifying the destination address. For RFCOMM sockets, the address is a pair (hostaddr, channel). """, "setblocking": """ setblocking(flag) Set the socket to blocking (flag is true) or non-blocking (false). setblocking(True) is equivalent to settimeout(None); setblocking(False) is equivalent to settimeout(0.0). Initially a socket is in blocking mode. In non-blocking mode, if a socket operation cannot be performed immediately, socket.error is raised. The underlying implementation on Python for Series 60 only supports non-blocking mode for send() and recv(), and ignores it for connect() and accept(). """, "setsockopt": """ setsockopt(level, option, value) Set a socket option. See the Unix manual for level and option. The value argument can either be an integer or a string. Currently support for socket options are platform independent -- i.e. depends on the underlying Series 60 or BlueZ socket options support. The Mac OS X implementation currently does not support any options at all and automatically raise socket.error. """, "settimeout": """ settimeout(timeout) Set a timeout on socket operations. 'timeout' can be a float, giving in seconds, or None. Setting a timeout of None disables the timeout feature and is equivalent to setblocking(1). Setting a timeout of zero is the same as setblocking(0). If a timeout is set, the connect, accept, send and receive operations will raise socket.timeout if a timeout occurs. Raises NotImplementedError on Python For Series 60. """, "shutdown": """ shutdown(how) Shut down the reading side of the socket (flag == socket.SHUT_RD), the writing side of the socket (flag == socket.SHUT_WR), or both ends (flag == socket.SHUT_RDWR). """ } lightblue-0.3.2/src/mac/.__macutil.py 0000755 0000765 0000000 00000000122 10770564220 017254 0 ustar bea wheel 0000000 0000000 Mac OS X 2 R TEXT lightblue-0.3.2/src/mac/_macutil.py 0000755 0000765 0000765 00000022353 10770564220 016516 0 ustar bea bea 0000000 0000000 # Copyright (c) 2006 Bea Lam. All rights reserved. # # Permission is hereby granted, free of charge, to any person # obtaining a copy of this software and associated documentation files # (the "Software"), to deal in the Software without restriction, # including without limitation the rights to use, copy, modify, merge, # publish, distribute, sublicense, and/or sell copies of the Software, # and to permit persons to whom the Software is furnished to do so, # subject to the following conditions: # # The above copyright notice and this permission notice shall be # included in all copies or substantial portions of the Software. # # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, # EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF # MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. # IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY # CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, # TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE # SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. # Mac-specific utility functions and constants. from Foundation import NSObject, NSDate, NSPoint, NSDefaultRunLoopMode, NSTimer from AppKit import NSApplication, NSEvent, NSApplicationDefined, NSAnyEventMask import objc import time import _IOBluetooth import _lightbluecommon # for mac os 10.5 try: from Foundation import NSUIntegerMax NSAnyEventMask = NSUIntegerMax except: pass # values of constants used in _IOBluetooth.framework kIOReturnSuccess = 0 # defined in kIOBluetoothUserNotificationChannelDirectionIncoming = 1 # defined in kBluetoothHCIErrorPageTimeout = 0x04 # # defined in kIOBluetoothServiceBrowserControllerOptionsNone = 0L LIGHTBLUE_NOTIFY_ID = 5444 # any old number WAIT_MAX_TIMEOUT = 3 # IOBluetoothSDPUUID objects for RFCOMM and OBEX protocol UUIDs PROTO_UUIDS = { _lightbluecommon.RFCOMM: _IOBluetooth.IOBluetoothSDPUUID.uuid16_(0x0003), _lightbluecommon.OBEX: _IOBluetooth.IOBluetoothSDPUUID.uuid16_(0x0008) } def formatdevaddr(addr): """ Returns address of a device in usual form e.g. "00:00:00:00:00:00" - addr: address as returned by device.getAddressString() on an IOBluetoothDevice """ # make uppercase cos PyS60 & Linux seem to always return uppercase # addresses # can safely encode to ascii cos BT addresses are only in hex (pyobjc # returns all strings in unicode) return addr.replace("-", ":").encode('ascii').upper() def createbtdevaddr(addr): # in mac 10.5, can use BluetoothDeviceAddress directly chars = btaddrtochars(addr) try: btdevaddr = _IOBluetooth.BluetoothDeviceAddress(chars) return btdevaddr except: return chars def btaddrtochars(addr): """ Takes a bluetooth address and returns a tuple with the corresponding char values. This can then be used to construct a IOBluetoothDevice object, providing the signature of the withAddress: selector has been set (as in _setpyobjcsignatures() in this module). For example: >>> chars = btaddrtochars("00:0e:0a:00:a2:00") >>> chars (0, 14, 10, 0, 162, 0) >>> device = _IOBluetooth.IOBluetoothDevice.withAddress_(chars) >>> type(device) >>> device.getAddressString() u'00-0e-0a-00-a2-00' """ if not _lightbluecommon._isbtaddr(addr): raise TypeError("address %s not valid bluetooth address" % str(addr)) if addr.find(":") == -1: addr = addr.replace("-", ":") # consider alternative addr separator # unhexlify gives binary value like '\x0e', then ord to get the char value. # unhexlify throws TypeError if value is not a hex pair. import binascii chars = [ord(binascii.unhexlify(part)) for part in addr.split(":")] return tuple(chars) def looponce(): app = NSApplication.sharedApplication() # to push the run loops I seem to have to do this twice # use NSEventTrackingRunLoopMode or NSDefaultRunLoopMode? for i in range(2): event = app.nextEventMatchingMask_untilDate_inMode_dequeue_( NSAnyEventMask, NSDate.dateWithTimeIntervalSinceNow_(0.02), NSDefaultRunLoopMode, False) def waituntil(conditionfunc, timeout=None): """ Waits until conditionfunc() returns true, or seconds have passed. (If timeout=None, this waits indefinitely until conditionfunc() returns true.) Returns false if the process timed out, otherwise returns true. Note!! You must call interruptwait() when you know that conditionfunc() should be checked (e.g. if you are waiting for data and you know some data has arrived) so that this can check conditionfunc(); otherwise it will just continue to wait. (This allows the function to wait for an event that is sent by interruptwait() instead of polling conditionfunc().) This allows the caller to wait while the main event loop processes its events. This must be done for certain situations, e.g. to receive socket data or to accept client connections on a server socket, since IOBluetooth requires the presence of an event loop to run these operations. This function doesn't need to be called if there is something else that is already processing the main event loop, e.g. if called from within a Cocoa application. """ app = NSApplication.sharedApplication() starttime = time.time() if timeout is None: timeout = NSDate.distantFuture().timeIntervalSinceNow() if not isinstance(timeout, (int, float)): raise TypeError("timeout must be int or float, was %s" % \ type(timeout)) endtime = starttime + timeout while True: currtime = time.time() if currtime >= endtime: return False # use WAIT_MAX_TIMEOUT, don't wait forever in case of KeyboardInterrupt e = app.nextEventMatchingMask_untilDate_inMode_dequeue_(NSAnyEventMask, NSDate.dateWithTimeIntervalSinceNow_(min(endtime - currtime, WAIT_MAX_TIMEOUT)), NSDefaultRunLoopMode, True) if e is not None: if (e.type() == NSApplicationDefined and e.subtype() == LIGHTBLUE_NOTIFY_ID): if conditionfunc(): return True else: app.postEvent_atStart_(e, True) def interruptwait(): """ If waituntil() has been called, this will interrupt the waiting process so it can check whether it should stop waiting. """ evt = NSEvent.otherEventWithType_location_modifierFlags_timestamp_windowNumber_context_subtype_data1_data2_(NSApplicationDefined, NSPoint(), NSApplicationDefined, 0, 1, None, LIGHTBLUE_NOTIFY_ID, 0, 0) NSApplication.sharedApplication().postEvent_atStart_(evt, True) class BBCocoaSleeper(NSObject): def init(self): self = super(BBCocoaSleeper, self).init() self.timedout = False return self def sleep(self, timeout): NSTimer.scheduledTimerWithTimeInterval_target_selector_userInfo_repeats_( timeout, self, "timedOut:", None, False) self.timedout = False waituntil(lambda: self.timedout) def timedOut_(self, timer): self.timedout = True interruptwait() timedOut_ = objc.selector(timedOut_, signature="v@:@") def waitfor(timeout): sleeper = BBCocoaSleeper.alloc().init() sleeper.sleep(timeout) class BBFileLikeObjectReader(NSObject): """ Provides a suitable delegate class for the BBDelegatingInputStream class in LightAquaBlue.framework. This basically provides a wrapper for a python file-like object so that it can be read through a NSInputStream. """ def initWithFileLikeObject_(self, fileobj): self = super(BBFileLikeObjectReader, self).init() self.__fileobj = fileobj return self initWithFileLikeObject_ = objc.selector(initWithFileLikeObject_, signature="@@:@") def readDataWithMaxLength_(self, maxlength): try: data = self.__fileobj.read(maxlength) except Exception: return None return buffer(data) readDataWithMaxLength_ = objc.selector(readDataWithMaxLength_, signature="@@:I") #"@12@0:4I8" #"@:I" class BBFileLikeObjectWriter(NSObject): """ Provides a suitable delegate class for the BBDelegatingOutputStream class in LightAquaBlue.framework. This basically provides a wrapper for a python file-like object so that it can be written to through a NSOutputStream. """ def initWithFileLikeObject_(self, fileobj): self = super(BBFileLikeObjectWriter, self).init() self.__fileobj = fileobj return self initWithFileLikeObject_ = objc.selector(initWithFileLikeObject_, signature="@@:@") def write_(self, data): try: self.__fileobj.write(data[:]) except Exception: return -1 return data.length() write_ = objc.selector(write_, signature="i12@0:4@8") #i12@0:4@8 #i@:@ lightblue-0.3.2/src/mac/.__obex.py 0000755 0000765 0000000 00000000122 10767105406 016556 0 ustar bea wheel 0000000 0000000 Mac OS X 2 R TEXT lightblue-0.3.2/src/mac/_obex.py 0000755 0000765 0000000 00000057775 10767105406 016373 0 ustar bea wheel 0000000 0000000 # Copyright (c) 2006 Bea Lam. All rights reserved. # # Permission is hereby granted, free of charge, to any person # obtaining a copy of this software and associated documentation files # (the "Software"), to deal in the Software without restriction, # including without limitation the rights to use, copy, modify, merge, # publish, distribute, sublicense, and/or sell copies of the Software, # and to permit persons to whom the Software is furnished to do so, # subject to the following conditions: # # The above copyright notice and this permission notice shall be # included in all copies or substantial portions of the Software. # # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, # EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF # MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. # IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY # CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, # TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE # SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. import datetime import time import types import objc from Foundation import NSObject, NSDate from _IOBluetooth import OBEXSession, IOBluetoothDevice, \ IOBluetoothRFCOMMChannel from _LightAquaBlue import BBBluetoothOBEXClient, BBBluetoothOBEXServer, \ BBStreamingInputStream, BBStreamingOutputStream, \ BBMutableOBEXHeaderSet, \ BBLocalDevice import _lightbluecommon import _obexcommon import _macutil from _obexcommon import OBEXError # from _kOBEXSuccess = 0 _kOBEXGeneralError = -21850 _kOBEXSessionNotConnectedError = -21876 _kOBEXSessionAlreadyConnectedError = -21882 _kOBEXSessionNoTransportError = -21879 _kOBEXSessionTransportDiedError = -21880 _OBEX_FINAL_MASK = 0x80 _HEADER_MASK = 0xc0 _HEADER_UNICODE = 0x00 _HEADER_BYTE_SEQ = 0x40 _HEADER_1BYTE = 0x80 _HEADER_4BYTE = 0xc0 # public attributes __all__ = ("OBEXClient", "sendfile", "recvfile") _obexerrorcodes = { 0: "no error", -21850: "general error", -21851: "no resources", -21852: "operation not supported", -21853: "internal error", -21854: "bad argument", -21855: "timeout", -21856: "bad request", -21857: "cancelled", -21875: "session is busy", -21876: "OBEX session not connected", -21877: "bad request in OBEX session", -21878: "bad response from other party", -21879: "Bluetooth transport not available", -21880: "Bluetooth transport connection died", -21881: "OBEX session timed out", -21882: "OBEX session already connected" } def errdesc(errorcode): return _obexerrorcodes.get(errorcode, str(errorcode)) # OBEXSession provides response codes with the final bit set, but OBEXResponse # class expects the response code to not have the final bit set. def _cutresponsefinalbit(responsecode): return (responsecode & ~_OBEX_FINAL_MASK) def _headersdicttoset(headers): headerset = BBMutableOBEXHeaderSet.alloc().init() for header, value in headers.items(): if isinstance(header, types.StringTypes): hid = _obexcommon._HEADER_STRINGS_TO_IDS.get(header.lower()) else: hid = header if hid is None: raise ValueError("unknown header '%s'" % header) if isinstance(value, datetime.datetime): value = value.strftime("%Y%m%dT%H%M%S") mask = hid & _HEADER_MASK if mask == _HEADER_UNICODE: if not isinstance(value, types.StringTypes): raise TypeError("value for '%s' must be string, was %s" % (str(header), type(value))) headerset.setValue_forUnicodeHeader_(value, hid) elif mask == _HEADER_BYTE_SEQ: try: value = buffer(value) except: raise TypeError("value for '%s' must be string, array or other buffer type, was %s" % (str(header), type(value))) headerset.setValue_forByteSequenceHeader_(value, hid) elif mask == _HEADER_1BYTE: if not isinstance(value, int): raise TypeError("value for '%s' must be int, was %s" % (str(header), type(value))) headerset.setValue_for1ByteHeader_(value, hid) elif mask == _HEADER_4BYTE: if not isinstance(value, int) and not isinstance(value, long): raise TypeError("value for '%s' must be int, was %s" % (str(header), type(value))) headerset.setValue_for4ByteHeader_(value, hid) if not headerset.containsValueForHeader_(hid): raise ValueError("cannot set OBEX header value for '%s'" % header) return headerset # returns in { header-id: value } form. def _headersettodict(headerset): headers = {} for number in headerset.allHeaders(): hid = number.unsignedCharValue() mask = hid & _HEADER_MASK if mask == _HEADER_UNICODE: value = headerset.valueForUnicodeHeader_(hid) elif mask == _HEADER_BYTE_SEQ: value = headerset.valueForByteSequenceHeader_(hid)[:] if hid == 0x42: # type if len(value) > 0 and value[-1] == '\0': value = value[:-1] # remove null byte elif hid == 0x44: # time iso-8601 string value = _obexcommon._datetimefromstring(value) elif mask == _HEADER_1BYTE: value = headerset.valueFor1ByteHeader_(hid) elif mask == _HEADER_4BYTE: value = headerset.valueFor4ByteHeader_(hid) headers[hid] = value return headers class OBEXClient: __doc__ = _obexcommon._obexclientclassdoc def __init__(self, address, channel): if not _lightbluecommon._isbtaddr(address): raise TypeError("address '%s' is not a valid bluetooth address" % address) if not type(channel) == int: raise TypeError("channel must be int, was %s" % type(channel)) if channel < 0: raise ValueError("channel cannot be negative") self.__serveraddr = (address, channel) self.__busy = False self.__client = None self.__obexsession = None # for testing #BBBluetoothOBEXClient.setDebug_(True) def connect(self, headers={}): if self.__client is not None: raise OBEXError(_kOBEXSessionAlreadyConnectedError, "session is already connected") if not BBLocalDevice.isPoweredOn(): raise OBEXError(_kOBEXSessionNoTransportError, "Bluetooth device not available") self.__delegate = _BBOBEXClientDelegate.alloc().initWithCallback_( self._finishedrequest) self.__client = BBBluetoothOBEXClient.alloc().initWithRemoteDeviceAddress_channelID_delegate_( _macutil.btaddrtochars(self.__serveraddr[0]), self.__serveraddr[1], self.__delegate) if self.__obexsession is not None: self.__client.performSelector_withObject_("setOBEXSession:", self.__obexsession) self.__reset() headerset = _headersdicttoset(headers) r = self.__client.sendConnectRequestWithHeaders_(headerset) if r != _kOBEXSuccess: self.__closetransport() raise OBEXError(r, "error starting Connect request (%s)" % errdesc(r)) _macutil.waituntil(self._done) if self.__error != _kOBEXSuccess: self.__closetransport() raise OBEXError(self.__error, "error during Connect request (%s)" % errdesc(self.__error)) resp = self.__getresponse() if resp.code != _obexcommon.OK: self.__closetransport() return resp def disconnect(self, headers={}): self.__checkconnected() self.__reset() try: headerset = _headersdicttoset(headers) r = self.__client.sendDisconnectRequestWithHeaders_(headerset) if r != _kOBEXSuccess: raise OBEXError(r, "error starting Disconnect request (%s)" % errdesc(r)) _macutil.waituntil(self._done) if self.__error != _kOBEXSuccess: raise OBEXError(self.__error, "error during Disconnect request (%s)" % errdesc(self.__error)) finally: # close channel regardless of disconnect result self.__closetransport() return self.__getresponse() def put(self, headers, fileobj): if not hasattr(fileobj, "read"): raise TypeError("file-like object must have read() method") self.__checkconnected() self.__reset() headerset = _headersdicttoset(headers) self.fileobj = fileobj self.__fileobjdelegate = _macutil.BBFileLikeObjectReader.alloc().initWithFileLikeObject_(fileobj) self.instream = BBStreamingInputStream.alloc().initWithDelegate_(self.__fileobjdelegate) self.instream.open() r = self.__client.sendPutRequestWithHeaders_readFromStream_( headerset, self.instream) if r != _kOBEXSuccess: raise OBEXError(r, "error starting Put request (%s)" % errdesc(r)) _macutil.waituntil(self._done) if self.__error != _kOBEXSuccess: raise OBEXError(self.__error, "error during Put request (%s)" % errdesc(self.__error)) return self.__getresponse() def delete(self, headers): self.__checkconnected() self.__reset() headerset = _headersdicttoset(headers) r = self.__client.sendPutRequestWithHeaders_readFromStream_(headerset, None) if r != _kOBEXSuccess: raise OBEXError(r, "error starting Delete request (%s)" % errdesc(r)) _macutil.waituntil(self._done) if self.__error != _kOBEXSuccess: raise OBEXError(self.__error, "error during Delete request (%s)" % errdesc(self.__error)) return self.__getresponse() def get(self, headers, fileobj): if not hasattr(fileobj, "write"): raise TypeError("file-like object must have write() method") self.__checkconnected() self.__reset() headerset = _headersdicttoset(headers) delegate = _macutil.BBFileLikeObjectWriter.alloc().initWithFileLikeObject_(fileobj) outstream = BBStreamingOutputStream.alloc().initWithDelegate_(delegate) outstream.open() r = self.__client.sendGetRequestWithHeaders_writeToStream_( headerset, outstream) if r != _kOBEXSuccess: raise OBEXError(r, "error starting Get request (%s)" % errdesc(r)) _macutil.waituntil(self._done) if self.__error != _kOBEXSuccess: raise OBEXError(self.__error, "error during Get request (%s)" % errdesc(self.__error)) return self.__getresponse() def setpath(self, headers, cdtoparent=False, createdirs=False): self.__checkconnected() self.__reset() headerset = _headersdicttoset(headers) r = self.__client.sendSetPathRequestWithHeaders_changeToParentDirectoryFirst_createDirectoriesIfNeeded_(headerset, cdtoparent, createdirs) if r != _kOBEXSuccess: raise OBEXError(r, "error starting SetPath request (%s)" % errdesc(r)) _macutil.waituntil(self._done) if self.__error != _kOBEXSuccess: raise OBEXError(self.__error, "error during SetPath request (%s)" % errdesc(self.__error)) return self.__getresponse() def _done(self): return not self.__busy def _finishedrequest(self, error, response): if error in (_kOBEXSessionNoTransportError, _kOBEXSessionTransportDiedError): self.__closetransport() self.__error = error self.__response = response self.__busy = False _macutil.interruptwait() def _setobexsession(self, session): self.__obexsession = session # Note that OBEXSession returns kOBEXSessionNotConnectedError if you don't # send CONNECT before sending any other requests; this means the OBEXClient # must send connect() before other requests, so this restriction is enforced # in the Linux version as well, for consistency. def __checkconnected(self): if self.__client is None: raise OBEXError(_kOBEXSessionNotConnectedError, "must connect() before sending other requests") def __closetransport(self): if self.__client is not None: try: self.__client.RFCOMMChannel().closeChannel() self.__client.RFCOMMChannel().getDevice().closeConnection() except: pass self.__client = None def __reset(self): self.__busy = True self.__error = None self.__response = None def __getresponse(self): code = self.__response.responseCode() rawheaders = _headersettodict(self.__response.allHeaders()) return _obexcommon.OBEXResponse(_cutresponsefinalbit(code), rawheaders) # set method docstrings definedmethods = locals() # i.e. defined methods in OBEXClient for name, doc in _obexcommon._obexclientdocs.items(): try: definedmethods[name].__doc__ = doc except KeyError: pass class _BBOBEXClientDelegate(NSObject): def initWithCallback_(self, cb_requestdone): self = super(_BBOBEXClientDelegate, self).init() self._cb_requestdone = cb_requestdone return self initWithCallback_ = objc.selector(initWithCallback_, signature="@@:@") # # Delegate methods follow. objc signatures for all methods must be set # using objc.selector or else may get bus error. # # - (void)client:(BBBluetoothOBEXClient *)client # didFinishConnectRequestWithError:(OBEXError)error # response:(BBOBEXResponse *)response; def client_didFinishConnectRequestWithError_response_(self, client, error, response): self._cb_requestdone(error, response) client_didFinishConnectRequestWithError_response_ = objc.selector( client_didFinishConnectRequestWithError_response_, signature="v@:@i@") # - (void)client:(BBBluetoothOBEXClient *)client # didFinishDisconnectRequestWithError:(OBEXError)error # response:(BBOBEXResponse *)response; def client_didFinishDisconnectRequestWithError_response_(self, client, error, response): self._cb_requestdone(error, response) client_didFinishDisconnectRequestWithError_response_ = objc.selector( client_didFinishDisconnectRequestWithError_response_,signature="v@:@i@") # - (void)client:(BBBluetoothOBEXClient *)client # didFinishPutRequestForStream:(NSInputStream *)inputStream # error:(OBEXError)error # response:(BBOBEXResponse *)response; def client_didFinishPutRequestForStream_error_response_(self, client, instream, error, response): self._cb_requestdone(error, response) client_didFinishPutRequestForStream_error_response_ = objc.selector( client_didFinishPutRequestForStream_error_response_,signature="v@:@@i@") # - (void)client:(BBBluetoothOBEXClient *)client # didFinishGetRequestForStream:(NSOutputStream *)outputStream # error:(OBEXError)error # response:(BBOBEXResponse *)response; def client_didFinishGetRequestForStream_error_response_(self, client, outstream, error, response): self._cb_requestdone(error, response) client_didFinishGetRequestForStream_error_response_ = objc.selector( client_didFinishGetRequestForStream_error_response_,signature="v@:@@i@") # - (void)client:(BBBluetoothOBEXClient *)client # didFinishSetPathRequestWithError:(OBEXError)error # response:(BBOBEXResponse *)response; def client_didFinishSetPathRequestWithError_response_(self, client, error, response): self._cb_requestdone(error, response) client_didFinishSetPathRequestWithError_response_ = objc.selector( client_didFinishSetPathRequestWithError_response_, signature="v@:@i@") # client:didAbortRequestWithStream:error:response: not # implemented since OBEXClient does not allow abort requests # ------------------------------------------------------------------ def sendfile(address, channel, source): if not _lightbluecommon._isbtaddr(address): raise TypeError("address '%s' is not a valid bluetooth address" % address) if not isinstance(channel, int): raise TypeError("channel must be int, was %s" % type(channel)) if not isinstance(source, types.StringTypes) and \ not hasattr(source, "read"): raise TypeError("source must be string or file-like object with read() method") if isinstance(source, types.StringTypes): headers = {"name": source} fileobj = file(source, "rb") closefileobj = True else: if hasattr(source, "name"): headers = {"name": source.name} fileobj = source closefileobj = False client = OBEXClient(address, channel) client.connect() try: resp = client.put(headers, fileobj) finally: if closefileobj: fileobj.close() try: client.disconnect() except: pass # always ignore disconnection errors if resp.code != _obexcommon.OK: raise OBEXError("server denied the Put request") # ------------------------------------------------------------------ class BBOBEXObjectPushServer(NSObject): def initWithChannel_fileLikeObject_(self, channel, fileobject): if not isinstance(channel, IOBluetoothRFCOMMChannel) and \ not isinstance(channel, OBEXSession): raise TypeError("internal error, channel is of wrong type %s" % type(channel)) if not hasattr(fileobject, "write"): raise TypeError("fileobject must be file-like object with write() method") self = super(BBOBEXObjectPushServer, self).init() self.__fileobject = fileobject self.__server = BBBluetoothOBEXServer.alloc().initWithIncomingRFCOMMChannel_delegate_(channel, self) #BBBluetoothOBEXServer.setDebug_(True) self.__error = None self.__gotfile = False self.__gotdisconnect = False self.__disconnected = False # for internal testing if isinstance(channel, OBEXSession): self.__server.performSelector_withObject_("setOBEXSession:", channel) return self initWithChannel_fileLikeObject_ = objc.selector( initWithChannel_fileLikeObject_, signature="@@:i@") def run(self): self.__server.run() # wait until client sends a file, or an error occurs _macutil.waituntil(lambda: self.__gotfile or self.__error is not None) # wait briefly for a disconnect request (client may have decided to just # close the connection without sending a disconnect request) if self.__error is None: ok = _macutil.waituntil(lambda: self.__gotdisconnect, 3) if ok: _macutil.waituntil(lambda: self.__disconnected) # only raise OBEXError if file was not received if not self.__gotfile: if self.__error is not None: raise OBEXError(self.__error[0], self.__error[1]) # if client connected but didn't send PUT raise OBEXError(_kOBEXGeneralError, "client did not send a file") # # BBBluetoothOBEXClientDelegate methods follow. # These enable this class to get callbacks when some event occurs on the # server (e.g. got a new client request, or an error occurred, etc.). # # - (BOOL)server:(BBBluetoothOBEXServer *)server # shouldHandleConnectRequest:(BBOBEXHeaderSet *)requestHeaders; def server_shouldHandleConnectRequest_(self, server, requestheaders): return True server_shouldHandleConnectRequest_ = objc.selector( server_shouldHandleConnectRequest_, signature="c@:@@") # - (BOOL)server:(BBBluetoothOBEXServer *)server # shouldHandleDisconnectRequest:(BBOBEXHeaderSet *)requestHeaders; def server_shouldHandleDisconnectRequest_(self, server, requestheaders): self.__gotdisconnect = True _macutil.interruptwait() return True server_shouldHandleDisconnectRequest_ = objc.selector( server_shouldHandleDisconnectRequest_, signature="c@:@@") # - (void)serverDidHandleDisconnectRequest:(BBBluetoothOBEXServer *)server; def serverDidHandleDisconnectRequest_(self, server): self.__disconnected = True _macutil.interruptwait() serverDidHandleDisconnectRequest_ = objc.selector( serverDidHandleDisconnectRequest_, signature="v@:@") # - (NSOutputStream *)server:(BBBluetoothOBEXServer *)server # shouldHandlePutRequest:(BBOBEXHeaderSet *)requestHeaders; def server_shouldHandlePutRequest_(self, server, requestheaders): #print "Incoming file:", requestHeaders.valueForNameHeader() self.delegate = _macutil.BBFileLikeObjectWriter.alloc().initWithFileLikeObject_(self.__fileobject) outstream = BBStreamingOutputStream.alloc().initWithDelegate_(self.delegate) outstream.open() return outstream server_shouldHandlePutRequest_ = objc.selector( server_shouldHandlePutRequest_, signature="@@:@@") # - (void)server:(BBBluetoothOBEXServer *)server # didHandlePutRequestForStream:(NSOutputStream *)outputStream # requestWasAborted:(BOOL)aborted; def server_didHandlePutRequestForStream_requestWasAborted_(self, server, stream, aborted): if aborted: self.__error = (_kOBEXGeneralError, "client aborted file transfer") else: self.__gotfile = True _macutil.interruptwait() server_didHandlePutRequestForStream_requestWasAborted_ = objc.selector( server_didHandlePutRequestForStream_requestWasAborted_, signature="v@:@@c") # - (void)server:(BBBluetoothOBEXServer *)server # errorOccurred:(OBEXError)error # description:(NSString *)description; def server_errorOccurred_description_(self, server, error, desc): self.__error = (error, desc) _macutil.interruptwait() server_errorOccurred_description_ = objc.selector( server_errorOccurred_description_, signature="v@:@i@") # ------------------------------------------------------------------ def recvfile(sock, dest): if sock is None: raise TypeError("Given socket is None") if not isinstance(dest, (types.StringTypes, types.FileType)): raise TypeError("dest must be string or file-like object with write() method") if isinstance(dest, types.StringTypes): fileobj = open(dest, "wb") closefileobj = True else: fileobj = dest closefileobj = False try: sock.listen(1) conn, addr = sock.accept() #print "A client connected:", addr server = BBOBEXObjectPushServer.alloc().initWithChannel_fileLikeObject_( conn._getchannel(), fileobj) server.run() conn.close() finally: if closefileobj: fileobj.close() lightblue-0.3.2/src/mac/.__obexcommon.py 0000755 0000765 0000000 00000000122 10750556342 017770 0 ustar bea wheel 0000000 0000000 Mac OS X 2 R TEXT lightblue-0.3.2/src/mac/_obexcommon.py 0000755 0000765 0000765 00000044343 10750556342 017235 0 ustar bea bea 0000000 0000000 # Copyright (c) 2006 Bea Lam. All rights reserved. # # Permission is hereby granted, free of charge, to any person # obtaining a copy of this software and associated documentation files # (the "Software"), to deal in the Software without restriction, # including without limitation the rights to use, copy, modify, merge, # publish, distribute, sublicense, and/or sell copies of the Software, # and to permit persons to whom the Software is furnished to do so, # subject to the following conditions: # # The above copyright notice and this permission notice shall be # included in all copies or substantial portions of the Software. # # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, # EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF # MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. # IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY # CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, # TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE # SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. import _lightbluecommon __all__ = ('OBEXResponse', 'OBEXError', 'CONTINUE', 'OK', 'CREATED', 'ACCEPTED', 'NON_AUTHORITATIVE_INFORMATION', 'NO_CONTENT', 'RESET_CONTENT', 'PARTIAL_CONTENT', 'MULTIPLE_CHOICES', 'MOVED_PERMANENTLY', 'MOVED_TEMPORARILY', 'SEE_OTHER', 'NOT_MODIFIED', 'USE_PROXY', 'BAD_REQUEST', 'UNAUTHORIZED', 'PAYMENT_REQUIRED', 'FORBIDDEN', 'NOT_FOUND', 'METHOD_NOT_ALLOWED', 'NOT_ACCEPTABLE', 'PROXY_AUTHENTICATION_REQUIRED', 'REQUEST_TIME_OUT', 'CONFLICT', 'GONE', 'LENGTH_REQUIRED', 'PRECONDITION_FAILED', 'REQUESTED_ENTITY_TOO_LARGE', 'REQUEST_URL_TOO_LARGE', 'UNSUPPORTED_MEDIA_TYPE', 'INTERNAL_SERVER_ERROR', 'NOT_IMPLEMENTED', 'BAD_GATEWAY', 'SERVICE_UNAVAILABLE', 'GATEWAY_TIMEOUT', 'HTTP_VERSION_NOT_SUPPORTED', 'DATABASE_FULL', 'DATABASE_LOCKED') class OBEXError(_lightbluecommon.BluetoothError): """ Generic exception raised for OBEX-related errors. """ pass class OBEXResponse: """ Contains the OBEX response received from an OBEX server. When an OBEX client sends a request, the OBEX server sends back a response code (to indicate whether the request was successful) and a set of response headers (to provide other useful information). For example, if a client sends a 'Get' request to retrieve a file, the client might get a response like this: >>> import lightblue >>> client = lightblue.obex.OBEXClient("aa:bb:cc:dd:ee:ff", 10) >>> response = client.get({"name": "file.txt"}, file("file.txt", "w")) >>> print response You can get the response code and response headers in different formats: >>> print response.reason 'OK' # a string description of the response code >>> print response.code 32 # the response code (e.g. this is 0x20) >>> print response.headers {'length': 35288} # the headers, with string keys >>> print response.rawheaders {195: 35288} # the headers, with raw header ID keys >>> Note how the 'code' attribute does not have the final bit set - e.g. for OK/Success, the response code is 0x20, not 0xA0. The lightblue.obex module defines constants for response code values (e.g. lightblue.obex.OK, lightblue.obex.FORBIDDEN, etc.). """ def __init__(self, code, rawheaders): self.__code = code self.__reason = _OBEX_RESPONSES.get(code, "Unknown response code") self.__rawheaders = rawheaders self.__headers = None code = property(lambda self: self.__code, doc='The response code, without the final bit set.') reason = property(lambda self: self.__reason, doc='A string description of the response code.') rawheaders = property(lambda self: self.__rawheaders, doc='The response headers, as a dictionary with header ID (unsigned byte) keys.') def getheader(self, header, default=None): ''' Returns the response header value for the given header, which may either be a string (not case-sensitive) or the raw byte value of the header ID. Returns the specified default value if the header is not present. ''' if isinstance(header, types.StringTypes): return self.headers.get(header.lower(), default) return self.__rawheaders.get(header, default) def __getheaders(self): if self.__headers is None: self.__headers = {} for headerid, value in self.__rawheaders.items(): if headerid in _HEADER_IDS_TO_STRINGS: self.__headers[_HEADER_IDS_TO_STRINGS[headerid]] = value else: self.__headers["0x%02x" % headerid] = value return self.__headers headers = property(__getheaders, doc='The response headers, as a dictionary with string keys.') def __repr__(self): return " " % \ (self.__reason, self.__code, (self.__code | 0x80), str(self.headers)) try: import datetime # as from python docs example class UTC(datetime.tzinfo): """UTC""" def utcoffset(self, dt): return datetime.timedelta(0) def tzname(self, dt): return "UTC" def dst(self, dt): return datetime.timedelta(0) except: pass # no datetime on pys60 _LOCAL_TIME_FORMAT = "%Y%m%dT%H%M%S" _UTC_TIME_FORMAT = _LOCAL_TIME_FORMAT + "Z" def _datetimefromstring(s): import time if s[-1:] == "Z": # add UTC() instance as tzinfo args = (time.strptime(s, _UTC_TIME_FORMAT)[0:6]) + (0, UTC()) return datetime.datetime(*args) else: return datetime.datetime(*(time.strptime(s, _LOCAL_TIME_FORMAT)[0:6])) _HEADER_STRINGS_TO_IDS = { "count": 0xc0, "name": 0x01, "type": 0x42, "length": 0xc3, "time": 0x44, "description": 0x05, "target": 0x46, "http": 0x47, "who": 0x4a, "connection-id": 0xcb, "application-parameters": 0x4c, "authentication-challenge": 0x4d, "authentication-response": 0x4e, "creator-id": 0xcf, "wan-uuid": 0x50, "object-class": 0x51, "session-parameters": 0x52, "session-sequence-number": 0x93 } _HEADER_IDS_TO_STRINGS = {} for key, value in _HEADER_STRINGS_TO_IDS.items(): _HEADER_IDS_TO_STRINGS[value] = key assert len(_HEADER_IDS_TO_STRINGS) == len(_HEADER_STRINGS_TO_IDS) # These match the associated strings in httplib.responses, since OBEX response # codes are matched to HTTP status codes (except for 0x60 and 0x61). # Note these are the responses *without* the final bit set. _OBEX_RESPONSES = { 0x10: "Continue", 0x20: "OK", 0x21: "Created", 0x22: "Accepted", 0x23: "Non-Authoritative Information", 0x24: "No Content", 0x25: "Reset Content", 0x26: "Partial Content", 0x30: "Multiple Choices", 0x31: "Moved Permanently", 0x32: "Moved Temporarily", # but is 'Found' (302) in httplib.response??? 0x33: "See Other", 0x34: "Not Modified", 0x35: "Use Proxy", 0x40: "Bad Request", 0x41: "Unauthorized", 0x42: "Payment Required", 0x43: "Forbidden", 0x44: "Not Found", 0x45: "Method Not Allowed", 0x46: "Not Acceptable", 0x47: "Proxy Authentication Required", 0x48: "Request Timeout", 0x49: "Conflict", 0x4A: "Gone", 0x48: "Length Required", 0x4C: "Precondition Failed", 0x4D: "Request Entity Too Large", 0x4E: "Request-URI Too Long", 0x4F: "Unsupported Media Type", 0x50: "Internal Server Error", 0x51: "Not Implemented", 0x52: "Bad Gateway", 0x53: "Service Unavailable", 0x54: "Gateway Timeout", 0x55: "HTTP Version Not Supported", 0x60: "Database Full", 0x61: "Database Locked" } _obexclientclassdoc = \ """ An OBEX client class. (Note this is not available on Python for Series 60.) For example, to connect to an OBEX server and send a file: >>> import lightblue >>> client = lightblue.obex.OBEXClient("aa:bb:cc:dd:ee:ff", 10) >>> client.connect() >>> client.put({"name": "photo.jpg"}, file("photo.jpg", "rb")) >>> client.disconnect() >>> A client must call connect() to establish a connection before it can send any other requests. The connect(), disconnect(), put(), delete(), get() and setpath() methods all accept the request headers as a dictionary of header-value mappings. The request headers are used to provide the server with additional information for the request. For example, this sends a Put request that includes Name, Type and Length headers in the request headers, to provide details about the transferred file: >>> f = file("file.txt") >>> client.put({"name": "file.txt", "type": "text/plain", ... "length": 5192}, f) >>> Here is a list of all the different string header keys that you can use in the request headers, and the expected type of the value for each header: - "name" -> a string - "type" -> a string - "length" -> an int - "time" -> a datetime object from the datetime module - "description" -> a string - "target" -> a string or buffer - "http" -> a string or buffer - "who" -> a string or buffer - "connection-id" -> an int - "application-parameters" -> a string or buffer - "authentication-challenge" -> a string or buffer - "authentication-response" -> a string or buffer - "creator-id" -> an int - "wan-uuid" -> a string or buffer - "object-class" -> a string or buffer - "session-parameters" -> a string or buffer - "session-sequence-number" -> an int less than 256 (The string header keys are not case-sensitive.) Alternatively, you can use raw header ID values instead of the above convenience strings. So, the previous example can be rewritten as: >>> client.put({0x01: "file.txt", 0x42: "text/plain", 0xC3: 5192}, ... fileobject) >>> This is also useful for inserting custom headers. For example, a PutImage request for a Basic Imaging client requires the Img-Descriptor (0x71) header: >>> client.put({"type": "x-bt/img-img", ... "name": "photo.jpg", ... 0x71: ' '}, ... file('photo.jpg', 'rb')) >>> Notice that the connection-id header is not sent, because this is automatically included by OBEXClient in the request headers if a connection-id was received in a previous Connect response. See the included src/examples/obex_ftp_client.py for an example of using OBEXClient to implement a File Transfer client for browsing the files on a remote device. """ _obexclientdocs = { "__init__": """ Creates an OBEX client. Arguments: - address: the address of the remote device - channel: the RFCOMM channel of the remote OBEX service """, "connect": """ Establishes the Bluetooth connection to the remote OBEX server and sends a Connect request to open the OBEX session. Returns an OBEXResponse instance containing the server response. Raises lightblue.obex.OBEXError if the session is already connected, or if an error occurs during the request. If the server refuses the Connect request (i.e. if it sends a response code other than OK/Success), the Bluetooth connection will be closed. Arguments: - headers={}: the headers to send for the Connect request """, "disconnect": """ Sends a Disconnect request to end the OBEX session and closes the Bluetooth connection to the remote OBEX server. Returns an OBEXResponse instance containing the server response. Raises lightblue.obex.OBEXError if connect() has not been called, or if an error occurs during the request. Note that you don't need to send any connection-id headers - this is automatically included if the client received one in a Connect response. Arguments: - headers={}: the headers to send for the request """, "put": """ Sends a Put request. Returns an OBEXResponse instance containing the server response. Raises lightblue.obex.OBEXError if connect() has not been called, or if an error occurs during the request. Note that you don't need to send any connection-id headers - this is automatically included if the client received one in a Connect response. Arguments: - headers: the headers to send for the request - fileobj: a file-like object containing the file data to be sent for the request For example, to send a file named 'photo.jpg', using the request headers to notify the server of the file's name, MIME type and length: >>> client = lightblue.obex.OBEXClient("aa:bb:cc:dd:ee:ff", 10) >>> client.connect() >>> client.put({"name": "photo.jpg", "type": "image/jpeg", "length": 28566}, file("photo.jpg", "rb")) >>> """, "delete": """ Sends a Put-Delete request in order to delete a file or folder on the remote server. Returns an OBEXResponse instance containing the server response. Raises lightblue.obex.OBEXError if connect() has not been called, or if an error occurs during the request. Note that you don't need to send any connection-id headers - this is automatically included if the client received one in a Connect response. Arguments: - headers: the headers to send for the request - you should use the 'name' header to specify the file you want to delete If the file on the server can't be deleted because it's a read-only file, you might get an 'Unauthorized' response, like this: >>> client = lightblue.obex.OBEXClient("aa:bb:cc:dd:ee:ff", 10) >>> client.connect() >>> client.delete({"name": "random_file.txt"}) >>> """, "get": """ Sends a Get request. Returns an OBEXResponse instance containing the server response. Raises lightblue.obex.OBEXError if connect() has not been called, or if an error occurs during the request. Note that you don't need to send any connection-id headers - this is automatically included if the client received one in a Connect response. Arguments: - headers: the headers to send for the request - you should use these to specify the file you want to retrieve - fileobj: a file-like object, to which the received data will be written An example: >>> client = lightblue.obex.OBEXClient("aa:bb:cc:dd:ee:ff", 10) >>> client.connect() >>> f = file("received_file.txt", "w+") >>> client.get({"name": "testfile.txt"}, f) >>> f.seek(0) >>> f.read() 'test file' >>> """, "setpath": """ Sends a SetPath request in order to set the "current path" on the remote server for file transfers. Returns an OBEXResponse instance containing the server response. Raises lightblue.obex.OBEXError if connect() has not been called, or if an error occurs during the request. Note that you don't need to send any connection-id headers - this is automatically included if the client received one in a Connect response. Arguments: - headers: the headers to send for the request - you should use the 'name' header to specify the directory you want to change to - cdtoparent=False: True if the remote server should move up one directory before applying the specified directory (i.e. 'cd ../dirname') - createdirs=False: True if the specified directory should be created if it doesn't exist (if False, the server will return an error response if the directory doesn't exist) For example: # change to the "images" subdirectory >>> client.setpath({"name": "images"}) >>> # change to the parent directory >>> client.setpath({}, cdtoparent=True) >>> # create a subdirectory "My_Files" >>> client.setpath({"name": "My_Files"}, createdirs=True) >>> # change to the root directory - you can use an empty "name" header # to specify this >>> client.setpath({"name": ""}) >>> """ } # response constants CONTINUE = 0x10 OK = 0x20 CREATED = 0x21 ACCEPTED = 0x22 NON_AUTHORITATIVE_INFORMATION = 0x23 NO_CONTENT = 0x24 RESET_CONTENT = 0x25 PARTIAL_CONTENT = 0x26 MULTIPLE_CHOICES = 0x30 MOVED_PERMANENTLY = 0x31 MOVED_TEMPORARILY = 0x32 SEE_OTHER = 0x33 NOT_MODIFIED = 0x34 USE_PROXY = 0x35 BAD_REQUEST = 0x40 UNAUTHORIZED = 0x41 PAYMENT_REQUIRED = 0x42 FORBIDDEN = 0x43 NOT_FOUND = 0x44 METHOD_NOT_ALLOWED = 0x45 NOT_ACCEPTABLE = 0x46 PROXY_AUTHENTICATION_REQUIRED = 0x47 REQUEST_TIME_OUT = 0x48 CONFLICT = 0x49 GONE = 0x4A LENGTH_REQUIRED = 0x4B PRECONDITION_FAILED = 0x4C REQUESTED_ENTITY_TOO_LARGE = 0x4D REQUEST_URL_TOO_LARGE = 0x4E UNSUPPORTED_MEDIA_TYPE = 0x4F INTERNAL_SERVER_ERROR = 0x50 NOT_IMPLEMENTED = 0x51 BAD_GATEWAY = 0x52 SERVICE_UNAVAILABLE = 0x53 GATEWAY_TIMEOUT = 0x54 HTTP_VERSION_NOT_SUPPORTED = 0x55 DATABASE_FULL = 0x60 DATABASE_LOCKED = 0x61 lightblue-0.3.2/src/mac/LightAquaBlue/ 0000755 0000765 0000765 00000000000 10770565177 017042 5 ustar bea bea 0000000 0000000 lightblue-0.3.2/src/mac/LightAquaBlue/advertising-notes.txt 0000644 0000765 0000765 00000002763 10747223642 023250 0 ustar bea bea 0000000 0000000 SerialPortDictionary.plist is a modification of the same file in the OBEXSample project available in the Mac OS X Developer examples (under 'Bluetooth'). I modified it by adding a 0x1101 (Serial Port Profile) in the ServiceClassIDList entry. Without this entry, the Nokia 6600 (and it seems Series 60 phones in general) could not find the service when searching for RFCOMM services. Other web resources seem to confirm that the 0x1101 is necessary for RFCOMM services. How does OBEXObjectPushDictionary.plist differ from SerialPortDictionary.plist? In OBEXObjectPushDictionary.plist: - ServiceClassIDList property has <1105> as a data object to represent the OBEX Object Push Profile. - BluetoothProfileDescriptorList has <1105> too as an entry. - ProtocolDescriptorList has <0008> (for OBEX protocol) along with the L2CAP (0x0100) and RFCOMM (0x0003) entries I used 0x1105 which is the UUID for the OBEX Object Push Profile. OBEXFileTransferDictionary uses 0x1106 instead which is the UUID for the File Transfer Profile. The thing to do is to build a server which supports particular operations and then choose the right profile depending on whether you support the corresponding operations. E.g. if you advertise the File Transfer Profile your server should support folder browsing, and Object Push servers might support some kind of business card exchange via vCards etc. See BluetoothAssignedNumbers.h in the IOBluetooth.framework headers for a list of all the appropriate UUIDs and numbers and what they mean. lightblue-0.3.2/src/mac/LightAquaBlue/BBBluetoothChannelDelegate.h 0000644 0000765 0000765 00000004060 10747262564 024306 0 ustar bea bea 0000000 0000000 /* * Copyright (c) 2006 Bea Lam. All rights reserved. * * Permission is hereby granted, free of charge, to any person * obtaining a copy of this software and associated documentation files * (the "Software"), to deal in the Software without restriction, * including without limitation the rights to use, copy, modify, merge, * publish, distribute, sublicense, and/or sell copies of the Software, * and to permit persons to whom the Software is furnished to do so, * subject to the following conditions: * * The above copyright notice and this permission notice shall be * included in all copies or substantial portions of the Software. * * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */ // // BBBluetoothChannelDelegate.h // LightAquaBlue // // Provides a delegate for RFCOMM and L2CAP channels. This is only intended // for use from the LightBlue library. // #include @class IOBluetoothRFCOMMChannel; @class IOBluetoothL2CAPChannel; @interface BBBluetoothChannelDelegate : NSObject { id m_delegate; } - (id)initWithDelegate:(id)delegate; + (IOReturn)synchronouslyWriteData:(NSData *)data toRFCOMMChannel:(IOBluetoothRFCOMMChannel *)channel; + (IOReturn)synchronouslyWriteData:(NSData *)data toL2CAPChannel:(IOBluetoothL2CAPChannel *)channel; @end /* * These are the methods that should be implemented by the delegate of this * delegate (very awkward, but that's what it is). */ @protocol BBBluetoothChannelDelegateObserver - (void)channelData:(id)channel data:(NSData *)data; - (void)channelClosed:(id)channel; @end lightblue-0.3.2/src/mac/LightAquaBlue/BBBluetoothChannelDelegate.m 0000644 0000765 0000765 00000006377 10747262555 024330 0 ustar bea bea 0000000 0000000 /* * Copyright (c) 2006 Bea Lam. All rights reserved. * * Permission is hereby granted, free of charge, to any person * obtaining a copy of this software and associated documentation files * (the "Software"), to deal in the Software without restriction, * including without limitation the rights to use, copy, modify, merge, * publish, distribute, sublicense, and/or sell copies of the Software, * and to permit persons to whom the Software is furnished to do so, * subject to the following conditions: * * The above copyright notice and this permission notice shall be * included in all copies or substantial portions of the Software. * * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */ // // BBBluetoothChannelDelegate.m // LightAquaBlue // #import "BBBluetoothChannelDelegate.h" #import #import static SEL channelDataSelector; static SEL channelClosedSelector; @implementation BBBluetoothChannelDelegate + (void)initialize { channelDataSelector = @selector(channelData:data:); channelClosedSelector = @selector(channelClosed:); } - (id)initWithDelegate:(id)delegate { self = [super init]; m_delegate = delegate; return self; } - (void)rfcommChannelData:(IOBluetoothRFCOMMChannel *)rfcommChannel data:(void *)dataPointer length:(size_t)dataLength { if (m_delegate && [m_delegate respondsToSelector:channelDataSelector]) { [m_delegate channelData:rfcommChannel data:[NSData dataWithBytes:dataPointer length:dataLength]]; } } - (void)rfcommChannelClosed:(IOBluetoothRFCOMMChannel *)rfcommChannel { if (m_delegate && [m_delegate respondsToSelector:channelClosedSelector]) { [m_delegate channelClosed:rfcommChannel]; } } - (void)l2capChannelData:(IOBluetoothL2CAPChannel *)l2capChannel data:(void *)dataPointer length:(size_t)dataLength { if (m_delegate && [m_delegate respondsToSelector:channelDataSelector]) { [m_delegate channelData:l2capChannel data:[NSData dataWithBytes:dataPointer length:dataLength]]; } } - (void)l2capChannelClosed:(IOBluetoothL2CAPChannel *)l2capChannel { if (m_delegate && [m_delegate respondsToSelector:channelClosedSelector]) { [m_delegate channelClosed:l2capChannel]; } } + (IOReturn)synchronouslyWriteData:(NSData *)data toRFCOMMChannel:(IOBluetoothRFCOMMChannel *)channel { return [channel writeSync:(void *)[data bytes] length:[data length]]; } + (IOReturn)synchronouslyWriteData:(NSData *)data toL2CAPChannel:(IOBluetoothL2CAPChannel *)channel { return [channel writeSync:(void *)[data bytes] length:[data length]]; } @end lightblue-0.3.2/src/mac/LightAquaBlue/._BBBluetoothOBEXClient.h 0000644 0000765 0000000 00000000122 10750073373 023732 0 ustar bea wheel 0000000 0000000 Mac OS X 2 R TEXT lightblue-0.3.2/src/mac/LightAquaBlue/BBBluetoothOBEXClient.h 0000644 0000765 0000765 00000030753 10750073373 023177 0 ustar bea bea 0000000 0000000 /* * Copyright (c) 2006 Bea Lam. All rights reserved. * * Permission is hereby granted, free of charge, to any person * obtaining a copy of this software and associated documentation files * (the "Software"), to deal in the Software without restriction, * including without limitation the rights to use, copy, modify, merge, * publish, distribute, sublicense, and/or sell copies of the Software, * and to permit persons to whom the Software is furnished to do so, * subject to the following conditions: * * The above copyright notice and this permission notice shall be * included in all copies or substantial portions of the Software. * * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */ // // BBBluetoothOBEXClient.h // LightAquaBlue // // Implements the client side of an OBEX session over a Bluetooth transport. // // There is an example in examples/LightAquaBlue/SimpleOBEXClient that shows // how to use this class to connect to and send files to an OBEX server. // #import #import #import @class OBEXSession; @class BBOBEXHeaderSet; @class BBOBEXRequest; @class IOBluetoothDevice; @class BBOBEXResponse; @class IOBluetoothRFCOMMChannel; @interface BBBluetoothOBEXClient : NSObject { OBEXSession* mSession; id mDelegate; OBEXMaxPacketLength mMaxPacketLength; int mLastServerResponse; uint32_t mConnectionID; BOOL mHasConnectionID; BOOL mAborting; BBOBEXRequest *mCurrentRequest; } /* * Creates a BBBluetoothOBEXClient with the given . The client will * connect to the OBEX server on the given and . */ - (id)initWithRemoteDeviceAddress:(const BluetoothDeviceAddress *)deviceAddress channelID:(BluetoothRFCOMMChannelID)channelID delegate:(id)delegate; /* * Sends a Connect request with the given . * * Returns kOBEXSuccess if the request was sent, or some other OBEXError value * from if there was an error. The delegate is informed * through client:didFinishConnectRequestWithError:responseCode:responseHeaders: * when the request is finished. */ - (OBEXError)sendConnectRequestWithHeaders:(BBOBEXHeaderSet *)headers; /* * Sends a Disconnect request with the given . * * Returns kOBEXSuccess if the request was sent, or some other OBEXError value * from if there was an error. The delegate is informed * through client:didFinishDisconnectRequestWithError:responseCode:responseHeaders: * when the request is finished. * * You must have already sent a Connect request; otherwise, this fails and * return kOBEXSessionNotConnectedError. * * Note the Connection ID is automatically sent in the request headers if one * was provided by the server in a previous Connect response. */ - (OBEXError)sendDisconnectRequestWithHeaders:(BBOBEXHeaderSet *)headers; /* * Sends a Put request with the given that will send the data from * the given . (The stream must be already open, or the request * will fail!) To send a Put-Delete request, set to nil. * * Returns kOBEXSuccess if the request was sent, or some other OBEXError value * from if there was an error. The delegate is informed * through client:didFinishPutRequestForStream:error:responseCode:responseHeaders: * when the request is finished. * * You must have already sent a Connect request; otherwise, this fails and * return kOBEXSessionNotConnectedError. * * Note the Connection ID is automatically sent in the request headers if one * was provided by the server in a previous Connect response. */ - (OBEXError)sendPutRequestWithHeaders:(BBOBEXHeaderSet *)headers readFromStream:(NSInputStream *)inputStream; /* * Sends a Get request with the given that will write received data * to the given . (The stream must be already open, or the request * will fail!) * * Returns kOBEXSuccess if the request was sent, or some other OBEXError value * from if there was an error. The delegate is informed * through client:didFinishGetRequestForStream:error:responseCode:responseHeaders: * when the request is finished. * * You must have already sent a Connect request; otherwise, this fails and * return kOBEXSessionNotConnectedError. * * Note the Connection ID is automatically sent in the request headers if one * was provided by the server in a previous Connect response. */ - (OBEXError)sendGetRequestWithHeaders:(BBOBEXHeaderSet *)headers writeToStream:(NSOutputStream *)outputStream; /* * Sends a SetPath request with the given . Set * to YES if you want to move up one directory * (i.e. "..") before changing to the directory specified in the headers. Set * to YES if you want to create a directory * (instead of receiving an error response) if it does not currently exist. * * Returns kOBEXSuccess if the request was sent, or some other OBEXError value * from if there was an error. The delegate is informed * through client:didFinishSetPathRequestWithError:responseCode:responseHeaders: * when the request is finished. * * You must have already sent a Connect request; otherwise, this fails and * return kOBEXSessionNotConnectedError. * * Note the Connection ID is automatically sent in the request headers if one * was provided by the server in a previous Connect response. */ - (OBEXError)sendSetPathRequestWithHeaders:(BBOBEXHeaderSet *)headers changeToParentDirectoryFirst:(BOOL)changeToParentDirectoryFirst createDirectoriesIfNeeded:(BOOL)createDirectoriesIfNeeded; /* * Aborts the current request if a Put or Get request is currently in progress. * * This schedules an Abort request to be sent when possible (i.e. when the * client next receives a server response). * * Returns kOBEXSuccess if the request was sent, or some other OBEXError value * from if there was an error. The delegate is informed * through client:didFinishAbortRequestWithError:responseCode:forStream: * when the Abort request is finished. */ - (void)abortCurrentRequest; /* * Returns whether the OBEX session is connected (i.e. whether a Connect * request has been sent, without a following Disconnect request). */ - (BOOL)isConnected; /* * Returns the Connection ID for the OBEX session, if one was received in a * response to a previous Connect request. * * This is automatically sent by the client for each request; you do not need * to add it to the request headers yourself. */ - (uint32_t)connectionID; /* * Returns the RFCOMM channel for the client. */ - (IOBluetoothRFCOMMChannel *)RFCOMMChannel; /* * Returns whether this client has a Connection ID. */ - (BOOL)hasConnectionID; /* * Returns the maximum packet length for the OBEX session. */ - (OBEXMaxPacketLength)maximumPacketLength; /* * Sets the client delegate to . */ - (void)setDelegate:(id)delegate; /* * Returns the delegate for this client. */ - (id)delegate; /* * Sets whether debug messages should be displayed (default is NO). */ + (void)setDebug:(BOOL)debug; @end /* * This informal protocol describes the methods that can be implemented for a * BBBluetoothOBEXClient delegate. */ @protocol BBBluetoothOBEXClientDelegate /* * Called when a Connect request is completed. is set to kOBEXSuccess * if the request finished without an error, or some other OBEXError value * from if an error occured. contains the * response code and headers. * * The only indicates whether the request was processed successfully; * use the response code in to see whether the request was actually * accepted by the OBEX server. */ - (void)client:(BBBluetoothOBEXClient *)client didFinishConnectRequestWithError:(OBEXError)error response:(BBOBEXResponse *)response; /* * Called when a Disconnect request is completed. is set to kOBEXSuccess * if the request finished without an error, or some other OBEXError value * from if an error occured. contains the * response code and headers. * * The only indicates whether the request was processed successfully; * use the response code in to see whether the request was actually * accepted by the OBEX server. */ - (void)client:(BBBluetoothOBEXClient *)client didFinishDisconnectRequestWithError:(OBEXError)error response:(BBOBEXResponse *)response; /* * Called when a Put request is completed. is set to kOBEXSuccess * if the request finished without an error, or some other OBEXError value * from if an error occured. The is the * stream originally passed to sendPutRequestWithHeaders:readFromStream:, and * contains the response code and headers. * * The only indicates whether the request was processed successfully; * use the response code in to see whether the request was actually * accepted by the OBEX server. */ - (void)client:(BBBluetoothOBEXClient *)client didFinishPutRequestForStream:(NSInputStream *)inputStream error:(OBEXError)error response:(BBOBEXResponse *)response; /* * Called each time the client sends another chunk of data to the OBEX server * during a Put request. is the number of bytes sent. */ - (void)client:(BBBluetoothOBEXClient *)client didSendDataOfLength:(unsigned)length; /* * Called each time the client receives another chunk of data from the OBEX * server during a Get request. is the number of bytes received, and * is the total number of bytes the client expects to receive * for the request. is zero if the total length is unknown. */ - (void)client:(BBBluetoothOBEXClient *)session didReceiveDataOfLength:(unsigned)length ofTotalLength:(unsigned)totalLength; /* * Called when a Get request is completed. is set to kOBEXSuccess * if the request finished without an error, or some other OBEXError value * from if an error occured. The is the * stream originally passed to sendGetRequestWithHeaders:writeToStream:, and * contains the response code and headers. * * The only indicates whether the request was processed successfully; * use the response code in to see whether the request was actually * accepted by the OBEX server. */ - (void)client:(BBBluetoothOBEXClient *)client didFinishGetRequestForStream:(NSOutputStream *)outputStream error:(OBEXError)error response:(BBOBEXResponse *)response; /* * Called when a SetPath request is completed. is set to kOBEXSuccess * if the request finished without an error, or some other OBEXError value * from if an error occured. contains the * response code and headers. * * The only indicates whether the request was processed successfully; * use the response code in to see whether the request was actually * accepted by the OBEX server. */ - (void)client:(BBBluetoothOBEXClient *)client didFinishSetPathRequestWithError:(OBEXError)error response:(BBOBEXResponse *)response; /* * Called when an Abort request is completed following a call to * abortCurrentRequest:. is set to kOBEXSuccess * if the request finished without an error, or some other OBEXError value * from if an error occured. The is the * stream originally passed to sendPutRequestWithHeaders:readFromStream: or * sendGetRequestWithHeaders:writeToStream:, and contains the * response code and headers. * * The only indicates whether the request was processed successfully; * use the response code in to see whether the request was actually * accepted by the OBEX server. */ - (void)client:(BBBluetoothOBEXClient *)session didAbortRequestWithStream:(NSStream *)stream error:(OBEXError)error response:(BBOBEXResponse *)response; @end lightblue-0.3.2/src/mac/LightAquaBlue/._BBBluetoothOBEXClient.m 0000644 0000765 0000000 00000000122 10750747454 023747 0 ustar bea wheel 0000000 0000000 Mac OS X 2 R TEXT lightblue-0.3.2/src/mac/LightAquaBlue/BBBluetoothOBEXClient.m 0000644 0000765 0000765 00000030774 10750747454 023217 0 ustar bea bea 0000000 0000000 /* * Copyright (c) 2006 Bea Lam. All rights reserved. * * Permission is hereby granted, free of charge, to any person * obtaining a copy of this software and associated documentation files * (the "Software"), to deal in the Software without restriction, * including without limitation the rights to use, copy, modify, merge, * publish, distribute, sublicense, and/or sell copies of the Software, * and to permit persons to whom the Software is furnished to do so, * subject to the following conditions: * * The above copyright notice and this permission notice shall be * included in all copies or substantial portions of the Software. * * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */ // // BBBluetoothOBEXClient.m // LightAquaBlue // #import "BBBluetoothOBEXClient.h" #import "BBMutableOBEXHeaderSet.h" #import "BBOBEXRequest.h" #import #import #import #import #define DEBUG_NAME @"[BBBluetoothOBEXClient] " static BOOL _debug = NO; @implementation BBBluetoothOBEXClient - (id)initWithRemoteDeviceAddress:(const BluetoothDeviceAddress *)deviceAddress channelID:(BluetoothRFCOMMChannelID)channelID delegate:(id)delegate; { self = [super init]; mSession = [[IOBluetoothOBEXSession alloc] initWithDevice:[IOBluetoothDevice withAddress:deviceAddress] channelID:channelID]; mDelegate = delegate; mMaxPacketLength = 0x2000; mLastServerResponse = kOBEXResponseCodeSuccessWithFinalBit; mConnectionID = 0; mHasConnectionID = NO; mAborting = NO; mCurrentRequest = nil; return self; } - (BBOBEXHeaderSet *)addConnectionIDToHeaders:(BBOBEXHeaderSet *)headers { if (!mHasConnectionID) return headers; BBMutableOBEXHeaderSet *modifiedHeaders = [BBMutableOBEXHeaderSet headerSet]; [modifiedHeaders addHeadersFromHeaderSet:headers]; [modifiedHeaders setValueForConnectionIDHeader:mConnectionID]; return modifiedHeaders; } - (OBEXError)sendConnectRequestWithHeaders:(BBOBEXHeaderSet *)headers { if (mCurrentRequest && ![mCurrentRequest isFinished]) return kOBEXSessionBusyError; BBOBEXConnectRequest *request = [[BBOBEXConnectRequest alloc] initWithClient:self eventSelector:@selector(handleSessionEvent:) session:mSession]; OBEXError status = [request beginWithHeaders:headers]; if (status == kOBEXSuccess) { [mCurrentRequest release]; mCurrentRequest = request; } else { [request release]; } return status; } - (OBEXError)sendDisconnectRequestWithHeaders:(BBOBEXHeaderSet *)headers { if (mCurrentRequest && ![mCurrentRequest isFinished]) return kOBEXSessionBusyError; BBOBEXDisconnectRequest *request = [[BBOBEXDisconnectRequest alloc] initWithClient:self eventSelector:@selector(handleSessionEvent:) session:mSession]; BBOBEXHeaderSet *realHeaders = (mHasConnectionID ? [self addConnectionIDToHeaders:headers] : headers); OBEXError status = [request beginWithHeaders:realHeaders]; if (status == kOBEXSuccess) { [mCurrentRequest release]; mCurrentRequest = request; } else { [request release]; } return status; } - (OBEXError)sendPutRequestWithHeaders:(BBOBEXHeaderSet *)headers readFromStream:(NSInputStream *)inputStream { if (mCurrentRequest && ![mCurrentRequest isFinished]) return kOBEXSessionBusyError; BBOBEXPutRequest *request = [[BBOBEXPutRequest alloc] initWithClient:self eventSelector:@selector(handleSessionEvent:) session:mSession inputStream:inputStream]; BBOBEXHeaderSet *realHeaders = (mHasConnectionID ? [self addConnectionIDToHeaders:headers] : headers); OBEXError status = [request beginWithHeaders:realHeaders]; if (status == kOBEXSuccess) { [mCurrentRequest release]; mCurrentRequest = request; } else { [request release]; } return status; } - (OBEXError)sendGetRequestWithHeaders:(BBOBEXHeaderSet *)headers writeToStream:(NSOutputStream *)outputStream { if (mCurrentRequest && ![mCurrentRequest isFinished]) return kOBEXSessionBusyError; BBOBEXGetRequest *request = [[BBOBEXGetRequest alloc] initWithClient:self eventSelector:@selector(handleSessionEvent:) session:mSession outputStream:outputStream]; BBOBEXHeaderSet *realHeaders = (mHasConnectionID ? [self addConnectionIDToHeaders:headers] : headers); OBEXError status = [request beginWithHeaders:realHeaders]; if (status == kOBEXSuccess) { [mCurrentRequest release]; mCurrentRequest = request; } else { [request release]; } return status; } - (OBEXError)sendSetPathRequestWithHeaders:(BBOBEXHeaderSet *)headers changeToParentDirectoryFirst:(BOOL)changeToParentDirectoryFirst createDirectoriesIfNeeded:(BOOL)createDirectoriesIfNeeded { if (mCurrentRequest && ![mCurrentRequest isFinished]) return kOBEXSessionBusyError; BBOBEXSetPathRequest *request = [[BBOBEXSetPathRequest alloc] initWithClient:self eventSelector:@selector(handleSessionEvent:) session:mSession changeToParentDirectoryFirst:changeToParentDirectoryFirst createDirectoriesIfNeeded:createDirectoriesIfNeeded]; BBOBEXHeaderSet *realHeaders = (mHasConnectionID ? [self addConnectionIDToHeaders:headers] : headers); OBEXError status = [request beginWithHeaders:realHeaders]; if (status == kOBEXSuccess) { [mCurrentRequest release]; mCurrentRequest = request; } else { [request release]; } return status; } - (void)abortCurrentRequest { if (_debug) NSLog(DEBUG_NAME @"[abortCurrentRequest]"); if (!mCurrentRequest || [mCurrentRequest isFinished] || mAborting) return; if (_debug) NSLog(DEBUG_NAME @"Aborting later..."); // Just set an abort flag -- can't send OBEXAbort right away because we // might be in the middle of a transaction, and we must wait our turn to // send the abort (i.e. wait until after we've received a server response) mAborting = YES; } #pragma mark - - (void)finishedCurrentRequestWithError:(OBEXError)error responseCode:(int)responseCode { if (_debug) NSLog(DEBUG_NAME @"[finishedCurrentRequestWithError] %d 0x%02x", error, responseCode); mAborting = NO; [mCurrentRequest finishedWithError:error responseCode:responseCode]; [mCurrentRequest release]; mCurrentRequest = nil; } - (void)performAbort { if (_debug) NSLog(DEBUG_NAME @"[performAbort]"); [mCurrentRequest release]; mCurrentRequest = [[BBOBEXAbortRequest alloc] initWithClient:self eventSelector:@selector(handleSessionEvent:) session:mSession]; OBEXError status = [mCurrentRequest beginWithHeaders:nil]; if (status != kOBEXSuccess) [self finishedCurrentRequestWithError:status responseCode:0]; } - (void)processResponseWithHeaders:(BBMutableOBEXHeaderSet *)responseHeaders responseCode:(int)responseCode { if (_debug) NSLog(DEBUG_NAME @"processResponseWithHeaders 0x%x", responseCode); if (responseCode == kOBEXResponseCodeContinueWithFinalBit) { if (mAborting) { [self performAbort]; return; } [mCurrentRequest receivedResponseWithHeaders:responseHeaders]; OBEXError status = [mCurrentRequest sendNextRequestPacket]; if (status != kOBEXSuccess) { [self finishedCurrentRequestWithError:status responseCode:responseCode]; return; } } else { [mCurrentRequest receivedResponseWithHeaders:responseHeaders]; mLastServerResponse = responseCode; [self finishedCurrentRequestWithError:kOBEXSuccess responseCode:responseCode]; } } - (void)handleSessionEvent:(const OBEXSessionEvent *)event { if (_debug) NSLog(DEBUG_NAME @"[handleSessionEvent] event %d (current request=%@)", event->type, mCurrentRequest); if (mCurrentRequest) { if (event->type == kOBEXSessionEventTypeError) { if (_debug) NSLog(DEBUG_NAME @"[handleSessionEvent] error occurred %d", event->u.errorData.error); [self finishedCurrentRequestWithError:event->u.errorData.error responseCode:0]; return; } int responseCode; BBMutableOBEXHeaderSet *responseHeaders = nil; if ([mCurrentRequest readOBEXResponseHeaders:&responseHeaders andResponseCode:&responseCode fromSessionEvent:event]) { if (!responseHeaders) responseHeaders = [BBMutableOBEXHeaderSet headerSet]; if (event->type == kOBEXSessionEventTypeConnectCommandResponseReceived) { // note any received connection id so it can be sent with later // requests if ([responseHeaders containsValueForHeader:kOBEXHeaderIDConnectionID]) { mConnectionID = [responseHeaders valueForConnectionIDHeader]; mHasConnectionID = YES; } } else if (event->type == kOBEXSessionEventTypeDisconnectCommandResponseReceived) { // disconnected, can clear connection id now mConnectionID = 0; mHasConnectionID = NO; } [self processResponseWithHeaders:responseHeaders responseCode:responseCode]; } else { // unable to read response / response didn't match current request if (_debug) NSLog(DEBUG_NAME @"[handleSessionEvent] can't parse event!"); [self finishedCurrentRequestWithError:kOBEXSessionBadResponseError responseCode:0]; } } else { if (_debug) NSLog(DEBUG_NAME @"ignoring event received while idle: %d", event->type); } } - (int)serverResponseForLastRequest { return mLastServerResponse; } // for internal testing - (void)setOBEXSession:(OBEXSession *)session { [session retain]; [mSession release]; mSession = session; } - (BOOL)isConnected { if (mSession) return [mSession hasOpenOBEXConnection]; return NO; } - (IOBluetoothRFCOMMChannel *)RFCOMMChannel { if (mSession && [mSession isKindOfClass:[IOBluetoothOBEXSession class]]) { IOBluetoothOBEXSession *session = (IOBluetoothOBEXSession *)mSession; return [session getRFCOMMChannel]; } return nil; } - (uint32_t)connectionID { return mConnectionID; } - (BOOL)hasConnectionID { return mHasConnectionID; } - (OBEXMaxPacketLength)maximumPacketLength { return mMaxPacketLength; } - (void)setDelegate:(id)delegate { mDelegate = delegate; } - (id)delegate { return mDelegate; } + (void)setDebug:(BOOL)debug { _debug = debug; [BBOBEXRequest setDebug:debug]; } - (void)dealloc { [mSession setEventSelector:NULL target:nil refCon:NULL]; [mCurrentRequest release]; mCurrentRequest = nil; // if client is deleted during a delegate callback [mSession closeTransportConnection]; [mSession release]; mSession = nil; [super dealloc]; } @end lightblue-0.3.2/src/mac/LightAquaBlue/._BBBluetoothOBEXServer.h 0000644 0000765 0000000 00000000122 10750072721 023756 0 ustar bea wheel 0000000 0000000 Mac OS X 2 R TEXT lightblue-0.3.2/src/mac/LightAquaBlue/BBBluetoothOBEXServer.h 0000644 0000765 0000765 00000024234 10750072721 023220 0 ustar bea bea 0000000 0000000 /* * Copyright (c) 2006 Bea Lam. All rights reserved. * * Permission is hereby granted, free of charge, to any person * obtaining a copy of this software and associated documentation files * (the "Software"), to deal in the Software without restriction, * including without limitation the rights to use, copy, modify, merge, * publish, distribute, sublicense, and/or sell copies of the Software, * and to permit persons to whom the Software is furnished to do so, * subject to the following conditions: * * The above copyright notice and this permission notice shall be * included in all copies or substantial portions of the Software. * * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */ // // BBBluetoothOBEXServer.h // LightAquaBlue // // Implements the server side of an OBEX session over a Bluetooth transport. // // Generally you will use BBBluetoothOBEXServer like this: // 1. Call registerForChannelOpenNotifications:selector:withChannelID:direction: // in the IOBluetoothRFCOMMChannel class in order be notified whenever // you receive a client connection on a particular RFCOMM channel ID. // 2. When you are notified that a client has connected, use the provided // IOBluetoothRFCOMMChannel to create a a BBBluetoothOBEXServer // object, and then call run: on the object to start the server. // // There is an example in examples/LightAquaBlue/SimpleOBEXServer that shows // how to use this class to run a basic OBEX server session. // #import #import @class OBEXSession; @class BBOBEXHeaderSet; @class BBMutableOBEXHeaderSet; @class BBOBEXRequestHandler; @class IOBluetoothRFCOMMChannel; @class IOBluetoothUserNotification; @interface BBBluetoothOBEXServer : NSObject { IOBluetoothRFCOMMChannel *mChannel; OBEXSession *mSession; id mDelegate; BBOBEXRequestHandler *mCurrentRequestHandler; IOBluetoothUserNotification *mChannelNotif; } /* * Creates and returns a BBBluetoothOBEXServer. */ + (id)serverWithIncomingRFCOMMChannel:(IOBluetoothRFCOMMChannel *)channel delegate:(id)delegate; /* * Initialises a BBBluetoothOBEXServer that will run on the given . * The will be notified when events occur on the server. */ - (id)initWithIncomingRFCOMMChannel:(IOBluetoothRFCOMMChannel *)channel delegate:(id)delegate; /* * Starts the server. The server will now receive and process client requests. */ - (void)run; /* * Closes the server. It cannot be started again after this. */ - (void)close; /* * Sets to be the next response code to be sent for the current * request. * * Available response codes are listed in the OBEXOpCodeResponseValues enum in * . (Use the codes that end with "WithFinalBit".) For * example, you could set the response code to * kOBEXResponseCodeNotFoundWithFinalBit if a client requests a non-existent * file. */ - (void)setResponseCodeForCurrentRequest:(int)responseCode; /* * Adds to the next response headers to be sent for the * current request. * * For example, OBEX servers commonly include a "Length" header when * responding to a Get request to indicate the size of the file to be * transferred. */ - (void)addResponseHeadersForCurrentRequest:(BBOBEXHeaderSet *)responseHeaders; /* * Sets the server's delegate to . */ - (void)setDelegate:(id)delegate; /* * Returns the delegate for this server. */ - (id)delegate; /* * Sets whether debug messages should be displayed (default is NO). */ + (void)setDebug:(BOOL)debug; @end /* * This informal protocol describes the methods that can be implemented for a * BBBluetoothOBEXServer delegate. * * For each type of client request, there is a "...shouldHandle..." method * (e.g. server:shouldHandleConnectRequest:) that is called when the request * is received. If the delegate does not implement this method for a * particular type of request, the server will automatically refuse all * requests of this type with a "Not Implemented" response. */ @protocol BBBluetoothOBEXServerDelegate /* * Called when an error occurs on the server. is an error code from * and is a description of the error. */ - (void)server:(BBBluetoothOBEXServer *)server errorOccurred:(OBEXError)error description:(NSString *)description; /* * Called when a Connect request is received with the specified . * * This should return YES if the request should be allowed to continue, or NO * if the request should be refused. (By default, a request will be refused * with a 'Forbidden' response; call setResponseCodeForCurrentRequest: to set * a more specific response.) */ - (BOOL)server:(BBBluetoothOBEXServer *)server shouldHandleConnectRequest:(BBOBEXHeaderSet *)requestHeaders; /* * Called when the server finishes processing of a Connect request. */ - (void)serverDidHandleConnectRequest:(BBBluetoothOBEXServer *)server; /* * Called when a Disconnect request is received with the specified . * * This should return YES if the request should be allowed to continue, or NO * if the request should be refused. (By default, a request will be refused * with a 'Forbidden' response; call setResponseCodeForCurrentRequest: to set * a more specific response.) */ - (BOOL)server:(BBBluetoothOBEXServer *)server shouldHandleDisconnectRequest:(BBOBEXHeaderSet *)requestHeaders; /* * Called when the server finishes processing of a Disconnect request. */ - (void)serverDidHandleDisconnectRequest:(BBBluetoothOBEXServer *)server; /* * Called when a Put request is received with the specified . * * This should return an opened NSOutputStream if the request should be allowed * to continue, or nil if the request should be refused. (By default, a request * will be refused with a 'Forbidden' response; call * setResponseCodeForCurrentRequest: to set a more specific response.) * * Note the returned stream *must* be open, or the request will fail. */ - (NSOutputStream *)server:(BBBluetoothOBEXServer *)server shouldHandlePutRequest:(BBOBEXHeaderSet *)requestHeaders; /* * Called each time a chunk of data is received during a Put request. * The indicates the number of bytes received, and is * set to YES if all the data has now been received and the server is about to * send the final response for the request. */ - (void)server:(BBBluetoothOBEXServer *)server didReceiveDataOfLength:(unsigned)length isLastPacket:(BOOL)isLastPacket; /* * Called when the server finishes processing of a Put request. The * is the stream originally provided from * server:shouldHandlePutRequest: and is set to YES if the client * sent an Abort request to cancel the Put request before it was completed. */ - (void)server:(BBBluetoothOBEXServer *)server didHandlePutRequestForStream:(NSOutputStream *)outputStream requestWasAborted:(BOOL)aborted; /* * Called when a Put-Delete request is received with the specified . * * This should return YES if the request should be allowed to continue, or NO * if the request should be refused. (By default, a request will be refused * with a 'Forbidden' response; call setResponseCodeForCurrentRequest: to set * a more specific response.) */ - (BOOL)server:(BBBluetoothOBEXServer *)server shouldHandlePutDeleteRequest:(BBOBEXHeaderSet *)requestHeaders; /* * Called when the server finishes processing of a Put-Delete request. */ - (void)serverDidHandlePutDeleteRequest:(BBBluetoothOBEXServer *)server; /* * Called when a Get request is received with the specified . * * This should return an opened NSInputStream if the request should be allowed * to continue, or nil if the request should be refused. (By default, a request * will be refused with a 'Forbidden' response; call * setResponseCodeForCurrentRequest: to set a more specific response.) * * Note the returned stream *must* be open, or the request will fail. */ - (NSInputStream *)server:(BBBluetoothOBEXServer *)server shouldHandleGetRequest:(BBOBEXHeaderSet *)requestHeaders; /* * Called each time a chunk of data is sent during a Get request. * The indicates the number of bytes sent. */ - (void)server:(BBBluetoothOBEXServer *)server didSendDataOfLength:(unsigned)length; /* * Called when the server finishes processing of a Get request. The * is the stream originally provided from * server:shouldHandleGetRequest: and is set to YES if the client * sent an Abort request to cancel the Get request before it was completed. */ - (void)server:(BBBluetoothOBEXServer *)server didHandleGetRequestForStream:(NSInputStream *)inputStream requestWasAborted:(BOOL)aborted; /* * Called when a SetPath request is received with the specified * and SetPath . The first two bits of the flags are significant * for the SetPath operation: * - Bit 0 is set if the server should back up one level (i.e. "..") * before applying the requested path name * - Bit 1 is set if the server should respond with an error instead of * creating a directory if the specified directory does not exist * * This should return YES if the request should be allowed to continue, or NO * if the request should be refused. (By default, a request will be refused * with a 'Forbidden' response; call setResponseCodeForCurrentRequest: to set * a more specific response.) */ - (BOOL)server:(BBBluetoothOBEXServer *)server shouldHandleSetPathRequest:(BBOBEXHeaderSet *)requestHeaders withFlags:(OBEXFlags)flags; /* * Called when the server finishes processing of a SetPath request. */ - (void)serverDidHandleSetPathRequest:(BBBluetoothOBEXServer *)server; @end lightblue-0.3.2/src/mac/LightAquaBlue/._BBBluetoothOBEXServer.m 0000644 0000765 0000000 00000000122 10750744407 023772 0 ustar bea wheel 0000000 0000000 Mac OS X 2 R TEXT lightblue-0.3.2/src/mac/LightAquaBlue/BBBluetoothOBEXServer.m 0000644 0000765 0000765 00000021746 10750744407 023241 0 ustar bea bea 0000000 0000000 /* * Copyright (c) 2006 Bea Lam. All rights reserved. * * Permission is hereby granted, free of charge, to any person * obtaining a copy of this software and associated documentation files * (the "Software"), to deal in the Software without restriction, * including without limitation the rights to use, copy, modify, merge, * publish, distribute, sublicense, and/or sell copies of the Software, * and to permit persons to whom the Software is furnished to do so, * subject to the following conditions: * * The above copyright notice and this permission notice shall be * included in all copies or substantial portions of the Software. * * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */ // // BBBluetoothOBEXServer.m // LightAquaBlue // #import "BBBluetoothOBEXServer.h" #import "BBOBEXRequestHandler.h" #import "BBOBEXHeaderSet.h" #import #import #define DEBUG_NAME @"[BBBluetoothOBEXServer] " static BOOL _debug = NO; @implementation BBBluetoothOBEXServer - (void)errorOccurred:(OBEXError)error description:(NSString *)description { if (_debug) NSLog(DEBUG_NAME @"errorOccurred: %d description: %@", error, description); if ([mDelegate respondsToSelector:@selector(server:errorOccurred:description:)]) { [mDelegate server:self errorOccurred:error description:description]; } } + (id)serverWithIncomingRFCOMMChannel:(IOBluetoothRFCOMMChannel *)channel delegate:(id)delegate { return [[[BBBluetoothOBEXServer alloc] initWithIncomingRFCOMMChannel:channel delegate:delegate] autorelease]; } - (id)initWithIncomingRFCOMMChannel:(IOBluetoothRFCOMMChannel *)channel delegate:(id)delegate { self = [super init]; mChannel = [channel retain]; mDelegate = delegate; return self; } - (BBOBEXRequestHandler *)handlerForEventType:(OBEXSessionEventType)type { BBOBEXRequestHandler *handler = nil; SEL selector = @selector(handleSessionEvent:); switch (type) { case kOBEXSessionEventTypeConnectCommandReceived: handler = [[BBOBEXConnectRequestHandler alloc] initWithServer:self eventSelector:selector session:mSession]; break; case kOBEXSessionEventTypeDisconnectCommandReceived: handler = [[BBOBEXDisconnectRequestHandler alloc] initWithServer:self eventSelector:selector session:mSession]; break; case kOBEXSessionEventTypePutCommandReceived: handler = [[BBOBEXPutRequestHandler alloc] initWithServer:self eventSelector:selector session:mSession]; break; case kOBEXSessionEventTypeGetCommandReceived: handler = [[BBOBEXGetRequestHandler alloc] initWithServer:self eventSelector:selector session:mSession]; break; case kOBEXSessionEventTypeSetPathCommandReceived: handler = [[BBOBEXSetPathRequestHandler alloc] initWithServer:self eventSelector:selector session:mSession]; break; } [handler autorelease]; return handler; } - (void)channelClosed:(IOBluetoothUserNotification *)notification channel:(IOBluetoothRFCOMMChannel *)channel { if (_debug) NSLog(DEBUG_NAME @"RFCOMM channel closed!"); if (mSession) { [self errorOccurred:kOBEXSessionTransportDiedError description:@"Bluetooth transport connection died"]; } if (channel == mChannel) [self close]; } - (void)run { if (mChannel) { IOBluetoothOBEXSession *session = [IOBluetoothOBEXSession withIncomingRFCOMMChannel:mChannel eventSelector:@selector(handleSessionEvent:) selectorTarget:self refCon:NULL]; mSession = [session retain]; mChannelNotif = [mChannel registerForChannelCloseNotification:self selector:@selector(channelClosed:channel:)]; } else if (mSession) { // for internal testing //NSLog(@"send dummy event"); // dummy event - event selector doesn't seem to get set otherwise if // I just call setEventSelector:target:refCon: [mSession OBEXConnectResponse:kOBEXResponseCodeSuccessWithFinalBit flags:0 maxPacketLength:1024 optionalHeaders:NULL optionalHeadersLength:0 eventSelector:@selector(handleSessionEvent:) selectorTarget:self refCon:NULL]; } } - (void)close { if (_debug) NSLog(DEBUG_NAME @"close"); [mChannelNotif unregister]; mChannelNotif = nil; // must set the event selector and target to NULL, otherwise the // OBEXSession might continue to try to send us events (e.g. if there's // a link error) if (mSession) [mSession setEventSelector:NULL target:nil refCon:NULL]; [mCurrentRequestHandler release]; mCurrentRequestHandler = nil; [mChannel release]; mChannel = nil; [mSession release]; mSession = nil; } - (void)setResponseCodeForCurrentRequest:(int)responseCode { if (mCurrentRequestHandler) [mCurrentRequestHandler setNextResponseCode:responseCode]; } - (void)addResponseHeadersForCurrentRequest:(BBOBEXHeaderSet *)responseHeaders { if (mCurrentRequestHandler) [mCurrentRequestHandler addResponseHeaders:responseHeaders]; } - (void)handleSessionEvent:(const OBEXSessionEvent *)event { if (_debug) NSLog(DEBUG_NAME @"handleSessionEvent %d", event->type); if (event->type == kOBEXSessionEventTypeError) { if (mCurrentRequestHandler) { [self errorOccurred:event->u.errorData.error description:@"Error occurred during client request"]; } else { [self errorOccurred:event->u.errorData.error description:@"Error occurred while server was idle"]; } } else if (event->type == kOBEXSessionEventTypeAbortCommandReceived) { if (mCurrentRequestHandler) { if (_debug) NSLog(DEBUG_NAME @"Aborting current request..."); [mCurrentRequestHandler handleRequestAborted]; } else { if (_debug) NSLog(DEBUG_NAME @"Got Abort request, but no request to abort"); // not really an error, so errorOccurred: not called } } else { if (_debug) NSLog(DEBUG_NAME @"Received client request"); if (!mCurrentRequestHandler) { mCurrentRequestHandler = [self handlerForEventType:event->type]; if (!mCurrentRequestHandler) { [self errorOccurred:kOBEXGeneralError description:[NSString stringWithFormat:@"Server received unknown event: %d", event->type]]; return; } [mCurrentRequestHandler retain]; } if (_debug) NSLog(DEBUG_NAME @"Found handler, %@", mCurrentRequestHandler); BOOL requestFinished = [mCurrentRequestHandler handleRequestEvent:event]; if (requestFinished) { if (_debug) NSLog(DEBUG_NAME @"Finished request"); [mCurrentRequestHandler release]; mCurrentRequestHandler = nil; } } } - (void)setOBEXSession:(OBEXSession *)session { [session retain]; [mSession release]; mSession = session; } - (void)setDelegate:(id)delegate { mDelegate = delegate; } - (id)delegate { return mDelegate; } + (void)setDebug:(BOOL)debug { _debug = debug; [BBOBEXRequestHandler setDebug:debug]; } - (void)dealloc { [self close]; [super dealloc]; } @end lightblue-0.3.2/src/mac/LightAquaBlue/BBLocalDevice.h 0000644 0000765 0000765 00000003474 10747223642 021571 0 ustar bea bea 0000000 0000000 /* * Copyright (c) 2006 Bea Lam. All rights reserved. * * Permission is hereby granted, free of charge, to any person * obtaining a copy of this software and associated documentation files * (the "Software"), to deal in the Software without restriction, * including without limitation the rights to use, copy, modify, merge, * publish, distribute, sublicense, and/or sell copies of the Software, * and to permit persons to whom the Software is furnished to do so, * subject to the following conditions: * * The above copyright notice and this permission notice shall be * included in all copies or substantial portions of the Software. * * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */ // // BBLocalDevice.h // LightAquaBlue // // Provides information about the local Bluetooth device. // #import #import @interface BBLocalDevice : NSObject { // } /* * Returns the local device name, or nil if it can't be read. */ + (NSString *)getName; /* * Returns the local device address as a string, or nil if it can't be read. * The address is separated by hyphens, e.g. "00-11-22-33-44-55". */ + (NSString *)getAddressString; /* * Returns the local device's class of device, or -1 if it can't be read. */ + (BluetoothClassOfDevice)getClassOfDevice; /* * Returns YES if the local device is available and switched on. */ + (BOOL)isPoweredOn; @end lightblue-0.3.2/src/mac/LightAquaBlue/BBLocalDevice.m 0000644 0000765 0000765 00000004763 10747223642 021600 0 ustar bea bea 0000000 0000000 /* * Copyright (c) 2006 Bea Lam. All rights reserved. * * Permission is hereby granted, free of charge, to any person * obtaining a copy of this software and associated documentation files * (the "Software"), to deal in the Software without restriction, * including without limitation the rights to use, copy, modify, merge, * publish, distribute, sublicense, and/or sell copies of the Software, * and to permit persons to whom the Software is furnished to do so, * subject to the following conditions: * * The above copyright notice and this permission notice shall be * included in all copies or substantial portions of the Software. * * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */ // // BBLocalDevice.m // LightAquaBlue // #import #import #import #import "BBLocalDevice.h" @implementation BBLocalDevice + (NSString *)getName { BluetoothDeviceName name; IOReturn result; result = IOBluetoothLocalDeviceReadName(name, NULL, NULL, NULL); if (result == kIOReturnSuccess) { NSString *s = [NSString stringWithCString:(char *)name]; if (s != nil) return s; } return nil; } + (NSString *)getAddressString { BluetoothDeviceAddress address; IOReturn result; result = IOBluetoothLocalDeviceReadAddress(&address, NULL, NULL, NULL); if (result == kIOReturnSuccess) { return IOBluetoothNSStringFromDeviceAddress(&address); } return nil; } + (BluetoothClassOfDevice)getClassOfDevice { BluetoothClassOfDevice classOfDevice; IOReturn result; result = IOBluetoothLocalDeviceReadClassOfDevice(&classOfDevice, NULL, NULL, NULL); if (result == kIOReturnSuccess) { return classOfDevice; } return -1; } + (BOOL)isPoweredOn { if (!IOBluetoothLocalDeviceAvailable()) return NO; BluetoothHCIPowerState powerState; IOReturn status = IOBluetoothLocalDeviceGetPowerState(&powerState); if (status != kIOReturnSuccess || powerState != kBluetoothHCIPowerStateON) return NO; return YES; } @end lightblue-0.3.2/src/mac/LightAquaBlue/._BBMutableOBEXHeaderSet.h 0000644 0000765 0000000 00000000122 10750035142 023774 0 ustar bea wheel 0000000 0000000 Mac OS X 2 R TEXT lightblue-0.3.2/src/mac/LightAquaBlue/BBMutableOBEXHeaderSet.h 0000644 0000765 0000765 00000012445 10750035142 023237 0 ustar bea bea 0000000 0000000 /* * Copyright (c) 2006 Bea Lam. All rights reserved. * * Permission is hereby granted, free of charge, to any person * obtaining a copy of this software and associated documentation files * (the "Software"), to deal in the Software without restriction, * including without limitation the rights to use, copy, modify, merge, * publish, distribute, sublicense, and/or sell copies of the Software, * and to permit persons to whom the Software is furnished to do so, * subject to the following conditions: * * The above copyright notice and this permission notice shall be * included in all copies or substantial portions of the Software. * * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */ // // BBMutableOBEXHeaderSet.h // LightAquaBlue // // A mutable version of BBOBEXHeaderSet that allows adding and removing // of headers. // #import "BBOBEXHeaderSet.h" @interface BBMutableOBEXHeaderSet : BBOBEXHeaderSet { CFMutableDictionaryRef mMutableDict; } /* * Creates and returns an empty header set. */ + (id)headerSet; /* * Removes the header from this header set. */ - (void)removeValueForHeader:(uint8_t)headerID; /* * Sets the value for the Name header to , overriding any existing * value for this header. */ - (void)setValueForNameHeader:(NSString *)name; /* * Sets the value for the Type header to , overriding any existing * value for this header. */ - (void)setValueForTypeHeader:(NSString *)type; /* * Sets the value for the Length header to , overriding any existing * value for this header. */ - (void)setValueForLengthHeader:(uint32_t)length; /* * Sets the value for the Time (0x44) header to , overriding any * existing value for this header. Assumes is in local time. */ - (void)setValueForTimeHeader:(NSDate *)date; /* * Sets the value for the Time (0x44) header to , overriding any * existing value for this header. If is YES, the time value is * marked as UTC time, otherwise it is marked as local time. */ - (void)setValueForTimeHeader:(NSDate *)date isUTCTime:(BOOL)isUTCTime; /* * Sets the value for the Description header to , overriding * any existing value for this header. */ - (void)setValueForDescriptionHeader:(NSString *)description; /* * Sets the value for the Target header to , overriding * any existing value for this header. */ - (void)setValueForTargetHeader:(NSData *)target; /* * Sets the value for the HTTP header to , overriding * any existing value for this header. */ - (void)setValueForHTTPHeader:(NSData *)http; /* * Sets the value for the Who header to , overriding * any existing value for this header. */ - (void)setValueForWhoHeader:(NSData *)who; /* * Sets the value for the Connection Id header to , overriding * any existing value for this header. */ - (void)setValueForConnectionIDHeader:(uint32_t)connectionID; /* * Sets the value for the Application Parameters header to , * overriding any existing value for this header. */ - (void)setValueForApplicationParametersHeader:(NSData *)appParameters; /* * Sets the value for the Authorization Challenge header to , * overriding any existing value for this header. */ - (void)setValueForAuthorizationChallengeHeader:(NSData *)authChallenge; /* * Sets the value for the Authorization Response header to , * overriding any existing value for this header. */ - (void)setValueForAuthorizationResponseHeader:(NSData *)authResponse; /* * Sets the value for the Object Class header to , * overriding any existing value for this header. */ - (void)setValueForObjectClassHeader:(NSData *)objectClass; /* * Sets the value for the unicode-encoded header to , * overriding any existing value for this header. */ - (void)setValue:(NSString *)value forUnicodeHeader:(uint8_t)headerID; /* * Sets the value for the byte-sequence-encoded header to , * overriding any existing value for this header. */ - (void)setValue:(NSData *)value forByteSequenceHeader:(uint8_t)headerID; /* * Sets the value for the 4-byte-header to , * overriding any existing value for this header. */ - (void)setValue:(uint32_t)value for4ByteHeader:(uint8_t)headerID; /* * Sets the value for the 1-byte-encoded header to