/**************************************************************************** ** ** Copyright (C) 2016 The Qt Company Ltd. ** Contact: https://www.qt.io/licensing/ ** ** This file is part of the QtCore module of the Qt Toolkit. ** ** $QT_BEGIN_LICENSE:LGPL$ ** Commercial License Usage ** Licensees holding valid commercial Qt licenses may use this file in ** accordance with the commercial license agreement provided with the ** Software or, alternatively, in accordance with the terms contained in ** a written agreement between you and The Qt Company. For licensing terms ** and conditions see https://www.qt.io/terms-conditions. For further ** information use the contact form at https://www.qt.io/contact-us. ** ** GNU Lesser General Public License Usage ** Alternatively, this file may be used under the terms of the GNU Lesser ** General Public License version 3 as published by the Free Software ** Foundation and appearing in the file LICENSE.LGPL3 included in the ** packaging of this file. Please review the following information to ** ensure the GNU Lesser General Public License version 3 requirements ** will be met: https://www.gnu.org/licenses/lgpl-3.0.html. ** ** GNU General Public License Usage ** Alternatively, this file may be used under the terms of the GNU ** General Public License version 2.0 or (at your option) the GNU General ** Public license version 3 or any later version approved by the KDE Free ** Qt Foundation. The licenses are as published by the Free Software ** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3 ** included in the packaging of this file. Please review the following ** information to ensure the GNU General Public License requirements will ** be met: https://www.gnu.org/licenses/gpl-2.0.html and ** https://www.gnu.org/licenses/gpl-3.0.html. ** ** $QT_END_LICENSE$ ** ****************************************************************************/ #include "qjnihelpers_p.h" #include "qjni_p.h" #include "qmutex.h" #include "qlist.h" #include "qsemaphore.h" #include "qsharedpointer.h" #include "qvector.h" #include "qthread.h" #include "qcoreapplication.h" #include #include #include QT_BEGIN_NAMESPACE namespace QtAndroidPrivate { // *Listener virtual function implementations. // Defined out-of-line to pin the vtable/type_info. ActivityResultListener::~ActivityResultListener() {} NewIntentListener::~NewIntentListener() {} ResumePauseListener::~ResumePauseListener() {} void ResumePauseListener::handlePause() {} void ResumePauseListener::handleResume() {} GenericMotionEventListener::~GenericMotionEventListener() {} KeyEventListener::~KeyEventListener() {} } static JavaVM *g_javaVM = nullptr; static jobject g_jActivity = nullptr; static jobject g_jService = nullptr; static jobject g_jClassLoader = nullptr; static jint g_androidSdkVersion = 0; static jclass g_jNativeClass = nullptr; static jmethodID g_runPendingCppRunnablesMethodID = nullptr; static jmethodID g_hideSplashScreenMethodID = nullptr; Q_GLOBAL_STATIC(std::deque, g_pendingRunnables); static QBasicMutex g_pendingRunnablesMutex; Q_GLOBAL_STATIC_WITH_ARGS(QtAndroidPrivate::OnBindListener*, g_onBindListener, (nullptr)); Q_GLOBAL_STATIC(QMutex, g_onBindListenerMutex); Q_GLOBAL_STATIC(QSemaphore, g_waitForServiceSetupSemaphore); Q_GLOBAL_STATIC(QAtomicInt, g_serviceSetupLockers); class PermissionsResultClass : public QObject { Q_OBJECT public: PermissionsResultClass(const QtAndroidPrivate::PermissionsResultFunc &func) : m_func(func) {} Q_INVOKABLE void sendResult(const QtAndroidPrivate::PermissionsHash &result) { m_func(result); delete this;} private: QtAndroidPrivate::PermissionsResultFunc m_func; }; typedef QHash PendingPermissionRequestsHash; Q_GLOBAL_STATIC(PendingPermissionRequestsHash, g_pendingPermissionRequests); static QBasicMutex g_pendingPermissionRequestsMutex; static int nextRequestCode() { static QBasicAtomicInt counter = Q_BASIC_ATOMIC_INITIALIZER(0); return counter.fetchAndAddRelaxed(1); } // function called from Java from Android UI thread static void runPendingCppRunnables(JNIEnv */*env*/, jobject /*obj*/) { for (;;) { // run all posted runnables QMutexLocker locker(&g_pendingRunnablesMutex); if (g_pendingRunnables->empty()) { break; } QtAndroidPrivate::Runnable runnable(std::move(g_pendingRunnables->front())); g_pendingRunnables->pop_front(); locker.unlock(); runnable(); // run it outside the sync block! } } namespace { struct GenericMotionEventListeners { QMutex mutex; QVector listeners; }; enum { PERMISSION_GRANTED = 0 }; } Q_GLOBAL_STATIC(GenericMotionEventListeners, g_genericMotionEventListeners) static void sendRequestPermissionsResult(JNIEnv *env, jobject /*obj*/, jint requestCode, jobjectArray permissions, jintArray grantResults) { QMutexLocker locker(&g_pendingPermissionRequestsMutex); auto it = g_pendingPermissionRequests->find(requestCode); if (it == g_pendingPermissionRequests->end()) { // show an error or something ? return; } auto request = *it; g_pendingPermissionRequests->erase(it); locker.unlock(); Qt::ConnectionType connection = QThread::currentThread() == request->thread() ? Qt::DirectConnection : Qt::QueuedConnection; QtAndroidPrivate::PermissionsHash hash; const int size = env->GetArrayLength(permissions); std::unique_ptr results(new jint[size]); env->GetIntArrayRegion(grantResults, 0, size, results.get()); for (int i = 0 ; i < size; ++i) { const auto &permission = QJNIObjectPrivate(env->GetObjectArrayElement(permissions, i)).toString(); auto value = results[i] == PERMISSION_GRANTED ? QtAndroidPrivate::PermissionsResult::Granted : QtAndroidPrivate::PermissionsResult::Denied; hash[permission] = value; } QMetaObject::invokeMethod(request, "sendResult", connection, Q_ARG(QtAndroidPrivate::PermissionsHash, hash)); } static jboolean dispatchGenericMotionEvent(JNIEnv *, jclass, jobject event) { jboolean ret = JNI_FALSE; QMutexLocker locker(&g_genericMotionEventListeners()->mutex); for (auto *listener : qAsConst(g_genericMotionEventListeners()->listeners)) ret |= listener->handleGenericMotionEvent(event); return ret; } namespace { struct KeyEventListeners { QMutex mutex; QVector listeners; }; } Q_GLOBAL_STATIC(KeyEventListeners, g_keyEventListeners) static jboolean dispatchKeyEvent(JNIEnv *, jclass, jobject event) { jboolean ret = JNI_FALSE; QMutexLocker locker(&g_keyEventListeners()->mutex); for (auto *listener : qAsConst(g_keyEventListeners()->listeners)) ret |= listener->handleKeyEvent(event); return ret; } namespace { class ActivityResultListeners { public: QMutex mutex; QList listeners; }; } Q_GLOBAL_STATIC(ActivityResultListeners, g_activityResultListeners) void QtAndroidPrivate::registerActivityResultListener(ActivityResultListener *listener) { QMutexLocker locker(&g_activityResultListeners()->mutex); g_activityResultListeners()->listeners.append(listener); } void QtAndroidPrivate::unregisterActivityResultListener(ActivityResultListener *listener) { QMutexLocker locker(&g_activityResultListeners()->mutex); g_activityResultListeners()->listeners.removeAll(listener); } void QtAndroidPrivate::handleActivityResult(jint requestCode, jint resultCode, jobject data) { QMutexLocker locker(&g_activityResultListeners()->mutex); const QList &listeners = g_activityResultListeners()->listeners; for (int i=0; ihandleActivityResult(requestCode, resultCode, data)) break; } } namespace { class NewIntentListeners { public: QMutex mutex; QList listeners; }; } Q_GLOBAL_STATIC(NewIntentListeners, g_newIntentListeners) void QtAndroidPrivate::registerNewIntentListener(NewIntentListener *listener) { QMutexLocker locker(&g_newIntentListeners()->mutex); g_newIntentListeners()->listeners.append(listener); } void QtAndroidPrivate::unregisterNewIntentListener(NewIntentListener *listener) { QMutexLocker locker(&g_newIntentListeners()->mutex); g_newIntentListeners()->listeners.removeAll(listener); } void QtAndroidPrivate::handleNewIntent(JNIEnv *env, jobject intent) { QMutexLocker locker(&g_newIntentListeners()->mutex); const QList &listeners = g_newIntentListeners()->listeners; for (int i=0; ihandleNewIntent(env, intent)) break; } } namespace { class ResumePauseListeners { public: QMutex mutex; QList listeners; }; } Q_GLOBAL_STATIC(ResumePauseListeners, g_resumePauseListeners) void QtAndroidPrivate::registerResumePauseListener(ResumePauseListener *listener) { QMutexLocker locker(&g_resumePauseListeners()->mutex); g_resumePauseListeners()->listeners.append(listener); } void QtAndroidPrivate::unregisterResumePauseListener(ResumePauseListener *listener) { QMutexLocker locker(&g_resumePauseListeners()->mutex); g_resumePauseListeners()->listeners.removeAll(listener); } void QtAndroidPrivate::handlePause() { QMutexLocker locker(&g_resumePauseListeners()->mutex); const QList &listeners = g_resumePauseListeners()->listeners; for (int i=0; ihandlePause(); } void QtAndroidPrivate::handleResume() { QMutexLocker locker(&g_resumePauseListeners()->mutex); const QList &listeners = g_resumePauseListeners()->listeners; for (int i=0; ihandleResume(); } static inline bool exceptionCheck(JNIEnv *env) { if (env->ExceptionCheck()) { #ifdef QT_DEBUG env->ExceptionDescribe(); #endif // QT_DEBUG env->ExceptionClear(); return true; } return false; } static void setAndroidSdkVersion(JNIEnv *env) { jclass androidVersionClass = env->FindClass("android/os/Build$VERSION"); if (exceptionCheck(env)) return; jfieldID androidSDKFieldID = env->GetStaticFieldID(androidVersionClass, "SDK_INT", "I"); if (exceptionCheck(env)) return; g_androidSdkVersion = env->GetStaticIntField(androidVersionClass, androidSDKFieldID); } static void setNativeActivity(JNIEnv *env, jclass, jobject activity) { if (g_jActivity != 0) env->DeleteGlobalRef(g_jActivity); if (activity != 0) { g_jActivity = env->NewGlobalRef(activity); env->DeleteLocalRef(activity); } else { g_jActivity = 0; } } static void setNativeService(JNIEnv *env, jclass, jobject service) { if (g_jService != 0) env->DeleteGlobalRef(g_jService); if (service != 0) { g_jService = env->NewGlobalRef(service); env->DeleteLocalRef(service); } else { g_jService = 0; } } jint QtAndroidPrivate::initJNI(JavaVM *vm, JNIEnv *env) { jclass jQtNative = env->FindClass("org/qtproject/qt5/android/QtNative"); if (exceptionCheck(env)) return JNI_ERR; jmethodID activityMethodID = env->GetStaticMethodID(jQtNative, "activity", "()Landroid/app/Activity;"); if (exceptionCheck(env)) return JNI_ERR; jobject activity = env->CallStaticObjectMethod(jQtNative, activityMethodID); if (exceptionCheck(env)) return JNI_ERR; jmethodID serviceMethodID = env->GetStaticMethodID(jQtNative, "service", "()Landroid/app/Service;"); if (exceptionCheck(env)) return JNI_ERR; jobject service = env->CallStaticObjectMethod(jQtNative, serviceMethodID); if (exceptionCheck(env)) return JNI_ERR; jmethodID classLoaderMethodID = env->GetStaticMethodID(jQtNative, "classLoader", "()Ljava/lang/ClassLoader;"); if (exceptionCheck(env)) return JNI_ERR; jobject classLoader = env->CallStaticObjectMethod(jQtNative, classLoaderMethodID); if (exceptionCheck(env)) return JNI_ERR; setAndroidSdkVersion(env); g_jClassLoader = env->NewGlobalRef(classLoader); env->DeleteLocalRef(classLoader); if (activity) { g_jActivity = env->NewGlobalRef(activity); env->DeleteLocalRef(activity); } if (service) { g_jService = env->NewGlobalRef(service); env->DeleteLocalRef(service); } g_javaVM = vm; static const JNINativeMethod methods[] = { {"runPendingCppRunnables", "()V", reinterpret_cast(runPendingCppRunnables)}, {"dispatchGenericMotionEvent", "(Landroid/view/MotionEvent;)Z", reinterpret_cast(dispatchGenericMotionEvent)}, {"dispatchKeyEvent", "(Landroid/view/KeyEvent;)Z", reinterpret_cast(dispatchKeyEvent)}, {"setNativeActivity", "(Landroid/app/Activity;)V", reinterpret_cast(setNativeActivity)}, {"setNativeService", "(Landroid/app/Service;)V", reinterpret_cast(setNativeService)}, {"sendRequestPermissionsResult", "(I[Ljava/lang/String;[I)V", reinterpret_cast(sendRequestPermissionsResult)}, }; const bool regOk = (env->RegisterNatives(jQtNative, methods, sizeof(methods) / sizeof(methods[0])) == JNI_OK); if (!regOk && exceptionCheck(env)) return JNI_ERR; g_runPendingCppRunnablesMethodID = env->GetStaticMethodID(jQtNative, "runPendingCppRunnablesOnAndroidThread", "()V"); g_hideSplashScreenMethodID = env->GetStaticMethodID(jQtNative, "hideSplashScreen", "(I)V"); g_jNativeClass = static_cast(env->NewGlobalRef(jQtNative)); env->DeleteLocalRef(jQtNative); qRegisterMetaType(); return JNI_OK; } jobject QtAndroidPrivate::activity() { return g_jActivity; } jobject QtAndroidPrivate::service() { return g_jService; } jobject QtAndroidPrivate::context() { if (g_jActivity) return g_jActivity; if (g_jService) return g_jService; return 0; } JavaVM *QtAndroidPrivate::javaVM() { return g_javaVM; } jobject QtAndroidPrivate::classLoader() { return g_jClassLoader; } jint QtAndroidPrivate::androidSdkVersion() { return g_androidSdkVersion; } void QtAndroidPrivate::runOnUiThread(QRunnable *runnable, JNIEnv *env) { runOnAndroidThread([runnable]() { runnable->run(); if (runnable->autoDelete()) delete runnable; }, env); } void QtAndroidPrivate::runOnAndroidThread(const QtAndroidPrivate::Runnable &runnable, JNIEnv *env) { QMutexLocker locker(&g_pendingRunnablesMutex); const bool triggerRun = g_pendingRunnables->empty(); g_pendingRunnables->push_back(runnable); locker.unlock(); if (triggerRun) env->CallStaticVoidMethod(g_jNativeClass, g_runPendingCppRunnablesMethodID); } static bool waitForSemaphore(int timeoutMs, QSharedPointer sem) { while (timeoutMs > 0) { if (sem->tryAcquire(1, 10)) return true; timeoutMs -= 10; QCoreApplication::processEvents(); } return false; } void QtAndroidPrivate::runOnAndroidThreadSync(const QtAndroidPrivate::Runnable &runnable, JNIEnv *env, int timeoutMs) { QSharedPointer sem(new QSemaphore); runOnAndroidThread([&runnable, sem]{ runnable(); sem->release(); }, env); waitForSemaphore(timeoutMs, sem); } void QtAndroidPrivate::requestPermissions(JNIEnv *env, const QStringList &permissions, const QtAndroidPrivate::PermissionsResultFunc &callbackFunc, bool directCall) { if (androidSdkVersion() < 23 || !activity()) { QHash res; for (const auto &perm : permissions) res[perm] = checkPermission(perm); callbackFunc(res); return; } // Check API 23+ permissions const int requestCode = nextRequestCode(); if (!directCall) { QMutexLocker locker(&g_pendingPermissionRequestsMutex); (*g_pendingPermissionRequests)[requestCode] = new PermissionsResultClass(callbackFunc); } runOnAndroidThread([permissions, callbackFunc, requestCode, directCall] { if (directCall) { QMutexLocker locker(&g_pendingPermissionRequestsMutex); (*g_pendingPermissionRequests)[requestCode] = new PermissionsResultClass(callbackFunc); } QJNIEnvironmentPrivate env; auto array = env->NewObjectArray(permissions.size(), env->FindClass("java/lang/String"), nullptr); int index = 0; for (const auto &perm : permissions) env->SetObjectArrayElement(array, index++, QJNIObjectPrivate::fromString(perm).object()); QJNIObjectPrivate(activity()).callMethod("requestPermissions", "([Ljava/lang/String;I)V", array, requestCode); env->DeleteLocalRef(array); }, env); } QtAndroidPrivate::PermissionsHash QtAndroidPrivate::requestPermissionsSync(JNIEnv *env, const QStringList &permissions, int timeoutMs) { QSharedPointer> res(new QHash()); QSharedPointer sem(new QSemaphore); requestPermissions(env, permissions, [sem, res](const QHash &result){ *res = result; sem->release(); }, true); if (waitForSemaphore(timeoutMs, sem)) return std::move(*res); else // mustn't touch *res return QHash(); } QtAndroidPrivate::PermissionsResult QtAndroidPrivate::checkPermission(const QString &permission) { const auto res = QJNIObjectPrivate::callStaticMethod("org/qtproject/qt5/android/QtNative", "checkSelfPermission", "(Ljava/lang/String;)I", QJNIObjectPrivate::fromString(permission).object()); return res == PERMISSION_GRANTED ? PermissionsResult::Granted : PermissionsResult::Denied; } bool QtAndroidPrivate::shouldShowRequestPermissionRationale(const QString &permission) { if (androidSdkVersion() < 23 || !activity()) return false; return QJNIObjectPrivate(activity()).callMethod("shouldShowRequestPermissionRationale", "(Ljava/lang/String;)Z", QJNIObjectPrivate::fromString(permission).object()); } void QtAndroidPrivate::registerGenericMotionEventListener(QtAndroidPrivate::GenericMotionEventListener *listener) { QMutexLocker locker(&g_genericMotionEventListeners()->mutex); g_genericMotionEventListeners()->listeners.push_back(listener); } void QtAndroidPrivate::unregisterGenericMotionEventListener(QtAndroidPrivate::GenericMotionEventListener *listener) { QMutexLocker locker(&g_genericMotionEventListeners()->mutex); g_genericMotionEventListeners()->listeners.removeOne(listener); } void QtAndroidPrivate::registerKeyEventListener(QtAndroidPrivate::KeyEventListener *listener) { QMutexLocker locker(&g_keyEventListeners()->mutex); g_keyEventListeners()->listeners.push_back(listener); } void QtAndroidPrivate::unregisterKeyEventListener(QtAndroidPrivate::KeyEventListener *listener) { QMutexLocker locker(&g_keyEventListeners()->mutex); g_keyEventListeners()->listeners.removeOne(listener); } void QtAndroidPrivate::hideSplashScreen(JNIEnv *env, int duration) { env->CallStaticVoidMethod(g_jNativeClass, g_hideSplashScreenMethodID, duration); } void QtAndroidPrivate::waitForServiceSetup() { g_waitForServiceSetupSemaphore->acquire(); } int QtAndroidPrivate::acuqireServiceSetup(int flags) { g_serviceSetupLockers->ref(); return flags; } void QtAndroidPrivate::setOnBindListener(QtAndroidPrivate::OnBindListener *listener) { QMutexLocker lock(g_onBindListenerMutex); *g_onBindListener = listener; if (!g_serviceSetupLockers->deref()) g_waitForServiceSetupSemaphore->release(); } jobject QtAndroidPrivate::callOnBindListener(jobject intent) { QMutexLocker lock(g_onBindListenerMutex); if (*g_onBindListener) return (*g_onBindListener)->onBind(intent); return nullptr; } QT_END_NAMESPACE #include "qjnihelpers.moc"