1 #!/usr/bin/env python 2 3 """ 4 Directory input context. 5 6 Copyright (C) 2018, 2019 Paul Boddie <paul@boddie.org.uk> 7 8 This program is free software; you can redistribute it and/or modify it under 9 the terms of the GNU General Public License as published by the Free Software 10 Foundation; either version 3 of the License, or (at your option) any later 11 version. 12 13 This program is distributed in the hope that it will be useful, but WITHOUT 14 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS 15 FOR A PARTICULAR PURPOSE. See the GNU General Public License for more 16 details. 17 18 You should have received a copy of the GNU General Public License along with 19 this program. If not, see <http://www.gnu.org/licenses/>. 20 """ 21 22 from moinformat.input.common import Input 23 from moinformat.utils.directory import Directory 24 from os.path import sep 25 26 class DirectoryInput(Input): 27 28 "A directory input context." 29 30 name = "directory" 31 32 def __init__(self, metadata): 33 34 "Initialise the context with the given 'metadata'." 35 36 if not metadata.has_key("input_filename"): 37 raise ValueError, metadata 38 39 Input.__init__(self, metadata) 40 self.dir = Directory(metadata.get("input_filename")) 41 42 # Support an encoding of the level separator for the filesystem. 43 # Where it is the same as the directory separator, documents are stored 44 # using nested directories, not as a flat list. 45 46 self.level_sep = metadata.get("input_separator", sep) 47 48 def all(self): 49 50 "Return all pages in the context." 51 52 nested = self.level_sep == sep 53 54 # Ignore dotfiles. 55 56 return map(self.to_pagename, self.dir.select_files("[!.]*", nested)) 57 58 # Page characteristics. 59 60 def subpage_filenames(self, pagename): 61 62 "Return the subpage filenames of 'pagename'." 63 64 nested = self.level_sep == sep 65 pattern = self.to_filename("%s/*" % pagename) 66 return self.dir.select_files(pattern, nested) 67 68 def subpages(self, pagename): 69 70 "Return the subpages of 'pagename'." 71 72 return map(self.to_pagename, self.subpage_filenames(pagename)) 73 74 # Page access methods. 75 76 def readfile(self, filename, encoding=None): 77 78 """ 79 Return the contents of the file having the given 'filename' and optional 80 'encoding'. 81 """ 82 83 return self.readpath(self.dir.get_filename(filename), encoding) 84 85 # NOTE: Translation methods should encode filenames appropriately. 86 87 def to_filename(self, pagename): 88 89 "Return the filename corresponding to 'pagename'." 90 91 if sep == self.level_sep: 92 return pagename 93 else: 94 return self.level_sep.join(pagename.split("/")) 95 96 def to_pagename(self, filename): 97 98 "Return the pagename corresponding to 'filename'." 99 100 if sep == self.level_sep: 101 return filename 102 else: 103 return "/".join(filename.split(self.level_sep)) 104 105 input = DirectoryInput 106 107 # vim: tabstop=4 expandtab shiftwidth=4