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 join, 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. 49 50 self.nested = self.level_sep == sep 51 52 # Support attachments directories. 53 54 self.attachments_dir = metadata.get("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(join(self.attachments_dir, "*"), True) 69 70 def get_attachments(self, pagename): 71 72 """ 73 Return all attachment filenames for the given 'pagename'. Each filename 74 is relative to the appropriate attachment directory. 75 """ 76 77 attachments_dir = Directory(join(self.dir.filename, 78 self.attachments_dir, 79 pagename)) 80 81 return attachments_dir.select_files("*") 82 83 # Page characteristics. 84 85 def subpage_filenames(self, pagename): 86 87 "Return the subpage filenames of 'pagename'." 88 89 pattern = self.to_filename("%s%s*" % (pagename, self.level_sep)) 90 return self.dir.select_files(pattern, self.nested) 91 92 def subpages(self, pagename): 93 94 "Return the subpages of 'pagename'." 95 96 return map(self.to_pagename, self.subpage_filenames(pagename)) 97 98 # Page access methods. 99 100 def readfile(self, filename, encoding=None): 101 102 """ 103 Return the contents of the file having the given 'filename' and optional 104 'encoding'. 105 """ 106 107 return self.readpath(self.dir.get_filename(filename), encoding) 108 109 # Convenience methods. 110 111 def get_attachment_filename(self, pagename, filename): 112 113 """ 114 Return the full path of an attachment file for the given 'pagename' 115 having the given 'filename'. 116 """ 117 118 if not pagename: 119 return None 120 121 return self.dir.get_filename(join(self.attachments_dir, 122 pagename, filename)) 123 124 # NOTE: Translation methods should encode filenames appropriately. 125 126 def to_filename(self, pagename): 127 128 "Return the filename corresponding to 'pagename'." 129 130 if sep == self.level_sep: 131 return pagename 132 else: 133 return self.level_sep.join(pagename.split("/")) 134 135 def to_pagename(self, filename): 136 137 "Return the pagename corresponding to 'filename'." 138 139 if sep == self.level_sep: 140 return filename 141 else: 142 return "/".join(filename.split(self.level_sep)) 143 144 input = DirectoryInput 145 146 # vim: tabstop=4 expandtab shiftwidth=4