OLD | NEW |
---|---|
1 // Copyright (c) 2017 The Chromium Authors. All rights reserved. | 1 // Copyright (c) 2017 The Chromium Authors. All rights reserved. |
2 // Use of this source code is governed by a BSD-style license that can be | 2 // Use of this source code is governed by a BSD-style license that can be |
3 // found in the LICENSE file. | 3 // found in the LICENSE file. |
4 | 4 |
5 #ifndef CHROME_BROWSER_WIN_JUMPLIST_FILE_UTIL_H_ | 5 #ifndef CHROME_BROWSER_WIN_JUMPLIST_FILE_UTIL_H_ |
6 #define CHROME_BROWSER_WIN_JUMPLIST_FILE_UTIL_H_ | 6 #define CHROME_BROWSER_WIN_JUMPLIST_FILE_UTIL_H_ |
7 | 7 |
8 #include "base/files/file_path.h" | 8 #include "base/files/file_path.h" |
9 | 9 |
10 // Maximum number of icon files allowed to delete per jumplist update. | 10 // Maximum number of icon files allowed to delete per jumplist update. |
11 const int kFileDeleteLimit = 30; | 11 const int kFileDeleteLimit = 30; |
12 | 12 |
13 // Folder delete status enumeration, used in Delete* methods below. | |
14 // This is used for UMA. Do not delete entries, and keep in sync with | |
15 // histograms.xml. | |
16 enum FolderDeleteResult { | |
17 SUCCEED = 0, | |
18 // File name's length exceeds MAX_PATH. This shouldn't happen. | |
19 FAIL_INVALID_FILE_PATH, | |
20 // JumpListIcons{,Old} directories are read-only. This may heppen. | |
21 FAIL_READ_ONLY_DIRECTORY, | |
22 // Since JumpListIcons{,Old} are directories. This shouldn't happen. | |
23 FAIL_DELETE_SINGLE_FILE, | |
24 // JumpListIcons{,Old} should not have sub-directories, so this shouldn't | |
25 // happen. If this happens, the root cause must be found. | |
26 FAIL_SUBDIRECTORY_EXISTS, | |
27 // Delete maximum files allowed succeeds. However, in the process of deleting | |
28 // these files, it fails to delete some other files. This may happen. | |
29 FAIL_DELETE_MAX_FILES_WITH_ERRORS, | |
30 // Fail to delete maximum files allowed when the maximum attempt failures | |
31 // are hit. This may heppen. | |
32 FAIL_MAX_DELETE_FAILURES, | |
33 // Fail to remove the raw empty directory. This may happen. | |
34 FAIL_REMOVE_RAW_DIRECTORY, | |
35 // Add new items before this one, always keep this one at the end. | |
36 END | |
37 }; | |
38 | |
39 // An enumeration indicating if a directory exists or if it is empty or not. | |
40 // This is used for UMA. Do not delete entries, and keep in sync with | |
41 // histograms.xml. | |
42 enum DirectoryStatus { | |
43 EMPTY = 0, | |
44 NON_EMPTY, | |
45 NON_EXIST, | |
46 // Add new items before this one, always keep this one at the end. | |
47 DIRECTORY_STATUS_END | |
48 }; | |
49 | |
50 // This method is similar to base::DeleteFileRecursive in | 13 // This method is similar to base::DeleteFileRecursive in |
51 // file_util_win.cc with the following differences. | 14 // file_util_win.cc with the following differences. |
52 // 1) It has an input parameter |max_file_deleted| to specify the maximum files | 15 // 1) It has an input parameter |max_file_deleted| to specify the maximum files |
53 // allowed to delete as well as the maximum attempt failures allowd per run. | 16 // allowed to delete as well as the maximum attempt failures allowd per run. |
54 // 2) It deletes only the files in |path|. All subdirectories in |path| are | 17 // 2) It deletes only the files in |path|. All subdirectories in |path| are |
55 // untouched but are considered as attempt failures. | 18 // untouched but are considered as attempt failures. |
56 // 3) Detailed delete status is returned. | 19 void DeleteFiles(const base::FilePath& path, |
57 FolderDeleteResult DeleteFiles(const base::FilePath& path, | 20 const base::FilePath::StringType& pattern, |
58 const base::FilePath::StringType& pattern, | 21 int max_file_deleted); |
59 int max_file_deleted); | |
60 | 22 |
61 // This method is similar to base::DeleteFile in file_util_win.cc | 23 // This method is similar to base::DeleteFile in file_util_win.cc |
62 // with the following differences. | 24 // with the following differences. |
63 // 1) It has an input parameter |max_file_deleted| to specify the maximum files | 25 // 1) It has an input parameter |max_file_deleted| to specify the maximum files |
64 // allowed to delete as well as the maximum attempt failures allowd per run. | 26 // allowed to delete as well as the maximum attempt failures allowd per run. |
65 // 2) It deletes only the files in |path|. All subdirectories in |path| are | 27 // 2) It deletes only the files in |path|. All subdirectories in |path| are |
66 // untouched but are considered as attempt failures. | 28 // untouched but are considered as attempt failures. |
67 // 3) |path| won't be removed even if all its contents are deleted successfully. | 29 // 3) |path| won't be removed even if all its contents are deleted successfully. |
68 // 4) Detailed delete status is returned. | 30 void DeleteDirectoryContent(const base::FilePath& path, int max_file_deleted); |
69 FolderDeleteResult DeleteDirectoryContent(const base::FilePath& path, | |
70 int max_file_deleted); | |
71 | 31 |
72 // This method firstly calls DeleteDirectoryContent() to delete the contents in | 32 // This method firstly calls DeleteDirectoryContent() to delete the contents in |
73 // |path|. If |path| is empty after the call, it is removed. | 33 // |path|. If |path| is empty after the call, it is removed. |
74 FolderDeleteResult DeleteDirectory(const base::FilePath& path, | 34 void DeleteDirectory(const base::FilePath& path, int max_file_deleted); |
75 int max_file_deleted); | |
76 | 35 |
77 // Deletes the directory at |path| and records the result to UMA. | 36 // Delete the content in the directory at |path| and records the runtime to UMA. |
grt (UTC plus 2)
2017/04/28 07:37:08
Delete -> Deletes
chengx
2017/04/28 22:29:29
Done.
| |
78 void DeleteDirectoryAndLogResults(const base::FilePath& path, | 37 // DeleteDirectoryContentAndLogRuntime is explicited called for certain folders' |
grt (UTC plus 2)
2017/04/28 07:37:08
this sentence documents the callers rather than th
chengx
2017/04/28 22:29:29
Agreed. I added this comment to avoid confusion ab
| |
79 int max_file_deleted); | 38 // operation, while DeleteDirectoryContent is called for others where we don't |
80 | 39 // care about the runtime at all. |
81 // Deletes the content in the directory at |path| and records the result to UMA. | 40 // TODO(chengx): Remove this method and use DeleteDirectoryContent after fixing |
82 void DeleteDirectoryContentAndLogResults(const base::FilePath& path, | 41 // http://crbug.com/40407. |
42 void DeleteDirectoryContentAndLogRuntime(const base::FilePath& path, | |
83 int max_file_deleted); | 43 int max_file_deleted); |
84 | 44 |
85 #endif // CHROME_BROWSER_WIN_JUMPLIST_FILE_UTIL_H_ | 45 #endif // CHROME_BROWSER_WIN_JUMPLIST_FILE_UTIL_H_ |
OLD | NEW |