FileObserver.java revision 9bb8fd77c8dc177aab9ac96bed4f55972dcda70a
19066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project/* 29066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Copyright (C) 2006 The Android Open Source Project 39066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 49066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Licensed under the Apache License, Version 2.0 (the "License"); 59066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * you may not use this file except in compliance with the License. 69066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * You may obtain a copy of the License at 79066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 89066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * http://www.apache.org/licenses/LICENSE-2.0 99066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 109066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Unless required by applicable law or agreed to in writing, software 119066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * distributed under the License is distributed on an "AS IS" BASIS, 129066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 139066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * See the License for the specific language governing permissions and 149066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * limitations under the License. 159066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 169066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 179066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Projectpackage android.os; 189066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 199066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Projectimport android.util.Log; 209066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 219066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Projectimport com.android.internal.os.RuntimeInit; 229066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 239066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Projectimport java.lang.ref.WeakReference; 249066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Projectimport java.util.ArrayList; 259066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Projectimport java.util.HashMap; 269066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 279066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Projectpublic abstract class FileObserver { 289bb8fd77c8dc177aab9ac96bed4f55972dcda70aJoe Onorato /** File was accessed */ 299bb8fd77c8dc177aab9ac96bed4f55972dcda70aJoe Onorato public static final int ACCESS = 0x00000001; 309bb8fd77c8dc177aab9ac96bed4f55972dcda70aJoe Onorato /** File was modified */ 319bb8fd77c8dc177aab9ac96bed4f55972dcda70aJoe Onorato public static final int MODIFY = 0x00000002; 329bb8fd77c8dc177aab9ac96bed4f55972dcda70aJoe Onorato /** Metadata changed */ 339bb8fd77c8dc177aab9ac96bed4f55972dcda70aJoe Onorato public static final int ATTRIB = 0x00000004; 349bb8fd77c8dc177aab9ac96bed4f55972dcda70aJoe Onorato /** Writable file was closed */ 359bb8fd77c8dc177aab9ac96bed4f55972dcda70aJoe Onorato public static final int CLOSE_WRITE = 0x00000008; 369bb8fd77c8dc177aab9ac96bed4f55972dcda70aJoe Onorato /** Unwrittable file closed */ 379bb8fd77c8dc177aab9ac96bed4f55972dcda70aJoe Onorato public static final int CLOSE_NOWRITE = 0x00000010; 389bb8fd77c8dc177aab9ac96bed4f55972dcda70aJoe Onorato /** File was opened */ 399bb8fd77c8dc177aab9ac96bed4f55972dcda70aJoe Onorato public static final int OPEN = 0x00000020; 409bb8fd77c8dc177aab9ac96bed4f55972dcda70aJoe Onorato /** File was moved from X */ 419bb8fd77c8dc177aab9ac96bed4f55972dcda70aJoe Onorato public static final int MOVED_FROM = 0x00000040; 429bb8fd77c8dc177aab9ac96bed4f55972dcda70aJoe Onorato /** File was moved to Y */ 439bb8fd77c8dc177aab9ac96bed4f55972dcda70aJoe Onorato public static final int MOVED_TO = 0x00000080; 449bb8fd77c8dc177aab9ac96bed4f55972dcda70aJoe Onorato /** Subfile was created */ 459bb8fd77c8dc177aab9ac96bed4f55972dcda70aJoe Onorato public static final int CREATE = 0x00000100; 469bb8fd77c8dc177aab9ac96bed4f55972dcda70aJoe Onorato /** Subfile was deleted */ 479bb8fd77c8dc177aab9ac96bed4f55972dcda70aJoe Onorato public static final int DELETE = 0x00000200; 489bb8fd77c8dc177aab9ac96bed4f55972dcda70aJoe Onorato /** Self was deleted */ 499bb8fd77c8dc177aab9ac96bed4f55972dcda70aJoe Onorato public static final int DELETE_SELF = 0x00000400; 509bb8fd77c8dc177aab9ac96bed4f55972dcda70aJoe Onorato /** Self was moved */ 519bb8fd77c8dc177aab9ac96bed4f55972dcda70aJoe Onorato public static final int MOVE_SELF = 0x00000800; 529bb8fd77c8dc177aab9ac96bed4f55972dcda70aJoe Onorato 539066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public static final int ALL_EVENTS = ACCESS | MODIFY | ATTRIB | CLOSE_WRITE 549066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project | CLOSE_NOWRITE | OPEN | MOVED_FROM | MOVED_TO | DELETE | CREATE 559066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project | DELETE_SELF | MOVE_SELF; 569bb8fd77c8dc177aab9ac96bed4f55972dcda70aJoe Onorato 579066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project private static final String LOG_TAG = "FileObserver"; 589066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 599066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project private static class ObserverThread extends Thread { 609066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project private HashMap<Integer, WeakReference> m_observers = new HashMap<Integer, WeakReference>(); 619066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project private int m_fd; 629066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 639066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public ObserverThread() { 649066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project super("FileObserver"); 659066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project m_fd = init(); 669066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 679066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 689066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public void run() { 699066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project observe(m_fd); 709066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 719066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 729066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public int startWatching(String path, int mask, FileObserver observer) { 739066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project int wfd = startWatching(m_fd, path, mask); 749066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 759066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project Integer i = new Integer(wfd); 769066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project if (wfd >= 0) { 779066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project synchronized (m_observers) { 789066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project m_observers.put(i, new WeakReference(observer)); 799066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 809066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 819066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 829066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return i; 839066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 849066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 859066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public void stopWatching(int descriptor) { 869066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project stopWatching(m_fd, descriptor); 879066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 889066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 899066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public void onEvent(int wfd, int mask, String path) { 909066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project // look up our observer, fixing up the map if necessary... 919066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project FileObserver observer; 929066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 939066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project synchronized (m_observers) { 949066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project WeakReference weak = m_observers.get(wfd); 959066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project observer = (FileObserver) weak.get(); 969066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project if (observer == null) { 979066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project m_observers.remove(wfd); 989066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 999066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1009066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1019066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project // ...then call out to the observer without the sync lock held 1029066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project if (observer != null) { 1039066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project try { 1049066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project observer.onEvent(mask, path); 1059066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } catch (Throwable throwable) { 1069066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project Log.e(LOG_TAG, "Unhandled throwable " + throwable.toString() + 1079066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project " (returned by observer " + observer + ")", throwable); 1089066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project RuntimeInit.crash("FileObserver", throwable); 1099066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1109066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1119066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1129066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1139066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project private native int init(); 1149066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project private native void observe(int fd); 1159066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project private native int startWatching(int fd, String path, int mask); 1169066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project private native void stopWatching(int fd, int wfd); 1179066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1189066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1199066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project private static ObserverThread s_observerThread; 1209066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1219066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project static { 1229066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project s_observerThread = new ObserverThread(); 1239066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project s_observerThread.start(); 1249066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1259066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1269066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project // instance 1279066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project private String m_path; 1289066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project private Integer m_descriptor; 1299066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project private int m_mask; 1309066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1319066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public FileObserver(String path) { 1329066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project this(path, ALL_EVENTS); 1339066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1349066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1359066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public FileObserver(String path, int mask) { 1369066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project m_path = path; 1379066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project m_mask = mask; 1389066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project m_descriptor = -1; 1399066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1409066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1419066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project protected void finalize() { 1429066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project stopWatching(); 1439066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1449066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1459066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public void startWatching() { 1469066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project if (m_descriptor < 0) { 1479066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project m_descriptor = s_observerThread.startWatching(m_path, m_mask, this); 1489066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1499066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1509066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1519066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public void stopWatching() { 1529066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project if (m_descriptor >= 0) { 1539066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project s_observerThread.stopWatching(m_descriptor); 1549066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project m_descriptor = -1; 1559066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1569066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1579066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1589066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public abstract void onEvent(int event, String path); 1599066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project} 160