984 строки
33 KiB
Python
984 строки
33 KiB
Python
|
#-------------------------------------------------------------------------
|
||
|
|
# Copyright (c) Microsoft. All rights reserved.
|
||
|
|
#
|
||
|
|
# Licensed under the Apache License, Version 2.0 (the "License");
|
||
|
|
# you may not use this file except in compliance with the License.
|
||
|
|
# You may obtain a copy of the License at
|
||
|
|
# http://www.apache.org/licenses/LICENSE-2.0
|
||
|
|
#
|
||
|
|
# Unless required by applicable law or agreed to in writing, software
|
||
|
|
# distributed under the License is distributed on an "AS IS" BASIS,
|
||
|
|
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||
|
|
# See the License for the specific language governing permissions and
|
||
|
|
# limitations under the License.
|
||
|
|
#--------------------------------------------------------------------------
|
||
|
|
import ast
|
||
|
|
import base64
|
||
|
|
import hashlib
|
||
|
|
import hmac
|
||
|
|
import sys
|
||
|
|
import types
|
||
|
|
import warnings
|
||
|
|
import inspect
|
||
|
|
if sys.version_info < (3,):
|
||
|
|
from urllib2 import quote as url_quote
|
||
|
|
from urllib2 import unquote as url_unquote
|
||
|
|
_strtype = basestring
|
||
|
|
else:
|
||
|
|
from urllib.parse import quote as url_quote
|
||
|
|
from urllib.parse import unquote as url_unquote
|
||
|
|
_strtype = str
|
||
|
|
|
||
|
|
from datetime import datetime
|
||
|
|
from xml.dom import minidom
|
||
|
|
from xml.sax.saxutils import escape as xml_escape
|
||
|
|
|
||
|
|
#--------------------------------------------------------------------------
|
||
|
|
# constants
|
||
|
|
|
||
|
|
__author__ = 'Microsoft Corp. <ptvshelp@microsoft.com>'
|
||
|
|
__version__ = '0.8.4'
|
||
|
|
|
||
|
|
# Live ServiceClient URLs
|
||
|
|
BLOB_SERVICE_HOST_BASE = '.blob.core.windows.net'
|
||
|
|
QUEUE_SERVICE_HOST_BASE = '.queue.core.windows.net'
|
||
|
|
TABLE_SERVICE_HOST_BASE = '.table.core.windows.net'
|
||
|
|
SERVICE_BUS_HOST_BASE = '.servicebus.windows.net'
|
||
|
|
MANAGEMENT_HOST = 'management.core.windows.net'
|
||
|
|
|
||
|
|
# Development ServiceClient URLs
|
||
|
|
DEV_BLOB_HOST = '127.0.0.1:10000'
|
||
|
|
DEV_QUEUE_HOST = '127.0.0.1:10001'
|
||
|
|
DEV_TABLE_HOST = '127.0.0.1:10002'
|
||
|
|
|
||
|
|
# Default credentials for Development Storage Service
|
||
|
|
DEV_ACCOUNT_NAME = 'devstoreaccount1'
|
||
|
|
DEV_ACCOUNT_KEY = 'Eby8vdM02xNOcqFlqUwJPLlmEtlCDXJ1OUzFT50uSRZ6IFsuFq2UVErCz4I6tq/K1SZFPTOtr/KBHBeksoGMGw=='
|
||
|
|
|
||
|
|
# All of our error messages
|
||
|
|
_ERROR_CANNOT_FIND_PARTITION_KEY = 'Cannot find partition key in request.'
|
||
|
|
_ERROR_CANNOT_FIND_ROW_KEY = 'Cannot find row key in request.'
|
||
|
|
_ERROR_INCORRECT_TABLE_IN_BATCH = \
|
||
|
|
'Table should be the same in a batch operations'
|
||
|
|
_ERROR_INCORRECT_PARTITION_KEY_IN_BATCH = \
|
||
|
|
'Partition Key should be the same in a batch operations'
|
||
|
|
_ERROR_DUPLICATE_ROW_KEY_IN_BATCH = \
|
||
|
|
'Row Keys should not be the same in a batch operations'
|
||
|
|
_ERROR_BATCH_COMMIT_FAIL = 'Batch Commit Fail'
|
||
|
|
_ERROR_MESSAGE_NOT_PEEK_LOCKED_ON_DELETE = \
|
||
|
|
'Message is not peek locked and cannot be deleted.'
|
||
|
|
_ERROR_MESSAGE_NOT_PEEK_LOCKED_ON_UNLOCK = \
|
||
|
|
'Message is not peek locked and cannot be unlocked.'
|
||
|
|
_ERROR_QUEUE_NOT_FOUND = 'Queue was not found'
|
||
|
|
_ERROR_TOPIC_NOT_FOUND = 'Topic was not found'
|
||
|
|
_ERROR_CONFLICT = 'Conflict ({0})'
|
||
|
|
_ERROR_NOT_FOUND = 'Not found ({0})'
|
||
|
|
_ERROR_UNKNOWN = 'Unknown error ({0})'
|
||
|
|
_ERROR_SERVICEBUS_MISSING_INFO = \
|
||
|
|
'You need to provide servicebus namespace, access key and Issuer'
|
||
|
|
_ERROR_STORAGE_MISSING_INFO = \
|
||
|
|
'You need to provide both account name and access key'
|
||
|
|
_ERROR_ACCESS_POLICY = \
|
||
|
|
'share_access_policy must be either SignedIdentifier or AccessPolicy ' + \
|
||
|
|
'instance'
|
||
|
|
_WARNING_VALUE_SHOULD_BE_BYTES = \
|
||
|
|
'Warning: {0} must be bytes data type. It will be converted ' + \
|
||
|
|
'automatically, with utf-8 text encoding.'
|
||
|
|
_ERROR_VALUE_SHOULD_BE_BYTES = '{0} should be of type bytes.'
|
||
|
|
_ERROR_VALUE_NONE = '{0} should not be None.'
|
||
|
|
_ERROR_VALUE_NEGATIVE = '{0} should not be negative.'
|
||
|
|
_ERROR_CANNOT_SERIALIZE_VALUE_TO_ENTITY = \
|
||
|
|
'Cannot serialize the specified value ({0}) to an entity. Please use ' + \
|
||
|
|
'an EntityProperty (which can specify custom types), int, str, bool, ' + \
|
||
|
|
'or datetime.'
|
||
|
|
_ERROR_PAGE_BLOB_SIZE_ALIGNMENT = \
|
||
|
|
'Invalid page blob size: {0}. ' + \
|
||
|
|
'The size must be aligned to a 512-byte boundary.'
|
||
|
|
|
||
|
|
_USER_AGENT_STRING = 'pyazure/' + __version__
|
||
|
|
|
||
|
|
METADATA_NS = 'http://schemas.microsoft.com/ado/2007/08/dataservices/metadata'
|
||
|
|
|
||
|
|
|
||
|
|
class WindowsAzureData(object):
|
||
|
|
|
||
|
|
''' This is the base of data class.
|
||
|
|
It is only used to check whether it is instance or not. '''
|
||
|
|
pass
|
||
|
|
|
||
|
|
|
||
|
|
class WindowsAzureError(Exception):
|
||
|
|
|
||
|
|
''' WindowsAzure Excpetion base class. '''
|
||
|
|
|
||
|
|
def __init__(self, message):
|
||
|
|
super(WindowsAzureError, self).__init__(message)
|
||
|
|
|
||
|
|
|
||
|
|
class WindowsAzureConflictError(WindowsAzureError):
|
||
|
|
|
||
|
|
'''Indicates that the resource could not be created because it already
|
||
|
|
exists'''
|
||
|
|
|
||
|
|
def __init__(self, message):
|
||
|
|
super(WindowsAzureConflictError, self).__init__(message)
|
||
|
|
|
||
|
|
|
||
|
|
class WindowsAzureMissingResourceError(WindowsAzureError):
|
||
|
|
|
||
|
|
'''Indicates that a request for a request for a resource (queue, table,
|
||
|
|
container, etc...) failed because the specified resource does not exist'''
|
||
|
|
|
||
|
|
def __init__(self, message):
|
||
|
|
super(WindowsAzureMissingResourceError, self).__init__(message)
|
||
|
|
|
||
|
|
|
||
|
|
class WindowsAzureBatchOperationError(WindowsAzureError):
|
||
|
|
|
||
|
|
'''Indicates that a batch operation failed'''
|
||
|
|
|
||
|
|
def __init__(self, message, code):
|
||
|
|
super(WindowsAzureBatchOperationError, self).__init__(message)
|
||
|
|
self.code = code
|
||
|
|
|
||
|
|
|
||
|
|
class Feed(object):
|
||
|
|
pass
|
||
|
|
|
||
|
|
|
||
|
|
class _Base64String(str):
|
||
|
|
pass
|
||
|
|
|
||
|
|
|
||
|
|
class HeaderDict(dict):
|
||
|
|
|
||
|
|
def __getitem__(self, index):
|
||
|
|
return super(HeaderDict, self).__getitem__(index.lower())
|
||
|
|
|
||
|
|
|
||
|
|
def _encode_base64(data):
|
||
|
|
if isinstance(data, _unicode_type):
|
||
|
|
data = data.encode('utf-8')
|
||
|
|
encoded = base64.b64encode(data)
|
||
|
|
return encoded.decode('utf-8')
|
||
|
|
|
||
|
|
|
||
|
|
def _decode_base64_to_bytes(data):
|
||
|
|
if isinstance(data, _unicode_type):
|
||
|
|
data = data.encode('utf-8')
|
||
|
|
return base64.b64decode(data)
|
||
|
|
|
||
|
|
|
||
|
|
def _decode_base64_to_text(data):
|
||
|
|
decoded_bytes = _decode_base64_to_bytes(data)
|
||
|
|
return decoded_bytes.decode('utf-8')
|
||
|
|
|
||
|
|
|
||
|
|
def _get_readable_id(id_name, id_prefix_to_skip):
|
||
|
|
"""simplified an id to be more friendly for us people"""
|
||
|
|
# id_name is in the form 'https://namespace.host.suffix/name'
|
||
|
|
# where name may contain a forward slash!
|
||
|
|
pos = id_name.find('//')
|
||
|
|
if pos != -1:
|
||
|
|
pos += 2
|
||
|
|
if id_prefix_to_skip:
|
||
|
|
pos = id_name.find(id_prefix_to_skip, pos)
|
||
|
|
if pos != -1:
|
||
|
|
pos += len(id_prefix_to_skip)
|
||
|
|
pos = id_name.find('/', pos)
|
||
|
|
if pos != -1:
|
||
|
|
return id_name[pos + 1:]
|
||
|
|
return id_name
|
||
|
|
|
||
|
|
|
||
|
|
def _get_entry_properties_from_node(entry, include_id, id_prefix_to_skip=None, use_title_as_id=False):
|
||
|
|
''' get properties from entry xml '''
|
||
|
|
properties = {}
|
||
|
|
|
||
|
|
etag = entry.getAttributeNS(METADATA_NS, 'etag')
|
||
|
|
if etag:
|
||
|
|
properties['etag'] = etag
|
||
|
|
for updated in _get_child_nodes(entry, 'updated'):
|
||
|
|
properties['updated'] = updated.firstChild.nodeValue
|
||
|
|
for name in _get_children_from_path(entry, 'author', 'name'):
|
||
|
|
if name.firstChild is not None:
|
||
|
|
properties['author'] = name.firstChild.nodeValue
|
||
|
|
|
||
|
|
if include_id:
|
||
|
|
if use_title_as_id:
|
||
|
|
for title in _get_child_nodes(entry, 'title'):
|
||
|
|
properties['name'] = title.firstChild.nodeValue
|
||
|
|
else:
|
||
|
|
for id in _get_child_nodes(entry, 'id'):
|
||
|
|
properties['name'] = _get_readable_id(
|
||
|
|
id.firstChild.nodeValue, id_prefix_to_skip)
|
||
|
|
|
||
|
|
return properties
|
||
|
|
|
||
|
|
|
||
|
|
def _get_entry_properties(xmlstr, include_id, id_prefix_to_skip=None):
|
||
|
|
''' get properties from entry xml '''
|
||
|
|
xmldoc = minidom.parseString(xmlstr)
|
||
|
|
properties = {}
|
||
|
|
|
||
|
|
for entry in _get_child_nodes(xmldoc, 'entry'):
|
||
|
|
properties.update(_get_entry_properties_from_node(entry, include_id, id_prefix_to_skip))
|
||
|
|
|
||
|
|
return properties
|
||
|
|
|
||
|
|
|
||
|
|
def _get_first_child_node_value(parent_node, node_name):
|
||
|
|
xml_attrs = _get_child_nodes(parent_node, node_name)
|
||
|
|
if xml_attrs:
|
||
|
|
xml_attr = xml_attrs[0]
|
||
|
|
if xml_attr.firstChild:
|
||
|
|
value = xml_attr.firstChild.nodeValue
|
||
|
|
return value
|
||
|
|
|
||
|
|
|
||
|
|
def _get_child_nodes(node, tagName):
|
||
|
|
return [childNode for childNode in node.getElementsByTagName(tagName)
|
||
|
|
if childNode.parentNode == node]
|
||
|
|
|
||
|
|
|
||
|
|
def _get_children_from_path(node, *path):
|
||
|
|
'''descends through a hierarchy of nodes returning the list of children
|
||
|
|
at the inner most level. Only returns children who share a common parent,
|
||
|
|
not cousins.'''
|
||
|
|
cur = node
|
||
|
|
for index, child in enumerate(path):
|
||
|
|
if isinstance(child, _strtype):
|
||
|
|
next = _get_child_nodes(cur, child)
|
||
|
|
else:
|
||
|
|
next = _get_child_nodesNS(cur, *child)
|
||
|
|
if index == len(path) - 1:
|
||
|
|
return next
|
||
|
|
elif not next:
|
||
|
|
break
|
||
|
|
|
||
|
|
cur = next[0]
|
||
|
|
return []
|
||
|
|
|
||
|
|
|
||
|
|
def _get_child_nodesNS(node, ns, tagName):
|
||
|
|
return [childNode for childNode in node.getElementsByTagNameNS(ns, tagName)
|
||
|
|
if childNode.parentNode == node]
|
||
|
|
|
||
|
|
|
||
|
|
def _create_entry(entry_body):
|
||
|
|
''' Adds common part of entry to a given entry body and return the whole
|
||
|
|
xml. '''
|
||
|
|
updated_str = datetime.utcnow().isoformat()
|
||
|
|
if datetime.utcnow().utcoffset() is None:
|
||
|
|
updated_str += '+00:00'
|
||
|
|
|
||
|
|
entry_start = '''<?xml version="1.0" encoding="utf-8" standalone="yes"?>
|
||
|
|
<entry xmlns:d="http://schemas.microsoft.com/ado/2007/08/dataservices" xmlns:m="http://schemas.microsoft.com/ado/2007/08/dataservices/metadata" xmlns="http://www.w3.org/2005/Atom" >
|
||
|
|
<title /><updated>{updated}</updated><author><name /></author><id />
|
||
|
|
<content type="application/xml">
|
||
|
|
{body}</content></entry>'''
|
||
|
|
return entry_start.format(updated=updated_str, body=entry_body)
|
||
|
|
|
||
|
|
|
||
|
|
def _to_datetime(strtime):
|
||
|
|
return datetime.strptime(strtime, "%Y-%m-%dT%H:%M:%S.%f")
|
||
|
|
|
||
|
|
_KNOWN_SERIALIZATION_XFORMS = {
|
||
|
|
'include_apis': 'IncludeAPIs',
|
||
|
|
'message_id': 'MessageId',
|
||
|
|
'content_md5': 'Content-MD5',
|
||
|
|
'last_modified': 'Last-Modified',
|
||
|
|
'cache_control': 'Cache-Control',
|
||
|
|
'account_admin_live_email_id': 'AccountAdminLiveEmailId',
|
||
|
|
'service_admin_live_email_id': 'ServiceAdminLiveEmailId',
|
||
|
|
'subscription_id': 'SubscriptionID',
|
||
|
|
'fqdn': 'FQDN',
|
||
|
|
'private_id': 'PrivateID',
|
||
|
|
'os_virtual_hard_disk': 'OSVirtualHardDisk',
|
||
|
|
'logical_disk_size_in_gb': 'LogicalDiskSizeInGB',
|
||
|
|
'logical_size_in_gb': 'LogicalSizeInGB',
|
||
|
|
'os': 'OS',
|
||
|
|
'persistent_vm_downtime_info': 'PersistentVMDowntimeInfo',
|
||
|
|
'copy_id': 'CopyId',
|
||
|
|
}
|
||
|
|
|
||
|
|
|
||
|
|
def _get_serialization_name(element_name):
|
||
|
|
"""converts a Python name into a serializable name"""
|
||
|
|
known = _KNOWN_SERIALIZATION_XFORMS.get(element_name)
|
||
|
|
if known is not None:
|
||
|
|
return known
|
||
|
|
|
||
|
|
if element_name.startswith('x_ms_'):
|
||
|
|
return element_name.replace('_', '-')
|
||
|
|
if element_name.endswith('_id'):
|
||
|
|
element_name = element_name.replace('_id', 'ID')
|
||
|
|
for name in ['content_', 'last_modified', 'if_', 'cache_control']:
|
||
|
|
if element_name.startswith(name):
|
||
|
|
element_name = element_name.replace('_', '-_')
|
||
|
|
|
||
|
|
return ''.join(name.capitalize() for name in element_name.split('_'))
|
||
|
|
|
||
|
|
if sys.version_info < (3,):
|
||
|
|
_unicode_type = unicode
|
||
|
|
|
||
|
|
def _str(value):
|
||
|
|
if isinstance(value, unicode):
|
||
|
|
return value.encode('utf-8')
|
||
|
|
|
||
|
|
return str(value)
|
||
|
|
else:
|
||
|
|
_str = str
|
||
|
|
_unicode_type = str
|
||
|
|
|
||
|
|
|
||
|
|
def _str_or_none(value):
|
||
|
|
if value is None:
|
||
|
|
return None
|
||
|
|
|
||
|
|
return _str(value)
|
||
|
|
|
||
|
|
|
||
|
|
def _int_or_none(value):
|
||
|
|
if value is None:
|
||
|
|
return None
|
||
|
|
|
||
|
|
return str(int(value))
|
||
|
|
|
||
|
|
|
||
|
|
def _bool_or_none(value):
|
||
|
|
if value is None:
|
||
|
|
return None
|
||
|
|
|
||
|
|
if isinstance(value, bool):
|
||
|
|
if value:
|
||
|
|
return 'true'
|
||
|
|
else:
|
||
|
|
return 'false'
|
||
|
|
|
||
|
|
return str(value)
|
||
|
|
|
||
|
|
|
||
|
|
def _convert_class_to_xml(source, xml_prefix=True):
|
||
|
|
if source is None:
|
||
|
|
return ''
|
||
|
|
|
||
|
|
xmlstr = ''
|
||
|
|
if xml_prefix:
|
||
|
|
xmlstr = '<?xml version="1.0" encoding="utf-8"?>'
|
||
|
|
|
||
|
|
if isinstance(source, list):
|
||
|
|
for value in source:
|
||
|
|
xmlstr += _convert_class_to_xml(value, False)
|
||
|
|
elif isinstance(source, WindowsAzureData):
|
||
|
|
class_name = source.__class__.__name__
|
||
|
|
xmlstr += '<' + class_name + '>'
|
||
|
|
for name, value in vars(source).items():
|
||
|
|
if value is not None:
|
||
|
|
if isinstance(value, list) or \
|
||
|
|
isinstance(value, WindowsAzureData):
|
||
|
|
xmlstr += _convert_class_to_xml(value, False)
|
||
|
|
else:
|
||
|
|
xmlstr += ('<' + _get_serialization_name(name) + '>' +
|
||
|
|
xml_escape(str(value)) + '</' +
|
||
|
|
_get_serialization_name(name) + '>')
|
||
|
|
xmlstr += '</' + class_name + '>'
|
||
|
|
return xmlstr
|
||
|
|
|
||
|
|
|
||
|
|
def _find_namespaces_from_child(parent, child, namespaces):
|
||
|
|
"""Recursively searches from the parent to the child,
|
||
|
|
gathering all the applicable namespaces along the way"""
|
||
|
|
for cur_child in parent.childNodes:
|
||
|
|
if cur_child is child:
|
||
|
|
return True
|
||
|
|
if _find_namespaces_from_child(cur_child, child, namespaces):
|
||
|
|
# we are the parent node
|
||
|
|
for key in cur_child.attributes.keys():
|
||
|
|
if key.startswith('xmlns:') or key == 'xmlns':
|
||
|
|
namespaces[key] = cur_child.attributes[key]
|
||
|
|
break
|
||
|
|
return False
|
||
|
|
|
||
|
|
|
||
|
|
def _find_namespaces(parent, child):
|
||
|
|
res = {}
|
||
|
|
for key in parent.documentElement.attributes.keys():
|
||
|
|
if key.startswith('xmlns:') or key == 'xmlns':
|
||
|
|
res[key] = parent.documentElement.attributes[key]
|
||
|
|
_find_namespaces_from_child(parent, child, res)
|
||
|
|
return res
|
||
|
|
|
||
|
|
|
||
|
|
def _clone_node_with_namespaces(node_to_clone, original_doc):
|
||
|
|
clone = node_to_clone.cloneNode(True)
|
||
|
|
|
||
|
|
for key, value in _find_namespaces(original_doc, node_to_clone).items():
|
||
|
|
clone.attributes[key] = value
|
||
|
|
|
||
|
|
return clone
|
||
|
|
|
||
|
|
|
||
|
|
def _convert_response_to_feeds(response, convert_callback):
|
||
|
|
if response is None:
|
||
|
|
return None
|
||
|
|
|
||
|
|
feeds = _list_of(Feed)
|
||
|
|
|
||
|
|
x_ms_continuation = HeaderDict()
|
||
|
|
for name, value in response.headers:
|
||
|
|
if 'x-ms-continuation' in name:
|
||
|
|
x_ms_continuation[name[len('x-ms-continuation') + 1:]] = value
|
||
|
|
if x_ms_continuation:
|
||
|
|
setattr(feeds, 'x_ms_continuation', x_ms_continuation)
|
||
|
|
|
||
|
|
xmldoc = minidom.parseString(response.body)
|
||
|
|
xml_entries = _get_children_from_path(xmldoc, 'feed', 'entry')
|
||
|
|
if not xml_entries:
|
||
|
|
# in some cases, response contains only entry but no feed
|
||
|
|
xml_entries = _get_children_from_path(xmldoc, 'entry')
|
||
|
|
if inspect.isclass(convert_callback) and issubclass(convert_callback, WindowsAzureData):
|
||
|
|
for xml_entry in xml_entries:
|
||
|
|
return_obj = convert_callback()
|
||
|
|
for node in _get_children_from_path(xml_entry,
|
||
|
|
'content',
|
||
|
|
convert_callback.__name__):
|
||
|
|
_fill_data_to_return_object(node, return_obj)
|
||
|
|
for name, value in _get_entry_properties_from_node(xml_entry,
|
||
|
|
include_id=True,
|
||
|
|
use_title_as_id=True).items():
|
||
|
|
setattr(return_obj, name, value)
|
||
|
|
feeds.append(return_obj)
|
||
|
|
else:
|
||
|
|
for xml_entry in xml_entries:
|
||
|
|
new_node = _clone_node_with_namespaces(xml_entry, xmldoc)
|
||
|
|
feeds.append(convert_callback(new_node.toxml('utf-8')))
|
||
|
|
|
||
|
|
return feeds
|
||
|
|
|
||
|
|
|
||
|
|
def _validate_type_bytes(param_name, param):
|
||
|
|
if not isinstance(param, bytes):
|
||
|
|
raise TypeError(_ERROR_VALUE_SHOULD_BE_BYTES.format(param_name))
|
||
|
|
|
||
|
|
|
||
|
|
def _validate_not_none(param_name, param):
|
||
|
|
if param is None:
|
||
|
|
raise TypeError(_ERROR_VALUE_NONE.format(param_name))
|
||
|
|
|
||
|
|
|
||
|
|
def _fill_list_of(xmldoc, element_type, xml_element_name):
|
||
|
|
xmlelements = _get_child_nodes(xmldoc, xml_element_name)
|
||
|
|
return [_parse_response_body_from_xml_node(xmlelement, element_type) \
|
||
|
|
for xmlelement in xmlelements]
|
||
|
|
|
||
|
|
|
||
|
|
def _fill_scalar_list_of(xmldoc, element_type, parent_xml_element_name,
|
||
|
|
xml_element_name):
|
||
|
|
'''Converts an xml fragment into a list of scalar types. The parent xml
|
||
|
|
element contains a flat list of xml elements which are converted into the
|
||
|
|
specified scalar type and added to the list.
|
||
|
|
Example:
|
||
|
|
xmldoc=
|
||
|
|
<Endpoints>
|
||
|
|
<Endpoint>http://{storage-service-name}.blob.core.windows.net/</Endpoint>
|
||
|
|
<Endpoint>http://{storage-service-name}.queue.core.windows.net/</Endpoint>
|
||
|
|
<Endpoint>http://{storage-service-name}.table.core.windows.net/</Endpoint>
|
||
|
|
</Endpoints>
|
||
|
|
element_type=str
|
||
|
|
parent_xml_element_name='Endpoints'
|
||
|
|
xml_element_name='Endpoint'
|
||
|
|
'''
|
||
|
|
xmlelements = _get_child_nodes(xmldoc, parent_xml_element_name)
|
||
|
|
if xmlelements:
|
||
|
|
xmlelements = _get_child_nodes(xmlelements[0], xml_element_name)
|
||
|
|
return [_get_node_value(xmlelement, element_type) \
|
||
|
|
for xmlelement in xmlelements]
|
||
|
|
|
||
|
|
|
||
|
|
def _fill_dict(xmldoc, element_name):
|
||
|
|
xmlelements = _get_child_nodes(xmldoc, element_name)
|
||
|
|
if xmlelements:
|
||
|
|
return_obj = {}
|
||
|
|
for child in xmlelements[0].childNodes:
|
||
|
|
if child.firstChild:
|
||
|
|
return_obj[child.nodeName] = child.firstChild.nodeValue
|
||
|
|
return return_obj
|
||
|
|
|
||
|
|
|
||
|
|
def _fill_dict_of(xmldoc, parent_xml_element_name, pair_xml_element_name,
|
||
|
|
key_xml_element_name, value_xml_element_name):
|
||
|
|
'''Converts an xml fragment into a dictionary. The parent xml element
|
||
|
|
contains a list of xml elements where each element has a child element for
|
||
|
|
the key, and another for the value.
|
||
|
|
Example:
|
||
|
|
xmldoc=
|
||
|
|
<ExtendedProperties>
|
||
|
|
<ExtendedProperty>
|
||
|
|
<Name>Ext1</Name>
|
||
|
|
<Value>Val1</Value>
|
||
|
|
</ExtendedProperty>
|
||
|
|
<ExtendedProperty>
|
||
|
|
<Name>Ext2</Name>
|
||
|
|
<Value>Val2</Value>
|
||
|
|
</ExtendedProperty>
|
||
|
|
</ExtendedProperties>
|
||
|
|
element_type=str
|
||
|
|
parent_xml_element_name='ExtendedProperties'
|
||
|
|
pair_xml_element_name='ExtendedProperty'
|
||
|
|
key_xml_element_name='Name'
|
||
|
|
value_xml_element_name='Value'
|
||
|
|
'''
|
||
|
|
return_obj = {}
|
||
|
|
|
||
|
|
xmlelements = _get_child_nodes(xmldoc, parent_xml_element_name)
|
||
|
|
if xmlelements:
|
||
|
|
xmlelements = _get_child_nodes(xmlelements[0], pair_xml_element_name)
|
||
|
|
for pair in xmlelements:
|
||
|
|
keys = _get_child_nodes(pair, key_xml_element_name)
|
||
|
|
values = _get_child_nodes(pair, value_xml_element_name)
|
||
|
|
if keys and values:
|
||
|
|
key = keys[0].firstChild.nodeValue
|
||
|
|
value = values[0].firstChild.nodeValue
|
||
|
|
return_obj[key] = value
|
||
|
|
|
||
|
|
return return_obj
|
||
|
|
|
||
|
|
|
||
|
|
def _fill_instance_child(xmldoc, element_name, return_type):
|
||
|
|
'''Converts a child of the current dom element to the specified type.
|
||
|
|
'''
|
||
|
|
xmlelements = _get_child_nodes(
|
||
|
|
xmldoc, _get_serialization_name(element_name))
|
||
|
|
|
||
|
|
if not xmlelements:
|
||
|
|
return None
|
||
|
|
|
||
|
|
return_obj = return_type()
|
||
|
|
_fill_data_to_return_object(xmlelements[0], return_obj)
|
||
|
|
|
||
|
|
return return_obj
|
||
|
|
|
||
|
|
|
||
|
|
def _fill_instance_element(element, return_type):
|
||
|
|
"""Converts a DOM element into the specified object"""
|
||
|
|
return _parse_response_body_from_xml_node(element, return_type)
|
||
|
|
|
||
|
|
|
||
|
|
def _fill_data_minidom(xmldoc, element_name, data_member):
|
||
|
|
xmlelements = _get_child_nodes(
|
||
|
|
xmldoc, _get_serialization_name(element_name))
|
||
|
|
|
||
|
|
if not xmlelements or not xmlelements[0].childNodes:
|
||
|
|
return None
|
||
|
|
|
||
|
|
value = xmlelements[0].firstChild.nodeValue
|
||
|
|
|
||
|
|
if data_member is None:
|
||
|
|
return value
|
||
|
|
elif isinstance(data_member, datetime):
|
||
|
|
return _to_datetime(value)
|
||
|
|
elif type(data_member) is bool:
|
||
|
|
return value.lower() != 'false'
|
||
|
|
else:
|
||
|
|
return type(data_member)(value)
|
||
|
|
|
||
|
|
|
||
|
|
def _get_node_value(xmlelement, data_type):
|
||
|
|
value = xmlelement.firstChild.nodeValue
|
||
|
|
if data_type is datetime:
|
||
|
|
return _to_datetime(value)
|
||
|
|
elif data_type is bool:
|
||
|
|
return value.lower() != 'false'
|
||
|
|
else:
|
||
|
|
return data_type(value)
|
||
|
|
|
||
|
|
|
||
|
|
def _get_request_body_bytes_only(param_name, param_value):
|
||
|
|
'''Validates the request body passed in and converts it to bytes
|
||
|
|
if our policy allows it.'''
|
||
|
|
if param_value is None:
|
||
|
|
return b''
|
||
|
|
|
||
|
|
if isinstance(param_value, bytes):
|
||
|
|
return param_value
|
||
|
|
|
||
|
|
# Previous versions of the SDK allowed data types other than bytes to be
|
||
|
|
# passed in, and they would be auto-converted to bytes. We preserve this
|
||
|
|
# behavior when running under 2.7, but issue a warning.
|
||
|
|
# Python 3 support is new, so we reject anything that's not bytes.
|
||
|
|
if sys.version_info < (3,):
|
||
|
|
warnings.warn(_WARNING_VALUE_SHOULD_BE_BYTES.format(param_name))
|
||
|
|
return _get_request_body(param_value)
|
||
|
|
|
||
|
|
raise TypeError(_ERROR_VALUE_SHOULD_BE_BYTES.format(param_name))
|
||
|
|
|
||
|
|
|
||
|
|
def _get_request_body(request_body):
|
||
|
|
'''Converts an object into a request body. If it's None
|
||
|
|
we'll return an empty string, if it's one of our objects it'll
|
||
|
|
convert it to XML and return it. Otherwise we just use the object
|
||
|
|
directly'''
|
||
|
|
if request_body is None:
|
||
|
|
return b''
|
||
|
|
|
||
|
|
if isinstance(request_body, WindowsAzureData):
|
||
|
|
request_body = _convert_class_to_xml(request_body)
|
||
|
|
|
||
|
|
if isinstance(request_body, bytes):
|
||
|
|
return request_body
|
||
|
|
|
||
|
|
if isinstance(request_body, _unicode_type):
|
||
|
|
return request_body.encode('utf-8')
|
||
|
|
|
||
|
|
request_body = str(request_body)
|
||
|
|
if isinstance(request_body, _unicode_type):
|
||
|
|
return request_body.encode('utf-8')
|
||
|
|
|
||
|
|
return request_body
|
||
|
|
|
||
|
|
|
||
|
|
def _parse_enum_results_list(response, return_type, resp_type, item_type):
|
||
|
|
"""resp_body is the XML we received
|
||
|
|
resp_type is a string, such as Containers,
|
||
|
|
return_type is the type we're constructing, such as ContainerEnumResults
|
||
|
|
item_type is the type object of the item to be created, such as Container
|
||
|
|
|
||
|
|
This function then returns a ContainerEnumResults object with the
|
||
|
|
containers member populated with the results.
|
||
|
|
"""
|
||
|
|
|
||
|
|
# parsing something like:
|
||
|
|
# <EnumerationResults ... >
|
||
|
|
# <Queues>
|
||
|
|
# <Queue>
|
||
|
|
# <Something />
|
||
|
|
# <SomethingElse />
|
||
|
|
# </Queue>
|
||
|
|
# </Queues>
|
||
|
|
# </EnumerationResults>
|
||
|
|
respbody = response.body
|
||
|
|
return_obj = return_type()
|
||
|
|
doc = minidom.parseString(respbody)
|
||
|
|
|
||
|
|
items = []
|
||
|
|
for enum_results in _get_child_nodes(doc, 'EnumerationResults'):
|
||
|
|
# path is something like Queues, Queue
|
||
|
|
for child in _get_children_from_path(enum_results,
|
||
|
|
resp_type,
|
||
|
|
resp_type[:-1]):
|
||
|
|
items.append(_fill_instance_element(child, item_type))
|
||
|
|
|
||
|
|
for name, value in vars(return_obj).items():
|
||
|
|
# queues, Queues, this is the list its self which we populated
|
||
|
|
# above
|
||
|
|
if name == resp_type.lower():
|
||
|
|
# the list its self.
|
||
|
|
continue
|
||
|
|
value = _fill_data_minidom(enum_results, name, value)
|
||
|
|
if value is not None:
|
||
|
|
setattr(return_obj, name, value)
|
||
|
|
|
||
|
|
setattr(return_obj, resp_type.lower(), items)
|
||
|
|
return return_obj
|
||
|
|
|
||
|
|
|
||
|
|
def _parse_simple_list(response, type, item_type, list_name):
|
||
|
|
respbody = response.body
|
||
|
|
res = type()
|
||
|
|
res_items = []
|
||
|
|
doc = minidom.parseString(respbody)
|
||
|
|
type_name = type.__name__
|
||
|
|
item_name = item_type.__name__
|
||
|
|
for item in _get_children_from_path(doc, type_name, item_name):
|
||
|
|
res_items.append(_fill_instance_element(item, item_type))
|
||
|
|
|
||
|
|
setattr(res, list_name, res_items)
|
||
|
|
return res
|
||
|
|
|
||
|
|
|
||
|
|
def _parse_response(response, return_type):
|
||
|
|
'''
|
||
|
|
Parse the HTTPResponse's body and fill all the data into a class of
|
||
|
|
return_type.
|
||
|
|
'''
|
||
|
|
return _parse_response_body_from_xml_text(response.body, return_type)
|
||
|
|
|
||
|
|
def _parse_service_resources_response(response, return_type):
|
||
|
|
'''
|
||
|
|
Parse the HTTPResponse's body and fill all the data into a class of
|
||
|
|
return_type.
|
||
|
|
'''
|
||
|
|
return _parse_response_body_from_service_resources_xml_text(response.body, return_type)
|
||
|
|
|
||
|
|
|
||
|
|
def _fill_data_to_return_object(node, return_obj):
|
||
|
|
members = dict(vars(return_obj))
|
||
|
|
for name, value in members.items():
|
||
|
|
if isinstance(value, _list_of):
|
||
|
|
setattr(return_obj,
|
||
|
|
name,
|
||
|
|
_fill_list_of(node,
|
||
|
|
value.list_type,
|
||
|
|
value.xml_element_name))
|
||
|
|
elif isinstance(value, _scalar_list_of):
|
||
|
|
setattr(return_obj,
|
||
|
|
name,
|
||
|
|
_fill_scalar_list_of(node,
|
||
|
|
value.list_type,
|
||
|
|
_get_serialization_name(name),
|
||
|
|
value.xml_element_name))
|
||
|
|
elif isinstance(value, _dict_of):
|
||
|
|
setattr(return_obj,
|
||
|
|
name,
|
||
|
|
_fill_dict_of(node,
|
||
|
|
_get_serialization_name(name),
|
||
|
|
value.pair_xml_element_name,
|
||
|
|
value.key_xml_element_name,
|
||
|
|
value.value_xml_element_name))
|
||
|
|
elif isinstance(value, _xml_attribute):
|
||
|
|
real_value = None
|
||
|
|
if node.hasAttribute(value.xml_element_name):
|
||
|
|
real_value = node.getAttribute(value.xml_element_name)
|
||
|
|
if real_value is not None:
|
||
|
|
setattr(return_obj, name, real_value)
|
||
|
|
elif isinstance(value, WindowsAzureData):
|
||
|
|
setattr(return_obj,
|
||
|
|
name,
|
||
|
|
_fill_instance_child(node, name, value.__class__))
|
||
|
|
elif isinstance(value, dict):
|
||
|
|
setattr(return_obj,
|
||
|
|
name,
|
||
|
|
_fill_dict(node, _get_serialization_name(name)))
|
||
|
|
elif isinstance(value, _Base64String):
|
||
|
|
value = _fill_data_minidom(node, name, '')
|
||
|
|
if value is not None:
|
||
|
|
value = _decode_base64_to_text(value)
|
||
|
|
# always set the attribute, so we don't end up returning an object
|
||
|
|
# with type _Base64String
|
||
|
|
setattr(return_obj, name, value)
|
||
|
|
else:
|
||
|
|
value = _fill_data_minidom(node, name, value)
|
||
|
|
if value is not None:
|
||
|
|
setattr(return_obj, name, value)
|
||
|
|
|
||
|
|
|
||
|
|
def _parse_response_body_from_xml_node(node, return_type):
|
||
|
|
'''
|
||
|
|
parse the xml and fill all the data into a class of return_type
|
||
|
|
'''
|
||
|
|
return_obj = return_type()
|
||
|
|
_fill_data_to_return_object(node, return_obj)
|
||
|
|
|
||
|
|
return return_obj
|
||
|
|
|
||
|
|
|
||
|
|
def _parse_response_body_from_xml_text(respbody, return_type):
|
||
|
|
'''
|
||
|
|
parse the xml and fill all the data into a class of return_type
|
||
|
|
'''
|
||
|
|
doc = minidom.parseString(respbody)
|
||
|
|
return_obj = return_type()
|
||
|
|
xml_name = return_type._xml_name if hasattr(return_type, '_xml_name') else return_type.__name__
|
||
|
|
for node in _get_child_nodes(doc, xml_name):
|
||
|
|
_fill_data_to_return_object(node, return_obj)
|
||
|
|
|
||
|
|
return return_obj
|
||
|
|
|
||
|
|
def _parse_response_body_from_service_resources_xml_text(respbody, return_type):
|
||
|
|
'''
|
||
|
|
parse the xml and fill all the data into a class of return_type
|
||
|
|
'''
|
||
|
|
doc = minidom.parseString(respbody)
|
||
|
|
return_obj = _list_of(return_type)
|
||
|
|
for node in _get_children_from_path(doc, "ServiceResources", "ServiceResource"):
|
||
|
|
local_obj = return_type()
|
||
|
|
_fill_data_to_return_object(node, local_obj)
|
||
|
|
return_obj.append(local_obj)
|
||
|
|
|
||
|
|
return return_obj
|
||
|
|
|
||
|
|
class _dict_of(dict):
|
||
|
|
|
||
|
|
"""a dict which carries with it the xml element names for key,val.
|
||
|
|
Used for deserializaion and construction of the lists"""
|
||
|
|
|
||
|
|
def __init__(self, pair_xml_element_name, key_xml_element_name,
|
||
|
|
value_xml_element_name):
|
||
|
|
self.pair_xml_element_name = pair_xml_element_name
|
||
|
|
self.key_xml_element_name = key_xml_element_name
|
||
|
|
self.value_xml_element_name = value_xml_element_name
|
||
|
|
super(_dict_of, self).__init__()
|
||
|
|
|
||
|
|
|
||
|
|
class _list_of(list):
|
||
|
|
|
||
|
|
"""a list which carries with it the type that's expected to go in it.
|
||
|
|
Used for deserializaion and construction of the lists"""
|
||
|
|
|
||
|
|
def __init__(self, list_type, xml_element_name=None):
|
||
|
|
self.list_type = list_type
|
||
|
|
if xml_element_name is None:
|
||
|
|
self.xml_element_name = list_type.__name__
|
||
|
|
else:
|
||
|
|
self.xml_element_name = xml_element_name
|
||
|
|
super(_list_of, self).__init__()
|
||
|
|
|
||
|
|
|
||
|
|
class _scalar_list_of(list):
|
||
|
|
|
||
|
|
"""a list of scalar types which carries with it the type that's
|
||
|
|
expected to go in it along with its xml element name.
|
||
|
|
Used for deserializaion and construction of the lists"""
|
||
|
|
|
||
|
|
def __init__(self, list_type, xml_element_name):
|
||
|
|
self.list_type = list_type
|
||
|
|
self.xml_element_name = xml_element_name
|
||
|
|
super(_scalar_list_of, self).__init__()
|
||
|
|
|
||
|
|
class _xml_attribute:
|
||
|
|
|
||
|
|
"""a accessor to XML attributes
|
||
|
|
expected to go in it along with its xml element name.
|
||
|
|
Used for deserialization and construction"""
|
||
|
|
|
||
|
|
def __init__(self, xml_element_name):
|
||
|
|
self.xml_element_name = xml_element_name
|
||
|
|
|
||
|
|
|
||
|
|
def _update_request_uri_query_local_storage(request, use_local_storage):
|
||
|
|
''' create correct uri and query for the request '''
|
||
|
|
uri, query = _update_request_uri_query(request)
|
||
|
|
if use_local_storage:
|
||
|
|
return '/' + DEV_ACCOUNT_NAME + uri, query
|
||
|
|
return uri, query
|
||
|
|
|
||
|
|
|
||
|
|
def _update_request_uri_query(request):
|
||
|
|
'''pulls the query string out of the URI and moves it into
|
||
|
|
the query portion of the request object. If there are already
|
||
|
|
query parameters on the request the parameters in the URI will
|
||
|
|
appear after the existing parameters'''
|
||
|
|
|
||
|
|
if '?' in request.path:
|
||
|
|
request.path, _, query_string = request.path.partition('?')
|
||
|
|
if query_string:
|
||
|
|
query_params = query_string.split('&')
|
||
|
|
for query in query_params:
|
||
|
|
if '=' in query:
|
||
|
|
name, _, value = query.partition('=')
|
||
|
|
request.query.append((name, value))
|
||
|
|
|
||
|
|
request.path = url_quote(request.path, '/()$=\',')
|
||
|
|
|
||
|
|
# add encoded queries to request.path.
|
||
|
|
if request.query:
|
||
|
|
request.path += '?'
|
||
|
|
for name, value in request.query:
|
||
|
|
if value is not None:
|
||
|
|
request.path += name + '=' + url_quote(value, '/()$=\',') + '&'
|
||
|
|
request.path = request.path[:-1]
|
||
|
|
|
||
|
|
return request.path, request.query
|
||
|
|
|
||
|
|
|
||
|
|
def _dont_fail_on_exist(error):
|
||
|
|
''' don't throw exception if the resource exists.
|
||
|
|
This is called by create_* APIs with fail_on_exist=False'''
|
||
|
|
if isinstance(error, WindowsAzureConflictError):
|
||
|
|
return False
|
||
|
|
else:
|
||
|
|
raise error
|
||
|
|
|
||
|
|
|
||
|
|
def _dont_fail_not_exist(error):
|
||
|
|
''' don't throw exception if the resource doesn't exist.
|
||
|
|
This is called by create_* APIs with fail_on_exist=False'''
|
||
|
|
if isinstance(error, WindowsAzureMissingResourceError):
|
||
|
|
return False
|
||
|
|
else:
|
||
|
|
raise error
|
||
|
|
|
||
|
|
|
||
|
|
def _general_error_handler(http_error):
|
||
|
|
''' Simple error handler for azure.'''
|
||
|
|
if http_error.status == 409:
|
||
|
|
raise WindowsAzureConflictError(
|
||
|
|
_ERROR_CONFLICT.format(str(http_error)))
|
||
|
|
elif http_error.status == 404:
|
||
|
|
raise WindowsAzureMissingResourceError(
|
||
|
|
_ERROR_NOT_FOUND.format(str(http_error)))
|
||
|
|
else:
|
||
|
|
if http_error.respbody is not None:
|
||
|
|
raise WindowsAzureError(
|
||
|
|
_ERROR_UNKNOWN.format(str(http_error)) + '\n' + \
|
||
|
|
http_error.respbody.decode('utf-8'))
|
||
|
|
else:
|
||
|
|
raise WindowsAzureError(_ERROR_UNKNOWN.format(str(http_error)))
|
||
|
|
|
||
|
|
|
||
|
|
def _parse_response_for_dict(response):
|
||
|
|
''' Extracts name-values from response header. Filter out the standard
|
||
|
|
http headers.'''
|
||
|
|
|
||
|
|
if response is None:
|
||
|
|
return None
|
||
|
|
http_headers = ['server', 'date', 'location', 'host',
|
||
|
|
'via', 'proxy-connection', 'connection']
|
||
|
|
return_dict = HeaderDict()
|
||
|
|
if response.headers:
|
||
|
|
for name, value in response.headers:
|
||
|
|
if not name.lower() in http_headers:
|
||
|
|
return_dict[name] = value
|
||
|
|
|
||
|
|
return return_dict
|
||
|
|
|
||
|
|
|
||
|
|
def _parse_response_for_dict_prefix(response, prefixes):
|
||
|
|
''' Extracts name-values for names starting with prefix from response
|
||
|
|
header. Filter out the standard http headers.'''
|
||
|
|
|
||
|
|
if response is None:
|
||
|
|
return None
|
||
|
|
return_dict = {}
|
||
|
|
orig_dict = _parse_response_for_dict(response)
|
||
|
|
if orig_dict:
|
||
|
|
for name, value in orig_dict.items():
|
||
|
|
for prefix_value in prefixes:
|
||
|
|
if name.lower().startswith(prefix_value.lower()):
|
||
|
|
return_dict[name] = value
|
||
|
|
break
|
||
|
|
return return_dict
|
||
|
|
else:
|
||
|
|
return None
|
||
|
|
|
||
|
|
|
||
|
|
def _parse_response_for_dict_filter(response, filter):
|
||
|
|
''' Extracts name-values for names in filter from response header. Filter
|
||
|
|
out the standard http headers.'''
|
||
|
|
if response is None:
|
||
|
|
return None
|
||
|
|
return_dict = {}
|
||
|
|
orig_dict = _parse_response_for_dict(response)
|
||
|
|
if orig_dict:
|
||
|
|
for name, value in orig_dict.items():
|
||
|
|
if name.lower() in filter:
|
||
|
|
return_dict[name] = value
|
||
|
|
return return_dict
|
||
|
|
else:
|
||
|
|
return None
|
||
|
|
|
||
|
|
|
||
|
|
def _sign_string(key, string_to_sign, key_is_base64=True):
|
||
|
|
if key_is_base64:
|
||
|
|
key = _decode_base64_to_bytes(key)
|
||
|
|
else:
|
||
|
|
if isinstance(key, _unicode_type):
|
||
|
|
key = key.encode('utf-8')
|
||
|
|
if isinstance(string_to_sign, _unicode_type):
|
||
|
|
string_to_sign = string_to_sign.encode('utf-8')
|
||
|
|
signed_hmac_sha256 = hmac.HMAC(key, string_to_sign, hashlib.sha256)
|
||
|
|
digest = signed_hmac_sha256.digest()
|
||
|
|
encoded_digest = _encode_base64(digest)
|
||
|
|
return encoded_digest
|