Merge lp:~suutari-olli/openlp/click-slide-to-go-live-from-blank into lp:openlp

[Azaziah]

This branch introduces the functionality of unblanking
display from Blank to Black/Theme/Desktop for:

a) Clicking slide in "Live panel"
b) Next/Previous shortcuts (Green arrows)
c) Go to verse x.
d) When starting automatic playback (To end or Loop)
Also added "Unblank display when changing slide in Live" to general
options tab for disabling/enabling this behavior for a-c.

Additionally this branch also includes fix for bug
https://bugs.launchpad.net/openlp/+bug/1531691
Do note that this branch does not fix this for Escape item blanking,
creating yet an another Escape exclusive bug.

-----------------------------------------------------------------------------
The only reason Escape item has been a good alternative for other
blank to methods is the functionality of resuming Live by clicking
slides and the fact it worked in single screen scenarios.
I can’t see any reason why it should not be removed after this branch
is merged since the single screen issue was already fixed earlier.

-----------------------------------------------------------------------------

lp:~suutari-olli/openlp/click-slide-to-go-live-from-blank (revision 2664)
[SUCCESS] https://ci.openlp.io/job/Branch-01-Pull/1712/
[SUCCESS] https://ci.openlp.io/job/Branch-02-Functional-Tests/1623/
[SUCCESS] https://ci.openlp.io/job/Branch-03-Interface-Tests/1561/
[SUCCESS] https://ci.openlp.io/job/Branch-04a-Windows_Functional_Tests/1323/
[SUCCESS] https://ci.openlp.io/job/Branch-04b-Windows_Interface_Tests/913/
[SUCCESS] https://ci.openlp.io/job/Branch-05a-Code_Analysis/981/
[SUCCESS] https://ci.openlp.io/job/Branch-05b-Test_Coverage/849/
[SUCCESS] https://ci.openlp.io/job/Branch-05c-Code_Analysis2/26/

[Tomas Groth (tomasgroth)]

Just tested a bit.
You have introduced the "Click live slide to unblank" setting, but a "Unblank display when adding new item" also exists in the general tab. You should probably move yours to be under the exiting one to keep similar settings in the same place. Currently your code doesn't honor the "Unblank display when adding new item", which it will have to do. As it is now the item goes live no matter if the setting is enabled or not.
Also the new setting should be "false" as default, this is new behavior, so users should enabled it if they want it.
Also added a code-comment below.

review: Needs Fixing

[Azaziah (suutari-olli)]

Hi Tomas and thank you for your comments!

"Unblank display when adding new item" also exists in the general tab. You should probably move yours to be under the exiting one to keep similar settings in the same place. Currently your code doesn't honor the "Unblank display when adding new item

# Done and Done, now also honoring double clicking preview

Also the new setting should be "false" as default, this is new behavior, so users should enabled it if they want it.

# Done
# Currently this is default behavior for Escape item and probably easier
to use than our current blank to modes. I think this and some other settings
should eventually be changed to be more user friendly by default.

[Tomas Groth (tomasgroth)]

Looks good now. As you mention in one of your source-comments the previous slide is shortly visible when display is unblanked. Don't know if it can be helped.
Added a comment to the code below.
Besides that, you need tests :)

review: Needs Fixing

[Azaziah (suutari-olli)]

Thanks again,

if by previous slide being shortly visible you mean it happens once you change slide inside the Live Panel
and the transition effect is applied, yes that can be changed. I've heard people complaining there's no transition effects when unblanking or changing items so maybe it should be left as it is since it would mean loosing effects.

If you were talking about this happening on song edit:
Think it would be possible but would require quite a effort,
maybe we can let it pass for the time being, it's still mostly fixed.

I really suck at writing tests, is one enough for a rookie?

I also replied to the code comment.

[Raoul Snyman (raoul-snyman)]

Looks good to me. Nice tests.

review: Approve

[Tim Bentley (trb143)]

Couple of tests and some tests are needed.

review: Needs Fixing

[Azaziah (suutari-olli)]

I need to start working on tests...

Fixed the diff comments.

[Raoul Snyman (raoul-snyman)]

Check my comment. I'll try to look at this more in-depth over the weekend and give you more feedback.

review: Needs Fixing

[Azaziah (suutari-olli)]

> Check my comment. I'll try to look at this more in-depth over the weekend and
> give you more feedback.

Thank you for checking this out, I've replied to your comment.

I'm away from my coding station until next week, so no new commits
(if required) will be made until then.

I wish you all the best for your day.

[Azaziah (suutari-olli)]

I noticed the comment was not saved, so here it is. ^^ Sorry about that :/

[Azaziah (suutari-olli)]

I commented on replace live item function and resetting the setting.

[Raoul Snyman (raoul-snyman)]

I still do not agree with using settings for temporary flags. Find another way.

review: Needs Fixing

[Azaziah (suutari-olli)]

"I still do not agree with using settings for temporary flags. Find another way."

Well I can't think of an other way.

I tried to fix: https://bugs.launchpad.net/openlp/+bug/1531691 without settings,
but it didn't work properly and was way more complex.

Since we need to trigger actions in many files/functions based on temporary flags,
what would be a proper solution without the use of settings?

Also replied to diff comments.

Thank you for your review.

[Raoul Snyman (raoul-snyman)]

I've just merged the flags section of the Registry object.

Having said that, and looking at your branch, I'm not entirely convinced this is the way to go about this. While you can explain to me what the difference is between this and the other auto-unblank setting, you can't explain it to our users, and I refuse to be lumped with the problem (I'm about the only person who actually actively deals with our users).

I recommend rather merging this with the current "auto-unblank" setting and make a single setting with a set of modes instead.

review: Needs Information

[Azaziah (suutari-olli)]

> I've just merged the flags section of the Registry object.
>
> Having said that, and looking at your branch, I'm not entirely convinced this
> is the way to go about this. While you can explain to me what the difference
> is between this and the other auto-unblank setting, you can't explain it to
> our users, and I refuse to be lumped with the problem (I'm about the only
> person who actually actively deals with our users).
>
> I recommend rather merging this with the current "auto-unblank" setting and
> make a single setting with a set of modes instead.

I'll be looking forward to moving the flags to registry.

This branch adds the unblanking of display by clicking slides in Live.

Currently this is possible when using Escape item, but not while using the real blank to modes.
The current behavior is highly confusing.
This setting will make things more understandable and easier to manage.

So ultimately this just makes it possible for users to easily resume Live presentation by clicking a slide they wish to show.

It's not related to sending items to Live, It's more about unblanking display and resuming the projection of the current Live item. Thus they are a very different thing.

After this is merged, I think we should begin working on removing the Escape item,
It's very much a broken and confusing format.

I am sorry about the current user support situation, hope things will be better someday.
Ultimately it would be great if the customer support would be something you wouldn't have to do.

[Tim Bentley (trb143)]

Traceback (most recent call last):
  File "/home/tim/Projects/OpenLP/openlp/click-slide-to-go-live-from-blank/openlp/core/ui/slidecontroller.py", line 1401, in on_preview_double_click
    elif not Registry().get_flag('has doubleclick added item to service') is True:
  File "/home/tim/Projects/OpenLP/openlp/click-slide-to-go-live-from-blank/openlp/core/common/registry.py", line 160, in get_flag
    raise KeyError('Working Flag {key} not found in list'.format(key=key))
KeyError: 'Working Flag has doubleclick added item to service not found in list'

Blank live and double click on a preview slide.

review: Needs Fixing

[Azaziah (suutari-olli)]

I am unable to reproduce this traceback,
need to investigate further.

Fixed the commented stuff.

Thank you for the review.

[Azaziah (suutari-olli)]

> Traceback (most recent call last):
> File "/home/tim/Projects/OpenLP/openlp/click-slide-to-go-live-from-
> blank/openlp/core/ui/slidecontroller.py", line 1401, in
> on_preview_double_click
> elif not Registry().get_flag('has doubleclick added item to service') is
> True:
> File "/home/tim/Projects/OpenLP/openlp/click-slide-to-go-live-from-
> blank/openlp/core/common/registry.py", line 160, in get_flag
> raise KeyError('Working Flag {key} not found in list'.format(key=key))
> KeyError: 'Working Flag has doubleclick added item to service not found in
> list'
>
> Blank live and double click on a preview slide.

Fixed this,
also removed the ??? if statement.

[Raoul Snyman (raoul-snyman)]

review: Approve

[Tim Bentley (trb143)]

review: Approve

[Tim Bentley (trb143)]

Sorry but needs to respin and other merges have broken this

review: Needs Fixing

[Raoul Snyman (raoul-snyman)]

review: Approve

[Tim Bentley (trb143)]

review: Approve

=== modified file 'openlp/core/common/settings.py'
--- openlp/core/common/settings.py	2016-07-01 21:17:20 +0000
+++ openlp/core/common/settings.py	2016-08-10 18:57:47 +0000
@@ -141,6 +141,7 @@
         'core/auto preview': False,
         'core/audio start paused': True,
         'core/auto unblank': False,
+        'core/click live slide to unblank': False,
         'core/blank warning': False,
         'core/ccli number': '',
         'core/has run wizard': False,
 
=== modified file 'openlp/core/lib/mediamanageritem.py'
--- openlp/core/lib/mediamanageritem.py	2016-06-12 22:02:24 +0000
+++ openlp/core/lib/mediamanageritem.py	2016-08-10 18:57:47 +0000
@@ -488,6 +488,7 @@
                                                         'You must select one or more items to preview.'))
         else:
             log.debug('%s Preview requested' % self.plugin.name)
+            Registry().set_flag('has doubleclick added item to service', False)
             service_item = self.build_service_item()
             if service_item:
                 service_item.from_plugin = True
 
=== modified file 'openlp/core/ui/generaltab.py'
--- openlp/core/ui/generaltab.py	2016-07-24 20:20:25 +0000
+++ openlp/core/ui/generaltab.py	2016-08-10 18:57:47 +0000
@@ -209,6 +209,9 @@
         self.auto_unblank_check_box = QtWidgets.QCheckBox(self.settings_group_box)
         self.auto_unblank_check_box.setObjectName('auto_unblank_check_box')
         self.settings_layout.addRow(self.auto_unblank_check_box)
+        self.click_live_slide_to_unblank_check_box = QtWidgets.QCheckBox(self.settings_group_box)
+        self.click_live_slide_to_unblank_check_box.setObjectName('click_live_slide_to_unblank')
+        self.settings_layout.addRow(self.click_live_slide_to_unblank_check_box)
         self.auto_preview_check_box = QtWidgets.QCheckBox(self.settings_group_box)
         self.auto_preview_check_box.setObjectName('auto_preview_check_box')
         self.settings_layout.addRow(self.auto_preview_check_box)
@@ -258,6 +261,8 @@
         self.settings_group_box.setTitle(translate('OpenLP.GeneralTab', 'Application Settings'))
         self.save_check_service_check_box.setText(translate('OpenLP.GeneralTab',
                                                   'Prompt to save before starting a new service'))
+        self.click_live_slide_to_unblank_check_box.setText(translate('OpenLP.GeneralTab',
+                                                           'Unblank display when changing slide in Live'))
         self.auto_unblank_check_box.setText(translate('OpenLP.GeneralTab', 'Unblank display when sending '
                                                                            'items to Live'))
         self.auto_preview_check_box.setText(translate('OpenLP.GeneralTab',
@@ -293,6 +298,7 @@
         self.password_edit.setText(settings.value('songselect password'))
         self.save_check_service_check_box.setChecked(settings.value('save prompt'))
         self.auto_unblank_check_box.setChecked(settings.value('auto unblank'))
+        self.click_live_slide_to_unblank_check_box.setChecked(settings.value('click live slide to unblank'))
         self.display_on_monitor_check.setChecked(self.screens.display)
         self.warning_check_box.setChecked(settings.value('blank warning'))
         self.auto_open_check_box.setChecked(settings.value('auto open'))
@@ -337,6 +343,7 @@
         settings.setValue('update check', self.check_for_updates_check_box.isChecked())
         settings.setValue('save prompt', self.save_check_service_check_box.isChecked())
         settings.setValue('auto unblank', self.auto_unblank_check_box.isChecked())
+        settings.setValue('click live slide to unblank', self.click_live_slide_to_unblank_check_box.isChecked())
         settings.setValue('auto preview', self.auto_preview_check_box.isChecked())
         settings.setValue('loop delay', self.timeout_spin_box.value())
         settings.setValue('ccli number', self.number_edit.displayText())
 
=== modified file 'openlp/core/ui/slidecontroller.py'
--- openlp/core/ui/slidecontroller.py	2016-07-24 20:20:25 +0000
+++ openlp/core/ui/slidecontroller.py	2016-08-10 18:57:47 +0000
@@ -87,6 +87,8 @@
         self.is_live = False
         self.display = None
         self.controller_type = None
+        Registry().set_flag('has doubleclick added item to service', True)
+        Registry().set_flag('replace service manager item', False)
 
     def send_to_plugins(self, *args):
         """
@@ -796,12 +798,15 @@
 
     def replace_service_manager_item(self, item):
         """
-        Replacement item following a remote edit
+        Replacement item following a remote edit.
+        This action  also takes place when a song that is sent to live from Service Manager is edited.
 
         :param item: The current service item
         """
         if item == self.service_item:
+            Registry().set_flag('replace service manager item', True)
             self._process_item(item, self.preview_widget.current_slide_number())
+            Registry().set_flag('replace service manager item', False)
 
     def add_service_manager_item(self, item, slide_no):
         """
@@ -970,9 +975,10 @@
 
     def on_slide_unblank(self):
         """
-        Handle the slidecontroller unblank event
+        Handle the slidecontroller unblank event.
         """
-        self.on_blank_display(False)
+        if not Registry().get_flag('replace service manager item') is True:
+            self.on_blank_display(False)
 
     def on_blank_display(self, checked=None):
         """
@@ -1103,6 +1109,11 @@
                 self.log_debug('Could not get lock in slide_selected after waiting %f, skip to avoid deadlock.'
                                % timeout)
             return
+        # If "click live slide to unblank" is enabled, unblank the display. And start = Item is sent to Live.
+        # Note: If this if statement is placed at the bottom of this function instead of top slide transitions are lost.
+        if self.is_live and Settings().value('core/click live slide to unblank'):
+            if not start:
+                Registry().execute('slidecontroller_live_unblank')
         row = self.preview_widget.current_slide_number()
         old_selected_row = self.selected_row
         self.selected_row = 0
@@ -1285,6 +1296,8 @@
             self.play_slides_once.setText(UiStrings().PlaySlidesToEnd)
             self.play_slides_menu.setDefaultAction(self.play_slides_loop)
             self.play_slides_once.setChecked(False)
+            if Settings().value('core/click live slide to unblank'):
+                Registry().execute('slidecontroller_live_unblank')
         else:
             self.play_slides_loop.setIcon(build_icon(':/media/media_time.png'))
             self.play_slides_loop.setText(UiStrings().PlaySlidesInLoop)
@@ -1308,6 +1321,8 @@
             self.play_slides_loop.setText(UiStrings().PlaySlidesInLoop)
             self.play_slides_menu.setDefaultAction(self.play_slides_once)
             self.play_slides_loop.setChecked(False)
+            if Settings().value('core/click live slide to unblank'):
+                Registry().execute('slidecontroller_live_unblank')
         else:
             self.play_slides_once.setIcon(build_icon(':/media/media_time'))
             self.play_slides_once.setText(UiStrings().PlaySlidesToEnd)
@@ -1362,7 +1377,7 @@
         Triggered when a preview slide item is doubleclicked
         """
         if self.service_item:
-            if Settings().value('advanced/double click live'):
+            if Settings().value('advanced/double click live') and Settings().value('core/auto unblank'):
                 # Live and Preview have issues if we have video or presentations
                 # playing in both at the same time.
                 if self.service_item.is_command():
@@ -1371,8 +1386,13 @@
                 if self.service_item.is_media():
                     self.on_media_close()
                 self.on_go_live()
-            else:
+            # If ('advanced/double click live') is not enabled, double clicking preview adds the item to Service.
+            # Prevent same item in preview from being sent to Service multiple times.
+            # Changing the preview slide resets this flag to False.
+            # Do note that this still allows to add item to Service multiple times if icon is clicked.
+            elif not Registry().get_flag('has doubleclick added item to service') is True:
                 self.on_preview_add_to_service()
+                Registry().set_flag('has doubleclick added item to service', True)
 
     def on_go_live(self, field=None):
         """
 
=== modified file 'openlp/plugins/presentations/lib/messagelistener.py'
--- openlp/plugins/presentations/lib/messagelistener.py	2016-07-01 21:17:20 +0000
+++ openlp/plugins/presentations/lib/messagelistener.py	2016-08-10 18:57:47 +0000
@@ -26,7 +26,7 @@
 
 from PyQt5 import QtCore
 
-from openlp.core.common import Registry
+from openlp.core.common import Registry, Settings
 from openlp.core.ui import HideMode
 from openlp.core.lib import ServiceItemContext
 from openlp.plugins.presentations.lib.pdfcontroller import PDF_CONTROLLER_FILETYPES
@@ -419,6 +419,8 @@
         is_live = message[1]
         if is_live:
             self.live_handler.next()
+            if Settings().value('core/click live slide to unblank'):
+                Registry().execute('slidecontroller_live_unblank')
         else:
             self.preview_handler.next()
 
@@ -431,6 +433,8 @@
         is_live = message[1]
         if is_live:
             self.live_handler.previous()
+            if Settings().value('core/click live slide to unblank'):
+                Registry().execute('slidecontroller_live_unblank')
         else:
             self.preview_handler.previous()
 
 
=== modified file 'tests/functional/openlp_core_ui/test_slidecontroller.py'
--- tests/functional/openlp_core_ui/test_slidecontroller.py	2016-06-01 21:42:54 +0000
+++ tests/functional/openlp_core_ui/test_slidecontroller.py	2016-08-10 18:57:47 +0000
@@ -713,6 +713,52 @@
             slide_controller.theme_screen, slide_controller.blank_screen
         ])
 
+    @patch('openlp.core.ui.slidecontroller.Settings')
+    def on_preview_double_click_unblank_display_test(self, MockedSettings):
+        # GIVEN: A slide controller, actions needed, settins set to True.
+        slide_controller = SlideController(None)
+        mocked_settings = MagicMock()
+        mocked_settings.return_value = True
+        MockedSettings.return_value = mocked_settings
+        slide_controller.service_item = MagicMock()
+        slide_controller.service_item.is_media = MagicMock()
+        slide_controller.on_media_close = MagicMock()
+        slide_controller.on_go_live = MagicMock()
+        slide_controller.on_preview_add_to_service = MagicMock()
+        slide_controller.media_reset = MagicMock()
+        Registry.create()
+        Registry().set_flag('has doubleclick added item to service', True)
+
+        # WHEN: on_preview_double_click is called
+        slide_controller.on_preview_double_click()
+
+        # THEN: The call to addActions should be correct
+        self.assertEqual(1, slide_controller.on_go_live.call_count, 'on_go_live should have been called once.')
+        self.assertEqual(0, slide_controller.on_preview_add_to_service.call_count, 'Should have not been called.')
+
+    @patch('openlp.core.ui.slidecontroller.Settings')
+    def on_preview_double_click_add_to_service_test(self, MockedSettings):
+        # GIVEN: A slide controller, actions needed, settins set to False.
+        slide_controller = SlideController(None)
+        mocked_settings = MagicMock()
+        mocked_settings.value.return_value = False
+        MockedSettings.return_value = mocked_settings
+        slide_controller.service_item = MagicMock()
+        slide_controller.service_item.is_media = MagicMock()
+        slide_controller.on_media_close = MagicMock()
+        slide_controller.on_go_live = MagicMock()
+        slide_controller.on_preview_add_to_service = MagicMock()
+        slide_controller.media_reset = MagicMock()
+        Registry.create()
+        Registry().set_flag('has doubleclick added item to service', False)
+
+        # WHEN: on_preview_double_click is called
+        slide_controller.on_preview_double_click()
+
+        # THEN: The call to addActions should be correct
+        self.assertEqual(0, slide_controller.on_go_live.call_count, 'on_go_live Should have not been called.')
+        self.assertEqual(1, slide_controller.on_preview_add_to_service.call_count, 'Should have been called once.')
+
     @patch(u'openlp.core.ui.slidecontroller.SlideController.image_manager')
     @patch(u'PyQt5.QtCore.QTimer.singleShot')
     def test_update_preview_live(self, mocked_singleShot, mocked_image_manager):