File: trash_auto_cleanup.cc

package info (click to toggle)
chromium 139.0.7258.127-1
  • links: PTS, VCS
  • area: main
  • in suites:
  • size: 6,122,068 kB
  • sloc: cpp: 35,100,771; ansic: 7,163,530; javascript: 4,103,002; python: 1,436,920; asm: 946,517; xml: 746,709; pascal: 187,653; perl: 88,691; sh: 88,436; objc: 79,953; sql: 51,488; cs: 44,583; fortran: 24,137; makefile: 22,147; tcl: 15,277; php: 13,980; yacc: 8,984; ruby: 7,485; awk: 3,720; lisp: 3,096; lex: 1,327; ada: 727; jsp: 228; sed: 36
file content (237 lines) | stat: -rw-r--r-- 9,120 bytes parent folder | download | duplicates (6)
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
231
232
233
234
235
236
237
// Copyright 2024 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#include "chrome/browser/ash/file_manager/trash_auto_cleanup.h"

#include "base/barrier_callback.h"
#include "base/files/file_enumerator.h"
#include "base/files/file_util.h"
#include "base/metrics/histogram_functions.h"
#include "base/system/sys_info.h"
#include "base/task/thread_pool.h"
#include "base/time/time.h"
#include "chrome/browser/ash/file_manager/trash_common_util.h"

namespace file_manager::trash {

namespace {

constexpr char kCleanupFileCountMetricName[] =
    "FileBrowser.TrashAutoCleanup.FileCount";
constexpr char kCleanupErrorsMetricName[] =
    "FileBrowser.TrashAutoCleanup.Errors";
constexpr char kCleanupTimeMetricName[] = "FileBrowser.TrashAutoCleanup.Time";

// Enumerates Trash info files (supported .Trash/info/ locations) and returns
// the list of trashinfo files corresponding to the trash entries to delete.
// A maximum of `kMaxBatchSize` trashinfo files is returned.
std::vector<base::FilePath> GetTrashInfoFilesToDeleteOnBlockingThread(
    const std::vector<base::FilePath>& trash_info_directories) {
  std::vector<base::FilePath> trash_info_paths_to_delete;
  base::Time now = base::Time::Now();
  int invalid_file_counter = 0;
  int file_get_info_failed_counter = 0;
  for (const base::FilePath& dir : trash_info_directories) {
    base::FileEnumerator file_iter(dir, false, base::FileEnumerator::FILES);
    while (!file_iter.Next().empty()) {
      const std::string file_name = file_iter.GetInfo().GetName().value();
      const base::FilePath trash_info_path = dir.Append(file_name);
      // Get last modified time.
      base::File file(trash_info_path,
                      base::File::FLAG_OPEN | base::File::FLAG_READ);
      if (!file.IsValid()) {
        ++invalid_file_counter;
        base::UmaHistogramEnumeration(kCleanupErrorsMetricName,
                                      AutoCleanupError::kInvalidTrashInfoFile);
        continue;
      }
      base::File::Info info;
      if (!file.GetInfo(&info)) {
        ++file_get_info_failed_counter;
        base::UmaHistogramEnumeration(
            kCleanupErrorsMetricName,
            AutoCleanupError::kFailedToGetTrashInfoFileModifiedTime);
        continue;
      }
      if (now - info.last_modified >= kMaxTrashAge) {
        trash_info_paths_to_delete.push_back(trash_info_path);
        if (trash_info_paths_to_delete.size() >= kMaxBatchSize) {
          break;
        }
      }
    }
    if (trash_info_paths_to_delete.size() >= kMaxBatchSize) {
      break;
    }
  }
  if (invalid_file_counter) {
    LOG(ERROR) << invalid_file_counter << " invalid trashinfo files";
  }
  if (file_get_info_failed_counter) {
    LOG(ERROR) << "Could not get info from " << file_get_info_failed_counter
               << " trashinfo files";
  }
  base::UmaHistogramCounts1000(kCleanupFileCountMetricName,
                               trash_info_paths_to_delete.size());
  return trash_info_paths_to_delete;
}

bool DeleteOldTrashFilesOnBlockingThread(
    std::vector<ParsedTrashInfoData> to_delete) {
  bool success = true;
  for (const ParsedTrashInfoData& trash_info_data : to_delete) {
    if (!base::DeleteFile(trash_info_data.trashed_file_path) ||
        !base::DeleteFile(trash_info_data.trash_info_path)) {
      base::UmaHistogramEnumeration(kCleanupErrorsMetricName,
                                    AutoCleanupError::kFailedToDeleteTrashFile);
      success = false;
    } else {
      base::UmaHistogramEnumeration(kCleanupErrorsMetricName,
                                    AutoCleanupError::kSuccessfullyDeleted);
    }
  }
  return success;
}

}  // namespace

TrashAutoCleanup::TrashAutoCleanup(Profile* profile) : profile_(profile) {
  const TrashPathsMap trash_locations_ =
      file_manager::trash::GenerateEnabledTrashLocationsForProfile(profile_);
  for (const trash::TrashPathsMap::value_type& location : trash_locations_) {
    trash_info_directories_.push_back(
        location.first.Append(location.second.relative_folder_path)
            .Append(kInfoFolderName));
  }
}

TrashAutoCleanup::~TrashAutoCleanup() = default;

std::unique_ptr<TrashAutoCleanup> TrashAutoCleanup::Create(Profile* profile) {
  // Only run the auto cleanup process for regular profiles on ChromeOS.
  if (!file_manager::trash::IsTrashEnabledForProfile(profile) || !profile ||
      !profile->IsRegularProfile() || !base::SysInfo::IsRunningOnChromeOS()) {
    return nullptr;
  }

  auto instance = base::WrapUnique(new TrashAutoCleanup(profile));
  instance->Init();
  return instance;
}

void TrashAutoCleanup::Init() {
  cleanup_repeating_timer_.Start(
      FROM_HERE, kCleanupCheckInterval,
      base::BindRepeating(&TrashAutoCleanup::StartCleanup,
                          weak_ptr_factory_.GetWeakPtr()));
}

void TrashAutoCleanup::StartCleanup() {
  // "TrashEnabled" can be dynamically refreshed, make sure that it's enabled.
  if (!file_manager::trash::IsTrashEnabledForProfile(profile_)) {
    return;
  }

  if (!last_cleanup_time_.is_null() &&
      base::Time::Now() - last_cleanup_time_ < kCleanupInterval) {
    // Skip cleanup iteration if it last happened less than a day earlier.
    if (cleanup_done_closure_for_test_) {
      std::move(cleanup_done_closure_for_test_)
          .Run(AutoCleanupResult::kWaitingForNextCleanupIteration);
    }
    return;
  }
  last_cleanup_time_ = base::Time::Now();
  cleanup_start_time_ = base::TimeTicks::Now();

  base::ThreadPool::PostTaskAndReplyWithResult(
      FROM_HERE,
      {base::MayBlock(), base::TaskShutdownBehavior::SKIP_ON_SHUTDOWN,
       base::TaskPriority::BEST_EFFORT},
      base::BindOnce(&GetTrashInfoFilesToDeleteOnBlockingThread,
                     trash_info_directories_),
      base::BindOnce(&TrashAutoCleanup::OnTrashInfoFilesToDeleteEnumerated,
                     weak_ptr_factory_.GetWeakPtr()));
}

void TrashAutoCleanup::OnTrashInfoFilesToDeleteEnumerated(
    const std::vector<base::FilePath>& trash_info_paths_to_delete) {
  if (trash_info_paths_to_delete.empty()) {
    if (cleanup_done_closure_for_test_) {
      std::move(cleanup_done_closure_for_test_)
          .Run(AutoCleanupResult::kNoOldFilesToCleanup);
    }
    return;
  }
  if (trash_info_paths_to_delete.size() == kMaxBatchSize) {
    // The maximum batch size has been reached: there is more likely going to be
    // more files to cleanup. Unset the last cleanup time to force the next
    // iteration.
    last_cleanup_time_ = base::Time();
  }
  validator_ =
      std::make_unique<file_manager::trash::TrashInfoValidator>(profile_);
  auto barrier_callback =
      base::BarrierCallback<file_manager::trash::ParsedTrashInfoDataOrError>(
          trash_info_paths_to_delete.size(),
          base::BindOnce(&TrashAutoCleanup::OnTrashInfoFilesParsed,
                         weak_ptr_factory_.GetWeakPtr()));
  for (const base::FilePath& path : trash_info_paths_to_delete) {
    validator_->ValidateAndParseTrashInfo(std::move(path), barrier_callback);
  }
}

void TrashAutoCleanup::OnTrashInfoFilesParsed(
    std::vector<ParsedTrashInfoDataOrError> parsed_data_or_error) {
  validator_.reset();
  std::vector<ParsedTrashInfoData> to_delete;
  int parse_error_counter = 0;
  for (auto& trash_info_data_or_error : parsed_data_or_error) {
    if (!trash_info_data_or_error.has_value()) {
      ++parse_error_counter;
      base::UmaHistogramEnumeration(
          kCleanupErrorsMetricName,
          AutoCleanupError::kFailedToParseTrashInfoFile);
      continue;
    }
    to_delete.push_back(std::move(trash_info_data_or_error.value()));
  }
  if (parse_error_counter) {
    LOG(ERROR) << "Failed to parse " << parse_error_counter
               << " trash info files";
    if (cleanup_done_closure_for_test_) {
      std::move(cleanup_done_closure_for_test_)
          .Run(AutoCleanupResult::kTrashInfoParsingError);
    }
  }
  if (to_delete.empty()) {
    return;
  }
  base::ThreadPool::PostTaskAndReplyWithResult(
      FROM_HERE,
      {base::MayBlock(), base::TaskShutdownBehavior::SKIP_ON_SHUTDOWN,
       base::TaskPriority::BEST_EFFORT},
      base::BindOnce(&DeleteOldTrashFilesOnBlockingThread,
                     std::move(to_delete)),
      base::BindOnce(&TrashAutoCleanup::OnCleanupDone,
                     weak_ptr_factory_.GetWeakPtr()));
}

void TrashAutoCleanup::OnCleanupDone(bool success) {
  if (cleanup_done_closure_for_test_) {
    const AutoCleanupResult result = success
                                         ? AutoCleanupResult::kCleanupSuccessful
                                         : AutoCleanupResult::kDeletionError;
    std::move(cleanup_done_closure_for_test_).Run(result);
  }
  base::UmaHistogramTimes(kCleanupTimeMetricName,
                          base::TimeTicks::Now() - cleanup_start_time_);
}

void TrashAutoCleanup::SetCleanupDoneCallbackForTest(
    base::OnceCallback<void(AutoCleanupResult result)> cleanup_done_closure) {
  cleanup_done_closure_for_test_ = std::move(cleanup_done_closure);
}

}  // namespace file_manager::trash