2 * upkg: tool for manipulating Unreal Tournament packages.
3 * Copyright © 2009-2012, 2015, 2020, 2022 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 <https://www.gnu.org/licenses/>.
28 #include <glib-object.h>
30 #include <uobject/uobject.h>
31 #include <uobject/module.h>
32 #include <uobject/package.h>
36 #define U_OBJECT_GET_PRIV(o) \
37 G_TYPE_INSTANCE_GET_PRIVATE(o, U_TYPE_OBJECT, struct u_object_priv)
40 # define SIZE_MAX ((size_t)-1)
44 const char *prop_name, *struct_name;
45 unsigned long size, array_idx;
68 struct u_object_priv {
72 unsigned char buf[2048];
76 G_DEFINE_TYPE(UObject, u_object, G_TYPE_OBJECT);
79 * Determine the actual size (in bytes) of a property, given the 3-bit encoded
80 * size from the tag byte. Depending on the tag size, there will be 0, 1, 2
81 * or 4 additional size bytes, which are to be found in the provided buffer
82 * which is at least n bytes long. The result is stored in *size.
84 * Returns the number of bytes that were read from the buffer, which may be 0.
85 * On failure, (i.e., there was not enough material in the buffer) 0 is stored
89 decode_tag_size(unsigned long *size, unsigned tag_size,
90 const unsigned char *buf, unsigned long n)
95 case 0: *size = 1; return 0;
96 case 1: *size = 2; return 0;
97 case 2: *size = 4; return 0;
98 case 3: *size = 12; return 0;
99 case 4: *size = 16; return 0;
108 *size = unpack_16_le(buf);
113 *size = unpack_32_le(buf);
121 decode_array_index(unsigned long *index, const unsigned char *buf,
127 /* TODO: Actually implement this instead of aborting. */
128 assert("FIXME" && !(buf[0] & 0x80));
135 * Decode the (mostly) generic property header, filling out the struct pointed
136 * to by head. Returns the number of bytes read from the buffer, or 0 on
140 decode_prop_header(struct upkg *upkg, struct prop_head *head,
141 const unsigned char *buf, unsigned long n)
143 unsigned long rc, len = 0;
144 unsigned char tag_size;
147 rc = upkg_decode_index(&index, buf+len, n-len);
150 if (!(head->prop_name = upkg_get_name(upkg, index)))
154 /* A property called "None" terminates the list, and does not have
155 * the usual header. */
156 if (!strcmp(head->prop_name, "None")) {
157 head->type = PROPERTY_END;
164 head->tag_msb = (buf[len] >> 7) & 0x01;
165 tag_size = (buf[len] >> 4) & 0x07;
166 head->type = (buf[len] >> 0) & 0x0f;
170 * TODO: Confirm the correct relative ordering of the next three
173 if (head->type == PROPERTY_STRUCT) {
174 rc = upkg_decode_index(&index, buf+len, n-len);
177 if (!(head->struct_name = upkg_get_name(upkg, index)))
182 rc = decode_tag_size(&head->size, tag_size, buf+len, n-len);
183 if (rc == 0 && head->size == 0)
188 if (head->tag_msb && head->type != PROPERTY_BOOLEAN) {
189 rc = decode_array_index(&head->array_idx, buf+len, n-len);
199 * TODO: Make this use the uobject_module stuff so packages are not loaded
203 open_import_package(UObject *uo, const struct upkg_import *i)
207 assert(i->parent == NULL);
209 if (strcmp(i->class_package, "Core") != 0
210 || strcmp(i->class_name, "Package") != 0) {
211 u_err(uo, "import root must be Core.Package");
215 pkg = u_pkg_open(i->name);
216 if (!pkg || !g_type_module_use(pkg)) {
217 u_err(uo, "failed to open package: %s", i->name);
221 if (!U_PKG(pkg)->pkg) {
222 g_type_module_unuse(pkg);
223 u_err(uo, "failed to open package: %s", pkg->name);
230 /* Find the export index of a package based on the import chain from another
231 * package. Returns the (non-negative) offset on success, or a negative value
233 static long resolve_import(struct upkg *pkg, const struct upkg_import *import)
240 current = resolve_import(pkg, import->parent);
241 if (current != -1 && current >= 0)
244 index = upkg_export_find(pkg, current, import->name);
251 static GObject *get_import_object(UObject *uo, unsigned long index)
253 const struct upkg_import *import;
258 import = upkg_get_import(uo->pkg_file->pkg, index);
260 u_err(uo, "invalid package import: %ld", index);
264 /* Get the package name at the top of the hierarchy. */
265 for (const struct upkg_import *i = import; i; i = i->parent) {
266 if (i->parent == NULL) {
267 pkg = open_import_package(uo, i);
273 obj_index = resolve_import(U_PKG(pkg)->pkg, import);
275 u_err(uo, "could not find import in package: %s", pkg->name);
279 obj = u_object_new_from_package(pkg, obj_index);
281 g_type_module_unuse(pkg);
285 GObject *u_object_get_by_link(GObject *go, long index)
287 g_return_val_if_fail(IS_U_OBJECT(go), NULL);
288 UObject *uo = U_OBJECT(go);
294 return get_import_object(uo, -(index+1));
297 return u_object_new_from_package(uo->pkg, index-1);
300 static int decode_object_property(UObject *uo, GValue *val, unsigned long len)
302 struct u_object_priv *priv = U_OBJECT_GET_PRIV(uo);
307 rc = upkg_decode_index(&index, priv->buf+len, priv->nbuf-len);
311 obj = u_object_get_by_link(G_OBJECT(uo), index);
312 g_value_init(val, U_TYPE_OBJECT);
313 g_value_take_object(val, obj);
317 static unsigned long deserialize_property(UObject *uo, struct prop_head *head)
319 struct u_object_priv *priv = U_OBJECT_GET_PRIV(uo);
320 unsigned long rc, len = 0;
323 rc = decode_prop_header(uo->pkg_file->pkg, head, priv->buf, priv->nbuf);
328 switch (head->type) {
332 if (head->size != 1 || priv->nbuf-len < head->size)
334 g_value_init(&val, G_TYPE_UCHAR);
335 g_value_set_uchar(&val, priv->buf[len]);
336 g_object_set_property(G_OBJECT(uo), head->prop_name, &val);
338 case PROPERTY_INTEGER:
339 if (head->size != 4 || priv->nbuf-len < head->size)
341 g_value_init(&val, G_TYPE_ULONG);
342 g_value_set_ulong(&val, unpack_32_le(priv->buf+len));
343 g_object_set_property(G_OBJECT(uo), head->prop_name, &val);
345 case PROPERTY_BOOLEAN:
348 g_value_init(&val, G_TYPE_BOOLEAN);
349 g_value_set_boolean(&val, head->tag_msb);
350 g_object_set_property(G_OBJECT(uo), head->prop_name, &val);
352 case PROPERTY_OBJECT:
353 rc = decode_object_property(uo, &val, len);
356 g_object_set_property(G_OBJECT(uo), head->prop_name, &val);
359 * g_object_set_property increments refcount,
360 * release our reference.
362 g_object_unref(g_value_get_object(&val));
365 if (head->size != 4 || priv->nbuf-len < head->size)
367 g_value_init(&val, G_TYPE_FLOAT);
368 g_value_set_float(&val, u_unpack_binary32_le(priv->buf+len));
369 g_object_set_property(G_OBJECT(uo), head->prop_name, &val);
372 u_warn(uo, "%s: unsupported property type %u",
373 head->prop_name, (unsigned)head->type);
377 if (len > priv->nbuf) {
378 long skip = len - priv->nbuf;
380 /* XXX: Long properties are not supported yet, so just seek
381 * past them for now. */
382 if (upkg_export_seek(uo->pkg_file, skip, SEEK_CUR) != 0)
388 memmove(priv->buf, priv->buf+len, priv->nbuf-len);
394 /* Deserialize properties from an Unreal package. */
395 static int deserialize(UObject *uo)
397 struct u_object_priv *priv = U_OBJECT_GET_PRIV(uo);
398 struct upkg_file *f = uo->pkg_file;
399 unsigned long rc, tot_len = 0;
402 struct prop_head head;
404 /* Prime the buffer; deserialize_property assumes that there's
405 * enough data for "small" properties already available. */
407 void *buf = priv->buf + priv->nbuf;
408 size_t amt = sizeof priv->buf - priv->nbuf;
409 rc = upkg_export_read(f, buf, amt);
410 if (rc == 0 && priv->nbuf == 0)
415 rc = deserialize_property(uo, &head);
421 if (head.type == PROPERTY_END)
427 upkg_export_seek(f, 0, SEEK_SET);
433 * Get the full hierarchical object name for an export, used for diagnostics.
434 * The package name is passed in pname.
436 * Returns a buffer allocated by malloc on success, or NULL on failure.
438 static char *get_obj_fullname(const char *pname, const struct upkg_export *e)
440 size_t total_len = strlen(pname) + 1, len;
445 for (const struct upkg_export *c = e; c; c = c->parent) {
446 len = strlen(c->name) + 1;
447 if (total_len > SIZE_MAX - len)
452 fullname = malloc(total_len);
456 for (const struct upkg_export *c = e; c; c = c->parent) {
457 len = strlen(c->name);
458 assert(total_len > len);
460 total_len -= len + 1;
461 memcpy(fullname + total_len, c->name, len);
462 fullname[total_len + len] = c == e ? '\0' : '.';
465 assert(total_len == strlen(pname)+1);
466 memcpy(fullname, pname, total_len-1);
467 fullname[total_len-1] = '.';
472 int u_object_deserialize(GObject *obj, GTypeModule *pkg, unsigned long idx)
474 g_return_val_if_fail(IS_U_OBJECT(obj), -1);
475 g_return_val_if_fail(IS_U_PKG(pkg), -1);
477 UObject *uo = U_OBJECT(obj);
478 struct upkg *upkg = U_PKG(pkg)->pkg;
479 const struct upkg_export *e;
483 g_return_val_if_fail(uo->pkg_file == NULL, -1);
484 f = upkg_export_open(upkg, idx);
492 e = upkg_get_export(upkg, idx);
495 uo->pkg_name = get_obj_fullname(pkg->name, e);
499 rc = U_OBJECT_GET_CLASS(obj)->deserialize(uo);
501 upkg_export_close(f);
508 GObject *u_object_new_from_package(GTypeModule *pkg, unsigned long idx)
510 g_return_val_if_fail(IS_U_PKG(pkg), NULL);
512 const struct upkg_export *export;
516 export = upkg_get_export(U_PKG(pkg)->pkg, idx);
518 u_err(pkg, "invalid package export: %lu", idx);
522 type = u_object_module_get_class(pkg, export->class);
524 obj = g_object_new(type, NULL);
525 if (u_object_deserialize(obj, pkg, idx) != 0) {
534 static void u_object_init(UObject *o)
540 static void u_object_finalize(GObject *o)
542 UObject *uo = U_OBJECT(o);
545 upkg_export_close(uo->pkg_file);
550 G_OBJECT_CLASS(u_object_parent_class)->finalize(o);
553 static void u_object_class_init(UObjectClass *class)
555 g_type_class_add_private(class, sizeof (struct u_object_priv));
556 GObjectClass *go = G_OBJECT_CLASS(class);
558 class->deserialize = deserialize;
559 go->finalize = u_object_finalize;
563 * Prepend a prefix to a printf-style format string. Unfortunately, there's
564 * no way to construct va_list values on the fly in C, so we cannot simply
565 * prepend %s and pass the prefix as an argument. Any % characters in the
566 * prefix will be escaped.
568 * Returns a pointer to a newly allocated string, which should be freed by the
569 * caller, or NULL otherwise.
571 static char *prepend_fmt(const char *prefix, const char *fmt)
573 size_t prefix_len = strlen(prefix), fmt_len = strlen(fmt);
576 if (prefix_len > SIZE_MAX/2 - sizeof ": ")
578 if (2*prefix_len > SIZE_MAX - fmt_len)
581 new_fmt = malloc(2*prefix_len + fmt_len + 1);
585 for (size_t i = 0; i < prefix_len; i++) {
586 if (prefix[i] == '%')
587 new_fmt[offset++] = '%';
588 new_fmt[offset++] = prefix[i];
591 new_fmt[offset++] = ':';
592 new_fmt[offset++] = ' ';
593 strcpy(new_fmt+offset, fmt);
599 /* Logging helpers that automatically prepend the UObject class information. */
600 void u_vlog_full(GObject *o, GLogLevelFlags level, const char *fmt, va_list ap)
602 char *new_fmt = NULL, *obj_prefix = NULL;
604 if (IS_U_OBJECT(o)) {
605 obj_prefix = U_OBJECT(o)->pkg_name;
606 } else if (G_IS_TYPE_MODULE(o)) {
607 obj_prefix = G_TYPE_MODULE(o)->name;
611 new_fmt = prepend_fmt(obj_prefix, fmt);
613 g_log(G_OBJECT_TYPE_NAME(o), level, "%s", obj_prefix);
618 g_logv(G_OBJECT_TYPE_NAME(o), level, fmt, ap);
622 void u_log_full(GObject *o, GLogLevelFlags level, const char *fmt, ...)
627 u_vlog_full(o, level, fmt, ap);