flickrbackup-0.2/0000755000175000017500000000000011641073243013004 5ustar tiagotiagoflickrbackup-0.2/README0000644000175000017500000000047311637165215013676 0ustar tiagotiagoflickrbackup - backup your flickr photos ---------------------------------------- flickrbackup is a simple python script which allows you to save a local copy of your flickr photo sets. Run it with -h to see the options. dependencies ------------ python simple usage ------------ ./flickrbackup -o flickrbackup-0.2/COPYING0000644000175000017500000002613611637162720014053 0ustar tiagotiago Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. Copyright [yyyy] [name of copyright owner] 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. flickrbackup-0.2/flickrbackup0000755000175000017500000003235211641072745015405 0ustar tiagotiago#!/usr/bin/env python # # flickrbackup - a simple python script to grab all your photos from flickr, # dump into a directory - organised into folders by set - # along with any favourites you have saved. # # Original Author: colm - AT - allcosts.net - Colm MacCarthaigh - 2008-01-21 # # Modified by: Dan Benjamin - http://hivelogic.com # # Forked, renamed and (being) refactored by Tiago Bortoletto Vaz # in Thu Sep 8 00:04:58 UTC 2011 # # License: Apache 2.0 - http://www.apache.org/licenses/LICENSE-2.0.html # import xml.dom.minidom import webbrowser import urlparse import urllib2 import unicodedata import cPickle import hashlib import sys import os import optparse import pyexiv2 API_KEY = "5c94226d43774e47e67b0b8578a95a40" SHARED_SECRET = "dfbd14bafe4e8f06" # # Utility functions for dealing with flickr authentication # def getText(nodelist): rc = "" for node in nodelist: if node.nodeType == node.TEXT_NODE: rc = rc + node.data return rc.encode("utf-8") # # Normalize input text to ASCII # def normalizeToASCII(text): return unicodedata.normalize('NFKD', text.decode("utf-8", "ignore")).encode('ASCII', 'ignore') # # Get the frob based on our API_KEY and shared secret # def getfrob(): # Create our signing string string = SHARED_SECRET + "api_key" + API_KEY + "methodflickr.auth.getFrob" hash = hashlib.md5(string).digest().encode("hex") # Formulate the request url = "http://api.flickr.com/services/rest/?method=flickr.auth.getFrob" url += "&api_key=" + API_KEY + "&api_sig=" + hash try: # Make the request and extract the frob response = urllib2.urlopen(url) # Parse the XML dom = xml.dom.minidom.parse(response) # get the frob frob = getText(dom.getElementsByTagName("frob")[0].childNodes) # Free the DOM dom.unlink() # Return the frob return frob except: raise "Could not retrieve frob" # # Login and get a token # def froblogin(frob, perms): string = SHARED_SECRET + "api_key" + API_KEY + "frob" + frob + "perms" + perms hash = hashlib.md5(string).digest().encode("hex") # Formulate the request url = "http://api.flickr.com/services/auth/?" url += "api_key=" + API_KEY + "&perms=" + perms url += "&frob=" + frob + "&api_sig=" + hash # Tell the user what's happening print "In order to allow flickrbackup to read your photos and favourites" print "you need to allow the application. Please press return when you've" print "granted access at the following url (which should have opened" print "automatically)." print print url print print "Waiting for you to press return" # We now have a login url, open it in a web-browser webbrowser.open_new(url) # Wait for input sys.stdin.readline() # Now, try and retrieve a token string = SHARED_SECRET + "api_key" + API_KEY + "frob" + frob + "methodflickr.auth.getToken" hash = hashlib.md5(string).digest().encode("hex") # Formulate the request url = "http://api.flickr.com/services/rest/?method=flickr.auth.getToken" url += "&api_key=" + API_KEY + "&frob=" + frob url += "&api_sig=" + hash # See if we get a token try: # Make the request and extract the frob response = urllib2.urlopen(url) # Parse the XML dom = xml.dom.minidom.parse(response) # get the token and user-id token = getText(dom.getElementsByTagName("token")[0].childNodes) nsid = dom.getElementsByTagName("user")[0].getAttribute("nsid") # Free the DOM dom.unlink() # Return the token and userid return (nsid, token) except: raise "Login failed" # # Sign an arbitrary flickr request with a token # def flickrsign(url, token): query = urlparse.urlparse(url).query query += "&api_key=" + API_KEY + "&auth_token=" + token params = query.split('&') # Create the string to hash string = SHARED_SECRET # Sort the arguments alphabettically params.sort() for param in params: string += param.replace('=', '') hash = hashlib.md5(string).digest().encode("hex") # Now, append the api_key, and the api_sig args url += "&api_key=" + API_KEY + "&auth_token=" + token + "&api_sig=" + hash # Return the signed url return url # # Grab the photo from the server # def getphoto(id, token, filename): try: # Contruct a request to find the sizes url = "http://api.flickr.com/services/rest/?method=flickr.photos.getSizes" url += "&photo_id=" + id # Sign the request url = flickrsign(url, token) # Make the request response = urllib2.urlopen(url) # Parse the XML dom = xml.dom.minidom.parse(response) # Get the list of sizes sizes = dom.getElementsByTagName("size") # Grab the original if it exists if (sizes[-1].getAttribute("label") == "Original"): imgurl = sizes[-1].getAttribute("source") else: print "Failed to get original for photo id " + id # Free the DOM memory dom.unlink() # Grab the image file response = urllib2.urlopen(imgurl) data = response.read() # Save the file! fh = open(filename, "w") fh.write(data) fh.close() return filename except: print "Failed to retrieve photo id " + id # # Grab Photo Metadata from the server # code based on flickrtouchr fork from Greg Grossmeier # https://code.launchpad.net/~greg.grossmeier/+junk/flickrtouchr # def getmetadata(id, token): try: # Contruct a request to find the sizes url = "http://api.flickr.com/services/rest/?method=flickr.photos.getInfo" url += "&photo_id=" + id # Sign the request url = flickrsign(url, token) # Make the request response = urllib2.urlopen(url) # Parse the XML dom = xml.dom.minidom.parse(response) # Get the Info #title = normalizeToASCII(getText(dom.getElementsByTagName("title")[0].childNodes)) title = getText(dom.getElementsByTagName("title")[0].childNodes) description = getText(dom.getElementsByTagName("description")[0].childNodes) tags = getText(dom.getElementsByTagName("tags")[0].childNodes) urls = getText(dom.getElementsByTagName("urls")[0].childNodes) metadata = {'title' : title, 'desc' : description, 'tags' : tags, 'urls' : urls} # Free the DOM memory dom.unlink() return metadata except: print "Failed to retrieve photo metadata from photo id " + id # # Write metadata to EXIF # def writeEXIF(imagepath,key,value): try: metadata = pyexiv2.ImageMetadata(imagepath) metadata.read() metadata[key] = value metadata.write() except: print "Failed to write EXIF tag %s to photo id %s" % (key, imagepath) ######## Main Application ########## if __name__ == '__main__': program = "flickrbackup" version = "%prog 0.2" usage = "Usage: %prog [OPTIONS] -o OUTPUT_DIR" description = "Backup your flickr photos." # Parse a few arguments parser = optparse.OptionParser(usage=usage, version=version, description=description, prog=program) parser.add_option('-o', '--output_dir', action="store", dest="output_dir", help="set the local directory where you want to store your pictures", ) parser.add_option('-e', '--metadata-exif', action="store_true", dest="exif", default=False, help="store flickr metadata (title, description etc) as EXIF tags in your local files [default: %default]", ) parser.add_option('-x', '--metadata-xml', action="store_true", dest="xml", default=False, help="store metadata as default flickr XML files [NOT IMPLEMENTED]", ) parser.add_option('-u', '--metadata-update', action="store_true", dest="update", default=False, help="update flickr metadata to your local files. Use this option with -x and/or -e [default: %default]", ) parser.add_option('-g', '--html-gallery', action="store_true", dest="gallery", default=False, help="generate a local HTML gallery [NOT IMPLEMENTED]", ) (options, args) = parser.parse_args() try: os.chdir(options.output_dir) except: parser.error("use -o to specify a directory\n") if options.update and (not options.exif and not options.xml): parser.error("please choose at least one way to store your metadata. Use -e (exif) and/or -x (xml)") # First things first, see if we have a cached user and auth-token try: cache = open(".flickrbackup.frob.cache", "r") config = cPickle.load(cache) cache.close() # We don't - get a new one except: (user, token) = froblogin(getfrob(), "read") config = { "version":1 , "user":user, "token":token } # Save it for future use cache = open(".flickrbackup.frob.cache", "w") cPickle.dump(config, cache) cache.close() # Now, construct a query for the list of photo sets url = "http://api.flickr.com/services/rest/?method=flickr.photosets.getList" url += "&user_id=" + config["user"] url = flickrsign(url, config["token"]) # get the result response = urllib2.urlopen(url) # Parse the XML dom = xml.dom.minidom.parse(response) # Get the list of Sets sets = dom.getElementsByTagName("photoset") # For each set - create a url urls = [] for set in sets: pid = set.getAttribute("id") dir = getText(set.getElementsByTagName("title")[0].childNodes) dir = normalizeToASCII(dir) # Build the list of photos url = "http://api.flickr.com/services/rest/?method=flickr.photosets.getPhotos" url += "&photoset_id=" + pid # Append to our list of urls urls.append( (url , dir) ) # Free the DOM memory dom.unlink() # Add the photos which are not in any set url = "http://api.flickr.com/services/rest/?method=flickr.photos.getNotInSet" urls.append( (url, "No Set") ) # Add the user's Favourites url = "http://api.flickr.com/services/rest/?method=flickr.favorites.getList" urls.append( (url, "Favourites") ) # Time to get the photos inodes = {} for (url , dir) in urls: # Create the directory try: os.makedirs(dir) except: pass # Get 500 results per page url += "&per_page=500" pages = page = 1 while page <= pages: request = url + "&page=" + str(page) # Sign the url request = flickrsign(request, config["token"]) # Make the request response = urllib2.urlopen(request) # Parse the XML dom = xml.dom.minidom.parse(response) # print dom.toprettyxml(encoding="utf8") # Get the total if dom.getElementsByTagName("photo"): pages = int(dom.getElementsByTagName("photo")[0].parentNode.getAttribute("pages")) # Grab the photos for photo in dom.getElementsByTagName("photo"): # Tell the user we're grabbing the file print 'Getting "' + photo.getAttribute("title").encode("utf8") + '" in set "' + dir + '"' # Grab the id photoid = photo.getAttribute("id") # The target target = dir + "/" + photoid + ".jpg" # Skip files that exist if os.access(target, os.R_OK): inodes[photoid] = target print target + " exists. Skipping download..." # Write EXIF metadata if user wants to update it if options.update is True and options.exif is True: writeEXIF(target,"Exif.Image.ImageDescription",getmetadata(photo.getAttribute("id"), config["token"])["title"]) writeEXIF(target,"Exif.Photo.UserComment",getmetadata(photo.getAttribute("id"), config["token"])["desc"]) continue # Look it up in our dictionary of inodes first if photoid in inodes and inodes[photoid] and os.access(inodes[photoid], os.R_OK): # woo, we have it already, use a hard-link os.link(inodes[photoid], target) else: inodes[photoid] = getphoto(photo.getAttribute("id"), config["token"], target) # Writing EXIF metadata if user wants to if options.exif is True: writeEXIF(target,"Exif.Image.ImageDescription",getmetadata(photo.getAttribute("id"), config["token"])["title"]) writeEXIF(target,"Exif.Photo.UserComment",getmetadata(photo.getAttribute("id"), config["token"])["desc"]) # Move on the next page page = page + 1