components/reporting/util/file.h

// Copyright 2022 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

// Utilities for file operations.

#ifndef COMPONENTS_REPORTING_UTIL_FILE_H_
#define COMPONENTS_REPORTING_UTIL_FILE_H_

#include <string>

#include "base/files/file_path.h"
#include "base/functional/callback.h"
#include "base/strings/strcat.h"
#include "components/reporting/util/status.h"
#include "components/reporting/util/statusor.h"

namespace base {
class FileEnumerator;
}

namespace reporting {

// Deletes the given path, whether it's a file or a directory.
// This function is identical to base::DeleteFile() except that it issues a
// warning if the deletion fails. Useful when we do not care about whether the
// deletion succeeds or not.
bool DeleteFileWarnIfFailed(const base::FilePath& path);

// Enumerates over |dir_enum|, and deletes the file if pred.Run(file) returns
// true. If |pred| is unspecified, all files enumerated are deleted. If a
// directory is enumerated, it is deleted only if it is empty or contains only
// files and subdirectories that are also to be deleted. It deletes each
// individual file with DeleteFileWarnIfFailed(). Refer to
// DeleteFileWarnIfFailed() for the effect of the deletion. Returns true if all
// files are deleted successfully, otherwise returns false.
bool DeleteFilesWarnIfFailed(
    base::FileEnumerator& dir_enum,
    base::RepeatingCallback<bool(const base::FilePath&)> pred =
        base::BindRepeating([](const base::FilePath&) { return true; }));

// A convenient wrapper to the function above so that creating a named
// FileEnumerator object would be unneeded.
bool DeleteFilesWarnIfFailed(
    base::FileEnumerator&& dir_enum,
    base::RepeatingCallback<bool(const base::FilePath&)> pred =
        base::BindRepeating([](const base::FilePath&) { return true; }));

// Attempt to read entire file given from |file_path| starting from offset.
// Returns a string of the data read, or an error if one was encountered.
StatusOr<std::string> MaybeReadFile(const base::FilePath& file_path,
                                    int64_t offset);

// Appends |data| with a new line to |file_path|.
Status AppendLine(const base::FilePath& file_path,
                  const std::string_view& data);

// Overwrites or creates a new file at |file_path| with the contents |data|.
Status MaybeWriteFile(const base::FilePath& file_path,
                      const std::string_view& data);

// Removes the first |pos| bytes from a file at |file_path| and also removes
// the rest of the line which the byte at position |pos| was on.
StatusOr<uint32_t> RemoveAndTruncateLine(const base::FilePath& file_path,
                                         uint32_t pos);
}  // namespace reporting

#endif  // COMPONENTS_REPORTING_UTIL_FILE_H_