How to enable files and folders permission on iOS

Viewed 3791

I am trying to download a file using AlamoFire and save it to a downloads directory of the user's choice (like safari). However, whenever I set the download directory to a folder outside of my app's documents, I get the following error (on a real iOS device):

downloadedFileMoveFailed(error: Error Domain=NSCocoaErrorDomain Code=513 "“CFNetworkDownload_dlIcno.tmp” couldn’t be moved because you don’t have permission to access “Downloads”." UserInfo={NSSourceFilePathErrorKey=/private/var/mobile/Containers/Data/Application/A24D885A-1306-4CE4-9B15-952AF92B7E6C/tmp/CFNetworkDownload_dlIcno.tmp, NSUserStringVariant=(Move), NSDestinationFilePath=/private/var/mobile/Containers/Shared/AppGroup/E6303CBC-62A3-4206-9C84-E37041894DEC/File Provider Storage/Downloads/100MB.bin, NSFilePath=/private/var/mobile/Containers/Data/Application/A24D885A-1306-4CE4-9B15-952AF92B7E6C/tmp/CFNetworkDownload_dlIcno.tmp, NSUnderlyingError=0x281d045d0 {Error Domain=NSPOSIXErrorDomain Code=1 "Operation not permitted"}}, source: file:///private/var/mobile/Containers/Data/Application/A24D885A-1306-4CE4-9B15-952AF92B7E6C/tmp/CFNetworkDownload_dlIcno.tmp, destination: file:///private/var/mobile/Containers/Shared/AppGroup/E6303CBC-62A3-4206-9C84-E37041894DEC/File%20Provider%20Storage/Downloads/100MB.bin)

The summary of that error is that I don't have permission to access the folder I just granted access to.

Here's my attached code:

import SwiftUI
import UniformTypeIdentifiers
import Alamofire

struct ContentView: View {
    @AppStorage("downloadsDirectory") var downloadsDirectory = ""
    
    @State private var showFileImporter = false
    
    var body: some View {
        VStack {
            Button("Set downloads directory") {
                showFileImporter.toggle()
            }
            
            Button("Save to downloads directory") {
                Task {
                    do {
                        let destination: DownloadRequest.Destination = { _, response in
                            let documentsURL = URL(string: downloadsDirectory)!
                            let suggestedName = response.suggestedFilename ?? "unknown"

                            let fileURL = documentsURL.appendingPathComponent(suggestedName)

                            return (fileURL, [.removePreviousFile, .createIntermediateDirectories])
                        }

                        let _ = try await AF.download(URL(string: "https://i.imgur.com/zaVQDFJ.png")!, to: destination).serializingDownloadedFileURL().value
                    } catch {
                        print("Downloading error!: \(error)")
                    }
                }
            }
        }
        .fileImporter(isPresented: $showFileImporter, allowedContentTypes: [UTType.folder]) { result in
            switch result {
            case .success(let url):
                downloadsDirectory = url.absoluteString
            case .failure(let error):
                print("Download picker error: \(error)")
            }
        }
    }
}

To reproduce (Run on a REAL iOS device!):

  1. Click the Set downloads directory button to On my iPhone
  2. Click the Save to downloads directory button
  3. Error occurs

Upon further investigation, I found that safari uses the Files and Folders privacy permission (Located in Settings > Privacy > Files and folders on an iPhone) to access folders outside the app sandbox (This link for the image of what I'm talking about). I scoured the web as much as I can and I couldn't find any documentation for this exact permission.

I have seen non-apple apps (such as VLC) use this permission, but I cannot figure out how it's granted.

I tried enabling the following plist properties, but none of them work (because I later realized these are for macOS only)

<key>NSDocumentsFolderUsageDescription</key>
<string>App wants to access your documents folder</string>
<key>NSDownloadsFolderUsageDescription</key>
<string>App wants to access your downloads folder</string>
<key>LSSupportsOpeningDocumentsInPlace</key>
<true/>
<key>UIFileSharingEnabled</key>
<true/>

Can someone please help me figure out how to grant the files and folder permission and explain what it does? I would really appreciate the help.

1 Answers

After some research, I stumbled onto this Apple documentation page (which wasn't found after my hours of google searching when I posted this question)

https://developer.apple.com/documentation/uikit/view_controllers/providing_access_to_directories

Navigate to the Save the URL as a Bookmark part of the article.

Utilizing a SwiftUI fileImporter gives one-time read/write access to the user-selected directory. To persist this read/write access, I had to make a bookmark and store it somewhere to access later.

Since I only needed one bookmark for the user's downloads directory, I saved it in UserDefaults (a bookmark is very small in terms of size).

When saving a bookmark, the app is added into the Files and folders in the user's settings, so the user can revoke file permissions for the app immediately (hence all the guard statements in my code snippet).

Here's the code snippet which I used and with testing, downloading does persist across app launches and multiple downloads.

import SwiftUI
import UniformTypeIdentifiers
import Alamofire

struct ContentView: View {
    @AppStorage("bookmarkData") var downloadsBookmark: Data?
    
    @State private var showFileImporter = false
    
    var body: some View {
        VStack {
            Button("Set downloads directory") {
                showFileImporter.toggle()
            }
            
            Button("Save to downloads directory") {
                Task {
                    do {
                        let destination: DownloadRequest.Destination = { _, response in
                            // Save to a temp directory in app documents
                            let documentsURL = FileManager.default.urls(for: .documentDirectory, in: .userDomainMask)[0].appendingPathComponent("Downloads")
                            let suggestedName = response.suggestedFilename ?? "unknown"

                            let fileURL = documentsURL.appendingPathComponent(suggestedName)

                            return (fileURL, [.removePreviousFile, .createIntermediateDirectories])
                        }

                        let tempUrl = try await AF.download(URL(string: "https://i.imgur.com/zaVQDFJ.png")!, to: destination).serializingDownloadedFileURL().value
                        
                        // Get the bookmark data from the AppStorage call
                        guard let bookmarkData = downloadsBookmark else {
                            return
                        }
                        var isStale = false
                        let downloadsUrl = try URL(resolvingBookmarkData: bookmarkData, bookmarkDataIsStale: &isStale)
                        
                        guard !isStale else {
                            // Log that the bookmark is stale
                            
                            return
                        }
                        
                        // Securely access the URL from the bookmark data
                        guard downloadsUrl.startAccessingSecurityScopedResource() else {
                            print("Can't access security scoped resource")
                            
                            return
                        }
                        
                        // We have to stop accessing the resource no matter what
                        defer { downloadsUrl.stopAccessingSecurityScopedResource() }
                        
                        do {
                            try FileManager.default.moveItem(at: tempUrl, to: downloadsUrl.appendingPathComponent(tempUrl.lastPathComponent))
                        } catch {
                            print("Move error: \(error)")
                        }
                    } catch {
                        print("Downloading error!: \(error)")
                    }
                }
            }
        }
        .fileImporter(isPresented: $showFileImporter, allowedContentTypes: [UTType.folder]) { result in
            switch result {
            case .success(let url):
                // Securely access the URL to save a bookmark
                guard url.startAccessingSecurityScopedResource() else {
                    // Handle the failure here.
                    return
                }
                
                // We have to stop accessing the resource no matter what
                defer { url.stopAccessingSecurityScopedResource() }
                
                do {
                    // Make sure the bookmark is minimal!
                    downloadsBookmark = try url.bookmarkData(options: .minimalBookmark, includingResourceValuesForKeys: nil, relativeTo: nil)
                } catch {
                    print("Bookmark error \(error)")
                }
            case .failure(let error):
                print("Importer error: \(error)")
            }
        }
    }
}
Related