Save and restore webbrowsers [DISCL-6] (#97)

.gitexternals

@@ -1,2 +1,2 @@
 # -*- mode: cmake -*-
-# CMake/common https://github.com/Eyescale/CMake.git ca64fd0
+# CMake/common https://github.com/Eyescale/CMake.git 009f72c

CMake/GitExternal.cmake

@@ -281,13 +281,10 @@ if(EXISTS ${GIT_EXTERNALS} AND NOT GIT_EXTERNAL_SCRIPT_MODE)
  if(NOT TARGET update)
  add_custom_target(update)
  endif()
- if(NOT TARGET update-gitexternal)
- add_custom_target(update-gitexternal)
- add_custom_target(flatten-gitexternal)
- add_dependencies(update update-gitexternal)
- endif()
- if(NOT TARGET ${PROJECT_NAME}-flatten-gitexternal)
+ if(NOT TARGET ${PROJECT_NAME}-update-gitexternal)
+ add_custom_target(${PROJECT_NAME}-update-gitexternal)
  add_custom_target(${PROJECT_NAME}-flatten-gitexternal)
+ add_dependencies(update ${PROJECT_NAME}-update-gitexternal)
  endif()
 
  # Create a unique, flat name
@@ -328,7 +325,7 @@ endif()")
  COMMENT "Update ${REPO} in ${GIT_EXTERNALS_BASE}"
  DEPENDS ${GIT_EXTERNAL_TARGET}
  WORKING_DIRECTORY "${CMAKE_CURRENT_SOURCE_DIR}")
- add_dependencies(update-gitexternal
+ add_dependencies(${PROJECT_NAME}-update-gitexternal
  update-gitexternal-${GIT_EXTERNAL_NAME})
 
  # Flattens a git external repository into its parent repo:
@@ -346,12 +343,10 @@ endif()")
  COMMENT "Flatten ${REPO} into ${DIR}"
  DEPENDS ${PROJECT_NAME}-make-branch
  WORKING_DIRECTORY "${CMAKE_CURRENT_SOURCE_DIR}/${DIR}")
- add_dependencies(flatten-gitexternal
- flatten-gitexternal-${GIT_EXTERNAL_NAME})
  add_dependencies(${PROJECT_NAME}-flatten-gitexternal
  flatten-gitexternal-${GIT_EXTERNAL_NAME})
 
- foreach(_target flatten-gitexternal-${GIT_EXTERNAL_NAME} ${PROJECT_NAME}-flatten-gitexternal flatten-gitexternal update-gitexternal-${GIT_EXTERNAL_NAME} ${GIT_EXTERNAL_TARGET} update-gitexternal update)
+ foreach(_target flatten-gitexternal-${GIT_EXTERNAL_NAME} ${PROJECT_NAME}-flatten-gitexternal update-gitexternal-${GIT_EXTERNAL_NAME} ${GIT_EXTERNAL_TARGET} ${PROJECT_NAME}-update-gitexternal update)
  set_target_properties(${_target} PROPERTIES
  EXCLUDE_FROM_DEFAULT_BUILD ON FOLDER git)
  endforeach()

apps/Launcher/Launcher.cpp

@@ -63,10 +63,10 @@ Launcher::Launcher( int& argc, char* argv[] )
  const CommandLineOptions options( argc, argv );
  const MasterConfiguration config( options.getConfiguration( ));
 
- const auto deflectStreamname = options.getStreamname().toStdString();
+ const auto deflectStreamId = options.getStreamId().toStdString();
  _qmlStreamer.reset( new deflect::qt::QmlStreamer( deflectQmlFile,
  deflectHost,
- deflectStreamname ));
+ deflectStreamId ));
 
  connect( _qmlStreamer.get(), &deflect::qt::QmlStreamer::streamClosed,
  this, &QCoreApplication::quit );

apps/LocalStreamer/Application.cpp

@@ -84,7 +84,7 @@ bool Application::initialize( const CommandLineOptions& options )
  this, &Application::sendData );
 
  // Connect to Tide
- _deflectStream = new deflect::Stream( options.getStreamname().toStdString(),
+ _deflectStream = new deflect::Stream( options.getStreamId().toStdString(),
  TIDE_STREAM_HOST_ADDRESS );
  if( !_deflectStream->isConnected( ))
  {

apps/Webbrowser/Webbrowser.cpp

@@ -63,10 +63,10 @@ Webbrowser::Webbrowser( int& argc, char* argv[] )
 {
  const CommandLineOptions options( argc, argv );
 
- const auto deflectStreamname = options.getStreamname().toStdString();
+ const auto deflectStreamId = options.getStreamId().toStdString();
  _qmlStreamer.reset( new deflect::qt::QmlStreamer( deflectQmlFile,
  deflectHost,
- deflectStreamname ));
+ deflectStreamId ));
 
  connect( _qmlStreamer.get(), &deflect::qt::QmlStreamer::streamClosed,
  this, &QCoreApplication::quit );
@@ -90,6 +90,7 @@ Webbrowser::Webbrowser( int& argc, char* argv[] )
  _webengine->setProperty( "url", options.getUrl( ));
 
  connect( _webengine, SIGNAL( urlChanged( )), this, SLOT( _sendData( )));
+ connect( _webengine, SIGNAL( titleChanged( )), this, SLOT( _sendData( )));
 }
 
 Webbrowser::~Webbrowser() {}
@@ -151,8 +152,10 @@ WebbrowserHistory _getNavigationHistory( const QQuickItem* webengine )
 void Webbrowser::_sendData()
 {
  const auto history = _getNavigationHistory( _webengine );
+ const auto title = QQmlProperty::read( _webengine, "title" ).toString();
  const auto restPort = 0; // no rest interface
- const auto data = WebbrowserContent::serializeData( history, restPort );
+ const auto data = WebbrowserContent::serializeData( history, title,
+ restPort );
  if( !_qmlStreamer->sendData( data ))
  QGuiApplication::quit();
 }

apps/Whiteboard/Whiteboard.cpp

@@ -55,10 +55,10 @@ Whiteboard::Whiteboard( int& argc, char* argv[] )
  const CommandLineOptions options( argc, argv );
  const MasterConfiguration config( options.getConfiguration( ));
 
- const auto deflectStreamname = options.getStreamname().toStdString();
+ const auto deflectStreamId = options.getStreamId().toStdString();
  _qmlStreamer.reset( new deflect::qt::QmlStreamer( deflectQmlFile,
  deflectHost,
- deflectStreamname ));
+ deflectStreamId ));
 
  connect( _qmlStreamer.get(), &deflect::qt::QmlStreamer::streamClosed,
  this, &QCoreApplication::quit );

doc/Changelog.md

@@ -3,6 +3,9 @@ Changelog {#changelog}
 
 # Release 1.2 (git master)
 
+* [97](https://github.com/BlueBrain/Tide/pull/97):
+ Webbrowsers can be saved and restored from sessions and display the page title
+ in their title bar.
 * [95](https://github.com/BlueBrain/Tide/pull/95):
  More consistent and intuitive user experience:
  - Double-tap a window to make it fullscreen

tests/cpp/CMakeLists.txt

@@ -27,15 +27,17 @@ else()
  )
 endif()
 
-if(NOT TARGET Qt5::WebEngine AND X11_FOUND AND TARGET Qt5::WebKitWidgets)
+if(X11_FOUND AND TARGET Qt5::WebKitWidgets)
  list(APPEND TEST_LIBRARIES ${X11_LIBRARIES} Qt5::WebKitWidgets)
 else()
  list(APPEND EXCLUDE_FROM_TESTS
  core/LocalPixelStreamerTests.cpp
- core/WebbrowserTests.cpp
- core/WebbrowserContentTests.cpp
+ core/WebkitTests.cpp
  core/WebkitHtmlSelectReplacementTests.cpp)
 endif()
+if(NOT TARGET Qt5::WebEngine AND NOT TARGET Qt5::WebKitWidgets)
+ list(APPEND EXCLUDE_FROM_TESTS core/WebbrowserContentTests.cpp)
+endif()
 
 # Recursively compile unit tests for *.cpp files in the current folder,
 # linking with TEST_LIBRARIES and excluding EXCLUDE_FROM_TESTS

tests/cpp/core/CommandLineOptionsTests.cpp

@@ -52,7 +52,7 @@ BOOST_AUTO_TEST_CASE( testCommandLineDefaults )
  CommandLineOptions options;
 
  BOOST_CHECK( !options.getHelp() );
- BOOST_CHECK_EQUAL( options.getStreamname().toStdString(), "" );
+ BOOST_CHECK_EQUAL( options.getStreamId().toStdString(), "" );
  BOOST_CHECK_EQUAL( options.getPixelStreamerType(), PS_UNKNOWN );
  BOOST_CHECK_EQUAL( options.getUrl().toStdString(), "" );
  BOOST_CHECK_EQUAL( options.getConfiguration().toStdString(), "" );
@@ -67,7 +67,7 @@ BOOST_AUTO_TEST_CASE( testCommandLineDefaults )
 void setOptionParameters( CommandLineOptions& options )
 {
  options.setHelp( true );
- options.setStreamname( "MyStreamer" );
+ options.setStreamId( "MyStreamer" );
  options.setPixelStreamerType( PS_WEBKIT );
  options.setUrl( "http://www.perdu.com" );
  options.setHeight( 640 );
@@ -78,7 +78,7 @@ void setOptionParameters( CommandLineOptions& options )
 void checkOptionParameters( const CommandLineOptions& options )
 {
  BOOST_CHECK( options.getHelp() );
- BOOST_CHECK_EQUAL( options.getStreamname().toStdString(), "MyStreamer" );
+ BOOST_CHECK_EQUAL( options.getStreamId().toStdString(), "MyStreamer" );
  BOOST_CHECK_EQUAL( options.getPixelStreamerType(), PS_WEBKIT );
  BOOST_CHECK_EQUAL( options.getUrl().toStdString(), "http://www.perdu.com" );
  BOOST_CHECK_EQUAL( options.getHeight(), 640 );
@@ -88,7 +88,7 @@ void checkOptionParameters( const CommandLineOptions& options )
 
  BOOST_CHECK_EQUAL( options.getCommandLine().toStdString(),
  "--type webkit --width 480 --height 640 --help "
- "--streamname MyStreamer --url http://www.perdu.com "
+ "--streamid MyStreamer --url http://www.perdu.com "
  "--config /path/to/configuration.xml" );
 }
 

tests/cpp/core/ContentControllerTests.cpp

@@ -47,7 +47,8 @@
 #if TIDE_ENABLE_PDF_SUPPORT
 # include "control/PDFController.h"
 #endif
-#if TIDE_USE_QT5WEBKITWIDGETS || TIDE_USE_QT5WEBENGINE
+#include "control/PixelStreamController.h"
+#if TIDE_USE_QT5WEBKITWIDGETS
 # include "control/WebbrowserController.h"
 #endif
 #include "control/ZoomController.h"
@@ -98,7 +99,11 @@ BOOST_AUTO_TEST_CASE( testFactoryMethod )
  std::bad_cast );
  ContentWindow webWindow( ContentFactory::getWebbrowserContent( "abc" ));
  BOOST_CHECK_NO_THROW( controller = ContentController::create( webWindow ));
+#endif
+#if TIDE_USE_QT5WEBKITWIDGETS
  BOOST_CHECK( dynamic_cast<WebbrowserController*>( controller.get( )));
+#elif TIDE_USE_QT5WEBENGINE
+ BOOST_CHECK( dynamic_cast<PixelStreamController*>( controller.get( )));
 #endif
 
 #if TIDE_ENABLE_PDF_SUPPORT

tests/cpp/core/ContentWindowControllerTests.cpp

@@ -41,8 +41,6 @@
 #define BOOST_TEST_MODULE ContentWindowControllerTests
 #include <boost/test/unit_test.hpp>
 
-#include <boost/make_shared.hpp>
-
 #include "control/ContentWindowController.h"
 #include "control/LayoutEngine.h"
 #include "scene/ContentWindow.h"

tests/cpp/core/DisplayGroupTests.cpp

@@ -46,8 +46,6 @@
 
 #include "DummyContent.h"
 
-#include <boost/make_shared.hpp>
-
 namespace
 {
 const QSize wallSize( 1000, 1000 );

tests/cpp/core/JsonOptionsTests.cpp

@@ -44,8 +44,6 @@
 #include "rest/JsonOptions.h"
 #include "scene/Options.h"
 
-#include <boost/make_shared.hpp>
-
 namespace
 {
 const std::string defaultJson{

tests/cpp/core/LoggingUtilityTest.cpp

@@ -39,7 +39,6 @@
 
 #define BOOST_TEST_MODULE LoggingUtilityTest
 
-#include <boost/make_shared.hpp>
 #include <boost/test/unit_test.hpp>
 
 #include "LoggingUtility.h"

tests/cpp/core/PixelStreamWindowManagerTests.cpp

@@ -98,25 +98,25 @@ BOOST_AUTO_TEST_CASE( testNoStreamerWindowCreation )
  const QSize size( testWindowSize );
 
  windowManager.openWindow( uri, pos, size );
- ContentWindowPtr window = windowManager.getContentWindow( uri );
+ ContentWindowPtr window = windowManager.getWindow( uri );
  BOOST_REQUIRE( window );
 
- BOOST_CHECK_EQUAL( window, windowManager.getContentWindow( uri ));
+ BOOST_CHECK_EQUAL( window, windowManager.getWindow( uri ));
 
  const QRectF& coords = window->getCoordinates();
  BOOST_CHECK_EQUAL( coords.center(), pos );
  BOOST_CHECK_EQUAL( coords.size(), size );
 
- windowManager.closePixelStreamWindow( uri );
- BOOST_CHECK( !windowManager.getContentWindow( uri ));
+ windowManager.handleStreamEnd( uri );
+ BOOST_CHECK( !windowManager.getWindow( uri ));
 }
 
 BOOST_AUTO_TEST_CASE( testEventReceiver )
 {
  DisplayGroupPtr displayGroup( new DisplayGroup( wallSize ));
  PixelStreamWindowManager windowManager( *displayGroup );
  windowManager.openWindow( CONTENT_URI, testWindowPos, testWindowSize );
- ContentWindowPtr window = windowManager.getContentWindow( CONTENT_URI );
+ ContentWindowPtr window = windowManager.getWindow( CONTENT_URI );
  BOOST_REQUIRE( window );
 
  auto content = dynamic_cast<PixelStreamContent*>( window->getContentPtr( ));
@@ -168,15 +168,15 @@ BOOST_AUTO_TEST_CASE( testExplicitWindowCreation )
  const QSize size( testWindowSize );
 
  windowManager.openWindow( uri, pos, size );
- ContentWindowPtr window = windowManager.getContentWindow( uri );
+ ContentWindowPtr window = windowManager.getWindow( uri );
  BOOST_REQUIRE( window );
 
- BOOST_CHECK_EQUAL( window, windowManager.getContentWindow( uri ));
+ BOOST_CHECK_EQUAL( window, windowManager.getWindow( uri ));
  BOOST_CHECK_EQUAL( window,
  displayGroup->getContentWindow( window->getID( )));
 
- windowManager.openPixelStreamWindow( uri );
- BOOST_CHECK_EQUAL( window, windowManager.getContentWindow( uri ));
+ windowManager.handleStreamStart( uri );
+ BOOST_CHECK_EQUAL( window, windowManager.getWindow( uri ));
 
  ContentPtr content = window->getContent();
  BOOST_REQUIRE( content );
@@ -193,8 +193,8 @@ BOOST_AUTO_TEST_CASE( testExplicitWindowCreation )
  BOOST_CHECK_EQUAL( coords.center(), pos );
  BOOST_CHECK_EQUAL( coords.size(), size );
 
- windowManager.closePixelStreamWindow( uri );
- BOOST_CHECK( !windowManager.getContentWindow( uri ));
+ windowManager.handleStreamEnd( uri );
+ BOOST_CHECK( !windowManager.getWindow( uri ));
  BOOST_CHECK( !displayGroup->getContentWindow( window->getID( )));
 }
 
@@ -208,8 +208,8 @@ BOOST_AUTO_TEST_CASE( testImplicitWindowCreation )
  const QPointF pos( wallSize.width() * 0.5, wallSize.height() * 0.5 );
  const QSize size( defaultPixelStreamWindowSize );
 
- windowManager.openPixelStreamWindow( uri );
- ContentWindowPtr window = windowManager.getContentWindow( uri );
+ windowManager.handleStreamStart( uri );
+ ContentWindowPtr window = windowManager.getWindow( uri );
  BOOST_REQUIRE( window );
  BOOST_CHECK_EQUAL( window,
  displayGroup->getContentWindow( window->getID( )));
@@ -236,8 +236,8 @@ BOOST_AUTO_TEST_CASE( testImplicitWindowCreation )
  BOOST_CHECK_EQUAL( coords.center(), pos );
  BOOST_CHECK_EQUAL( coords.size(), testFrameSize );
 
- windowManager.closePixelStreamWindow( uri );
- BOOST_CHECK( !windowManager.getContentWindow( uri ));
+ windowManager.handleStreamEnd( uri );
+ BOOST_CHECK( !windowManager.getWindow( uri ));
  BOOST_CHECK( !displayGroup->getContentWindow( window->getID( )));
 }
 
@@ -246,8 +246,8 @@ BOOST_AUTO_TEST_CASE( testSizeHints )
  DisplayGroupPtr displayGroup( new DisplayGroup( wallSize ));
  PixelStreamWindowManager windowManager( *displayGroup );
  const QString uri = CONTENT_URI;
- windowManager.openPixelStreamWindow( uri );
- ContentWindowPtr window = windowManager.getContentWindow( uri );
+ windowManager.handleStreamStart( uri );
+ ContentWindowPtr window = windowManager.getWindow( uri );
  ContentPtr content = window->getContent();
 
  BOOST_CHECK_EQUAL( content->getDimensions(), QSizeF( ));
@@ -279,8 +279,8 @@ BOOST_AUTO_TEST_CASE( hideAndShowWindow )
  PixelStreamWindowManager windowManager( *displayGroup );
 
  const QString uri = CONTENT_URI;
- windowManager.openPixelStreamWindow( uri );
- ContentWindowPtr window = windowManager.getContentWindow( uri );
+ windowManager.handleStreamStart( uri );
+ ContentWindowPtr window = windowManager.getWindow( uri );
 
  BOOST_REQUIRE( !window->isHidden( ));
  BOOST_REQUIRE( !window->isPanel( ));
@@ -298,8 +298,8 @@ BOOST_AUTO_TEST_CASE( hideAndShowPanel )
  PixelStreamWindowManager windowManager( *displayGroup );
 
  const QString uri = PANEL_URI;
- windowManager.openPixelStreamWindow( uri );
- ContentWindowPtr panel = windowManager.getContentWindow( uri );
+ windowManager.handleStreamStart( uri );
+ ContentWindowPtr panel = windowManager.getWindow( uri );
 
  BOOST_REQUIRE( panel->isPanel( ));
  BOOST_REQUIRE( !panel->isHidden( ));

tests/cpp/core/VisibilityHelperTests.cpp

@@ -46,8 +46,6 @@
 
 #include "DummyContent.h"
 
-#include <boost/make_shared.hpp>
-
 namespace
 {
 const QSize groupSize( 800, 600 );