Android: QStandardPaths implementation

Adds standard paths implementation for Android.

[ChangeLog][QtCore][QStandardPaths] Added
QStandardPaths implementation for Android.

Task-number: QTBUG-34631

Change-Id: I38673204a521a990438470c4e165105a2b02b7ad
Reviewed-by: BogDan Vatra <bogdan@kde.org>
Reviewed-by: Shawn Rutledge <shawn.rutledge@digia.com>
bb10
Christian Strømme 2013-06-18 13:56:29 +02:00 committed by The Qt Project
parent 48db373ce3
commit aa7ec3cdf5
3 changed files with 336 additions and 3 deletions

View File

@ -142,6 +142,8 @@ win32 {
}
} else:blackberry {
SOURCES += io/qstandardpaths_blackberry.cpp
} else:android {
SOURCES += io/qstandardpaths_android.cpp
} else {
SOURCES += io/qstandardpaths_unix.cpp
}

View File

@ -0,0 +1,331 @@
/****************************************************************************
**
** Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies).
** Contact: http://www.qt-project.org/legal
**
** 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 Digia. For licensing terms and
** conditions see http://qt.digia.com/licensing. For further information
** use the contact form at http://qt.digia.com/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 2.1 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPL included in the
** packaging of this file. Please review the following information to
** ensure the GNU Lesser General Public License version 2.1 requirements
** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
**
** In addition, as a special exception, Digia gives you certain additional
** rights. These rights are described in the Digia Qt LGPL Exception
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 3.0 as published by the Free Software
** Foundation and appearing in the file LICENSE.GPL included in the
** packaging of this file. Please review the following information to
** ensure the GNU General Public License version 3.0 requirements will be
** met: http://www.gnu.org/copyleft/gpl.html.
**
**
** $QT_END_LICENSE$
**
****************************************************************************/
#include "qstandardpaths.h"
#ifndef QT_NO_STANDARDPATHS
#include <QtCore/private/qjni_p.h>
#include <QtCore/private/qjnihelpers_p.h>
#include <QtCore/qmap.h>
#include <QDir>
QT_BEGIN_NAMESPACE
typedef QMap<QString, QString> AndroidDirCache;
Q_GLOBAL_STATIC(AndroidDirCache, androidDirCache)
static QString testDir()
{
return QStandardPaths::isTestModeEnabled() ? QLatin1String("/qttest")
: QLatin1String("");
}
static QJNIObjectPrivate applicationContext()
{
static QJNIObjectPrivate appCtx;
if (appCtx.isValid())
return appCtx;
QJNIObjectPrivate activity = QtAndroidPrivate::activity();
if (!activity.isValid())
return appCtx;
appCtx = activity.callObjectMethod("getApplicationContext",
"()Landroid/content/Context;");
return appCtx;
}
static inline QString getAbsolutePath(const QJNIObjectPrivate &file)
{
QJNIObjectPrivate path = file.callObjectMethod("getAbsolutePath",
"()Ljava/lang/String;");
if (!path.isValid())
return QString();
return path.toString();
}
/*
* The root of the external storage
*
*/
static QString getExternalStorageDirectory()
{
QString &path = (*androidDirCache)[QStringLiteral("EXT_ROOT")];
if (!path.isEmpty())
return path;
QJNIObjectPrivate file = QJNIObjectPrivate::callStaticObjectMethod("android/os/Environment",
"getExternalStorageDirectory",
"()Ljava/io/File;");
if (!file.isValid())
return QString();
return (path = getAbsolutePath(file));
}
/*
* Locations where applications can place user files (public).
* E.g., /storage/Music
*/
static QString getExternalStoragePublicDirectory(const char *directoryField)
{
QString &path = (*androidDirCache)[QLatin1String(directoryField)];
if (!path.isEmpty())
return path;
QJNIObjectPrivate dirField = QJNIObjectPrivate::getStaticObjectField("android/os/Environment",
directoryField,
"Ljava/lang/String;");
if (!dirField.isValid())
return QString();
QJNIObjectPrivate file = QJNIObjectPrivate::callStaticObjectMethod("android/os/Environment",
"getExternalStoragePublicDirectory",
"(Ljava/lang/String;)Ljava/io/File;",
dirField.object());
if (!file.isValid())
return QString();
return (path = getAbsolutePath(file));
}
/*
* Locations where applications can place persistent files it owns.
* E.g., /storage/org.app/Music
*/
static QString getExternalFilesDir(const char *directoryField = 0)
{
QString &path = (*androidDirCache)[QString(QLatin1String("APPNAME_%1")).arg(QLatin1String(directoryField))];
if (!path.isEmpty())
return path;
QJNIObjectPrivate activity = QtAndroidPrivate::activity();
if (!activity.isValid())
return QString();
QJNIObjectPrivate appCtx = applicationContext();
if (!appCtx.isValid())
return QString();
QJNIObjectPrivate dirField = QJNIObjectPrivate::fromString(QLatin1String(""));
if (directoryField) {
dirField = QJNIObjectPrivate::getStaticObjectField("android/os/Environment",
directoryField,
"Ljava/lang/String;");
if (!dirField.isValid())
return QString();
}
QJNIObjectPrivate file = appCtx.callObjectMethod("getExternalFilesDir",
"(Ljava/lang/String;)Ljava/io/File;",
dirField.object());
if (!file.isValid())
return QString();
return (path = getAbsolutePath(file));
}
/*
* Directory where applications can store cache files it owns (public).
* E.g., /storage/org.app/
*/
static QString getExternalCacheDir()
{
QString &path = (*androidDirCache)[QStringLiteral("APPNAME_CACHE")];
if (!path.isEmpty())
return path;
QJNIObjectPrivate appCtx = applicationContext();
if (!appCtx.isValid())
return QString();
QJNIObjectPrivate file = appCtx.callObjectMethod("getExternalCacheDir",
"()Ljava/io/File;");
if (!file.isValid())
return QString();
return (path = getAbsolutePath(file));
}
/*
* Directory where applications can store cache files it owns (private).
*/
static QString getCacheDir()
{
QString &path = (*androidDirCache)[QStringLiteral("APPROOT_CACHE")];
if (!path.isEmpty())
return path;
QJNIObjectPrivate appCtx = applicationContext();
if (!appCtx.isValid())
return QString();
QJNIObjectPrivate file = appCtx.callObjectMethod("getCacheDir",
"()Ljava/io/File;");
if (!file.isValid())
return QString();
return (path = getAbsolutePath(file));
}
/*
* Directory where applications can store files it owns (private).
* (Same location as $HOME)
*/
static QString getFilesDir()
{
QString &path = (*androidDirCache)[QStringLiteral("APPROOT_FILES")];
if (!path.isEmpty())
return path;
return (path = QDir::homePath());
}
QString QStandardPaths::writableLocation(StandardLocation type)
{
switch (type) {
case QStandardPaths::MusicLocation:
return getExternalStoragePublicDirectory("DIRECTORY_MUSIC");
case QStandardPaths::MoviesLocation:
return getExternalStoragePublicDirectory("DIRECTORY_MOVIES");
case QStandardPaths::PicturesLocation:
return getExternalStoragePublicDirectory("DIRECTORY_PICTURES");
case QStandardPaths::DocumentsLocation:
if (QtAndroidPrivate::androidSdkVersion() > 18)
return getExternalStoragePublicDirectory("DIRECTORY_DOCUMENTS");
else
return getExternalStorageDirectory() + QLatin1String("/Documents");
case QStandardPaths::DownloadLocation:
return getExternalStoragePublicDirectory("DIRECTORY_DOWNLOADS");
case QStandardPaths::GenericConfigLocation:
case QStandardPaths::ConfigLocation:
return getFilesDir() + testDir() + QLatin1String("/settings");
case QStandardPaths::GenericDataLocation:
return getExternalStorageDirectory() + testDir();
case QStandardPaths::DataLocation:
return getFilesDir() + testDir();
case QStandardPaths::GenericCacheLocation:
case QStandardPaths::RuntimeLocation:
case QStandardPaths::TempLocation:
case QStandardPaths::CacheLocation:
return getCacheDir() + testDir();
case QStandardPaths::DesktopLocation:
case QStandardPaths::HomeLocation:
return getFilesDir();
case QStandardPaths::ApplicationsLocation:
case QStandardPaths::FontsLocation:
default:
break;
}
return QString();
}
QStringList QStandardPaths::standardLocations(StandardLocation type)
{
if (type == MusicLocation) {
return QStringList() << writableLocation(type)
<< getExternalFilesDir("DIRECTORY_MUSIC")
<< getExternalStoragePublicDirectory("DIRECTORY_PODCASTS")
<< getExternalFilesDir("DIRECTORY_PODCASTS")
<< getExternalStoragePublicDirectory("DIRECTORY_NOTIFICATIONS")
<< getExternalFilesDir("DIRECTORY_NOTIFICATIONS")
<< getExternalStoragePublicDirectory("DIRECTORY_ALARMS")
<< getExternalFilesDir("DIRECTORY_ALARMS");
}
if (type == MoviesLocation) {
return QStringList() << writableLocation(type)
<< getExternalFilesDir("DIRECTORY_MOVIES");
}
if (type == PicturesLocation) {
return QStringList() << writableLocation(type)
<< getExternalFilesDir("DIRECTORY_PICTURES");
}
if (type == DocumentsLocation) {
if (QtAndroidPrivate::androidSdkVersion() > 18) {
return QStringList() << writableLocation(type)
<< getExternalFilesDir("DIRECTORY_DOCUMENTS");
} else {
return QStringList() << writableLocation(type)
<< getExternalFilesDir() + QLatin1String("/Documents");
}
}
if (type == DownloadLocation) {
return QStringList() << writableLocation(type)
<< getExternalFilesDir("DIRECTORY_DOWNLOADS");
}
if (type == DataLocation) {
return QStringList() << writableLocation(type)
<< getExternalFilesDir();
}
if (type == CacheLocation) {
return QStringList() << writableLocation(type)
<< getExternalCacheDir();
}
if (type == FontsLocation) {
QString &fontLocation = (*androidDirCache)[QStringLiteral("FONT_LOCATION")];
if (!fontLocation.isEmpty())
return QStringList(fontLocation);
const QByteArray ba = qgetenv("QT_ANDROID_FONT_LOCATION");
if (!ba.isEmpty())
return QStringList((fontLocation = QDir::cleanPath(QString::fromLocal8Bit(ba))));
return QStringList((fontLocation = QLatin1String("/system/fonts")));
}
return QStringList(writableLocation(type));
}
QT_END_NAMESPACE
#endif // QT_NO_STANDARDPATHS

View File

@ -52,7 +52,7 @@
#include <sys/types.h>
#endif
#if defined(Q_OS_UNIX) && !defined(Q_OS_MAC) && !defined(Q_OS_BLACKBERRY)
#if defined(Q_OS_UNIX) && !defined(Q_OS_MAC) && !defined(Q_OS_BLACKBERRY) && !defined(Q_OS_ANDROID)
#define Q_XDG_PLATFORM
#endif
@ -289,9 +289,9 @@ void tst_qstandardpaths::testDataLocation()
{
// On all platforms, DataLocation should be GenericDataLocation / organization name / app name
// This allows one app to access the data of another app.
// Blackberry OS is an exception to this case, owing to the fact that
// Blackberry OS and Android are exceptions to this case, owing to the fact that
// applications are sandboxed.
#ifndef Q_OS_BLACKBERRY
#if !defined(Q_OS_BLACKBERRY) && !defined(Q_OS_ANDROID)
const QString base = QStandardPaths::writableLocation(QStandardPaths::GenericDataLocation);
QCOMPARE(QStandardPaths::writableLocation(QStandardPaths::DataLocation), base + "/tst_qstandardpaths");
QCoreApplication::instance()->setOrganizationName("Qt");