Flickr-Upload
view release on metacpan or search on metacpan
flickr_upload view on Meta::CPAN
my $frob = getFrob( $ua );
# 2. get a url for the frob
my $url = $ua->request_auth_url('write', $frob);
# 3. tell the user what to do with it
print "1. Enter the following URL into your browser\n\n",
"$url\n\n",
"2. Follow the instructions on the web page\n",
"3. Hit <Enter> when finished.\n\n";
# 4. wait for enter.
<STDIN>;
# 5. Get the token from the frob
my $auth_token = getToken( $ua, $frob );
die "Failed to get authentication token!" unless defined $auth_token;
# 6. Tell the user what they won.
print "Your authentication token for this application is\n\t\t",
$auth_token, "\n";
exit 0;
}
if($oauth) {
# See Flickr::API SYNOPSIS on OAuth authentication, upon which this is heavily based
$ua = Flickr::Upload->new({
consumer_key => $api_key,
consumer_secret => $not_so_secret
});
my $response = $ua->oauth_request_token({ 'callback' => 'https://127.0.0.1/' });
my %request_token;
if($response eq 'ok') {
my $uri = $ua->oauth_authorize_uri({ 'perms' => 'write' });
print "Please open this URL in your browser and follow the instructions:\n\n";
print "$uri\n\n";
print "When you authorize this app, you'll be directed to a dummy URL\n";
print "that contains a confirmation code. Paste that URL here.\n\n";
print "URL: ";
my $input = <STDIN>;
chomp $input;
my ($callback_returned, $token_received) = split /\?/, $input;
my @params = split /\&/, $token_received;
foreach my $pair (@params) {
my ($key,$val) = split(/=/,$pair);
$key =~ s/oauth_//;
$request_token{$key}=$val;
}
die "Bad OAuth token received! verifier => '$request_token{verifier}', token => '$request_token{token}'\n"
unless $request_token{verifier} =~ /^[0-9a-f]+$/ && $request_token{verifier} =~ /^[0-9a-f-]+$/;
}
else {
die "Unable to initiate OAuth authorization. Response from Flickr was: '$response'\n";
}
my $ac_rc = $ua->oauth_access_token(\%request_token);
if($ac_rc eq 'ok') {
print "Saving OAuth credentials to $oauth_config\n";
$ua->export_storable_config($oauth_config);
}
}
if(!exists $args{'auth_token'} && -r $oauth_config) {
$ua = Flickr::Upload->import_storable_config($oauth_config);
bless $ua, 'Flickr::Upload';
}
die "No auth token or OAuth credentials found.\nUse --auth or --oauth to generate credentials or --auth_token to specify a token.\n"
unless exists $args{'auth_token'} || $ua->is_oauth;
if( $check ) {
exit( checkToken( $ua, $args{api_key}, $args{auth_token} ) );
}
die "No image specified to upload.\n" unless @ARGV;
$args{'tags'} = join( " ", @tags ) if @tags;
# pipeline things by uploading first, waiting for photo ids second.
$args{'async'} = 1;
my %tickets;
$| = 1;
my @argv = $reverse ? reverse @ARGV : @ARGV;
while( my $photo = shift @argv ) {
my $rc;
if ($progress) {
$HTTP::Request::Common::DYNAMIC_FILE_UPLOAD = 1;
my $photo_size = (stat($photo))[7];
my $req = $ua->make_upload_request( 'photo' => $photo, %args );
my $gen = $req->content();
die unless ref($gen) eq "CODE";
my $progress = Term::ProgressBar->new({
name => $photo,
count => $photo_size,
ETA => 'linear',
});
$progress->minor(0);
my $state;
my $size;
$req->content(
sub {
my $chunk = &$gen();
$size += Flickr::Upload::file_length_in_encoded_chunk(\$chunk, \$state, $photo_size);
$progress->update($size);
return $chunk;
}
);
$rc = $ua->upload_request( $req );
} else {
print 'Uploading ', $photo, '...';
$rc = $ua->upload( 'photo' => $photo, %args );
}
# let the caller know how many images weren't uploaded
exit (1+@ARGV) unless defined $rc;
# check those later
$tickets{$rc} = $photo;
flickr_upload view on Meta::CPAN
return $res->{tree}->{children}->[1]->{children}->[1]->{children}->[0]->{content};
}
sub checkToken {
my $ua = shift;
my $key = shift;
my $token = shift;
my $res = $ua->execute_method("flickr.auth.checkToken",
{
'auth_token' => $token,
'api_key' => $key,
} );
# FIXME: this could be parsed, but I'm not going to get too fancy
print $res->decoded_content();
return 0;
}
__END__
=head1 NAME
flickr_upload - Upload photos to C<flickr.com>
=head1 SYNOPSIS
flickr_upload [--auth] --auth_token <auth_token> [--title <title>]
[--description description] [--public <0|1>] [--friend <0|1>]
[--family <0|1>] [--tag <tag>] [--option key=value] [--progress]
<photos...>
=head1 DESCRIPTION
Batch image uploader for the L<Flickr.com> service.
L<flickr_upload> may also be useful for generating authentication tokens
against other API keys/secrets (i.e. for embedding in scripts).
=head1 OPTIONS
=over 4
=item --auth
The C<--auth> flag will cause L<flickr_upload> to generate an
authentication token against it's API key and secret (or, if you want,
your own specific key and secret). This process requires the caller
to have a browser handy so they can cut and paste a url. The resulting
token should be kept somewhere like C<~/.flickrrc> since it's necessary
for actually uploading images.
=item --auth_token <auth_token>
Authentication token. You B<must> get an authentication token using
C<--auth> before you can upload images. See the L<EXAMPLES> section.
=item --oauth
Interactively perform OAuth authorization with Flickr. The user will get a URL to visit at Flickr at which Flickr::Upload must be granted write permissions. After granting permission, the user will be redirected to a dummy URL that contains an OAuth ...
=item --title <title>
Title to use on all the images. Optional.
=item --description <description>
Description to use on all the images. Optional.
=item --public <0|1>
Override the default C<is_public> access control. Optional.
=item --friend <0|1>
Override the default C<is_friend> access control. Optional.
=item --family <0|1>
Override the default C<is_family> access control. Optional.
=item --tag <tag>
Images are tagged with C<tag>. Multiple C<--tag> options can be given, or
you can just put them all into a single space-separated list. If you want
to define a tag with spaces, the quotes have to be part of the tag itself.
The following works in L<bash>:
flickr_upload --tag='"tag one"' --tag='"tag two"' image.jpg
=item --reverse
Reverse the list of supplied images. Useful when uploading contents of
directory with sorted filenames. Following example will upload the last
glob expanded file as first and vice versa. The last file will appear
first in target photo stream.
flickr_upload --reverse *.jpg
=item --set <NAME>
After successfully uploading all photos, create a new set named "NAME", and
add the photos into the set. One (random) photo will be the set's thumbnail.
=item --option key=value
Flickr periodically adds new features to the uploading API, and these are
almost always implemented as new key/value pairs. Rather than waiting for
a new L<Flickr::Upload> release, you can specify any of the upload
API's optional arguments using C<--option>.
flick_upload --option content_type=1 --tag='cats' two_cats.jpg
You may also use C<--option> rather than L<flickr_upload>'s command-line
options:
flickr_upload --option is_public=1 --option title='cats' two_cats.jpg
While Flickr may add new options at any time (see
L<https://www.flickr.com/services/api/upload.api.html> for the most up-to-date
list), currently known options include:
=over 4
=item --option safety_level=<1|2|3>
Override the default C<safety_level> notation.
Set to 1 for Safe, 2 for Moderate, or 3 for Restricted.
Refer to L<https://www.flickr.com/help/filters/>.
=item --option content_type=<1|2|3>
Override the default C<content_type> notation.
Set to 1 for Photo, 2 for Screenshot, or 3 for Art/Illustration.
Refer to L<https://www.flickr.com/help/filters/>.
=item --option hidden=<1|2>
Override the default C<hidden> notation.
Set to 1 to keep the photo in global search results, 2 to hide from public
earches.
=back
Note that options unknown to Flickr will result in undefined behaviour.
=item --check
Checks the authentication token via the flickr.auth.checkToken API call.
This can be used to verify API keys and credentials without trying to
upload an image. The output is the raw results of the API call.
=item --progress, --no-progress
Display a progress bar for each upload with L<Term::ProgressBar>. That
optional module will have to be installed on the system.
The default is not to display a progress bar. That can be changed in
the configuration file:
echo progress=1 >~/.flickrrc
=item --report, --no-report
Report the status of each upload ticket after uploading the batch via
L<Flickr::Upload's check_upload
method|Flickr::Upload/check_upload>. On by default. Checking the status can
be canceled by pressing ctrl-C.
The default is to display a report after each upload. That can be
changed in the configuration file:
echo report=0 >~/.flickrrc
=item --key <api_key>
=item --secret <secret>
Your own API key and secret. This is useful if you want to use
L<flickr_upload> in auth mode as a token generator. You need both C<key>
and C<secret>. Both C<key> and C<secret> can be placed in C<~/.flickrrc>,
allowing to mix L<flickr_upload> with your own scripts using the same
API key and authentication token. Getting your own API key and secret is
encouraged if you're tying L<flickr_upload> to some automated process.
Note that if you do get an authentication token against your own API key
and secret, you'll need to specify the key and secret along with the token
when uploading images. The default L<flickr_upload> API key and token won't
work in that case.
=item <photos...>
List of photos to upload. Uploading stops as soon as a failure is detected
during the upload. The script exit code will indicate the number of images
on the command line that were not uploaded. For each uploaded image, a
Flickr URL will be generated. L<flickr_upload> uses asynchronous uploading
so while the image is usually transferred fairly quickly, it might take
a while before it's actually available to users. L<flickr_upload> will
wait around for that to complete, but be aware that delays of upwards
of thirty minutes have (rarely) been know to occur.
=back
=head1 EXAMPLES
First, you need to get an authentication token. This is a requirement
driven by how Flickr manages third-party applications:
cpb@earth:~$ flickr_upload --auth
1. Enter the following URL into your browser
( run in 0.550 second using v1.01-cache-2.11-cpan-cdf2f3d4e48 )