src/io/inc/FIo_FileImpl.h

   1 //
   2 // Open Service Platform
   3 // Copyright (c) 2012 Samsung Electronics Co., Ltd.
   4 //
   5 // Licensed under the Apache License, Version 2.0 (the License);
   6 // you may not use this file except in compliance with the License.
   7 // You may obtain a copy of the License at
   8 //
   9 //     http://www.apache.org/licenses/LICENSE-2.0
  10 //
  11 // Unless required by applicable law or agreed to in writing, software
  12 // distributed under the License is distributed on an "AS IS" BASIS,
  13 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14 // See the License for the specific language governing permissions and
  15 // limitations under the License.
  16 //
  17
  18 /**
  19  * @file        FIo_FileImpl.h
  20  * @brief       This is the header file for the %_FileImpl class.
  21  *
  22  * This header file contains the declarations of the %_FileImpl class.
  23  */
  24
  25 #ifndef _FIO_INTERNAL_FILE_IMPL_H_
  26 #define _FIO_INTERNAL_FILE_IMPL_H_
  27
  28 #include <FBaseObject.h>
  29 #include <FBaseInternalTypes.h>
  30 #include <FOspConfig.h>
  31 #include <FIoFile.h>
  32
  33 namespace Tizen {namespace Base
  34 {
  35 class String;
  36 class ByteBuffer;
  37 }}
  38
  39 namespace Tizen { namespace Io
  40 {
  41
  42 class File;
  43 class FileAttributes;
  44 class _NormalFile;
  45 class _SecureFile;
  46 class _IFileCore;
  47 class _FileLockImpl;
  48
  49 #define MAX_FILEPATH_APP    18
  50 #define MAX_FILEPATH_MEDIA  2
  51 #define MAX_FILEPATH_SYSTEM 2
  52
  53 /**
  54  * @enum        _FilePathType
  55  * Defines various file path types supported.
  56  *
  57  * @since 2.1
  58  */
  59 enum _FilePathType
  60 {
  61         FILEPATH_TYPE_INVALID, // invalid case
  62         FILEPATH_TYPE_APP, // for paths like /home, /Res, /Share etc.
  63         FILEPATH_TYPE_MEDIA, // for paths like /Media,/Storagecard/Media, /Media/Images, /Media/xxx etc.
  64         FILEPATH_TYPE_SYSTEM // for paths like /SystemRw, /Tmp etc.
  65 };
  66
  67 /**
  68  * @enum        _FileLockMode
  69  * Defines various file lock modes supported.
  70  *
  71  * @since 2.1
  72  */
  73 enum _FileLockMode
  74 {
  75         FILE_LOCK_MODE_INVALID, // invalid case
  76         FILE_LOCK_MODE_BLOCKING, // blocking mode
  77         FILE_LOCK_MODE_NON_BLOCKING // non blocking mode
  78 };
  79
  80 class _OSP_EXPORT_ _FileImpl
  81         : public Tizen::Base::Object
  82 {
  83
  84 public:
  85         _FileImpl(void);
  86
  87         result Construct(const Tizen::Base::String& filePath, const Tizen::Base::String& openMode, bool createParentDirectories, const Tizen::Base::ByteBuffer* pSecretKey);
  88
  89         result Construct(const Tizen::Base::String& filePath, const char* pOpenMode, const Tizen::Base::ByteBuffer* pSecretKey);
  90
  91         virtual ~_FileImpl(void);
  92
  93         result Read(Tizen::Base::ByteBuffer& buffer);
  94
  95         int Read(void* buffer, int length);
  96
  97         result ReadN(char** buffer, int& length);
  98
  99         result Read(Tizen::Base::String& buffer);
 100
 101         result Write(const Tizen::Base::ByteBuffer& buffer);
 102
 103         result Write(const void* buffer, int length);
 104
 105         result Write(const Tizen::Base::String& buffer);
 106
 107         result Flush(void);
 108
 109         int Tell(void) const;
 110
 111         result Seek(FileSeekPosition position, long offset);
 112
 113         result Truncate(int length);
 114
 115         Tizen::Base::String GetName(void) const;
 116
 117         FILE* GetFilePointer(void) const;
 118
 119         FileLock* LockN(FileLockType lockType);
 120
 121         FileLock* LockN(FileLockType lockType, int offset, int length);
 122
 123         FileLock* TryToLockN(FileLockType lockType);
 124
 125         FileLock* TryToLockN(FileLockType lockType, int offset, int length);
 126
 127         static result Remove(const Tizen::Base::String& filePath);
 128
 129         static result Move(const Tizen::Base::String& oldFilePath, const Tizen::Base::String& newFilePath);
 130
 131         static result Copy(const Tizen::Base::String& srcFilePath, const Tizen::Base::String& destFilePath, bool failIfExist);
 132
 133         static result GetAttributes(const Tizen::Base::String& filePath, FileAttributes& attribute);
 134
 135         static Tizen::Base::String GetFileName(const Tizen::Base::String& filePath);
 136
 137         static Tizen::Base::String GetFileExtension(const Tizen::Base::String& filePath);
 138
 139         static bool IsFileExist(const Tizen::Base::String& filePath);
 140
 141         static result ConvertToSecureFile(const Tizen::Base::String& plainFilePath, const Tizen::Base::String& secureFilePath, const Tizen::Base::ByteBuffer& key);
 142
 143         static bool IsAppPath(const Tizen::Base::String& filePath);
 144
 145         static bool IsMediaPath(const Tizen::Base::String& filePath);
 146
 147         static bool IsSystemPath(const Tizen::Base::String& filePath);
 148
 149         static bool PrepareDataCaging(const Tizen::Base::String& appRootPath, const Tizen::Base::String& pkgId); // for OSP compatible app
 150
 151         static bool FinalizeDataCaging(const Tizen::Base::String& appRootPath); // for OSP compatible app
 152
 153         static bool CreateOspApplicationDirectories(const Tizen::Base::String& appRootpath, const Tizen::Base::String& pkgId); // for Tizen 2.0 app
 154
 155         static int GetAvailableUid(void);
 156
 157         static bool VerifyFilePathCompatibility(const Tizen::Base::String& filePath, bool ospCompat);
 158
 159         static _FileImpl* GetInstance(File& file);
 160
 161         static const _FileImpl* GetInstance(const File& file);
 162
 163         /**
 164         * Converts the virtual path to the physical path.
 165         *
 166         * @since 2.1
 167         * @return               An error code
 168         * @param[in]    virtualPath             The path used by applications with API version 2.0
 169         * @param[out]   physicalPath    The physical absolute path
 170         * @exception    E_SUCCESS               The method is successful.
 171         * @exception    E_INVALID_ARG   The specified @c virtualPath is not valid.
 172         */
 173         static result ConvertVirtualToPhysicalPath(const Tizen::Base::String& virtualPath, Tizen::Base::String& physicalPath);
 174
 175         /**
 176         * Converts the physical path to the virtual path.
 177         *
 178         * @since 2.1
 179         * @return               An error code
 180         * @param[in]    physicalPath    The physical absolute path
 181         * @param[out]   virtualPath             The path used by applications with API version 2.0
 182         * @exception    E_SUCCESS               The method is successful.
 183         * @exception    E_INVALID_ARG   The specified @c physicalPath is not valid.
 184         */
 185         static result ConvertPhysicalToVirtualPath(const Tizen::Base::String& physicalPath, Tizen::Base::String& virtualPath);
 186
 187         bool IsReadable(void) const
 188         {
 189         return __read;
 190         }
 191
 192         bool IsWritable(void) const
 193         {
 194         return __write;
 195         }
 196
 197 private:
 198         _FileImpl& operator =(const _FileImpl& source);
 199
 200         _FileImpl(const _FileImpl& source);
 201
 202         bool VerifyFileOpenMode(const char* pOpenMode);
 203
 204         FileLock* LockN(FileLockType lockType, _FileLockMode lockMode, int offset, int length);
 205
 206         static bool VerifyFilePath(const Tizen::Base::String& filePath, _FilePathType pathType);
 207
 208         static bool CreateOspInternalDirectories(const Tizen::Base::String& appRootPath, const Tizen::Base::String& pkgId);
 209
 210         static bool CreateOspExternalDirectories(const Tizen::Base::String& pkgId);
 211
 212         static bool CreateSlpDirectories(void);
 213
 214     static bool CreateSymbolicLink(void);
 215
 216         static bool CleanDirectories(const Tizen::Base::String& appRootPath, const Tizen::Base::String& pkgId);
 217
 218         _IFileCore* __pCore;
 219         bool __read;
 220         bool __write;
 221         bool __truncate;
 222         bool __append;
 223         _FileLockImpl* __pFileLockImpl;
 224
 225         friend class File;
 226         friend class _FileLockImpl;
 227
 228 }; // _FileImpl
 229
 230 }} // Tizen::Io
 231
 232 #endif // _FIO_INTERNAL_FILE_IMPL_H_
 233