love2d.love/src/common/android.cpp

/**
 * Copyright (c) 2006-2023 LOVE Development Team
 *
 * This software is provided 'as-is', without any express or implied
 * warranty.  In no event will the authors be held liable for any damages
 * arising from the use of this software.
 *
 * Permission is granted to anyone to use this software for any purpose,
 * including commercial applications, and to alter it and redistribute it
 * freely, subject to the following restrictions:
 *
 * 1. The origin of this software must not be misrepresented; you must not
 *    claim that you wrote the original software. If you use this software
 *    in a product, an acknowledgment in the product documentation would be
 *    appreciated but is not required.
 * 2. Altered source versions must be plainly marked as such, and must not be
 *    misrepresented as being the original software.
 * 3. This notice may not be removed or altered from any source distribution.
 **/

#include "android.h"

#ifdef LOVE_ANDROID

#include <cerrno>
#include <unordered_map>

#include <SDL.h>

#include <jni.h>
#include <android/asset_manager.h>
#include <android/asset_manager_jni.h>

#include <sys/stat.h>
#include <sys/types.h>
#include <unistd.h>

#include "filesystem/physfs/PhysfsIo.h"

namespace love
{
namespace android
{

void setImmersive(bool immersive_active)
{
	JNIEnv *env = (JNIEnv*) SDL_AndroidGetJNIEnv();

	jobject activity = (jobject) SDL_AndroidGetActivity();

	jclass clazz(env->GetObjectClass(activity));
	jmethodID method_id = env->GetMethodID(clazz, "setImmersiveMode", "(Z)V");

	env->CallVoidMethod(activity, method_id, immersive_active);

	env->DeleteLocalRef(activity);
	env->DeleteLocalRef(clazz);
}

bool getImmersive()
{
	JNIEnv *env = (JNIEnv*) SDL_AndroidGetJNIEnv();

	jobject activity = (jobject) SDL_AndroidGetActivity();

	jclass clazz(env->GetObjectClass(activity));
	jmethodID method_id = env->GetMethodID(clazz, "getImmersiveMode", "()Z");

	jboolean immersive_active = env->CallBooleanMethod(activity, method_id);

	env->DeleteLocalRef(activity);
	env->DeleteLocalRef(clazz);

	return immersive_active;
}

double getScreenScale()
{
	static double result = -1.;

	if (result == -1.)
	{
		JNIEnv *env = (JNIEnv*) SDL_AndroidGetJNIEnv();
		jclass activity = env->FindClass("org/love2d/android/GameActivity");

		jmethodID getMetrics = env->GetStaticMethodID(activity, "getMetrics", "()Landroid/util/DisplayMetrics;");
		jobject metrics = env->CallStaticObjectMethod(activity, getMetrics);
		jclass metricsClass = env->GetObjectClass(metrics);

		result = env->GetFloatField(metrics, env->GetFieldID(metricsClass, "density", "F"));

		env->DeleteLocalRef(metricsClass);
		env->DeleteLocalRef(metrics);
		env->DeleteLocalRef(activity);
	}

	return result;
}

bool getSafeArea(int &top, int &left, int &bottom, int &right)
{
	JNIEnv *env = (JNIEnv*) SDL_AndroidGetJNIEnv();
	jobject activity = (jobject) SDL_AndroidGetActivity();
	jclass clazz(env->GetObjectClass(activity));
	jmethodID methodID = env->GetMethodID(clazz, "initializeSafeArea", "()Z");
	bool hasSafeArea = false;

	if (methodID == nullptr)
		// NoSuchMethodException is thrown in case methodID is null
		env->ExceptionClear();
	else if ((hasSafeArea = env->CallBooleanMethod(activity, methodID)))
	{
		top = env->GetIntField(activity, env->GetFieldID(clazz, "safeAreaTop", "I"));
		left = env->GetIntField(activity, env->GetFieldID(clazz, "safeAreaLeft", "I"));
		bottom = env->GetIntField(activity, env->GetFieldID(clazz, "safeAreaBottom", "I"));
		right = env->GetIntField(activity, env->GetFieldID(clazz, "safeAreaRight", "I"));
	}

	env->DeleteLocalRef(clazz);
	env->DeleteLocalRef(activity);

	return hasSafeArea;
}

const char *getSelectedGameFile()
{
	static const char *path = NULL;

	if (path)
	{
		delete path;
		path = NULL;
	}

	JNIEnv *env = (JNIEnv*) SDL_AndroidGetJNIEnv();
	jclass activity = env->FindClass("org/love2d/android/GameActivity");

	jmethodID getGamePath = env->GetStaticMethodID(activity, "getGamePath", "()Ljava/lang/String;");
	jstring gamePath = (jstring) env->CallStaticObjectMethod(activity, getGamePath);
	const char *utf = env->GetStringUTFChars(gamePath, 0);
	if (utf)
	{
		path = SDL_strdup(utf);
		env->ReleaseStringUTFChars(gamePath, utf);
	}

	env->DeleteLocalRef(gamePath);
	env->DeleteLocalRef(activity);

	return path;
}

bool openURL(const std::string &url)
{
	JNIEnv *env = (JNIEnv*) SDL_AndroidGetJNIEnv();
	jclass activity = env->FindClass("org/love2d/android/GameActivity");

	jmethodID openURL = env->GetStaticMethodID(activity, "openURLFromLOVE", "(Ljava/lang/String;)Z");

	if (openURL == nullptr)
	{
		env->ExceptionClear();
		openURL = env->GetStaticMethodID(activity, "openURL", "(Ljava/lang/String;)Z");
	}

	jstring url_jstring = (jstring) env->NewStringUTF(url.c_str());

	jboolean result = env->CallStaticBooleanMethod(activity, openURL, url_jstring);

	env->DeleteLocalRef(url_jstring);
	env->DeleteLocalRef(activity);
	return result;
}

void vibrate(double seconds)
{
	JNIEnv *env = (JNIEnv*) SDL_AndroidGetJNIEnv();
	jclass activity = env->FindClass("org/love2d/android/GameActivity");

	jmethodID vibrate_method = env->GetStaticMethodID(activity, "vibrate", "(D)V");
	env->CallStaticVoidMethod(activity, vibrate_method, seconds);

	env->DeleteLocalRef(activity);
}

/*
 * Helper functions for the filesystem module
 */
void freeGameArchiveMemory(void *ptr)
{
	char *game_love_data = static_cast<char*>(ptr);
	delete[] game_love_data;
}

bool loadGameArchiveToMemory(const char* filename, char **ptr, size_t *size)
{
	SDL_RWops *asset_game_file = SDL_RWFromFile(filename, "rb");
	if (!asset_game_file) {
		SDL_Log("Could not find %s", filename);
		return false;
	}

	Sint64 file_size = asset_game_file->size(asset_game_file);
	if (file_size <= 0) {
		SDL_Log("Could not load game from %s. File has invalid file size: %d.", filename, (int) file_size);
		return false;
	}

	*ptr = new char[file_size];
	if (!*ptr) {
		SDL_Log("Could not allocate memory for in-memory game archive");
		return false;
	}

	size_t bytes_copied = asset_game_file->read(asset_game_file, (void*) *ptr, sizeof(char), (size_t) file_size);
	if (bytes_copied != file_size) {
		SDL_Log("Incomplete copy of in-memory game archive!");
		delete[] *ptr;
		return false;
	}

	*size = (size_t) file_size;
	return true;
}

bool directoryExists(const char *path)
{
	struct stat s;
	int err = stat(path, &s);
	if (err == -1)
	{
		if (errno != ENOENT)
			SDL_Log("Error checking for directory %s errno = %d: %s", path, errno, strerror(errno));
		return false;
	}

	return S_ISDIR(s.st_mode);
}

bool mkdir(const char *path)
{
	int err = ::mkdir(path, 0770);
	if (err == -1)
	{
		SDL_Log("Error: Could not create directory %s", path);
		return false;
	}

	return true;
}

bool createStorageDirectories()
{
	std::string internal_storage_path = SDL_AndroidGetInternalStoragePath();

	std::string save_directory = internal_storage_path + "/save";
	if (!directoryExists(save_directory.c_str()) && !mkdir(save_directory.c_str()))
		return false;

	std::string game_directory = internal_storage_path + "/game";
	if (!directoryExists (game_directory.c_str()) && !mkdir(game_directory.c_str()))
		return false;

	return true;
}

bool hasBackgroundMusic()
{
	JNIEnv *env = (JNIEnv*) SDL_AndroidGetJNIEnv();
	jobject activity = (jobject) SDL_AndroidGetActivity();

	jclass clazz(env->GetObjectClass(activity));
	jmethodID method_id = env->GetMethodID(clazz, "hasBackgroundMusic", "()Z");

	jboolean result = env->CallBooleanMethod(activity, method_id);

	env->DeleteLocalRef(activity);
	env->DeleteLocalRef(clazz);

	return result;
}

bool hasRecordingPermission()
{
	JNIEnv *env = (JNIEnv*) SDL_AndroidGetJNIEnv();
	jobject activity = (jobject) SDL_AndroidGetActivity();

	jclass clazz(env->GetObjectClass(activity));
	jmethodID methodID = env->GetMethodID(clazz, "hasRecordAudioPermission", "()Z");
	jboolean result = false;

	if (methodID == nullptr)
		env->ExceptionClear();
	else
		result = env->CallBooleanMethod(activity, methodID);

	env->DeleteLocalRef(activity);
	env->DeleteLocalRef(clazz);

	return result;
}


void requestRecordingPermission()
{
	JNIEnv *env = (JNIEnv*) SDL_AndroidGetJNIEnv();
	jobject activity = (jobject) SDL_AndroidGetActivity();
	jclass clazz(env->GetObjectClass(activity));
	jmethodID methodID = env->GetMethodID(clazz, "requestRecordAudioPermission", "()V");

	if (methodID == nullptr)
		env->ExceptionClear();
	else
		env->CallVoidMethod(activity, methodID);

	env->DeleteLocalRef(clazz);
	env->DeleteLocalRef(activity);
}

void showRecordingPermissionMissingDialog()
{
	JNIEnv *env = (JNIEnv*) SDL_AndroidGetJNIEnv();
	jobject activity = (jobject) SDL_AndroidGetActivity();
	jclass clazz(env->GetObjectClass(activity));
	jmethodID methodID = env->GetMethodID(clazz, "showRecordingAudioPermissionMissingDialog", "()V");

	if (methodID == nullptr)
		env->ExceptionClear();
	else
		env->CallVoidMethod(activity, methodID);

	env->DeleteLocalRef(clazz);
	env->DeleteLocalRef(activity);
}

/* A container for AssetManager Java object */
class AssetManagerObject
{
public:
	AssetManagerObject()
	{
		JNIEnv *env = (JNIEnv *) SDL_AndroidGetJNIEnv();
		jobject am = getLocalAssetManager(env);

		assetManager = env->NewGlobalRef(am);
		env->DeleteLocalRef(am);
	}

	~AssetManagerObject()
	{
		JNIEnv *env = (JNIEnv *) SDL_AndroidGetJNIEnv();
		env->DeleteGlobalRef(assetManager);
	}

	static jobject getLocalAssetManager(JNIEnv *env) {
		jobject self = (jobject) SDL_AndroidGetActivity();
		jclass activity = env->GetObjectClass(self);
		jmethodID method = env->GetMethodID(activity, "getAssets", "()Landroid/content/res/AssetManager;");
		jobject am = env->CallObjectMethod(self, method);

		env->DeleteLocalRef(self);
		env->DeleteLocalRef(activity);
		return am;
	}

	explicit operator jobject()
	{
		return assetManager;
	};
private:
	jobject assetManager;
};

/*
 * Helper functions to aid new fusing method
 */

// This returns *global* reference, no need to free it.
static jobject getJavaAssetManager()
{
	static AssetManagerObject assetManager;
	return (jobject) assetManager;
}

static AAssetManager *getAssetManager()
{
	JNIEnv *env = (JNIEnv*) SDL_AndroidGetJNIEnv();
	return AAssetManager_fromJava(env, (jobject) getJavaAssetManager());
}

namespace aasset
{

struct AssetInfo: public love::filesystem::physfs::PhysfsIo<AssetInfo>
{
	static const uint32_t version = 0;

	AAssetManager *assetManager;
	AAsset *asset;
	char *filename;
	size_t size;

	static AssetInfo *fromAAsset(AAssetManager *assetManager, const char *filename, AAsset *asset)
	{
		return new AssetInfo(assetManager, filename, asset);
	}

	int64_t read(void* buf, uint64_t len) const
	{
		int readed = AAsset_read(asset, buf, (size_t) len);

		PHYSFS_setErrorCode(readed < 0 ? PHYSFS_ERR_OS_ERROR : PHYSFS_ERR_OK);
		return (PHYSFS_sint64) readed;
	}

	int64_t write(const void* buf, uint64_t len) const
	{
		LOVE_UNUSED(buf);
		LOVE_UNUSED(len);

		PHYSFS_setErrorCode(PHYSFS_ERR_READ_ONLY);
		return -1;
	}

	int64_t seek(uint64_t offset) const
	{
		int64_t success = AAsset_seek64(asset, (off64_t) offset, SEEK_SET) != -1;

		PHYSFS_setErrorCode(success ? PHYSFS_ERR_OK : PHYSFS_ERR_OS_ERROR);
		return success;
	}

	int64_t tell() const
	{
		off64_t len = AAsset_getLength64(asset);
		off64_t remain = AAsset_getRemainingLength64(asset);

		return len - remain;
	}

	int64_t length() const
	{
		return AAsset_getLength64(asset);
	}

	int64_t flush() const
	{
		// Do nothing
		PHYSFS_setErrorCode(PHYSFS_ERR_OK);
		return 1;
	}

	AssetInfo *duplicate() const
	{
		AAsset *newAsset = AAssetManager_open(assetManager, filename, AASSET_MODE_RANDOM);

		if (newAsset == nullptr)
		{
			PHYSFS_setErrorCode(PHYSFS_ERR_OS_ERROR);
			return nullptr;
		}

		AAsset_seek64(asset, tell(), SEEK_SET);
		return fromAAsset(assetManager, filename, asset);
	}

	~AssetInfo() override
	{
		AAsset_close(asset);
		delete[] filename;
	}

private:
	AssetInfo(AAssetManager *assetManager, const char *filename, AAsset *asset)
	: assetManager(assetManager)
	, asset(asset)
	, size(strlen(filename) + 1)
	{
		this->filename = new (std::nothrow) char[size];
		memcpy(this->filename, filename, size);
	}
};

static std::unordered_map<std::string, PHYSFS_FileType> fileTree;

void *openArchive(PHYSFS_Io *io, const char *name, int forWrite, int *claimed)
{
	if (forWrite || io->opaque == nullptr || memcmp(io->opaque, "ASET", 4) != 0)
		return nullptr;

	// It's our archive
	*claimed = 1;
	AAssetManager *assetManager = getAssetManager();

	if (fileTree.empty())
	{
		// AAssetDir_getNextFileName intentionally excludes directories, so
		// we have to use JNI that calls AssetManager.list() recursively.
		JNIEnv *env = (JNIEnv *) SDL_AndroidGetJNIEnv();
		jobject activity = (jobject) SDL_AndroidGetActivity();
		jclass clazz = env->GetObjectClass(activity);

		jmethodID method = env->GetMethodID(clazz, "buildFileTree", "()[Ljava/lang/String;");
		jobjectArray list = (jobjectArray) env->CallObjectMethod(activity, method);

		for (jsize i = 0; i < env->GetArrayLength(list); i++)
		{
			jstring jstr = (jstring) env->GetObjectArrayElement(list, i);
			const char *str = env->GetStringUTFChars(jstr, nullptr);

			fileTree[str + 1] = str[0] == 'd' ? PHYSFS_FILETYPE_DIRECTORY : PHYSFS_FILETYPE_REGULAR;

			env->ReleaseStringUTFChars(jstr, str);
			env->DeleteLocalRef(jstr);
		}

		env->DeleteLocalRef(list);
		env->DeleteLocalRef(clazz);
		env->DeleteLocalRef(activity);
	}

	return assetManager;
}

PHYSFS_EnumerateCallbackResult enumerate(
	void *opaque,
	const char *dirname,
	PHYSFS_EnumerateCallback cb,
	const char *origdir,
	void *callbackdata
)
{
	using FileTreeIterator = std::unordered_map<std::string, PHYSFS_FileType>::iterator;
	LOVE_UNUSED(opaque);

	const char *path = dirname;
	if (path == nullptr || (path[0] == '/' && path[1] == 0))
		path = "";

	if (path[0] != 0)
	{
		FileTreeIterator result = fileTree.find(path);

		if (result == fileTree.end() || result->second != PHYSFS_FILETYPE_DIRECTORY)
		{
			PHYSFS_setErrorCode(PHYSFS_ERR_NOT_FOUND);
			return PHYSFS_ENUM_ERROR;
		}
	}

	JNIEnv *env = (JNIEnv *) SDL_AndroidGetJNIEnv();
	jobject assetManager = getJavaAssetManager();
	jclass clazz = env->GetObjectClass(assetManager);
	jmethodID method = env->GetMethodID(clazz, "list", "(Ljava/lang/String;)[Ljava/lang/String;");

	jstring jstringDir = env->NewStringUTF(path);
	jobjectArray dir = (jobjectArray) env->CallObjectMethod(assetManager, method, jstringDir);

	PHYSFS_EnumerateCallbackResult ret = PHYSFS_ENUM_OK;

	if (env->ExceptionCheck())
	{
		// IOException occured
		ret = PHYSFS_ENUM_ERROR;
		env->ExceptionClear();
	}
	else
	{
		jsize i = 0;
		jsize len = env->GetArrayLength(dir);

		while (ret == PHYSFS_ENUM_OK && i < len) {
			jstring jstr = (jstring) env->GetObjectArrayElement(dir, i++);
			const char *name = env->GetStringUTFChars(jstr, nullptr);

			ret = cb(callbackdata, origdir, name);

			env->ReleaseStringUTFChars(jstr, name);
			env->DeleteLocalRef(jstr);
		}

		env->DeleteLocalRef(dir);
	}

	env->DeleteLocalRef(jstringDir);
	env->DeleteLocalRef(clazz);
	return ret;
}

PHYSFS_Io *openRead(void *opaque, const char *name)
{
	AAssetManager *assetManager = (AAssetManager *) opaque;
	AAsset *file = AAssetManager_open(assetManager, name, AASSET_MODE_UNKNOWN);

	if (file == nullptr)
	{
		PHYSFS_setErrorCode(PHYSFS_ERR_NOT_FOUND);
		return nullptr;
	}

	PHYSFS_setErrorCode(PHYSFS_ERR_OK);
	return AssetInfo::fromAAsset(assetManager, name, file);
}

PHYSFS_Io *openWriteAppend(void *opaque, const char *name)
{
	LOVE_UNUSED(opaque);
	LOVE_UNUSED(name);

	// AAsset doesn't support modification
	PHYSFS_setErrorCode(PHYSFS_ERR_READ_ONLY);
	return nullptr;
}

int removeMkdir(void *opaque, const char *name)
{
	LOVE_UNUSED(opaque);
	LOVE_UNUSED(name);

	// AAsset doesn't support modification
	PHYSFS_setErrorCode(PHYSFS_ERR_READ_ONLY);
	return 0;
}

int stat(void *opaque, const char *name, PHYSFS_Stat *out)
{
	using FileTreeIterator = std::unordered_map<std::string, PHYSFS_FileType>::iterator;
	LOVE_UNUSED(opaque);

	FileTreeIterator result = fileTree.find(name);

	if (result != fileTree.end())
	{
		out->filetype = result->second;
		out->modtime = -1;
		out->createtime = -1;
		out->accesstime = -1;
		out->readonly = 1;

		PHYSFS_setErrorCode(PHYSFS_ERR_OK);
		return 1;
	}

	PHYSFS_setErrorCode(PHYSFS_ERR_NOT_FOUND);
	return 0;
}

void closeArchive(void *opaque)
{
	// Do nothing
	LOVE_UNUSED(opaque);
	PHYSFS_setErrorCode(PHYSFS_ERR_OK);
}

static PHYSFS_Archiver g_AAssetArchiver = {
	0,
	{
		"AASSET",
		"Android AAsset Wrapper",
		"LOVE Development Team",
		"https://developer.android.com/ndk/reference/group/asset",
		0
	},
	openArchive,
	enumerate,
	openRead,
	openWriteAppend,
	openWriteAppend,
	removeMkdir,
	removeMkdir,
	stat,
	closeArchive
};

static PHYSFS_sint64 dummyReturn0(PHYSFS_Io *io)
{
	LOVE_UNUSED(io);
	PHYSFS_setErrorCode(PHYSFS_ERR_OK);
	return 0;
}

static PHYSFS_Io *getDummyIO(PHYSFS_Io *io);

static char dummyOpaque[] = "ASET";
static PHYSFS_Io dummyIo = {
	0,
	dummyOpaque,
	nullptr,
	nullptr,
	[](PHYSFS_Io *io, PHYSFS_uint64 offset) -> int
	{
		PHYSFS_setErrorCode(offset == 0 ? PHYSFS_ERR_OK : PHYSFS_ERR_PAST_EOF);
		return offset == 0;
	},
	dummyReturn0,
	dummyReturn0,
	getDummyIO,
	nullptr,
	[](PHYSFS_Io *io) { LOVE_UNUSED(io); }
};

static PHYSFS_Io *getDummyIO(PHYSFS_Io *io)
{
	return &dummyIo;
}

}

static bool isVirtualArchiveInitialized = false;

bool initializeVirtualArchive()
{
	if (isVirtualArchiveInitialized)
		return true;

	if (!PHYSFS_registerArchiver(&aasset::g_AAssetArchiver))
		return false;
	if (!PHYSFS_mountIo(&aasset::dummyIo, "ASET.AASSET", nullptr, 0))
	{
		PHYSFS_deregisterArchiver(aasset::g_AAssetArchiver.info.extension);
		return false;
	}

	isVirtualArchiveInitialized = true;
	return true;
}

void deinitializeVirtualArchive()
{
	if (isVirtualArchiveInitialized)
	{
		PHYSFS_deregisterArchiver(aasset::g_AAssetArchiver.info.extension);
		isVirtualArchiveInitialized = false;
	}
}

bool checkFusedGame(void **physfsIO_Out)
{
	// TODO: Reorder the loading in 12.0
	PHYSFS_Io *&io = *(PHYSFS_Io **) physfsIO_Out;
	AAssetManager *assetManager = getAssetManager();

	// Prefer game.love inside assets/ folder
	AAsset *asset = AAssetManager_open(assetManager, "game.love", AASSET_MODE_RANDOM);
	if (asset)
	{
		io = aasset::AssetInfo::fromAAsset(assetManager, "game.love", asset);
		return true;
	}

	// If there's no game.love inside assets/ try main.lua
	asset = AAssetManager_open(assetManager, "main.lua", AASSET_MODE_STREAMING);

	if (asset)
	{
		AAsset_close(asset);
		io = nullptr;
		return true;
	}

	// Not found
	return false;
}

const char *getCRequirePath()
{
	static bool initialized = false;
	static const char *path = nullptr;

	if (!initialized)
	{
		JNIEnv *env = (JNIEnv*) SDL_AndroidGetJNIEnv();
		jobject activity = (jobject) SDL_AndroidGetActivity();

		jclass clazz(env->GetObjectClass(activity));
		jmethodID method_id = env->GetMethodID(clazz, "getCRequirePath", "()Ljava/lang/String;");

		path = "";
		initialized = true;

		if (method_id)
		{
			jstring cpath = (jstring) env->CallObjectMethod(activity, method_id);
			const char *utf = env->GetStringUTFChars(cpath, nullptr);
			if (utf)
			{
				path = SDL_strdup(utf);
				env->ReleaseStringUTFChars(cpath, utf);
			}

			env->DeleteLocalRef(cpath);
		}
		else
		{
			// NoSuchMethodException is thrown in case methodID is null
			env->ExceptionClear();
			return "";
		}

		env->DeleteLocalRef(activity);
		env->DeleteLocalRef(clazz);
	}

	return path;
}

} // android
} // love

#endif // LOVE_ANDROID