summaryrefslogtreecommitdiffstats
path: root/sched/src/com/android/sched/util/file/FileOrDirectory.java
blob: 688e5d227bd7451df3e7f027e1ff0330c68796a7 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
/*
 * Copyright (C) 2013 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.sched.util.file;

import com.android.sched.util.RunnableHooks;
import com.android.sched.util.location.HasLocation;
import com.android.sched.util.location.Location;
import com.android.sched.util.location.NoLocation;
import com.android.sched.util.log.LoggerFactory;

import java.io.File;
import java.util.logging.Level;
import java.util.logging.Logger;

import javax.annotation.CheckForNull;
import javax.annotation.Nonnull;

/**
 * Abstract class for file or directory which manage the underlying state
 * of the file system.
 */
public abstract class FileOrDirectory implements HasLocation {
  @Nonnull
  private static final Logger logger = LoggerFactory.getLogger();
  /**
   * Permission
   */
  public static class Permission {
    public static final int READ    = 1 << 0;
    public static final int WRITE   = 1 << 1;
    public static final int EXECUTE = 1 << 2;
  }

  /**
   * Change Permission
   */
  public enum ChangePermission {
    NOCHANGE,
    OWNER,
    EVERYBODY
  }

  /**
   * Existing condition
   */
  public enum Existence {
    MUST_EXIST,
    NOT_EXIST,
    MAY_EXIST
  }

  @Nonnull
  private static final Location NO_LOCATION = new NoLocation();

  @Nonnull
  protected Location location = NO_LOCATION;

  @CheckForNull
  private RunnableHooks hooks;

  @CheckForNull
  private Runnable remover;

  protected FileOrDirectory(@CheckForNull RunnableHooks hooks) {
    this.hooks = hooks;
  }

  @Override
  @Nonnull
  public Location getLocation() {
    return location;
  }

  @Nonnull
  public abstract String getPath();

  public static void setPermissions(@Nonnull File file, @Nonnull Location location,
      int permissions, @Nonnull FileOrDirectory.ChangePermission change)
      throws CannotSetPermissionException {
    if (change != ChangePermission.NOCHANGE) {
      // Set access
      if ((permissions & Permission.READ) != 0) {
        if (file.setReadable(true, change == ChangePermission.OWNER)) {
          logger.log(Level.FINE, "Set readable permission to {0} (''{1}'')",
              new Object[] {location.getDescription(), file.getAbsoluteFile()});
        } else {
          throw new CannotSetPermissionException(location, Permission.READ,
              change);
        }
      }

      if ((permissions & Permission.WRITE) != 0) {
        if (file.setWritable(true, change == ChangePermission.OWNER)) {
          logger.log(Level.FINE, "Set writable permission to {0} (''{1}'')",
              new Object[] {location.getDescription(), file.getAbsoluteFile()});
        } else {
          throw new CannotSetPermissionException(location, Permission.WRITE,
              change);
        }
      }

      if ((permissions & Permission.EXECUTE) != 0) {
        if (file.setExecutable(true, change == ChangePermission.OWNER)) {
          logger.log(Level.FINE, "Set executable permission to {0} (''{1}'')",
              new Object[] {location.getDescription(), file.getAbsoluteFile()});
        } else {
          throw new CannotSetPermissionException(location, Permission.EXECUTE,
              change);
        }
      }
    }
  }


  public static void unsetPermissions(@Nonnull File file, @Nonnull Location location,
      int permissions, @Nonnull FileOrDirectory.ChangePermission change)
      throws CannotSetPermissionException {
    if (change != ChangePermission.NOCHANGE) {
      // Set access
      if ((permissions & Permission.READ) != 0) {
        if (file.setReadable(false, change == ChangePermission.OWNER)) {
          logger.log(Level.FINE, "Clear readable permission to {0} (''{1}'')",
              new Object[] {location.getDescription(), file.getAbsoluteFile()});
        } else {
          throw new CannotSetPermissionException(location, Permission.READ,
              change);
        }
      }

      if ((permissions & Permission.WRITE) != 0) {
        if (file.setWritable(false, change == ChangePermission.OWNER)) {
          logger.log(Level.FINE, "Clear writable permission to {0} (''{1}'')",
              new Object[] {location.getDescription(), file.getAbsoluteFile()});
        } else {
          throw new CannotSetPermissionException(location, Permission.WRITE,
              change);
        }
      }

      if ((permissions & Permission.EXECUTE) != 0) {
        if (file.setExecutable(false, change == ChangePermission.OWNER)) {
          logger.log(Level.FINE, "Clear executable permission to {0} (''{1}'')",
              new Object[] {location.getDescription(), file.getAbsoluteFile()});
        } else {
          throw new CannotSetPermissionException(location, Permission.EXECUTE,
              change);
        }
      }
    }
  }

  public static void checkPermissions(@Nonnull File file, @Nonnull Location location,
      int permissions) throws WrongPermissionException {
    if ((permissions & Permission.READ) != 0) {
      if (!file.canRead()) {
        throw new WrongPermissionException(location, Permission.READ);
      }
    }

    if ((permissions & Permission.WRITE) != 0) {
      if (!file.canWrite()) {
        throw new WrongPermissionException(location, Permission.WRITE);
      }
    }

    if ((permissions & Permission.EXECUTE) != 0) {
      if (!file.canExecute()) {
        throw new WrongPermissionException(location, Permission.EXECUTE);
      }
    }
  }

  protected synchronized void addRemover(@Nonnull final File file) {
    assert remover == null;

    if (hooks != null) {
      remover = new Runnable() {
        @Override
        public void run() {
          if (file.delete()) {
            logger.log(Level.FINE, "Remove {0} (''{1}'')",
                new Object[] {location.getDescription(), file.getAbsoluteFile()});
          } else {
            logger.log(Level.SEVERE,
                "Can not delete {0}",
                location.getDescription());
         }
        }
      };

      assert hooks != null;
      hooks.addHook(remover);
    }
  }

  protected synchronized void clearRemover() {
    if (remover != null) {
      assert hooks != null;

      hooks.removeHook(remover);
      remover = null;
      hooks   = null;
    }
  }

  @Nonnull
  public static File getFileFromWorkingDirectory(@CheckForNull Directory workingDirectory,
      @Nonnull String path) {
    File fileWithoutWorkingDir = new File(path);
    if (workingDirectory != null && !fileWithoutWorkingDir.isAbsolute()) {
      return new File(workingDirectory.getFile(), path);
    } else {
      return fileWithoutWorkingDir;
    }
  }
}