Class: Alexandria::UI::NewBookDialog

Inherits:
BuilderBase show all
Extended by:
GetText
Includes:
ImageFetcher, Logging, GetText
Defined in:
lib/alexandria/ui/new_book_dialog.rb

Constant Summary collapse

@@last_criterion_was_not_isbn = 
false

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from ImageFetcher

#fetch_image

Methods included from Logging

included, #log

Constructor Details

#initialize(parent_window, ui_manager, selected_library, &block) ⇒ NewBookDialog

Returns a new instance of NewBookDialog.



27
28
29
30
31
32
33
34
35
36
37
 
# File 'lib/alexandria/ui/new_book_dialog.rb', line 27

def initialize(parent_window, ui_manager, selected_library, &block)
  super("new_book_dialog__builder.glade", widget_names)
  log.info { "New Book Dialog" }
  @new_book_dialog.transient_for = @parent = parent_window
  @ui_manager = ui_manager
  @block = block
  @destroyed = false
  @selected_library = selected_library
  setup_dialog_gui
  @progressbar.hide
end

Instance Attribute Details

#ui_manager ⇒ Object (readonly)

Returns the value of attribute ui_manager.



552
553
554
 
# File 'lib/alexandria/ui/new_book_dialog.rb', line 552

def ui_manager
  @ui_manager
end

Instance Method Details

#add_book_to_library(library, book, cover_uri) ⇒ Object 



411
412
413
414
415
 
# File 'lib/alexandria/ui/new_book_dialog.rb', line 411

def add_book_to_library(library, book, cover_uri)
  library.save_cover(book, cover_uri) unless cover_uri.nil?
  library << book
  library.save(book)
end

#add_selected_books(library, _is_new) ⇒ Object 



378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
 
# File 'lib/alexandria/ui/new_book_dialog.rb', line 378

def add_selected_books(library, _is_new)
  books_to_add = []
  @treeview_results.selection.each do |_model, _path, iter|
    @results.each do |book, cover|
      next unless book.ident == iter[1]

      isbn = book.isbn
      if isbn.nil? || isbn.empty?
        log.debug { "noisbn" }
        book.isbn = book.saved_ident = nil
        books_to_add << [book, cover]
        next
      end

      isbn = Library.canonicalise_ean(isbn)
      unless isbn
        log.debug { "invalidisbn #{book.isbn}" }
        next unless KeepBadISBNDialog.new(@new_book_dialog, book).keep?

        book.isbn = book.saved_ident = nil
      end

      book.isbn = isbn
      assert_not_exist(library, isbn)
      books_to_add << [book, cover]
    end
  end
  books_to_add.each do |book, cover_uri|
    add_book_to_library(library, book, cover_uri)
  end
  books_to_add.map(&:first) # array of Books only
end

#add_single_book_by_isbn(library, is_new) ⇒ Object 



333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
 
# File 'lib/alexandria/ui/new_book_dialog.rb', line 333

def add_single_book_by_isbn(library, is_new)
  # Perform the ISBN search via the providers.
  isbn = begin
           Library.canonicalise_isbn(@entry_isbn.text)
         rescue StandardError
           raise _("Couldn't validate the EAN/ISBN you " \
                   "provided.  Make sure it is written " \
                   "correctly, and try again.")
         end
  assert_not_exist(library, @entry_isbn.text)
  @button_add.sensitive = false
  notify_start_add_by_isbn
  GLib::Idle.add do
    @find_thread = Thread.new do
      log.info { "New @find_thread #{Thread.current}" }
      begin
        # MAJOR HACK, add this again...
        Alexandria::BookProviders.instance.add_observer(self)
        book, cover_url = Alexandria::BookProviders.isbn_search(isbn)

        notify_end_add_by_isbn

        if book
          log.debug { "adding book #{book} to library" }
          add_book_to_library(library, book, cover_url)
          @entry_isbn.text = ""

          post_addition([book], library, is_new)
        else
          post_addition([], library, is_new)
        end
      rescue Alexandria::BookProviders::NoResultsError => ex
        @find_error = ex.message
        @button_add.sensitive = true
        notify_end_add_by_isbn
      ensure
        Alexandria::BookProviders.instance.delete_observer(self)
        notify_end_add_by_isbn
      end
    end

    false
  end
end

#copy_results_to_treeview_model(results, model) ⇒ Object 



302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
 
# File 'lib/alexandria/ui/new_book_dialog.rb', line 302

def copy_results_to_treeview_model(results, model)
  results.each do |book, _cover_url|
    s = format(_("%s, by %s"), book.title, book.authors.join(", "))
    similar_books = results.find do |book2, _cover2|
      (book.title == book2.title) &&
        (book.authors == book2.authors)
    end
    s += " (#{book.edition}, #{book.publisher})" if similar_books.length > 1
    log.info { format(_("Copying %s into tree view."), book.title) }
    iter = model.append
    iter[0] = s
    iter[1] = book.ident
    iter[2] = Icons::BOOK
  end
end

#decode_cuecat(entry) ⇒ Object 



318
319
320
321
322
323
324
325
326
 
# File 'lib/alexandria/ui/new_book_dialog.rb', line 318

def decode_cuecat(entry)
  return unless entry.text =~ /^\..*?\..*?\.(.*?)\.$/

  tmp = Regexp.last_match[1].tr("a-zA-Z0-9+-", " -_")
  tmp = ((tmp.length * 3 / 4 + 32).to_i.chr << tmp).unpack1("u")
  tmp.chomp!("\000")
  entry.text = tmp.gsub!(/./) { |c| (c[0] ^ 67).chr }
  entry.text = "Bad scan result" if entry.text.count("^ -~") > 0
end

#destroyed? ⇒ Boolean

Returns:

  • (Boolean) 


548
549
550
 
# File 'lib/alexandria/ui/new_book_dialog.rb', line 548

def destroyed?
  @new_book_dialog.destroyed?
end

#get_images_async ⇒ Object 



161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
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
 
# File 'lib/alexandria/ui/new_book_dialog.rb', line 161

def get_images_async
  log.info { "get_images_async" }
  @images = {}
  @image_error = nil
  @image_thread = Thread.new do
    log.info { "New @image_thread #{Thread.current}" }
    begin
      @results.each_with_index do |result, i|
        uri = result[1]
        @images[i] = fetch_image(uri) if uri
      end
    rescue StandardError => ex
      log.error { "Couldn't download image: #{ex.class} #{ex}" }
      log.error { ex.backtrace.join("\n") }
      @image_error = ex.message
    end
  end

  GLib::Timeout.add(100) do
    if @image_error
      image_error_dialog(@image_error).display
      @image_error = nil
    else
      @images.each_pair do |key, value|
        @images.delete(key)

        next unless value

        loader = GdkPixbuf::PixbufLoader.new
        loader.last_write(value)
        pixbuf = loader.pixbuf

        if pixbuf.width > 1
          iter = @treeview_results.model.get_iter(key.to_s)
          unless @treeview_results.model.iter_is_valid?(iter)
            raise format(_("Iter is invalid! %s"), iter)
          end

          iter[2] = pixbuf # I bet you this is it!
        end
      rescue StandardError => ex
        image_error_dialog(ex.message).display
      end
    end

    # Stop if the image download thread has stopped.
    if @image_thread.alive?
      log.info { "@image_thread (#{@image_thread}) still alive." }
      true
    else
      log.info { "@image_thread (#{@image_thread}) asleep now." }
      false
    end
  end
end

#image_error_dialog(error) ⇒ Object 



154
155
156
157
158
159
 
# File 'lib/alexandria/ui/new_book_dialog.rb', line 154

def image_error_dialog(error)
  ErrorDialog.new(
    @parent,
    _("A problem occurred while downloading images"),
    error)
end

#notify_end_add_by_isbn ⇒ Object 



481
482
483
 
# File 'lib/alexandria/ui/new_book_dialog.rb', line 481

def notify_end_add_by_isbn
  ui_manager.stop_progress_bar_pulsing
end

#notify_start_add_by_isbn ⇒ Object 



477
478
479
 
# File 'lib/alexandria/ui/new_book_dialog.rb', line 477

def notify_start_add_by_isbn
  ui_manager.start_progress_bar_pulsing(self)
end

#on_add ⇒ Object 



443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
 
# File 'lib/alexandria/ui/new_book_dialog.rb', line 443

def on_add
  return unless @button_add.sensitive?

  @find_thread&.kill
  @image_thread&.kill

  begin
    libraries = LibraryCollection.instance.all_libraries
    library, is_new_library =
      @combo_libraries.selection_from_libraries(libraries)

    # book_was_added = false

    if @isbn_radiobutton.active?
      add_single_book_by_isbn(library, is_new_library)
    else
      books = add_selected_books(library, is_new_library)
      post_addition(books, library, is_new_library)
    end

    # Do not destroy if there is no addition.
    #          return unless book_was_added
  rescue StandardError => ex
    ErrorDialog.new(@new_book_dialog, _("Couldn't add the book"), ex.message).display
  end
  # books_to_add
end

#on_cancel ⇒ Object 



471
472
473
474
475
 
# File 'lib/alexandria/ui/new_book_dialog.rb', line 471

def on_cancel
  @find_thread&.kill
  @image_thread&.kill
  @new_book_dialog.destroy
end

#on_changed(entry) ⇒ Object 



148
149
150
151
152
 
# File 'lib/alexandria/ui/new_book_dialog.rb', line 148

def on_changed(entry)
  ok = !entry.text.strip.empty?
  decode_cuecat(@entry_isbn) if entry == @entry_isbn
  (entry == @entry_isbn ? @button_add : @button_find).sensitive = ok
end

#on_clicked(widget, event) ⇒ Object 



521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
 
# File 'lib/alexandria/ui/new_book_dialog.rb', line 521

def on_clicked(widget, event)
  if (event.event_type == :button_press) &&
      (event.button == 1)

    radio, target_widget, box2, box3 =
      case widget
      when @eventbox_entry_search
        [@title_radiobutton, @entry_search,
         @eventbox_combo_search, @eventbox_entry_isbn]
      when @eventbox_combo_search
        [@title_radiobutton, @combo_search,
         @eventbox_entry_search, @eventbox_entry_isbn]
      when @eventbox_entry_isbn
        [@isbn_radiobutton, @entry_isbn,
         @eventbox_entry_search, @eventbox_combo_search]
      end
    radio.active = true
    target_widget.grab_focus
    widget.above_child = false
    box2.above_child = box3.above_child = true
  end
end

#on_criterion_toggled(item) ⇒ Object 



104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
 
# File 'lib/alexandria/ui/new_book_dialog.rb', line 104

def on_criterion_toggled(item)
  log.debug { "on_criterion_toggled" }
  return unless item.active?

  # There used to be a strange effect here (pre SVN r1022).
  # When item is first toggled to "Search" the entry_search
  # field was unselectable. One used to have to click the dialog
  # title bar to be able to focus it again. Putting the GUI
  # modifications in an GLib::Idle.add block fixed the problem.

  is_isbn = item == @isbn_radiobutton
  if is_isbn
    GLib::Idle.add do
      @latest_size = @new_book_dialog.size
      @new_book_dialog.resizable = false
      @entry_isbn.grab_focus
      false
    end
  else
    GLib::Idle.add do
      @new_book_dialog.resizable = true
      @new_book_dialog.resize(*@latest_size) unless @latest_size.nil?
      @entry_search.grab_focus
      false
    end
  end
  @entry_isbn.sensitive = is_isbn
  @combo_search.sensitive = !is_isbn
  @entry_search.sensitive = !is_isbn
  @button_find.sensitive = !is_isbn
  @scrolledwindow.visible = !is_isbn
  on_changed(is_isbn ? @entry_isbn : @entry_search)
  unless is_isbn
    @button_add.sensitive =
      @treeview_results.selection.count_selected_rows > 0
  end

  # Remember the last criterion selected (so that we can re-select
  # it when the dialog opens again).
  @@last_criterion_was_not_isbn = !is_isbn

  # @new_book_dialog.present # attempted fix, bring dialog to foreground
end

#on_find ⇒ Object 



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
 
# File 'lib/alexandria/ui/new_book_dialog.rb', line 217

def on_find
  log.info { "on_find" }
  mode = case @combo_search.active
         when 0
           BookProviders::SEARCH_BY_TITLE
         when 1
           BookProviders::SEARCH_BY_AUTHORS
         when 2
           BookProviders::SEARCH_BY_KEYWORD
         end

  criterion = @entry_search.text.strip
  @treeview_results.model.clear
  log.info do
    format("TreeStore Model: %s columns; ref_counts: %s",
           @treeview_results.model.n_columns,
           @treeview_results.model.ref_count)
  end

  @find_error = nil
  @results = nil

  @find_thread&.kill
  @image_thread&.kill

  notify_start_add_by_isbn
  GLib::Idle.add do
    @find_thread = Thread.new do
      log.info { "New @find_thread #{Thread.current}" }
      begin
        Alexandria::BookProviders.instance.add_observer(self)
        @results = Alexandria::BookProviders.search(criterion, mode)

        log.info { "got #{@results.length} results" }
      rescue StandardError => ex
        @find_error = ex.message
      ensure
        Alexandria::BookProviders.instance.delete_observer(self)
        # notify_end_add_by_isbn
      end
    end
    false
  end

  GLib::Timeout.add(100) do
    # This block copies results into the tree view, or shows an
    # error if the search failed.

    # Err... continue == false if @find_error
    continue = if @find_error
                 ErrorDialog.new(@new_book_dialog,
                                 _("Unable to find matches for your search"),
                                 @find_error).display
                 false
               elsif @results
                 log.info { "Got results: #{@results[0]}..." }
                 copy_results_to_treeview_model(@results, @treeview_results.model)

                 # Kick off the image download thread.
                 if @find_thread.alive?
                   log.info { "@find_thread (#{@find_thread}) still alive." }
                   true
                 else
                   log.info { "@find_thread (#{@find_thread}) asleep now." }
                   # Not really async now.
                   get_images_async
                   false # continue == false if you get to here. Stop timeout.
                 end
               else
                 # Stop if the book find thread has stopped.
                 @find_thread.alive?
               end
    # continue == false if @find_error OR if results are returned
    # timeout ends if continue is false!

    # @find_thread.alive? happens after find_thread is done
    unless continue || @find_thread.alive? || @destroyed
      notify_end_add_by_isbn
      @button_add.sensitive = false
    end

    continue # timeout loop condition
  end
end

#on_focus ⇒ Object 



497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
 
# File 'lib/alexandria/ui/new_book_dialog.rb', line 497

def on_focus
  return unless @isbn_radiobutton.active? && @entry_isbn.text.strip.empty?

  clipboard = Gtk::Clipboard.get(Gdk::Selection::CLIPBOARD)
  text = clipboard.wait_for_text or return

  if Library.valid_isbn?(text) || Library.valid_ean?(text) ||
      Library.valid_upc?(text)
    GLib::Idle.add do
      @entry_isbn.text = text
      @entry_isbn.grab_focus
      @entry_isbn.select_region(0, -1) # select all...
      # @button_add.grab_focus
      false
    end
    log.debug { "Setting ISBN field to #{text}" }
    # FIXME: Get rid of this puts!
    puts text # required, strangely, to prevent GUI strangeness
    # above last checked with ruby-gnome2 0.17.1 2009-12-09
    # if this puts is commented out, the cursor disappears
    # from the @entry_isbn box... weird, ne? - CathalMagus
  end
end

#on_help ⇒ Object 



544
545
546
 
# File 'lib/alexandria/ui/new_book_dialog.rb', line 544

def on_help
  Alexandria::UI.display_help(@preferences_dialog, "add-book-by-isbn")
end

#on_results_button_press_event(_widget, event) ⇒ Object 



328
329
330
331
 
# File 'lib/alexandria/ui/new_book_dialog.rb', line 328

def on_results_button_press_event(_widget, event)
  # double left click
  on_add if (event.event_type == :"2button_press") && (event.button == 1)
end

#post_addition(books, library, is_new_library) ⇒ Object 



417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
 
# File 'lib/alexandria/ui/new_book_dialog.rb', line 417

def post_addition(books, library, is_new_library)
  log.debug { "post_addition #{books.size}" }
  return if books.empty?

  # books, a 1d array of Alexandria::Book
  @block.call(books, library, is_new_library)

  if @keep_open.active?
    # TODO: reset and clear fields
    if @@last_criterion_was_not_isbn
      @entry_search.select_region(0, -1) # select all, ready to delete
      @treeview_results.model.clear
      @entry_search.grab_focus
    else
      @button_add.sensitive = true
      @entry_isbn.text = "" # blank ISBN field
      @entry_isbn.grab_focus
    end

  else
    # Now we can destroy the dialog and go back to the main
    # application.
    @new_book_dialog.destroy
  end
end

#setup_dialog_gui ⇒ Object 



51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'lib/alexandria/ui/new_book_dialog.rb', line 51

def setup_dialog_gui
  libraries = LibraryCollection.instance.all_regular_libraries
  @selected_library = libraries.first if @selected_library.is_a?(SmartLibrary)
  @combo_libraries.populate_with_libraries(libraries,
                                           @selected_library)

  @treeview_results.model = Gtk::ListStore.new(String, String,
                                               GdkPixbuf::Pixbuf)
  @treeview_results.selection.mode = :multiple
  @treeview_results.selection.signal_connect("changed") do
    @button_add.sensitive = true
  end

  renderer = Gtk::CellRendererPixbuf.new
  col = Gtk::TreeViewColumn.new("", renderer)
  col.set_cell_data_func(renderer) do |_column, cell, _model, iter|
    pixbuf = iter[2]
    max_height = 25

    if pixbuf.height > max_height
      new_width = pixbuf.width * (max_height.to_f / pixbuf.height)
      pixbuf = pixbuf.scale(new_width, max_height)
    end

    cell.pixbuf = pixbuf
  end
  @treeview_results.append_column(col)

  col = Gtk::TreeViewColumn.new("", Gtk::CellRendererText.new,
                                text: 0)
  @treeview_results.append_column(col)

  @combo_search.active = 0

  # Re-select the last selected criterion.
  # TODO let's do this from a Gconf setting instead, maybe?
  @title_radiobutton.active = @@last_criterion_was_not_isbn

  if @@last_criterion_was_not_isbn
    @entry_search.grab_focus
  else
    @entry_isbn.grab_focus
  end

  @find_thread = nil
  @image_thread = nil

  @new_book_dialog.signal_connect("destroy") do
    @new_book_dialog.destroy
    @destroyed = true
  end
end

#show ⇒ Object 



39
40
41
 
# File 'lib/alexandria/ui/new_book_dialog.rb', line 39

def show
  @new_book_dialog.show
end

#update(status, provider) ⇒ Object 



485
486
487
488
489
490
491
492
493
494
495
 
# File 'lib/alexandria/ui/new_book_dialog.rb', line 485

def update(status, provider)
  messages = {
    searching: _("Searching Provider '%s'..."),
    error: _("Error while Searching Provider '%s'"),
    not_found: _("Not Found at Provider '%s'"),
    found: _("Found at Provider '%s'")
  }
  message = messages[status] % provider
  log.debug { "update message : #{message}" }
  ui_manager.set_status_label(message)
end

#widget_names ⇒ Object 



43
44
45
46
47
48
49
 
# File 'lib/alexandria/ui/new_book_dialog.rb', line 43

def widget_names
  [:new_book_dialog, :button_add, :button_cancel, :button_find,
   :button_help, :combo_libraries, :combo_search, :entry_isbn,
   :entry_search, :eventbox_combo_search, :eventbox_entry_isbn,
   :eventbox_entry_search, :isbn_radiobutton, :keep_open, :progressbar,
   :scrolledwindow, :title_radiobutton, :treeview_results]
end