zcc 0.1.0 → 0.2.0

data/examples/zebra/zcc_passw

@@ -0,0 +1 @@
+zcc:same01Dsong

data/examples/zebra/zebra.cfg

@@ -1,9 +1,8 @@
-# ZCC
 # Simple Zebra configuration file that defines
-# MARC21 records
+# a database with MARCXML records.
 #
 # Where are the config files located?
-profilePath:/home/jason/.zcc/zebra/tab
+profilePath:tab
 # modulePath - where to look for loadable zebra modules
 modulePath: /usr/lib/idzebra-2.0/modules
 
@@ -15,25 +14,31 @@ attset: gils.att
 
 # systag sysno rank
 # Specify record type
-recordId: file
-recordType: grs.marcxml.marc21
-storeKeys: 1
+recordType:grs.xml
+recordId: (bib1,Local-number)
 
-#added for public server
-database: zcc
+storeKeys:1
+storeData:1
 
+database: zcc
 
 # Lock File Area
-lockDir: /home/jason/.zcc/zebra/lock
-perm.anonymous:r
-register: /home/jason/.zcc/zebra/register:1G
+lockDir: lock
+
+# You will most likely only want to give anonymous access read privileges.
+# In testing leaving off the anonymous user still allows anonymous search!
+perm.anonymous:ar
+perm.zcc:rw
+passwd: zcc_passw
+dbaccess: accessfile
+
+register: register:1G
+shadow: shadow:1G
 
-# Temp File area for result sets
-setTmpDir: /home/jason/.zcc/zebra/tmp
 
 # Temp File area for index program
-keyTmpDir: /home/jason/.zcc/zebra/key
+keyTmpDir: key
 
 # Approx. Memory usage during indexing
-memMax: 50M
+memMax: 125M
 rank:rank-1

data/lib/zcc/cli_display.rb

@@ -4,8 +4,10 @@ module ZCC
     #puts self[0]
     unless results.is_a? ZCC::ResultSet
       raise ArgumentError, "This Array doesn't have a MARC::Record!" 
-    end 
-    
+    end
+    rec_copy = results.records
+    recs_length = rec_copy.length
+    index_range = (0..recs_length - 1)
     clear = %x{clear}
     
     # Help statements:
@@ -53,7 +55,7 @@ module ZCC
       Sorting reindexes the result set and removes nil values.
       E_O_F
 
-    help_c = "Compare two records.\nCompares the records line by line.\nLines with an 'm' match each other.\nLines with a plus sign are in the first record but not the second. Lines with a minus sign '-' are from the second record but not the first.\nEven the difference of a period matters here.\n> c4-2"
+    help_c = "Compare two records.\nCompares the records line by line.\nLines with an 'm' match each other.\nLines with a plus sign are in the first record but not the second. Lines with a minus sign '-' are from the second record but not the first.\nEven the difference of a period matters here.\n> c [ENTER] 4-2"
     help_l = "Lint the record.\nCheck for errors such as wrong indicator values or poor punctuation.\n> l5"
 
     help_f = "Forwards through the result set.\nThe number of results shown per page is configured in zcc.yaml."
@@ -73,7 +75,7 @@ module ZCC
     
 
     loop do
-      rec_copy = results.records
+      
       choose do |menu|
         print $clear_code
         
@@ -93,12 +95,16 @@ module ZCC
           end
           #puts "\n\n"
         end
-        puts "Highest position: " + (results.size - 1).to_s
-        
+
+        #convenience to show whole record in the case that there's only one
+        if recs_length == 1
+          say("#{ZCC.zcc_marc_str_bold(rec_copy[0].to_s, 'record')}")
+        end  
         
-        recs_length = rec_copy.length
-        index_range = (0..recs_length - 1)
+        puts "Highest position: " + (results.size - 1).to_s
+        say("\aYou are currently in the winnowing stage.\nWinnow your choices with 'unselect' or 'remove'.\nEnter 'done' if you want to process all selected records\nor if no records are selected you will be returned to a search.\n".bold) if take_how_many == 'winnow'
 
+        
         menu.hidden("help", help_help) do |cmd, d| 
           if d == ''
             say_help(help_help)
@@ -181,10 +187,12 @@ module ZCC
           if range_a[1]
             for r in range_a[0]..range_a[1]
               rec_copy[r] = nil if rec_copy[r]
+              #return
             end
           else
             rec_copy[range_a[0]] = nil
-          end          
+            #return
+          end
         end
 	      menu.hidden(:remove, help_r) { |cmd, d|  say_help(help_r) }
         
@@ -225,23 +233,12 @@ module ZCC
         end
 	      
         # compare
-        menu.hidden(:c, help_c){|c,d| say_help(help_c)}
-	      menu.choice('c#-#', help_c) do |command, details|
-          say_help(help_c)
-        end
-        comparison = []
-        for x in (0..recs_length-1)
-          for y in (0..recs_length-1)
-            unless x == y
-              comparison << 'c' + x.to_s + '-' + y.to_s
-            end
-          end
-        end
-        comparison.each do |compare|
-          menu.hidden(compare, help_c) do |cmd, details|
-            cmd = cmd[1,99]
-            compare_nums = cmd.split('-')
-            if rec_copy[compare_nums[0].to_i] == nil || rec_copy[compare_nums[1].to_i] == nil
+        menu.hidden(:compare, help_c){|c,d| say_help(help_c)}
+        menu.choice(:c, help_c) do |c,d| 
+          say(help_c)
+          comparitors = ask("Enter the two to compare. 1-2 compares record 1 to record 2.".boldz)
+          compare_nums = comparitors.split('-').collect{|i| i.to_i}
+          if rec_copy[compare_nums[0].to_i] == nil || rec_copy[compare_nums[1].to_i] == nil
               say_help("One of the records has been removed!")
             else
               say("comparison:".headline)
@@ -249,8 +246,33 @@ module ZCC
               ask("Hit ENTER to continue...".headlinez)            
               next
             end
-          end
         end
+        #this always gave an Ambiguous choice error in many cases for instance c1-2 would throw the Highline error. Would like to get this to work as originally intended.
+	      #menu.choice('c#-#', help_c) do |command, details|
+        #  say_help(help_c)
+        #end
+        # comparison = []
+        # for x in (0..recs_length-1)
+          # for y in (0..recs_length-1)
+            # unless x == y
+              # comparison << 'c' + x.to_s + '-' + y.to_s
+            # end
+          # end
+        # end
+        # comparison.each do |compare|
+          # menu.hidden(compare, help_c) do |cmd, details|
+            # cmd = cmd[1,99]
+            # compare_nums = cmd.split('-')
+            # if rec_copy[compare_nums[0].to_i] == nil || rec_copy[compare_nums[1].to_i] == nil
+              # say_help("One of the records has been removed!")
+            # else
+              # say("comparison:".headline)
+              # compare_marc(rec_copy[compare_nums[0].to_i], rec_copy[compare_nums[1].to_i])
+              # ask("Hit ENTER to continue...".headlinez)            
+              # next
+            # end
+          # end
+        # end
 
         # lint
         menu.hidden(:l, help_l){|c,d| say_help(help_l)}
@@ -301,7 +323,7 @@ module ZCC
         end
 
         # quit
-	      menu.choice(:quit, "Exit program.") { |cmd, d| exit}
+	      menu.choice(:quit, "Exit program.") { |cmd, d| return 'quit'}
         
         # none -- only for final record taking. not currently used
 	      if take_how_many == 'one'    
@@ -444,18 +466,18 @@ end
 # Override HighLine's own defaults so that our large menu options do not display.
 # This needs work to have better help for these error messages.
 
-class Highline
-  class Menu
-    def update_responses(  )
-      append_default unless default.nil?
-      @responses = { 
-        :ambiguous_completion =>    "Ambiguous choice.  ",                     
-        :ask_on_error         =>    "?  ",                     
-        :invalid_type         =>    "You must enter a valid option.",                     :no_completion        =>    "You must pick a valid option.",                     :not_in_range         =>    "You must input a valid option." ,                     
-        :not_valid            =>    "You must have a valid option." 
-      }.merge(@responses)
-    end    
-  end
-end
-
+ class Highline
+   class Menu
+     def update_responses(  )
+       append_default unless default.nil?
+       @responses = { 
+         :ambiguous_completion =>    "Ambiguous choice.  ",                     
+         :ask_on_error         =>    "?  ",                     
+         :invalid_type         =>    "You must enter a valid option.",                     :no_completion        =>    "You must pick a valid option.",                     :not_in_range         =>    "You must input a valid option." ,                     
+         :not_valid            =>    "You must have a valid option." 
+       }.merge(@responses)
+     end    
+   end
+ end
+ 
 

data/lib/zcc/query.rb

@@ -31,7 +31,7 @@ module ZCC
           term = term.split(" :au ")
           puts "Author and title then"
           @term = term[0]
-          @zsearch = "@and @attr 1=4 \"#{@term}\" @attr 1=1 \"#{term[1]} \"" #was: "@attr 1=4 \"'#{@term}'\""
+          @zsearch = "@and @attr 1=4 \"#{@term}\" @attr 1=1 \"#{term[1]}\"" #was: "@attr 1=4 \"'#{@term}'\""
         else
           @term = term
           @zsearch = "@attr 1=4 \"#{@term}\"" #was: "@attr 1=4 \"'#{@term}'\""
@@ -61,31 +61,32 @@ module ZCC
           #puts server.to_s
         search_threads << Thread.new(server, z) do |myserver, myz|
           begin
-            conn = ZOOM::Connection.new
-            conn.connect(myserver.host, server.port) #do |conn 
-            conn.set_option('charset', 'UTF-8')
-            conn.preferred_record_syntax = 'MARC21'
-            conn.database_name = myserver.database
-            puts "#{myz} Searching:          #{myserver.to_s} | #{self.zsearch}"
-            rset = conn.search(self.zsearch)
-            say(myz.to_s.headline + " Finished searching: #{myserver.to_s} | rset.size: " + "#{rset.size}".red.bold)
-            rset_recs = rset[0, show]
-            #puts "rset_recs in query.search: " 
-            #puts rset_recs
-            i = 0
-            rset_recs.each do |rec|
-              #puts myserver.to_s
-              #puts rec
-              #puts
-              marc_record = ZCC.convert_char(rec)
-              #puts "gets past character conversion"
-              #puts "-------------\n"
-              #puts marc_record
-              #puts "---------------\n"
-              zcc_record = Record.new(marc_record, myserver)
-              result_set.ingest(zcc_record)
-              puts "#{myz} record #{i} from       #{myserver}..."
-              i += 1
+            ZOOM::Connection.open("#{myserver.host}:#{server.port}/#{myserver.database}") do |conn|
+              #conn.connect(myserver.host, server.port) #do |conn 
+              conn.set_option('charset', 'UTF-8')
+              conn.preferred_record_syntax = 'MARC21'
+              puts "#{myz} Searching:          #{myserver.to_s} | #{self.zsearch}"
+              rset = conn.search(self.zsearch)
+              say(myz.to_s.headline + " Finished searching: #{myserver.to_s} | rset.size: " + "#{rset.size}".red.bold)
+              rset_recs = rset[0, show]
+              #puts "rset_recs in query.search: " 
+              #puts rset_recs
+              i = 0
+              rset_recs.each do |rec|
+                #puts myserver.to_s
+                #puts rec
+                #puts
+                marc_record = ZCC.convert_char(rec)
+                #puts "gets past character conversion"
+                #puts "-------------\n"
+                #puts marc_record
+                #puts "---------------\n"
+                zcc_record = Record.new(marc_record, myserver)
+                result_set.ingest(zcc_record)
+                puts "#{myz} record #{i} from       #{myserver}..."
+                i += 1
+              end
+            conn = nil  
             end
           rescue Exception => e
             zerror_log("dead thread: " + myserver.to_s + " | " + e)
@@ -101,8 +102,10 @@ module ZCC
     end
     
     alias search zoom
+
+    #FIXME probably should move this to a different class that contants more cli stuff
     def zerror_log error
-      File.open("#{File.expand_path("~")}/.zcc/zerror_log", "a+") do |f|
+      File.open("#{ROOT}/zerror_log", "a+") do |f|
         f.write error + "\n"
       end
     end

data/lib/zcc/record.rb

@@ -59,7 +59,7 @@ module ZCC
         puts 'You do not have the Perl MARC::Lint module installed or have disabled this feature.'
         return
       end
-      contents = `perl "#{File.expand_path("~")}"/.zcc/linter.pl "#{xml_rec}"`
+      contents = `perl "#{ROOT}"/linter.pl "#{xml_rec}"`
       if contents.empty?
         puts "there were no errors detected by the linter."
       else
@@ -209,7 +209,34 @@ module ZCC
       field_subfield << combined[3,1]
     end
   
-  
+    def full_edit
+      #puts self.class
+      orig_marc = Tempfile.new("orig_marc-")
+      orig_marc << self.marc.to_marc
+      orig_marc.close
+      
+      line_format = `yaz-marcdump #{orig_marc.path}`
+      
+      out = Tempfile.new("full_edit-")
+      out << line_format
+      out.close
+      
+      system("#{TEXT_EDITOR} #{out.path}")
+
+      final = Tempfile.new("final-")
+      final.close
+      `yaz-marcdump -i line -o marc #{out.path} > #{final.path}`
+      
+      record = MARC::Reader.new(final.path)
+      for rec in record
+        puts rec
+        self.marc = rec
+        puts rec.class
+      end
+      puts self.marc.inspect
+      
+    end
+
     
    # To use marc_to_csv it must be passed a csv template in the order of the fields.
   # See the zoomer.yaml file for instructions on creating a template.
@@ -242,7 +269,15 @@ module ZCC
           end
         end
         value.sub!(/\|$/, '')
-        value = value[0, leng] if leng
+        if leng
+            if value.length == value.jlength
+              value = value[0, leng]
+            else
+              puts "This value seems to have multibyte characters. If a byte gets dropped off the end that spells trouble."
+              leng = ask("How many bytes would you like to take?")
+              value = value[0, leng.to_s]
+            end
+          end
         #puts "value: #{value}"
         value = "\"#{value}\","
         values << value

data/lib/zcc/resultset.rb

@@ -58,6 +58,7 @@ module ZCC
     #returns number of ZCC::Records with @selected set to true
     def selected_size
       selected_records = self.find_all{|record| record.selected unless record == nil}
+      #puts selected_records.length
       selected_records.length
     end 
     

data/lib/zcc/version.rb

@@ -1,7 +1,7 @@
 module Zcc #:nodoc:
   module VERSION #:nodoc:
     MAJOR = 0
-    MINOR = 1
+    MINOR = 2
     TINY  = 0
 
     STRING = [MAJOR, MINOR, TINY].join('.')

data/website/index.html

@@ -33,23 +33,25 @@
     <h1>zcc projects</h1>
     <div id="version" class="clickable" onclick='document.location = "http://rubyforge.org/projects/zcc"; return false'>
       <p>Get Version</p>
-      <a href="http://rubyforge.org/projects/zcc" class="numbers">0.1.0</a>
+      <a href="http://rubyforge.org/projects/zcc" class="numbers">0.2.0</a>
     </div>
     <h1>&#x2192; &#8216;zcc&#8217;</h1>
 
+
 	<h2>What</h2>
 
+
 	<p><strong>Zcc projects</strong> is a collection of tools written in Ruby to help with copy cataloging.</p>
 
 
-	<h1><strong>THIS IS <em>alpha</em> SOFTWARE. <span class="caps">IT MIGHT MANGLE YOUR MARC AND CORRUPT YOUR CATALOG</span>.</strong></h1>
+	<h1><strong><span class="caps">THIS IS</span> <em>alpha</em> SOFTWARE. <span class="caps">IT MIGHT MANGLE YOUR MARC AND CORRUPT YOUR CATALOG</span>.</strong> 
+I use it myself, but I care enough about your data to call it alpha for now.</h1>
 
-	<h1>zcc project releases so far</h1>
 
-	<p><a href="http://zcc.rubyforge.org/zcc.html">zcc</a>  zcc is the main copy cataloging script.</p>
+	<h1>zcc project releases so far</h1>
 
 
-	<p><a href="http://zcc.rubyforge.org/wcid">wcid</a>  wcid is a library for handling WorldCat Identites</p>
+	<p><a href="http://zcc.rubyforge.org/zcc.html">zcc</a>  zcc is the main copy cataloging script.</p>
     
 </div>
 

data/website/index.txt

@@ -7,12 +7,12 @@ h2. What
 *Zcc projects* is a collection of tools written in Ruby to help with copy cataloging. 
 
 
-h1. *THIS IS _alpha_ SOFTWARE. IT MIGHT MANGLE YOUR MARC AND CORRUPT YOUR CATALOG.*
+h1. *THIS IS _alpha_ SOFTWARE. IT MIGHT MANGLE YOUR MARC AND CORRUPT YOUR CATALOG.* 
+I use it myself, but I care enough about your data to call it alpha for now.
 
 h1. zcc project releases so far
 
 "zcc":http://zcc.rubyforge.org/zcc.html  zcc is the main copy cataloging script.
 
-"wcid":http://zcc.rubyforge.org/wcid  wcid is a library for handling WorldCat Identites
 
 

data/website/koha.html

@@ -33,53 +33,66 @@
     <h1>Using Koha with zcc</h1>
     <div id="version" class="clickable" onclick='document.location = "http://rubyforge.org/projects/zcc"; return false'>
       <p>Get Version</p>
-      <a href="http://rubyforge.org/projects/zcc" class="numbers">0.1.0</a>
+      <a href="http://rubyforge.org/projects/zcc" class="numbers">0.2.0</a>
     </div>
     <p><a href="http://www.koha.org">Koha</a> + <a href="http://zcc.rubyforge.org/zcc.html">zcc</a></p>
 
 
 	<h2>Hints</h2>
 
-<ol>
+
+	<ol>
 	<li>Follow all the directions on the <a href="http://zcc.rubyforge.org/zcc.html">main zcc page</a> carefully. Please let me know if you run into problems with configuration.</li>
-</ol>
+	</ol>
+
 
-<ol>
+	<ol>
 	<li><a href="http://zcc.rubyforge.org/zcc.html">zcc</a> is <strong>not</strong> a part of Koha and is not developed by the same folks.</li>
-</ol>
+	</ol>
+
 
-<ol>
+	<ol>
 	<li><a href="http://zcc.rubyforge.org/zcc.html">zcc</a> only creates utf-8 encoded records. If you want <span class="caps">MARC</span>-8 encoded records you&#8217;re on your own. <span class="caps">MARC</span>-8 encoding has already caused enough problems in this world, so I encourage folks to move to <span class="caps">UTF</span>-8 <span class="caps">ASAP</span>. If you use a different encoding that you want supported, please let me know. To set up Koha properly for dealing with <span class="caps">UTF</span>-8 encoded records see <a href="http://wiki.koha.org/doku.php?id=encodingscratchpad&#38;s=utf8">this wiki page</a></li>
-</ol>
+	</ol>
+
+
+	<ol>
+	<li><span class="caps">ZCC</span> currently only works with a default install of Koha as paths are hardcoded. If there&#8217;s a need I&#8217;ll make it configurable for someone. Make sure the Koha modules are a part of your path. I accomplish this by adding &#8220;export <span class="caps">PERL5LIB</span>=/usr/local/koha/intranet/modules&#8221; (and &#8220;export <span class="caps">KOHA</span>_CONF=/etc/koha.conf&#8221;?) without the quotes to my .bashrc (or add the path to /etc/profile for the root user). If your paths differ from the preceding saving to Koha will not work.</li>
+	</ol>
+
 
-<ol>
-	<li><span class="caps">ZCC</span> currently only works with a default install as paths are hardcoded. If there&#8217;s a need I&#8217;ll make it configurable for someone. Make sure the Koha modules are a part of your path. I accomplish this by adding &#8220;export <span class="caps">PERL5LIB</span>=/usr/local/koha/intranet/modules&#8221; and &#8220;export <span class="caps">KOHA</span>_CONF=/etc/koha.conf&#8221; without the quotes to my .bashrc (or add the path to /etc/profile for the root user). If your paths differ from the preceding saving to Koha will not work.</li>
-</ol>
+	<ol>
+	<li>You then have 3 choices on how to get the records into koha:
 
-<ol>
-	<li>You can then have 3 choices on how to get the records into koha:<ul>
-	<li>Using the Koha Administration interface you can &#8220;Upload <span class="caps">MARC</span> records to the resevoir.&#8221; Then complete processing on the records like adding items and barcodes within the Koha web interface. The resevoir may strip out some fields that usually hold local content.</li>
-</ul>
+	<ul>
+	<li>Use <span class="caps">ZCC</span> to save_record_syntax your <span class="caps">MARC</span> records to file as &#8216;marc&#8217;. Using the Koha Administration interface you can &#8220;Upload <span class="caps">MARC</span> records to the resevoir.&#8221; Then complete processing on the records like adding items and barcodes within the Koha web interface. The resevoir may strip out some fields that usually hold local content.</li>
+	</ul>
 
-<ul>
+
+	<ul>
 	<li>If you have processed your records fully to include item numbers and barcodes, you can use the bulkmarcimport script to put the records directly into your database.  I&#8217;ve used bulkmarcimport without modification without problem. You may have different results and I&#8217;d like to hear them.</li>
-</ul>
+	</ul>
+
 
 <pre syntax="ruby">perl
   /usr/local/koha/intranet/scripts/misc/migration_tools/bulkmarcimport.pl -v -file
   /path/to/marc-file.mrc</pre>
+
 	<p>That is all one line.</p>
 
 
-<ul>
+	<ul>
 	<li>Or configure the save_record_syntax of your zcc.yaml file to &#8216;koha2&#8217;.  If this gives you errors make sure you have exported environment variables with: &#8220;export -p&#8221;. You may also need to change the permissions on /etc/koha.conf to allow all users to view the file. If you get errors you can (though it might not be the best solution) do the following as root:</li>
-</ul>
+	</ul>
+
 
 <pre>chmod 644 /etc/koha.conf</pre></li>
-</ol>
+	</ol>
+
 
 	<h1>Contact</h1>
 
+
 	<p>I use <span class="caps">ZCC</span> and Koha for my own work. So I&#8217;m very interested in making <span class="caps">ZCC</span> work better with Koha. Please send your comments, suggestions and patches to <a href="mailto:jronallo+zcc@gmail.com">Jason Ronallo</a></p>
     
 </div>