2 * upkg: tool for manipulating Unreal Tournament packages.
3 * Copyright © 2009-2011 Nick Bowler
5 * This program is free software: you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation, either version 3 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License
16 * along with this program. If not, see <http://www.gnu.org/licenses/>.
26 #include <glib-object.h>
28 #include <uobject/uobject.h>
29 #include <uobject/module.h>
30 #include <uobject/package.h>
34 #define U_OBJECT_GET_PRIV(o) \
35 G_TYPE_INSTANCE_GET_PRIVATE(o, U_TYPE_OBJECT, struct u_object_priv)
39 const char *prop_name, *struct_name;
40 unsigned long size, array_idx;
63 struct u_object_priv {
67 unsigned char buf[2048];
71 G_DEFINE_TYPE(UObject, u_object, G_TYPE_OBJECT);
74 * Determine the actual size (in bytes) of a property, given the 3-bit encoded
75 * size from the tag byte. Depending on the tag size, there will be 0, 1, 2
76 * or 4 additional size bytes, which are to be found in the provided buffer
77 * which is at least n bytes long. The result is stored in *size.
79 * Returns the number of bytes that were read from the buffer, which may be 0.
80 * On failure, (i.e., there was not enough material in the buffer) 0 is stored
84 decode_tag_size(unsigned long *size, unsigned tag_size,
85 const unsigned char *buf, unsigned long n)
90 case 0: *size = 1; return 0;
91 case 1: *size = 2; return 0;
92 case 2: *size = 4; return 0;
93 case 3: *size = 12; return 0;
94 case 4: *size = 16; return 0;
103 *size = unpack_16_le(buf);
108 *size = unpack_32_le(buf);
116 decode_array_index(unsigned long *index, const unsigned char *buf,
122 /* TODO: Actually implement this instead of aborting. */
123 assert("FIXME" && !(buf[0] & 0x80));
130 * Decode the (mostly) generic property header, filling out the struct pointed
131 * to by head. Returns the number of bytes read from the buffer, or 0 on
135 decode_prop_header(struct upkg *upkg, struct prop_head *head,
136 const unsigned char *buf, unsigned long n)
138 unsigned long rc, len = 0;
139 unsigned char tag_size;
142 rc = upkg_decode_index(&index, buf+len, n-len);
145 if (!(head->prop_name = upkg_get_name(upkg, index)))
149 /* A property called "None" terminates the list, and does not have
150 * the usual header. */
151 if (!strcmp(head->prop_name, "None")) {
152 head->type = PROPERTY_END;
159 head->tag_msb = (buf[len] >> 7) & 0x01;
160 tag_size = (buf[len] >> 4) & 0x07;
161 head->type = (buf[len] >> 0) & 0x0f;
165 * TODO: Confirm the correct relative ordering of the next three
168 if (head->type == PROPERTY_STRUCT) {
169 rc = upkg_decode_index(&index, buf+len, n-len);
172 if (!(head->struct_name = upkg_get_name(upkg, index)))
177 rc = decode_tag_size(&head->size, tag_size, buf+len, n-len);
178 if (rc == 0 && head->size == 0)
183 if (head->tag_msb && head->type != PROPERTY_BOOLEAN) {
184 rc = decode_array_index(&head->array_idx, buf+len, n-len);
193 static int decode_object_property(UObject *uo, GValue *val, unsigned long len)
195 struct u_object_priv *priv = U_OBJECT_GET_PRIV(uo);
200 rc = upkg_decode_index(&index, priv->buf+len, priv->nbuf-len);
201 if (rc == 0 || index == 0)
205 fprintf(stderr, "Imports not supported yet.\n");
207 obj = u_object_new_from_package(uo->pkg, index-1);
210 g_value_init(val, U_TYPE_OBJECT);
211 g_value_take_object(val, obj);
215 static unsigned long deserialize_property(UObject *uo, struct prop_head *head)
217 struct u_object_priv *priv = U_OBJECT_GET_PRIV(uo);
218 unsigned long rc, len = 0;
221 rc = decode_prop_header(uo->pkg_file->pkg, head, priv->buf, priv->nbuf);
226 switch (head->type) {
230 if (priv->nbuf-len < 1)
232 g_value_init(&val, G_TYPE_UCHAR);
233 g_value_set_uchar(&val, priv->buf[len]);
234 g_object_set_property(G_OBJECT(uo), head->prop_name, &val);
236 case PROPERTY_INTEGER:
237 if (priv->nbuf-len < 4)
239 g_value_init(&val, G_TYPE_ULONG);
240 g_value_set_ulong(&val, unpack_32_le(priv->buf+len));
241 g_object_set_property(G_OBJECT(uo), head->prop_name, &val);
243 case PROPERTY_BOOLEAN:
244 g_value_init(&val, G_TYPE_BOOLEAN);
245 g_value_set_boolean(&val, head->tag_msb);
246 g_object_set_property(G_OBJECT(uo), head->prop_name, &val);
248 case PROPERTY_OBJECT:
249 rc = decode_object_property(uo, &val, len);
252 g_object_set_property(G_OBJECT(uo), head->prop_name, &val);
255 fprintf(stderr, "Unhandled property type %x\n",
256 (unsigned)head->type);
260 if (len > priv->nbuf) {
261 long skip = len - priv->nbuf;
263 /* XXX: Long properties are not supported yet, so just seek
264 * past them for now. */
265 if (upkg_export_seek(uo->pkg_file, skip, SEEK_CUR) != 0)
271 memmove(priv->buf, priv->buf+len, priv->nbuf-len);
277 /* Deserialize properties from an Unreal package. */
278 static int deserialize(UObject *uo)
280 struct u_object_priv *priv = U_OBJECT_GET_PRIV(uo);
281 struct upkg_file *f = uo->pkg_file;
282 unsigned long rc, tot_len = 0;
285 struct prop_head head;
287 /* Prime the buffer; deserialize_property assumes that there's
288 * enough data for "small" properties already available. */
290 void *buf = priv->buf + priv->nbuf;
291 size_t amt = sizeof priv->buf - priv->nbuf;
292 rc = upkg_export_read(f, buf, amt);
293 if (rc == 0 && priv->nbuf == 0)
298 rc = deserialize_property(uo, &head);
304 if (head.type == PROPERTY_END)
310 upkg_export_seek(f, 0, SEEK_SET);
316 * Get the full hierarchical object name for an export, used for diagnostics.
317 * The package name is passed in pname.
319 * Returns a buffer allocated by malloc on success, or NULL on failure.
321 static char *get_obj_fullname(const char *pname, const struct upkg_export *e)
323 size_t total_len = strlen(pname) + 1, len;
328 for (const struct upkg_export *c = e; c; c = c->parent) {
329 len = strlen(c->name) + 1;
330 if (total_len > SIZE_MAX - len)
335 fullname = malloc(total_len);
339 for (const struct upkg_export *c = e; c; c = c->parent) {
340 len = strlen(c->name);
341 assert(total_len > len);
343 total_len -= len + 1;
344 memcpy(fullname + total_len, c->name, len);
345 fullname[total_len + len] = c == e ? '\0' : '.';
348 assert(total_len == strlen(pname)+1);
349 memcpy(fullname, pname, total_len-1);
350 fullname[total_len-1] = '.';
355 int u_object_deserialize(GObject *obj, GTypeModule *pkg, unsigned long idx)
357 g_return_val_if_fail(IS_U_OBJECT(obj), -1);
358 g_return_val_if_fail(IS_U_PKG(pkg), -1);
360 UObject *uo = U_OBJECT(obj);
361 struct upkg *upkg = U_PKG(pkg)->pkg;
362 const struct upkg_export *e;
366 g_return_val_if_fail(uo->pkg_file == NULL, -1);
367 f = upkg_export_open(upkg, idx);
375 e = upkg_get_export(upkg, idx);
378 uo->pkg_name = get_obj_fullname(pkg->name, e);
382 rc = U_OBJECT_GET_CLASS(obj)->deserialize(uo);
384 upkg_export_close(f);
391 GObject *u_object_new_from_package(GTypeModule *pkg, unsigned long idx)
393 g_return_val_if_fail(IS_U_PKG(pkg), NULL);
395 const struct upkg_export *export;
396 const char *class, *package;
400 class = upkg_export_class(U_PKG(pkg)->pkg, idx, &package);
402 type = u_object_module_get_class(package, class);
404 obj = g_object_new(type, NULL);
405 if (u_object_deserialize(obj, pkg, idx) != 0) {
414 static void u_object_init(UObject *o)
420 static void u_object_finalize(GObject *o)
422 UObject *uo = U_OBJECT(o);
425 upkg_export_close(uo->pkg_file);
430 G_OBJECT_CLASS(u_object_parent_class)->finalize(o);
433 static void u_object_class_init(UObjectClass *class)
435 g_type_class_add_private(class, sizeof (struct u_object_priv));
436 GObjectClass *go = G_OBJECT_CLASS(class);
438 class->deserialize = deserialize;
439 go->finalize = u_object_finalize;
443 * Prepend a prefix to a printf-style format string. Unfortunately, there's
444 * no way to construct va_list values on the fly in C, so we cannot simply
445 * prepend %s and pass the prefix as an argument. Any % characters in the
446 * prefix will be escaped.
448 * Returns a pointer to a newly allocated string, which should be freed by the
449 * caller, or NULL otherwise.
451 static char *prepend_fmt(const char *prefix, const char *fmt)
453 size_t prefix_len = strlen(prefix), fmt_len = strlen(fmt);
456 if (prefix_len > SIZE_MAX/2 - sizeof ": ")
458 if (2*prefix_len > SIZE_MAX - fmt_len)
461 new_fmt = malloc(2*prefix_len + fmt_len + 1);
465 for (size_t i = 0; i < prefix_len; i++) {
466 if (prefix[i] == '%')
467 new_fmt[offset++] = '%';
468 new_fmt[offset++] = prefix[i];
471 new_fmt[offset++] = ':';
472 new_fmt[offset++] = ' ';
473 strcpy(new_fmt+offset, fmt);
479 /* Logging helpers that automatically prepend the UObject class information. */
480 void u_vlog_full(GObject *o, GLogLevelFlags level, const char *fmt, va_list ap)
482 g_return_if_fail(IS_U_OBJECT(o));
483 UObject *uo = U_OBJECT(o);
484 char *new_fmt = NULL;
487 new_fmt = prepend_fmt(uo->pkg_name, fmt);
489 g_log(G_OBJECT_TYPE_NAME(o), level, "%s",
496 g_logv(G_OBJECT_TYPE_NAME(o), level, fmt, ap);
500 void u_log_full(GObject *o, GLogLevelFlags level, const char *fmt, ...)
505 u_vlog_full(o, level, fmt, ap);