paul@41 | 1 | # -*- coding: iso-8859-1 -*- |
paul@41 | 2 | """ |
paul@41 | 3 | MoinMoin - ItemSupport library |
paul@41 | 4 | |
paul@41 | 5 | @copyright: 2013 by Paul Boddie <paul@boddie.org.uk> |
paul@41 | 6 | @license: GNU GPL (v2 or later), see COPYING.txt for details. |
paul@41 | 7 | """ |
paul@41 | 8 | |
paul@41 | 9 | from MoinMoin.util import lock |
paul@41 | 10 | import os |
paul@41 | 11 | |
paul@41 | 12 | # Content storage support. |
paul@41 | 13 | |
paul@41 | 14 | class ItemDirectoryStore: |
paul@41 | 15 | |
paul@41 | 16 | "A directory-based item store." |
paul@41 | 17 | |
paul@41 | 18 | def __init__(self, path, lock_dir): |
paul@41 | 19 | |
paul@41 | 20 | "Initialise an item store for the given 'path' and 'lock_dir'." |
paul@41 | 21 | |
paul@41 | 22 | self.path = path |
paul@41 | 23 | self.next_path = os.path.join(self.path, "next") |
paul@41 | 24 | self.lock_dir = lock_dir |
paul@41 | 25 | self.writelock = lock.WriteLock(lock_dir) |
paul@41 | 26 | self.readlock = lock.ReadLock(lock_dir) |
paul@41 | 27 | |
paul@47 | 28 | def mtime(self): |
paul@47 | 29 | |
paul@47 | 30 | "Return the last modified time of the item store directory." |
paul@47 | 31 | |
paul@47 | 32 | return os.path.getmtime(self.path) |
paul@47 | 33 | |
paul@41 | 34 | def get_next(self): |
paul@41 | 35 | |
paul@41 | 36 | "Return the next item number." |
paul@41 | 37 | |
paul@41 | 38 | next = self.read_next() |
paul@41 | 39 | if next is None: |
paul@41 | 40 | next = self.deduce_next() |
paul@41 | 41 | self.write_next(next) |
paul@41 | 42 | return next |
paul@41 | 43 | |
paul@63 | 44 | def get_keys(self): |
paul@63 | 45 | |
paul@63 | 46 | "Return the item keys." |
paul@63 | 47 | |
paul@63 | 48 | return [int(filename) for filename in os.listdir(self.path) if filename.isdigit()] |
paul@63 | 49 | |
paul@41 | 50 | def deduce_next(self): |
paul@41 | 51 | |
paul@41 | 52 | "Deduce the next item number from the existing item files." |
paul@41 | 53 | |
paul@63 | 54 | return max(self.get_keys() or [-1]) + 1 |
paul@41 | 55 | |
paul@41 | 56 | def read_next(self): |
paul@41 | 57 | |
paul@41 | 58 | "Read the next item number from a special file." |
paul@41 | 59 | |
paul@41 | 60 | if not os.path.exists(self.next_path): |
paul@41 | 61 | return None |
paul@41 | 62 | |
paul@41 | 63 | f = open(self.next_path) |
paul@41 | 64 | try: |
paul@41 | 65 | try: |
paul@41 | 66 | return int(f.read()) |
paul@41 | 67 | except ValueError: |
paul@41 | 68 | return None |
paul@41 | 69 | finally: |
paul@41 | 70 | f.close() |
paul@41 | 71 | |
paul@41 | 72 | def write_next(self, next): |
paul@41 | 73 | |
paul@41 | 74 | "Write the 'next' item number to a special file." |
paul@41 | 75 | |
paul@41 | 76 | f = open(self.next_path, "w") |
paul@41 | 77 | try: |
paul@41 | 78 | f.write(str(next)) |
paul@41 | 79 | finally: |
paul@41 | 80 | f.close() |
paul@41 | 81 | |
paul@41 | 82 | def write_item(self, item, next): |
paul@41 | 83 | |
paul@41 | 84 | "Write the given 'item' to a file with the given 'next' item number." |
paul@41 | 85 | |
paul@41 | 86 | f = open(self.get_item_path(next), "w") |
paul@41 | 87 | try: |
paul@41 | 88 | f.write(item) |
paul@41 | 89 | finally: |
paul@41 | 90 | f.close() |
paul@41 | 91 | |
paul@41 | 92 | def read_item(self, number): |
paul@41 | 93 | |
paul@41 | 94 | "Read the item with the given item 'number'." |
paul@41 | 95 | |
paul@41 | 96 | f = open(self.get_item_path(number)) |
paul@41 | 97 | try: |
paul@41 | 98 | return f.read() |
paul@41 | 99 | finally: |
paul@41 | 100 | f.close() |
paul@41 | 101 | |
paul@63 | 102 | def remove_item(self, number): |
paul@63 | 103 | |
paul@63 | 104 | "Remove the item with the given item 'number'." |
paul@63 | 105 | |
paul@63 | 106 | os.remove(self.get_item_path(number)) |
paul@63 | 107 | |
paul@41 | 108 | def get_item_path(self, number): |
paul@41 | 109 | |
paul@41 | 110 | "Get the path for the given item 'number'." |
paul@41 | 111 | |
paul@41 | 112 | path = os.path.abspath(os.path.join(self.path, str(number))) |
paul@41 | 113 | basepath = os.path.join(self.path, "") |
paul@41 | 114 | |
paul@41 | 115 | if os.path.commonprefix([path, basepath]) != basepath: |
paul@41 | 116 | raise OSError, path |
paul@41 | 117 | |
paul@41 | 118 | return path |
paul@41 | 119 | |
paul@41 | 120 | # High-level methods. |
paul@41 | 121 | |
paul@41 | 122 | def append(self, item): |
paul@41 | 123 | |
paul@41 | 124 | "Append the given 'item' to the store." |
paul@41 | 125 | |
paul@41 | 126 | self.writelock.acquire() |
paul@41 | 127 | try: |
paul@41 | 128 | next = self.get_next() |
paul@41 | 129 | self.write_item(item, next) |
paul@41 | 130 | self.write_next(next + 1) |
paul@41 | 131 | finally: |
paul@41 | 132 | self.writelock.release() |
paul@41 | 133 | |
paul@41 | 134 | def __len__(self): |
paul@41 | 135 | |
paul@41 | 136 | """ |
paul@63 | 137 | Return the number of items. |
paul@41 | 138 | """ |
paul@41 | 139 | |
paul@63 | 140 | return len(self.keys()) |
paul@41 | 141 | |
paul@41 | 142 | def __iter__(self): |
paul@41 | 143 | |
paul@41 | 144 | "Return an iterator over the items in the store." |
paul@41 | 145 | |
paul@41 | 146 | return ItemIterator(self) |
paul@41 | 147 | |
paul@63 | 148 | def keys(self): |
paul@63 | 149 | |
paul@63 | 150 | "Return a list of keys for items in the store." |
paul@63 | 151 | |
paul@63 | 152 | self.readlock.acquire() |
paul@63 | 153 | try: |
paul@63 | 154 | return self.get_keys() |
paul@63 | 155 | finally: |
paul@63 | 156 | self.readlock.release() |
paul@63 | 157 | |
paul@41 | 158 | def __getitem__(self, number): |
paul@41 | 159 | |
paul@41 | 160 | "Return the item with the given 'number'." |
paul@41 | 161 | |
paul@41 | 162 | self.readlock.acquire() |
paul@41 | 163 | try: |
paul@41 | 164 | try: |
paul@41 | 165 | return self.read_item(number) |
paul@41 | 166 | except (IOError, OSError): |
paul@41 | 167 | raise IndexError, number |
paul@41 | 168 | finally: |
paul@41 | 169 | self.readlock.release() |
paul@41 | 170 | |
paul@63 | 171 | def __delitem__(self, number): |
paul@63 | 172 | |
paul@63 | 173 | "Remove the item with the given 'number' from the store." |
paul@63 | 174 | |
paul@63 | 175 | self.writelock.acquire() |
paul@63 | 176 | try: |
paul@63 | 177 | try: |
paul@63 | 178 | self.remove_item(number) |
paul@63 | 179 | except (IOError, OSError): |
paul@63 | 180 | raise IndexError, number |
paul@63 | 181 | finally: |
paul@63 | 182 | self.writelock.release() |
paul@63 | 183 | |
paul@63 | 184 | def next(self): |
paul@63 | 185 | |
paul@63 | 186 | """ |
paul@63 | 187 | Return the number of the next item (which should also be the number of |
paul@63 | 188 | items if none have been deleted). |
paul@63 | 189 | """ |
paul@63 | 190 | |
paul@63 | 191 | self.writelock.acquire() |
paul@63 | 192 | try: |
paul@63 | 193 | return self.get_next() |
paul@63 | 194 | finally: |
paul@63 | 195 | self.writelock.release() |
paul@63 | 196 | |
paul@41 | 197 | class ItemIterator: |
paul@41 | 198 | |
paul@41 | 199 | "An iterator over items in a store." |
paul@41 | 200 | |
paul@46 | 201 | def __init__(self, store, direction=1): |
paul@41 | 202 | self.store = store |
paul@46 | 203 | self.direction = direction |
paul@46 | 204 | self.reset() |
paul@46 | 205 | |
paul@46 | 206 | def reset(self): |
paul@46 | 207 | if self.direction == 1: |
paul@46 | 208 | self._next = 0 |
paul@63 | 209 | self.final = self.store.next() |
paul@46 | 210 | else: |
paul@63 | 211 | self._next = self.store.next() - 1 |
paul@46 | 212 | self.final = 0 |
paul@46 | 213 | |
paul@46 | 214 | def more(self): |
paul@46 | 215 | if self.direction == 1: |
paul@46 | 216 | return self._next < self.final |
paul@46 | 217 | else: |
paul@46 | 218 | return self._next >= self.final |
paul@46 | 219 | |
paul@46 | 220 | def get_next(self): |
paul@46 | 221 | next = self._next |
paul@46 | 222 | self._next += self.direction |
paul@46 | 223 | return next |
paul@41 | 224 | |
paul@41 | 225 | def next(self): |
paul@46 | 226 | while self.more(): |
paul@41 | 227 | try: |
paul@46 | 228 | return self.store[self.get_next()] |
paul@41 | 229 | except IndexError: |
paul@41 | 230 | pass |
paul@41 | 231 | |
paul@41 | 232 | raise StopIteration |
paul@41 | 233 | |
paul@46 | 234 | def reverse(self): |
paul@46 | 235 | self.direction = -self.direction |
paul@46 | 236 | self.reset() |
paul@46 | 237 | |
paul@46 | 238 | def reversed(self): |
paul@46 | 239 | self.reverse() |
paul@46 | 240 | return self |
paul@46 | 241 | |
paul@46 | 242 | def __iter__(self): |
paul@46 | 243 | return self |
paul@46 | 244 | |
paul@41 | 245 | # vim: tabstop=4 expandtab shiftwidth=4 |