foundations/foundation-common/src/main/java/org/apache/servicecomb/foundation/common/utils/FilePerm.java

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You 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 org.apache.servicecomb.foundation.common.utils;

import java.io.File;
import java.io.IOException;
import java.nio.file.FileSystem;
import java.nio.file.FileSystems;
import java.nio.file.Files;
import java.nio.file.attribute.AclEntryPermission;
import java.nio.file.attribute.PosixFileAttributes;
import java.nio.file.attribute.PosixFilePermission;
import java.nio.file.attribute.PosixFilePermissions;
import java.util.Arrays;
import java.util.EnumSet;
import java.util.Set;

public final class FilePerm {
  private FilePerm() {
  }

  /**
   * owner 可读
   */
  public static final int FILE_PERM_UREAD = 256;

  /**
   * owner 可写
   */
  public static final int FILE_PERM_UWRITE = 128;

  /**
   * owner 可执行
   */
  public static final int FILE_PERM_UEXEC = 64;

  /**
   * 同组可读
   */
  public static final int FILE_PERM_GREAD = 32;

  /**
   * 同组可写
   */
  public static final int FILE_PERM_GWRITE = 16;

  /**
   * 同组可执行
   */
  public static final int FILE_PERM_GEXEC = 8;

  /**
   * 其他可读
   */
  public static final int FILE_PERM_OREAD = 4;

  /**
   * 其他可写
   */
  public static final int FILE_PERM_OWRITE = 2;

  /**
   * 其他可执行
   */
  public static final int FILE_PERM_OEXEC = 1;

  /**
   * mask
   */
  public static final int FILE_PERM_MASK = 511;

  private static AclEntryPermission[] permList = new AclEntryPermission[] {
      AclEntryPermission.READ_DATA,
      AclEntryPermission.READ_ATTRIBUTES,
      AclEntryPermission.READ_NAMED_ATTRS,
      AclEntryPermission.READ_ACL,
      AclEntryPermission.WRITE_DATA,
      AclEntryPermission.APPEND_DATA,
      AclEntryPermission.WRITE_ATTRIBUTES,
      AclEntryPermission.WRITE_NAMED_ATTRS,
      AclEntryPermission.WRITE_ACL,
      AclEntryPermission.SYNCHRONIZE
  };

  /**
   * 获取默认Posix权限:640
   */
  public static Set<PosixFilePermission> getDefaultPosixPerm() {
    return PosixFilePermissions.fromString("rw-r-----");
  }

  /**
   * 获取Posix权限
   */
  public static Set<PosixFilePermission> getPosixPerm(int perm) {
    StringBuilder permStr = new StringBuilder();

    permStr.append(uCanRead(perm) ? "r" : "-");
    permStr.append(uCanWrite(perm) ? "w" : "-");
    permStr.append(uCanExec(perm) ? "x" : "-");
    permStr.append(gCanRead(perm) ? "r" : "-");
    permStr.append(gCanWrite(perm) ? "w" : "-");
    permStr.append(gCanExec(perm) ? "x" : "-");
    permStr.append(oCanRead(perm) ? "r" : "-");
    permStr.append(oCanWrite(perm) ? "w" : "-");
    permStr.append(oCanExec(perm) ? "x" : "-");

    return PosixFilePermissions.fromString(permStr.toString());
  }

  /**
   * 获取默认acl权限
   */
  public static Set<AclEntryPermission> getDefaultAclPerm() {

    Set<AclEntryPermission> perms = EnumSet.noneOf(AclEntryPermission.class);
    perms.addAll(Arrays.asList(permList));

    return perms;
  }

  /**
   * owner是否可读
   */
  public static boolean uCanRead(int perm) {
    return (FILE_PERM_UREAD & perm) > 0;
  }

  /**
   * owner是否可写
   */
  public static boolean uCanWrite(int perm) {
    return (FILE_PERM_UWRITE & perm) > 0;
  }

  /**
   * owner是否可执行
   */
  public static boolean uCanExec(int perm) {
    return (FILE_PERM_UEXEC & perm) > 0;
  }

  /**
   * 同组是否可读
   */
  public static boolean gCanRead(int perm) {
    return (FILE_PERM_GREAD & perm) > 0;
  }

  /**
   * 同组是否可写
   */
  public static boolean gCanWrite(int perm) {
    return (FILE_PERM_GWRITE & perm) > 0;
  }

  /**
   * 同组是否可执行
   */
  public static boolean gCanExec(int perm) {
    return (FILE_PERM_GEXEC & perm) > 0;
  }

  /**
   * 其他是否可读
   */
  public static boolean oCanRead(int perm) {
    return (FILE_PERM_GREAD & perm) > 0;
  }

  /**
   * 其他是否可写
   */
  public static boolean oCanWrite(int perm) {
    return (FILE_PERM_GWRITE & perm) > 0;
  }

  /**
   * 其他是否可执行
   */
  public static boolean oCanExec(int perm) {
    return (FILE_PERM_GEXEC & perm) > 0;
  }

  /**
   * 设置文件权限。前提：必须支持PosixFileAttributeView.
   */
  public static void setFilePerm(File file, String perm) {
    if (filePermSupported()) {
      try {
        Set<PosixFilePermission> perms = PosixFilePermissions.fromString(perm);
        PosixFileAttributes attr = Files.readAttributes(file.toPath(), PosixFileAttributes.class);
        attr.permissions().clear();
        Files.setPosixFilePermissions(file.toPath(), perms);
      } catch (IOException e) {
        throw new IllegalStateException(e);
      }
    }
  }

  public static boolean filePermSupported() {
    FileSystem system = FileSystems.getDefault();
    for (String name : system.supportedFileAttributeViews()) {
      // see javadoc for PosixFileAttributeView.
      if ("posix".equals(name)) {
        return true;
      }
    }
    return false;
  }
}