Memories/Photo.pm

   1 package Memories::Photo;
   2 use Apache2::Upload;
   3 use File::Basename;
   4 use File::Copy;
   5 use Archive::Any;
   6 use File::Temp qw(tempdir tmpnam);
   7 use File::Path qw(rmtree);
   8 use File::Find;
   9 use File::MMagic;
  10 use Image::Size qw(imgsize);
  11 use strict;
  12 use Carp qw(cluck confess);
  13 use base qw(Memories::DBI Maypole::Model::CDBI::Plain);
  14 use constant INTERESTINGNESS_ALGORITHM => '((rating+3)/(rated+1))*(1+rated/hit_count)*(1+hit_count/(select max(hit_count) from photo))';
  15 use Time::Piece;
  16 use Image::Seek;
  17 use constant PAGER_SYNTAX => "LimitXY";
  18 __PACKAGE__->columns(Essential => qw(id title uploader uploaded x y rating rated hit_count format));
  19 __PACKAGE__->untaint_columns(printable => [qw/title/]);
  20 __PACKAGE__->columns(TEMP => qw/exif_object/);
  21
  22 BEGIN {
  23 my %order_by = (
  24      recent => "uploaded",
  25      popular => "hit_count",
  26      loved => "rating/(1+rated)",
  27      interesting => INTERESTINGNESS_ALGORITHM,
  28      random => "rand()"
  29 );
  30
  31 while (my($label, $how) = each %order_by) {
  32     __PACKAGE__->set_sql($label => qq{
  33     SELECT __ESSENTIAL__
  34     FROM __TABLE__
  35     ORDER BY $how DESC
  36     LIMIT 4
  37     });
  38     no strict;
  39     *$label = sub {
  40         my ($self, $r) = @_;
  41         $self->view_paged_ordered($r, "$how desc");
  42     };
  43     __PACKAGE__->MODIFY_CODE_ATTRIBUTES(*{$label}{CODE}, "Exported"); # Hack
  44 }
  45 }
  46 __PACKAGE__->has_many(comments => "Memories::Comment");
  47 __PACKAGE__->has_a(uploader => "Memories::User");
  48 __PACKAGE__->has_a(uploaded => "Time::Piece",
  49     inflate => sub { Time::Piece->strptime(shift, "%Y-%m-%d %H:%M:%S") },
  50     deflate => 'datetime',
  51 );
  52
  53 sub do_upload :Exported {
  54     my ($self, $r) = @_;
  55     my $upload = $r->{ar}->upload("photo");
  56     # Check $self->type
  57     my @photos = ($self->upload_file($r, $upload->tempname, $upload->filename));
  58     my @quarantined = grep { !$_->tags } @photos;
  59     # Set it up to go again
  60     if (@quarantined) {
  61         $r->{session}{quarantined} = join ",", sort map { $_->id} @quarantined;
  62         $r->objects(\@quarantined);
  63         $r->template("quarantine");
  64         return;
  65     }
  66     $r->objects(\@photos);
  67     if (@photos == 0) { $r->template("upload"); return  }
  68     if (@photos > 1) { $r->template("list") }
  69     else { $r->template("view"); }
  70     $r->message("Thanks for the upload!");
  71 }
  72
  73 sub quarantine :Exported {
  74     my ($self, $r) = @_;
  75     my @quarantined = split /,/, $r->{session}{quarantined};
  76     my %q = map { $_ => 1 } @quarantined;
  77     for (map /(\d+)/,grep /tags\d+/, keys %{$r->{params}}) {
  78         my $tags = $r->{params}{"tags$_"};
  79         next unless $tags;
  80         if (my $photo = $self->retrieve($_)) {
  81             $photo->add_tags($tags);
  82             delete $q{$_};
  83         }
  84     }
  85     $r->{session}{quarantined} = join ",", sort keys %q;
  86     if (!$r->{session}{quarantined}) {
  87         $r->template("list");
  88         $r->objects([ map { $self->retrieve($_) } @quarantined ]);
  89     } else {
  90         $r->objects([ map { $self->retrieve($_) } sort keys %q ]);
  91     }
  92 }
  93
  94 sub upload_file {
  95     my ($self, $r, $filename, $offered_name) = @_;
  96     my $mm = File::MMagic->new;
  97     my $res = $mm->checktype_filename($filename);
  98     if ($res =~ m{/x-zip} or $offered_name =~ /t(ar\.)?gz$/i) {
  99         return $self->upload_archive($r, $filename);
 100     } elsif ($offered_name =~ /\.(raw|nef|dng|cr2)/i) {
 101         return $self->upload_raw($r, $filename, $offered_name);
 102     } elsif ($res =~ m{image/jpeg}) {
 103         return $self->upload_jpeg($r, $filename, $offered_name);
 104     } else {
 105         $r->message(basename($offered_name).": I can't handle $res files yet");
 106         return ();
 107     }
 108 }
 109
 110 sub upload_archive {
 111     my ($self, $r, $filename, $tags) = @_;
 112     $r->{params}{title} = ""; # Kill that dead.
 113     my $archive = Archive::Any->new($filename);
 114     my $dir = tempdir();
 115     $archive->extract($dir);
 116     my @results;
 117     find({ wanted   => sub { return unless -f $_;
 118                              push @results, $self->upload_file($r, $_, $_) },
 119            no_chdir => 1}, $dir);
 120     rmtree($dir);
 121     return @results;
 122 }
 123
 124 sub upload_raw {
 125     my ($self, $r, $filename, $offered_name) = @_;
 126     my $jpg = tmpnam().".jpg";
 127     system("dcraw -c $filename | convert - $jpg");
 128     $filename =~ /\.(.*)$/;
 129     my $format = $1;
 130     # Put the file in place
 131     $photo->format($format);
 132     copy($filename,
 133          Memories->config->{data_store}."/".$photo->id.".".$format);
 134     my $photo = $self->upload_jpeg($r, $jpg, $offered_name);
 135     return $photo;
 136 }
 137
 138 sub upload_jpeg {
 139     my ($self, $r, $filename, $offered_name) = @_;
 140     my $photo = $self->create({
 141         uploader => $r->user,
 142         uploaded => Time::Piece->new(),
 143         title => ($r->{params}{title} || basename($offered_name)),
 144         hit_count => 0,
 145         rating => 0,
 146         rated => 0,
 147     });
 148     if (!copy($filename, $photo->path("file"))) {
 149         warn "Couldn't copy photo to ".$photo->path("file").": $!";
 150         $photo->delete(); die;
 151     }
 152     my ($x, $y, undef) = imgsize($photo->path);
 153     $photo->x($x); $photo->y($y);
 154
 155     # Rotate?
 156     $photo->unrotate();
 157     if (!$photo->title){
 158         $photo->title($photo->title_exif || basename($filename));
 159     }
 160
 161     $photo->make_thumb;
 162     my $tags = $r->{params}{tags}.join " ", map { qq{"$_"} } $photo->tags_exif;
 163     $photo->add_tags($tags);
 164     $photo->add_to_imageseek_library;
 165     Memories->zap_cache();
 166     # Add system tags here
 167     my $tag = "date:".$photo->shot->ymd;
 168     $photo->add_to_system_tags({tag => Memories::SystemTag->find_or_create({name =>$tag}) });
 169     return $photo;
 170 }
 171
 172 sub approx_rating {
 173     my $self = shift;
 174     $self->rated or return 0;
 175     int($self->rating/$self->rated*10)/10;
 176 }
 177
 178 sub add_rating :Exported {
 179     my ($self, $r) = @_;
 180     my $photo = $r->{objects}[0];
 181     my $delta = $r->{params}{rating};
 182     if ($delta < 0 or $delta > 5) { return; } # Scammer
 183     # XXX Race
 184     $photo->rating($photo->rating() + $delta);
 185     $photo->rated($photo->rated() + 1);
 186     $r->output(""); # Only used by ajax
 187 }
 188
 189 sub view :Exported {
 190     my ($self, $r) = @_;
 191     my $photo = $r->{objects}[0];
 192     $photo->hit_count($photo->hit_count()+1);
 193     if ($r->{session}{last_search}) {
 194         # This is slightly inefficient
 195         my @search = split/,/, $r->{session}{last_search};
 196         my $found = -1;
 197         for my $i (0..$#search) {
 198             next unless $photo->id == $search[$i];
 199             $found = $i;
 200         }
 201         return unless $found > -1;
 202         $r->{template_args}{next} = $self->retrieve($search[$found+1])
 203             if $found+1 <= $#search;
 204         $r->{template_args}{prev} = $self->retrieve($search[$found-1])
 205             if $found-1 >= 0;
 206     }
 207 }
 208 sub upload :Exported {}
 209 sub exif :Exported {}
 210 sub comment :Exported {}
 211 sub tagedit :Exported {}
 212 sub similar :Exported {}
 213 sub sized :Exported {}
 214
 215 use Class::DBI::Plugin::Pager;
 216 use Class::DBI::Plugin::AbstractCount;
 217
 218 sub view_paged_ordered {
 219     my ($self, $r, $how) = @_;
 220     my $page = $r->params->{page} || 1;
 221     my $pager = $self->pager(
 222         per_page => Memories->config->{photos_per_page},
 223         page => $page,
 224         syntax => PAGER_SYNTAX,
 225         order_by => $how
 226     );
 227     $r->objects([$pager->retrieve_all ]);
 228     $r->{template_args}{pager} = $pager;
 229     $r->last_search;
 230     $r->template("paged"); # Set the what using the action name
 231 }
 232
 233 sub add_comment :Exported {
 234     my ($self, $r, $photo) = @_;
 235     $r->template("view");
 236     $r->objects->[0]->add_to_comments({
 237         name => $r->params->{name},
 238         content => $r->params->{content}
 239     });
 240 }
 241
 242 use Cache::MemoryCache;
 243 use Image::ExifTool;
 244 my $cache = new Cache::MemoryCache( { 'namespace' => 'MemoriesInfo' });
 245
 246 sub add_to_imageseek_library {
 247     my $self = shift;
 248     Image::Seek::cleardb();
 249     my $img = Image::Imlib2->load($self->path("file"));
 250
 251     Image::Seek::add_image($img, $self->id);
 252     # Merge this new one into the main database; there is a bit of a
 253     # race condition here. XXX
 254     Image::Seek::loaddb(Memories->config->{image_seek});
 255     Image::Seek::savedb(Memories->config->{image_seek});
 256 }
 257
 258 sub recommended_tags {
 259     my $self = shift;
 260     my %tags = map { $_->name => $_ }
 261                map { $_->tags }
 262                $self->find_similar(3);
 263     values %tags;
 264 }
 265
 266 sub find_similar {
 267     my ($self, $count) = @_;
 268     Image::Seek::cleardb();
 269     Image::Seek::loaddb(Memories->config->{image_seek});
 270     my @res = map {$_->[0] } Image::Seek::query_id($self->id, $count);
 271     shift @res; # $self
 272     map { $self->retrieve($_) } @res;
 273 }
 274
 275 sub unrotate {
 276     my $self = shift;
 277     my $orient = $self->exif_info->{EXIF}->{Orientation};
 278     return if $orient !~/Rotate (\d+)/i;
 279     my $steps = $1/90;
 280     my $img = Image::Imlib2->load($self->path("file"));
 281     $img->image_orientate($steps);
 282     $img->save($self->path("file"));
 283 }
 284
 285 sub exif_info {
 286     my $self = shift;
 287     my $info = $self->exif_object;
 288     return $info if $info;
 289     # Get it from the Cache
 290     if (!($info = $cache->get($self->id))) {
 291         # Create it
 292         $info = $self->_exif_info;
 293         $cache->set($self->id, $info);
 294     }
 295     $self->exif_object($info);
 296     $info;
 297 }
 298
 299 my %banned_tags = map { $_ => 1 }
 300     qw( CodedCharacterSet ApplicationRecordVersion );
 301
 302 sub _exif_info {
 303     my $exifTool = new Image::ExifTool;
 304     $exifTool->Options(Group0 => ['IPTC', 'EXIF', 'XMP', 'MakerNotes', 'Composite']);
 305     my $info = $exifTool->ImageInfo(shift->path(0,0,1));
 306     my $hash = {};
 307     foreach my $tag ($exifTool->GetFoundTags('Group0')) {
 308         next if $banned_tags{$tag};
 309          my $group = $exifTool->GetGroup($tag);
 310          my $val = $info->{$tag};
 311          next if ref $val eq 'SCALAR';
 312          next if $val =~ /^[0\s]*$/ or $val =~ /^nil$/;
 313          $hash->{$group}->{$exifTool->GetDescription($tag)} = $val;
 314     }
 315     return $hash;
 316 }
 317
 318 # XXX Cache this
 319 sub dimensions { join "x", $_[0]->x, $_[0]->y }
 320
 321 sub is_bigger {
 322     my ($self, $size) = @_;
 323     return 1 if $size eq "full";
 324     my ($w, $h) = ($self->x, $self->y);
 325     my ($w2, $h2) = split /x/, $size;
 326     return 1 if $w > $w2 or $h > $h2;
 327     return 0;
 328 }
 329
 330 sub sized_url { # Use this rather than ->path from TT
 331     my ($self, $size) = @_;
 332     my $url = Memories->config->{data_store_external};
 333     my $resized = Memories->config->{sizes}->[$size];
 334     if (!$resized) { cluck "Asked for crazy size $size"; return; }
 335     if ($resized eq "full") { return $self->path("url") }
 336     $self->scale($resized)
 337         unless -e $self->path( file => $resized );
 338     return $self->path(url => $resized);
 339 }
 340
 341 sub path {
 342     my ($self, $is_url, $scale, $raw) = @_;
 343     my $path =
 344         Memories->config->{$is_url eq "url" ? "data_store_external" : "data_store" };
 345     if ($scale) { $path .= "$scale/" }
 346     # Make dir if it doesn't exist, save trouble later
 347     use File::Path;
 348     if ($is_url ne "url" and ! -d $path) {mkpath($path) or die "Couldn't make path $path: $!";}
 349     if ($scale or ($is_url ne "url" and !$raw)) {
 350         $path .= $self->id.".jpg";
 351     } else {
 352         $path .= $self->id.".".($self->format||"jpg");
 353     }
 354     return $path;
 355 }
 356
 357 sub thumb_url { shift->path(url => Memories->config->{thumb_size}); }
 358 sub make_thumb { shift->scale(Memories->config->{thumb_size}, 1); }
 359
 360 use Image::Imlib2;
 361 sub scale {
 362     my ($self, $scale, $swap) = @_;
 363     my ($x, $y) = split /x/, $scale;
 364     # Find out smaller axis
 365     my ($cur_x, $cur_y) = ($self->x, $self->y);
 366     if (!$swap) {
 367         if ($cur_x < $cur_y) { $y = 0 } else { $x = 0 }
 368     } else {
 369         if ($cur_x > $cur_y) { $y = 0 } else { $x = 0 }
 370     }
 371     my $img = Image::Imlib2->load($self->path("file"));
 372     unless ($img) {
 373         cluck "Couldn't open image file ".$self->path("file");
 374         return;
 375     }
 376     $img = $img->create_scaled_image($x, $y);
 377     $img->image_set_format("jpeg");
 378     my $file = $self->path( file => $scale );
 379     $img->save($file);
 380     if ($!) {
 381         cluck "Couldn't write image file $file ($!)";
 382         return;
 383     }
 384 }
 385
 386 sub edit_tags :Exported {
 387     my ($self, $r) = @_;
 388     my $photo = $r->objects->[0];
 389     my %params = %{$r->params};
 390     my $exifTool = new Image::ExifTool;
 391     for (keys %params) {
 392         next unless /delete_(\d+)/;
 393         my $tagging = Memories::Tagging->retrieve($1) or next;
 394         next unless $tagging->photo->id == $photo->id;
 395         $exifTool->SetNewValue(Keywords => $1, DelValue => 1);
 396         $tagging->delete;
 397     }
 398     $exifTool->WriteInfo($photo->path);
 399     $photo->add_tags($params{newtags});
 400     $r->template("view");
 401 }
 402
 403 sub add_tags {
 404     my ($photo, $tagstring) = @_;
 405     my $exifTool = new Image::ExifTool;
 406
 407     for my $tag (Tagtools->separate_tags($tagstring)) {
 408         $photo->add_to_tags({tag => Memories::Tag->find_or_create({name =>$tag}) });
 409         $exifTool->SetNewValue(Keywords => $tag, AddValue => 1);
 410     }
 411     $exifTool->WriteInfo($photo->path);
 412 }
 413
 414 # Work out some common properties from a set of potential photo metadata
 415 # tags
 416 sub _grovel_metadata {
 417     my ($self, @tags) = @_;
 418     my %md = map {%$_} values %{$self->exif_info};
 419     for (@tags) {
 420         if ($md{$_} and $md{$_} =~/[^ 0:]/) { return $md{$_} }
 421     }
 422     return;
 423 }
 424
 425 sub shot {
 426     my $self = shift;
 427     my $dt = $self->_grovel_metadata(
 428         'Shooting Date/Time',
 429         'Date/Time Of Digitization',
 430         'Date/Time Of Last Modification'
 431     );
 432     if (!$dt) { return $self->uploaded }
 433     return Time::Piece->strptime($dt, "%Y:%m:%d %T") || $self->uploaded;
 434 }
 435
 436 sub description {
 437     shift->_grovel_metadata(
 438         'Description', 'Image Description', 'Caption-Abstract'
 439     );
 440 }
 441
 442 sub title_exif { shift->_grovel_metadata( 'Headline', 'Title'); }
 443 sub license { shift->_grovel_metadata( 'Rights Usage Terms', 'Usage Terms' ) }
 444 sub copyright { shift->_grovel_metadata( 'Rights', 'Copyright', 'Copyright Notice') }
 445
 446 # This one's slightly different since we want everything we can get...
 447 sub tags_exif {
 448     my $self = shift;
 449     my %md = map {%$_} values %{$self->exif_info};
 450     my %tags =
 451         map { s/\s+/-/g; lc $_ => 1  }
 452         map { split /\s*,\s*/, $md{$_}}
 453         grep {$md{$_} and $md{$_} =~/[^ 0:]/}
 454         (qw(Keywords Subject City State Location Country Province-State),
 455         'Intellectual Genre',
 456         'Country-Primary Location Name'
 457         );
 458     return keys %tags;
 459 }
 460 1;