Synnefo

.. automodule:: pithos.lib.client

env.packages = ['snf-pithos-lib', 'snf-pithos-backend', 'snf-pithos-app',

                        'snf-pithos-tools']

env.deb_packages = ['snf-pithos-lib', 'snf-pithos-backend',

                    'snf-pithos-tools', 'snf-pithos-app']

from pithos.lib.hashmap import HashMap

from pithos.lib.transfer import upload

from pithos.lib.hashmap import HashMap

from pithos.lib.client import Fault

from pithos.lib.user import get_user

from pithos.lib.filter import parse_filters

from pithos.backends.base import NotAllowedError, QuotaError

from pithos.lib.user import get_user

from pithos.lib.compat import parse_http_date_safe, parse_http_date

from log import LoggingConfigMiddleware

from secure import SecureMiddleware

# Copyright 2011-2012 GRNET S.A. All rights reserved.

# 

# Redistribution and use in source and binary forms, with or

# without modification, are permitted provided that the following

# conditions are met:

# 

#   1. Redistributions of source code must retain the above

#      copyright notice, this list of conditions and the following

#      disclaimer.

# 

#   2. Redistributions in binary form must reproduce the above

#      copyright notice, this list of conditions and the following

#      disclaimer in the documentation and/or other materials

#      provided with the distribution.

# 

# THIS SOFTWARE IS PROVIDED BY GRNET S.A. ``AS IS'' AND ANY EXPRESS

# OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED

# WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR

# PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL GRNET S.A OR

# CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,

# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT

# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF

# USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED

# AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT

# LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN

# ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE

# POSSIBILITY OF SUCH DAMAGE.

# 

# The views and conclusions contained in the software and

# documentation are those of the authors and should not be

# interpreted as representing official policies, either expressed

# or implied, of GRNET S.A.

from django.conf import settings

from django.core.exceptions import MiddlewareNotUsed

from pithos.lib.dictconfig import dictConfig

import logging

class NullHandler(logging.Handler):

    def emit(self, record):

        pass

class LoggingConfigMiddleware:

    def __init__(self):

        '''Initialise the logging setup from settings, called on first request.'''

        logging_setting = getattr(settings, 'LOGGING_SETUP', None)

        if logging_setting:

            # Disable handlers that are not used by any logger.

            active_handlers = set()

            loggers = logging_setting.get('loggers', {})

            for logger in loggers.values():

                active_handlers.update(logger.get('handlers', []))

            handlers = logging_setting.get('handlers', {})

            for handler in handlers:

                if handler not in active_handlers:

                    handlers[handler] = {'class': 'logging.NullHandler'}

            logging.NullHandler = NullHandler

            dictConfig(logging_setting)

        raise MiddlewareNotUsed('Logging setup only.')

# Copyright 2011-2012 GRNET S.A. All rights reserved.

# 

# Redistribution and use in source and binary forms, with or

# without modification, are permitted provided that the following

# conditions are met:

# 

#   1. Redistributions of source code must retain the above

#      copyright notice, this list of conditions and the following

#      disclaimer.

# 

#   2. Redistributions in binary form must reproduce the above

#      copyright notice, this list of conditions and the following

#      disclaimer in the documentation and/or other materials

#      provided with the distribution.

# 

# THIS SOFTWARE IS PROVIDED BY GRNET S.A. ``AS IS'' AND ANY EXPRESS

# OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED

# WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR

# PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL GRNET S.A OR

# CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,

# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT

# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF

# USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED

# AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT

# LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN

# ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE

# POSSIBILITY OF SUCH DAMAGE.

# 

# The views and conclusions contained in the software and

# documentation are those of the authors and should not be

# interpreted as representing official policies, either expressed

# or implied, of GRNET S.A.

class SecureMiddleware(object):

    def process_request(self, request):

        if 'HTTP_X_FORWARDED_PROTOCOL' in request.META:

            request.is_secure = lambda: request.META['HTTP_X_FORWARDED_PROTOCOL'] == 'https'

from pithos.lib.queue import exchange_connect, exchange_send, exchange_close, Receipt

from pithos.lib.filter import parse_filters

from pithos.lib.filter import parse_filters

from pithos.lib.hashmap import HashMap

    'snf-pithos-lib',

Copyright 2011 GRNET S.A. All rights reserved.

Redistribution and use in source and binary forms, with or

without modification, are permitted provided that the following

conditions are met:

  1. Redistributions of source code must retain the above

     copyright notice, this list of conditions and the following

     disclaimer.

  2. Redistributions in binary form must reproduce the above

     copyright notice, this list of conditions and the following

     disclaimer in the documentation and/or other materials

     provided with the distribution.

THIS SOFTWARE IS PROVIDED BY GRNET S.A. ``AS IS'' AND ANY EXPRESS

OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED

WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR

PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL GRNET S.A OR

CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,

SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT

LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF

USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED

AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT

LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN

ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE

POSSIBILITY OF SUCH DAMAGE.

The views and conclusions contained in the software and

documentation are those of the authors and should not be

interpreted as representing official policies, either expressed

or implied, of GRNET S.A.

recursive-include pithos *.json *.html *.json *.xml *.txt

recursive-include pithos/ui/static *

include README Changelog

include distribute_setup.py

#!python

"""Bootstrap distribute installation

If you want to use setuptools in your package's setup.py, just include this

file in the same directory with it, and add this to the top of your setup.py::

    from distribute_setup import use_setuptools

    use_setuptools()

If you want to require a specific version of setuptools, set a download

mirror, or use an alternate download directory, you can do so by supplying

the appropriate options to ``use_setuptools()``.

This file can also be run as a script to install or upgrade setuptools.

"""

import os

import sys

import time

import fnmatch

import tempfile

import tarfile

from distutils import log

try:

    from site import USER_SITE

except ImportError:

    USER_SITE = None

try:

    import subprocess

    def _python_cmd(*args):

        args = (sys.executable,) + args

        return subprocess.call(args) == 0

except ImportError:

    # will be used for python 2.3

    def _python_cmd(*args):

        args = (sys.executable,) + args

        # quoting arguments if windows

        if sys.platform == 'win32':

            def quote(arg):

                if ' ' in arg:

                    return '"%s"' % arg

                return arg

            args = [quote(arg) for arg in args]

        return os.spawnl(os.P_WAIT, sys.executable, *args) == 0

DEFAULT_VERSION = "0.6.10"

DEFAULT_URL = "http://pypi.python.org/packages/source/d/distribute/"

SETUPTOOLS_FAKED_VERSION = "0.6c11"

SETUPTOOLS_PKG_INFO = """\

Metadata-Version: 1.0

Name: setuptools

Version: %s

Summary: xxxx

Home-page: xxx

Author: xxx

Author-email: xxx

License: xxx

Description: xxx

""" % SETUPTOOLS_FAKED_VERSION

def _install(tarball):

    # extracting the tarball

    tmpdir = tempfile.mkdtemp()

    log.warn('Extracting in %s', tmpdir)

    old_wd = os.getcwd()

    try:

        os.chdir(tmpdir)

        tar = tarfile.open(tarball)

        _extractall(tar)

        tar.close()

        # going in the directory

        subdir = os.path.join(tmpdir, os.listdir(tmpdir)[0])

        os.chdir(subdir)

        log.warn('Now working in %s', subdir)

        # installing

        log.warn('Installing Distribute')

        if not _python_cmd('setup.py', 'install'):

            log.warn('Something went wrong during the installation.')

            log.warn('See the error message above.')

    finally:

        os.chdir(old_wd)

def _build_egg(egg, tarball, to_dir):

    # extracting the tarball

    tmpdir = tempfile.mkdtemp()

    log.warn('Extracting in %s', tmpdir)

    old_wd = os.getcwd()

    try:

        os.chdir(tmpdir)

        tar = tarfile.open(tarball)

        _extractall(tar)

        tar.close()

        # going in the directory

        subdir = os.path.join(tmpdir, os.listdir(tmpdir)[0])

        os.chdir(subdir)

        log.warn('Now working in %s', subdir)

        # building an egg

        log.warn('Building a Distribute egg in %s', to_dir)

        _python_cmd('setup.py', '-q', 'bdist_egg', '--dist-dir', to_dir)

    finally:

        os.chdir(old_wd)

    # returning the result

    log.warn(egg)

    if not os.path.exists(egg):

        raise IOError('Could not build the egg.')

def _do_download(version, download_base, to_dir, download_delay):

    egg = os.path.join(to_dir, 'distribute-%s-py%d.%d.egg'

                       % (version, sys.version_info[0], sys.version_info[1]))

    if not os.path.exists(egg):

        tarball = download_setuptools(version, download_base,

                                      to_dir, download_delay)

        _build_egg(egg, tarball, to_dir)

    sys.path.insert(0, egg)

    import setuptools

    setuptools.bootstrap_install_from = egg

def use_setuptools(version=DEFAULT_VERSION, download_base=DEFAULT_URL,

                   to_dir=os.curdir, download_delay=15, no_fake=True):

    # making sure we use the absolute path

    to_dir = os.path.abspath(to_dir)

    was_imported = 'pkg_resources' in sys.modules or \

        'setuptools' in sys.modules

    try:

        try:

            import pkg_resources

            if not hasattr(pkg_resources, '_distribute'):

                if not no_fake:

                    _fake_setuptools()

                raise ImportError

        except ImportError:

            return _do_download(version, download_base, to_dir, download_delay)

        try:

            pkg_resources.require("distribute>="+version)

            return

        except pkg_resources.VersionConflict:

            e = sys.exc_info()[1]

            if was_imported:

                sys.stderr.write(

                "The required version of distribute (>=%s) is not available,\n"

                "and can't be installed while this script is running. Please\n"

                "install a more recent version first, using\n"

                "'easy_install -U distribute'."

                "\n\n(Currently using %r)\n" % (version, e.args[0]))

                sys.exit(2)

            else:

                del pkg_resources, sys.modules['pkg_resources']    # reload ok

                return _do_download(version, download_base, to_dir,

                                    download_delay)

        except pkg_resources.DistributionNotFound:

            return _do_download(version, download_base, to_dir,

                                download_delay)

    finally:

        if not no_fake:

            _create_fake_setuptools_pkg_info(to_dir)

def download_setuptools(version=DEFAULT_VERSION, download_base=DEFAULT_URL,

                        to_dir=os.curdir, delay=15):

    """Download distribute from a specified location and return its filename

    `version` should be a valid distribute version number that is available

    as an egg for download under the `download_base` URL (which should end

    with a '/'). `to_dir` is the directory where the egg will be downloaded.

    `delay` is the number of seconds to pause before an actual download

    attempt.

    """

    # making sure we use the absolute path

    to_dir = os.path.abspath(to_dir)

    try:

        from urllib.request import urlopen

    except ImportError:

        from urllib2 import urlopen

    tgz_name = "distribute-%s.tar.gz" % version

    url = download_base + tgz_name

    saveto = os.path.join(to_dir, tgz_name)

    src = dst = None

    if not os.path.exists(saveto):  # Avoid repeated downloads

        try:

            log.warn("Downloading %s", url)

            src = urlopen(url)

            # Read/write all in one block, so we don't create a corrupt file

            # if the download is interrupted.

            data = src.read()

            dst = open(saveto, "wb")

            dst.write(data)

        finally:

            if src:

                src.close()

            if dst:

                dst.close()

    return os.path.realpath(saveto)

def _no_sandbox(function):

    def __no_sandbox(*args, **kw):

        try:

            from setuptools.sandbox import DirectorySandbox

            if not hasattr(DirectorySandbox, '_old'):

                def violation(*args):

                    pass

                DirectorySandbox._old = DirectorySandbox._violation

                DirectorySandbox._violation = violation

                patched = True

            else:

                patched = False

        except ImportError:

            patched = False

        try:

            return function(*args, **kw)

        finally:

            if patched:

                DirectorySandbox._violation = DirectorySandbox._old

                del DirectorySandbox._old

    return __no_sandbox

def _patch_file(path, content):

    """Will backup the file then patch it"""

    existing_content = open(path).read()

    if existing_content == content:

        # already patched

        log.warn('Already patched.')

        return False

    log.warn('Patching...')

    _rename_path(path)

    f = open(path, 'w')

    try:

        f.write(content)

    finally:

        f.close()

    return True

_patch_file = _no_sandbox(_patch_file)

def _same_content(path, content):

    return open(path).read() == content

def _rename_path(path):

    new_name = path + '.OLD.%s' % time.time()

    log.warn('Renaming %s into %s', path, new_name)

    os.rename(path, new_name)

    return new_name

def _remove_flat_installation(placeholder):

    if not os.path.isdir(placeholder):

        log.warn('Unkown installation at %s', placeholder)

        return False

    found = False

    for file in os.listdir(placeholder):

        if fnmatch.fnmatch(file, 'setuptools*.egg-info'):

            found = True

            break

    if not found:

        log.warn('Could not locate setuptools*.egg-info')

        return

    log.warn('Removing elements out of the way...')

    pkg_info = os.path.join(placeholder, file)

    if os.path.isdir(pkg_info):

        patched = _patch_egg_dir(pkg_info)

    else:

        patched = _patch_file(pkg_info, SETUPTOOLS_PKG_INFO)

    if not patched:

        log.warn('%s already patched.', pkg_info)

        return False

    # now let's move the files out of the way

    for element in ('setuptools', 'pkg_resources.py', 'site.py'):

        element = os.path.join(placeholder, element)

        if os.path.exists(element):

            _rename_path(element)

        else:

            log.warn('Could not find the %s element of the '

                     'Setuptools distribution', element)

    return True

_remove_flat_installation = _no_sandbox(_remove_flat_installation)

def _after_install(dist):

    log.warn('After install bootstrap.')

    placeholder = dist.get_command_obj('install').install_purelib

    _create_fake_setuptools_pkg_info(placeholder)

def _create_fake_setuptools_pkg_info(placeholder):

    if not placeholder or not os.path.exists(placeholder):

        log.warn('Could not find the install location')

        return

    pyver = '%s.%s' % (sys.version_info[0], sys.version_info[1])

    setuptools_file = 'setuptools-%s-py%s.egg-info' % \

            (SETUPTOOLS_FAKED_VERSION, pyver)

    pkg_info = os.path.join(placeholder, setuptools_file)

    if os.path.exists(pkg_info):

        log.warn('%s already exists', pkg_info)

        return

    log.warn('Creating %s', pkg_info)

    f = open(pkg_info, 'w')

    try:

        f.write(SETUPTOOLS_PKG_INFO)

    finally:

        f.close()

    pth_file = os.path.join(placeholder, 'setuptools.pth')

    log.warn('Creating %s', pth_file)

    f = open(pth_file, 'w')

    try:

        f.write(os.path.join(os.curdir, setuptools_file))

    finally:

        f.close()

_create_fake_setuptools_pkg_info = _no_sandbox(_create_fake_setuptools_pkg_info)

def _patch_egg_dir(path):

    # let's check if it's already patched

    pkg_info = os.path.join(path, 'EGG-INFO', 'PKG-INFO')

    if os.path.exists(pkg_info):

        if _same_content(pkg_info, SETUPTOOLS_PKG_INFO):

            log.warn('%s already patched.', pkg_info)

            return False

    _rename_path(path)

    os.mkdir(path)

    os.mkdir(os.path.join(path, 'EGG-INFO'))

    pkg_info = os.path.join(path, 'EGG-INFO', 'PKG-INFO')

    f = open(pkg_info, 'w')

    try:

        f.write(SETUPTOOLS_PKG_INFO)

    finally:

        f.close()

    return True

_patch_egg_dir = _no_sandbox(_patch_egg_dir)

def _before_install():

    log.warn('Before install bootstrap.')

    _fake_setuptools()

def _under_prefix(location):

    if 'install' not in sys.argv:

        return True

    args = sys.argv[sys.argv.index('install')+1:]

    for index, arg in enumerate(args):

        for option in ('--root', '--prefix'):

            if arg.startswith('%s=' % option):

                top_dir = arg.split('root=')[-1]

                return location.startswith(top_dir)

            elif arg == option:

                if len(args) > index:

                    top_dir = args[index+1]

                    return location.startswith(top_dir)

        if arg == '--user' and USER_SITE is not None:

            return location.startswith(USER_SITE)

    return True

def _fake_setuptools():

    log.warn('Scanning installed packages')

    try:

        import pkg_resources

    except ImportError:

        # we're cool

        log.warn('Setuptools or Distribute does not seem to be installed.')

        return

    ws = pkg_resources.working_set

    try:

        setuptools_dist = ws.find(pkg_resources.Requirement.parse('setuptools',

                                  replacement=False))

    except TypeError:

        # old distribute API

        setuptools_dist = ws.find(pkg_resources.Requirement.parse('setuptools'))

    if setuptools_dist is None:

        log.warn('No setuptools distribution found')

        return

    # detecting if it was already faked

    setuptools_location = setuptools_dist.location

    log.warn('Setuptools installation detected at %s', setuptools_location)

    # if --root or --preix was provided, and if

    # setuptools is not located in them, we don't patch it

    if not _under_prefix(setuptools_location):

        log.warn('Not patching, --root or --prefix is installing Distribute'

                 ' in another location')

        return

    # let's see if its an egg

    if not setuptools_location.endswith('.egg'):

        log.warn('Non-egg installation')

        res = _remove_flat_installation(setuptools_location)

        if not res:

            return

    else:

        log.warn('Egg installation')

        pkg_info = os.path.join(setuptools_location, 'EGG-INFO', 'PKG-INFO')

        if (os.path.exists(pkg_info) and

            _same_content(pkg_info, SETUPTOOLS_PKG_INFO)):

            log.warn('Already patched.')

            return

        log.warn('Patching...')

        # let's create a fake egg replacing setuptools one

        res = _patch_egg_dir(setuptools_location)

        if not res:

            return

    log.warn('Patched done.')

    _relaunch()

def _relaunch():

    log.warn('Relaunching...')

    # we have to relaunch the process

    # pip marker to avoid a relaunch bug

    if sys.argv[:3] == ['-c', 'install', '--single-version-externally-managed']:

        sys.argv[0] = 'setup.py'

    args = [sys.executable] + sys.argv

    sys.exit(subprocess.call(args))

def _extractall(self, path=".", members=None):

    """Extract all members from the archive to the current working

       directory and set owner, modification time and permissions on

       directories afterwards. `path' specifies a different directory

       to extract to. `members' is optional and must be a subset of the

       list returned by getmembers().

    """

    import copy

    import operator

    from tarfile import ExtractError

    directories = []

    if members is None:

        members = self

    for tarinfo in members:

        if tarinfo.isdir():

            # Extract directories with a safe mode.

            directories.append(tarinfo)

            tarinfo = copy.copy(tarinfo)

            tarinfo.mode = 448 # decimal for oct 0700

        self.extract(tarinfo, path)

    # Reverse sort directories.

    if sys.version_info < (2, 4):

        def sorter(dir1, dir2):

            return cmp(dir1.name, dir2.name)

        directories.sort(sorter)

        directories.reverse()

    else:

        directories.sort(key=operator.attrgetter('name'), reverse=True)

    # Set correct owner, mtime and filemode on directories.

    for tarinfo in directories:

        dirpath = os.path.join(path, tarinfo.name)

        try:

            self.chown(tarinfo, dirpath)

            self.utime(tarinfo, dirpath)

            self.chmod(tarinfo, dirpath)

        except ExtractError:

            e = sys.exc_info()[1]

            if self.errorlevel > 1:

                raise

            else:

                self._dbg(1, "tarfile: %s" % e)

def main(argv, version=DEFAULT_VERSION):

    """Install or upgrade setuptools and EasyInstall"""

    tarball = download_setuptools()

    _install(tarball)

if __name__ == '__main__':

    main(sys.argv[1:])

# Copyright 2011 GRNET S.A. All rights reserved.

#

# Redistribution and use in source and binary forms, with or

# without modification, are permitted provided that the following

# conditions are met:

#

#   1. Redistributions of source code must retain the above

#      copyright notice, this list of conditions and the following

#      disclaimer.

#

#   2. Redistributions in binary form must reproduce the above

#      copyright notice, this list of conditions and the following

#      disclaimer in the documentation and/or other materials

#      provided with the distribution.

#

# THIS SOFTWARE IS PROVIDED BY GRNET S.A. ``AS IS'' AND ANY EXPRESS

# OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED

# WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR

# PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL GRNET S.A OR

# CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,

# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT

# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF

# USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED

# AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT

# LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN

# ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE

# POSSIBILITY OF SUCH DAMAGE.

#

# The views and conclusions contained in the software and

# documentation are those of the authors and should not be

# interpreted as representing official policies, either expressed

# or implied, of GRNET S.A.

# this is a namespace package

try:

    import pkg_resources

    pkg_resources.declare_namespace(__name__)

except ImportError:

    import pkgutil

    __path__ = pkgutil.extend_path(__path__, __name__)

# Copyright 2011-2012 GRNET S.A. All rights reserved.

# 

# Redistribution and use in source and binary forms, with or

# without modification, are permitted provided that the following

# conditions are met:

# 

#   1. Redistributions of source code must retain the above

#      copyright notice, this list of conditions and the following

#      disclaimer.

# 

#   2. Redistributions in binary form must reproduce the above

#      copyright notice, this list of conditions and the following

#      disclaimer in the documentation and/or other materials

#      provided with the distribution.

# 

# THIS SOFTWARE IS PROVIDED BY GRNET S.A. ``AS IS'' AND ANY EXPRESS

# OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED

# WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR

# PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL GRNET S.A OR

# CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,

# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT

# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF

# USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED

# AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT

# LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN

# ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE

# POSSIBILITY OF SUCH DAMAGE.

# 

# The views and conclusions contained in the software and

# documentation are those of the authors and should not be

# interpreted as representing official policies, either expressed

# or implied, of GRNET S.A.

from httplib import HTTPConnection, HTTPSConnection, HTTP

from sys import stdin

from xml.dom import minidom

from StringIO import StringIO

from urllib import quote, unquote

from urlparse import urlparse

import json

import types

import socket

import urllib

import datetime

ERROR_CODES = {304:'Not Modified',

               400:'Bad Request',

               401:'Unauthorized',

               403:'Forbidden',

               404:'Not Found',

               409:'Conflict',

               411:'Length Required',

               412:'Precondition Failed',

               413:'Request Entity Too Large',

               416:'Range Not Satisfiable',

               422:'Unprocessable Entity',

               500:'Internal Server Error',

               501:'Not Implemented'}

class Fault(Exception):

    def __init__(self, data='', status=None):

        if data == '' and status in ERROR_CODES.keys():

            data = ERROR_CODES[status]

        Exception.__init__(self, data)

        self.data = data

        self.status = status

class Client(object):

    def __init__(self, url, token, account, verbose=False, debug=False):

        """`url` can also include a port, e.g '127.0.0.1:8000'."""

        self.url = url

        self.account = account

        self.verbose = verbose or debug

        self.debug = debug

        self.token = token

    def _req(self, method, path, body=None, headers={}, format='text', params={}):

        p = urlparse(self.url)

        if p.scheme == 'http':

            conn = HTTPConnection(p.netloc)

        elif p.scheme == 'https':

            conn = HTTPSConnection(p.netloc)

        else:

            raise Exception('Unknown URL scheme')

        full_path = _prepare_path(p.path + path, format, params)

        kwargs = {}

        kwargs['headers'] = _prepare_headers(headers)

        kwargs['headers']['X-Auth-Token'] = self.token

        if body:

            kwargs['body'] = body

            kwargs['headers'].setdefault('content-type', 'application/octet-stream')

        kwargs['headers'].setdefault('content-length', len(body) if body else 0)

        #print '#', method, full_path, kwargs

        #t1 = datetime.datetime.utcnow()

        conn.request(method, full_path, **kwargs)

        resp = conn.getresponse()

        #t2 = datetime.datetime.utcnow()

        #print 'response time:', str(t2-t1)

        return _handle_response(resp, self.verbose, self.debug)

    def _chunked_transfer(self, path, method='PUT', f=stdin, headers=None,

                          blocksize=1024, params={}):

        """perfomrs a chunked request"""

        p = urlparse(self.url)

        if p.scheme == 'http':

            conn = HTTPConnection(p.netloc)

        elif p.scheme == 'https':

            conn = HTTPSConnection(p.netloc)

        else:

            raise Exception('Unknown URL scheme')

        full_path = _prepare_path(p.path + path, params=params)

        conn.putrequest(method, full_path)

        conn.putheader('x-auth-token', self.token)

        conn.putheader('content-type', 'application/octet-stream')

        conn.putheader('transfer-encoding', 'chunked')

        for k,v in _prepare_headers(headers).items():

            conn.putheader(k, v)

        conn.endheaders()

        # write body

        data = ''

        while True:

            if f.closed:

                break

            block = f.read(blocksize)

            if block == '':

                break

            data = '%x\r\n%s\r\n' % (len(block), block)

            try:

                conn.send(data)

            except:

                #retry

                conn.send(data)

        data = '0\r\n\r\n'

        try:

            conn.send(data)

        except:

            #retry

            conn.send(data)

        resp = conn.getresponse()

        return _handle_response(resp, self.verbose, self.debug)

    def delete(self, path, format='text', params={}):

        return self._req('DELETE', path, format=format, params=params)

    def get(self, path, format='text', headers={}, params={}):

        return self._req('GET', path, headers=headers, format=format,

                        params=params)

    def head(self, path, format='text', params={}):

         return self._req('HEAD', path, format=format, params=params)

    def post(self, path, body=None, format='text', headers=None, params={}):

        return self._req('POST', path, body, headers=headers, format=format,

                        params=params)

    def put(self, path, body=None, format='text', headers=None, params={}):

        return self._req('PUT', path, body, headers=headers, format=format,

                         params=params)

    def _list(self, path, format='text', params={}, **headers):

        status, headers, data = self.get(path, format=format, headers=headers,

                                         params=params)

        if format == 'json':

            data = json.loads(data) if data else ''

        elif format == 'xml':

            data = minidom.parseString(data)

        else:

            data = data.split('\n')[:-1] if data else ''

        return data

    def _get_metadata(self, path, prefix=None, params={}):

        status, headers, data = self.head(path, params=params)

        prefixlen = len(prefix) if prefix else 0

        meta = {}

        for key, val in headers.items():

            if prefix and not key.startswith(prefix):

                continue

            elif prefix and key.startswith(prefix):

                key = key[prefixlen:]

            meta[key] = val

        return meta

    def _filter(self, l, d):

        """

        filter out from l elements having the metadata values provided

        """

        ll = l

        for elem in l:

            if type(elem) == types.DictionaryType:

                for key in d.keys():

                    k = 'x_object_meta_%s' % key

                    if k in elem.keys() and elem[k] == d[key]:

                        ll.remove(elem)

                        break

        return ll

class OOS_Client(Client):

    """Openstack Object Storage Client"""

    def _update_metadata(self, path, entity, **meta):

        """adds new and updates the values of previously set metadata"""

        ex_meta = self.retrieve_account_metadata(restricted=True)

        ex_meta.update(meta)

        headers = {}

        prefix = 'x-%s-meta-' % entity

        for k,v in ex_meta.items():

            k = '%s%s' % (prefix, k)

            headers[k] = v

        return self.post(path, headers=headers)

    def _reset_metadata(self, path, entity, **meta):

        """

        overwrites all user defined metadata

        """

        headers = {}

        prefix = 'x-%s-meta-' % entity

        for k,v in meta.items():

            k = '%s%s' % (prefix, k)

            headers[k] = v

        return self.post(path, headers=headers)

    def _delete_metadata(self, path, entity, meta=[]):

        """delete previously set metadata"""

        ex_meta = self.retrieve_account_metadata(restricted=True)

        headers = {}

        prefix = 'x-%s-meta-' % entity

        for k in ex_meta.keys():

            if k in meta:

                headers['%s%s' % (prefix, k)] = ex_meta[k]

        return self.post(path, headers=headers)

    # Storage Account Services

    def list_containers(self, format='text', limit=None,

                        marker=None, params={}, account=None, **headers):

        """lists containers"""

        account = account or self.account

        path = '/%s' % account

        params.update({'limit':limit, 'marker':marker})

        return self._list(path, format, params, **headers)

    def retrieve_account_metadata(self, restricted=False, account=None, **params):

        """returns the account metadata"""

        account = account or self.account

        path = '/%s' % account

        prefix = 'x-account-meta-' if restricted else None

        return self._get_metadata(path, prefix, params)

    def update_account_metadata(self, account=None, **meta):

        """updates the account metadata"""

        account = account or self.account

        path = '/%s' % account

        return self._update_metadata(path, 'account', **meta)

    def delete_account_metadata(self, meta=[], account=None):

        """deletes the account metadata"""

        account = account or self.account

        path = '/%s' % account

        return self._delete_metadata(path, 'account', meta)

    def reset_account_metadata(self, account=None, **meta):

        """resets account metadata"""

        account = account or self.account

        path = '/%s' % account

        return self._reset_metadata(path, 'account', **meta)

    # Storage Container Services

    def _filter_trashed(self, l):

        return self._filter(l, {'trash':'true'})

    def list_objects(self, container, format='text',

                     limit=None, marker=None, prefix=None, delimiter=None,

                     path=None, include_trashed=False, params={}, account=None,

                     **headers):

        """returns a list with the container objects"""

        account = account or self.account

        params.update({'limit':limit, 'marker':marker, 'prefix':prefix,

                       'delimiter':delimiter, 'path':path})

        l = self._list('/%s/%s' % (account, container), format, params,

                       **headers)

        #TODO support filter trashed with xml also

        if format != 'xml' and not include_trashed:

            l = self._filter_trashed(l)

        return l

    def create_container(self, container, account=None, meta={}, **headers):

        """creates a container"""

        account = account or self.account

        if not headers:

            headers = {}

        for k,v in meta.items():

            headers['x-container-meta-%s' %k.strip().upper()] = v.strip()

        status, header, data = self.put('/%s/%s' % (account, container),

                                        headers=headers)

        if status == 202:

            return False

        elif status != 201:

            raise Fault(data, int(status))

        return True

    def delete_container(self, container, params={}, account=None):

        """deletes a container"""

        account = account or self.account

        return self.delete('/%s/%s' % (account, container), params=params)

    def retrieve_container_metadata(self, container, restricted=False,

                                    account=None, **params):

        """returns the container metadata"""

        account = account or self.account

        prefix = 'x-container-meta-' if restricted else None

        return self._get_metadata('/%s/%s' % (account, container), prefix,

                                  params)

    def update_container_metadata(self, container, account=None, **meta):

        """unpdates the container metadata"""

        account = account or self.account

        return self._update_metadata('/%s/%s' % (account, container),

                                     'container', **meta)

    def delete_container_metadata(self, container, meta=[], account=None):

        """deletes the container metadata"""

        account = account or self.account

        path = '/%s/%s' % (account, container)

        return self._delete_metadata(path, 'container', meta)

    # Storage Object Services

    def request_object(self, container, object, format='text', params={},

                       account=None, **headers):

        """returns tuple containing the status, headers and data response for an object request"""

        account = account or self.account

        path = '/%s/%s/%s' % (account, container, object)

        status, headers, data = self.get(path, format, headers, params)

        return status, headers, data

    def retrieve_object(self, container, object, format='text', params={},

                        account=None, **headers):

        """returns an object's data"""

        account = account or self.account

        t = self.request_object(container, object, format, params, account,

                                **headers)

        data = t[2]

        if format == 'json':

            data = json.loads(data) if data else ''

        elif format == 'xml':

            data = minidom.parseString(data)

        return data

    def retrieve_object_hashmap(self, container, object, format='json', params={},

                        account=None, **headers):

        """returns the hashmap representing object's data"""

        if not params:

            params = {}

        params.update({'hashmap':None})

        return self.retrieve_object(container, object, params, format, account, **headers)

    def create_directory_marker(self, container, object, account=None):

        """creates a dierectory marker"""

        account = account or self.account

        if not object:

            raise Fault('Directory markers have to be nested in a container')

        h = {'content_type':'application/directory'}

        return self.create_zero_length_object(container, object, account=account,

                                              **h)

    def create_object(self, container, object, f=stdin, format='text', meta={},

                      params={}, etag=None, content_type=None, content_encoding=None,

                      content_disposition=None, account=None, **headers):

        """creates a zero-length object"""

        account = account or self.account

        path = '/%s/%s/%s' % (account, container, object)

        for k, v  in headers.items():

            if v == None:

                headers.pop(k)

        l = ['etag', 'content_encoding', 'content_disposition', 'content_type']

        l = [elem for elem in l if eval(elem)]

        for elem in l:

            headers.update({elem:eval(elem)})

        headers.setdefault('content-type', 'application/octet-stream')

        for k,v in meta.items():

            headers['x-object-meta-%s' %k.strip()] = v.strip()

        data = f.read() if f else None

        return self.put(path, data, format, headers=headers, params=params)

    def create_zero_length_object(self, container, object, meta={}, etag=None,

                                  content_type=None, content_encoding=None,

                                  content_disposition=None, account=None,

                                  **headers):

        account = account or self.account

        args = locals().copy()

        for elem in ['self', 'container', 'headers', 'account']:

            args.pop(elem)

        args.update(headers)

        return self.create_object(container, account=account, f=None, **args)

    def update_object(self, container, object, f=stdin,

                      offset=None, meta={}, params={}, content_length=None,

                      content_type=None, content_encoding=None,

                      content_disposition=None,  account=None, **headers):

        account = account or self.account

        path = '/%s/%s/%s' % (account, container, object)

        for k, v  in headers.items():

            if v == None:

                headers.pop(k)

        l = ['content_encoding', 'content_disposition', 'content_type',

             'content_length']

        l = [elem for elem in l if eval(elem)]

        for elem in l:

            headers.update({elem:eval(elem)})

        if 'content_range' not in headers.keys():

            if offset != None:

                headers['content_range'] = 'bytes %s-/*' % offset

            else:

                headers['content_range'] = 'bytes */*'

        for k,v in meta.items():

            headers['x-object-meta-%s' %k.strip()] = v.strip()

        data = f.read() if f else None

        return self.post(path, data, headers=headers, params=params)

    def update_object_using_chunks(self, container, object, f=stdin,

                                   blocksize=1024, offset=None, meta={},

                                   params={}, content_type=None, content_encoding=None,

                                   content_disposition=None, account=None, **headers):

        """updates an object (incremental upload)"""

        account = account or self.account

        path = '/%s/%s/%s' % (account, container, object)

        headers = headers if not headers else {}

        l = ['content_type', 'content_encoding', 'content_disposition']