pyffi.formats.rockstar.dir

102 """This class implements the DIR format.""" 103 xml_file_name = 'dir.xml' 104 # where to look for dir.xml 105 xml_file_path = [os.path.dirname(__file__)] 106 # file name regular expression match 107 RE_FILENAME = re.compile(r'^.*\.dir$', re.IGNORECASE) 108 109 # basic types 110 UInt = pyffi.object_models.common.UInt

111 - class String(pyffi.object_models.common.FixedString):

112 _len = 24

113

114 - class Data(pyffi.object_models.FileFormat.Data):

115 """A class to contain the actual dir data.""" 116

117 - def __init__(self, folder=None):

118 """Initialize empty file list, or take list of files from 119 a folder. 120 """ 121 self.files = [] 122 offset = 0 123 if folder: 124 for filename in sorted(os.listdir(folder)): 125 if not os.path.isfile(os.path.join(folder, filename)): 126 continue 127 fileinfo = os.stat(os.path.join(folder, filename)) 128 file_record = DirFormat.File() 129 file_record.offset = offset 130 file_record.size = (fileinfo.st_size + 2047) // 2048 131 file_record.name = filename 132 self.files.append(file_record) 133 offset += file_record.size

134

135 - def inspect_quick(self, stream):

136 """Quickly checks if stream contains DIR data, by looking at 137 the first 36 bytes. 138 139 :param stream: The stream to inspect. 140 :type stream: file 141 """ 142 pos = stream.tell() 143 try: 144 off1, size1, file1 = struct.unpack( 145 "<II24s", stream.read(32)) 146 try: 147 off2, = struct.unpack( 148 "<I", stream.read(4)) 149 except struct.error: 150 # this happens if .dir only contains one file record 151 off2 = size1 152 if not(off1 == 0 153 #and size1 < 1000 # heuristic 154 and off2 == size1 155 and file1[-1] == '\x00'): 156 raise ValueError('Not a Rockstar DIR file.') 157 finally: 158 stream.seek(pos)

159 160 # overriding pyffi.object_models.FileFormat.Data methods 161

162 - def inspect(self, stream):

163 """Quickly checks if stream contains DIR data. 164 165 :param stream: The stream to inspect. 166 :type stream: file 167 """ 168 pos = stream.tell() 169 try: 170 self.inspect_quick(stream) 171 finally: 172 stream.seek(pos)

173 174

175 - def read(self, stream):

176 """Read a dir file. 177 178 :param stream: The stream from which to read. 179 :type stream: ``file`` 180 """ 181 self.inspect_quick(stream) 182 self.files = [] 183 pos = stream.tell() 184 while stream.read(1): 185 stream.seek(pos) 186 file_record = DirFormat.File() 187 file_record.read(stream, self) 188 self.files.append(file_record) 189 pos = stream.tell()

190

191 - def write(self, stream):

192 """Write a dir file. 193 194 :param stream: The stream to which to write. 195 :type stream: ``file`` 196 """ 197 for file_record in self.files: 198 file_record.write(stream, self)

199 200 # GlobalNode 201

202 - def get_global_child_nodes(self, edge_filter=EdgeFilter()):

203 return self.files

204

205 - def unpack(self, image, folder):

206 """Unpack all files, whose data resides in the given 207 image, into the given folder. 208 """ 209 for file_record in self.files: 210 image.seek(file_record.offset * 2048) 211 with open(os.path.join(folder, file_record.name), 'wb') as data: 212 data.write(image.read(file_record.size * 2048))

213

214 - def pack(self, image, folder):

215 """Pack all files, whose data resides in the given folder, 216 into the given image. 217 """ 218 for file_record in self.files: 219 if image.tell() != file_record.offset * 2048: 220 raise ValueError('file offset mismatch') 221 with open(os.path.join(folder, file_record.name), 'rb') as data: 222 allbytes = data.read() 223 size = file_record.size * 2048 224 if len(allbytes) > size: 225 raise ValueError('file larger than record size') 226 image.write(allbytes) 227 if len(allbytes) < size: 228 image.write('\x00' * (size - len(allbytes)))

Source Code for Package pyffi.formats.rockstar.dir_