Class: PrimoService

125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172

# File 'lib/service_adaptors/primo_service.rb', line 125

def initialize(config)
  # defaults
  @holding_attributes = Exlibris::Primo::Holding.base_attributes
  @rsrc_attributes = Exlibris::Primo::Rsrc.base_attributes
  @toc_attributes = Exlibris::Primo::Toc.base_attributes
  # TODO: Run these decisions by Bill M. to see if they make sense.
  @referent_enhancements = {
    # Prefer SFX journal titles to Primo journal titles
    :jtitle => { :overwrite => false },
    :btitle => { :overwrite => true }, :aulast => { :overwrite => true },
    :aufirst => { :overwrite => true }, :aucorp => { :overwrite => true }, 
    :au => { :overwrite => true }, :pub => { :overwrite => true },
    :place => { :value => :cop, :overwrite => false },
    # Prefer SFX journal titles to Primo journal titles
    :title => { :value => :jtitle, :overwrite => false},
    :title => { :value => :btitle, :overwrite => true},
    # Primo lccn and oclcid are spotty in Primo, so don't overwrite
    :lccn => { :overwrite => false }, :oclcnum => { :value => :oclcid, :overwrite => false}
  }
  @suppress_urls = []
  @suppress_tocs = []
  @suppress_holdings = []
  @service_types = [ "fulltext", "holding", "holding_search",
    "table_of_contents", "referent_enhance", "cover_image" ] if @service_types.nil?
  # For backward compatibility, re-map "old" config values to new more 
  # Umlaut-y names and print deprecation warning in the logs.
  old_to_new_mappings = {
    :base_path => :base_url,
    :base_view_id => :vid,
    :link_to_search_text => :holding_search_text
  }
  old_to_new_mappings.each do |old_param, new_param|
    unless config["#{old_param}"].nil?
      config["#{new_param}"] = config["#{old_param}"] if config["#{new_param}"].nil?
      RAILS_DEFAULT_LOGGER.warn("Parameter '#{old_param}' is deprecated.  Please use '#{new_param}' instead.")
    end
  end # End backward compatibility maintenance
  super(config)
  # For backward compatibility, handle the special case where holding_search_institution was not included.
  # Set holding_search_institution to vid and print warning in the logs.
  if @service_types.include?("holding_search") and @holding_search_institution.nil?
    @holding_search_institution = @institution
    RAILS_DEFAULT_LOGGER.warn("Required parameter 'holding_search_institution' was not set.  Please set the appropriate value in services.yml.  Defaulting institution to view id, #{@vid}.")
  end # End backward compatibility maintenance
  raise ArgumentError.new(
    "Missing Service configuration parameter. Service type #{self.class} (id: #{self.id}) requires a config parameter named 'holding_search_institution'. Check your config/umlaut_config/services.yml file."
  ) if @service_types.include?("holding_search") and @holding_search_institution.nil?
end

184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347

# File 'lib/service_adaptors/primo_service.rb', line 184

def handle(request)
  @identifier = request.referrer.identifier if request.referrer and request.referrer.identifier
  primo_id = @identifier.match(/primo-(.+)/)[1] if primo_identifier? unless @identifier.nil? or @identifier.match(/primo-(.+)/).nil?
  # DEPRECATED
  # Extend OpenURL standard to take Primo Doc Id
  primo_id = request.referent.metadata['primo'] unless request.referent.metadata['primo'].nil?
  RAILS_DEFAULT_LOGGER.warn("Use of 'rft.primo' is deprecated.  Please use the identifier instead.") unless request.referent.metadata['primo'].nil?
  # End DEPRECATED
  searcher_setup = {
    :base_url => @base_url, :vid => @vid, :institution => @institution,
    :config => primo_config
  }
  # don't send mal-formed issn
  issn = request.referent.metadata['issn'] if request.referent.metadata['issn'] =~ /\d{4}(-)?\d{3}(\d|X)/
  title = title(request)
  search_params = {
    :primo_id => primo_id,
    :isbn => request.referent.metadata['isbn'], 
    :issn => issn,
    :title => title,
    :author => author(request),
    :genre => request.referent.metadata['genre']
  }
  begin
     primo_searcher = Exlibris::Primo::Searcher.new(searcher_setup, search_params)
  rescue Exception => e
    # Log error and return finished
    RAILS_DEFAULT_LOGGER.error(
      "Error in Exlibris::Primo::Searcher. "+ 
      "Returning 0 Primo services for search #{search_params.inspect}. "+ 
      "Exlibris::Primo::Searcher raised the following exception:\n#{e}")
    return request.dispatched(self, true)
  end
  # Enhance the referent with metadata from Primo Searcher if primo id is present
  # i.e. if we did our search with the Primo system number
  if primo_id and @service_types.include?("referent_enhance")
    @referent_enhancements.each do |key, options|
      value = (options[:value].nil?) ? key.to_sym : options[:value].to_sym
      request.referent.enhance_referent(
        key.to_s, primo_searcher.method(value).call, 
        true, false, options
      ) if primo_searcher.respond_to? value and not primo_searcher.method(value).call.nil?
    end
  end
  # Get cover image only if primo_id is defined
  if primo_id and @service_types.include?("referent_enhance")
    cover_image = primo_searcher.cover_image
    unless cover_image.nil?
      request.add_service_response({
        :service => self, 
        :display_text => 'Cover Image',
        :key => 'medium', 
        :url => cover_image, 
        :service_data => {:size => 'medium' }
      }, [ServiceTypeValue[:cover_image]])
    end
  end
  # Get holdings from Primo Searcher
  if @service_types.include?("holding") or @service_types.include?("primo_source")
    holdings = primo_searcher.holdings # Array of Exlibris::Primo::Holding
    holdings.each do |holding|
      next if @suppress_holdings.find {|suppress| suppress === holding.availlibrary}
      service_data = {}
      @holding_attributes.each do |attr|
        service_data[attr] = holding.method(attr).call
      end
      # Only add one service type, either "primo_source" OR "holding", not both.
      service_type = (@service_types.include?("primo_source")) ? "primo_source" : "holding"
      # Add some other holding information for compatibility with default holding partial
      service_data.merge!({ 
        :call_number => holding.call_number, :collection => holding.collection,
        :collection_str => "#{holding.library} #{holding.collection}",
        :coverage_str => holding.coverage.join("<br />"), 
        :coverage_str_array => holding.coverage }) if service_type.eql? "holding"
      request.add_service_response(
        { :service => self,
          :notes => service_data[:notes],
          :url => service_data[:url],
          :service_data => service_data }, [ service_type ] )
    end
    # Provide title search functionality in the absence of available holdings.
    if @service_types.include?("holding_search")
      if holdings.empty? and
         not primo_identifier? and 
         not title.nil?
        service_data = {}
        service_data[:type] = "link_to_search"
        service_data[:display_text] = (@holding_search_text.nil?) ? "Search for this title." : @holding_search_text
        service_data[:note] = ""
        service_data[:url] = @base_url+"/primo_library/libweb/action/dlSearch.do?institution=#{@holding_search_institution}&vid=#{@vid}&onCampus=false&query=#{CGI::escape("title,exact,"+title)}&indx=1&bulkSize=10&group=GUEST"
        request.add_service_response({
          :service => self,
          :display_text => service_data[:display_text],
          :notes =>service_data[:notes],
          :url => service_data[:url],
          :service_data => service_data }, ['holding_search'] )
      end
    end
  end
  # Get fulltext
  if @service_types.include?("fulltext")
    # Get RSRCs from Primo Searcher (executes search)
    # Let's find any URLs, and add full text responses for those.
    urls_seen = [] # for de-duplicating urls from catalog.
    primo_searcher.rsrcs.each do |rsrc|
      # No url? Forget it.
      next if rsrc.url.nil?
      # Next if duplicate.
      next if urls_seen.include?(rsrc.url)
      # Don't add the URL if it matches our SFXUrl finder (unless fulltext is empty, 
      # [assuming something is better than nothing]), because
      # that means we think this is an SFX controlled URL.
      next if SfxUrl.sfx_controls_url?(handle_ezproxy(rsrc.url)) and 
        request.referent.metadata['genre'] != "book" and 
          !request.get_service_type("fulltext", { :refresh => true }).empty?
      # We have our own list of URLs to suppress, array of strings
      # or regexps.
      next if @suppress_urls.find {|suppress| suppress === rsrc.url}
      urls_seen.push(rsrc.url)
      service_data = {}
      @rsrc_attributes.each do |attr|
        service_data[attr] = rsrc.method(attr).call
      end
      # Default display text to URL.
      service_data[:display_text] = (service_data[:display].nil?) ? service_data[:url] : service_data[:display]
      # Add the response
      request.add_service_response({
        :service => self,
        :display_text => service_data[:display_text],
        :url => service_data[:url],
        :notes => service_data[:notes],
        :service_data => service_data }, ['fulltext'] )
    end
  end
  # Get TOCs
  if @service_types.include?("table_of_contents")
    # Let's find any TOCs, and add table of contents responses for those.
    tocs_seen = [] # for de-duplicating urls from catalog.
    primo_searcher.tocs.each do |toc|
      url = toc.url # actual url
      next if tocs_seen.include?(toc.url)
      # We have our own list of URLs to suppress, array of strings
      # or regexps.
      next if @suppress_tocs.find {|suppress| suppress === toc.url}
      # No url? Forget it.
      next if toc.url.nil?
      tocs_seen.push(toc.url)
      service_data = {}
      @toc_attributes.each do |attr|
        service_data[attr] = toc.method(attr).call
      end
      # Default display text to URL.
      service_data[:display_text] = (service_data[:display].nil?) ? service_data[:url] : service_data[:display]
      # Add the response
      request.add_service_response({ 
        :service => self,
        :display_text => service_data[:display_text],
        :url => service_data[:url],
        :notes => service_data[:notes],
        :service_data => service_data }, ['table_of_contents'] )
    end
  end
  return request.dispatched(self, true)
end