"""
Client Module
=============
"""
import os
import urllib2
import python_webdav.connection as conn
class Client(object):
def __init__(self, webdav_server_uri, webdav_path='.', port=80, realm=''):
"""
The Client module is not yet ready for use. The purpose of this module is to
make WebDAV use easier. The Connection.Client object is for lower level use
while this top level module will hopefully aid in quicker development.
"""
self._connection_settings = dict(host=webdav_server_uri,
path=webdav_path,
port=port, realm=realm)
path = self._connection_settings['path']
if path[-1] != '/' and path != '.':
self._connection_settings['path'] += '/'
self.connection = None
def set_connection(self, username='', password=''):
""" Set up the connection object
"""
self._connection_settings['username'] = username
self._connection_settings['password'] = password
self.connection = conn.Connection(self._connection_settings)
self.client = conn.Client()
def download_file(self, file_path, dest_path='.'):
""" Download a file from file_path to dest_path
"""
resource_path = urllib2.urlparse.urljoin(self.connection.path,
file_path.strip('/'))
resp, content = self.connection.send_get(resource_path)
file_name = os.path.basename(file_path)
write_to_path = os.path.join(dest_path, file_name)
try:
file_fd = open(write_to_path, 'wb')
file_fd.write(content)
except IOError:
raise
finally:
file_fd.close()
return resp, content
def chdir(self, directory):
""" Change directory from whatever current dir is to directory specified
"""
# Make sure there's a leading '/'
if not self.connection.path.startswith('/'):
self.connection.path = '/' + self.connection.path
self.connection.path = os.path.realpath(
os.path.join(self.connection.path, directory))
def mkdir(self, path):
""" Make a directory (collection). If path does not start with '/'
it is assumed to be relative to the current working directory.
"""
if not path.startswith('/'):
path = self.connection.path + '/' + path
self.connection.send_mkcol(path)
# ---------------- UNFINISHED --------------- #
def ls(self, path='', list_format=('F','C','M'), separator='\t', display=True):
"""
list_format: This is the format for the directory listing
The format symbals are:
T - Type (resourcetype)
D - Date Time (creationdate)
F - Filename (href)
M - Last modified time (getlastmodified)
A - Attributes (executable)
E - ETag (getetag)
C - Content type (getcontenttype)
"""
# Format Map
format_map = {'T': 'resourcetype',
'D': 'creationdate',
'F': 'href',
'M': 'getlastmodified',
'A': 'executable',
'E': 'getetag',
'C': 'getcontenttype'}
# Get the properties for the given path
if not path:
path = self.connection.path
props = self.client.get_properties(self.connection, path)
property_lists = []
for prop in props:
format_string = ''
formatted_list = [getattr(prop, format_map[symbol]) for symbol in list_format]
property_lists.append(formatted_list)
format_string = separator.join(formatted_list)
if display:
print format_string
return property_lists
def pwd(self):
""" Return the working directory
"""
if self.connection:
return self.connection.path
else:
return None
