381 lines
12 KiB
C++
381 lines
12 KiB
C++
/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
|
|
/* vim: set ts=8 sts=2 et sw=2 tw=80: */
|
|
/* This Source Code Form is subject to the terms of the Mozilla Public
|
|
* License, v. 2.0. If a copy of the MPL was not distributed with this file,
|
|
* You can obtain one at http://mozilla.org/MPL/2.0/. */
|
|
|
|
#ifndef DeviceStorage_h
|
|
#define DeviceStorage_h
|
|
|
|
#include "nsIFile.h"
|
|
#include "nsIPrincipal.h"
|
|
#include "mozilla/DOMEventTargetHelper.h"
|
|
#include "mozilla/RefPtr.h"
|
|
#include "mozilla/StaticPtr.h"
|
|
#include "mozilla/dom/DOMRequest.h"
|
|
#include "nsWeakReference.h"
|
|
|
|
#define DEVICESTORAGE_PICTURES "pictures"
|
|
#define DEVICESTORAGE_VIDEOS "videos"
|
|
#define DEVICESTORAGE_MUSIC "music"
|
|
#define DEVICESTORAGE_APPS "apps"
|
|
#define DEVICESTORAGE_SDCARD "sdcard"
|
|
#define DEVICESTORAGE_CRASHES "crashes"
|
|
|
|
class nsIInputStream;
|
|
class nsIOutputStream;
|
|
struct DeviceStorageFileDescriptor;
|
|
#ifdef MOZ_WIDGET_GONK
|
|
class nsIVolume;
|
|
#endif
|
|
|
|
namespace mozilla {
|
|
class EventListenerManager;
|
|
namespace dom {
|
|
class Blob;
|
|
struct DeviceStorageEnumerationParameters;
|
|
class DOMCursor;
|
|
class DOMRequest;
|
|
class Promise;
|
|
class DeviceStorageFileSystem;
|
|
} // namespace dom
|
|
namespace ipc {
|
|
class FileDescriptor;
|
|
class PrincipalInfo;
|
|
} // namespace ipc
|
|
} // namespace mozilla
|
|
|
|
class DeviceStorageRequest;
|
|
class DeviceStorageCursorRequest;
|
|
class DeviceStorageRequestManager;
|
|
class nsDOMDeviceStorageCursor;
|
|
|
|
class DeviceStorageFile final
|
|
: public nsISupports {
|
|
public:
|
|
nsCOMPtr<nsIFile> mFile;
|
|
nsString mStorageType;
|
|
nsString mStorageName;
|
|
nsString mRootDir;
|
|
nsString mPath;
|
|
bool mEditable;
|
|
nsString mMimeType;
|
|
uint64_t mLength;
|
|
uint64_t mLastModifiedDate;
|
|
|
|
// Used when the path will be set later via SetPath.
|
|
DeviceStorageFile(const nsAString& aStorageType,
|
|
const nsAString& aStorageName);
|
|
// Used for non-enumeration purposes.
|
|
DeviceStorageFile(const nsAString& aStorageType,
|
|
const nsAString& aStorageName,
|
|
const nsAString& aPath);
|
|
// Used for enumerations. When you call Enumerate, you can pass in a
|
|
// directory to enumerate and the results that are returned are relative to
|
|
// that directory, files related to an enumeration need to know the "root of
|
|
// the enumeration" directory.
|
|
DeviceStorageFile(const nsAString& aStorageType,
|
|
const nsAString& aStorageName,
|
|
const nsAString& aRootDir,
|
|
const nsAString& aPath);
|
|
|
|
void SetPath(const nsAString& aPath);
|
|
void SetEditable(bool aEditable);
|
|
|
|
static already_AddRefed<DeviceStorageFile>
|
|
CreateUnique(nsAString& aFileName,
|
|
uint32_t aFileType,
|
|
uint32_t aFileAttributes);
|
|
|
|
static already_AddRefed<DeviceStorageFile>
|
|
CreateUnique(const nsAString& aStorageType,
|
|
const nsAString& aStorageName,
|
|
nsAString& aFileName,
|
|
uint32_t aFileType,
|
|
uint32_t aFileAttributes);
|
|
|
|
NS_DECL_THREADSAFE_ISUPPORTS
|
|
|
|
bool IsAvailable();
|
|
void GetFullPath(nsAString& aFullPath);
|
|
|
|
// we want to make sure that the names of file can't reach
|
|
// outside of the type of storage the user asked for.
|
|
bool IsSafePath();
|
|
bool IsSafePath(const nsAString& aPath);
|
|
|
|
void Dump(const char* label);
|
|
|
|
nsresult Remove();
|
|
nsresult Write(nsIInputStream* aInputStream);
|
|
nsresult Write(InfallibleTArray<uint8_t>& bits);
|
|
nsresult Append(nsIInputStream* aInputStream);
|
|
nsresult Append(nsIInputStream* aInputStream,
|
|
nsIOutputStream* aOutputStream);
|
|
void CollectFiles(nsTArray<RefPtr<DeviceStorageFile> >& aFiles,
|
|
PRTime aSince = 0);
|
|
void collectFilesInternal(nsTArray<RefPtr<DeviceStorageFile> >& aFiles,
|
|
PRTime aSince, nsAString& aRootPath);
|
|
|
|
void AccumDiskUsage(uint64_t* aPicturesSoFar, uint64_t* aVideosSoFar,
|
|
uint64_t* aMusicSoFar, uint64_t* aTotalSoFar);
|
|
|
|
void GetStorageFreeSpace(int64_t* aSoFar);
|
|
void GetStatus(nsAString& aStatus);
|
|
void GetStorageStatus(nsAString& aStatus);
|
|
void DoFormat(nsAString& aStatus);
|
|
void DoMount(nsAString& aStatus);
|
|
void DoUnmount(nsAString& aStatus);
|
|
static void GetRootDirectoryForType(const nsAString& aStorageType,
|
|
const nsAString& aStorageName,
|
|
nsIFile** aFile);
|
|
|
|
nsresult CalculateSizeAndModifiedDate();
|
|
nsresult CalculateMimeType();
|
|
nsresult CreateFileDescriptor(mozilla::ipc::FileDescriptor& aFileDescriptor);
|
|
|
|
private:
|
|
~DeviceStorageFile() {}
|
|
void Init();
|
|
void NormalizeFilePath();
|
|
void AppendRelativePath(const nsAString& aPath);
|
|
void AccumDirectoryUsage(nsIFile* aFile,
|
|
uint64_t* aPicturesSoFar,
|
|
uint64_t* aVideosSoFar,
|
|
uint64_t* aMusicSoFar,
|
|
uint64_t* aTotalSoFar);
|
|
};
|
|
|
|
#define NS_DOM_DEVICE_STORAGE_CID \
|
|
{ 0xe4a9b969, 0x81fe, 0x44f1, \
|
|
{ 0xaa, 0x0c, 0x9e, 0x16, 0x64, 0x86, 0x2a, 0xd5 } }
|
|
|
|
class nsDOMDeviceStorage final
|
|
: public mozilla::DOMEventTargetHelper
|
|
, public nsSupportsWeakReference
|
|
{
|
|
typedef mozilla::ErrorResult ErrorResult;
|
|
typedef mozilla::dom::DeviceStorageEnumerationParameters
|
|
EnumerationParameters;
|
|
typedef mozilla::dom::DOMCursor DOMCursor;
|
|
typedef mozilla::dom::DOMRequest DOMRequest;
|
|
typedef mozilla::dom::Promise Promise;
|
|
typedef mozilla::dom::DeviceStorageFileSystem DeviceStorageFileSystem;
|
|
public:
|
|
typedef nsTArray<nsString> VolumeNameArray;
|
|
|
|
NS_DECLARE_STATIC_IID_ACCESSOR(NS_DOM_DEVICE_STORAGE_CID)
|
|
NS_DECL_ISUPPORTS_INHERITED
|
|
NS_REALLY_FORWARD_NSIDOMEVENTTARGET(DOMEventTargetHelper)
|
|
|
|
void EventListenerWasAdded(const nsAString& aType,
|
|
ErrorResult& aRv,
|
|
JSCompartment* aCompartment) override;
|
|
|
|
explicit nsDOMDeviceStorage(nsPIDOMWindow* aWindow);
|
|
|
|
static int InstanceCount() { return sInstanceCount; }
|
|
|
|
static void InvalidateVolumeCaches();
|
|
|
|
nsresult Init(nsPIDOMWindow* aWindow, const nsAString& aType,
|
|
const nsAString& aVolName);
|
|
|
|
bool IsAvailable();
|
|
bool IsFullPath(const nsAString& aPath)
|
|
{
|
|
return aPath.Length() > 0 && aPath.CharAt(0) == '/';
|
|
}
|
|
|
|
void SetRootDirectoryForType(const nsAString& aType,
|
|
const nsAString& aVolName);
|
|
|
|
// WebIDL
|
|
nsPIDOMWindow*
|
|
GetParentObject() const
|
|
{
|
|
return GetOwner();
|
|
}
|
|
virtual JSObject*
|
|
WrapObject(JSContext* aCx, JS::Handle<JSObject*> aGivenProto) override;
|
|
|
|
IMPL_EVENT_HANDLER(change)
|
|
|
|
already_AddRefed<DOMRequest>
|
|
Add(mozilla::dom::Blob* aBlob, ErrorResult& aRv);
|
|
already_AddRefed<DOMRequest>
|
|
AddNamed(mozilla::dom::Blob* aBlob, const nsAString& aPath, ErrorResult& aRv);
|
|
|
|
already_AddRefed<DOMRequest>
|
|
AppendNamed(mozilla::dom::Blob* aBlob, const nsAString& aPath,
|
|
ErrorResult& aRv);
|
|
|
|
already_AddRefed<DOMRequest>
|
|
Get(const nsAString& aPath, ErrorResult& aRv)
|
|
{
|
|
return GetInternal(aPath, false, aRv);
|
|
}
|
|
already_AddRefed<DOMRequest>
|
|
GetEditable(const nsAString& aPath, ErrorResult& aRv)
|
|
{
|
|
return GetInternal(aPath, true, aRv);
|
|
}
|
|
already_AddRefed<DOMRequest>
|
|
Delete(const nsAString& aPath, ErrorResult& aRv);
|
|
|
|
already_AddRefed<DOMCursor>
|
|
Enumerate(const EnumerationParameters& aOptions, ErrorResult& aRv)
|
|
{
|
|
return Enumerate(NullString(), aOptions, aRv);
|
|
}
|
|
already_AddRefed<DOMCursor>
|
|
Enumerate(const nsAString& aPath, const EnumerationParameters& aOptions,
|
|
ErrorResult& aRv);
|
|
already_AddRefed<DOMCursor>
|
|
EnumerateEditable(const EnumerationParameters& aOptions, ErrorResult& aRv)
|
|
{
|
|
return EnumerateEditable(NullString(), aOptions, aRv);
|
|
}
|
|
already_AddRefed<DOMCursor>
|
|
EnumerateEditable(const nsAString& aPath,
|
|
const EnumerationParameters& aOptions, ErrorResult& aRv);
|
|
|
|
already_AddRefed<DOMRequest> FreeSpace(ErrorResult& aRv);
|
|
already_AddRefed<DOMRequest> UsedSpace(ErrorResult& aRv);
|
|
already_AddRefed<DOMRequest> Available(ErrorResult& aRv);
|
|
already_AddRefed<DOMRequest> Format(ErrorResult& aRv);
|
|
already_AddRefed<DOMRequest> StorageStatus(ErrorResult& aRv);
|
|
already_AddRefed<DOMRequest> Mount(ErrorResult& aRv);
|
|
already_AddRefed<DOMRequest> Unmount(ErrorResult& aRv);
|
|
|
|
already_AddRefed<DOMRequest> CreateFileDescriptor(const nsAString& aPath,
|
|
DeviceStorageFileDescriptor* aDSFD,
|
|
ErrorResult& aRv);
|
|
|
|
bool CanBeMounted();
|
|
bool CanBeFormatted();
|
|
bool CanBeShared();
|
|
bool IsRemovable();
|
|
bool LowDiskSpace();
|
|
bool Default();
|
|
void GetStorageName(nsAString& aStorageName);
|
|
|
|
already_AddRefed<Promise>
|
|
GetRoot(ErrorResult& aRv);
|
|
|
|
static void
|
|
CreateDeviceStorageFor(nsPIDOMWindow* aWin,
|
|
const nsAString& aType,
|
|
nsDOMDeviceStorage** aStore);
|
|
|
|
static void
|
|
CreateDeviceStorageByNameAndType(nsPIDOMWindow* aWin,
|
|
const nsAString& aName,
|
|
const nsAString& aType,
|
|
nsDOMDeviceStorage** aStore);
|
|
|
|
bool Equals(nsPIDOMWindow* aWin,
|
|
const nsAString& aName,
|
|
const nsAString& aType);
|
|
|
|
void Shutdown();
|
|
|
|
static void GetOrderedVolumeNames(const nsAString& aType,
|
|
nsTArray<nsString>& aVolumeNames);
|
|
|
|
static void GetOrderedVolumeNames(nsTArray<nsString>& aVolumeNames);
|
|
|
|
static void GetDefaultStorageName(const nsAString& aStorageType,
|
|
nsAString& aStorageName);
|
|
|
|
static bool ParseFullPath(const nsAString& aFullPath,
|
|
nsAString& aOutStorageName,
|
|
nsAString& aOutStoragePath);
|
|
|
|
// DeviceStorageStatics callbacks
|
|
void OnFileWatcherUpdate(const nsCString& aData, DeviceStorageFile* aFile);
|
|
void OnDiskSpaceWatcher(bool aLowDiskSpace);
|
|
void OnWritableNameChanged();
|
|
#ifdef MOZ_WIDGET_GONK
|
|
void OnVolumeStateChanged(nsIVolume* aVolume);
|
|
#endif
|
|
|
|
uint32_t CreateDOMRequest(DOMRequest** aRequest, ErrorResult& aRv);
|
|
uint32_t CreateDOMCursor(DeviceStorageCursorRequest* aRequest,
|
|
nsDOMDeviceStorageCursor** aCursor,
|
|
ErrorResult& aRv);
|
|
already_AddRefed<DOMRequest> CreateAndRejectDOMRequest(const char *aReason,
|
|
ErrorResult& aRv);
|
|
|
|
nsresult CheckPermission(already_AddRefed<DeviceStorageRequest>&& aRequest);
|
|
|
|
bool IsOwningThread();
|
|
nsresult DispatchToOwningThread(already_AddRefed<nsIRunnable>&& aRunnable);
|
|
|
|
private:
|
|
~nsDOMDeviceStorage();
|
|
|
|
static nsresult CheckPrincipal(nsPIDOMWindow* aWindow, bool aIsAppsStorage,
|
|
nsIPrincipal** aPrincipal);
|
|
|
|
already_AddRefed<DOMRequest>
|
|
AddOrAppendNamed(mozilla::dom::Blob* aBlob, const nsAString& aPath,
|
|
bool aCreate, ErrorResult& aRv);
|
|
|
|
already_AddRefed<DOMRequest>
|
|
GetInternal(const nsAString& aPath, bool aEditable, ErrorResult& aRv);
|
|
|
|
void
|
|
DeleteInternal(nsPIDOMWindow* aWin, const nsAString& aPath,
|
|
DOMRequest* aRequest);
|
|
|
|
already_AddRefed<DOMCursor>
|
|
EnumerateInternal(const nsAString& aName,
|
|
const EnumerationParameters& aOptions, bool aEditable,
|
|
ErrorResult& aRv);
|
|
|
|
static int sInstanceCount;
|
|
|
|
nsString mStorageType;
|
|
nsCOMPtr<nsIFile> mRootDirectory;
|
|
nsString mStorageName;
|
|
bool mIsShareable;
|
|
bool mIsRemovable;
|
|
|
|
already_AddRefed<nsDOMDeviceStorage> GetStorage(const nsAString& aFullPath,
|
|
nsAString& aOutStoragePath);
|
|
already_AddRefed<nsDOMDeviceStorage>
|
|
GetStorageByName(const nsAString &aStorageName);
|
|
|
|
static already_AddRefed<nsDOMDeviceStorage>
|
|
GetStorageByNameAndType(nsPIDOMWindow* aWin,
|
|
const nsAString& aStorageName,
|
|
const nsAString& aType);
|
|
|
|
bool mIsDefaultLocation;
|
|
|
|
nsresult Notify(const char* aReason, class DeviceStorageFile* aFile);
|
|
|
|
friend class WatchFileEvent;
|
|
friend class DeviceStorageRequest;
|
|
|
|
static mozilla::StaticAutoPtr<nsTArray<nsString>> sVolumeNameCache;
|
|
|
|
#ifdef MOZ_WIDGET_GONK
|
|
nsString mLastStatus;
|
|
nsString mLastStorageStatus;
|
|
void DispatchStatusChangeEvent(nsAString& aStatus);
|
|
void DispatchStorageStatusChangeEvent(nsAString& aStorageStatus);
|
|
#endif
|
|
|
|
uint64_t mInnerWindowID;
|
|
RefPtr<DeviceStorageFileSystem> mFileSystem;
|
|
RefPtr<DeviceStorageRequestManager> mManager;
|
|
nsAutoPtr<mozilla::ipc::PrincipalInfo> mPrincipalInfo;
|
|
nsCOMPtr<nsIThread> mOwningThread;
|
|
};
|
|
|
|
NS_DEFINE_STATIC_IID_ACCESSOR(nsDOMDeviceStorage, NS_DOM_DEVICE_STORAGE_CID)
|
|
|
|
#endif
|