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 # Search recursively in nested directories for pages and files. 49 50 self.nested = self.level_sep == sep 51 52 # Support attachments directories. 53 54 self.attachments_dir = metadata.get("attachments", "attachments") 55 56 def all(self): 57 58 "Return all pages in the context." 59 60 # Ignore dotfiles. 61 62 return map(self.to_pagename, self.dir.select_files("[!.]*", self.nested)) 63 64 def all_attachments(self): 65 66 "Return all attachment filenames in the context." 67 68 return self.dir.select_files("%s/*" % self.attachments_dir, self.nested) 69 70 # Page characteristics. 71 72 def subpage_filenames(self, pagename): 73 74 "Return the subpage filenames of 'pagename'." 75 76 pattern = self.to_filename("%s/*" % pagename) 77 return self.dir.select_files(pattern, self.nested) 78 79 def subpages(self, pagename): 80 81 "Return the subpages of 'pagename'." 82 83 return map(self.to_pagename, self.subpage_filenames(pagename)) 84 85 # Page access methods. 86 87 def readfile(self, filename, encoding=None): 88 89 """ 90 Return the contents of the file having the given 'filename' and optional 91 'encoding'. 92 """ 93 94 return self.readpath(self.dir.get_filename(filename), encoding) 95 96 # NOTE: Translation methods should encode filenames appropriately. 97 98 def to_filename(self, pagename): 99 100 "Return the filename corresponding to 'pagename'." 101 102 if sep == self.level_sep: 103 return pagename 104 else: 105 return self.level_sep.join(pagename.split("/")) 106 107 def to_pagename(self, filename): 108 109 "Return the pagename corresponding to 'filename'." 110 111 if sep == self.level_sep: 112 return filename 113 else: 114 return "/".join(filename.split(self.level_sep)) 115 116 input = DirectoryInput 117 118 # vim: tabstop=4 expandtab shiftwidth=4