summaryrefslogtreecommitdiffstats
path: root/chrome/common/extensions/docs/server2/compiled_file_system.py
blob: 087eea8a08761efd4b172fc80181f7a45b8555d6 (plain)
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
# Copyright (c) 2012 The Chromium Authors. All rights reserved.
# Use of this source code is governed by a BSD-style license that can be
# found in the LICENSE file.

class _CacheEntry(object):
  def __init__(self, cache_data, version):
    self._cache_data = cache_data
    self.version = version

class CompiledFileSystem(object):
  """This class caches FileSystem data that has been processed.
  """
  class Factory(object):
    """A class to build a CompiledFileSystem backed by |file_system|.
    """
    def __init__(self, file_system, object_store_creator):
      self._file_system = file_system
      self._object_store_creator = object_store_creator

    def Create(self, populate_function, cls, category=None):
      """Create a CompiledFileSystem that populates the cache by calling
      |populate_function| with (path, data), where |data| is the data that was
      fetched from |path|.
      The namespace for the file system is derived like ObjectStoreCreator: from
      |cls| along with an optional |category|.
      """
      assert isinstance(cls, type)
      assert not cls.__name__[0].islower()  # guard against non-class types
      full_name = cls.__name__
      if category is not None:
        full_name = '%s/%s' % (full_name, category)
      def create_object_store(category):
        return self._object_store_creator.Create(
            CompiledFileSystem, category='%s/%s' % (full_name, category))
      return CompiledFileSystem(self._file_system,
                                populate_function,
                                create_object_store('file'),
                                create_object_store('list'))

    def CreateIdentity(self, cls):
      '''Handy helper to get or create the identity compiled file system.
      GetFromFile will return the file's contents.
      GetFromFileListing will return the directory list.
      '''
      return self.Create(lambda _, x: x, cls)

  def __init__(self,
               file_system,
               populate_function,
               file_object_store,
               list_object_store):
    self._file_system = file_system
    self._populate_function = populate_function
    self._file_object_store = file_object_store
    self._list_object_store = list_object_store

  def _RecursiveList(self, path):
    files = []
    for filename in self._file_system.ReadSingle(path):
      if filename.endswith('/'):
        files.extend(['%s%s' % (filename, f)
                      for f in self._RecursiveList('%s%s' % (path, filename))])
      else:
        files.append(filename)
    return files

  def GetFromFile(self, path, binary=False):
    """Calls |populate_function| on the contents of the file at |path|.  If
    |binary| is True then the file will be read as binary - but this will only
    apply for the first time the file is fetched; if already cached, |binary|
    will be ignored.
    """
    version = self._file_system.Stat(path).version
    cache_entry = self._file_object_store.Get(path).Get()
    if (cache_entry is not None) and (version == cache_entry.version):
      return cache_entry._cache_data
    cache_data = self._populate_function(
        path,
        self._file_system.ReadSingle(path, binary=binary))
    self._file_object_store.Set(path, _CacheEntry(cache_data, version))
    return cache_data

  def GetFromFileListing(self, path):
    """Calls |populate_function| on the listing of the files at |path|.
    Assumes that the path given is to a directory.
    """
    if not path.endswith('/'):
      path += '/'
    version = self._file_system.Stat(path).version
    cache_entry = self._list_object_store.Get(path).Get()
    if (cache_entry is not None) and (version == cache_entry.version):
        return cache_entry._cache_data
    cache_data = self._populate_function(path, self._RecursiveList(path))
    self._list_object_store.Set(path, _CacheEntry(cache_data, version))
    return cache_data

  def StatFile(self, path):
    cache_entry = self._file_object_store.Get(path).Get()
    if cache_entry is not None:
      return cache_entry.version
    return self._file_system.Stat(path).version

  def StatFileListing(self, path):
    if not path.endswith('/'):
      path += '/'
    cache_entry = self._list_object_store.Get(path).Get()
    if cache_entry is not None:
      return cache_entry.version
    return self._file_system.Stat(path).version