File Coverage

blib/lib/Net/Flickr/Geo/YahooMaps.pm

Criterion	Covered	Total	%
statement	6	6	100.0
branch			n/a
condition			n/a
subroutine	2	2	100.0
pod			n/a
total	8	8	100.0

use strict;
# $Id: YahooMaps.pm,v 1.24 2008/08/03 17:08:40 asc Exp $

package Net::Flickr::Geo::YahooMaps;
use base qw (Net::Flickr::Geo);

$Net::Flickr::Geo::YahooMaps::VERSION = '0.72';

=head1 NAME

Net::Flickr::Geo::YahooMaps - tools for working with geotagged Flickr photos and Yahoo! Maps

=head1 SYNOPSIS

 my %opts = ();
 getopts('c:i:', \%opts);

 my $cfg = Config::Simple->new($opts{'c'});

 my $fl = Net::Flickr::Geo::YahooMaps->new($cfg);
 $fl->log()->add(Log::Dispatch::Screen->new('name' => 'scr', min_level => 'info'));

 my @map = $fl->mk_pinwin_map_for_photo($opts{'i'});
 print Dumper(\@map);

 # returns :
 # ['/tmp/GGsf4552h.jpg', '99999992'];

=head1 DESCRIPTION

Tools for working with geotagged Flickr photos and Yahoo! Maps

=cut

=head1 OPTIONS

Options are passed to Net::Flickr::Backup using a Config::Simple object or
a valid Config::Simple config file. Options are grouped by "block".

=head2 flickr

=over 4

=item * B

String. I

A valid Flickr API key.

=item * B

String. I

A valid Flickr Auth API secret key.

=item * B

String. I

A valid Flickr Auth API token.

The B defines which XML/XPath handler to use to process API responses.

=over 4

=item * B

Use XML::LibXML.

=item * B

Use XML::XPath.

=back

=back

=head2 pinwin

=item * B

The height of the background map on which the pinwin/thumbnail will be
placed.

Default is 1024.

=item * B

The width of the background map on which the pinwin/thumbnail will be
placed.

Default is 1024.

=item * B

Boolean.

Automatically upload newly create map images to Flickr. Photos will be tagged with the following machine tags :

=over 4

=item * B

Where I is the photo that has been added to the map image.

=item * B

=back

Default is false.

=item * B

Boolean.

Mark pinwin uploads to Flickr as viewable by anyone.

Default is false.

=item * B

Boolean.

Mark pinwin uploads to Flickr as viewable only by friends.

Default is false.

=item * B

Boolean.

Mark pinwin uploads to Flickr as viewable only by family.

Default is false.

=item * B

Int.

By default, the object will try to map the (Flickr) accuracy to the corresponding
zoom level of the Modest Maps provider you have chosen. If this option is defined
then it will be used as the zoom level regardless of what Flickr says.

=item * B

Int (or array reference of ints)

Used by I related object methods, a list of photos to exclude from the list
returned by the Flickr API.

=item * B

String (or array reference of strings)

Used by I related object methods, a list of tags that all photos must B have if
they are to be included in the final output.

=item * B

String (or array reference of strings)

Used by I related object methods, a list of tags that all photos must have if
they are to be included in the final output.

=head2 yahoo

=over 4

=item * B

A valid Yahoo! developers API key.

=item * B

Set the Yahoo! Map Image API 'radius' property. From the docs :

"How far (in miles) from the specified location to display on the map."

Default is none, and to use a zoom level that maps to the I property
of a photo.

=back

=cut

use FileHandle;
use File::Temp qw (tempfile);

=head1 PACKAGE METHODS

=cut

=head2 __PACKAGE__->new($cfg)

Returns a I object.

=cut

# Defined in Net::Flickr::API

=head1 OBJECT METHODS

=cut

=head2 $obj->mk_pinwin_map_for_photo($photo_id)

Fetch a map using the Yahoo! Map Image API for a geotagged Flickr photo
and place a "pinwin" style thumbnail of the photo over the map's marker.

Returns an array of arrays  (kind of pointless really, but at least consistent).

The first element of the (second-level) array will be the path to the newly created map
image. If uploads are enabled the newly created Flickr photo ID will be
passed as the second element.

=cut

# Defined in Net::Flickr::Geo

=head2 $obj->mk_pinwin_maps_for_photoset($photoset_id)

For each geotagged photo in a set, fetch a map using the Yahoo! Map
Image API for a geotagged Flickr photo and place a "pinwin" style
thumbnail of the photo over the map's marker.

If uploads are enabled then each map for a given photo will be
added such that it appears before the photo it references.

Returns an array of arrays.

The first element of each (second-level) array reference will be the path to the newly
created map image. If uploads are enabled the newly created Flickr photo
ID will be passed as the second element.

=cut

# Defined in Net::Flickr::Geo

sub fetch_map_image {
        my $self = shift;
        my $ph = shift;
        my $thumb_data = shift;

        my $lat = $self->get_geo_property($ph, "latitude");
        my $lon = $self->get_geo_property($ph, "longitude");
        my $acc = $self->get_geo_property($ph, "accuracy");

        if ((! $lat) || (! $lon)){
                return undef;
        }

        #

        my $appid = $self->divine_option("yahoo.appid");

        my $h = $self->divine_option("pinwin.map_height", 1024);
        my $w = $self->divine_option("pinwin.map_width", 1024);

        my $ua  = LWP::UserAgent->new();
        my $url = "http://local.yahooapis.com/MapsService/V1/mapImage?image_width=" . $w . "&image_height=" . $h . "&appid=" . $appid . "&latitude=" . $lat . "&longitude=" . $lon;

        if (my $r = $self->divine_option("yahoo.map_radius")){
                $url .= "&radius=$r";
        }

        else {
                my $z = $self->flickr_accuracy_to_zoom($acc);
                $z = $self->divine_option("pinwin.zoom", $z);
                $url .= "&zoom=$z";
        }

        $self->log()->info("fetch yahoo map : $url");

        my $req = HTTP::Request->new(GET => $url);
        my $res = $ua->request($req);

        if (! $res->is_success()){
                $self->log()->error("failed to retrieve yahoo map : " . $res->code());
                return 0;
        }

        my $xml = $self->_parse_results_xml($res);

        if (! $xml){
                $self->log()->error("failed to parse yahoo api response");
                return 0;
        }

        my $map = $xml->findvalue("/Result");
        my $path = $self->simple_get($map, $self->mk_tempfile(".png"));

        return {
                'url' => $map,
                'path' => $path,
               };
}

sub flickr_accuracy_to_zoom {
        my $self = shift;
        my $acc = shift;

        my %map = (1 => 12,
                   2 => 12,
                   3 => 12,
                   4 => 11,
                   5 => 10,
                   6 => 9,
                   7 => 8,
                   8 => 7,
                   9 => 6,
                   10 => 5,
                   12 => 4,
                   13 => 3,
                   14 => 2,
                   15 => 1,
                   16 => 1);

        return $map{$acc};
}

=head1 VERSION

0.72

=head1 DATE

$Date: 2008/08/03 17:08:40 $

=head1 AUTHOR

Aaron Straup Cope  [e-mail]

=head1 REQUIREMENTS

B
to have the pinwin marker successfully composited on to the map.>

The transparency is otherwise not honoured by either I or I. Please for your
patches or cluebats...

=head1 NOTES

All uploads to Flickr are marked with a content-type of "other".

=head1 SEE ALSO

L

L

=head1 BUGS

Sure, why not.

Please report all bugs via L

=head1 LICENSE

Copyright (c) 2007-2008 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.

=cut

return 1;