src/vogar/android/AdbChrootTarget.java

/*
 * Copyright (C) 2018 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 vogar.android;

import com.google.common.collect.ImmutableList;
import java.io.File;
import java.io.FileNotFoundException;
import java.util.List;
import java.util.ListIterator;
import vogar.Log;
import vogar.android.AdbTarget;
import vogar.commands.Command;

/**
 * A class similar to AdbTarget, but working relatively to a chroot
 * directory (instead of the whole system under the root directory on
 * the device).
 *
 * All "remote" pathnames (as java.io.File objects) passed as
 * arguments to methods below and/or returned by them are relative to
 * the chroot directory, except when they represent "local" (host)
 * files.
 *
 * @see AdbTarget
 */
public final class AdbChrootTarget extends AdbTarget {

    private final String chrootDir;

    private final ImmutableList<String> targetProcessPrefixList;

    private static String TARGET_PROCESS_WRAPPER = "sh -c";

    public AdbChrootTarget(Log log, DeviceFilesystem deviceFilesystem,
            DeviceFileCache deviceFileCache, String chrootDir) {
        super(log, deviceFilesystem, deviceFileCache);
        this.chrootDir = chrootDir;
        this.targetProcessPrefixList = ImmutableList.of("adb", "shell", "chroot", chrootDir);
    }

    @Override
    public void await(File directory) {
        super.await(chrootToRoot(directory));
    }

    @Override
    public List<File> ls(File directory) throws FileNotFoundException {
        // Add chroot prefix to searched directory.
        List<File> files = super.ls(chrootToRoot(directory));
        // Remove chroot prefix from files found in directory.
        ListIterator<File> iterator = files.listIterator();
        while (iterator.hasNext()){
            File file = iterator.next();
            try {
                iterator.set(rootToChroot(file));
            } catch (PathnameNotUnderChrootException e) {
                // This should never happen, as `file` is derived from a chroot-based pathname.
                throw new Error(e);
            }
        }
        return files;
    }

    @Override
    public void rm(File file) {
        super.rm(chrootToRoot(file));
    }

    @Override
    public void mkdirs(File file) {
        super.mkdirs(chrootToRoot(file));
    }

    @Override
    public void push(File local, File remote) {
        super.push(local, chrootToRoot(remote));
    }

    @Override
    public void pull(File remote, File local) {
        super.pull(chrootToRoot(remote), local);
    }

    @Override
    protected ImmutableList<String> targetProcessPrefix() {
        return targetProcessPrefixList;
    }

    @Override
    protected String targetProcessWrapper() {
        return TARGET_PROCESS_WRAPPER;
    }

    /**
     * Convert a file relative to the chroot dir to a file relative to
     * the device's filesystem "absolute" root.
     */
    private File chrootToRoot(File file) {
        return new File(chrootDir + "/" + file.getPath());
    }

    /**
     * Convert a file relative to the device's filesystem "absolute"
     * root to a file relative to the chroot dir .
     */
    private File rootToChroot(File file) throws PathnameNotUnderChrootException {
        String pathname = file.getPath();
        if (!pathname.startsWith(chrootDir)) {
            throw new PathnameNotUnderChrootException(pathname, chrootDir);
        }
        return new File(pathname.substring(chrootDir.length()));
    }

    /**
     * Exception thrown when a pathname does not represent a file
     * under the chroot directory.
     */
    private class PathnameNotUnderChrootException extends Exception {

        public PathnameNotUnderChrootException(String pathname, String chrootDir) {
            super("Pathname " + pathname + " does not represent a file under chroot directory "
                + chrootDir);
        }
    }

}