1 # -*- coding: utf-8 -*-
2 """Data interface functions for the mudpy engine."""
4 # Copyright (c) 2004-2012 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.
11 """A file containing universe elements."""
13 def __init__(self, filename, universe):
14 self.filename = filename
15 self.universe = universe
19 """Read a file and create elements accordingly."""
24 self.data = ConfigParser.RawConfigParser()
26 if os.access(self.filename, os.R_OK):
27 self.data.read(self.filename)
28 if not hasattr(self.universe, "files"):
29 self.universe.files = {}
30 self.universe.files[self.filename] = self
32 if self.data.has_option("__control__", "include_files"):
33 for included in makelist(
34 self.data.get("__control__", "include_files")
38 relative=self.filename,
39 universe=self.universe
41 if included not in includes:
42 includes.append(included)
43 if self.data.has_option("__control__", "include_dirs"):
45 os.path.join(x, "__init__.mpy") for x in makelist(
46 self.data.get("__control__", "include_dirs")
51 relative=self.filename,
52 universe=self.universe
54 if included not in includes:
55 includes.append(included)
56 if self.data.has_option("__control__", "default_files"):
58 self.data.get("__control__", "default_files")
60 for key in origins.keys():
61 origins[key] = find_file(
63 relative=self.filename,
64 universe=self.universe
66 if origins[key] not in includes:
67 includes.append(origins[key])
68 self.universe.default_origins[key] = origins[key]
69 if key not in self.universe.categories:
70 self.universe.categories[key] = {}
71 if self.data.has_option("__control__", "private_files"):
73 self.data.get("__control__", "private_files")
77 relative=self.filename,
78 universe=self.universe
80 if item not in includes:
82 if item not in self.universe.private_files:
83 self.universe.private_files.append(item)
84 for section in self.data.sections():
85 if section != "__control__":
86 mudpy.misc.Element(section, self.universe, self.filename)
87 for include_file in includes:
88 if not os.path.isabs(include_file):
89 include_file = find_file(
91 relative=self.filename,
92 universe=self.universe
94 if (include_file not in self.universe.files or not
95 self.universe.files[include_file].is_writeable()):
96 DataFile(include_file, self.universe)
99 """Write the data, if necessary."""
106 # when modified, writeable and has content or the file exists
107 if self.modified and self.is_writeable() and (
108 self.data.sections() or os.path.exists(self.filename)
111 # make parent directories if necessary
112 if not os.path.exists(os.path.dirname(self.filename)):
113 os.makedirs(os.path.dirname(self.filename))
116 if self.data.has_option("__control__", "backup_count"):
117 max_count = self.data.has_option(
118 "__control__", "backup_count")
120 max_count = self.universe.categories[
124 ].getint("default_backup_count")
125 if os.path.exists(self.filename) and max_count:
127 for candidate in os.listdir(os.path.dirname(self.filename)):
129 os.path.basename(self.filename) +
130 """\.\d+$""", candidate
132 backups.append(int(candidate.split(".")[-1]))
135 for old_backup in backups:
136 if old_backup >= max_count - 1:
137 os.remove(self.filename + "." + old_backup)
138 elif not os.path.exists(
139 self.filename + "." + old_backup + 1
142 self.filename + "." + old_backup,
143 self.filename + "." + old_backup + 1
145 if not os.path.exists(self.filename + ".0"):
146 os.rename(self.filename, self.filename + ".0")
149 file_descriptor = codecs.open(self.filename, "w", "utf-8")
151 # if it's marked private, chmod it appropriately
152 if self.filename in self.universe.private_files and oct(
153 stat.S_IMODE(os.stat(self.filename)[stat.ST_MODE])
155 os.chmod(self.filename, 0600)
157 # write it back sorted, instead of using ConfigParser
158 sections = self.data.sections()
160 for section in sections:
161 file_descriptor.write("[" + section + "]\n")
162 options = self.data.options(section)
164 for option in options:
165 file_descriptor.write(
167 self.data.get(section, option) + "\n"
169 file_descriptor.write("\n")
171 # flush and close the file
172 file_descriptor.flush()
173 file_descriptor.close()
175 # unset the modified flag
176 self.modified = False
178 def is_writeable(self):
179 """Returns True if the __control__ read_only is False."""
180 return not self.data.has_option(
181 "__control__", "read_only"
182 ) or not self.data.getboolean(
183 "__control__", "read_only"
195 """Return an absolute file path based on configuration."""
200 # make sure to get rid of any surrounding quotes first thing
202 file_name = file_name.strip("\"'")
204 # this is all unnecessary if it's already absolute
205 if file_name and os.path.isabs(file_name):
206 return os.path.realpath(file_name)
208 # when no file name is specified, look for <argv[0]>.conf
210 file_name = os.path.basename(sys.argv[0]) + ".conf"
212 # if a universe was provided, try to get some defaults from there
218 ) and "internal:storage" in universe.contents:
219 storage = universe.categories["internal"]["storage"]
221 root_path = storage.get("root_path").strip("\"'")
223 search_path = storage.getlist("search_path")
225 default_dir = storage.get("default_dir").strip("\"'")
227 # if there's only one file loaded, try to work around a chicken<egg
228 elif hasattr(universe, "files") and len(
230 ) == 1 and not universe.files[
231 list(universe.files.keys())[0]].is_writeable():
232 data_file = universe.files[list(universe.files.keys())[0]].data
234 # try for a fallback default directory
235 if not default_dir and data_file.has_option(
239 default_dir = data_file.get(
244 # try for a fallback root path
245 if not root_path and data_file.has_option(
249 root_path = data_file.get(
254 # try for a fallback search path
255 if not search_path and data_file.has_option(
259 search_path = makelist(
260 data_file.get("internal:storage",
261 "search_path").strip("\"'")
264 # another fallback root path, this time from the universe startdir
265 if not root_path and hasattr(universe, "startdir"):
266 root_path = universe.startdir
268 # when no root path is specified, assume the current working directory
270 root_path = os.getcwd()
272 # otherwise, make sure it's absolute
273 elif not os.path.isabs(root_path):
274 root_path = os.path.realpath(root_path)
276 # if there's no search path, just use the root path and etc
278 search_path = [root_path, "etc"]
280 # work on a copy of the search path, to avoid modifying the caller's
282 search_path = search_path[:]
284 # if there's no default path, use the last element of the search path
286 default_dir = search_path[-1]
288 # if an existing file or directory reference was supplied, prepend it
290 relative = relative.strip("\"'")
291 if os.path.isdir(relative):
292 search_path = [relative] + search_path
294 search_path = [os.path.dirname(relative)] + search_path
296 # make the search path entries absolute and throw away any dupes
297 clean_search_path = []
298 for each_path in search_path:
299 each_path = each_path.strip("\"'")
300 if not os.path.isabs(each_path):
301 each_path = os.path.realpath(os.path.join(root_path, each_path))
302 if each_path not in clean_search_path:
303 clean_search_path.append(each_path)
305 # start hunting for the file now
306 for each_path in clean_search_path:
308 # if the file exists and is readable, we're done
309 if os.path.isfile(os.path.join(each_path, file_name)):
310 file_name = os.path.realpath(os.path.join(each_path, file_name))
313 # it didn't exist after all, so use the default path instead
314 if not os.path.isabs(file_name):
315 file_name = os.path.join(default_dir, file_name)
316 if not os.path.isabs(file_name):
317 file_name = os.path.join(root_path, file_name)
319 # and normalize it last thing before returning
320 file_name = os.path.realpath(file_name)
322 # normalize the resulting file path and hand it back
327 """Turn string into list type."""
328 if value[0] + value[-1] == "[]":
330 elif value[0] + value[-1] == "\"\"":
337 """Turn string into dict type."""
338 if value[0] + value[-1] == "{}":
340 elif value.find(":") > 0:
341 return eval("{" + value + "}")