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

Proposed by Azaziah on 2016-07-16
Status: Superseded
Proposed branch: lp:~suutari-olli/openlp/click-slide-to-go-live-from-blank
Merge into: lp:openlp
Diff against target: 247 lines (+85/-6)
6 files modified
openlp/core/common/settings.py (+1/-0)
openlp/core/lib/mediamanageritem.py (+1/-0)
openlp/core/ui/generaltab.py (+7/-0)
openlp/core/ui/slidecontroller.py (+25/-5)
openlp/plugins/presentations/lib/messagelistener.py (+5/-1)
tests/functional/openlp_core_ui/test_slidecontroller.py (+46/-0)
To merge this branch: bzr merge lp:~suutari-olli/openlp/click-slide-to-go-live-from-blank
Reviewer Review Type Date Requested Status
Tim Bentley 2016-07-16 Needs Fixing on 2016-07-16
Tomas Groth 2016-07-16 Pending
Raoul Snyman 2016-07-16 Pending
Review via email: mp+300257@code.launchpad.net

This proposal supersedes a proposal from 2016-07-15.

This proposal has been superseded by a proposal from 2016-07-17.

Description of the change

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 advanced
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.

-----------------------------------------------------------------------------
Added 3 tests for checking display is re-blanked if it was
blanked before re-processing edited Live item.
Also fixed the issue where Next/Previous slide does not
unblank display for PowerPoint/Impress.

-----------------------------------------------------------------------------
Better fix for bug where display is unblanked on editing current live item.
This now sets a hidden setting to true while processing Live item and then changes it back to false.
Display is thus not unblanked at all during the process. (Old fix showed the edited slide for a small time)

Downside: All the new tests were based on the old
method and thus they were removed.

Fixed bug 1462420 (Double clicking preview adds items to service unlimited times)
- Added a hidden setting for controlling this behavior.
  It is reset if any item is sent to preview from library.
- Sending the same item to service multiple times is still
  possible by using the "Add button (icon)"
-----------------------------------------------------------------------------
- Added two tests for checking if doubleclicking preview should
  add item to service or send it to live.
-----------------------------------------------------------------------------

lp:~suutari-olli/openlp/click-slide-to-go-live-from-blank (revision 2656)
[←[1;32mSUCCESS←[1;m] https://ci.openlp.io/job/Branch-01-Pull/1648/
[←[1;32mSUCCESS←[1;m] https://ci.openlp.io/job/Branch-02-Functional-Tests/1559/
[←[1;32mSUCCESS←[1;m] https://ci.openlp.io/job/Branch-03-Interface-Tests/1497/
[←[1;32mSUCCESS←[1;m] https://ci.openlp.io/job/Branch-04a-Windows_Functional_Tests/1263/
[←[1;32mSUCCESS←[1;m] https://ci.openlp.io/job/Branch-04b-Windows_Interface_Tests/853/
[←[1;32mSUCCESS←[1;m] https://ci.openlp.io/job/Branch-05a-Code_Analysis/921/
[←[1;32mSUCCESS←[1;m] https://ci.openlp.io/job/Branch-05b-Test_Coverage/789/

To post a comment you must log in.
Tomas Groth (tomasgroth) wrote : Posted in a previous version of this proposal

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) wrote : Posted in a previous version of this proposal

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) wrote : Posted in a previous version of this proposal

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) wrote : Posted in a previous version of this proposal

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) wrote : Posted in a previous version of this proposal

Looks good to me. Nice tests.

review: Approve
Tim Bentley (trb143) wrote : Posted in a previous version of this proposal

Couple of tests and some tests are needed.

review: Needs Fixing
Azaziah (suutari-olli) wrote : Posted in a previous version of this proposal

I need to start working on tests...

Fixed the diff comments.

Raoul Snyman (raoul-snyman) wrote : Posted in a previous version of this proposal

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) wrote : Posted in a previous version of this proposal

> 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) wrote : Posted in a previous version of this proposal

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

Azaziah (suutari-olli) wrote : Posted in a previous version of this proposal

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

Raoul Snyman (raoul-snyman) wrote : Posted in a previous version of this proposal

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

review: Needs Fixing
Azaziah (suutari-olli) wrote : Posted in a previous version of this proposal

"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) wrote : Posted in a previous version of this proposal

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) wrote : Posted in a previous version of this proposal

> 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) wrote :

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
2657. By Azaziah on 2016-07-16

- Reduced comments
- Removed unrequired reg_value from test.

Azaziah (suutari-olli) wrote :

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

Fixed the commented stuff.

Thank you for the review.

2658. By Azaziah on 2016-07-17

- Fixed the issue where items sent to Preview from Service may cause tracebacks.

2659. By Azaziah on 2016-07-17

- Moved the 2nd new registry flag from one init to an another init which also has the 1st

2660. By Azaziah on 2016-07-17

- Moved them to another init since something broke

2661. By Azaziah on 2016-07-17

- removed one unrequired if statement.

Azaziah (suutari-olli) wrote :

> 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.

2662. By Azaziah on 2016-07-31

- Merged trunk on 31.7.16

2663. By Azaziah on 2016-08-09

- Merged trunk on 10/8/16.

2664. By Azaziah on 2016-08-10

- Merged trunk and resolved conflict that was created by ui-messages-part-1 branch.

Unmerged revisions

Preview Diff

[H/L] Next/Prev Comment, [J/K] Next/Prev File, [N/P] Next/Prev Hunk
1=== modified file 'openlp/core/common/settings.py'
2--- openlp/core/common/settings.py 2016-05-18 18:40:27 +0000
3+++ openlp/core/common/settings.py 2016-07-17 16:12:19 +0000
4@@ -141,6 +141,7 @@
5 'core/auto preview': False,
6 'core/audio start paused': True,
7 'core/auto unblank': False,
8+ 'core/click live slide to unblank': False,
9 'core/blank warning': False,
10 'core/ccli number': '',
11 'core/has run wizard': False,
12
13=== modified file 'openlp/core/lib/mediamanageritem.py'
14--- openlp/core/lib/mediamanageritem.py 2016-05-17 13:15:53 +0000
15+++ openlp/core/lib/mediamanageritem.py 2016-07-17 16:12:19 +0000
16@@ -488,6 +488,7 @@
17 'You must select one or more items to preview.'))
18 else:
19 log.debug('%s Preview requested' % self.plugin.name)
20+ Registry().set_flag('has doubleclick added item to service', False)
21 service_item = self.build_service_item()
22 if service_item:
23 service_item.from_plugin = True
24
25=== modified file 'openlp/core/ui/generaltab.py'
26--- openlp/core/ui/generaltab.py 2016-05-20 16:22:06 +0000
27+++ openlp/core/ui/generaltab.py 2016-07-17 16:12:19 +0000
28@@ -209,6 +209,9 @@
29 self.auto_unblank_check_box = QtWidgets.QCheckBox(self.settings_group_box)
30 self.auto_unblank_check_box.setObjectName('auto_unblank_check_box')
31 self.settings_layout.addRow(self.auto_unblank_check_box)
32+ self.click_live_slide_to_unblank_check_box = QtWidgets.QCheckBox(self.settings_group_box)
33+ self.click_live_slide_to_unblank_check_box.setObjectName('click_live_slide_to_unblank')
34+ self.settings_layout.addRow(self.click_live_slide_to_unblank_check_box)
35 self.auto_preview_check_box = QtWidgets.QCheckBox(self.settings_group_box)
36 self.auto_preview_check_box.setObjectName('auto_preview_check_box')
37 self.settings_layout.addRow(self.auto_preview_check_box)
38@@ -259,6 +262,8 @@
39 self.save_check_service_check_box.setText(translate('OpenLP.GeneralTab',
40 'Prompt to save before starting a new service'))
41 self.auto_unblank_check_box.setText(translate('OpenLP.GeneralTab', 'Unblank display when adding new live item'))
42+ self.click_live_slide_to_unblank_check_box.setText(translate('OpenLP.GeneralTab',
43+ 'Unblank display when changing slide in Live'))
44 self.auto_preview_check_box.setText(translate('OpenLP.GeneralTab',
45 'Automatically preview next item in service'))
46 self.timeout_label.setText(translate('OpenLP.GeneralTab', 'Timed slide interval:'))
47@@ -292,6 +297,7 @@
48 self.password_edit.setText(settings.value('songselect password'))
49 self.save_check_service_check_box.setChecked(settings.value('save prompt'))
50 self.auto_unblank_check_box.setChecked(settings.value('auto unblank'))
51+ self.click_live_slide_to_unblank_check_box.setChecked(settings.value('click live slide to unblank'))
52 self.display_on_monitor_check.setChecked(self.screens.display)
53 self.warning_check_box.setChecked(settings.value('blank warning'))
54 self.auto_open_check_box.setChecked(settings.value('auto open'))
55@@ -336,6 +342,7 @@
56 settings.setValue('update check', self.check_for_updates_check_box.isChecked())
57 settings.setValue('save prompt', self.save_check_service_check_box.isChecked())
58 settings.setValue('auto unblank', self.auto_unblank_check_box.isChecked())
59+ settings.setValue('click live slide to unblank', self.click_live_slide_to_unblank_check_box.isChecked())
60 settings.setValue('auto preview', self.auto_preview_check_box.isChecked())
61 settings.setValue('loop delay', self.timeout_spin_box.value())
62 settings.setValue('ccli number', self.number_edit.displayText())
63
64=== modified file 'openlp/core/ui/slidecontroller.py'
65--- openlp/core/ui/slidecontroller.py 2016-05-20 16:22:06 +0000
66+++ openlp/core/ui/slidecontroller.py 2016-07-17 16:12:19 +0000
67@@ -88,6 +88,8 @@
68 self.is_live = False
69 self.display = None
70 self.controller_type = None
71+ Registry().set_flag('has doubleclick added item to service', True)
72+ Registry().set_flag('replace service manager item', False)
73
74 def send_to_plugins(self, *args):
75 """
76@@ -797,12 +799,15 @@
77
78 def replace_service_manager_item(self, item):
79 """
80- Replacement item following a remote edit
81+ Replacement item following a remote edit.
82+ This action also takes place when a song that is sent to live from Service Manager is edited.
83
84 :param item: The current service item
85 """
86 if item == self.service_item:
87+ Registry().set_flag('replace service manager item', True)
88 self._process_item(item, self.preview_widget.current_slide_number())
89+ Registry().set_flag('replace service manager item', False)
90
91 def add_service_manager_item(self, item, slide_no):
92 """
93@@ -971,9 +976,10 @@
94
95 def on_slide_unblank(self):
96 """
97- Handle the slidecontroller unblank event
98+ Handle the slidecontroller unblank event.
99 """
100- self.on_blank_display(False)
101+ if not Registry().get_flag('replace service manager item') is True:
102+ self.on_blank_display(False)
103
104 def on_blank_display(self, checked=None):
105 """
106@@ -1104,6 +1110,11 @@
107 self.log_debug('Could not get lock in slide_selected after waiting %f, skip to avoid deadlock.'
108 % timeout)
109 return
110+ # If "click live slide to unblank" is enabled, unblank the display. And start = Item is sent to Live.
111+ # Note: If this if statement is placed at the bottom of this function instead of top slide transitions are lost.
112+ if self.is_live and Settings().value('core/click live slide to unblank'):
113+ if not start:
114+ Registry().execute('slidecontroller_live_unblank')
115 row = self.preview_widget.current_slide_number()
116 old_selected_row = self.selected_row
117 self.selected_row = 0
118@@ -1286,6 +1297,8 @@
119 self.play_slides_once.setText(UiStrings().PlaySlidesToEnd)
120 self.play_slides_menu.setDefaultAction(self.play_slides_loop)
121 self.play_slides_once.setChecked(False)
122+ if Settings().value('core/click live slide to unblank'):
123+ Registry().execute('slidecontroller_live_unblank')
124 else:
125 self.play_slides_loop.setIcon(build_icon(':/media/media_time.png'))
126 self.play_slides_loop.setText(UiStrings().PlaySlidesInLoop)
127@@ -1309,6 +1322,8 @@
128 self.play_slides_loop.setText(UiStrings().PlaySlidesInLoop)
129 self.play_slides_menu.setDefaultAction(self.play_slides_once)
130 self.play_slides_loop.setChecked(False)
131+ if Settings().value('core/click live slide to unblank'):
132+ Registry().execute('slidecontroller_live_unblank')
133 else:
134 self.play_slides_once.setIcon(build_icon(':/media/media_time'))
135 self.play_slides_once.setText(UiStrings().PlaySlidesToEnd)
136@@ -1363,7 +1378,7 @@
137 Triggered when a preview slide item is doubleclicked
138 """
139 if self.service_item:
140- if Settings().value('advanced/double click live'):
141+ if Settings().value('advanced/double click live') and Settings().value('core/auto unblank'):
142 # Live and Preview have issues if we have video or presentations
143 # playing in both at the same time.
144 if self.service_item.is_command():
145@@ -1372,8 +1387,13 @@
146 if self.service_item.is_media():
147 self.on_media_close()
148 self.on_go_live()
149- else:
150+ # If ('advanced/double click live') is not enabled, double clicking preview adds the item to Service.
151+ # Prevent same item in preview from being sent to Service multiple times.
152+ # Changing the preview slide resets this flag to False.
153+ # Do note that this still allows to add item to Service multiple times if icon is clicked.
154+ elif not Registry().get_flag('has doubleclick added item to service') is True:
155 self.on_preview_add_to_service()
156+ Registry().set_flag('has doubleclick added item to service', True)
157
158 def on_go_live(self, field=None):
159 """
160
161=== modified file 'openlp/plugins/presentations/lib/messagelistener.py'
162--- openlp/plugins/presentations/lib/messagelistener.py 2016-05-21 18:19:18 +0000
163+++ openlp/plugins/presentations/lib/messagelistener.py 2016-07-17 16:12:19 +0000
164@@ -26,7 +26,7 @@
165
166 from PyQt5 import QtCore
167
168-from openlp.core.common import Registry
169+from openlp.core.common import Registry, Settings
170 from openlp.core.ui import HideMode
171 from openlp.core.lib import ServiceItemContext, ServiceItem
172 from openlp.plugins.presentations.lib.pdfcontroller import PDF_CONTROLLER_FILETYPES
173@@ -419,6 +419,8 @@
174 is_live = message[1]
175 if is_live:
176 self.live_handler.next()
177+ if Settings().value('core/click live slide to unblank'):
178+ Registry().execute('slidecontroller_live_unblank')
179 else:
180 self.preview_handler.next()
181
182@@ -431,6 +433,8 @@
183 is_live = message[1]
184 if is_live:
185 self.live_handler.previous()
186+ if Settings().value('core/click live slide to unblank'):
187+ Registry().execute('slidecontroller_live_unblank')
188 else:
189 self.preview_handler.previous()
190
191
192=== modified file 'tests/functional/openlp_core_ui/test_slidecontroller.py'
193--- tests/functional/openlp_core_ui/test_slidecontroller.py 2016-06-01 21:42:54 +0000
194+++ tests/functional/openlp_core_ui/test_slidecontroller.py 2016-07-17 16:12:19 +0000
195@@ -713,6 +713,52 @@
196 slide_controller.theme_screen, slide_controller.blank_screen
197 ])
198
199+ @patch('openlp.core.ui.slidecontroller.Settings')
200+ def on_preview_double_click_unblank_display_test(self, MockedSettings):
201+ # GIVEN: A slide controller, actions needed, settins set to True.
202+ slide_controller = SlideController(None)
203+ mocked_settings = MagicMock()
204+ mocked_settings.return_value = True
205+ MockedSettings.return_value = mocked_settings
206+ slide_controller.service_item = MagicMock()
207+ slide_controller.service_item.is_media = MagicMock()
208+ slide_controller.on_media_close = MagicMock()
209+ slide_controller.on_go_live = MagicMock()
210+ slide_controller.on_preview_add_to_service = MagicMock()
211+ slide_controller.media_reset = MagicMock()
212+ Registry.create()
213+ Registry().set_flag('has doubleclick added item to service', True)
214+
215+ # WHEN: on_preview_double_click is called
216+ slide_controller.on_preview_double_click()
217+
218+ # THEN: The call to addActions should be correct
219+ self.assertEqual(1, slide_controller.on_go_live.call_count, 'on_go_live should have been called once.')
220+ self.assertEqual(0, slide_controller.on_preview_add_to_service.call_count, 'Should have not been called.')
221+
222+ @patch('openlp.core.ui.slidecontroller.Settings')
223+ def on_preview_double_click_add_to_service_test(self, MockedSettings):
224+ # GIVEN: A slide controller, actions needed, settins set to False.
225+ slide_controller = SlideController(None)
226+ mocked_settings = MagicMock()
227+ mocked_settings.value.return_value = False
228+ MockedSettings.return_value = mocked_settings
229+ slide_controller.service_item = MagicMock()
230+ slide_controller.service_item.is_media = MagicMock()
231+ slide_controller.on_media_close = MagicMock()
232+ slide_controller.on_go_live = MagicMock()
233+ slide_controller.on_preview_add_to_service = MagicMock()
234+ slide_controller.media_reset = MagicMock()
235+ Registry.create()
236+ Registry().set_flag('has doubleclick added item to service', False)
237+
238+ # WHEN: on_preview_double_click is called
239+ slide_controller.on_preview_double_click()
240+
241+ # THEN: The call to addActions should be correct
242+ self.assertEqual(0, slide_controller.on_go_live.call_count, 'on_go_live Should have not been called.')
243+ self.assertEqual(1, slide_controller.on_preview_add_to_service.call_count, 'Should have been called once.')
244+
245 @patch(u'openlp.core.ui.slidecontroller.SlideController.image_manager')
246 @patch(u'PyQt5.QtCore.QTimer.singleShot')
247 def test_update_preview_live(self, mocked_singleShot, mocked_image_manager):