fix!: remove deprecated platforms

apache · Nov 2, 2024 · fba0e67 · fba0e67
1 parent 6bff845
commit fba0e67
Show file tree

Hide file tree

Showing 18 changed files with 19 additions and 3,324 deletions.
diff --git a/README.md b/README.md
@@ -57,8 +57,6 @@ Although the object is in the global scope, it is not available to applications
 
 - Android
 - iOS
-- OS X
-- Windows*
 - Browser
 
 \* _These platforms do not support `FileReader.readAsArrayBuffer` nor `FileWriter.write(blob)`._
@@ -70,22 +68,22 @@ Each URL is in the form _file:///path/to/spot/_, and can be converted to a
 `DirectoryEntry` using `window.resolveLocalFileSystemURL()`.
 
 * `cordova.file.applicationDirectory` - Read-only directory where the application
-  is installed. (_iOS_, _Android_, _BlackBerry 10_, _OSX_, _windows_)
+  is installed. (_iOS_, _Android_)
 
 * `cordova.file.applicationStorageDirectory` - Root directory of the application's
-  sandbox; on iOS & windows this location is read-only (but specific subdirectories [like
-  `/Documents` on iOS or `/localState` on windows] are read-write). All data contained within
-  is private to the app. (_iOS_, _Android_, _BlackBerry 10_, _OSX_)
+  sandbox; on iOS this location is read-only (but specific subdirectories [like
+  `/Documents` on iOS] is read-write). All data contained within
+  is private to the app. (_iOS_, _Android_)
 
 * `cordova.file.dataDirectory` - Persistent and private data storage within the
   application's sandbox using internal memory (on Android, if you need to use
   external memory, use `.externalDataDirectory`). On iOS, this directory is not
-  synced with iCloud (use `.syncedDataDirectory`). (_iOS_, _Android_, _BlackBerry 10_, _windows_)
+  synced with iCloud (use `.syncedDataDirectory`). (_iOS_, _Android_)
 
 * `cordova.file.cacheDirectory` -  Directory for cached data files or any files
   that your app can re-create easily. The OS may delete these files when the device
   runs low on storage, nevertheless, apps should not rely on the OS to delete files
-  in here. (_iOS_, _Android_, _BlackBerry 10_, _OSX_, _windows_)
+  in here. (_iOS_, _Android_)
 
 * `cordova.file.externalApplicationStorageDirectory` - Application space on
   external storage. (_Android_). See [Quirks](#androids-external-storage-quirks).
@@ -96,19 +94,17 @@ Each URL is in the form _file:///path/to/spot/_, and can be converted to a
 * `cordova.file.externalCacheDirectory` - Application cache on external storage.
   (_Android_). See [Quirks](#androids-external-storage-quirks).
 
-* `cordova.file.externalRootDirectory` - External storage (SD card) root. (_Android_, _BlackBerry 10_). See [Quirks](#androids-external-storage-quirks).
+* `cordova.file.externalRootDirectory` - External storage (SD card) root. (_Android_). See [Quirks](#androids-external-storage-quirks).
 
 * `cordova.file.tempDirectory` - Temp directory that the OS can clear at will. Do not
   rely on the OS to clear this directory; your app should always remove files as
-  applicable. (_iOS_, _OSX_, _windows_)
+  applicable. (_iOS_)
 
 * `cordova.file.syncedDataDirectory` - Holds app-specific files that should be synced
-  (e.g. to iCloud). (_iOS_, _windows_)
+  (e.g. to iCloud). (_iOS_)
 
 * `cordova.file.documentsDirectory` - Files private to the app, but that are meaningful
-  to other application (e.g. Office files). Note that for _OSX_ this is the user's `~/Documents` directory. (_iOS_, _OSX_)
-
-* `cordova.file.sharedDirectory` - Files globally available to all applications (_BlackBerry 10_)
+  to other application (e.g. Office files). (_iOS_)
 
 ## File System Layouts
 
@@ -191,41 +187,6 @@ These limitations only applies to external filesystems (e.g. `cordova.file.exter
 
 If interfacing with the external file system is a requirement for your application, consider using a [MediaStore](https://www.npmjs.com/search?q=ecosystem%3Acordova%20storage%20access%20framework) plugin instead.
 
-### OS X File System Layout
-
-| Device Path                                      | `cordova.file.*`            | `iosExtraFileSystems` | r/w? |  OS clears | private |
-|:-------------------------------------------------|:----------------------------|:----------------------|:----:|:---------:|:-------:|
-| `/Applications/<appname>.app/`                   | -                           | bundle                | r    |     N/A   |   Yes   |
-| &nbsp;&nbsp;&nbsp;&nbsp;`Content/Resources/`     | applicationDirectory        | -                     | r    |     N/A   |   Yes   |
-| `~/Library/Application Support/<bundle-id>/`     | applicationStorageDirectory | -                     | r/w  |     No    |   Yes   |
-| &nbsp;&nbsp;&nbsp;&nbsp;`files/`                 | dataDirectory               | -                     | r/w  |     No    |   Yes   |
-| `~/Documents/`                                   | documentsDirectory          | documents             | r/w  |     No    |    No   |
-| `~/Library/Caches/<bundle-id>/`                  | cacheDirectory              | cache                 | r/w  |     No    |   Yes   |
-| `/tmp/`                                          | tempDirectory               | -                     | r/w  |    Yes\*  |   Yes   |
-| `/`                                              | rootDirectory               | root                  | r/w  |    No\*\* |    No   |
-
-**Note**: This is the layout for non sandboxed applications. I you enable sandboxing, the `applicationStorageDirectory` will be below ` ~/Library/Containers/<bundle-id>/Data/Library/Application Support`.
-
-\* Files persist across app restarts and upgrades, but this directory can
-     be cleared whenever the OS desires. Your app should be able to recreate any
-     content that might be deleted. You should clear this directory as
-     appropriate for your application.
-
-\*\* Allows access to the entire file system. This is only available for non sandboxed apps.
-
-### Windows File System Layout
-
-| Device Path                                           | `cordova.file.*`            | r/w? | persistent? | OS clears | private |
-|:------------------------------------------------------|:----------------------------|:----:|:-----------:|:---------:|:-------:|
-| `ms-appdata:///`                                      | applicationDirectory        | r    |     N/A     |     N/A   |   Yes   |
-| &nbsp;&nbsp;&nbsp;`local/`                            | dataDirectory               | r/w  |     Yes     |     No    |   Yes   |
-| &nbsp;&nbsp;&nbsp;`temp/`                             | cacheDirectory              | r/w  |     No      |     Yes\* |   Yes   |
-| &nbsp;&nbsp;&nbsp;`temp/`                             | tempDirectory               | r/w  |     No      |     Yes\* |   Yes   |
-| &nbsp;&nbsp;&nbsp;`roaming/`                          | syncedDataDirectory         | r/w  |     Yes     |     No    |   Yes   |
-
-\* The OS may periodically clear this directory
-
-
 ## Android Quirks
 
 ### Android Persistent storage location
@@ -510,10 +471,6 @@ var my_media = new Media('cdvfile://localhost/temporary/path/to/file.mp3', ...);
 my_media.play();
 ```
 
-#### cdvfile quirks
-- Using `cdvfile://` paths in the DOM is not supported on Windows platform (a path can be converted to native instead).
-
-
 ## List of Error Codes and Meanings
 When an error is thrown, one of the following codes will be used.
 
@@ -582,7 +539,7 @@ When you get file system access using `requestFileSystem`, access is granted for
 
 Here is a request for persistent storage.
 
->*Note* When targeting WebView clients (instead of a browser) or native apps (Windows), you dont need to use `requestQuota` before using persistent storage.
+>*Note* When targeting WebView clients (instead of a browser), you dont need to use `requestQuota` before using persistent storage.
 
 ```js
 window.requestFileSystem(LocalFileSystem.PERSISTENT, 0, function (fs) {
@@ -848,12 +805,6 @@ function displayImageByFileURL(fileEntry) {
 }
 ```
 
-If you are using some platform-specific URIs instead of a FileEntry and you want to display an image, you may need to include the main part of the URI in the Content-Security-Policy <meta> element in index.html. For example, on Windows 10, you can include `ms-appdata:` in your <meta> element. Here is an example.
-
-```html
-<meta http-equiv="Content-Security-Policy" content="default-src 'self' data: gap: ms-appdata: https://ssl.gstatic.com 'unsafe-eval'; style-src 'self' 'unsafe-inline'; media-src *">
-```
-
 ## Create Directories <a name="createDir"></a>
 
 In the code here, you create directories in the root of the app storage location. You could use this code with any writable storage location (that is, any DirectoryEntry). Here, you write to the application cache (assuming that you used window.TEMPORARY to get your FileSystem object) by passing fs.root into this function.

diff --git a/package.json b/package.json
@@ -8,9 +8,7 @@
     "platforms": [
       "android",
       "browser",
-      "ios",
-      "osx",
-      "windows"
+      "ios"
     ]
   },
   "repository": "github:apache/cordova-plugin-file",
@@ -21,9 +19,7 @@
     "ecosystem:cordova",
     "cordova-android",
     "cordova-browser",
-    "cordova-ios",
-    "cordova-osx",
-    "cordova-windows"
+    "cordova-ios"
   ],
   "scripts": {
     "test": "npm run lint",

diff --git a/plugin.xml b/plugin.xml
@@ -201,46 +201,6 @@ to config.xml in order for the application to find previously stored files.
         <resource-file src="src/ios/CDVFile.bundle" target="CDVFile.bundle" />
     </platform>
 
-    <!-- osx -->
-    <platform name="osx">
-        <config-file target="config.xml" parent="/*">
-            <feature name="File">
-                <param name="ios-package" value="CDVFile" />
-                <param name="onload" value="true" />
-            </feature>
-        </config-file>
-        <header-file src="src/osx/CDVFile.h" />
-        <source-file src="src/osx/CDVFile.m" />
-        <header-file src="src/osx/CDVLocalFilesystem.h" />
-        <source-file src="src/osx/CDVLocalFilesystem.m" />
-
-        <!-- osx specific file apis -->
-        <js-module src="www/osx/FileSystem.js" name="osxFileSystem">
-            <merges target="FileSystem" />
-        </js-module>
-
-        <js-module src="www/fileSystems-roots.js" name="fileSystems-roots">
-            <runs/>
-        </js-module>
-
-        <js-module src="www/fileSystemPaths.js" name="fileSystemPaths">
-            <merges target="cordova" />
-            <runs/>
-        </js-module>
-    </platform>
-
-    <!-- windows -->
-    <platform name="windows">
-        <js-module src="src/windows/FileProxy.js" name="FileProxy">
-            <runs />
-        </js-module>
-
-        <js-module src="www/fileSystemPaths.js" name="fileSystemPaths">
-            <merges target="cordova" />
-            <runs/>
-        </js-module>
-    </platform>
-
     <platform name="browser">
         <!-- File for Chrome -->
         <js-module src="www/browser/Preparing.js" name="Preparing">

diff --git a/src/browser/FileProxy.js b/src/browser/FileProxy.js
@@ -107,7 +107,7 @@
             }, errorCallback);
         };
 
-        // Overridden by Android, BlackBerry 10 and iOS to populate fsMap
+        // Overridden by Android and iOS to populate fsMap
         require('./fileSystems').getFs = function (name, callback) {
             callback(new FileSystem(name, fs_.root));
         };