Merge lp:~trb143/openlp/bug-850254 into lp:openlp

[Tim Bentley]

This is the core changes to handle the remote events for hiding and showing screens

[Jonathan Corwin (j-corwin)]

Too many blank lines 56-58
There is an elif on 53 but an if on 55.

I'm not sure about the term "status" in httpserver, it doesn't seem descriptive enough to me, as lots of things could have a status. Perhaps displaystatus or something?

review: Needs Fixing

[Jonathan Corwin (j-corwin)]

Oh, and you seem to be sneaking a feature in along with the fix...

[Raoul Snyman (raoul-snyman)]

81 + (r'^/api/status$', self.status),
82 + (r'^/api/changeStatus/(blank|theme|desktop)$', self.changeStatus),

As Jonathan said, "status" is a little too generic...

(r'^/api/display-status$', self.displayStatus),
(r'^/api/display-status/(blank|theme|desktop)$', self.changeDisplayStatus),

That should work.

review: Needs Fixing

[Raoul Snyman (raoul-snyman)]

Can you also change the method names to make them a little more descriptive please? Like...

  def displayStatus(self):
      """
      Obtain the display status of system.
      """

  def changeDisplayStatus(self, action):
      """
      Toggle the display of the system including the status button.
      """

review: Needs Fixing

[Jonathan Corwin (j-corwin)]

Just looking at httpserver.py, we already have a method /api/display
It currently only supports hide or show.
Can't we just extend it to support 'theme' and 'desktop' too?

I'm also not convinced about just toggling it, this could just cause chaos if both the PC user and remote user do it at the same time as it could just result in a flicker. I think the user should tell the app what he wants to do, and then the app does it, even if the end result is to do nothing.

[Tim Bentley (trb143)]

Will fix up the comments.

The API needs changing but if we change it when have to update the clients at the same time which will be a problem. The old API should be deprecated and removed in March.

The current situation is worse as the when and android can set the screen to blank but then have no view of what it is and the display is just changed without the button being set.
This change will make it possible to make the button states consistent across all clients.

[Jonathan Corwin (j-corwin)]

But if I write a client that wants to blank the screen, then I want to be able to tell OpenLP to blank the screen. Changing it to a 'toggle' means that I press the button, and the application has no clue as to what OpenLP will do.

I have no issue with a method to get the current display status and for this to then update the ui afterwards with the state, or even poll regularly. But the remote app needs to be able to tell OpenLP exactly what they want to do.

99% of the time the operator will be able to look up at the projector screen and see what the current state of play is if they really badly want to know.

[Jonathan Corwin (j-corwin)]

In fact we could just change the existing 'poll' call to get the display status

[Raoul Snyman (raoul-snyman)]

I agree with Jonathan, I think we should probably move away from a "toggle" mentality, and move to a "hide|theme|desktop|show" idea - then we can keep the API the same, just adding new items, keeping the API backwards compatible.

Then we can show 4 buttons in the toolbar, and using the poll event, indicate which button is active.

Further thoughts/ideas/comments/etc ?

[Raoul Snyman (raoul-snyman)]

review: Approve

=== modified file 'openlp/core/ui/slidecontroller.py'
--- openlp/core/ui/slidecontroller.py	2011-12-09 12:35:18 +0000
+++ openlp/core/ui/slidecontroller.py	2011-12-15 19:01:50 +0000
@@ -95,7 +95,7 @@
             u'Edit Song',
         ]
         self.nextPreviousList = [
-            u'Previous Slide', 
+            u'Previous Slide',
             u'Next Slide'
         ]
         self.timer_id = 0
@@ -114,8 +114,8 @@
             self.typeLabel.setText(UiStrings().Live)
             self.split = 1
             self.typePrefix = u'live'
-            self.keypress_queue = deque() 
-            self.keypress_loop = False           
+            self.keypress_queue = deque()
+            self.keypress_loop = False
         else:
             self.typeLabel.setText(UiStrings().Preview)
             self.split = 0
@@ -187,7 +187,7 @@
                 translate('OpenLP.SlideController', 'Hide'), self.toolbar))
             self.blankScreen = shortcut_action(self.hideMenu, u'blankScreen',
                 [QtCore.Qt.Key_Period], self.onBlankDisplay,
-                u':/slides/slide_blank.png', False, 
+                u':/slides/slide_blank.png', False,
                 unicode(UiStrings().LiveToolbar))
             self.blankScreen.setText(
                 translate('OpenLP.SlideController', 'Blank Screen'))
@@ -412,6 +412,9 @@
             QtCore.QObject.connect(Receiver.get_receiver(),
                 QtCore.SIGNAL(u'slidecontroller_live_spin_delay'),
                 self.receiveSpinDelay)
+            QtCore.QObject.connect(Receiver.get_receiver(),
+                QtCore.SIGNAL(u'slidecontroller_toggle_display'),
+                self.toggleDisplay)
             self.toolbar.makeWidgetsInvisible(self.loopList)
         else:
             QtCore.QObject.connect(self.previewListWidget,
@@ -570,6 +573,21 @@
         self.display.setVisible(False)
         self.mediaController.video_stop([self])
 
+    def toggleDisplay(self, action):
+        """
+        Toggle the display settings triggered from remote messages.
+        """
+        if action == u'blank' or action == u'hide':
+            self.onBlankDisplay(True)
+        elif action == u'theme':
+            self.onThemeDisplay(True)
+        elif action == u'desktop':
+            self.onHideDisplay(True)
+        elif action == u'show':
+            self.onBlankDisplay(False)
+            self.onThemeDisplay(False)
+            self.onHideDisplay(False)
+
     def servicePrevious(self):
         """
         Live event to select the previous service item from the service manager.
@@ -618,8 +636,8 @@
         self.previewSizeChanged()
         self.previewDisplay.setup()
         serviceItem = ServiceItem()
-        self.previewDisplay.webView.setHtml(build_html(serviceItem, 
-            self.previewDisplay.screen, None, self.isLive, None, 
+        self.previewDisplay.webView.setHtml(build_html(serviceItem,
+            self.previewDisplay.screen, None, self.isLive, None,
             plugins=PluginManager.get_instance().plugins))
         self.mediaController.setup_display(self.previewDisplay)
         if self.serviceItem:

=== modified file 'openlp/plugins/remotes/lib/httpserver.py'
--- openlp/plugins/remotes/lib/httpserver.py	2011-12-14 22:39:52 +0000
+++ openlp/plugins/remotes/lib/httpserver.py	2011-12-15 19:01:50 +0000
@@ -249,7 +249,7 @@
             (r'^/api/poll$', self.poll),
             (r'^/api/controller/(live|preview)/(.*)$', self.controller),
             (r'^/api/service/(.*)$', self.service),
-            (r'^/api/display/(hide|show)$', self.display),
+            (r'^/api/display/(hide|show|blank|theme|desktop)$', self.display),
             (r'^/api/alert$', self.alert),
             (r'^/api/plugin/(search)$', self.pluginInfo),
             (r'^/api/(.*)/search$', self.search),
@@ -401,7 +401,13 @@
             u'item': self.parent.current_item._uuid \
                 if self.parent.current_item else u'',
             u'twelve':QtCore.QSettings().value(
-            u'remotes/twelve hour', QtCore.QVariant(True)).toBool()
+            u'remotes/twelve hour', QtCore.QVariant(True)).toBool(),
+            u'blank': self.parent.plugin.liveController.blankScreen.\
+                isChecked(),
+            u'theme': self.parent.plugin.liveController.themeScreen.\
+                isChecked(),
+            u'display': self.parent.plugin.liveController.desktopScreen.\
+                isChecked()
         }
         return HttpResponse(json.dumps({u'results': result}),
             {u'Content-Type': u'application/json'})
@@ -413,8 +419,7 @@
         ``action``
             This is the action, either ``hide`` or ``show``.
         """
-        event = u'live_display_%s' % action
-        Receiver.send_message(event, HideMode.Blank)
+        Receiver.send_message(u'slidecontroller_toggle_display', action)
         return HttpResponse(json.dumps({u'results': {u'success': True}}),
             {u'Content-Type': u'application/json'})