app/tasks/minetestcheck/tree.py

   1 import os
   2 from . import MinetestCheckError, ContentType
   3 from .config import parse_conf
   4
   5 def get_base_dir(path):
   6         if not os.path.isdir(path):
   7                 raise IOError("Expected dir")
   8
   9         root, subdirs, files = next(os.walk(path))
  10         if len(subdirs) == 1 and len(files) == 0:
  11                 return get_base_dir(path + "/" + subdirs[0])
  12         else:
  13                 return path
  14
  15
  16 def detect_type(path):
  17         if os.path.isfile(path + "/game.conf"):
  18                 return ContentType.GAME
  19         elif os.path.isfile(path + "/init.lua"):
  20                 return ContentType.MOD
  21         elif os.path.isfile(path + "/modpack.txt") or \
  22                         os.path.isfile(path + "/modpack.conf"):
  23                 return ContentType.MODPACK
  24         elif os.path.isdir(path + "/mods"):
  25                 return ContentType.GAME
  26         elif os.path.isfile(path + "/texture_pack.conf"):
  27                 return ContentType.TXP
  28         else:
  29                 return ContentType.UNKNOWN
  30
  31
  32 class PackageTreeNode:
  33         def __init__(self, baseDir, relative, author=None, repo=None, name=None):
  34                 self.baseDir  = baseDir
  35                 self.relative = relative
  36                 self.author   = author
  37                 self.name        = name
  38                 self.repo        = repo
  39                 self.meta        = None
  40                 self.children = []
  41
  42                 # Detect type
  43                 self.type = detect_type(baseDir)
  44                 self.read_meta()
  45
  46                 if self.type == ContentType.GAME:
  47                         if not os.path.isdir(baseDir + "/mods"):
  48                                 raise MinetestCheckError(("game at {} does not have a mods/ folder").format(self.relative))
  49                         self.add_children_from_mod_dir(baseDir + "/mods")
  50                 elif self.type == ContentType.MODPACK:
  51                         self.add_children_from_mod_dir(baseDir)
  52
  53         def getMetaFilePath(self):
  54                 filename = None
  55                 if self.type == ContentType.GAME:
  56                         filename = "game.conf"
  57                 elif self.type == ContentType.MOD:
  58                         filename = "mod.conf"
  59                 elif self.type == ContentType.MODPACK:
  60                         filename = "modpack.conf"
  61                 elif self.type == ContentType.TXP:
  62                         filename = "texture_pack.conf"
  63                 else:
  64                         return None
  65
  66                 return self.baseDir + "/" + filename
  67
  68
  69         def read_meta(self):
  70                 result = {}
  71
  72                 # .conf file
  73                 try:
  74                         with open(self.getMetaFilePath() or "", "r") as myfile:
  75                                 conf = parse_conf(myfile.read())
  76                                 for key, value in conf.items():
  77                                         result[key] = value
  78                 except IOError:
  79                         pass
  80
  81                 # description.txt
  82                 if not "description" in result:
  83                         try:
  84                                 with open(self.baseDir + "/description.txt", "r") as myfile:
  85                                         result["description"] = myfile.read()
  86                         except IOError:
  87                                 pass
  88
  89                 # depends.txt
  90                 import re
  91                 pattern = re.compile("^([a-z0-9_]+)\??$")
  92                 if not "depends" in result and not "optional_depends" in result:
  93                         try:
  94                                 with open(self.baseDir + "/depends.txt", "r") as myfile:
  95                                         contents = myfile.read()
  96                                         soft = []
  97                                         hard = []
  98                                         for line in contents.split("\n"):
  99                                                 line = line.strip()
 100                                                 if pattern.match(line):
 101                                                         if line[len(line) - 1] == "?":
 102                                                                 soft.append( line[:-1])
 103                                                         else:
 104                                                                 hard.append(line)
 105
 106                                         result["depends"] = hard
 107                                         result["optional_depends"] = soft
 108
 109                         except IOError:
 110                                 pass
 111
 112                 else:
 113                         if "depends" in result:
 114                                 result["depends"] = [x.strip() for x in result["depends"].split(",")]
 115                         if "optional_depends" in result:
 116                                 result["optional_depends"] = [x.strip() for x in result["optional_depends"].split(",")]
 117
 118                 # Fix games using "name" as "title"
 119                 if self.type == ContentType.GAME:
 120                         result["title"] = result["name"]
 121                         del result["name"]
 122
 123                 # Calculate Title
 124                 if "name" in result and not "title" in result:
 125                         result["title"] = result["name"].replace("_", " ").title()
 126
 127                 # Calculate short description
 128                 if "description" in result:
 129                         desc = result["description"]
 130                         idx = desc.find(".") + 1
 131                         cutIdx = min(len(desc), 200 if idx < 5 else idx)
 132                         result["short_description"] = desc[:cutIdx]
 133
 134                 if "name" in result:
 135                         self.name = result["name"]
 136                         del result["name"]
 137
 138                 self.meta = result
 139
 140         def add_children_from_mod_dir(self, dir):
 141                 for entry in next(os.walk(dir))[1]:
 142                         path = os.path.join(dir, entry)
 143                         if not entry.startswith('.') and os.path.isdir(path):
 144                                 child = PackageTreeNode(path, self.relative + entry + "/", name=entry)
 145                                 if not child.type.isModLike():
 146                                         raise MinetestCheckError(("Expecting mod or modpack, found {} at {} inside {}") \
 147                                                         .format(child.type.value, child.relative, self.type.value))
 148
 149                                 self.children.append(child)
 150
 151         def getModNames(self):
 152                 return self.fold("name", type=ContentType.MOD)
 153
 154         # attr: Attribute name
 155         # key: Key in attribute
 156         # retval: Accumulator
 157         # type: Filter to type
 158         def fold(self, attr, key=None, retval=None, type=None):
 159                 if retval is None:
 160                         retval = set()
 161
 162                 # Iterate through children
 163                 for child in self.children:
 164                         child.fold(attr, key, retval, type)
 165
 166                 # Filter on type
 167                 if type and type != self.type:
 168                         return retval
 169
 170                 # Get attribute
 171                 at = getattr(self, attr)
 172                 if not at:
 173                         return retval
 174
 175                 # Get value
 176                 value = at if key is None else at.get(key)
 177                 if isinstance(value, list):
 178                         retval |= set(value)
 179                 elif value:
 180                         retval.add(value)
 181
 182                 return retval
 183
 184         def get(self, key):
 185                 return self.meta.get(key)
 186
 187         def validate(self):
 188                 for child in self.children:
 189                         child.validate()