unicorn/unicorn_patrons_to_tsv.pl

   1 #!/usr/bin/perl -w
   2
   3 # Converts a Unicorn users.data file to a tab-separated file.
   4 # 2009-08-10 Ben Ostrowsky <ben@esilibrary.com>
   5
   6 my @records;
   7 my $serial = -1;
   8 my $line = 0;
   9 my $section = '';
  10 my $field = '';
  11 my %unique_fields;
  12 my @output_fields = qw(
  13 l_user_id l_user_altid l_user_pin l_user_profile l_user_status l_user_library l_user_priv_granted
  14 l_user_priv_expires l_user_mailingaddr l_birthdate l_prefix_name l_last_name l_first_name l_middle_name
  15 l_suffix_name l_note l_note1 l_patron l_comment l_staff l_webcatpref l_user_category1 l_user_category2
  16 l_user_category3 l_user_category4 l_dept l_guardian l_license l_ssn l_misc l_aup l_photo l_notify_via
  17 l_user_claims_ret l_user_environment l_user_department l_ums_id l_user_last_activity l_placcard l_user_email
  18 l_addr1_std_line1 l_addr1_std_line2 l_addr1_std_city l_addr1_std_state l_addr1_std_zip l_addr1_country
  19 l_addr1_township l_addr1_room l_addr1_company l_addr1_office l_addr1_phone l_addr1_dayphone l_addr1_homephone
  20 l_addr1_workphone l_addr1_cellphone l_addr1_fax l_addr1_email l_addr1_location l_addr1_usefor l_addr1_care_of
  21 l_addr1_known_bad l_addr1_ums_addrid l_addr2_std_line1 l_addr2_std_line2 l_addr2_std_city l_addr2_std_state
  22 l_addr2_std_zip l_addr2_country l_addr2_township l_addr2_room l_addr2_company l_addr2_office l_addr2_phone
  23 l_addr2_dayphone l_addr2_homephone l_addr2_workphone l_addr2_cellphone l_addr2_fax l_addr2_email
  24 l_addr2_locationl_addr2_usefor l_addr2_care_of l_addr2_known_bad l_addr2_ums_addrid l_addr3_std_line1
  25 l_addr3_std_line2 l_addr3_std_city l_addr3_std_state l_addr3_std_zip l_addr3_country l_addr3_township
  26 l_addr3_room l_addr3_company l_addr3_office l_addr3_phone l_addr3_dayphone l_addr3_homephone l_addr3_workphone
  27 l_addr3_cellphone l_addr3_fax l_addr3_email l_addr3_location l_addr3_usefor l_addr3_care_of l_addr3_known_bad
  28 l_addr3_ums_addrid l_identific l_noempl l_profession l_program l_represent l_userid_active l_inactive_barcode1
  29 l_inactive_barcode2);
  30
  31
  32 # Load each record
  33 while (<>) {
  34     s/\r\n/\n/g;
  35 # print STDERR "Loaded this line: " . $_;
  36
  37         # Is this the start of a new record?
  38         if ( /^... DOCUMENT BOUNDARY ...$/ ) {
  39                 $line = 0;
  40                 $serial++;
  41                 $section = ''; # just in case this didn't get reset in the previous record
  42                 # print STDERR "Processing record $serial.\n";
  43                 next;
  44         }
  45
  46         # Is this a FORM= line (which can be ignored)?
  47         if ( /^FORM=/ ) {
  48                 next;
  49         }
  50
  51         # If this isn't the start of the new record, it's a new line in the present record.
  52         $line++;
  53
  54         # Is this line the beginning of a block of data (typically an address or a note)?
  55         if ( /^\.(.*?)_BEGIN.$/ ) {
  56                 # print STDERR "I think this might be the beginning of a beautiful " . $1 . ".\n";
  57                 $section = "$1.";
  58                 next;
  59         }
  60
  61         # Is this line the beginning of a block of data (typically an address or a note)?
  62         if ( /^\.(.*?)_END.$/ ) {
  63                 if ("$1." ne $section) {
  64                         print STDERR "Error in record $serial, line $line (input line $.): got an end-of-$1 but I thought I was in a $section block!\n";
  65                 }
  66                 # print STDERR "It's been fun, guys, but... this is the end of the " . $1 . ".\n";
  67                 $section = '';
  68                 next;
  69         }
  70
  71         # Looks like we've got some actual data!  Let's store it.
  72         # FIXME: For large batches of data, we may run out of memory and should store this on disk.
  73         if ( /^\.(.*?).\s+(\|a)?(.*)$/ ) {
  74
  75                 # Build the name of this field (taking note of whether we're in a named section of data)
  76                 $field = '';
  77                 if ($section ne '') {
  78                         $field .= $section;
  79                 }
  80                 $field .= $1;
  81
  82                 # Store the field as a key of an array.  If it already exists, oh well, now it still exists.
  83                 $unique_fields{$field} = 1;
  84
  85                 # Now we can actually store this line of data!
  86                 $records[$serial]{$field} = $3;
  87
  88                 # print STDERR "Data extracted: \$records[$serial]{'$field'} = '$3'\n";
  89
  90                 next;
  91         }
  92
  93         # This is the continuation of the previous line.
  94         else {
  95                 chomp($_);
  96                 $records[$serial]{$field} .= ' ' . $_;
  97                 # print STDERR "Appended data to previous field. \$records[$serial]{'$field'} is now '" . $records[$serial]{$field} . "'.\n";
  98         }
  99
 100 }
 101
 102 print STDERR "Loaded " . scalar(@records) . " records.\n";
 103
 104
 105 # Process the records:
 106 for (my $u = 0; $u < @records; $u++) {
 107
 108         # Some fields can be mapped straightforwardly:
 109         foreach $f (qw( user_id user_alt_id user_pin user_profile user_status user_library user_priv_granted user_priv_expires user_mailingaddr user_claims_ret user_environment user_department user_last_activity user_category1 user_category2 user_category3 user_category4 )) {
 110                 $records[$u]{uc($f)} = '' unless defined $records[$u]{uc($f)};
 111                 $records[$u]{'l_' . $f} = $records[$u]{uc($f)};
 112         }
 113
 114         # Addresses are a bit different:
 115         foreach $a (qw( addr1 addr2 addr3 )) {
 116                 foreach $f (qw( std_line1 std_line2 std_city std_state std_zip country township room company office phone dayphone homephone workphone cellphone fax email location usefor care_of known_bad ums_addrid )) {
 117                         $records[$u]{uc('USER_' . $a . '.' . $f)} = '' unless defined $records[$u]{uc('USER_' . $a . '.' . $f)};
 118                         $records[$u]{'l_' . $a . '_' . '$f'} = $records[$u]{uc('USER_' . $a . '.' . $f)};
 119                 }
 120         }
 121
 122         # Handle fields that don't exactly match (e.g. parse USER_NAME into l_last_name etc.)
 123
 124         $records[$u]{'l_birthdate'} = $records[$u]{'USER.BIRTH_DATE'};
 125         $records[$u]{'l_note'} = $records[$u]{'USER_XINFO.NOTE'};
 126         $records[$u]{'l_note1'} = '';
 127         $records[$u]{'l_patron'} = '';
 128         $records[$u]{'l_comment'} = $records[$u]{'USER_XINFO.COMMENT'};
 129         $records[$u]{'l_staff'} = $records[$u]{'USER_XINFO.STAFF'};
 130         $records[$u]{'l_webcatpref'} = $records[$u]{'USER_XINFO.WEBCATPREF'};
 131         $records[$u]{'l_dept'} = $records[$u]{'USER_DEPARTMENT'};
 132         $records[$u]{'l_guardian'} = '';
 133         $records[$u]{'l_license'} = $records[$u]{'USER_XINFO.LICENSE'};
 134         $records[$u]{'l_ssn'} = $records[$u]{'USER_XINFO.SSN'};
 135         $records[$u]{'l_misc'} = '';
 136         $records[$u]{'l_aup'} = '';
 137         $records[$u]{'l_photo'} = '';
 138         $records[$u]{'l_notify_via'} = $records[$u]{'USER_XINFO.NOTIFY_VIA'};
 139         $records[$u]{'l_ums_id'} = '';
 140         $records[$u]{'l_placcard'} = '';
 141         $records[$u]{'l_user_email'} = '';
 142         $records[$u]{'l_identific'} = '';
 143         $records[$u]{'l_noempl'} = '';
 144         $records[$u]{'l_profession'} = '';
 145         $records[$u]{'l_program'} = '';
 146         $records[$u]{'l_represent'} = '';
 147         $records[$u]{'l_userid_active'} = '';
 148         $records[$u]{'l_inactive_barcode1'} = $records[$u]{'USER_XINFO.PREV_ID'};
 149         $records[$u]{'l_inactive_barcode2'} = $records[$u]{'USER_XINFO.PREV_ID2'};
 150
 151         # We can parse the name like so:
 152
 153         # Copy the name to a temp value
 154         $temp_name = $records[$u]{'USER_NAME'};
 155
 156         # Strip off a prefix, if there is one
 157         foreach $prefix (qw( Ms. Mrs. Mr. Dr. )) {
 158                 if ($temp_name =~ /$prefix /i) {
 159                         $records[$u]{'l_prefix_name'} = $prefix;
 160                         $temp_name =~ s/$prefix //i;
 161                 }
 162         }
 163
 164         # Strip off a suffix, if there is one
 165         foreach $suffix (qw( Jr. Sr. II III IV )) {
 166                 if ($temp_name =~ /$suffix /i) {
 167                         $records[$u]{'l_suffix_name'} = $suffix;
 168                         $temp_name =~ s/$suffix //i;
 169                 }
 170         }
 171
 172         # Strip off the family name (before the comma)
 173         # Of what remains, whatever is before the first space is the first name and the rest is the middle name
 174         $records[$u]{'l_last_name'} = $temp_name =~ /^([^,])*\s*,.*$/;
 175         $records[$u]{'l_first_given_name', 'l_second_given_name'} = $temp_name =~ /^[^,]*\s*,\s*([^,\s]*)\s*(.*)$/;
 176
 177 }
 178
 179
 180 # Print the results
 181 for (my $u = 0; $u < @records; $u++) {
 182         foreach $f (@output_fields) {
 183                 if (defined $records[$u]{$f}) {
 184                         print $records[$u]{$f};
 185                 }
 186         print "\t";
 187         }
 188         print "\n";
 189 }
 190
 191 print STDERR "Wrote " . scalar(@records) . " records.\n";
 192 # uh-bdee-uh-bdee-uh-bdee-uh- THAT'S ALL, FOLKS