Changeset 11915

Timestamp:

2006-06-09T14:12:49+12:00 (18 years ago)

Author:

mdewsnip

Message:

Much improved code for generating and maintaining the place image variants. Place images are no longer scaled larger, and it no longer rewrites all the .inf files every time the collection is imported!

File:

• trunk/cic-hcap/perllib/plugins/CICPlug.pm (modified) (7 diffs)

trunk/cic-hcap/perllib/plugins/CICPlug.pm

@@ -190 +190 @@
     my $dbh = DBI->connect('dbi:ODBC:CIC-HCAP');
 
-    # $self->process_institutions($dbh);
-    # $self->process_places($dbh);
+    $self->process_institutions($dbh);
+    $self->process_places($dbh);
     $self->process_designers($dbh);
 
@@ -289 +289 @@
         }
 
-        $self->new_place_image($institution_doc_obj, $institution_best_place_image_location, "medium");
-        $self->new_place_image($institution_doc_obj, $institution_best_place_image_location, "large");
+        $self->generate_place_image_variant($institution_doc_obj, $institution_best_place_image_location, "medium");
+        $self->generate_place_image_variant($institution_doc_obj, $institution_best_place_image_location, "large");
 
         my $institution_best_place_image_large_file_name = $institution_best_place_image_name . "-large.jpg";
@@ -329 +329 @@
         }
         else {
-        $self->new_place_image($institution_doc_obj, $institution_campus_plan_image_location, "large");
+        $self->generate_place_image_variant($institution_doc_obj, $institution_campus_plan_image_location, "large");
 
         my $institution_campus_plan_image_large_file_name = $institution_campus_plan_name . "-large.jpg";
@@ -590 +590 @@
     while (my $place_images_match_hashref = $place_images_sql_handle->fetchrow_hashref) {
         my $place_image_location = $place_images_match_hashref->{"Location"};
-        $self->new_place_image($place_doc_obj, $place_image_location, "small");
-        $self->new_place_image($place_doc_obj, $place_image_location, "large");
+        $self->generate_place_image_variant($place_doc_obj, $place_image_location, "small");
+        $self->generate_place_image_variant($place_doc_obj, $place_image_location, "large");
 
         my $place_image_name = $place_images_match_hashref->{"FileName"};
@@ -695 +695 @@
         if (defined($designer_place_image_match_hashref)) {
         my $designer_place_image_location = $designer_place_image_match_hashref->{"Location"};
-        $self->new_place_image($designer_doc_obj, $designer_place_image_location, "small");
+        $self->generate_place_image_variant($designer_doc_obj, $designer_place_image_location, "small");
 
         my $designer_place_image_name = $designer_place_image_match_hashref->{"FileName"};
@@ -771 +771 @@
 
 
-sub new_place_image
+sub get_place_image_dimensions
 {
     my $self = shift(@_);
-    my ($doc_obj, $place_image_location, $place_image_size) = (@_);
+    my $place_image_file_path = shift(@_);
     my $fail_log_handle = $self->{'failhandle'};
 
-    # Don't bother with empty values
-    return if ($place_image_location eq "");
-
-    # Convert the server location of the file into the local location of the file
-    my $place_image_file_path = $place_image_location;
-    $place_image_file_path =~ s/^[A-Z]:/$self->{'images_directory'}/;
-
-    # Create a new section for each image of the place
-    my $place_image_section = $doc_obj->insert_section($doc_obj->get_end_child($doc_obj->get_top_section()));
-    $doc_obj->add_utf8_text($place_image_section, "Some dummy text.");
-    $doc_obj->add_utf8_metadata($place_image_section, "Title", "1");
-
+    # Make sure the place image file actually exists
     if (!-f $place_image_file_path) {
     print STDERR "<ProcessingError n='$place_image_file_path' p='CICPlug' r='Does not exist'>\n" if ($self->{'gli'});
@@ -795 +784 @@
     return;
     }
-
-    my $place_image_file_name = $place_image_file_path;
-    $place_image_file_name =~ s/^.*?([^\\]+)$/$1/;
-    my ($image_file_root) = ($place_image_file_name =~ /^(.+)\./);
-
-    # Scale the original image to make the place image
-    my $image_width = $self->{$place_image_size . '_image_width'};
-    my $image_options = "-scale $image_width " . $self->{$place_image_size . '_image_options'};
-    my $image_file_name = $image_file_root . "-$place_image_size." . $self->{$place_image_size . '_image_type'};
-
-    my $original_image_file_path = $place_image_file_path;
-    my $image_type = $place_image_size;
-
-    my $original_image_file_date = (stat($original_image_file_path))[9];
-    my $image_file_path = &util::filename_cat($self->{'cache_directory'}, $image_file_name);
-    my $image_command = "convert -verbose $image_options \"$original_image_file_path\" \"$image_file_path\"";
-    my $image_height;
-
-    # Check if this image has already been generated by looking for a ".inf" file in the tmp directory
-    $image_file_name =~ /^(.*?)\.[^\.]+$/;
-    my $image_info_file_name = $1 . ".inf";
-    my $image_info_file_path = &util::filename_cat($self->{'cache_directory'}, $image_info_file_name);
-    if (-e $image_info_file_path) {
-    open(IMAGE_INFO_FILE, "<$image_info_file_path");
-    my @image_info = <IMAGE_INFO_FILE>;
-    close(IMAGE_INFO_FILE);
-
-    # Read the original image file date and image command from the file and check they match
-    my $old_original_image_file_date = $image_info[0];
-    $old_original_image_file_date =~ s/\n$//;
-    my $old_image_command = $image_info[1];
-    $old_image_command =~ s/\n$//;
-    if ($old_original_image_file_date eq $original_image_file_date && lc($old_image_command) eq lc($image_command)) {
-        # print STDERR "Already generated $image_file_name...\n";
-        $image_width = $image_info[2];
-        $image_width =~ s/\n$//;
-        $image_height = $image_info[3];
-        $image_height =~ s/\n$//;
-    }
-    }
-
-    # Generate the image if it doesn't already exist
-    if (!defined($image_width) || !defined($image_height)) {
-    print STDERR "Generating place image file: $image_file_name...\n";
-    my $outhandle = $self->{'outhandle'};
-    print $outhandle "$image_command\n" if ($self->{'verbosity'} > 2);
-    my $image_result = `$image_command` || "";
-    print $outhandle "RESULT = $image_result\n" if ($self->{'verbosity'} > 2);
-
-    # Check that the converted image exists
-    if (!-f $image_file_path) {
-        print STDERR "<ProcessingError n='$image_file_path' p='CICPlug' r='Could not be created'>\n" if ($self->{'gli'});
-        print STDERR "Error: Image $image_file_path could not be created.\n";
-        print $fail_log_handle "Error: Image $image_file_path could not be created.\n";
-        return;
-    }
-
-    # Get image dimensions
-    if ($image_command !~ /\-scale / && $image_result =~ m/([0-9]+)x([0-9]+)/) {
-        $image_width = $1;
-        $image_height = $2;
-    }
-    elsif ($image_result =~ m/[0-9]+x[0-9]+=>([0-9]+)x([0-9]+)/) {
-        $image_width = $1;
-        $image_height = $2;
-    }
-    elsif ($image_result =~ m/Image Width: (\d+) Image Length: (\d+)/) {
-        $image_width = $1;
-        $image_height = $2;
-    }
-        elsif ($image_result =~ m/JPEG (\d+)x(\d+)/) {
-        $image_width = $1;
-        $image_height = $2;
-        }
-    else {
-        print STDERR "Error: Could not parse image width and height for $original_image_file_path\n";
-        return;
-    }
-    }
-
-    # Associate the image file
-    $doc_obj->associate_file($image_file_path, $image_file_name, undef, $self->{'section'});
-
-    # Add various bits of metadata for the image
-    my $image_metadata_value = $image_file_name;
-    $image_metadata_value =~ s/ /%20/g;
-    $doc_obj->add_utf8_metadata($self->{'section'}, $image_type . "Image", $image_metadata_value);
-    $doc_obj->add_metadata($self->{'section'}, $image_type . "ImageWidth", $image_width);
-    $doc_obj->add_metadata($self->{'section'}, $image_type . "ImageHeight", $image_height);
-    $doc_obj->add_metadata($self->{'section'}, $image_type . "ImagePath", "_httpcollection_/index/assoc/[parent(Top):assocfilepath]/[${image_type}Image]");
-
-    # Write the image info file so we don't have to regenerate this exact image again in the future
-    open(IMAGE_INFO_FILE, ">$image_info_file_path");
-    print IMAGE_INFO_FILE "$original_image_file_date\n";
-    print IMAGE_INFO_FILE "$image_command\n";
-    print IMAGE_INFO_FILE "$image_width\n";
-    print IMAGE_INFO_FILE "$image_height\n";
-    close(IMAGE_INFO_FILE);
+    my $place_image_file_date = (stat($place_image_file_path))[9];
+
+    # Check if this place image has already been identified by looking for a ".info" file in the same directory
+    my $place_image_info_file_path = $place_image_file_path . ".info";
+    if (-f $place_image_info_file_path) {
+    # A ".info" file exists, so read the cached place image information from it
+    open(PLACE_IMAGE_INFO_FILE, "<$place_image_info_file_path");
+    my @place_image_info = <PLACE_IMAGE_INFO_FILE>;
+    close(PLACE_IMAGE_INFO_FILE);
+
+    # Read the cached place image file date and check that it matches
+    my $cached_place_image_file_date = $place_image_info[0];
+    $cached_place_image_file_date =~ s/\n$//;
+    if ($cached_place_image_file_date == $place_image_file_date) {
+        # It does match, so use the cached information from the ".info" file instead of re-identifying the file
+        my $place_image_width = $place_image_info[1];
+        $place_image_width =~ s/\n$//;
+        my $place_image_height = $place_image_info[2];
+        $place_image_height =~ s/\n$//;
+        return ($place_image_width, $place_image_height);
+    }
+    }
+
+    # We haven't already identified the place image, so do it now
+    print STDERR "Identifying place image $place_image_file_path...\n";
+    my $identify_command = "identify -format \"%w %h\" \"$place_image_file_path\"";
+    my $identify_result = `$identify_command`;
+    print "Identify result: $identify_result\n" if ($self->{'verbosity'} > 2);
+
+    # Check that the output is what we're expecting
+    if ($identify_result !~ /(\d+) (\d+)/) {
+    print STDERR "<ProcessingError n='$place_image_file_path' p='CICPlug' r='Could not identify'>\n" if ($self->{'gli'});
+    print STDERR "Error: Place image $place_image_file_path could not be identified.\n";
+    print $fail_log_handle "Error: Place image $place_image_file_path could not be identified.\n";
+    return;
+    }
+
+    # Parse the place image width and height from the output
+    my $place_image_width = $1;
+    my $place_image_height = $2;
+
+    # Write the place image info file so we don't have to identify this exact image again in the future
+    open(PLACE_IMAGE_INFO_FILE, ">$place_image_info_file_path");
+    print PLACE_IMAGE_INFO_FILE "$place_image_file_date\n";
+    print PLACE_IMAGE_INFO_FILE "$place_image_width\n";
+    print PLACE_IMAGE_INFO_FILE "$place_image_height\n";
+    close(PLACE_IMAGE_INFO_FILE);
+    return ($place_image_width, $place_image_height);
+}
+
+
+sub generate_place_image_variant
+{
+    my $self = shift(@_);
+    my ($doc_obj, $place_image_location, $place_image_variant_size) = (@_);
+    my $fail_log_handle = $self->{'failhandle'};
+
+    # Convert the server location of the file into the local location of the file
+    my $place_image_file_path = $place_image_location;
+    $place_image_file_path =~ s/^[A-Z]:/$self->{'images_directory'}/;
+
+    # Get the width and height of the place image
+    my ($place_image_width, $place_image_height) = $self->get_place_image_dimensions($place_image_file_path);
+    if (!defined($place_image_width) || !defined($place_image_height)) {
+    # An error has occurred (error message generated by get_place_image_dimensions())
+    return;
+    }
+    my $place_image_file_date = (stat($place_image_file_path))[9];
+
+    # Generate the path of the place image variant (in the cache directory)
+    my $place_image_variant_file_suffix = "-$place_image_variant_size." . $self->{$place_image_variant_size . '_image_type'};
+    my $place_image_variant_file_path = $place_image_location;
+    $place_image_variant_file_path =~ s/^[A-Z]:/$self->{'cache_directory'}/;
+    $place_image_variant_file_path =~ s/^(.+)(\..*)/$1$place_image_variant_file_suffix/;
+    my ($place_image_variant_file_name) = ($place_image_variant_file_path =~ /^.+\\(.+)$/);
+
+    # Only scale down the place image if it is bigger than the desired width
+    my $place_image_variant_desired_width = $self->{$place_image_variant_size . '_image_width'};
+    if ($place_image_width > $place_image_variant_desired_width) {
+    # Only generate the place image variant if it doesn't already exist, or if the place image is newer
+    if (!-f $place_image_variant_file_path || $place_image_file_date > (stat($place_image_variant_file_path))[9]) {
+        print STDERR "Generating place image variant $place_image_variant_file_path...\n";
+        my ($place_image_variant_directory) = ($place_image_variant_file_path =~ /^(.+)\\.+$/);
+        &util::mk_all_dir($place_image_variant_directory);
+        my $place_image_variant_options = "-scale $place_image_variant_desired_width " . $self->{$place_image_variant_size . '_image_options'};
+        my $convert_command = "convert $place_image_variant_options \"$place_image_file_path\" \"$place_image_variant_file_path\"";
+        my $convert_result = `$convert_command`;
+    }
+    }
+    else {
+    # The desired width is bigger than the place image, so we just use the original
+    $place_image_variant_file_path = $place_image_file_path;
+    }
+
+    my ($place_image_variant_width, $place_image_variant_height) = $self->get_place_image_dimensions($place_image_variant_file_path);
+    if (!defined($place_image_variant_width) || !defined($place_image_variant_height)) {
+    # An error has occurred (error message generated by get_place_image_dimensions())
+    return;
+    }
+
+    # Create a new section for each place image variant (!! TO DO: Check if this is really necessary)
+    my $place_image_variant_section = $doc_obj->insert_section($doc_obj->get_end_child($doc_obj->get_top_section()));
+    $doc_obj->add_utf8_text($place_image_variant_section, "Some dummy text.");
+    $doc_obj->add_utf8_metadata($place_image_variant_section, "Title", "1");
+
+    # Associate the place image variant file
+    $doc_obj->associate_file($place_image_variant_file_path, $place_image_variant_file_name, undef, $self->{'section'});
+
+    # Add various bits of metadata for the place image variant
+    my $place_image_variant_metadata_value = $place_image_variant_file_name;
+    $place_image_variant_metadata_value =~ s/ /%20/g;
+    $doc_obj->add_utf8_metadata($self->{'section'}, $place_image_variant_size . "Image", $place_image_variant_metadata_value);
+    $doc_obj->add_metadata($self->{'section'}, $place_image_variant_size . "ImageWidth", $place_image_variant_width);
+    $doc_obj->add_metadata($self->{'section'}, $place_image_variant_size . "ImageHeight", $place_image_variant_height);
+    $doc_obj->add_metadata($self->{'section'}, $place_image_variant_size . "ImagePath", "_httpcollection_/index/assoc/[parent(Top):assocfilepath]/[${place_image_variant_size}Image]");
 }