lib/mudpy/data.py

   1 # -*- coding: utf-8 -*-
   2 """Data interface functions for the mudpy engine."""
   3
   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.
   7
   8
   9 class DataFile:
  10
  11     """A file containing universe elements."""
  12
  13     def __init__(self, filename, universe):
  14         self.filename = filename
  15         self.universe = universe
  16         self.load()
  17
  18     def load(self):
  19         """Read a file and create elements accordingly."""
  20         import ConfigParser
  21         import mudpy.misc
  22         import os
  23         import os.path
  24         self.data = ConfigParser.RawConfigParser()
  25         self.modified = False
  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
  31         includes = []
  32         if self.data.has_option("__control__", "include_files"):
  33             for included in makelist(
  34                 self.data.get("__control__", "include_files")
  35             ):
  36                 included = find_file(
  37                     included,
  38                     relative=self.filename,
  39                     universe=self.universe
  40                 )
  41                 if included not in includes:
  42                     includes.append(included)
  43         if self.data.has_option("__control__", "include_dirs"):
  44             for included in [
  45                 os.path.join(x, "__init__.mpy") for x in makelist(
  46                     self.data.get("__control__", "include_dirs")
  47                 )
  48             ]:
  49                 included = find_file(
  50                     included,
  51                     relative=self.filename,
  52                     universe=self.universe
  53                 )
  54                 if included not in includes:
  55                     includes.append(included)
  56         if self.data.has_option("__control__", "default_files"):
  57             origins = makedict(
  58                 self.data.get("__control__", "default_files")
  59             )
  60             for key in origins.keys():
  61                 origins[key] = find_file(
  62                     origins[key],
  63                     relative=self.filename,
  64                     universe=self.universe
  65                 )
  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"):
  72             for item in makelist(
  73                 self.data.get("__control__", "private_files")
  74             ):
  75                 item = find_file(
  76                     item,
  77                     relative=self.filename,
  78                     universe=self.universe
  79                 )
  80                 if item not in includes:
  81                     includes.append(item)
  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(
  90                     include_file,
  91                     relative=self.filename,
  92                     universe=self.universe
  93                 )
  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)
  97
  98     def save(self):
  99         """Write the data, if necessary."""
 100         import codecs
 101         import os
 102         import os.path
 103         import re
 104         import stat
 105
 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)
 109            ):
 110
 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))
 114
 115             # backup the file
 116             if self.data.has_option("__control__", "backup_count"):
 117                 max_count = self.data.has_option(
 118                     "__control__", "backup_count")
 119             else:
 120                 max_count = self.universe.categories[
 121                     "internal"
 122                 ][
 123                     "limits"
 124                 ].getint("default_backup_count")
 125             if os.path.exists(self.filename) and max_count:
 126                 backups = []
 127                 for candidate in os.listdir(os.path.dirname(self.filename)):
 128                     if re.match(
 129                        os.path.basename(self.filename) +
 130                        """\.\d+$""", candidate
 131                        ):
 132                         backups.append(int(candidate.split(".")[-1]))
 133                 backups.sort()
 134                 backups.reverse()
 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
 140                     ):
 141                         os.rename(
 142                             self.filename + "." + old_backup,
 143                             self.filename + "." + old_backup + 1
 144                         )
 145                 if not os.path.exists(self.filename + ".0"):
 146                     os.rename(self.filename, self.filename + ".0")
 147
 148             # our data file
 149             file_descriptor = codecs.open(self.filename, "w", "utf-8")
 150
 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])
 154                ) != 0o0600:
 155                 os.chmod(self.filename, 0o0600)
 156
 157             # write it back sorted, instead of using ConfigParser
 158             sections = self.data.sections()
 159             sections.sort()
 160             for section in sections:
 161                 file_descriptor.write("[" + section + "]\n")
 162                 options = self.data.options(section)
 163                 options.sort()
 164                 for option in options:
 165                     file_descriptor.write(
 166                         option + " = " +
 167                         self.data.get(section, option) + "\n"
 168                     )
 169                 file_descriptor.write("\n")
 170
 171             # flush and close the file
 172             file_descriptor.flush()
 173             file_descriptor.close()
 174
 175             # unset the modified flag
 176             self.modified = False
 177
 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"
 184         )
 185
 186
 187 def find_file(
 188     file_name=None,
 189     root_path=None,
 190     search_path=None,
 191     default_dir=None,
 192     relative=None,
 193     universe=None
 194 ):
 195     """Return an absolute file path based on configuration."""
 196     import os
 197     import os.path
 198     import sys
 199
 200     # make sure to get rid of any surrounding quotes first thing
 201     if file_name:
 202         file_name = file_name.strip("\"'")
 203
 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)
 207
 208     # when no file name is specified, look for <argv[0]>.conf
 209     elif not file_name:
 210         file_name = os.path.basename(sys.argv[0]) + ".conf"
 211
 212     # if a universe was provided, try to get some defaults from there
 213     if universe:
 214
 215         if hasattr(
 216            universe,
 217            "contents"
 218            ) and "internal:storage" in universe.contents:
 219             storage = universe.categories["internal"]["storage"]
 220             if not root_path:
 221                 root_path = storage.get("root_path").strip("\"'")
 222             if not search_path:
 223                 search_path = storage.getlist("search_path")
 224             if not default_dir:
 225                 default_dir = storage.get("default_dir").strip("\"'")
 226
 227         # if there's only one file loaded, try to work around a chicken<egg
 228         elif hasattr(universe, "files") and len(
 229             universe.files
 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
 233
 234             # try for a fallback default directory
 235             if not default_dir and data_file.has_option(
 236                "internal:storage",
 237                "default_dir"
 238                ):
 239                 default_dir = data_file.get(
 240                     "internal:storage",
 241                     "default_dir"
 242                 ).strip("\"'")
 243
 244             # try for a fallback root path
 245             if not root_path and data_file.has_option(
 246                "internal:storage",
 247                "root_path"
 248                ):
 249                 root_path = data_file.get(
 250                     "internal:storage",
 251                     "root_path"
 252                 ).strip("\"'")
 253
 254             # try for a fallback search path
 255             if not search_path and data_file.has_option(
 256                "internal:storage",
 257                "search_path"
 258                ):
 259                 search_path = makelist(
 260                     data_file.get("internal:storage",
 261                                   "search_path").strip("\"'")
 262                 )
 263
 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
 267
 268     # when no root path is specified, assume the current working directory
 269     if not root_path:
 270         root_path = os.getcwd()
 271
 272     # otherwise, make sure it's absolute
 273     elif not os.path.isabs(root_path):
 274         root_path = os.path.realpath(root_path)
 275
 276     # if there's no search path, just use the root path and etc
 277     if not search_path:
 278         search_path = [root_path, "etc"]
 279
 280     # work on a copy of the search path, to avoid modifying the caller's
 281     else:
 282         search_path = search_path[:]
 283
 284     # if there's no default path, use the last element of the search path
 285     if not default_dir:
 286         default_dir = search_path[-1]
 287
 288     # if an existing file or directory reference was supplied, prepend it
 289     if relative:
 290         relative = relative.strip("\"'")
 291         if os.path.isdir(relative):
 292             search_path = [relative] + search_path
 293         else:
 294             search_path = [os.path.dirname(relative)] + search_path
 295
 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)
 304
 305     # start hunting for the file now
 306     for each_path in clean_search_path:
 307
 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))
 311             break
 312
 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)
 318
 319     # and normalize it last thing before returning
 320     file_name = os.path.realpath(file_name)
 321
 322     # normalize the resulting file path and hand it back
 323     return file_name
 324
 325
 326 def makelist(value):
 327     """Turn string into list type."""
 328     if value[0] + value[-1] == "[]":
 329         return eval(value)
 330     elif value[0] + value[-1] == "\"\"":
 331         return [value[1:-1]]
 332     else:
 333         return [value]
 334
 335
 336 def makedict(value):
 337     """Turn string into dict type."""
 338     if value[0] + value[-1] == "{}":
 339         return eval(value)
 340     elif value.find(":") > 0:
 341         return eval("{" + value + "}")
 342     else:
 343         return {value: None}