net/disk_cache/simple/simple_util.h

   1 // Copyright (c) 2013 The Chromium Authors. All rights reserved.
   2 // Use of this source code is governed by a BSD-style license that can be
   3 // found in the LICENSE file.
   4
   5 #ifndef NET_DISK_CACHE_SIMPLE_SIMPLE_UTIL_H_
   6 #define NET_DISK_CACHE_SIMPLE_SIMPLE_UTIL_H_
   7
   8 #include <string>
   9
  10 #include "base/basictypes.h"
  11 #include "base/strings/string_piece.h"
  12 #include "net/base/net_export.h"
  13
  14 namespace base {
  15 class FilePath;
  16 class Time;
  17 }
  18
  19 namespace disk_cache {
  20
  21 namespace simple_util {
  22
  23 NET_EXPORT_PRIVATE std::string ConvertEntryHashKeyToHexString(uint64 hash_key);
  24
  25 // |key| is the regular cache key, such as an URL.
  26 // Returns the Hex ascii representation of the uint64 hash_key.
  27 NET_EXPORT_PRIVATE std::string GetEntryHashKeyAsHexString(
  28     const std::string& key);
  29
  30 // |key| is the regular HTTP Cache key, which is a URL.
  31 // Returns the hash of the key as uint64.
  32 NET_EXPORT_PRIVATE uint64 GetEntryHashKey(const std::string& key);
  33
  34 // Parses the |hash_key| string into a uint64 buffer.
  35 // |hash_key| string must be of the form: FFFFFFFFFFFFFFFF .
  36 NET_EXPORT_PRIVATE bool GetEntryHashKeyFromHexString(
  37     const base::StringPiece& hash_key,
  38     uint64* hash_key_out);
  39
  40 // Given a |key| for a (potential) entry in the simple backend and the |index|
  41 // of a stream on that entry, returns the filename in which that stream would be
  42 // stored.
  43 NET_EXPORT_PRIVATE std::string GetFilenameFromKeyAndIndex(
  44     const std::string& key,
  45     int index);
  46
  47 // Same as |GetFilenameFromKeyAndIndex| above, but using a hex string.
  48 std::string GetFilenameFromEntryHashAndIndex(uint64 entry_hash, int index);
  49
  50 // Given the size of a file holding a stream in the simple backend and the key
  51 // to an entry, returns the number of bytes in the stream.
  52 NET_EXPORT_PRIVATE int32 GetDataSizeFromKeyAndFileSize(const std::string& key,
  53                                                        int64 file_size);
  54
  55 // Given the size of a stream in the simple backend and the key to an entry,
  56 // returns the number of bytes in the file.
  57 NET_EXPORT_PRIVATE int64 GetFileSizeFromKeyAndDataSize(const std::string& key,
  58                                                        int32 data_size);
  59
  60 // Given the key to an entry, and an offset into a stream on that entry, returns
  61 // the file offset corresponding to |data_offset|.
  62 NET_EXPORT_PRIVATE int64 GetFileOffsetFromKeyAndDataOffset(
  63     const std::string& key,
  64     int data_offset);
  65
  66 // Fills |out_time| with the time the file last modified time. Unlike the
  67 // functions in platform_file.h, the time resolution is milliseconds.
  68 NET_EXPORT_PRIVATE bool GetMTime(const base::FilePath& path,
  69                                  base::Time* out_mtime);
  70 }  // namespace simple_backend
  71
  72 }  // namespace disk_cache
  73
  74 #endif  // NET_DISK_CACHE_SIMPLE_SIMPLE_UTIL_H_