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@96 | 9 | from MoinMoin.Page import Page |
paul@95 | 10 | from MoinMoin.PageEditor import PageEditor |
paul@41 | 11 | from MoinMoin.util import lock |
paul@96 | 12 | from MoinSupport import getMetadata, getPagesForSearch |
paul@95 | 13 | import re |
paul@41 | 14 | import os |
paul@41 | 15 | |
paul@41 | 16 | # Content storage support. |
paul@41 | 17 | |
paul@95 | 18 | # Underlying storage mechanisms. |
paul@95 | 19 | |
paul@92 | 20 | class GeneralItemStore: |
paul@91 | 21 | |
paul@91 | 22 | "Common item store functionality." |
paul@91 | 23 | |
paul@91 | 24 | def __init__(self, lock_dir): |
paul@91 | 25 | |
paul@91 | 26 | "Initialise an item store with the given 'lock_dir' guarding access." |
paul@91 | 27 | |
paul@91 | 28 | self.lock_dir = lock_dir |
paul@91 | 29 | self.writelock = lock.WriteLock(lock_dir) |
paul@91 | 30 | self.readlock = lock.ReadLock(lock_dir) |
paul@91 | 31 | |
paul@91 | 32 | def deduce_next(self): |
paul@91 | 33 | |
paul@91 | 34 | "Deduce the next item number from the existing item files." |
paul@91 | 35 | |
paul@91 | 36 | return max(self.get_keys() or [-1]) + 1 |
paul@91 | 37 | |
paul@91 | 38 | # High-level methods. |
paul@91 | 39 | |
paul@91 | 40 | def __len__(self): |
paul@91 | 41 | |
paul@91 | 42 | """ |
paul@91 | 43 | Return the number of items. |
paul@91 | 44 | """ |
paul@91 | 45 | |
paul@91 | 46 | return len(self.keys()) |
paul@91 | 47 | |
paul@91 | 48 | def __iter__(self): |
paul@91 | 49 | |
paul@91 | 50 | "Return an iterator over the items in the store." |
paul@91 | 51 | |
paul@91 | 52 | return ItemIterator(self) |
paul@91 | 53 | |
paul@91 | 54 | def keys(self): |
paul@91 | 55 | |
paul@91 | 56 | "Return a list of keys for items in the store." |
paul@91 | 57 | |
paul@91 | 58 | self.readlock.acquire() |
paul@91 | 59 | try: |
paul@91 | 60 | return self.get_keys() |
paul@91 | 61 | finally: |
paul@91 | 62 | self.readlock.release() |
paul@91 | 63 | |
paul@91 | 64 | def __getitem__(self, number): |
paul@91 | 65 | |
paul@91 | 66 | "Return the item with the given 'number'." |
paul@91 | 67 | |
paul@91 | 68 | self.readlock.acquire() |
paul@91 | 69 | try: |
paul@91 | 70 | try: |
paul@91 | 71 | return self.read_item(number) |
paul@91 | 72 | except (IOError, OSError): |
paul@91 | 73 | raise IndexError, number |
paul@91 | 74 | finally: |
paul@91 | 75 | self.readlock.release() |
paul@91 | 76 | |
paul@91 | 77 | def __delitem__(self, number): |
paul@91 | 78 | |
paul@91 | 79 | "Remove the item with the given 'number' from the store." |
paul@91 | 80 | |
paul@91 | 81 | self.writelock.acquire() |
paul@91 | 82 | try: |
paul@91 | 83 | try: |
paul@91 | 84 | self.remove_item(number) |
paul@91 | 85 | except (IOError, OSError): |
paul@91 | 86 | raise IndexError, number |
paul@91 | 87 | finally: |
paul@91 | 88 | self.writelock.release() |
paul@91 | 89 | |
paul@91 | 90 | def next(self): |
paul@91 | 91 | |
paul@91 | 92 | """ |
paul@91 | 93 | Return the number of the next item (which should also be the number of |
paul@91 | 94 | items if none have been deleted). |
paul@91 | 95 | """ |
paul@91 | 96 | |
paul@91 | 97 | self.writelock.acquire() |
paul@91 | 98 | try: |
paul@91 | 99 | return self.get_next() |
paul@91 | 100 | finally: |
paul@91 | 101 | self.writelock.release() |
paul@91 | 102 | |
paul@92 | 103 | class DirectoryItemStore(GeneralItemStore): |
paul@41 | 104 | |
paul@41 | 105 | "A directory-based item store." |
paul@41 | 106 | |
paul@41 | 107 | def __init__(self, path, lock_dir): |
paul@41 | 108 | |
paul@41 | 109 | "Initialise an item store for the given 'path' and 'lock_dir'." |
paul@41 | 110 | |
paul@41 | 111 | self.path = path |
paul@41 | 112 | self.next_path = os.path.join(self.path, "next") |
paul@41 | 113 | self.lock_dir = lock_dir |
paul@41 | 114 | self.writelock = lock.WriteLock(lock_dir) |
paul@41 | 115 | self.readlock = lock.ReadLock(lock_dir) |
paul@41 | 116 | |
paul@47 | 117 | def mtime(self): |
paul@47 | 118 | |
paul@47 | 119 | "Return the last modified time of the item store directory." |
paul@47 | 120 | |
paul@47 | 121 | return os.path.getmtime(self.path) |
paul@47 | 122 | |
paul@41 | 123 | def get_next(self): |
paul@41 | 124 | |
paul@41 | 125 | "Return the next item number." |
paul@41 | 126 | |
paul@41 | 127 | next = self.read_next() |
paul@41 | 128 | if next is None: |
paul@41 | 129 | next = self.deduce_next() |
paul@41 | 130 | self.write_next(next) |
paul@41 | 131 | return next |
paul@41 | 132 | |
paul@63 | 133 | def get_keys(self): |
paul@63 | 134 | |
paul@63 | 135 | "Return the item keys." |
paul@63 | 136 | |
paul@63 | 137 | return [int(filename) for filename in os.listdir(self.path) if filename.isdigit()] |
paul@63 | 138 | |
paul@41 | 139 | def read_next(self): |
paul@41 | 140 | |
paul@41 | 141 | "Read the next item number from a special file." |
paul@41 | 142 | |
paul@41 | 143 | if not os.path.exists(self.next_path): |
paul@41 | 144 | return None |
paul@41 | 145 | |
paul@41 | 146 | f = open(self.next_path) |
paul@41 | 147 | try: |
paul@41 | 148 | try: |
paul@41 | 149 | return int(f.read()) |
paul@41 | 150 | except ValueError: |
paul@41 | 151 | return None |
paul@41 | 152 | finally: |
paul@41 | 153 | f.close() |
paul@41 | 154 | |
paul@41 | 155 | def write_next(self, next): |
paul@41 | 156 | |
paul@41 | 157 | "Write the 'next' item number to a special file." |
paul@41 | 158 | |
paul@41 | 159 | f = open(self.next_path, "w") |
paul@41 | 160 | try: |
paul@41 | 161 | f.write(str(next)) |
paul@41 | 162 | finally: |
paul@41 | 163 | f.close() |
paul@41 | 164 | |
paul@41 | 165 | def write_item(self, item, next): |
paul@41 | 166 | |
paul@41 | 167 | "Write the given 'item' to a file with the given 'next' item number." |
paul@41 | 168 | |
paul@41 | 169 | f = open(self.get_item_path(next), "w") |
paul@41 | 170 | try: |
paul@41 | 171 | f.write(item) |
paul@41 | 172 | finally: |
paul@41 | 173 | f.close() |
paul@41 | 174 | |
paul@41 | 175 | def read_item(self, number): |
paul@41 | 176 | |
paul@41 | 177 | "Read the item with the given item 'number'." |
paul@41 | 178 | |
paul@41 | 179 | f = open(self.get_item_path(number)) |
paul@41 | 180 | try: |
paul@41 | 181 | return f.read() |
paul@41 | 182 | finally: |
paul@41 | 183 | f.close() |
paul@41 | 184 | |
paul@63 | 185 | def remove_item(self, number): |
paul@63 | 186 | |
paul@63 | 187 | "Remove the item with the given item 'number'." |
paul@63 | 188 | |
paul@63 | 189 | os.remove(self.get_item_path(number)) |
paul@63 | 190 | |
paul@41 | 191 | def get_item_path(self, number): |
paul@41 | 192 | |
paul@41 | 193 | "Get the path for the given item 'number'." |
paul@41 | 194 | |
paul@41 | 195 | path = os.path.abspath(os.path.join(self.path, str(number))) |
paul@41 | 196 | basepath = os.path.join(self.path, "") |
paul@41 | 197 | |
paul@41 | 198 | if os.path.commonprefix([path, basepath]) != basepath: |
paul@41 | 199 | raise OSError, path |
paul@41 | 200 | |
paul@41 | 201 | return path |
paul@41 | 202 | |
paul@41 | 203 | # High-level methods. |
paul@41 | 204 | |
paul@41 | 205 | def append(self, item): |
paul@41 | 206 | |
paul@41 | 207 | "Append the given 'item' to the store." |
paul@41 | 208 | |
paul@41 | 209 | self.writelock.acquire() |
paul@41 | 210 | try: |
paul@41 | 211 | next = self.get_next() |
paul@41 | 212 | self.write_item(item, next) |
paul@41 | 213 | self.write_next(next + 1) |
paul@41 | 214 | finally: |
paul@41 | 215 | self.writelock.release() |
paul@41 | 216 | |
paul@95 | 217 | class SubpageItemStore(GeneralItemStore): |
paul@95 | 218 | |
paul@95 | 219 | "A subpage-based item store." |
paul@95 | 220 | |
paul@95 | 221 | def __init__(self, page, lock_dir): |
paul@95 | 222 | |
paul@95 | 223 | "Initialise an item store for subpages under the given 'page'." |
paul@95 | 224 | |
paul@95 | 225 | GeneralItemStore.__init__(self, lock_dir) |
paul@95 | 226 | self.page = page |
paul@95 | 227 | |
paul@95 | 228 | def mtime(self): |
paul@95 | 229 | |
paul@95 | 230 | "Return the last modified time of the item store." |
paul@95 | 231 | |
paul@95 | 232 | keys = self.get_keys() |
paul@95 | 233 | if not keys: |
paul@95 | 234 | page = self.page |
paul@95 | 235 | else: |
paul@95 | 236 | page = Page(self.page.request, self.get_item_path(max(keys))) |
paul@95 | 237 | |
paul@95 | 238 | return wikiutil.version2timestamp( |
paul@95 | 239 | getMetadata(page)["last-modified"] |
paul@95 | 240 | ) |
paul@95 | 241 | |
paul@95 | 242 | def get_next(self): |
paul@95 | 243 | |
paul@95 | 244 | "Return the next item number." |
paul@95 | 245 | |
paul@95 | 246 | return self.deduce_next() |
paul@95 | 247 | |
paul@95 | 248 | def get_keys(self): |
paul@95 | 249 | |
paul@95 | 250 | "Return the item keys." |
paul@95 | 251 | |
paul@95 | 252 | # Collect the strict subpages of the parent page. |
paul@95 | 253 | |
paul@95 | 254 | leafnames = [] |
paul@95 | 255 | parentname = self.page.page_name |
paul@95 | 256 | |
paul@96 | 257 | for page in getPagesForSearch("title:regex:^%s/" % parentname, self.page.request): |
paul@96 | 258 | basename, leafname = page.page_name.rsplit("/", 1) |
paul@95 | 259 | |
paul@95 | 260 | # Only collect numbered pages immediately below the parent. |
paul@95 | 261 | |
paul@96 | 262 | if basename == parentname and leafname.isdigit(): |
paul@96 | 263 | leafnames.append(int(leafname)) |
paul@95 | 264 | |
paul@95 | 265 | return leafnames |
paul@95 | 266 | |
paul@95 | 267 | def write_item(self, item, next): |
paul@95 | 268 | |
paul@95 | 269 | "Write the given 'item' to a file with the given 'next' item number." |
paul@95 | 270 | |
paul@95 | 271 | page = PageEditor(self.page.request, self.get_item_path(next)) |
paul@95 | 272 | page.saveText(item, 0) |
paul@95 | 273 | |
paul@95 | 274 | def read_item(self, number): |
paul@95 | 275 | |
paul@95 | 276 | "Read the item with the given item 'number'." |
paul@95 | 277 | |
paul@95 | 278 | page = Page(self.page.request, self.get_item_path(number)) |
paul@95 | 279 | return page.get_raw_body() |
paul@95 | 280 | |
paul@95 | 281 | def remove_item(self, number): |
paul@95 | 282 | |
paul@95 | 283 | "Remove the item with the given item 'number'." |
paul@95 | 284 | |
paul@95 | 285 | page = PageEditor(self.page.request, self.get_item_path(number)) |
paul@95 | 286 | page.deletePage() |
paul@95 | 287 | |
paul@95 | 288 | def get_item_path(self, number): |
paul@95 | 289 | |
paul@95 | 290 | "Get the path for the given item 'number'." |
paul@95 | 291 | |
paul@95 | 292 | return "%s/%s" % (self.page.page_name, number) |
paul@95 | 293 | |
paul@95 | 294 | # High-level methods. |
paul@95 | 295 | |
paul@95 | 296 | def append(self, item): |
paul@95 | 297 | |
paul@95 | 298 | "Append the given 'item' to the store." |
paul@95 | 299 | |
paul@95 | 300 | self.writelock.acquire() |
paul@95 | 301 | try: |
paul@95 | 302 | next = self.get_next() |
paul@95 | 303 | self.write_item(item, next) |
paul@95 | 304 | finally: |
paul@95 | 305 | self.writelock.release() |
paul@95 | 306 | |
paul@41 | 307 | class ItemIterator: |
paul@41 | 308 | |
paul@41 | 309 | "An iterator over items in a store." |
paul@41 | 310 | |
paul@46 | 311 | def __init__(self, store, direction=1): |
paul@41 | 312 | self.store = store |
paul@46 | 313 | self.direction = direction |
paul@46 | 314 | self.reset() |
paul@46 | 315 | |
paul@46 | 316 | def reset(self): |
paul@46 | 317 | if self.direction == 1: |
paul@46 | 318 | self._next = 0 |
paul@63 | 319 | self.final = self.store.next() |
paul@46 | 320 | else: |
paul@63 | 321 | self._next = self.store.next() - 1 |
paul@46 | 322 | self.final = 0 |
paul@46 | 323 | |
paul@46 | 324 | def more(self): |
paul@46 | 325 | if self.direction == 1: |
paul@46 | 326 | return self._next < self.final |
paul@46 | 327 | else: |
paul@46 | 328 | return self._next >= self.final |
paul@46 | 329 | |
paul@46 | 330 | def get_next(self): |
paul@46 | 331 | next = self._next |
paul@46 | 332 | self._next += self.direction |
paul@46 | 333 | return next |
paul@41 | 334 | |
paul@41 | 335 | def next(self): |
paul@46 | 336 | while self.more(): |
paul@41 | 337 | try: |
paul@46 | 338 | return self.store[self.get_next()] |
paul@41 | 339 | except IndexError: |
paul@41 | 340 | pass |
paul@41 | 341 | |
paul@41 | 342 | raise StopIteration |
paul@41 | 343 | |
paul@46 | 344 | def reverse(self): |
paul@46 | 345 | self.direction = -self.direction |
paul@46 | 346 | self.reset() |
paul@46 | 347 | |
paul@46 | 348 | def reversed(self): |
paul@46 | 349 | self.reverse() |
paul@46 | 350 | return self |
paul@46 | 351 | |
paul@46 | 352 | def __iter__(self): |
paul@46 | 353 | return self |
paul@46 | 354 | |
paul@95 | 355 | def getDirectoryItemStoreForPage(page, item_dir, lock_dir): |
paul@95 | 356 | |
paul@95 | 357 | """ |
paul@95 | 358 | A convenience function returning a directory-based store for the given |
paul@95 | 359 | 'page', using the given 'item_dir' and 'lock_dir'. |
paul@95 | 360 | """ |
paul@95 | 361 | |
paul@95 | 362 | item_dir_path = tuple(item_dir.split("/")) |
paul@95 | 363 | lock_dir_path = tuple(lock_dir.split("/")) |
paul@95 | 364 | return DirectoryItemStore(page.getPagePath(*item_dir_path), page.getPagePath(*lock_dir_path)) |
paul@95 | 365 | |
paul@95 | 366 | def getSubpageItemStoreForPage(page, lock_dir): |
paul@95 | 367 | |
paul@95 | 368 | """ |
paul@95 | 369 | A convenience function returning a subpage-based store for the given |
paul@95 | 370 | 'page', using the given 'lock_dir'. |
paul@95 | 371 | """ |
paul@95 | 372 | |
paul@95 | 373 | lock_dir_path = tuple(lock_dir.split("/")) |
paul@95 | 374 | return SubpageItemStore(page, page.getPagePath(*lock_dir_path)) |
paul@95 | 375 | |
paul@95 | 376 | # Page-oriented item store classes. |
paul@95 | 377 | |
paul@95 | 378 | class ItemStoreBase: |
paul@95 | 379 | |
paul@95 | 380 | "Access item stores via pages, observing page access restrictions." |
paul@95 | 381 | |
paul@95 | 382 | def __init__(self, page, store): |
paul@95 | 383 | self.page = page |
paul@95 | 384 | self.store = store |
paul@95 | 385 | |
paul@95 | 386 | def can_write(self): |
paul@95 | 387 | |
paul@95 | 388 | """ |
paul@95 | 389 | Return whether the user associated with the request can write to the |
paul@95 | 390 | page owning this store. |
paul@95 | 391 | """ |
paul@95 | 392 | |
paul@95 | 393 | user = self.page.request.user |
paul@95 | 394 | return user and user.may.write(self.page.page_name) |
paul@95 | 395 | |
paul@95 | 396 | def can_read(self): |
paul@95 | 397 | |
paul@95 | 398 | """ |
paul@95 | 399 | Return whether the user associated with the request can read from the |
paul@95 | 400 | page owning this store. |
paul@95 | 401 | """ |
paul@95 | 402 | |
paul@95 | 403 | user = self.page.request.user |
paul@95 | 404 | return user and user.may.read(self.page.page_name) |
paul@95 | 405 | |
paul@95 | 406 | def can_delete(self): |
paul@95 | 407 | |
paul@95 | 408 | """ |
paul@95 | 409 | Return whether the user associated with the request can delete the |
paul@95 | 410 | page owning this store. |
paul@95 | 411 | """ |
paul@95 | 412 | |
paul@95 | 413 | user = self.page.request.user |
paul@95 | 414 | return user and user.may.delete(self.page.page_name) |
paul@95 | 415 | |
paul@95 | 416 | # Store-specific methods. |
paul@95 | 417 | |
paul@95 | 418 | def mtime(self): |
paul@95 | 419 | return self.store.mtime() |
paul@95 | 420 | |
paul@95 | 421 | # High-level methods. |
paul@95 | 422 | |
paul@95 | 423 | def keys(self): |
paul@95 | 424 | |
paul@95 | 425 | "Return a list of keys for items in the store." |
paul@95 | 426 | |
paul@95 | 427 | if not self.can_read(): |
paul@95 | 428 | return 0 |
paul@95 | 429 | |
paul@95 | 430 | return self.store.keys() |
paul@95 | 431 | |
paul@95 | 432 | def append(self, item): |
paul@95 | 433 | |
paul@95 | 434 | "Append the given 'item' to the store." |
paul@95 | 435 | |
paul@95 | 436 | if not self.can_write(): |
paul@95 | 437 | return |
paul@95 | 438 | |
paul@95 | 439 | self.store.append(item) |
paul@95 | 440 | |
paul@95 | 441 | def __len__(self): |
paul@95 | 442 | |
paul@95 | 443 | "Return the number of items in the store." |
paul@95 | 444 | |
paul@95 | 445 | if not self.can_read(): |
paul@95 | 446 | return 0 |
paul@95 | 447 | |
paul@95 | 448 | return len(self.store) |
paul@95 | 449 | |
paul@95 | 450 | def __getitem__(self, number): |
paul@95 | 451 | |
paul@95 | 452 | "Return the item with the given 'number'." |
paul@95 | 453 | |
paul@95 | 454 | if not self.can_read(): |
paul@95 | 455 | raise IndexError, number |
paul@95 | 456 | |
paul@95 | 457 | return self.store.__getitem__(number) |
paul@95 | 458 | |
paul@95 | 459 | def __delitem__(self, number): |
paul@95 | 460 | |
paul@95 | 461 | "Remove the item with the given 'number'." |
paul@95 | 462 | |
paul@95 | 463 | if not self.can_delete(): |
paul@95 | 464 | return |
paul@95 | 465 | |
paul@95 | 466 | return self.store.__delitem__(number) |
paul@95 | 467 | |
paul@95 | 468 | def __iter__(self): |
paul@95 | 469 | return self.store.__iter__() |
paul@95 | 470 | |
paul@95 | 471 | def next(self): |
paul@95 | 472 | return self.store.next() |
paul@95 | 473 | |
paul@95 | 474 | # Convenience store classes. |
paul@95 | 475 | |
paul@95 | 476 | class ItemStore(ItemStoreBase): |
paul@95 | 477 | |
paul@95 | 478 | "Store items in a directory via a page." |
paul@95 | 479 | |
paul@95 | 480 | def __init__(self, page, item_dir="items", lock_dir="item_locks"): |
paul@95 | 481 | ItemStoreBase.__init__(self, page, getDirectoryItemStoreForPage(page, item_dir, lock_dir)) |
paul@95 | 482 | |
paul@95 | 483 | class ItemSubpageStore(ItemStoreBase): |
paul@95 | 484 | |
paul@95 | 485 | "Store items in subpages of a page." |
paul@95 | 486 | |
paul@95 | 487 | def __init__(self, page, lock_dir="item_locks"): |
paul@95 | 488 | ItemStoreBase.__init__(self, page, getSubpageItemStoreForPage(page, lock_dir)) |
paul@95 | 489 | |
paul@41 | 490 | # vim: tabstop=4 expandtab shiftwidth=4 |