#!/usr/bin/perl

# testboxfolder


# rewriting this so it gets the info from one EAD at a time,
# then hunts for the content in the web directory.
# also to use the following rules for matching boxes and folders:
#	If I remove the SC and leading zeros (and spaces) from box numbers both in the item metadata and in that collection's EAD, the box numbers should match.
#	If I remove anything before a hyphen or a period, and remove leading zeros from box numbers both in the item metadata and in that collection's EAD, the box numbers should match.
#	If I run across "frame" treat it as a box number.
#	If I run across "volume" treat it as box unless there is a box, then treat it as a folder.
#	If I run across  a box with no folder, or an empty folder, assume it is folder 1;  if then I find I have content for multiple folders for that collection, stop and make a note that that EAD requires alteration (or a different script that creates folders).

# pulls out box and folder information if existing
# writes to NOTINEAD and FOUND as well as outputs total count found and not found
# THIS DOES NOT TAKE CARE OF IMAGE OR AUDIO COLLECTIONS FROM MANUSCRIPT COLLECTIONS

# jody DeRidder, 2/15/10

# updated 3/24/10 to use allOnePlace list of collections where all content is in single box/folder in finding aid, so no match is needed

## Copyright (c) 2010, The University of Alabama Libraries. 
## Contributed by Jody DeRidder, 7/30/10.
## All rights reserved.

## Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

##    * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
##    * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in 
##       the documentation and/or other materials provided with the distribution.
##    * Neither the name of The University of Alabama Libraries nor the names of its contributors may be used to endorse or promote products 
##       derived from this software without specific prior written permission.

##THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, 
##THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR 
##CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, 
##PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF 
##LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
##EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

$allOnePlace = "./allOnePlace";
$eadbase = "/srv/deposits/EADs/online/";

$base = "/srv/www/htdocs/content/";

open(ONE, $allOnePlace) or die "can't read $allOnePlace\n";
while ($line = <ONE>){
  chomp $line;
  if ($line =~ /^[a-z]{1}\d{4}.*/){push (@allone, $line);}
  }
close (ONE);


$sums = ">./sums";
open(SUMS, $sums) or die "can't write to $sums\n";

$eadBoxFolders = ">EADboxFolders\n";
open(EADBF, $eadBoxFolders) or die "can't write to $eadBoxFolders\n";

$notInEADlist = ">./notInEAD";
open (NOTINEAD, $notInEADlist) or die "can't write to $notInEADlist\n";

$out = ">./found";
open (FOUND, $out) or die "can't write to $out\n";

opendir(EADS, $eadbase) or die "can't look through $eadbase\n";
while ($file = readdir(EADS)){
   if ($file =~ /^(u0003\_\d{7})\.ead\.xml/){
     $collnum = $1;
     if ($collnum eq "u0003_0000252"){ next; }  # we're already doing Cabaniss
     undef $found;
     foreach $all (@allone){
       if ($all eq $collnum){ $found = 1;}
       }
     if ($found){ next;}
     $path = $eadbase.$file;
     #print "looking at $file\n";
     undef $foundsome;
     undef $eadLine;
     open(EAD, $path) or die "can't read $file\n";
           while ($line = <EAD>){
             if ($line =~ /<did>/  || $line =~ /<\/?container/){   
                chomp $line;
                $eadLine .= $line;
                }
             }
     close(EAD);
     undef @containers;
     undef @boxfolders;
     undef @eadMatch;
     undef @myerrors;
     @containers = split("<did>", $eadLine);
     foreach $con (@containers){
              undef $b;
              undef $f;
              if ($con =~ /<container [^>]*type="Box"[^>]*> *([^<]*?) *</i){ $b = $1;} 
              if ($con =~ /<container [^>]*type="Folder"[^>]*> *([^<]*?) *</i){ $f = $1;}
              elsif ($con =~ /<container [^>]*type="Frame"[^>]*> *([^<]*?) *</i){ $f = $1;}
              if ($con =~ /<container [^>]*type="Volume"[^>]*> *([^<]*?) *</i){
                 if (!$b){ $b = $1;}
                 else{$f = $1;}
                 }
              if (!$b && !$f){ next;}
              
              $orig = $b."_".$f;   # save so I can locate it in the finding aid

      #        print "$orig  becomes  ";
   # clean these up for matching
              $b =~ s, ,,g;  # remove spaces
              $b =~ s,^.*?\.,,;  # remove anything prior to a period, and the period
              $b =~ s,\..*,,;  # remove anything after a period, and the period
              $b =~ s,^.*?\-,,;  # remove anything prior to a hyphen, and the hyphen
              $b =~ s,^0*,,;  # remove leading zeros
              $f =~ s, ,,g;  # remove spaces
              $f =~ s,^.*?\.,,;  # remove anything prior to a period, and the period
              $f =~ s,\..*,,;  # remove anything after a period, and the period
              $f =~ s,^.*?\-,,;  # remove anything prior to a hyphen, and the hyphen
              $f =~ s,^0*,,;  # remove leading zeros

              $thisn = $b."_".$f;
      #        print $b."_".$f."\n";
              undef $found;
              undef @replace;
              foreach $bf (@boxfolders){
                  if ($thisn eq $bf){ $found = 1;}
                  else{push (@replace, $bf);}
                  }
              if ($found){
                  push (@myerrors, "More than one entry in EAD for $thisn.  Unable to match\n");
                  @boxfolders = @replace;
                  if ($b && !$f){  # remove the false one value also
                    undef @replace;
                    undef $found;
                    $thisn = $b."_1";
                    foreach $bf (@boxfolders){
                      if ($thisn eq $bf){ $found = 1;}
                      else{push (@replace, $bf);}
                      }
                    if ($found){@boxfolders = @replace;}
                    }  
                  next;
                  } 

              push (@boxfolders, $b."_".$f);
              $eadMatch{$b."_".$f} = $orig;     # so I can get back to what it is in the finding aid

# when there's NO folder, it MIGHT also be folder 1
              if ($b && !$f){
                $f = 1;
                push (@boxfolders, $b."_".$f);
                $eadMatch{$b."_".$f} = $orig;
                }
              }
   
       

     # now, let's find the MODS files.
     undef @mymods;
     ($collpath = $collnum) =~ s,\_,\/,;
     $collpath = $base.$collpath."/"; 
     $topmods = $collpath."Metadata/".$collnum.".mods.xml";

     # this gets those one-item collections where the item unfortunately has the same ID as the collection
     if (-e $topmods){ push (@mymods, $topmods);}

     else{    # if no collection-level MODS, look for item-level MODS
      
       opendir(COLL, $collpath) or die "can't look through $collpath\n";
       while ($file = readdir(COLL)){
         undef $midmods;
         if ($file =~ /^(\d{7})$/){
           $itempath = $collpath.$file."/";
           $midmods = $itempath."Metadata/".$collnum."_".$file.".mods.xml";
           if (-e $midmods){ push (@mymods, $midmods);}

           else{    # if no item-level MODS look for page-level MODS
             opendir(ITEM, $itempath) or die "can't look through $itempath\n"; 
             while ($page = readdir(ITEM)){
               if ($page =~ /^(\d{4})$/){
                 $pagepath = $itempath.$page."/";
                 $lowmods = $pagepath."Metadata/".$collnum."_".$file."_".$page.".mods.xml";
                 if (-e $lowmods){ push (@mymods, $lowmods);}
                 }
               }
             close(ITEM);
             }
           }
         }
      close(COLL);
      }

    # now I have all the MODS for this collection in @mymods and I have 
    # all the cleaned-up EAD box and folder values in @boxfolders (underscore separated)
    # and I have the original EAD box and folder values in %eadMatch, keyed on the cleaned-up versions.
    # so... time to go through the MODS and see if I can match box and folders to these, to determine
    # where in the EAD the links need to go.

    undef $myhits;
    undef $mymisses;

    foreach $mods (@mymods){
       open(MODS, $mods) or die "can't open $mods\n";
       undef $bigline;
       undef $boxnum;
       undef $foldernum;
       undef $matchme;
       while ($line = <MODS>){
         chomp $line;
         $bigline .= $line;
         }
       close(MODS);
       if ($bigline =~ /<physicalLocation type=\"Box Number\">([^<]*?)</){ $boxnum = $1;}
       if ($bigline =~ /<physicalLocation type=\"Folder Number\"> *([^<]*?) *</){ $foldernum = $1;}

   # clean these up the same way I did the EAD entries
       $orig = $boxnum."_".$foldernum;
       if (! $boxnum && ! $foldernum){
          print NOTINEAD "$collnum  $matchme  $mods\n";
          $lostCount += 1;
          next;
          }

      # print "for $mods\n    $orig  becomes "; 
       $boxnum =~ s, ,,g;  # remove spaces
       $boxnum =~ s,^.*?\.,,;  # remove anything prior to a period, and the period
       $boxnum =~ s,\..*,,;  # remove anything after a period, and the period
       $boxnum =~ s,^.*?\-,,;  # remove anything prior to a hyphen, and the hyphen
       $boxnum =~ s,^0*,,;  # remove leading zeros
       
       $foldernum =~ s, ,,g;  # remove spaces
       $foldernum =~ s,^.*?\.,,;  # remove anything prior to a period, and the period
       $foldernum =~ s,\..*,,;  # remove anything after a period, and the period
       $foldernum =~ s,^.*?\-,,;  # remove anything prior to a hyphen, and the hyphen
       $foldernum =~ s,^0*,,;  # remove leading zeros
        
     
       undef $myloc;
       $matchme = $boxnum."_".$foldernum;

     #  print "$matchme\n";
       foreach $bf (@boxfolders){
         if ($bf eq $matchme){
           $myloc = $eadMatch{$bf};
           print FOUND "$collnum  $myloc  $mods\n";
           $foundCount += 1;
           $foundsome = 1;
           $myhits += 1;
           last;
           }
         }
       if (!$myloc){ 
          print NOTINEAD "$collnum  $matchme  $mods\n";
          $lostCount += 1;
          $mymisses += 1;
          }
       } 
    if (!$foundsome){
       print EADBF "\n\n  **  $collnum  **\n";
       foreach (@myerrors){ print EADBF "   $_";}
      # foreach $bf (@boxfolders){
          #print  EADBF "   $bf    ".$eadMatch{$bf}."\n";}
       }
    elsif (@myerrors){
       print EADBF "\n\n  **  $collnum  **\n";
       foreach (@myerrors){ print EADBF "   $_";}
       push (@multiples, $collnum);
       }
    if (!$myhits && !$mymisses){ push (@nokids, $collnum); next;}
    elsif (!$myhits){ $myhits = 0;}
    elsif (!$mymisses){ $mymisses = 0;}
    print SUMS $collnum."  Found:$myhits  Lost:$mymisses\n";
    }
  }

$bad = scalar (@multiples);

print SUMS "\n\nFound $foundCount files I can link in \n";
print SUMS  "Unable to link in $lostCount files\n";
print SUMS  "$bad finding aids have multiple entries of the same box and folder duo\n";
foreach (@multiples){ print SUMS "   $_\n";}
print SUMS  "\n\n\nThe following EADs have no kids\n";
foreach (@nokids){ print SUMS "   $_\n";}

close(FOUND);
close(NOTINEAD);       
close (EADBF);
close(SUMS);