ECLAPI.ECLConnection Class Reference

Public Member Functions
def	__init__ (self, url, username=None, password=None, xml_user=True)
def	post (self, entry)
def	close (self)
def	list (self, category=None, form=None, tag=None, limit=None, after=None, substring=None, text=None)
def	get (self, eid)

Static Public Attributes
string	SignatureMethod = "md5"

Private Member Functions
def	_make_salt (self)
def	_signature (self, method, args, body)
def	_add_signature (self, req, args, body)

Private Attributes
	_url
	_username
	_password

Detailed Description

Definition at line 47 of file ECLAPI.py.

Constructor & Destructor Documentation

def ECLAPI.ECLConnection.__init__	(		self,
			url,
			username = None,
			password = None,
			xml_user = True
	)

Definition at line 51 of file ECLAPI.py.

    def __init__(self, url, username=None, password=None, xml_user=True):
        '''
        '''
        self._url = url
        self._username = username
        self._password = password
        

Member Function Documentation

def ECLAPI.ECLConnection._add_signature (   self,   req,   args,   body  )

private

Definition at line 80 of file ECLAPI.py.

    def _add_signature(self, req, args, body):
        if self._username:
            req.add_header("X-Signature-Method", self.SignatureMethod)
            req.add_header("X-User", self._username)
            req.add_header("X-Signature", 
                self._signature(self.SignatureMethod, args, body))

def ECLAPI.ECLConnection._make_salt (   self )

private

Definition at line 59 of file ECLAPI.py.

    def _make_salt(self):
        m = hashlib.new('md5')
        m.update("%s" % (random.randint(1,1234567890),))
        return m.hexdigest()

def ECLAPI.ECLConnection._signature (   self,   method,   args,   body  )

private

Definition at line 65 of file ECLAPI.py.

    def _signature(self, method, args, body):
        text = '%s:%s:%s' % (args, self._password, body)
        h = None
        if method == 'sha1':
            h = hashlib.sha1()
        elif method == 'md5':
            h = hashlib.md5()
        elif method == 'sha512':
            h = hashlib.sha512()
        if h == None:
            return None
        h.update(text)
        return h.hexdigest() 

def ECLAPI.ECLConnection.close

(

self

)

Definition at line 112 of file ECLAPI.py.

    def close(self):
        pass

def ECLAPI.ECLConnection.get	(		self,
			eid
	)

Definition at line 153 of file ECLAPI.py.

    def get(self, eid):
        args = ['e=%s' % (eid,), 'salt=%s' % (self._make_salt(),)]
        url = self._url + '/E/xml_get'
        args = '&'.join(args)
        if args:
            url += '?' + args
        req =  urllib2.Request(url=url)
        self._add_signature(req, args, '')
        response = urllib2.urlopen(req)
        return response.read()        
        
        
        

def ECLAPI.ECLConnection.list	(		self,
			category = None,
			form = None,
			tag = None,
			limit = None,
			after = None,
			substring = None,
			text = None
	)

Definition at line 116 of file ECLAPI.py.

            limit=None, after=None, substring=None, text=None):
        args = ['o=ids', 'salt=%s' % (self._make_salt(),)]
        if category:
            args.append('c=%s' % (urllib.quote_plus(category,)))
        if form:
            args.append('f=%s' % (urllib.quote_plus(form,)))
        if after:
            if type(after) != type(''):
                after = after.strptime('%Y-%m-%d %H:%M:%S')
            args.append('a=%s' % (urllib.quote_plus(after),))
        if tag:
            args.append('t=%s' % (tag,))
        if limit:
            args.append('l=%s' % (limit,))
        if substring:
            args.append('st=%s' % (urllib.quote_plus(substring),))
        if text:
            args.append('si=%s' % (urllib.quote_plus(text),))

        url = self._url + '/E/xml_search'
        args = '&'.join(args)
        
        if args:
            url += '?' + args
        req =  urllib2.Request(url=url)
        self._add_signature(req, args, '')
        #print 'Signature: '+ self.calculate_signature(self._password + ":" + params, 
        #            self.SignatureMethod)
        
        try:
            response = urllib2.urlopen(req)
        except HTTPError, error:
            raise ECLHTTPError(error.code, error.msg, error.fp.read()) 
        tree = etree.parse(response)
        entries = tree.findall('entry')
        return [int(e.attrib.get('id')) for e in entries]
        

def ECLAPI.ECLConnection.post	(		self,
			entry
	)

Definition at line 87 of file ECLAPI.py.

    def post(self, entry):
        '''
        '''
        if self._username:
            entry.setAuthor(self._username)
        params = entry.xshow().strip()
        args = "salt=%s" % (self._make_salt(),)
        req = urllib2.Request(url=self._url + '/E/xml_post' +
            '?' + args, data=params)
        #print 'Signature: '+ self.calculate_signature(self._password + ":" + params, 
        #            self.SignatureMethod)
        req.add_header("Content-type", "text/xml")
        if self._url.startswith("https:"):
            req.add_header("X-Password", self._password)
        self._add_signature(req, args, params)
        try:
            response = urllib2.urlopen(req)
        except HTTPError, err:
            return err.code, err.msg, err.fp.read()
            
        data = response.read()

        #print data  # DEBUG
        return response.code, response.msg, data

Member Data Documentation

ECLAPI.ECLConnection._password

private

Definition at line 56 of file ECLAPI.py.

ECLAPI.ECLConnection._url

private

Definition at line 54 of file ECLAPI.py.

ECLAPI.ECLConnection._username

private

Definition at line 55 of file ECLAPI.py.

string ECLAPI.ECLConnection.SignatureMethod = "md5"

static

Definition at line 49 of file ECLAPI.py.

---

The documentation for this class was generated from the following file:

• duneutil/scripts/ECLAPI.py