Merge pull request #9318 from birarda/ovr-platform-entitlement

handle OVR Platform entitlement checks

cmake/externals/LibOVRPlatform/CMakeLists.txt

@@ -0,0 +1,32 @@
+include(ExternalProject)
+include(SelectLibraryConfigurations)
+
+set(EXTERNAL_NAME LibOVRPlatform)
+
+string(TOUPPER ${EXTERNAL_NAME} EXTERNAL_NAME_UPPER)
+
+if (WIN32)
+
+  ExternalProject_Add(
+    ${EXTERNAL_NAME}
+    URL http://hifi-public.s3.amazonaws.com/dependencies/OVRPlatformSDK_v1.10.0.zip
+    URL_MD5 e6c8264af16d904e6506acd5172fa0a9
+    CONFIGURE_COMMAND ""
+    BUILD_COMMAND ""
+    INSTALL_COMMAND ""
+    LOG_DOWNLOAD 1
+  )
+
+  ExternalProject_Get_Property(${EXTERNAL_NAME} SOURCE_DIR)
+
+  if ("${CMAKE_SIZEOF_VOID_P}" EQUAL "8")
+    set(${EXTERNAL_NAME_UPPER}_LIBRARY_RELEASE ${SOURCE_DIR}/Windows/LibOVRPlatform64_1.lib CACHE TYPE INTERNAL)
+  else()
+    set(${EXTERNAL_NAME_UPPER}_LIBRARY_RELEASE ${SOURCE_DIR}/Windows/LibOVRPlatform32_1.lib CACHE TYPE INTERNAL)
+  endif()
+
+  set(${EXTERNAL_NAME_UPPER}_INCLUDE_DIRS ${SOURCE_DIR}/Include CACHE TYPE INTERNAL)
+endif ()
+
+# Hide this external target (for ide users)
+set_target_properties(${EXTERNAL_NAME} PROPERTIES FOLDER "hidden/externals")

cmake/modules/FindLibOVRPlatform.cmake

@@ -0,0 +1,44 @@
+#
+#  FindLibOVRPlatform.cmake
+#
+#  Try to find the LibOVRPlatform library to use the Oculus Platform SDK
+#
+#  You must provide a LIBOVRPLATFORM_ROOT_DIR which contains Windows and Include directories
+#
+#  Once done this will define
+#
+#  LIBOVRPLATFORM_FOUND - system found Oculus Platform SDK
+#  LIBOVRPLATFORM_INCLUDE_DIRS - the Oculus Platform include directory
+#  LIBOVRPLATFORM_LIBRARIES - Link this to use Oculus Platform
+#
+#  Created on December 16, 2016 by Stephen Birarda
+#  Copyright 2016 High Fidelity, Inc.
+#
+#  Distributed under the Apache License, Version 2.0.
+#  See the accompanying file LICENSE or http://www.apache.org/licenses/LICENSE-2.0.html
+#
+
+
+if (WIN32)
+  # setup hints for LIBOVRPLATFORM search
+  include("${MACRO_DIR}/HifiLibrarySearchHints.cmake")
+  hifi_library_search_hints("LibOVRPlatform")
+
+  find_path(LIBOVRPLATFORM_INCLUDE_DIRS OVR_Platform.h PATH_SUFFIXES Include HINTS ${LIBOVRPLATFORM_SEARCH_DIRS})
+
+  if ("${CMAKE_SIZEOF_VOID_P}" EQUAL "8")
+    set(_LIB_NAME LibOVRPlatform64_1.lib)
+  else()
+    set(_LIB_NAME LibOVRPlatform32_1.lib)
+  endif()
+
+  find_library(LIBOVRPLATFORM_LIBRARY_RELEASE NAMES ${_LIB_NAME} PATH_SUFFIXES Windows HINTS ${LIBOVRPLATFORM_SEARCH_DIRS})
+
+  include(SelectLibraryConfigurations)
+  select_library_configurations(LIBOVRPLATFORM)
+
+  include(FindPackageHandleStandardArgs)
+  find_package_handle_standard_args(LIBOVRPLATFORM DEFAULT_MSG LIBOVRPLATFORM_INCLUDE_DIRS LIBOVRPLATFORM_LIBRARIES)
+
+  mark_as_advanced(LIBOVRPLATFORM_INCLUDE_DIRS LIBOVRPLATFORM_LIBRARIES LIBOVRPLATFORM_SEARCH_DIRS)
+endif ()

interface/src/Application.cpp

@@ -252,7 +252,7 @@ public:
     static const unsigned long MAX_HEARTBEAT_AGE_USECS = 30 * USECS_PER_SECOND;
     static const int WARNING_ELAPSED_HEARTBEAT = 500 * USECS_PER_MSEC; // warn if elapsed heartbeat average is large
     static const int HEARTBEAT_SAMPLES = 100000; // ~5 seconds worth of samples
-    
+
     // Set the heartbeat on launch
     DeadlockWatchdogThread() {
         setObjectName("Deadlock Watchdog");
@@ -616,7 +616,7 @@ Application::Application(int& argc, char** argv, QElapsedTimer& startupTimer, bo
     _window->setWindowTitle("Interface");
 
     Model::setAbstractViewStateInterface(this); // The model class will sometimes need to know view state details from us
-    
+
     auto nodeList = DependencyManager::get<NodeList>();
 
     // Set up a watchdog thread to intentionally crash the application on deadlocks
@@ -637,6 +637,9 @@ Application::Application(int& argc, char** argv, QElapsedTimer& startupTimer, bo
     qCDebug(interfaceapp) << "[VERSION] We will use DEVELOPMENT global services.";
 #endif
 
+    // set the OCULUS_STORE property so the oculus plugin can know if we ran from the Oculus Store
+    static const QString OCULUS_STORE_ARG = "--oculus-store";
+    setProperty(hifi::properties::OCULUS_STORE, arguments().indexOf(OCULUS_STORE_ARG) != -1);
 
     static const QString NO_UPDATER_ARG = "--no-updater";
     static const bool noUpdater = arguments().indexOf(NO_UPDATER_ARG) != -1;
@@ -697,7 +700,7 @@ Application::Application(int& argc, char** argv, QElapsedTimer& startupTimer, bo
     audioIO->setPositionGetter([]{
         auto avatarManager = DependencyManager::get<AvatarManager>();
         auto myAvatar = avatarManager ? avatarManager->getMyAvatar() : nullptr;
-        
+
         return myAvatar ? myAvatar->getPositionForAudio() : Vectors::ZERO;
     });
     audioIO->setOrientationGetter([]{
@@ -880,7 +883,7 @@ Application::Application(int& argc, char** argv, QElapsedTimer& startupTimer, bo
 #ifdef Q_OS_MAC
     auto cursorTarget = _window; // OSX doesn't seem to provide for hiding the cursor only on the GL widget
 #else
-    // On windows and linux, hiding the top level cursor also means it's invisible when hovering over the 
+    // On windows and linux, hiding the top level cursor also means it's invisible when hovering over the
     // window menu, which is a pain, so only hide it for the GL surface
     auto cursorTarget = _glWidget;
 #endif
@@ -1125,7 +1128,7 @@ Application::Application(int& argc, char** argv, QElapsedTimer& startupTimer, bo
     loadSettings();
 
     // Now that we've loaded the menu and thus switched to the previous display plugin
-    // we can unlock the desktop repositioning code, since all the positions will be 
+    // we can unlock the desktop repositioning code, since all the positions will be
     // relative to the desktop size for this plugin
     auto offscreenUi = DependencyManager::get<OffscreenUi>();
     offscreenUi->getDesktop()->setProperty("repositionLocked", false);
@@ -1598,7 +1601,7 @@ void Application::checkChangeCursor() {
 #ifdef Q_OS_MAC
         auto cursorTarget = _window; // OSX doesn't seem to provide for hiding the cursor only on the GL widget
 #else
-        // On windows and linux, hiding the top level cursor also means it's invisible when hovering over the 
+        // On windows and linux, hiding the top level cursor also means it's invisible when hovering over the
         // window menu, which is a pain, so only hide it for the GL surface
         auto cursorTarget = _glWidget;
 #endif
@@ -1785,7 +1788,7 @@ Application::~Application() {
 #endif
     // The window takes ownership of the menu, so this has the side effect of destroying it.
     _window->setMenuBar(nullptr);
-    
+
     _window->deleteLater();
 
     // Can't log to file passed this point, FileLogger about to be deleted
@@ -1811,10 +1814,10 @@ void Application::initializeGL() {
 
     _glWidget->makeCurrent();
     gpu::Context::init<gpu::gl::GLBackend>();
-    qApp->setProperty(hifi::properties::gl::MAKE_PROGRAM_CALLBACK, 
+    qApp->setProperty(hifi::properties::gl::MAKE_PROGRAM_CALLBACK,
         QVariant::fromValue((void*)(&gpu::gl::GLBackend::makeProgram)));
     _gpuContext = std::make_shared<gpu::Context>();
-    // The gpu context can make child contexts for transfers, so 
+    // The gpu context can make child contexts for transfers, so
     // we need to restore primary rendering context
     _glWidget->makeCurrent();
 
@@ -2034,7 +2037,7 @@ void Application::paintGL() {
     // FIXME not needed anymore?
     _offscreenContext->makeCurrent();
 
-    // If a display plugin loses it's underlying support, it 
+    // If a display plugin loses it's underlying support, it
     // needs to be able to signal us to not use it
     if (!displayPlugin->beginFrameRender(_frameCount)) {
         _inPaint = false;
@@ -2846,7 +2849,7 @@ void Application::keyPressEvent(QKeyEvent* event) {
                     if (isMirrorChecked) {
 
                         // if we got here without coming in from a non-Full Screen mirror case, then our
-                        // _returnFromFullScreenMirrorTo is unknown. In that case we'll go to the old 
+                        // _returnFromFullScreenMirrorTo is unknown. In that case we'll go to the old
                         // behavior of returning to ThirdPerson
                         if (_returnFromFullScreenMirrorTo.isEmpty()) {
                             _returnFromFullScreenMirrorTo = MenuOption::ThirdPerson;
@@ -3020,7 +3023,7 @@ void Application::mouseMoveEvent(QMouseEvent* event) {
     maybeToggleMenuVisible(event);
 
     auto& compositor = getApplicationCompositor();
-    // if this is a real mouse event, and we're in HMD mode, then we should use it to move the 
+    // if this is a real mouse event, and we're in HMD mode, then we should use it to move the
     // compositor reticle
     // handleRealMouseMoveEvent() will return true, if we shouldn't process the event further
     if (!compositor.fakeEventActive() && compositor.handleRealMouseMoveEvent()) {
@@ -4109,7 +4112,7 @@ void Application::setKeyboardFocusEntity(EntityItemID entityItemID) {
                 }
                 _lastAcceptedKeyPress = usecTimestampNow();
 
-                setKeyboardFocusHighlight(entity->getPosition(), entity->getRotation(), 
+                setKeyboardFocusHighlight(entity->getPosition(), entity->getRotation(),
                     entity->getDimensions() * FOCUS_HIGHLIGHT_EXPANSION_FACTOR);
             }
         }
@@ -4700,7 +4703,7 @@ void Application::queryOctree(NodeType_t serverType, PacketType packetType, Node
                 _octreeQuery.setMaxQueryPacketsPerSecond(0);
             }
 
-            // if asked to forceResend, then set the query's position/orientation to be degenerate in a manner 
+            // if asked to forceResend, then set the query's position/orientation to be degenerate in a manner
             // that will cause our next query to be guarenteed to be different and the server will resend to us
             if (forceResend) {
                 _octreeQuery.setCameraPosition(glm::vec3(-0.1, -0.1, -0.1));
@@ -5833,7 +5836,7 @@ void Application::addAssetToWorldWithNewMapping(QString filePath, QString mappin
             mapping = mapping.insert(mapping.lastIndexOf("."), "-" + QString::number(copy));
             addAssetToWorldWithNewMapping(filePath, mapping, copy);
         } else {
-            QString errorInfo = "Too many copies of asset name: " 
+            QString errorInfo = "Too many copies of asset name: "
                 + mapping.left(mapping.length() - QString::number(copy).length() - 1);
             qWarning(interfaceapp) << "Error downloading model: " + errorInfo;
             addAssetToWorldError(filenameFromPath(filePath), errorInfo);
@@ -5900,7 +5903,7 @@ void Application::addAssetToWorldAddEntity(QString filePath, QString mapping) {
 
     // Note: Model dimensions are not available here; model is scaled per FBX mesh in RenderableModelEntityItem::update() later
     // on. But FBX dimensions may be in cm, so we monitor for the dimension change and rescale again if warranted.
-    
+
     if (entityID == QUuid()) {
         QString errorInfo = "Could not add model " + mapping + " to world.";
         qWarning(interfaceapp) << "Could not add model to world: " + errorInfo;
@@ -6364,7 +6367,7 @@ glm::uvec2 Application::getCanvasSize() const {
 }
 
 QRect Application::getRenderingGeometry() const {
-    auto geometry = _glWidget->geometry(); 
+    auto geometry = _glWidget->geometry();
     auto topLeft = geometry.topLeft();
     auto topLeftScreen = _glWidget->mapToGlobal(topLeft);
     geometry.moveTopLeft(topLeftScreen);
@@ -6727,8 +6730,8 @@ bool Application::makeRenderingContextCurrent() {
     return _offscreenContext->makeCurrent();
 }
 
-bool Application::isForeground() const { 
+bool Application::isForeground() const {
-    return _isForeground && !_window->isMinimized(); 
+    return _isForeground && !_window->isMinimized();
 }
 
 void Application::sendMousePressOnEntity(QUuid id, PointerEvent event) {

libraries/shared/src/shared/GlobalAppProperties.cpp

@@ -13,6 +13,7 @@ namespace hifi { namespace properties {
     const char* CRASHED = "com.highfidelity.crashed";
     const char* STEAM = "com.highfidelity.launchedFromSteam";
     const char* LOGGER = "com.highfidelity.logger";
+    const char* OCULUS_STORE = "com.highfidelity.oculusStore";
     const char* TEST = "com.highfidelity.test";
     const char* TRACING = "com.highfidelity.tracing";
 

libraries/shared/src/shared/GlobalAppProperties.h

@@ -15,6 +15,7 @@ namespace hifi { namespace properties {
     extern const char* CRASHED;
     extern const char* STEAM;
     extern const char* LOGGER;
+    extern const char* OCULUS_STORE;
     extern const char* TEST;
     extern const char* TRACING;
 

plugins/oculus/CMakeLists.txt

@@ -8,21 +8,31 @@
 
 if (WIN32)
 
-    # we're using static GLEW, so define GLEW_STATIC
+  # we're using static GLEW, so define GLEW_STATIC
-    add_definitions(-DGLEW_STATIC)
+  add_definitions(-DGLEW_STATIC)
 
-    set(TARGET_NAME oculus)
+  # if we were passed an Oculus App ID for entitlement checks, send that along
-    setup_hifi_plugin(Multimedia)
+  if (DEFINED ENV{OCULUS_APP_ID})
-    link_hifi_libraries(shared gl gpu gpu-gl controllers ui 
+    add_definitions(-DOCULUS_APP_ID="$ENV{OCULUS_APP_ID}")
-        plugins ui-plugins display-plugins input-plugins
+  endif ()
-        audio-client networking render-utils)
-    
-    include_hifi_library_headers(octree)
-    
-    add_dependency_external_projects(LibOVR)
-    find_package(LibOVR REQUIRED)
-    target_include_directories(${TARGET_NAME} PRIVATE ${LIBOVR_INCLUDE_DIRS})
-    target_link_libraries(${TARGET_NAME} ${LIBOVR_LIBRARIES})
-    target_link_libraries(${TARGET_NAME} Winmm.lib)
 
+  set(TARGET_NAME oculus)
+  setup_hifi_plugin(Multimedia)
+  link_hifi_libraries(
+    shared gl gpu gpu-gl controllers ui
+    plugins ui-plugins display-plugins input-plugins
+    audio-client networking render-utils
+  )
+  include_hifi_library_headers(octree)
+
+  add_dependency_external_projects(LibOVR)
+  find_package(LibOVR REQUIRED)
+  target_include_directories(${TARGET_NAME} PRIVATE ${LIBOVR_INCLUDE_DIRS})
+  target_link_libraries(${TARGET_NAME} ${LIBOVR_LIBRARIES})
+  target_link_libraries(${TARGET_NAME} Winmm.lib)
+
+  add_dependency_external_projects(LibOVRPlatform)
+  find_package(LibOVRPlatform REQUIRED)
+  target_include_directories(${TARGET_NAME} PRIVATE ${LIBOVRPLATFORM_INCLUDE_DIRS})
+  target_link_libraries(${TARGET_NAME} ${LIBOVRPLATFORM_LIBRARIES})
 endif()

plugins/oculus/src/OculusHelpers.cpp

@@ -15,8 +15,12 @@
 #include <QtCore/QDir>
 #include <QtCore/QProcessEnvironment>
 
+#define OVRPL_DISABLED
+#include <OVR_Platform.h>
+
 #include <controllers/Input.h>
 #include <controllers/Pose.h>
+#include <shared/GlobalAppProperties.h>
 #include <NumericalConstants.h>
 
 Q_LOGGING_CATEGORY(displayplugins, "hifi.plugins.display")
@@ -89,6 +93,18 @@ ovrSession acquireOculusSession() {
             return session;
         }
 
+#ifdef OCULUS_APP_ID
+        if (qApp->property(hifi::properties::OCULUS_STORE).toBool()) {
+            if (ovr_PlatformInitializeWindows(OCULUS_APP_ID) != ovrPlatformInitialize_Success) {
+                // we were unable to initialize the platform for entitlement check - fail the check
+                _quitRequested = true;
+            } else {
+                qCDebug(oculus) << "Performing Oculus Platform entitlement check";
+                ovr_Entitlement_GetIsViewerEntitled();
+            }
+        }
+#endif
+
         Q_ASSERT(0 == refCount);
         ovrGraphicsLuid luid;
         if (!OVR_SUCCESS(ovr_Create(&session, &luid))) {
@@ -127,6 +143,35 @@ void handleOVREvents() {
 
     _quitRequested = status.ShouldQuit;
     _reorientRequested = status.ShouldRecenter;
+
+ #ifdef OCULUS_APP_ID
+
+    if (qApp->property(hifi::properties::OCULUS_STORE).toBool()) {
+        // pop messages to see if we got a return for an entitlement check
+        ovrMessageHandle message = ovr_PopMessage();
+
+        while (message) {
+            switch (ovr_Message_GetType(message)) {
+                case ovrMessage_Entitlement_GetIsViewerEntitled: {
+                    if (!ovr_Message_IsError(message)) {
+                        // this viewer is entitled, no need to flag anything
+                        qCDebug(oculus) << "Oculus Platform entitlement check succeeded, proceeding normally";
+                    } else {
+                        // we failed the entitlement check, set our flag so the app can stop
+                        qCDebug(oculus) << "Oculus Platform entitlement check failed, app will now quit" << OCULUS_APP_ID;
+                        _quitRequested = true;
+                    }
+                }
+            }
+
+            // free the message handle to cleanup and not leak
+            ovr_FreeMessage(message);
+
+            // pop the next message to check, if there is one
+            message = ovr_PopMessage();
+        }
+    }
+#endif
 }
 
 bool quitRequested() {
@@ -217,4 +262,4 @@ controller::Pose ovrControllerPoseToHandPose(
     pose.velocity = toGlm(handPose.LinearVelocity);
     pose.valid = true;
     return pose;
-}
+}