diff --git a/openlp/core/common/uistrings.py b/openlp/core/common/uistrings.py index c84c3c600..283cd7251 100644 --- a/openlp/core/common/uistrings.py +++ b/openlp/core/common/uistrings.py @@ -164,26 +164,22 @@ class UiStrings(object): 'Please use the Import Wizard to install one or more Bibles.') # Scripture reference error combined from small translation stings by using itertools. book_chapter = translate('OpenLP.Ui', 'Book Chapter') - bc = book_chapter chapter = translate('OpenLP.Ui', 'Chapter') - cha = chapter verse = translate('OpenLP.Ui', 'Verse') - ver = verse gap = ' | ' psalm = translate('OpenLP.Ui', 'Psalm') may_shorten = translate('OpenLP.Ui', 'Book names may be shortened from full names, for an example Ps 23 = ' 'Psalm 23') - bible_scripture_items = [bc, gap, psalm, ' 23
', - bc, '%(range)s', cha, gap, psalm, ' 23%(range)s24
', - bc, '%(verse)s', ver, '%(range)s', ver, gap, psalm, ' 23%(verse)s1%(range)s2
', - bc, '%(verse)s', ver, '%(range)s', ver, '%(list)s', ver, '%(range)s', ver, gap, psalm, - ' 23%(verse)s1%(range)s2%(list)s5%(range)s6
', - bc, '%(verse)s', ver, '%(range)s', ver, '%(list)s', cha, '%(verse)s', ver, '%(range)s', - ver, gap, psalm, ' 23%(verse)s1%(range)s2%(list)s24%(verse)s1%(range)s3
', bc, - '%(verse)s', ver, '%(range)s', cha, '%(verse)s', ver, gap, psalm, - ' 23%(verse)s1%(range)s24%(verse)s1

', may_shorten] - itertools.chain.from_iterable(itertools.repeat(strings, 1) if isinstance(strings, str) else strings for strings - in bible_scripture_items) - bible_scripture_error_joined = ''.join(str(joined) for joined in bible_scripture_items) - # This is what gets called to other files. - self.BibleScriptureError = bible_scripture_error_joined + bible_scripture_items = \ + [book_chapter, gap, psalm, ' 23
', + book_chapter, '%(range)s', chapter, gap, psalm, ' 23%(range)s24
', + book_chapter, '%(verse)s', verse, '%(range)s', verse, gap, psalm, ' 23%(verse)s1%(range)s2
', + book_chapter, '%(verse)s', verse, '%(range)s', verse, '%(list)s', verse, '%(range)s', verse, gap, psalm, + ' 23%(verse)s1%(range)s2%(list)s5%(range)s6
', + book_chapter, '%(verse)s', verse, '%(range)s', verse, '%(list)s', chapter, '%(verse)s', verse, '%(range)s', + verse, gap, psalm, ' 23%(verse)s1%(range)s2%(list)s24%(verse)s1%(range)s3
', + book_chapter, '%(verse)s', verse, '%(range)s', chapter, '%(verse)s', verse, gap, psalm, + ' 23%(verse)s1%(range)s24%(verse)s1

', may_shorten] + itertools.chain.from_iterable(itertools.repeat(strings, 1) if isinstance(strings, str) + else strings for strings in bible_scripture_items) + self.BibleScriptureError = ''.join(str(joined) for joined in bible_scripture_items) diff --git a/openlp/plugins/bibles/lib/manager.py b/openlp/plugins/bibles/lib/manager.py index 03e24ee99..83f6b26bd 100644 --- a/openlp/plugins/bibles/lib/manager.py +++ b/openlp/plugins/bibles/lib/manager.py @@ -240,6 +240,7 @@ class BibleManager(RegistryProperties): """ Parses a scripture reference, fetches the verses from the Bible specified, and returns a list of ``Verse`` objects. + This function is called in \bibles\lib\mediaitem.py by def on_quick_search_button :param bible: Unicode. The Bible to use. :param verse_text: @@ -258,28 +259,20 @@ class BibleManager(RegistryProperties): :param show_error: """ log.debug('BibleManager.get_verses("%s", "%s")', bible, verse_text) + # If no bibles are installed, message is given. if not bible: if show_error: self.main_window.information_message( ('%s' % UiStrings().BibleNoBiblesTitle), ('%s' % UiStrings().BibleNoBibles)) return None + # Get the language for books. language_selection = self.get_language_selection(bible) ref_list = parse_reference(verse_text, self.db_cache[bible], language_selection, book_ref_id) if ref_list: return self.db_cache[bible].get_verses(ref_list, show_error) + # If nothing is found. Message is given if this is not combined search. (defined in mediaitem.py) else: - if show_error: - reference_separators = { - 'verse': get_reference_separator('sep_v_display'), - 'range': get_reference_separator('sep_r_display'), - 'list': get_reference_separator('sep_l_display')} - self.main_window.information_message( - translate('BiblesPlugin.BibleManager', 'Scripture Reference Error'), - translate('BiblesPlugin.BibleManager', 'OpenLP couldn’t find anything ' - 'with your search.

' - 'Please make sure that your reference follows one of these patterns:

%s' - % UiStrings().BibleScriptureError % reference_separators)) return None def get_language_selection(self, bible): @@ -305,12 +298,14 @@ class BibleManager(RegistryProperties): def verse_search(self, bible, second_bible, text): """ Does a verse search for the given bible and text. + This function is called in \bibles\lib\mediaitem.py by def on_quick_search_button. :param bible: The bible to search in (unicode). :param second_bible: The second bible (unicode). We do not search in this bible. :param text: The text to search for (unicode). """ log.debug('BibleManager.verse_search("%s", "%s")', bible, text) + # If no bibles are installed, message is given. if not bible: self.main_window.information_message( ('%s' % UiStrings().BibleNoBiblesTitle), @@ -322,6 +317,7 @@ class BibleManager(RegistryProperties): if second_bible: second_web_bible = self.db_cache[second_bible].get_object(BibleMeta, 'download_source') if web_bible or second_web_bible: + # If either Bible is Web, cursor is reset to normal and message is given. self.application.set_normal_cursor() self.main_window.information_message( translate('BiblesPlugin.BibleManager', 'Web Bible cannot be used'), @@ -329,33 +325,18 @@ class BibleManager(RegistryProperties): 'Please use the Scripture Reference Search instead.') ) return None + # Shorter than 3 char searches break OpenLP with very long search times, thus they are blocked. if len(text) - text.count(' ') < 3: self.main_window.information_message( ('%s' % UiStrings().BibleShortSearchTitle), ('%s' % UiStrings().BibleShortSearch)) return None + # Fetch the results from db. If no results are found, return None, no message is given for this. elif text: return self.db_cache[bible].verse_search(text) else: return None - def get_verses_combined(self, bible, verse_text, book_ref_id=False, show_error=True): - log.debug('BibleManager.get_verses("%s", "%s")', bible, verse_text) - if not bible: - if show_error: - if not bible: - self.main_window.information_message( - ('%s' % UiStrings().BibleNoBiblesTitle), - ('%s' % UiStrings().BibleNoBibles)) - return None - return None - language_selection = self.get_language_selection(bible) - ref_list = parse_reference(verse_text, self.db_cache[bible], language_selection, book_ref_id) - if ref_list: - return self.db_cache[bible].get_verses(ref_list, show_error) - else: - return None - def save_meta_data(self, bible, version, copyright, permissions, book_name_language=None): """ Saves the bibles meta data. diff --git a/openlp/plugins/bibles/lib/mediaitem.py b/openlp/plugins/bibles/lib/mediaitem.py index 6003a860a..91fd6bfd7 100644 --- a/openlp/plugins/bibles/lib/mediaitem.py +++ b/openlp/plugins/bibles/lib/mediaitem.py @@ -654,35 +654,57 @@ class BibleMediaItem(MediaManagerItem): def on_quick_reference_search(self): # We are doing a 'Reference Search'. + # Set Bibles to use the text input from Quick search field. bible = self.quickVersionComboBox.currentText() second_bible = self.quickSecondComboBox.currentText() # Get input from field and replace '. ' with '' # This will check if field has any '.' and removes them. Eg. Gen. 1 = Gen 1 = Genesis 1 - text_direct = self.quick_search_edit.text() - text = text_direct.replace('. ', ' ') - # If we are doing "Reference" search, use the search from manager.py + text = self.quick_search_edit.text() + text = text.replace('. ', ' ') + # This is triggered on reference search, use the search from manager.py if self.quick_search_edit.current_search_type() == BibleSearch.Reference: self.search_results = self.plugin.manager.get_verses(bible, text) - # If we are doing "Combined Reference" search, use the get_verses_combined from manager.py (No error included) - else: - self.search_results = self.plugin.manager.get_verses_combined(bible, text) + if not self.search_results: + # if nothing is found, message is given. + # Get reference separators from settings. + reference_separators = { + 'verse': get_reference_separator('sep_v_display'), + 'range': get_reference_separator('sep_r_display'), + 'list': get_reference_separator('sep_l_display')} + self.main_window.information_message( + translate('BiblesPlugin.BibleManager', 'Scripture Reference Error'), + translate('BiblesPlugin.BibleManager', 'OpenLP couldn’t find anything ' + 'with your search.

' + 'Please make sure that your reference follows one of these patterns:

%s' + % UiStrings().BibleScriptureError % reference_separators)) + elif self.quick_search_edit.current_search_type() == BibleSearch.Combined: + # In Combined Reference search no error is given if no results are found. (This would result in duplicate) + self.search_results = self.plugin.manager.get_verses(bible, text) if second_bible and self.search_results: self.second_search_results = \ self.plugin.manager.get_verses(second_bible, text, self.search_results[0].book.book_reference_id) def on_quick_text_search(self): # We are doing a 'Text Search'. + # Set Bibles to use the text input from Quick search field. bible = self.quickVersionComboBox.currentText() second_bible = self.quickSecondComboBox.currentText() text = self.quick_search_edit.text() + # This changes the curson to "Loading animation" self.application.set_busy_cursor() + # Get Bibles list bibles = self.plugin.manager.get_bibles() + # Add results to "search_results" self.search_results = self.plugin.manager.verse_search(bible, second_bible, text) if second_bible and self.search_results: + # Set up variables, + # new_search_results is needed to make sure 2nd bible contains all verses. (And counting them on error) text = [] new_search_results = [] count = 0 passage_not_found = False + # Search second bible for results of search_results to make sure everythigns there. + # Count all the unfound passages. for verse in self.search_results: db_book = bibles[second_bible].get_book_by_book_ref_id(verse.book.book_reference_id) if not db_book: @@ -694,23 +716,27 @@ class BibleMediaItem(MediaManagerItem): new_search_results.append(verse) text.append((verse.book.book_reference_id, verse.chapter, verse.verse, verse.verse)) if passage_not_found: + # This is for the 2nd Bible. self.main_window.information_message( translate('BiblesPlugin.MediaItem', 'Information'), translate('BiblesPlugin.MediaItem', 'The second Bible does not contain all the verses ' 'that are in the main Bible. Only verses found in both Bibles ' 'will be shown. %d verses have not been included ' 'in the results.') % count) + # Join the searches so only verses that are found on both Bibles are shown. self.search_results = new_search_results self.second_search_results = bibles[second_bible].get_verses(text) def on_quick_search_button(self): """ - Does a quick search and saves the search results. Quick search can be: - "Reference Search" or "Text Search" or Combined search. + This triggers the proper Quick search based on which search type is used. + "Eg. "Reference Search", "Text Search" or "Combined search". """ log.debug('Quick Search Button clicked') + # Disable the button while processing, get text from Quick search field. self.quickSearchButton.setEnabled(False) self.application.process_events() + # These need to be defined here too so the search results can be displayed. bible = self.quickVersionComboBox.currentText() second_bible = self.quickSecondComboBox.currentText() text = self.quick_search_edit.text() @@ -720,20 +746,21 @@ class BibleMediaItem(MediaManagerItem): elif self.quick_search_edit.current_search_type() == BibleSearch.Text: # We are doing a 'Text Search'. (Get script from def on_quick_text_search) self.on_quick_text_search() - # Combined search, starting with reference search. elif self.quick_search_edit.current_search_type() == BibleSearch.Combined: + # We are doing a 'Combined search'. Starting with reference search. self.on_quick_reference_search() - # If keyword is shorter than 3 (not including spaces), message is given and search is finalized. - # It's actually to find verses with less than 3 chars (Eg. G1 = Genesis 1) thus this error is not shown if - # any results are found. This check needs to be here in order to avoid duplicate errors. - # if no Bibles are installed, this message is not shown - "No bibles" message is whon instead. (and bible) + # If results are found, search will be finalized. + # This check needs to be here in order to avoid duplicate errors. + # If keyword is shorter than 3 (not including spaces), message is given. It's actually possible to find + # verses with less than 3 chars (Eg. G1 = Genesis 1) thus this error is not shown if any results are found. + # if no Bibles are installed, this message is not shown - "No bibles" message is shown instead. (and bible) if not self.search_results and len(text) - text.count(' ') < 3 and bible: self.main_window.information_message( ('%s' % UiStrings().BibleShortSearchTitle), ('%s' % UiStrings().BibleShortSearch)) - # Text search starts here if no reference was found and keyword is longer than 2. - # This is required in order to avoid duplicate error messages for short keywords. if not self.search_results and len(text) - text.count(' ') > 2 and bible: + # Text search starts here if no reference was found and keyword is longer than 2. + # > 2 check is required in order to avoid duplicate error messages for short keywords. self.on_quick_text_search() # If no Text or Reference is found, message is given. if not self.search_results and not \ @@ -744,23 +771,16 @@ class BibleMediaItem(MediaManagerItem): 'range': get_reference_separator('sep_r_display'), 'list': get_reference_separator('sep_l_display')} self.main_window.information_message(translate('BiblesPlugin.BibleManager', 'Nothing found'), - translate('BiblesPlugin.BibleManager', 'OpenLP ' - 'couldn’t find ' - 'anything with your' - ' search.' - '

' - 'If you tried to ' - 'search with ' - 'Scripture ' - 'Reference, please ' - 'make
sure that ' - 'your reference ' - 'follows one of ' - 'these patterns:' - '

%s' + translate('BiblesPlugin.BibleManager', + 'OpenLP couldn’t find anything with your' + ' search.

If you tried to search' + ' with Scripture Reference, please make
sure' + ' that your reference follows one of these' + ' patterns:

%s' % UiStrings().BibleScriptureError % reference_separators)) # Finalizing the search + # List is cleared if not locked, results are listed, button is set available, cursor is set to normal. if not self.quickLockButton.isChecked(): self.list_view.clear() if self.list_view.count() != 0 and self.search_results: