Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit 941a7c8f authored by Anthony Hugh's avatar Anthony Hugh
Browse files

Update Wearable install logic to use stream API 

The default directory for PackageInstaller moved from
/data/user/foo to /data/user_de/foo.  Not sure on the exact reason
why, but it has something to do with the file based encryption
changes in N.  This was causing the temp APK file that we were
passing to PackageManager for installs to be in an invalid location.
This resulted in failed installations.

This is OK though because we never really wanted to use a temporary
file.  We were using it due to limitations in the PackageInstaller
APIs.  Since implementation, new APIs have been added to allow us
to pass a stream through instead.

This CL updates the install logic to use the stream API instead.
Because this code path is being deprecated and replaced, I've opted
to do the bare minimum needed to keep this code operational.  I've
also borrowed installation code from Wearsky/Finsky codebase to
make it easier and more reliable.

BUG: 28021618

Change-Id: Ia245abf56649e350e99cf48d2b503906d3cd855c
parent c657da43

src/com/android/packageinstaller/wear/InstallTask.java

0 → 100644
+173 −0
Original line number Diff line number Diff line 
/*

 * Copyright (C) 2016 The Android Open Source Project

 *

 * Licensed under the Apache License, Version 2.0 (the "License");

 * you may not use this file except in compliance with the License.

 * You may obtain a copy of the License at

 *

 *      http://www.apache.org/licenses/LICENSE-2.0

 *

 * Unless required by applicable law or agreed to in writing, software

 * distributed under the License is distributed on an "AS IS" BASIS,

 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

 * See the License for the specific language governing permissions and

 * limitations under the License

 */



package com.android.packageinstaller.wear;



import android.content.Context;

import android.content.IntentSender;

import android.content.pm.PackageInstaller;

import android.os.Looper;

import android.os.ParcelFileDescriptor;

import android.text.TextUtils;

import android.util.Log;



import java.io.Closeable;

import java.io.IOException;

import java.io.InputStream;

import java.io.OutputStream;



/**

 * Task that installs an APK. This must not be called on the main thread.

 * This code is based off the Finsky/Wearsky implementation

 */

public class InstallTask {

    private static final String TAG = "InstallTask";



    private static final int DEFAULT_BUFFER_SIZE = 8192;



    private final Context mContext;

    private String mPackageName;

    private ParcelFileDescriptor mParcelFileDescriptor;

    private PackageInstallerImpl.InstallListener mCallback;

    private PackageInstaller.Session mSession;

    private IntentSender mCommitCallback;



    private Exception mException = null;

    private int mErrorCode = 0;

    private String mErrorDesc = null;



    public InstallTask(Context context, String packageName,

            ParcelFileDescriptor parcelFileDescriptor,

            PackageInstallerImpl.InstallListener callback, PackageInstaller.Session session,

            IntentSender commitCallback) {

        mContext = context;

        mPackageName = packageName;

        mParcelFileDescriptor = parcelFileDescriptor;

        mCallback = callback;

        mSession = session;

        mCommitCallback = commitCallback;

    }



    public boolean isError() {

        return mErrorCode != InstallerConstants.STATUS_SUCCESS || !TextUtils.isEmpty(mErrorDesc);

    }



    public void execute() {

        if (Looper.myLooper() == Looper.getMainLooper()) {

            throw new IllegalStateException("This method cannot be called from the UI thread.");

        }



        OutputStream sessionStream = null;

        try {

            sessionStream = mSession.openWrite(mPackageName, 0, -1);



            // 2b: Stream the asset to the installer. Note:

            // Note: writeToOutputStreamFromAsset() always safely closes the input stream

            writeToOutputStreamFromAsset(sessionStream);

            mSession.fsync(sessionStream);

        } catch (Exception e) {

            mException = e;

            mErrorCode = InstallerConstants.ERROR_INSTALL_COPY_STREAM;

            mErrorDesc = "Could not write to stream";

        } finally {

            if (sessionStream != null) {

                // 2c: close output stream

                try {

                    sessionStream.close();

                } catch (Exception e) {

                    // Ignore otherwise

                    if (mException == null) {

                        mException = e;

                        mErrorCode = InstallerConstants.ERROR_INSTALL_CLOSE_STREAM;

                        mErrorDesc = "Could not close session stream";

                    }

                }

            }

        }



        if (mErrorCode != InstallerConstants.STATUS_SUCCESS) {

            // An error occurred, we're done

            Log.e(TAG, "Exception while installing " + mPackageName + ": " + mErrorCode + ", "

                    + mErrorDesc + ", " + mException);

            mSession.close();

            mCallback.installFailed(mErrorCode, "[" + mPackageName + "]" + mErrorDesc);

        } else {

            // 3. Commit the session (this actually installs it.)  Session map

            // will be cleaned up in the callback.

            mCallback.installBeginning();

            mSession.commit(mCommitCallback);

            mSession.close();

        }

    }



    /**

     * {@code PackageInstaller} works with streams. Get the {@code FileDescriptor}

     * corresponding to the {@code Asset} and then write the contents into an

     * {@code OutputStream} that is passed in.

     * <br>

     * The {@code FileDescriptor} is closed but the {@code OutputStream} is not closed.

     */

    private boolean writeToOutputStreamFromAsset(OutputStream outputStream) {

        if (outputStream == null) {

            mErrorCode = InstallerConstants.ERROR_INSTALL_COPY_STREAM_EXCEPTION;

            mErrorDesc = "Got a null OutputStream.";

            return false;

        }



        if (mParcelFileDescriptor == null || mParcelFileDescriptor.getFileDescriptor() == null)  {

            mErrorCode = InstallerConstants.ERROR_COULD_NOT_GET_FD;

            mErrorDesc = "Could not get FD";

            return false;

        }



        InputStream inputStream = null;

        try {

            byte[] inputBuf = new byte[DEFAULT_BUFFER_SIZE];

            int bytesRead;

            inputStream = new ParcelFileDescriptor.AutoCloseInputStream(mParcelFileDescriptor);



            while ((bytesRead = inputStream.read(inputBuf)) > -1) {

                if (bytesRead > 0) {

                    outputStream.write(inputBuf, 0, bytesRead);

                }

            }



            outputStream.flush();

        } catch (IOException e) {

            mErrorCode = InstallerConstants.ERROR_INSTALL_APK_COPY_FAILURE;

            mErrorDesc = "Reading from Asset FD or writing to temp file failed: " + e;

            return false;

        } finally {

            safeClose(inputStream);

        }



        return true;

    }



    /**

     * Quietly close a closeable resource (e.g. a stream or file). The input may already

     * be closed and it may even be null.

     */

    public static void safeClose(Closeable resource) {

        if (resource != null) {

            try {

                resource.close();

            } catch (IOException ioe) {

                // Catch and discard the error

            }

        }

    }

}
 
 No newline at end of file

src/com/android/packageinstaller/wear/InstallerConstants.java

0 → 100644
+59 −0
Original line number Diff line number Diff line 
/*

 * Copyright (C) 2016 The Android Open Source Project

 *

 * Licensed under the Apache License, Version 2.0 (the "License");

 * you may not use this file except in compliance with the License.

 * You may obtain a copy of the License at

 *

 *      http://www.apache.org/licenses/LICENSE-2.0

 *

 * Unless required by applicable law or agreed to in writing, software

 * distributed under the License is distributed on an "AS IS" BASIS,

 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

 * See the License for the specific language governing permissions and

 * limitations under the License

 */



package com.android.packageinstaller.wear;



/**

 * Constants for Installation / Uninstallation requests.

 * Using the same values as Finsky/Wearsky code for consistency in user analytics of failures

 */

public class InstallerConstants {

    /** Request succeeded */

    public static final int STATUS_SUCCESS = 0;



    /**

     * The new PackageInstaller also returns a small set of less granular error codes, which

     * we'll remap to the range -500 and below to keep away from existing installer codes

     * (which run from -1 to -110).

     */

    public final static int ERROR_PACKAGEINSTALLER_BASE = -500;



    public static final int ERROR_COULD_NOT_GET_FD = -603;

    /** This node is not targeted by this request. */



    /** The install did not complete because could not create PackageInstaller session */

    public final static int ERROR_INSTALL_CREATE_SESSION = -612;

    /** The install did not complete because could not open PackageInstaller session  */

    public final static int ERROR_INSTALL_OPEN_SESSION = -613;

    /** The install did not complete because could not open PackageInstaller output stream */

    public final static int ERROR_INSTALL_OPEN_STREAM = -614;

    /** The install did not complete because of an exception while streaming bytes */

    public final static int ERROR_INSTALL_COPY_STREAM_EXCEPTION = -615;

    /** The install did not complete because of an unexpected exception from PackageInstaller */

    public final static int ERROR_INSTALL_SESSION_EXCEPTION = -616;

    /** The install did not complete because of an unexpected userActionRequired callback */

    public final static int ERROR_INSTALL_USER_ACTION_REQUIRED = -617;

    /** The install did not complete because of an unexpected broadcast (missing fields) */

    public final static int ERROR_INSTALL_MALFORMED_BROADCAST = -618;

    /** The install did not complete because of an error while copying from downloaded file */

    public final static int ERROR_INSTALL_APK_COPY_FAILURE = -619;

    /** The install did not complete because of an error while copying to the PackageInstaller

     * output stream */

    public final static int ERROR_INSTALL_COPY_STREAM = -620;

    /** The install did not complete because of an error while closing the PackageInstaller

     * output stream */

    public final static int ERROR_INSTALL_CLOSE_STREAM = -621;

}
 
 No newline at end of file

src/com/android/packageinstaller/wear/PackageInstallerFactory.java

0 → 100644
+36 −0
Original line number Diff line number Diff line 
/*

 * Copyright (C) 2016 The Android Open Source Project

 *

 * Licensed under the Apache License, Version 2.0 (the "License");

 * you may not use this file except in compliance with the License.

 * You may obtain a copy of the License at

 *

 *      http://www.apache.org/licenses/LICENSE-2.0

 *

 * Unless required by applicable law or agreed to in writing, software

 * distributed under the License is distributed on an "AS IS" BASIS,

 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

 * See the License for the specific language governing permissions and

 * limitations under the License

 */



package com.android.packageinstaller.wear;



import android.content.Context;



/**

 * Factory that creates a Package Installer.

 */

public class PackageInstallerFactory {

    private static PackageInstallerImpl sPackageInstaller;



    /**

     * Return the PackageInstaller shared object. {@code init} should have already been called.

     */

    public synchronized static PackageInstallerImpl getPackageInstaller(Context context) {

        if (sPackageInstaller == null) {

            sPackageInstaller = new PackageInstallerImpl(context);

        }

        return sPackageInstaller;

    }

}
 
 No newline at end of file

src/com/android/packageinstaller/wear/PackageInstallerImpl.java

0 → 100644
+324 −0

File added.

Preview size limit exceeded, changes collapsed.

src/com/android/packageinstaller/wear/WearPackageInstallerService.java

+32 −32
Original line number Diff line number Diff line
@@ -22,7 +22,6 @@ import android.content.Context; 
import android.content.Intent;

import android.content.pm.FeatureInfo;

import android.content.pm.IPackageDeleteObserver;

import android.content.pm.IPackageInstallObserver;

import android.content.pm.PackageInfo;

import android.content.pm.PackageManager;

import android.content.pm.PackageParser;
@@ -98,13 +97,6 @@ public class WearPackageInstallerService extends Service { 
    private static final String SHOW_PERMS_SERVICE_CLASS =

            "com.google.android.clockwork.packagemanager.ShowPermsService";



    /**

     * Normally sent by the Play store (See http://go/playstore-gms_updated), we instead

     * broadcast, ourselves. http://b/17387718

     */

    private static final String GMS_UPDATED_BROADCAST = "com.google.android.gms.GMS_UPDATED";

    public static final String GMS_PACKAGE_NAME = "com.google.android.gms";



    private final int START_INSTALL = 1;

    private final int START_UNINSTALL = 2;
@@ -233,6 +225,12 @@ public class WearPackageInstallerService extends Service { 
                    Log.d(TAG, "Replacing package:" + packageName);

                }

            }

            // TODO(28021618): This was left as a temp file due to the fact that this code is being

            //       deprecated and that we need the bare minimum to continue working moving forward

            //       If this code is used as reference, this permission logic might want to be

            //       reworked to use a stream instead of a file so that we don't need to write a

            //       file at all.  Note that there might be some trickiness with opening a stream

            //       for multiple users.

            ParcelFileDescriptor parcelFd = getContentResolver()

                    .openFileDescriptor(assetUri, "r");

            tempFile = WearPackageUtil.getFileFromFd(WearPackageInstallerService.this,
@@ -318,9 +316,9 @@ public class WearPackageInstallerService extends Service { 
            }



            // Finally install the package.

            pm.installPackage(Uri.fromFile(tempFile),

                    new PackageInstallObserver(this, lock, startId, packageName),

                        installFlags, packageName);

            ParcelFileDescriptor fd = getContentResolver().openFileDescriptor(assetUri, "r");

            PackageInstallerFactory.getPackageInstaller(this).install(packageName, fd,

                    new PackageInstallListener(this, lock, startId, packageName));



            messageSent = true;

            Log.i(TAG, "Sent installation request for " + packageName);
@@ -338,6 +336,10 @@ public class WearPackageInstallerService extends Service { 
        }

    }



    // TODO: This was left using the old PackageManager API due to the fact that this code is being

    //       deprecated and that we need the bare minimum to continue working moving forward

    //       If this code is used as reference, this logic should be reworked to use the new

    //       PackageInstaller APIs similar to how installPackage was reworked

    private void uninstallPackage(Bundle argsBundle) {

        int startId = WearPackageArgs.getStartId(argsBundle);

        final String packageName = WearPackageArgs.getPackageName(argsBundle);
@@ -558,12 +560,12 @@ public class WearPackageInstallerService extends Service { 
        }

    }



    private class PackageInstallObserver extends IPackageInstallObserver.Stub {

    private class PackageInstallListener implements PackageInstallerImpl.InstallListener {

        private Context mContext;

        private PowerManager.WakeLock mWakeLock;

        private int mStartId;

        private String mApplicationPackageName;

        private PackageInstallObserver(Context context, PowerManager.WakeLock wakeLock,

        private PackageInstallListener(Context context, PowerManager.WakeLock wakeLock,

                int startId, String applicationPackageName) {

            mContext = context;

            mWakeLock = wakeLock;
@@ -571,35 +573,33 @@ public class WearPackageInstallerService extends Service { 
            mApplicationPackageName = applicationPackageName;

        }



        public void packageInstalled(String packageName, int returnCode) {

            try {

                // If installation failed, bail out and remove the ShowPermsStore entry

                if (returnCode < 0) {

                    Log.e(TAG, "Package install failed " + mApplicationPackageName

                            + ", returnCode " + returnCode);

                    WearPackageUtil.removeFromPermStore(mContext, mApplicationPackageName);

                    return;

        @Override

        public void installBeginning() {

            Log.i(TAG, "Package " + mApplicationPackageName + " is being installed.");

        }



                Log.i(TAG, "Package " + packageName + " was installed.");

        @Override

        public void installSucceeded() {

            try {

                Log.i(TAG, "Package " + mApplicationPackageName + " was installed.");



                // Delete tempFile from the file system.

                File tempFile = WearPackageUtil.getTemporaryFile(mContext, packageName);

                File tempFile = WearPackageUtil.getTemporaryFile(mContext, mApplicationPackageName);

                if (tempFile != null) {

                    tempFile.delete();

                }



                // Broadcast the "UPDATED" gmscore intent, normally sent by play store.

                // TODO: Remove this broadcast if/when we get the play store to do this for us.

                if (GMS_PACKAGE_NAME.equals(packageName)) {

                    Intent gmsInstalledIntent = new Intent(GMS_UPDATED_BROADCAST);

                    gmsInstalledIntent.setPackage(GMS_PACKAGE_NAME);

                    mContext.sendBroadcast(gmsInstalledIntent);

                }

            } finally {

                finishService(mWakeLock, mStartId);

            }

        }



        @Override

        public void installFailed(int errorCode, String errorDesc) {

            Log.e(TAG, "Package install failed " + mApplicationPackageName

                    + ", errorCode " + errorCode);

            WearPackageUtil.removeFromPermStore(mContext, mApplicationPackageName);

            finishService(mWakeLock, mStartId);

        }

    }



    private class PackageDeleteObserver extends IPackageDeleteObserver.Stub {