1 # -*- coding: utf-8 -*-
2 """Data interface functions for the mudpy engine."""
4 # Copyright (c) 2004-2013 Jeremy Stanley <fungi@yuggoth.org>. Permission
5 # to use, copy, modify, and distribute this software is granted under
6 # terms provided in the LICENSE file distributed with this software.
14 # TODO: remove this check after the switch to py3k
18 import ConfigParser as configparser
25 """A file containing universe elements."""
27 def __init__(self, filename, universe):
28 self.filename = filename
29 self.universe = universe
33 """Read a file and create elements accordingly."""
34 self.data = configparser.RawConfigParser()
36 if os.access(self.filename, os.R_OK):
37 self.data.read(self.filename)
38 if not hasattr(self.universe, "files"):
39 self.universe.files = {}
40 self.universe.files[self.filename] = self
42 if self.data.has_option("__control__", "include_files"):
43 for included in makelist(
44 self.data.get("__control__", "include_files")
48 relative=self.filename,
49 universe=self.universe
51 if included not in includes:
52 includes.append(included)
53 if self.data.has_option("__control__", "include_dirs"):
55 os.path.join(x, "__init__.mpy") for x in makelist(
56 self.data.get("__control__", "include_dirs")
61 relative=self.filename,
62 universe=self.universe
64 if included not in includes:
65 includes.append(included)
66 if self.data.has_option("__control__", "default_files"):
68 self.data.get("__control__", "default_files")
70 for key in origins.keys():
71 origins[key] = find_file(
73 relative=self.filename,
74 universe=self.universe
76 if origins[key] not in includes:
77 includes.append(origins[key])
78 self.universe.default_origins[key] = origins[key]
79 if key not in self.universe.categories:
80 self.universe.categories[key] = {}
81 if self.data.has_option("__control__", "private_files"):
83 self.data.get("__control__", "private_files")
87 relative=self.filename,
88 universe=self.universe
90 if item not in includes:
92 if item not in self.universe.private_files:
93 self.universe.private_files.append(item)
94 for section in self.data.sections():
95 if section != "__control__":
96 mudpy.misc.Element(section, self.universe, self.filename)
97 for include_file in includes:
98 if not os.path.isabs(include_file):
99 include_file = find_file(
101 relative=self.filename,
102 universe=self.universe
104 if (include_file not in self.universe.files or not
105 self.universe.files[include_file].is_writeable()):
106 DataFile(include_file, self.universe)
109 """Write the data, if necessary."""
111 # when modified, writeable and has content or the file exists
112 if self.modified and self.is_writeable() and (
113 self.data.sections() or os.path.exists(self.filename)
116 # make parent directories if necessary
117 if not os.path.exists(os.path.dirname(self.filename)):
118 os.makedirs(os.path.dirname(self.filename))
121 if self.data.has_option("__control__", "backup_count"):
122 max_count = self.data.has_option(
123 "__control__", "backup_count")
125 max_count = self.universe.categories[
129 ].getint("default_backup_count")
130 if os.path.exists(self.filename) and max_count:
132 for candidate in os.listdir(os.path.dirname(self.filename)):
134 os.path.basename(self.filename) +
135 """\.\d+$""", candidate
137 backups.append(int(candidate.split(".")[-1]))
140 for old_backup in backups:
141 if old_backup >= max_count - 1:
142 os.remove(self.filename + "." + old_backup)
143 elif not os.path.exists(
144 self.filename + "." + old_backup + 1
147 self.filename + "." + old_backup,
148 self.filename + "." + old_backup + 1
150 if not os.path.exists(self.filename + ".0"):
151 os.rename(self.filename, self.filename + ".0")
154 file_descriptor = codecs.open(self.filename, "w", "utf-8")
156 # if it's marked private, chmod it appropriately
157 if self.filename in self.universe.private_files and oct(
158 stat.S_IMODE(os.stat(self.filename)[stat.ST_MODE])
160 os.chmod(self.filename, 0o0600)
162 # write it back sorted, instead of using configparser
163 sections = self.data.sections()
165 for section in sections:
166 file_descriptor.write("[" + section + "]\n")
167 options = self.data.options(section)
169 for option in options:
170 file_descriptor.write(
172 self.data.get(section, option) + "\n"
174 file_descriptor.write("\n")
176 # flush and close the file
177 file_descriptor.flush()
178 file_descriptor.close()
180 # unset the modified flag
181 self.modified = False
183 def is_writeable(self):
184 """Returns True if the __control__ read_only is False."""
185 return not self.data.has_option(
186 "__control__", "read_only"
187 ) or not self.data.getboolean(
188 "__control__", "read_only"
200 """Return an absolute file path based on configuration."""
202 # make sure to get rid of any surrounding quotes first thing
204 file_name = file_name.strip("\"'")
206 # this is all unnecessary if it's already absolute
207 if file_name and os.path.isabs(file_name):
208 return os.path.realpath(file_name)
210 # when no file name is specified, look for <argv[0]>.conf
212 file_name = os.path.basename(sys.argv[0]) + ".conf"
214 # if a universe was provided, try to get some defaults from there
220 ) and "internal:storage" in universe.contents:
221 storage = universe.categories["internal"]["storage"]
223 root_path = storage.get("root_path").strip("\"'")
225 search_path = storage.getlist("search_path")
227 default_dir = storage.get("default_dir").strip("\"'")
229 # if there's only one file loaded, try to work around a chicken<egg
230 elif hasattr(universe, "files") and len(
232 ) == 1 and not universe.files[
233 list(universe.files.keys())[0]].is_writeable():
234 data_file = universe.files[list(universe.files.keys())[0]].data
236 # try for a fallback default directory
237 if not default_dir and data_file.has_option(
241 default_dir = data_file.get(
246 # try for a fallback root path
247 if not root_path and data_file.has_option(
251 root_path = data_file.get(
256 # try for a fallback search path
257 if not search_path and data_file.has_option(
261 search_path = makelist(
262 data_file.get("internal:storage",
263 "search_path").strip("\"'")
266 # another fallback root path, this time from the universe startdir
267 if not root_path and hasattr(universe, "startdir"):
268 root_path = universe.startdir
270 # when no root path is specified, assume the current working directory
272 root_path = os.getcwd()
274 # otherwise, make sure it's absolute
275 elif not os.path.isabs(root_path):
276 root_path = os.path.realpath(root_path)
278 # if there's no search path, just use the root path and etc
280 search_path = [root_path, "etc"]
282 # work on a copy of the search path, to avoid modifying the caller's
284 search_path = search_path[:]
286 # if there's no default path, use the last element of the search path
288 default_dir = search_path[-1]
290 # if an existing file or directory reference was supplied, prepend it
292 relative = relative.strip("\"'")
293 if os.path.isdir(relative):
294 search_path = [relative] + search_path
296 search_path = [os.path.dirname(relative)] + search_path
298 # make the search path entries absolute and throw away any dupes
299 clean_search_path = []
300 for each_path in search_path:
301 each_path = each_path.strip("\"'")
302 if not os.path.isabs(each_path):
303 each_path = os.path.realpath(os.path.join(root_path, each_path))
304 if each_path not in clean_search_path:
305 clean_search_path.append(each_path)
307 # start hunting for the file now
308 for each_path in clean_search_path:
310 # if the file exists and is readable, we're done
311 if os.path.isfile(os.path.join(each_path, file_name)):
312 file_name = os.path.realpath(os.path.join(each_path, file_name))
315 # it didn't exist after all, so use the default path instead
316 if not os.path.isabs(file_name):
317 file_name = os.path.join(default_dir, file_name)
318 if not os.path.isabs(file_name):
319 file_name = os.path.join(root_path, file_name)
321 # and normalize it last thing before returning
322 file_name = os.path.realpath(file_name)
324 # normalize the resulting file path and hand it back
329 """Turn string into list type."""
330 if value[0] + value[-1] == "[]":
332 elif value[0] + value[-1] == "\"\"":
339 """Turn string into dict type."""
340 if value[0] + value[-1] == "{}":
342 elif value.find(":") > 0:
343 return eval("{" + value + "}")