alexandria-book-collection-manager 0.6.9.pre1

data/doc/cuecat_support.rdoc

@@ -0,0 +1,67 @@
+= CueCat Barcode Scanner Support
+
+Alexandria now supports the use of unmodified CueCat barcode scanners
+for scanning ISBN barcodes.
+
+
+== What is a CueCat?
+
+The CueCat is a wand-style barcode scanner, available with either a
+PS/2 keyboard connector (and a PS/2 keyboard pass-through), or with a
+standard keyboard-type USB connector. 
+
+You scan a barcode by placing the 'nose' of the scanner on one side of
+the barcode, in the clear area before the first black bar, and waiting
+until the flashing red light stops flashing and illuminates the
+surface brightly, then swiftly passing the scanner across the barcode
+and into the clear area on the far side. The scan data is then input
+into your computer as if through a keyboard. You can test the
+operation of your CueCat by placing your keyboard cursor inside any
+text editor and scanning a barcode.
+
+By default the scan data is scrambled. There are instructions, widely
+available on the Internet, detailing how to modify the circuit board to
+disable scrambling, but some barcode scanning applications, including
+Alexandria, can automatically decode scrambled data from a CueCat.
+
+
+== The History of CueCat?
+
+Millions of CueCat scanners were distributed free of charge by their
+creator the Digital Convergence Corporation in the late 1990s and
+early 2000s. The intention was that customers would use the scanners
+to scan special barcodes in magazine advertisments and articles, and
+software would take the customers to a related web page.
+
+Dozens of eager hackers, upon recieving these barcode scanners,
+immediately set about finding a way to use them for a wider variety of
+purposes, such as book cataloging. They decoded the very simple
+scrambling of the scanner output data (it was a form of Base64
+encoding), and even reported on how to lift a single microchip pin to
+circumvent the scrambling in hardware. They also discovered that each
+CueCat has a unique serial number (which could have allowed
+DigitalConvergence to build up profiles of the products customers were
+interested in) and showed how to zero-out or avoid the serial number.
+
+Digital Convergence attempted to restrict such activities, but
+eventually the company went bust, leaving several electronics
+warehouses to buy up hundreds of thousands of unshipped CueCats in the
+ensuing liquidation sale.
+
+Today, PS/2 and USB CueCat scanners are available cheaply over the
+internet (about US$12 in 2007). Apart from the slight inconvenience
+caused by the data scrambling, they are eminently usable as cheap,
+robust, wand-style barcode scanners.
+
+== The Old Linux Driver
+
+A kernel driver for the CueCat was developed as a patch for the 2.4
+Linux kernel series. This provided decoding of the scrambled input,
+and made input data available from <tt>/dev/scanners/cuecat</tt>.
+
+Since this driver is currently unmaintained and does not work with 2.6
+kernels, support for this has been dropped from Alexandria. However,
+since Alexandria 0.6.2, there is so-called 'userland' support for the
+CueCat, which simply means that modifications to the kernel are not
+necessary. Instead, the decoding of the simple data scrambling is done
+by the application software.

data/lib/alexandria.rb

@@ -0,0 +1,85 @@
+# Copyright (C) 2004-2006 Laurent Sansonetti
+# Modifications Copyright (C) 2011 Matijs van Zuijlen
+#
+# Alexandria is free software; you can redistribute it and/or
+# modify it under the terms of the GNU General Public License as
+# published by the Free Software Foundation; either version 2 of the
+# License, or (at your option) any later version.
+#
+# Alexandria is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+# General Public License for more details.
+#
+# You should have received a copy of the GNU General Public
+# License along with Alexandria; see the file COPYING.  If not,
+# write to the Free Software Foundation, Inc., 51 Franklin Street,
+# Fifth Floor, Boston, MA 02110-1301 USA.
+
+require 'gettext'
+
+# XXX: Gettext hotfix
+module Gem
+  class << self
+    undef :all_load_paths if method_defined? :all_load_paths
+    def all_load_paths
+      []
+    end
+  end
+end
+
+require 'logger'
+require 'alexandria/logging'
+require 'alexandria/about'
+
+module Alexandria
+  def self.set_proxy
+    ENV['http_proxy'] = nil if !ENV['http_proxy'].nil? and URI.parse(ENV['http_proxy']).userinfo.nil?
+  end
+
+  def self.set_log_level
+    if $DEBUG
+      Alexandria.log.level = Logger::DEBUG
+    end
+    Alexandria.log.debug { 'Initializing Alexandria...' }
+  end
+
+  def self.main
+    set_proxy
+    set_log_level
+    Alexandria::UI.main
+  end
+end
+
+# lrz says 'macui' is obsolete (may be supported again some day)
+# unless $MACOSX
+require 'alexandria/config'
+require 'alexandria/version'
+
+# else
+#  module Alexandria
+#    module Config
+#      DATA_DIR = OSX::NSBundle.mainBundle.resourcePath.fileSystemRepresentation
+#    end
+#    VERSION = OSX::NSBundle.mainBundle.infoDictionary.objectForKey('CFBundleVersion').to_s
+#  end
+# end
+require 'alexandria/utils'
+
+require 'alexandria/models/book'
+require 'alexandria/models/library'
+
+require 'alexandria/smart_library'
+require 'alexandria/execution_queue'
+require 'alexandria/import_library'
+require 'alexandria/export_library'
+require 'alexandria/book_providers'
+require 'alexandria/preferences'
+require 'alexandria/undo_manager'
+require 'alexandria/web_themes'
+
+# lrz says 'macui' is obsolete (may be supported again some day)
+# require $MACOSX ? 'alexandria/macui' : 'alexandria/ui'
+
+require 'alexandria/ui'
+require 'alexandria/console'

data/lib/alexandria/about.rb

@@ -0,0 +1,82 @@
+# encoding: utf-8
+# Copyright (C) 2004-2006 Laurent Sansonetti
+# Copyright (C) 2008 Joseph Method
+#
+# Alexandria is free software; you can redistribute it and/or
+# modify it under the terms of the GNU General Public License as
+# published by the Free Software Foundation; either version 2 of the
+# License, or (at your option) any later version.
+#
+# Alexandria is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+# General Public License for more details.
+#
+# You should have received a copy of the GNU General Public
+# License along with Alexandria; see the file COPYING.  If not,
+# write to the Free Software Foundation, Inc., 51 Franklin Street,
+# Fifth Floor, Boston, MA 02110-1301 USA.
+
+module Alexandria
+  TITLE = 'Alexandria'
+  TEXTDOMAIN = 'alexandria'
+  extend GetText
+  bindtextdomain(Alexandria::TEXTDOMAIN, charset: 'UTF-8')
+  DESCRIPTION = _('A program to help you manage your book collection.')
+  COPYRIGHT = "Copyright (C) 2004,2005,2006 Laurent Sansonetti\n" \
+    'Copyright (C) 2007,2008,2009,2010 Alexandria Contributors'
+  AUTHORS = [
+    'Alexander McCormmach <alexander@tunicate.org>',
+    'Aymeric Nys <aymeric@nnx.com>',
+    'Cathal Mc Ginley <cathal.alexandria@gnostai.org>',
+    'Claudio Belotti <bel8@lilik.it>',
+    'Constantine Evans <cevans@costinet.org>',
+    'Dafydd Harries <daf@muse.19inch.net>',
+    'Javier Fernandez-Sanguino Pena <jfs@debian.org>',
+    'Joseph Method <tristil@gmail.com>',
+    'Kevin Schultz <schultkl@ieee.org>',
+    'Laurent Sansonetti <lrz@gnome.org>',
+    'Marco Costantini <costanti@science.unitn.it>',
+    'Mathieu Leduc-Hamel <arrak@arrak.org>',
+    'Owain Evans <o.evans@gmail.com>',
+    'Pascal Terjan <pterjan@linuxfr.org>',
+    'Rene Samselnig <sandman@sdm-net.org>',
+    'Robby Stephenson <robby@periapsis.org>',
+    'Sun Ning <classicning@gmail.com>',
+    'Takayuki Kusano <AE5T-KSN@asahi-net.or.jp>',
+    'Timothy Malone <timothy.malone@gmail.com>',
+    'Zachary P. Landau <kapheine@hypa.net>'
+  ]
+  DOCUMENTERS = [
+    'Cathal Mc Ginley <cathal.alexandria@gnostai.org>',
+    'Liam Davison <registrations@liamjdavison.info>'
+  ]
+  TRANSLATORS = [
+    'Adrián Chaves Fernández <adriyetichaves@gmail.com> (gl)',
+    'Cathal Mc Ginley <cathal.alexandria@gnostai.org> (ga)',
+    'CHIKAMA Masaki <masaki.chikama@gmail.com> (ja)',
+    'Dafydd Harries <daf@muse.19inch.net> (cy)',
+    'Damjan Dimitrioski <damjandimitrioski@gmail.com> (mk)',
+    'Giacomo Margarito <giacomomargarito@gmail.com> (it)',
+    'Jack Myrseh <jack@enkom.no> (nb)',
+    'Joachim Breitner <mail@joachim-breitner.de> (de)',
+    'José Ling <jlgdot369@gmail.com> (zh_TW)',
+    'Lennart Karssen <lennart@karssen.org> (nl)',
+    'Lígia Moreira <ligia.moreira@netvisao.pt> (fr, pt, pt_BR)',
+    'Martin Karlsson <martinkarlsson81@hotmail.com> (sv)',
+    'Michael Kotsarinis <mkotsari1@pre.forthnet.gr> (el)',
+    'Miguel Ángel García <magmax@ieee.org> (es)',
+    'Peter Kováč <kovac.peter@fotopriestor.sk> (sk)',
+    'Petr Vanek <vanous@penguin.cz> (cs)',
+    'Piotr Drąg <piotrdrag@gmail.com> (pl)',
+    'Serhij Dubyk <dubyk@library.lviv.ua> (uk)'
+  ]
+  ARTISTS = [
+    'Andreas Nilsson <nisses.mail@home.se>',
+    'Stefanie Dijoux <stefanie.dijoux@gmail.com>'
+  ]
+  LIST = 'alexandria-list@rubyforge.org'
+  BUGREPORT_URL = 'http://rubyforge.org/tracker/?func=add&group_id=205&atid=863'
+  WEBSITE_URL = 'http://alexandria.rubyforge.org'
+  DONATE_URL = ''
+end

data/lib/alexandria/book_providers.rb

@@ -0,0 +1,411 @@
+# Copyright (C) 2004-2006 Laurent Sansonetti
+# Copyright (C) 2009 Cathal Mc Ginley
+# Copyright (C) 2011, 2014 Matijs van Zuijlen
+#
+# Alexandria is free software; you can redistribute it and/or
+# modify it under the terms of the GNU General Public License as
+# published by the Free Software Foundation; either version 2 of the
+# License, or (at your option) any later version.
+#
+# Alexandria is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+# General Public License for more details.
+#
+# You should have received a copy of the GNU General Public
+# License along with Alexandria; see the file COPYING.  If not,
+# write to the Free Software Foundation, Inc., 51 Franklin Street,
+# Fifth Floor, Boston, MA 02110-1301 USA.
+
+require 'singleton'
+require 'observer'
+
+module Alexandria
+  # FIXME: Use delegation instead of inheritance.
+  class BookProviders < Array
+    include Logging
+    include Singleton
+    include Observable
+    include GetText
+    GetText.bindtextdomain(Alexandria::TEXTDOMAIN, charset: 'UTF-8')
+
+    SEARCH_BY_ISBN, SEARCH_BY_TITLE, SEARCH_BY_AUTHORS,
+    SEARCH_BY_KEYWORD = (0..3).to_a
+
+    class SearchError < StandardError; end
+    class NoResultsError < SearchError; end
+    class ProviderSkippedError < NoResultsError; end # not an error :^(
+    class SearchEmptyError < SearchError; end # sigh, again not really an error
+    class TooManyResultsError < SearchError; end
+    class InvalidSearchTypeError < SearchError; end
+
+    def self.search(criterion, type)
+      factory_n = 0
+      # puts "book_providers search #{self.instance.count_observers}"
+
+      begin
+        factory = instance[factory_n]
+        puts factory.fullname + ' lookup' if $DEBUG
+        unless factory.enabled
+          puts factory.fullname + ' disabled!, skipping...' if $DEBUG
+          raise ProviderSkippedError
+        end
+        instance.changed
+        instance.notify_observers(:searching, factory.fullname) # new
+        results = factory.search(criterion, type)
+
+        # sanity check if at least one valid result is actually found
+        results.delete_if { |book, _cover| book.nil? }
+
+        if results.length == 0
+          instance.changed
+          instance.notify_observers(:not_found, factory.fullname) # new
+          raise NoResultsError
+        else
+          log.info { 'found at ' + factory.fullname }
+          instance.changed
+          instance.notify_observers(:found, factory.fullname) # new
+          return results
+        end
+      rescue => boom
+        if boom.is_a? NoResultsError
+          unless boom.instance_of? ProviderSkippedError
+            instance.changed
+            instance.notify_observers(:not_found, factory.fullname) # new
+            Thread.new { sleep(0.5) }.join
+          end
+        else
+          instance.changed
+          instance.notify_observers(:error, factory.fullname) # new
+          Thread.new { sleep(0.5) }.join # hrmmmm, to make readable...
+          trace = boom.backtrace.join("\n >")
+          log.warn { "Provider #{factory.name} encountered error: #{boom.message} #{trace}" }
+        end
+        if last == factory
+          log.warn { "Error while searching #{criterion}" }
+          message = case boom
+                    when Timeout::Error
+                      _("Couldn't reach the provider '%s': timeout " \
+                        'expired.') % factory.name
+
+                    when SocketError
+                      _("Couldn't reach the provider '%s': socket " \
+                        'error (%s).') % [factory.name, boom.message]
+
+                    when NoResultsError
+                      _('No results were found.  Make sure your ' \
+                        'search criterion is spelled correctly, and ' \
+                        'try again.')
+
+                    when ProviderSkippedError
+                      _('No results were found.  Make sure your ' \
+                        'search criterion is spelled correctly, and ' \
+                        'try again.')
+
+                    when TooManyResultsError
+                      _('Too many results for that search.')
+
+                    when InvalidSearchTypeError
+                      _('Invalid search type.')
+
+                    else
+                      boom.message
+                    end
+          puts "raising empty error #{message}"
+          raise SearchEmptyError, message
+        else
+          factory_n += 1
+          retry
+        end
+      end
+    end
+
+    def self.isbn_search(criterion)
+      search(criterion, SEARCH_BY_ISBN)
+    end
+
+    class Preferences < Array
+      def initialize(provider)
+        @provider = provider
+      end
+
+      class Variable
+        attr_reader :name, :description,
+        :possible_values
+        attr_accessor :value
+
+        def initialize(provider, name, description, default_value,
+                       possible_values = nil, mandatory = true)
+
+          @provider = provider
+          @name = name
+          @description = description
+          @value = default_value
+          @possible_values = possible_values
+          @mandatory = mandatory
+        end
+
+        def default_value=(new_value)
+          self.value = new_value
+        end
+
+        def new_value=(new_value)
+          message = @provider.variable_name(self) + '='
+          Alexandria::Preferences.instance.send(message,
+                                                new_value)
+          self.value = new_value
+        end
+
+        def provider_name
+          @provider.name.downcase
+        end
+
+        def mandatory?
+          @mandatory
+        end
+      end
+
+      def add(*args)
+        self << Variable.new(@provider, *args)
+      end
+
+      def [](obj)
+        case obj
+        when String
+          var = variable_named(obj)
+          var ? var.value : nil
+        when Integer
+          super(obj)
+        end
+      end
+
+      def variable_named(name)
+        find { |var| var.name == name }
+      end
+
+      def read
+        each do |var|
+          message = @provider.variable_name(var)
+          val = Alexandria::Preferences.instance.send(message)
+          var.value = val unless val.nil? or (val == '' and var.mandatory?)
+        end
+      end
+    end
+
+    class AbstractProvider
+      include GetText
+      attr_reader :prefs
+      attr_accessor :name, :fullname
+
+      def initialize(name, fullname = nil)
+        @name = name
+        @fullname = (fullname or name)
+        @prefs = Preferences.new(self)
+        @prefs.add('enabled', _('Enabled'), true, [true, false])
+      end
+
+      def enabled
+        @prefs['enabled']
+      end
+
+      def toggle_enabled
+        old_value = enabled
+        @prefs.variable_named('enabled').new_value = !old_value
+      end
+
+      def reinitialize(fullname)
+        @name << '_' << fullname.hash.to_s
+        @fullname = fullname
+        prefs = Alexandria::Preferences.instance
+        ary = prefs.abstract_providers
+        ary ||= []
+        ary << @name
+        prefs.abstract_providers = ary
+        message = variable_name('name') + '='
+        prefs.send(message, @fullname)
+      end
+
+      def remove
+        prefs = Alexandria::Preferences.instance
+        if (ary = prefs.abstract_providers)
+          ary.delete(@name)
+          prefs.abstract_providers = ary
+        end
+        if (ary = prefs.providers_priority) and ary.include?(@name)
+          ary.delete(@name)
+          prefs.providers_priority = ary
+        end
+        self.prefs.each do |variable|
+          name = variable_name(variable)
+          prefs.remove_preference(name)
+        end
+        name = variable_name('name')
+        prefs.remove_preference(name)
+        prefs.save!
+      end
+
+      def variable_name(object)
+        s = case object
+            when String
+              object
+            when Preferences::Variable
+              object.name
+            else
+              raise
+            end
+        @name.downcase + '_' + s
+      end
+
+      def transport
+        config = Alexandria::Preferences.instance.http_proxy_config
+        config ? Net::HTTP.Proxy(*config) : Net::HTTP
+      end
+
+      def abstract?
+        self.class.abstract?
+      end
+
+      def self.abstract?
+        (!included_modules.include?(Singleton))
+      end
+
+      def <=>(provider)
+        fullname <=> provider.fullname
+      end
+
+      def self.unabstract
+        include Singleton
+        undef_method :reinitialize
+        undef_method :name=
+        undef_method :fullname=
+        undef_method :remove
+      end
+    end
+
+    class GenericProvider < AbstractProvider
+      unabstract
+    end
+
+    require 'alexandria/book_providers/mcu' # yep, still mostly works !
+    require 'alexandria/book_providers/douban' # only requires YAML
+
+    # require 'alexandria/book_providers/ibs_it'
+    # require 'alexandria/book_providers/renaud'
+    # require 'alexandria/book_providers/bol_it'
+    # require 'alexandria/book_providers/webster_it'
+    log.info { 'Not loading IBS, Renaud, BOL, Webster (providers not functional)' }
+
+    # Amazon AWS (Amazon Associates Web Services) provider, needs hpricot
+    require 'alexandria/book_providers/amazon_aws'
+
+    # Website based providers
+    require 'alexandria/book_providers/adlibris'
+    require 'alexandria/book_providers/barnes_and_noble'
+    require 'alexandria/book_providers/deastore'
+    require 'alexandria/book_providers/proxis'
+    require 'alexandria/book_providers/siciliano'
+    require 'alexandria/book_providers/thalia'
+    require 'alexandria/book_providers/worldcat'
+
+    # Ruby/ZOOM is optional
+    begin
+      require 'alexandria/book_providers/z3950'
+    rescue LoadError
+      log.info { "Can't load Ruby/ZOOM, hence Z39.50 and providers Library of Congress, British Library not available" }
+    end
+
+    attr_reader :abstract_classes
+
+    def initialize
+      @prefs = Alexandria::Preferences.instance
+      @abstract_classes = []
+      update_priority
+    end
+
+    def update_priority
+      # This is weird code that sorts through the list of classes brought
+      # in by requires and sorts through whether they are 'Abstract' or not,
+      # adding their names to @prefs.
+
+      @abstract_classes.clear
+      providers = {}
+      self.class.constants.each do |constant|
+        md = /(.+)Provider$/.match(constant)
+        next unless md
+        klass = self.class.module_eval(constant.to_s)
+        if klass.ancestors.include?(AbstractProvider) and
+            klass != GenericProvider and
+            klass != WebsiteBasedProvider and
+            klass != AbstractProvider
+
+          if klass.abstract?
+            @abstract_classes << klass
+          else
+            providers[md[1]] = klass.instance
+          end
+        end
+      end
+      if (ary = @prefs.abstract_providers)
+        ary.each do |name|
+          md = /^(.+)_/.match(name)
+          next unless md
+          klass_name = md[1] + 'Provider'
+          klass = @abstract_classes.find { |x| x.name.include?(klass_name) }
+          next unless klass
+          fullname = @prefs.send(name.downcase + '_name')
+          next unless fullname
+          instance = klass.new
+          instance.name = name
+          instance.fullname = fullname
+          instance.prefs.read
+          providers[name] = instance
+        end
+      end
+      clear
+      rejig_providers_priority
+      priority = (@prefs.providers_priority or [])
+      priority.map!(&:strip)
+      rest = providers.keys - priority
+      priority.each { |pname| self << providers[pname] }
+      rest.sort.each { |pname| self << providers[pname] }
+      self.compact!
+    end
+
+    # FIXME: Define the handful of methods that use this.
+    def self.method_missing(id, *args, &block)
+      if instance.respond_to? id
+        instance.method(id).call(*args, &block)
+      else
+        super
+      end
+    end
+
+    private
+
+    def rejig_providers_priority
+      priority = (@prefs.providers_priority or [])
+      unless priority.empty?
+        changed = false
+
+        if (ecs_index = priority.index('AmazonECS'))
+          priority[ecs_index] = 'Amazon' # replace legacy "AmazonECS" name
+          priority.uniq! # remove any other "Amazon" from the list
+          changed = true
+        end
+        if (deastore_index = priority.index('DeaStore_it'))
+          priority[deastore_index] = 'DeaStore'
+          changed = true
+        end
+        if (worldcat_index = priority.index('Worldcat'))
+          priority[worldcat_index] = 'WorldCat'
+          changed = true
+        end
+        if (adlibris_index = priority.index('Adlibris'))
+          priority[adlibris_index] = 'AdLibris'
+          changed = true
+        end
+        @prefs.providers_priority = priority if changed
+      end
+    end
+  end
+end