איך מבקשים קובץ משותף

כשאפליקציה רוצה לגשת לקובץ ששותף על ידי אפליקציה אחרת, האפליקציה המבקשת (הלקוח) בדרך כלל שולחת בקשה לאפליקציה שמשתפת את הקבצים (השרת). ברוב המקרים, הבקשה מפעילה Activity באפליקציית השרת, שמציגה את הקבצים שאפשר לשתף. המשתמש בוחר קובץ, ולאחר מכן אפליקציית השרת מחזירה את ה-URI של תוכן הקובץ לאפליקציית הלקוח.

בשיעור הזה מוסבר איך אפליקציית לקוח מבקשת קובץ מאפליקציית שרת, מקבלת את ה-URI של תוכן הקובץ מאפליקציית השרת ומתפתחת את הקובץ באמצעות ה-URI של התוכן.

שליחת בקשה לקובץ

כדי לבקש קובץ מאפליקציית השרת, אפליקציית הלקוח קוראת ל-startActivityForResult עם Intent שמכיל את הפעולה, למשל ACTION_PICK, וסוג MIME שאפליקציית הלקוח יכולה לטפל בו.

לדוגמה, קטע הקוד הבא מראה איך שולחים Intent לאפליקציית שרת כדי להפעיל את Activity שמתואר בקטע שיתוף קובץ:

class MainActivity : Activity() {
    private lateinit var requestFileIntent: Intent
    private lateinit var inputPFD: ParcelFileDescriptor
    ...
    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        setContentView(R.layout.activity_main)
        requestFileIntent = Intent(Intent.ACTION_PICK).apply {
            type = "image/jpg"
        }
        ...
    }
    ...
    private fun requestFile() {
        /**
         * When the user requests a file, send an Intent to the
         * server app.
         * files.
         */
        startActivityForResult(requestFileIntent, 0)
        ...
    }
    ...
}

public class MainActivity extends Activity {
    private Intent requestFileIntent;
    private ParcelFileDescriptor inputPFD;
    ...
    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);
        requestFileIntent = new Intent(Intent.ACTION_PICK);
        requestFileIntent.setType("image/jpg");
        ...
    }
    ...
    protected void requestFile() {
        /**
         * When the user requests a file, send an Intent to the
         * server app.
         * files.
         */
            startActivityForResult(requestFileIntent, 0);
        ...
    }
    ...
}

גישה לקובץ המבוקש

אפליקציית השרת שולחת את מזהה ה-URI של תוכן הקובץ בחזרה לאפליקציית הלקוח ב-Intent. הערך של Intent מועבר לאפליקציית הלקוח כערך החלופי של onActivityResult(). אחרי שאפליקציית הלקוח מקבלת את ה-URI של התוכן של הקובץ, היא יכולה לגשת אליו על ידי קבלת ה-FileDescriptor שלה.

אבטחת הקבצים נשמרת בתהליך הזה רק כל עוד מבצעים ניתוח תקין של URI התוכן שמקבלת אפליקציית הלקוח. כשמנתחים תוכן, צריך לוודא שה-URI הזה לא מפנה לשום דבר מחוץ לספרייה המיועדת, כדי לוודא שלא מתבצע ניסיון לחציית נתיב. רק אפליקציית הלקוח צריכה לקבל גישה לקובץ, ורק להרשאות שניתנות על ידי אפליקציית השרת. ההרשאות הן זמניות, כך שברגע שמקבץ המשימות של אפליקציית הלקוח מסתיים, הקובץ לא נגיש יותר מחוץ לאפליקציית השרת.

קטע הקוד הבא מדגים איך אפליקציית הלקוח מטפלת ב-Intent שנשלח מאפליקציית השרת, ואיך אפליקציית הלקוח מקבלת את FileDescriptor באמצעות URI התוכן:

/*
 * When the Activity of the app that hosts files sets a result and calls
 * finish(), this method is invoked. The returned Intent contains the
 * content URI of a selected file. The result code indicates if the
 * selection worked or not.
 */
public override fun onActivityResult(requestCode: Int, resultCode: Int, returnIntent: Intent) {
    // If the selection didn't work
    if (resultCode != Activity.RESULT_OK) {
        // Exit without doing anything else
        return
    }
    // Get the file's content URI from the incoming Intent
    returnIntent.data?.also { returnUri ->
        /*
         * Try to open the file for "read" access using the
         * returned URI. If the file isn't found, write to the
         * error log and return.
         */
        inputPFD = try {
            /*
             * Get the content resolver instance for this context, and use it
             * to get a ParcelFileDescriptor for the file.
             */
            contentResolver.openFileDescriptor(returnUri, "r")
        } catch (e: FileNotFoundException) {
            e.printStackTrace()
            Log.e("MainActivity", "File not found.")
            return
        }

        // Get a regular file descriptor for the file
        val fd = inputPFD.fileDescriptor
        ...
    }
}

    /*
     * When the Activity of the app that hosts files sets a result and calls
     * finish(), this method is invoked. The returned Intent contains the
     * content URI of a selected file. The result code indicates if the
     * selection worked or not.
     */
    @Override
    public void onActivityResult(int requestCode, int resultCode,
            Intent returnIntent) {
        // If the selection didn't work
        if (resultCode != RESULT_OK) {
            // Exit without doing anything else
            return;
        } else {
            // Get the file's content URI from the incoming Intent
            Uri returnUri = returnIntent.getData();
            /*
             * Try to open the file for "read" access using the
             * returned URI. If the file isn't found, write to the
             * error log and return.
             */
            try {
                /*
                 * Get the content resolver instance for this context, and use it
                 * to get a ParcelFileDescriptor for the file.
                 */
                inputPFD = getContentResolver().openFileDescriptor(returnUri, "r");
            } catch (FileNotFoundException e) {
                e.printStackTrace();
                Log.e("MainActivity", "File not found.");
                return;
            }
            // Get a regular file descriptor for the file
            FileDescriptor fd = inputPFD.getFileDescriptor();
            ...
        }
    }

השיטה openFileDescriptor() מחזירה ParcelFileDescriptor בשביל הקובץ. מהאובייקט הזה, אפליקציית הלקוח מקבלת אובייקט FileDescriptor, שבעזרתו היא יכולה לקרוא את הקובץ.

מידע נוסף בנושא זמין במאמרים הבאים:

• מסננים של Intent וכוונות
• אחזור נתונים מהספק