Net::Flickr::Backup - OOP for backing up your Flickr photos locally
use Net::Flickr::Backup;
use Log::Dispatch::Screen;
my $flickr = Net::Flickr::Backup->new($cfg);
my $feedback = Log::Dispatch::Screen->new('name' => 'info',
'min_level' => 'info');
$flickr->log()->add($feedback);
$flickr->backup();
OOP for backing up your Flickr photos locally.
Options are passed to Net::Flickr::Backup using a Config::Simple object or a valid Config::Simple config file. Options are grouped by "block".
String. required
A valid Flickr API key.
String. required
A valid Flickr Auth API secret key.
String. required
A valid Flickr Auth API token.
String. required
The root folder where you want photographs to be stored. Individual files are named using the following pattern :
B<photos_root>/B<YYYY>/B<MM>/B<DD>/B<YYYYMMDD>-B<photo_id>-B<clean_title>_B<size>.jpg
Where the various components are :
photo[@id=123]/dates/@taken
photo/@id
photo[@id=123]/title
Unicode characters translated in to ASCII (using Text::Unidecode) and the entire string is stripped anything that is not an alphanumeric, underbar, dash or a square bracket.
Net::Flickr::Backup will attempt to fetch not only the original file uploaded to Flickr but also, depending on your config options, the medium and square versions. Filenames will be modified as follows :
The original photo you uploaded to the Flickr servers. No extension is added.
These photos are scaled to 500 pixels at the longest dimension. A _m extension is added.
These photos are to cropped to 75 x 75 pixels at the center. A _s extension is added.
Boolean.
Retrieve the "original" version of a photo from the Flickr servers.
Default is true.
Boolean.
Retrieve the "medium" version of a photo from the Flickr servers; these photos have been scaled to 500 pixels at the longest dimension.
Default is false.
Boolean.
Retrieve the "square" version of a photo from the Flickr servers; these photos have been cropped to 75 x 75 pixels at the center.
Default is false.
Boolean.
If true then, for each Flickr photo ID backed up, the library will check backup.photos_root for images (and metadata files) with a matching ID but a different name. Matches will be deleted.
Boolean.
Force a photograph to be backed up even if it has not changed.
Default is false.
Boolean.
Generate an RDF description for each photograph. Descriptions are written to disk in separate files.
Default is false.
String.
The path where RDF data dumps for a photo should be written. The default is the same path as backup.photos_root.
File names are generated with the same pattern used to name photographs.
String.
If defined this string is applied as regular expression substitution to backup.photos_root.
Default is to append the file:/ URI protocol to a path.
Any valid parameter that can be passed to the flickr.photos.search method except 'user_id' which is pre-filled with the user_id that corresponds to the flickr.auth_token token.
Returns a Net::Flickr::Backup object.
Returns true or false.
Backup an individual photo. This method is called internally by backup.
Returns true or false.
Returns a hash ref of the prefixes and namespaces used by Net::Flickr::RDF
The default key/value pairs are :
Net::Flickr::Backup adds the following namespaces :
x-urn:$OSNAME: (where $OSNAME is the value of the English.pm $OSNAME variable.
Return the namespace prefix for $uri
Returns a string in the form of prefix:property. The property is the value of $name. The prefix passed may or may be the same as the prefix returned depending on whether or not the user has defined or redefined their own list of namespaces.
The prefix passed to the method is assumed to be one of prefixes in the default list of namespaces.
Returns an array ref of array refs of the meta data associated with a photo (%data).
If any errors are unencounter an error is recorded via the log method and the method returns undef.
Return the namespace prefix for $uri
Returns a string in the form of prefix:property. The property is the value of $name. The prefix passed may or may be the same as the prefix returned depending on whether or not the user has defined or redefined their own list of namespaces.
The prefix passed to the method is assumed to be one of prefixes in the default list of namespaces.
Valid args are :
A string containing the name of the Flickr API method you are calling.
A hash ref containing the key value pairs you are passing to method
If the method encounters any errors calling the API, receives an API error or can not parse the response it will log an error event, via the log method, and return undef.
Otherwise it will return a XML::LibXML::Document object (if XML::LibXML is installed) or a XML::XPath object.
Returns a Log::Dispatch object.
This is an example of a Config::Simple file used to back up photos tagged with 'cameraphone' from Flickr
[flickr] api_key=asd6234kjhdmbzcxi6e323 api_secret=s00p3rs3k3t auth_token=123-omgwtf4u [search] tags=cameraphone per_page=500 [backup] photos_root=/home/asc/photos scrub_backups=1 fetch_medium=1 fetch_square=1 force=0 [rdf] do_dump=1 rdfdump_root=/home/asc/photos
This is an example of an RDF dump for a photograph backed up from Flickr :
<?xml version='1.0'?> <rdf:RDF xmlns:dc="http://purl.org/dc/elements/1.1/" xmlns:a="http://www.w3.org/2000/10/annotation-ns" xmlns:acl="http://www.w3.org/2001/02/acls#" xmlns:exif="http://nwalsh.com/rdf/exif#" xmlns:skos="http://www.w3.org/2004/02/skos/core#" xmlns:foaf="http://xmlns.com/foaf/0.1/" xmlns:exifi="http://nwalsh.com/rdf/exif-intrinsic#" xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#" xmlns:rdfs="http://www.w3.org/2000/01/rdf-schema#" xmlns:computer="x-urn:freebsd:" xmlns:i="http://www.w3.org/2004/02/image-regions#" xmlns:flickr="x-urn:flickr:" xmlns:dcterms="http://purl.org/dc/terms/"> <flickr:photo rdf:about="http://www.flickr.com/photos/35034348999@N01/30763528"> <exif:isoSpeedRatings>1250</exif:isoSpeedRatings> <exif:apertureValue>336/100</exif:apertureValue> <exif:pixelYDimension>960</exif:pixelYDimension> <exif:focalLength>4.5 mm</exif:focalLength> <acl:access>visbility</acl:access> <exif:colorSpace>sRGB</exif:colorSpace> <exif:dateTimeOriginal>2005:08:02 18:12:19</exif:dateTimeOriginal> <dc:rights>All rights reserved.</dc:rights> <exif:shutterSpeedValue>4321/1000</exif:shutterSpeedValue> <dc:description></dc:description> <exif:exposureTime>0.05 sec (263/5260)</exif:exposureTime> <dc:created>2005-08-02T18:12:19-0700</dc:created> <dc:dateSubmitted>2005-08-02T18:16:20-0700</dc:dateSubmitted> <exif:gainControl>High gain up</exif:gainControl> <exif:flash>32</exif:flash> <exif:digitalZoomRatio>100/100</exif:digitalZoomRatio> <exif:pixelXDimension>1280</exif:pixelXDimension> <exif:dateTimeDigitized>2005:08:02 18:12:19</exif:dateTimeDigitized> <dc:title>20050802(007).jpg</dc:title> <exif:fNumber>f/3.2</exif:fNumber> <acl:accessor>public</acl:accessor> <dc:creator rdf:resource="http://www.flickr.com/people/35034348999@N01"/> <dc:subject rdf:resource="http://www.flickr.com/people/tags/usa"/> <dc:subject rdf:resource="http://www.flickr.com/people/tags/california"/> <dc:subject rdf:resource="http://www.flickr.com/people/tags/sanfrancisco"/> <dc:subject rdf:resource="http://www.flickr.com/people/tags/cameraphone"/> <a:hasAnnotation rdf:resource="http://www.flickr.com/photos/35034348999@N01/30763528#note-1140939"/> <a:hasAnnotation rdf:resource="http://www.flickr.com/photos/35034348999@N01/30763528#note-1140942"/> <a:hasAnnotation rdf:resource="http://www.flickr.com/photos/35034348999@N01/30763528#note-1140945"/> <a:hasAnnotation rdf:resource="http://www.flickr.com/photos/35034348999@N01/30763528#note-1140946"/> <a:hasAnnotation rdf:resource="http://www.flickr.com/photos/35034348999@N01/30763528#note-1140952"/> <a:hasAnnotation rdf:resource="http://www.flickr.com/photos/35034348999@N01/30763528#note-1142648"/> <a:hasAnnotation rdf:resource="http://www.flickr.com/photos/35034348999@N01/30763528#note-1142656"/> <a:hasAnnotation rdf:resource="http://www.flickr.com/photos/35034348999@N01/30763528#note-1143239"/> <a:hasAnnotation rdf:resource="http://www.flickr.com/photos/35034348999@N01/30763528#note-1148950"/> </flickr:photo> <flickr:note rdf:about="http://www.flickr.com/photos/35034348999@N01/30763528#note-1140942"> <i:boundingBox>468 141 22 26</i:boundingBox> <a:body>*sigh*</a:body> <i:regionDepicts rdf:resource="http://static.flickr.com/23/30763528_a981fab285.jpg"/> <a:author rdf:resource="http://www.flickr.com/people/44124415257@N01"/> <a:annotates rdf:resource="http://www.flickr.com/photos/35034348999@N01/30763528"/> </flickr:note> <dcterms:StillImage rdf:about="http://static.flickr.com/23/30763528_a981fab285_s.jpg"> <dcterms:relation>Square</dcterms:relation> <exifi:height>75</exifi:height> <exifi:width>75</exifi:width> <dcterms:isVersionOf rdf:resource="http://static.flickr.com/23/30763528_a981fab285_o.jpg"/> <rdfs:seeAlso rdf:resource="http://www.flickr.com/photos/35034348999@N01/30763528"/> </dcterms:StillImage> <flickr:note rdf:about="http://www.flickr.com/photos/35034348999@N01/30763528#note-1142656"> <i:boundingBox>357 193 81 28</i:boundingBox> <a:body>eww!</a:body> <i:regionDepicts rdf:resource="http://static.flickr.com/23/30763528_a981fab285.jpg"/> <a:author rdf:resource="http://www.flickr.com/people/32373682187@N01"/> <a:annotates rdf:resource="http://www.flickr.com/photos/35034348999@N01/30763528"/> </flickr:note> <flickr:user rdf:about="http://www.flickr.com/people/44124415257@N01"> <foaf:mbox_sha1sum>4f6f211958d5217ef0d10f7f5cd9a69cd66f217e</foaf:mbox_sha1sum> <foaf:name>Karl Dubost</foaf:name> <foaf:nick>karlcow</foaf:nick> </flickr:user> <flickr:note rdf:about="http://www.flickr.com/photos/35034348999@N01/30763528#note-1140939"> <i:boundingBox>326 181 97 25</i:boundingBox> <a:body>Did you see that this shirt makes me a beautiful breast?</a:body> <i:regionDepicts rdf:resource="http://static.flickr.com/23/30763528_a981fab285.jpg"/> <a:author rdf:resource="http://www.flickr.com/people/44124415257@N01"/> <a:annotates rdf:resource="http://www.flickr.com/photos/35034348999@N01/30763528"/> </flickr:note> <flickr:tag rdf:about="http://www.flickr.com/photos/35034348999@N01/tags/usa"> <skos:prefLabel>usa</skos:prefLabel> <dc:creator rdf:resource="http://www.flickr.com/people/35034348999@N01"/> <dcterms:isPartOf rdf:resource="http://flickr.com/photos/tags/usa"/> </flickr:tag> <flickr:note rdf:about="http://www.flickr.com/photos/35034348999@N01/30763528#note-1140952"> <i:boundingBox>9 205 145 55</i:boundingBox> <a:body>Do you want my opinion? There's a love affair going on here… Anyway. Talking non sense. We all know Heather is committed to Flickr. She even only dresses at FlickrApparel. Did they say &quot;No Logo&quot;. Doh Dude.</a:body> <i:regionDepicts rdf:resource="http://static.flickr.com/23/30763528_a981fab285.jpg"/> <a:author rdf:resource="http://www.flickr.com/people/44124415257@N01"/> <a:annotates rdf:resource="http://www.flickr.com/photos/35034348999@N01/30763528"/> </flickr:note> <dcterms:StillImage rdf:about="http://static.flickr.com/23/30763528_a981fab285_m.jpg"> <dcterms:relation>Small</dcterms:relation> <exifi:height>180</exifi:height> <exifi:width>240</exifi:width> <dcterms:isVersionOf rdf:resource="http://static.flickr.com/23/30763528_a981fab285_o.jpg"/> <rdfs:seeAlso rdf:resource="http://www.flickr.com/photos/35034348999@N01/30763528"/> </dcterms:StillImage> <flickr:tag rdf:about="http://www.flickr.com/photos/35034348999@N01/tags/cameraphone"> <skos:prefLabel>cameraphone</skos:prefLabel> <dc:creator rdf:resource="http://www.flickr.com/people/35034348999@N01"/> <dcterms:isPartOf rdf:resource="http://flickr.com/photos/tags/cameraphone"/> </flickr:tag> <computer:user rdf:about="x-urn:dhclient#asc"> <foaf:name>Aaron Straup Cope</foaf:name> <foaf:nick>asc</foaf:nick> </computer:user> <flickr:user rdf:about="http://www.flickr.com/people/34427469121@N01"> <foaf:mbox_sha1sum>216d56f03517c68e527c5b970552a181980c4389</foaf:mbox_sha1sum> <foaf:name>George Oates</foaf:name> <foaf:nick>George</foaf:nick> </flickr:user> <flickr:note rdf:about="http://www.flickr.com/photos/35034348999@N01/30763528#note-1140946"> <i:boundingBox>355 31 103 95</i:boundingBox> <a:body>(Yes… I love you heather, you are my dream star)</a:body> <i:regionDepicts rdf:resource="http://static.flickr.com/23/30763528_a981fab285.jpg"/> <a:author rdf:resource="http://www.flickr.com/people/44124415257@N01"/> <a:annotates rdf:resource="http://www.flickr.com/photos/35034348999@N01/30763528"/> </flickr:note> <rdf:Description rdf:about="x-urn:flickr:tag"> <rdfs:subClassOf rdf:resource="http://www.w3.org/2004/02/skos/core#Concept"/> </rdf:Description> <rdf:Description rdf:about="file:///home/asc/photos/2005/08/02/20050802-30763528-20050802_007.jpg"> <dcterms:created>2005-09-25T15:16:28Z</dcterms:created> <dc:creator rdf:resource="x-urn:dhclient#asc"/> <rdfs:seeAlso rdf:resource="http://www.flickr.com/photos/35034348999@N01/30763528"/> </rdf:Description> <rdf:Description rdf:about="file:///home/asc/photos/2005/08/02/20050802-30763528-20050802_007_m.jpg"> <dcterms:created>2005-09-25T15:16:28Z</dcterms:created> <dc:creator rdf:resource="x-urn:dhclient#asc"/> <rdfs:seeAlso rdf:resource="http://www.flickr.com/photos/35034348999@N01/30763528"/> </rdf:Description> <rdf:Description rdf:about="x-urn:freebsd:user"> <rdfs:subClassOf rdf:resource="http://xmlns.com/foaf/0.1/Person"/> </rdf:Description> <flickr:note rdf:about="http://www.flickr.com/photos/35034348999@N01/30763528#note-1143239"> <i:boundingBox>184 164 50 50</i:boundingBox> <a:body>Baaaaarp!</a:body> <i:regionDepicts rdf:resource="http://static.flickr.com/23/30763528_a981fab285.jpg"/> <a:author rdf:resource="http://www.flickr.com/people/34427469121@N01"/> <a:annotates rdf:resource="http://www.flickr.com/photos/35034348999@N01/30763528"/> </flickr:note> <rdf:Description rdf:about="file:///home/asc/photos/2005/08/02/20050802-30763528-20050802_007_s.jpg"> <dcterms:created>2005-09-25T15:16:28Z</dcterms:created> <dc:creator rdf:resource="x-urn:dhclient#asc"/> <rdfs:seeAlso rdf:resource="http://www.flickr.com/photos/35034348999@N01/30763528"/> </rdf:Description> <dcterms:StillImage rdf:about="http://static.flickr.com/23/30763528_a981fab285_t.jpg"> <dcterms:relation>Thumbnail</dcterms:relation> <exifi:height>75</exifi:height> <exifi:width>100</exifi:width> <dcterms:isVersionOf rdf:resource="http://static.flickr.com/23/30763528_a981fab285_o.jpg"/> <rdfs:seeAlso rdf:resource="http://www.flickr.com/photos/35034348999@N01/30763528"/> </dcterms:StillImage> <flickr:note rdf:about="http://www.flickr.com/photos/35034348999@N01/30763528#note-1140945"> <i:boundingBox>433 103 50 50</i:boundingBox> <a:body>(fuck… fuck…)</a:body> <i:regionDepicts rdf:resource="http://static.flickr.com/23/30763528_a981fab285.jpg"/> <a:author rdf:resource="http://www.flickr.com/people/44124415257@N01"/> <a:annotates rdf:resource="http://www.flickr.com/photos/35034348999@N01/30763528"/> </flickr:note> <flickr:user rdf:about="http://www.flickr.com/people/32373682187@N01"> <foaf:mbox_sha1sum>62bf10c8d5b56623226689b7be924c64dee5e94a</foaf:mbox_sha1sum> <foaf:name>heather powazek champ</foaf:name> <foaf:nick>heather</foaf:nick> </flickr:user> <rdf:Description rdf:about="x-urn:flickr:user"> <rdfs:subClassOf rdf:resource="http://xmlns.com/foaf/0.1/Person"/> </rdf:Description> <flickr:tag rdf:about="http://www.flickr.com/photos/35034348999@N01/tags/california"> <skos:prefLabel>california</skos:prefLabel> <dc:creator rdf:resource="http://www.flickr.com/people/35034348999@N01"/> <dcterms:isPartOf rdf:resource="http://flickr.com/photos/tags/california"/> </flickr:tag> <dcterms:StillImage rdf:about="http://static.flickr.com/23/30763528_a981fab285.jpg"> <dcterms:relation>Medium</dcterms:relation> <exifi:height>375</exifi:height> <exifi:width>500</exifi:width> <dcterms:isVersionOf rdf:resource="http://static.flickr.com/23/30763528_a981fab285_o.jpg"/> <rdfs:seeAlso rdf:resource="http://www.flickr.com/photos/35034348999@N01/30763528"/> </dcterms:StillImage> <flickr:note rdf:about="http://www.flickr.com/photos/35034348999@N01/30763528#note-1142648"> <i:boundingBox>202 224 50 50</i:boundingBox> <a:body>dude! who did this?</a:body> <i:regionDepicts rdf:resource="http://static.flickr.com/23/30763528_a981fab285.jpg"/> <a:author rdf:resource="http://www.flickr.com/people/32373682187@N01"/> <a:annotates rdf:resource="http://www.flickr.com/photos/35034348999@N01/30763528"/> </flickr:note> <dcterms:StillImage rdf:about="http://static.flickr.com/23/30763528_a981fab285_o.jpg"> <dcterms:relation>Original</dcterms:relation> <exifi:height>960</exifi:height> <exifi:width>1280</exifi:width> <rdfs:seeAlso rdf:resource="http://www.flickr.com/photos/35034348999@N01/30763528"/> </dcterms:StillImage> <flickr:user rdf:about="http://www.flickr.com/people/35034348999@N01"> <foaf:mbox_sha1sum>a4d1b5e38db5e2ed4f847f9f09fd51cf59bc0d3f</foaf:mbox_sha1sum> <foaf:name>Aaron</foaf:name> <foaf:nick>straup</foaf:nick> </flickr:user> <flickr:note rdf:about="http://www.flickr.com/photos/35034348999@N01/30763528#note-1148950"> <i:boundingBox>342 197 28 33</i:boundingBox> <a:body>Is that just one big boob, or...?</a:body> <i:regionDepicts rdf:resource="http://static.flickr.com/23/30763528_a981fab285.jpg"/> <a:author rdf:resource="http://www.flickr.com/people/34427469121@N01"/> <a:annotates rdf:resource="http://www.flickr.com/photos/35034348999@N01/30763528"/> </flickr:note> <rdf:Description rdf:about="x-urn:flickr:note"> <rdfs:subClassOf rdf:resource="http://www.w3.org/2000/10/annotation-nsAnnotation"/> </rdf:Description> <flickr:tag rdf:about="http://www.flickr.com/photos/35034348999@N01/tags/sanfrancisco"> <skos:prefLabel>san francisco</skos:prefLabel> <skos:altLabel>sanfrancisco</skos:altLabel> <dc:creator rdf:resource="http://www.flickr.com/people/35034348999@N01"/> <dcterms:isPartOf rdf:resource="http://flickr.com/photos/tags/sanfrancisco"/> </flickr:tag> </rdf:RDF>
2.3
$Date: 2005/12/17 17:59:23 $
Aaron Straup Cope <ascope@cpan.org>
http://www.flickr.com/services/api/misc.userauth.html
Please report all bugs via http://rt.cpan.org
Copyright (c) 2005 Aaron Straup Cope. All Rights Reserved.
This is free software. You may redistribute it and/or modify it under the same terms as Perl itself.
![http://static.flickr.com/23/30763528_a981fab285.jpg"/](http://static.flickr.com/23/30763528_a981fab285.jpg"/){kind=link}
![http://static.flickr.com/23/30763528_a981fab285_o.jpg"/](http://static.flickr.com/23/30763528_a981fab285_o.jpg"/){kind=link}
