Skip to content

Instantly share code, notes, and snippets.

@BlackVoid

BlackVoid/_sync.py

Last active June 29, 2022 17:56
Show Gist options
  • Save BlackVoid/0cc61fdba9e9f2b6526a to your computer and use it in GitHub Desktop.
Save BlackVoid/0cc61fdba9e9f2b6526a to your computer and use it in GitHub Desktop.
Download ZIP
Small script to sync images from facebook with CardDAV server (single user).
Raw
_sync.py
import fb
import carddav
import vobject
import requests
import Levenshtein
import sys
"""
Installs dependences required for lxml:
apt-get install libxml2-dev libxslt1-dev python-dev
fb==0.4.0
lxml==3.4.0
python-Levenshtein==0.11.2
requests==2.4.1
vobject==0.6.6
"""
token = "" # Token from facebook
host = "" # CardDav host ex. https://example.com/baikal/card.php/addressbooks/USERNAME/default/
usr = "" # Username on CardDav host
pwd = "" # Password on CardDav host
auth = "digest" # CardDav authentication method
# Authentication with carddav server and fetching all contacts
dav = carddav.PyCardDAV(host , user=usr, passwd=pwd, auth=auth, write_support=True, verify=True )
abook = dav.get_abook()
nCards = len( abook.keys() )
print("Fetched %s contacts from CardDAV." % (nCards,))
# Authenticating with facebook graph and fetching all friends along with firstname, lastname and URL to profile photos.
facebook = fb.graph.api(token)
friends = facebook.get_object(cat='single', id='me/taggable_friends', fields=['picture.width(512).height(512).type(square)', 'first_name', 'last_name'])["data"]
print("Fetched %s friends from Facebook." % (len(friends),))
matches = {}
for href, etag in abook.items():
# Fetching vcard from href
card = dav.get_vcard( href )
# Converting string to vcard object
vobj=vobject.readOne(card)
cname = "%s %s" % (vobj.n.value.given, vobj.n.value.family,)
for f in friends:
# uses Levenshtein distance to check if name is similar enough to be a mathc
distance = Levenshtein.distance(cname,"%s %s" % (f["first_name"], f["last_name"]))
# At most one character different is acceptable
if Levenshtein.distance(cname,"%s %s" % (f["first_name"], f["last_name"])) <= 1:
matches[cname] = f["id"]
# Downloads profile image
r = requests.get(f['picture']['data']['url'])
# Check if image is different from the one stored in the vcard (to not cause unnecessary updates on devices)
if hasattr(vobj, 'photo') and vobj.photo.value == r.content:
print("Pictures matches, no update for %s" % (cname,))
break
# Creates photo object in case it doesn't already exist.
vobj.add('photo')
vobj.photo.value = r.content
vobj.photo.encoding_param = "b"
vobj.photo.type_param = "JPEG"
try:
# Uploads changes to CardDAV server.
dav.update_vcard( vobj.serialize().decode( 'utf-8' ), href, etag )
print("Different picture, update for %s" % (cname,))
except Exception, e:
print ''
raise
break
if not cname in matches.keys():
print "No match: %s" % (cname,)
print "Sync finished!"
Raw
carddav.py
#!/usr/bin/env python
# vim: set ts=4 sw=4 expandtab sts=4:
# Copyright (c) 2011-2013 Christian Geier & contributors
#
# 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.
#-------------------------------------------------------------------------------
# Lukasz Janyst:
#
# lxml encoding issue:
# * Remove '<?xml version="1.0" encoding="utf-8"?>' header from responses
# to prevent etree errors
#
# requests-0.8.2:
# * Remove the verify ssl flag - caused exception
# * Add own raise_for_status for more meaningful error messages
# * Fix digest auth
#-------------------------------------------------------------------------------
"""
contains the class PyCardDAV and some associated functions and definitions
"""
from collections import namedtuple
import requests
import sys
import urlparse
import logging
import lxml.etree as ET
import string
def raise_for_status( resp ):
if 400 <= resp.status_code < 500 or 500 <= resp.status_code < 600:
msg = 'Error code: ' + str(resp.status_code) + '\n'
msg += resp.content
raise requests.exceptions.HTTPError( msg )
def get_random_href():
"""returns a random href"""
import random
tmp_list = list()
for _ in xrange(3):
rand_number = random.randint(0, 0x100000000)
tmp_list.append("{0:x}".format(rand_number))
return "-".join(tmp_list).upper()
DAVICAL = 'davical'
SABREDAV = 'sabredav'
UNKNOWN = 'unknown server'
class UploadFailed(Exception):
"""uploading the card failed"""
pass
class PyCardDAV(object):
"""class for interacting with a CardDAV server
Since PyCardDAV relies heavily on Requests [1] its SSL verification is also
shared by PyCardDAV [2]. For now, only the *verify* keyword is exposed
through PyCardDAV.
[1] http://docs.python-requests.org/
[2] http://docs.python-requests.org/en/latest/user/advanced/
raises:
requests.exceptions.SSLError
requests.exceptions.ConnectionError
more requests.exceptions depending on the actual error
Exception (shame on me)
"""
def __init__(self, resource, debug='', user='', passwd='',
verify=True, write_support=False, auth='basic'):
#shutup url3
urllog = logging.getLogger('requests.packages.urllib3.connectionpool')
urllog.setLevel(logging.CRITICAL)
split_url = urlparse.urlparse(resource)
url_tuple = namedtuple('url', 'resource base path')
self.url = url_tuple(resource,
split_url.scheme + '://' + split_url.netloc,
split_url.path)
self.debug = debug
self.session = requests.session()
self.write_support = write_support
self._settings = {'verify': verify}
if auth == 'basic':
self._settings['auth'] = (user, passwd,)
if auth == 'digest':
from requests.auth import HTTPDigestAuth
self._settings['auth'] = HTTPDigestAuth(user, passwd)
self._default_headers = {"User-Agent": "pyCardDAV"}
response = self.session.request('PROPFIND', resource,
headers=self.headers,
**self._settings)
raise_for_status( response ) #raises error on not 2XX HTTP status code
@property
def verify(self):
"""gets verify from settings dict"""
return self._settings['verify']
@verify.setter
def verify(self, verify):
"""set verify"""
self._settings['verify'] = verify
@property
def headers(self):
return dict(self._default_headers)
def _check_write_support(self):
"""checks if user really wants his data destroyed"""
if not self.write_support:
sys.stderr.write("Sorry, no write support for you. Please check "
"the documentation.\n")
sys.exit(1)
def _detect_server(self):
"""detects CardDAV server type
currently supports davical and sabredav (same as owncloud)
:rtype: string "davical" or "sabredav"
"""
response = requests.request('OPTIONS',
self.url.base,
headers=self.header)
if "X-Sabre-Version" in response.headers:
server = SABREDAV
elif "X-DAViCal-Version" in response.headers:
server = DAVICAL
else:
server = UNKNOWN
logging.info(server + " detected")
return server
def get_abook(self):
"""does the propfind and processes what it returns
:rtype: list of hrefs to vcards
"""
xml = self._get_xml_props()
abook = self._process_xml_props(xml)
return abook
def get_vcard(self, href):
"""
pulls vcard from server
:returns: vcard
:rtype: string
"""
response = self.session.get(self.url.base + href,
headers=self.headers,
**self._settings)
raise_for_status( response )
return response.content
def update_vcard(self, card, href, etag):
"""
pushes changed vcard to the server
card: vcard as unicode string
etag: str or None, if this is set to a string, card is only updated if
remote etag matches. If etag = None the update is forced anyway
"""
# TODO what happens if etag does not match?
self._check_write_support()
remotepath = str(self.url.base + href)
headers = self.headers
headers['content-type'] = 'text/vcard'
if etag is not None:
headers['If-Match'] = etag
self.session.put(remotepath, data=card.encode('utf-8'), headers=headers,
**self._settings)
def delete_vcard(self, href, etag):
"""deletes vcard from server
deletes the resource at href if etag matches,
if etag=None delete anyway
:param href: href of card to be deleted
:type href: str()
:param etag: etag of that card, if None card is always deleted
:type href: str()
:returns: nothing
"""
# TODO: what happens if etag does not match, url does not exist etc ?
self._check_write_support()
remotepath = str(self.url.base + href)
headers = self.headers
headers['content-type'] = 'text/vcard'
if etag is not None:
headers['If-Match'] = etag
result = self.session.delete(remotepath,
headers=headers,
**self._settings)
raise_for_status( response )
def upload_new_card(self, card):
"""
upload new card to the server
:param card: vcard to be uploaded
:type card: unicode
:rtype: tuple of string (path of the vcard on the server) and etag of
new card (string or None)
"""
self._check_write_support()
card = card.encode('utf-8')
for _ in range(0, 5):
rand_string = get_random_href()
remotepath = str(self.url.resource + rand_string + ".vcf")
headers = self.headers
headers['content-type'] = 'text/vcard'
headers['If-None-Match'] = '*'
response = requests.put(remotepath, data=card, headers=headers,
**self._settings)
if response.ok:
parsed_url = urlparse.urlparse(remotepath)
if response.headers['etag'] is None:
etag = ''
else:
etag = response.headers['etag']
return (parsed_url.path, etag)
raise_for_status( response )
def _get_xml_props(self):
"""PROPFIND method
gets the xml file with all vcard hrefs
:rtype: str() (an xml file)
"""
headers = self.headers
headers['Depth'] = '1'
response = self.session.request('PROPFIND',
self.url.resource,
headers=headers,
**self._settings)
raise_for_status( response )
if response.headers['DAV'].count('addressbook') == 0:
raise Exception("URL is not a CardDAV resource")
return response.content
@classmethod
def _process_xml_props(cls, xml):
"""processes the xml from PROPFIND, listing all vcard hrefs
:param xml: the xml file
:type xml: str()
:rtype: dict() key: href, value: etag
"""
xml = string.replace( xml, '<?xml version="1.0" encoding="utf-8"?>', '', 1 )
namespace = "{DAV:}"
element = ET.XML(xml)
abook = dict()
for response in element.iterchildren():
if (response.tag == namespace + "response"):
href = ""
etag = ""
insert = False
for refprop in response.iterchildren():
if (refprop.tag == namespace + "href"):
href = refprop.text
for prop in refprop.iterchildren():
for props in prop.iterchildren():
if (props.tag == namespace + "getcontenttype" and
(props.text == "text/vcard" or
props.text == "text/x-vcard" or
props.text == "text/x-vcard; charset=utf-8")):
insert = True
if (props.tag == namespace + "getetag"):
etag = props.text
if insert:
abook[href] = etag
return abook
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment