src/upkg.c

   1 /*
   2  *  upkg: tool for manipulating Unreal Tournament packages.
   3  *  Copyright © 2009-2011 Nick Bowler
   4  *
   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.
   9  *
  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.
  14  *
  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/>.
  17  */
  18
  19 #include <config.h>
  20 #include <stdio.h>
  21 #include <stdlib.h>
  22 #include <string.h>
  23 #include <errno.h>
  24 #include <assert.h>
  25 #include <getopt.h>
  26
  27 #include <glib-object.h>
  28
  29 #include "upkg.h"
  30 #include <uobject/uobject.h>
  31 #include <uobject/exportable.h>
  32 #include <uobject/loadable.h>
  33 #include <uobject/module.h>
  34 #include <uobject/package.h>
  35 #include <uobject/vfs.h>
  36
  37 enum {
  38         MODE_INFO,
  39         MODE_LIST,
  40         MODE_EXPORT,
  41         MODE_MAX
  42 };
  43
  44 int verbose = 0;
  45
  46 static const char *progname = "upkg";
  47 static const char *sopts = "ilxvf:VH";
  48 static const struct option lopts[] = {
  49         { "info",     0, NULL, 'i' },
  50         { "list",     0, NULL, 'l' },
  51         { "export",   0, NULL, 'x' },
  52         { "file",     1, NULL, 'f' },
  53         { "verbose",  0, NULL, 'v' },
  54         { "version",  0, NULL, 'V' },
  55         { "help",     0, NULL, 'H' },
  56         { 0 }
  57 };
  58
  59 void print_version(void)
  60 {
  61         printf("%s\n", PACKAGE_STRING);
  62         puts("\
  63 Copyright (C) 2009 Nick Bowler.\n\
  64 License GPLv3+: GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>.\n\
  65 This is free software: you are free to change and redistribute it.\n\
  66 There is NO WARRANTY, to the extent permitted by law."
  67         );
  68 }
  69
  70 void print_usage(FILE *f)
  71 {
  72         fprintf(f, "Usage: %s [options] [object ...]\n", progname);
  73 }
  74
  75 void print_help(void)
  76 {
  77         print_usage(stdout);
  78         puts("Detailed help coming soon.  Until then, I'll just list my options.");
  79         for (unsigned i = 0; lopts[i].name; i++) {
  80                 const struct option *o = &lopts[i];
  81                 printf("\t--%s", o->name);
  82
  83                 if (o->has_arg == 1) {
  84                         printf("=val");
  85                 } else if (o->has_arg == 2) {
  86                         printf("[=val]");
  87                 }
  88
  89                 printf(" (-%c)\n", o->val);
  90         }
  91 }
  92
  93 static void print_upkg_flags(const char *prefix, unsigned long flags)
  94 {
  95         if (flags & UPKG_FLAG_ALLOW_DOWNLOAD)
  96                 printf("%sAllowDownload\n", prefix);
  97         if (flags & UPKG_FLAG_CLIENT_OPTIONAL)
  98                 printf("%sClientOptional\n", prefix);
  99         if (flags & UPKG_FLAG_SERVER_ONLY)
 100                 printf("%sServerOnly\n", prefix);
 101         if (flags & UPKG_FLAG_BROKEN_LINKS)
 102                 printf("%sBrokenLinks\n", prefix);
 103         if (flags & UPKG_FLAG_INSECURE)
 104                 printf("%sInsecure\n", prefix);
 105         if (flags & UPKG_FLAG_REQUIRED)
 106                 printf("%sRequired\n", prefix);
 107 }
 108
 109 static void print_upkg_object_flags(const char *prefix, unsigned long flags)
 110 {
 111         if (flags & UPKG_OBJ_FLAG_TRANSACTIONAL)
 112                 printf("%sTransactional\n", prefix);
 113         if (flags & UPKG_OBJ_FLAG_UNREACHABLE)
 114                 printf("%sUnreachable\n", prefix);
 115         if (flags & UPKG_OBJ_FLAG_PUBLIC)
 116                 printf("%sPublic\n", prefix);
 117         if (flags & UPKG_OBJ_FLAG_TAG_IMPORT)
 118                 printf("%sImport\n", prefix);
 119         if (flags & UPKG_OBJ_FLAG_TAG_EXPORT)
 120                 printf("%sTagExport\n", prefix);
 121         if (flags & UPKG_OBJ_FLAG_SOURCE_MODIFIED)
 122                 printf("%sSourceModified\n", prefix);
 123         if (flags & UPKG_OBJ_FLAG_TAG_GARBAGE)
 124                 printf("%sTagGarbage\n", prefix);
 125         if (flags & UPKG_OBJ_FLAG_NEED_LOAD)
 126                 printf("%sNeedLoad\n", prefix);
 127         if (flags & UPKG_OBJ_FLAG_HIGHLIGHT_NAME)
 128                 printf("%sHighlightName\n", prefix);
 129         if (flags & UPKG_OBJ_FLAG_IN_SINGULAR_FUNC)
 130                 printf("%sInSingularFunc\n", prefix);
 131         if (flags & UPKG_OBJ_FLAG_SUPPRESSED)
 132                 printf("%sSuppressed\n", prefix);
 133         if (flags & UPKG_OBJ_FLAG_IN_END_STATE)
 134                 printf("%sInEndState\n", prefix);
 135         if (flags & UPKG_OBJ_FLAG_TRANSIENT)
 136                 printf("%sTransient\n", prefix);
 137         if (flags & UPKG_OBJ_FLAG_PRELOADING)
 138                 printf("%sPreloading\n", prefix);
 139         if (flags & UPKG_OBJ_FLAG_LOAD_FOR_CLIENT)
 140                 printf("%sLoadForClient\n", prefix);
 141         if (flags & UPKG_OBJ_FLAG_LOAD_FOR_SERVER)
 142                 printf("%sLoadForServer\n", prefix);
 143         if (flags & UPKG_OBJ_FLAG_LOAD_FOR_EDIT)
 144                 printf("%sLoadForEdit\n", prefix);
 145         if (flags & UPKG_OBJ_FLAG_STANDALONE)
 146                 printf("%sStandalone\n", prefix);
 147         if (flags & UPKG_OBJ_FLAG_NOT_FOR_CLIENT)
 148                 printf("%sNotForClient\n", prefix);
 149         if (flags & UPKG_OBJ_FLAG_NOT_FOR_SERVER)
 150                 printf("%sNotForServer\n", prefix);
 151         if (flags & UPKG_OBJ_FLAG_NOT_FOR_EDIT)
 152                 printf("%sNotForEdit\n", prefix);
 153         if (flags & UPKG_OBJ_FLAG_DESTROYED)
 154                 printf("%sDestroyed\n", prefix);
 155         if (flags & UPKG_OBJ_FLAG_NEED_POST_LOAD)
 156                 printf("%sNeedPostLoad\n", prefix);
 157         if (flags & UPKG_OBJ_FLAG_HAS_STACK)
 158                 printf("%sHasStack\n", prefix);
 159         if (flags & UPKG_OBJ_FLAG_NATIVE)
 160                 printf("%sNative\n", prefix);
 161         if (flags & UPKG_OBJ_FLAG_MARKED)
 162                 printf("%sMarked\n", prefix);
 163         if (flags & UPKG_OBJ_FLAG_ERROR_SHUTDOWN)
 164                 printf("%sErrorShutdown\n", prefix);
 165         if (flags & UPKG_OBJ_FLAG_DEBUG_POST_LOAD)
 166                 printf("%sDebugPostLoad\n", prefix);
 167         if (flags & UPKG_OBJ_FLAG_DEBUG_SERIALIZE)
 168                 printf("%sDebugSerialize\n", prefix);
 169         if (flags & UPKG_OBJ_FLAG_DEBUG_DESTROY)
 170                 printf("%sDebugDestroy\n", prefix);
 171 }
 172
 173 void print_guid(unsigned char guid[static 16])
 174 {
 175         for (unsigned i = 0; i < 16; i++) {
 176                 printf("%02hhx", guid[i]);
 177                 if (i == 15)
 178                         putchar('\n');
 179                 else
 180                         putchar(' ');
 181         }
 182 }
 183
 184 static void export_print_name(const struct upkg_export *e)
 185 {
 186         if (e) {
 187                 export_print_name(e->parent);
 188                 printf(".%s", e->name);
 189         }
 190 }
 191
 192 static void
 193 export_print_fullname(GTypeModule *pkg, const struct upkg_export *export)
 194 {
 195         printf("%s", pkg->name);
 196         export_print_name(export);
 197 }
 198
 199 static void import_print_fullname(const struct upkg_import *import)
 200 {
 201         if (import) {
 202                 import_print_fullname(import->parent);
 203                 if (import->parent)
 204                         putchar('.');
 205                 printf("%s", import->name);
 206         }
 207 }
 208
 209 void print_upkg_exports(struct upkg *pkg)
 210 {
 211         for (unsigned i = 0; i < pkg->export_count; i++) {
 212                 const struct upkg_export *export = upkg_get_export(pkg, i);
 213                 const char *package, *class;
 214
 215                 class = upkg_export_class(pkg, i, &package);
 216
 217                 if (!class)
 218                         continue;
 219
 220                 printf("%u - %s (%s.%s)\n", i+1, export->name, package, class);
 221                 printf("  Flags: %lx\n", export->flags);
 222                 if (verbose >= 2) {
 223                         print_upkg_object_flags("    ", export->flags);
 224                 }
 225         }
 226 }
 227
 228 void print_upkg_imports(struct upkg *pkg)
 229 {
 230         for (unsigned i = 0; i < pkg->import_count; i++) {
 231                 const struct upkg_import *import = upkg_get_import(pkg, i);
 232
 233                 printf("%u - ", i);
 234                 import_print_fullname(import);
 235                 printf(" (%s.%s)\n", import->class_package, import->class_name);
 236         }
 237 }
 238
 239 int package_info(struct upkg *pkg)
 240 {
 241         printf("Version: %u\n",  pkg->version);
 242         printf("License: %u\n",  pkg->license);
 243         printf("GUID: ");
 244         print_guid(pkg->guid);
 245
 246         printf("Flags:   %lx\n", pkg->flags);
 247         if (verbose >= 2) {
 248                 print_upkg_flags("        ", pkg->flags);
 249         }
 250
 251         printf("Names:   %lu\n", pkg->name_count);
 252         if (verbose >= 3) {
 253                 for (unsigned long i = 0; i < pkg->name_count; i++) {
 254                         printf("%lu - %s\n", i, upkg_get_name(pkg, i));
 255                 }
 256         }
 257
 258         printf("Exports: %lu\n", pkg->export_count);
 259         if (verbose >= 1) print_upkg_exports(pkg);
 260         printf("Imports: %lu\n", pkg->import_count);
 261         if (verbose >= 1) print_upkg_imports(pkg);
 262
 263         return 0;
 264 }
 265
 266 static int package_list(GTypeModule *pkg, long current)
 267 {
 268         struct upkg *upkg = U_PKG(pkg)->pkg;
 269         const struct upkg_export *parent = NULL;
 270
 271         if (current >= 0) {
 272                 parent = upkg_get_export(upkg, current);
 273                 assert(parent != NULL);
 274         }
 275
 276         for (unsigned i = 0; i < upkg->export_count; i++) {
 277                 const struct upkg_export *export = upkg_get_export(upkg, i);
 278
 279                 if (export->parent != parent)
 280                         continue;
 281
 282                 export_print_fullname(pkg, export);
 283
 284                 if (verbose >= 1) {
 285                         const char *class, *package;
 286
 287                         class = upkg_export_class(upkg, i, &package);
 288                         printf(" (%s.%s)", package, class);
 289                 }
 290
 291                 putchar('\n');
 292         }
 293
 294         return 0;
 295 }
 296
 297 static int object_info(GTypeModule *pkg, unsigned long idx)
 298 {
 299         struct upkg *upkg = U_PKG(pkg)->pkg;
 300         const struct upkg_export *export;
 301         const char *class, *package;
 302
 303         export = upkg_get_export(upkg, idx);
 304         export_print_fullname(pkg, export);
 305
 306         class = upkg_export_class(upkg, idx, &package);
 307         printf(" (%s.%s)\n", package, class);
 308
 309         /* Print out object properties. */
 310         if (verbose >= 1) {
 311                 GParamSpec **props;
 312                 GObject *obj;
 313                 unsigned n;
 314
 315                 obj = u_object_new_from_package(pkg, idx);
 316                 if (!obj) {
 317                         fprintf(stderr, "%s: failed to load object.\n",
 318                                         progname);
 319                         return -1;
 320                 }
 321
 322                 props = g_object_class_list_properties(G_OBJECT_GET_CLASS(obj), &n);
 323                 for (unsigned i = 0; i < n; i++) {
 324                         GValue val = {0};
 325                         char *valstr;
 326
 327                         printf("  property %s:", props[i]->name);
 328                         fflush(stdout);
 329
 330                         g_value_init(&val, props[i]->value_type);
 331                         g_object_get_property(obj, props[i]->name, &val);
 332
 333                         if (G_VALUE_HOLDS(&val, U_TYPE_OBJECT)) {
 334                                 UObject *obj = g_value_get_object(&val);
 335
 336                                 if (obj && obj->pkg_name) {
 337                                         printf(" %s", obj->pkg_name);
 338                                 }
 339                         }
 340
 341                         valstr = g_strdup_value_contents(&val);
 342                         printf(" %s\n", valstr);
 343                         g_free(valstr);
 344                 }
 345                 free(props);
 346
 347                 g_object_unref(obj);
 348         }
 349
 350         /* Print raw file info. */
 351         if (verbose >= 3) {
 352                 struct upkg_file *f = upkg_export_open(upkg, idx);
 353                 if (!f) {
 354                         fprintf(stderr, "%s: failed to open export.\n",
 355                                         progname);
 356                         return -1;
 357                 }
 358
 359                 printf("  file size: %lu\n", f->len);
 360                 printf("  file start: %#lx\n", f->base);
 361                 printf("  file end: %#lx\n", f->base + f->len);
 362
 363                 upkg_export_close(f);
 364         }
 365
 366         return 0;
 367 }
 368
 369 static int export(GTypeModule *pkg, GObject *obj, unsigned idx)
 370 {
 371         struct upkg *upkg = U_PKG(pkg)->pkg;
 372         char name[256];
 373         FILE *of;
 374         int rc;
 375
 376         if (U_OBJECT_IS_LOADABLE(obj) && u_object_load(obj) != 0) {
 377                 fprintf(stderr, "%s: failed to load export data.\n", progname);
 378                 return -1;
 379         }
 380
 381         rc = u_object_export_name(obj, name, sizeof name);
 382         if (rc <= 0) {
 383                 /* XXX: We could use a default name here. */
 384                 fprintf(stderr, "%s: failed to determine export filename.\n",
 385                                 progname);
 386                 return -1;
 387         }
 388
 389         printf("exporting ");
 390         export_print_fullname(pkg, upkg_get_export(upkg, idx));
 391         printf(" to %s\n", name);
 392
 393         of = fopen(name, "wb");
 394         if (!of) {
 395                 perror(name);
 396                 return -1;
 397         }
 398
 399         u_object_export(obj, of);
 400
 401         if (fclose(of) != 0) {
 402                 perror(name);
 403                 return -1;
 404         }
 405
 406         if (U_OBJECT_IS_LOADABLE(obj)) {
 407                 u_object_unload(obj);
 408         }
 409
 410         return 0;
 411 }
 412
 413 static int object_export(GTypeModule *pkg, unsigned long idx)
 414 {
 415         GObject *obj;
 416         int ret = -1;
 417
 418         obj = u_object_new_from_package(pkg, idx);
 419         if (!obj) {
 420                 fprintf(stderr, "%s: failed to load object.\n", progname);
 421                 return -1;
 422         }
 423
 424         if (!U_OBJECT_IS_EXPORTABLE(obj)) {
 425                 fprintf(stderr, "%s: object is not exportable.\n", progname);
 426                 goto out;
 427         }
 428
 429         ret = export(pkg, obj, idx);
 430 out:
 431         g_object_unref(obj);
 432         return ret;
 433 }
 434
 435 int package_export(GTypeModule *pkg)
 436 {
 437         struct upkg *upkg = U_PKG(pkg)->pkg;
 438         GObject *obj;
 439         int ret = 0;
 440
 441         for (unsigned i = 0; i < upkg->export_count; i++) {
 442                 obj = u_object_new_from_package(pkg, i);
 443                 if (U_OBJECT_IS_EXPORTABLE(obj) && export(pkg, obj, i) != 0) {
 444                         ret = -1;
 445                 }
 446                 g_object_unref(obj);
 447         }
 448
 449         return ret;
 450 }
 451
 452 static int process_object(int mode, const char *objname)
 453 {
 454         char work[strlen(objname)+1], *p = work, *c;
 455         GTypeModule *pkg;
 456         long current = -1;
 457         int ret = 0;
 458
 459         strcpy(work, objname);
 460
 461         /* First, find and open the actual package. */
 462         c = strchr(p, '.');
 463         if (c) *c = 0;
 464
 465         pkg = u_pkg_open(p);
 466         if (!pkg || !g_type_module_use(pkg)) {
 467                 fprintf(stderr, "%s: %s: failed to open package.\n",
 468                                 progname, work);
 469                 goto out;
 470         }
 471
 472         if (!U_PKG(pkg)->pkg) {
 473                 if (u_pkg_is_native(pkg)) {
 474                         fprintf(stderr, "%s: %s: not a UObject package.\n",
 475                                         progname, work);
 476                 } else {
 477                         fprintf(stderr, "%s: %s: package not found.\n",
 478                                         progname, work);
 479                 }
 480
 481                 goto out_unuse;
 482         }
 483
 484         /* Resolve the hierarchical reference. */
 485         while (c) {
 486                 p = c+1;
 487                 c = strchr(p, '.');
 488                 if (c) *c = 0;
 489
 490                 current = upkg_export_find(U_PKG(pkg)->pkg, current, p);
 491                 if (current == -1) {
 492                         /* We want to print the full name up to this point. */
 493                         strcpy(work, objname);
 494                         if (c) *c = 0;
 495
 496                         fprintf(stderr, "%s: %s: object not found.\n",
 497                                         progname, work);
 498                         goto out_unuse;
 499                 }
 500         }
 501
 502         switch (mode) {
 503         case MODE_INFO:
 504                 if (current < 0)
 505                         ret = package_info(U_PKG(pkg)->pkg);
 506                 else
 507                         ret = object_info(pkg, current);
 508                 break;
 509         case MODE_LIST:
 510                 ret = package_list(pkg, current);
 511                 break;
 512         case MODE_EXPORT:
 513                 if (current < 0)
 514                         ret = package_export(pkg);
 515                 else
 516                         ret = object_export(pkg, current);
 517                 break;
 518         default:
 519                 abort();
 520         }
 521
 522 out_unuse:
 523         g_type_module_unuse(pkg);
 524 out:
 525         return ret;
 526 }
 527
 528 int main(int argc, char **argv)
 529 {
 530         const char *pkgname = NULL;
 531         unsigned mode = MODE_INFO;
 532         int opt, rc;
 533
 534         if (argc > 0) progname = argv[0];
 535
 536         if (u_pkg_vfs_init() != 0)
 537                 return EXIT_FAILURE;
 538         if (u_object_module_init() != 0)
 539                 return EXIT_FAILURE;
 540
 541         while ((opt = getopt_long(argc, argv, sopts, lopts, NULL)) != -1) {
 542                 switch (opt) {
 543                 case 'f':
 544                         pkgname = u_pkg_vfs_add_local(NULL, optarg);
 545                         if (!pkgname) {
 546                                 fprintf(stderr, "failed to add package `%s'.\n", optarg);
 547                                 return EXIT_FAILURE;
 548                         }
 549                         break;
 550                 case 'i':
 551                         mode = MODE_INFO;
 552                         break;
 553                 case 'l':
 554                         mode = MODE_LIST;
 555                         break;
 556                 case 'x':
 557                         mode = MODE_EXPORT;
 558                         break;
 559                 case 'v':
 560                         verbose++;
 561                         break;
 562                 case 'V':
 563                         print_version();
 564                         return EXIT_SUCCESS;
 565                 case 'H':
 566                         print_help();
 567                         return EXIT_SUCCESS;
 568                 default:
 569                         print_usage(stderr);
 570                         return EXIT_FAILURE;
 571                 }
 572         }
 573
 574         if (!pkgname && !argv[optind]) {
 575                 print_usage(stderr);
 576                 return EXIT_FAILURE;
 577         }
 578
 579         rc = EXIT_SUCCESS;
 580         if (argv[optind]) {
 581                 for (int i = optind; i < argc; i++) {
 582                         if (process_object(mode, argv[i]) != 0)
 583                                 rc = EXIT_FAILURE;
 584                 }
 585         } else {
 586                 if (process_object(mode, pkgname) != 0)
 587                         rc = EXIT_FAILURE;
 588         }
 589
 590         u_object_module_exit();
 591         u_pkg_vfs_exit();
 592         return rc;
 593 }