epm.c

/*
 * Main program source for the ESP Package Manager (EPM).
 *
 * Copyright © 2020 by Jim Jagielski
 * Copyright © 1999-2020 by Michael R Sweet
 * Copyright © 1999-2008 by Easy Software Products.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

/*
 * Include necessary headers...
 */

#include "epm.h"

/*
 * Globals...
 */

int CompressFiles = EPM_COMPRESS;
const char *DataDir = EPM_DATADIR;
int KeepFiles = 0;
const char *SetupProgram = EPM_LIBDIR "/setup";
const char *SoftwareDir = EPM_SOFTWARE;
const char *UninstProgram = EPM_LIBDIR "/uninst";
int Verbosity = 0;
int AooMode = 0;

/*
 * Local functions...
 */

static void depend(dist_t *dist);
static void info(void);
static void usage(void);

/*
 * 'main()' - Read a product list and produce a distribution.
 */

int                /* O - Exit status */
main(int argc,     /* I - Number of command-line args */
     char *argv[]) /* I - Command-line arguments */
{
    int i;                   /* Looping var */
    int strip;               /* 1 if we should strip executables */
    struct utsname platform; /* UNIX name info */
    char *namefmt,           /* Name format to use */
        *custom_name,        /* User-supplied system name */
        platname[255],       /* Base platform name */
        prodname[256],       /* Product name */
        listname[256],       /* List file name */
        directory[255],      /* Name of install directory */
        *temp,               /* Temporary string pointer */
        *setup,              /* Setup GUI image */
        *types;              /* Setup GUI install types */
    dist_t *dist;            /* Software distribution */
    int format;              /* Distribution format */
    int show_depend;         /* Show dependencies */
    static char *formats[] = /* Distribution format strings */
        {"portable", "aix", "bsd", "deb", "inst",  "rpm",       "rpm",      "macos",
         "macos",    "pkg", "rpm", "rpm", "setld", "slackware", "swinstall"};

    /*
     * Get platform information...
     */

    get_platform(&platform);

    /*
     * Check arguments...
     */

    if (argc < 2) {
        puts("epm: Too few arguments!");
        usage();
    }

    strip = 1;
    format = PACKAGE_PORTABLE;
    setup = NULL;
    types = NULL;
    namefmt = "srm";
    custom_name = 0;
    prodname[0] = '\0';
    listname[0] = '\0';
    directory[0] = '\0';
    show_depend = 0;

    for (i = 1; i < argc; i++)
        if (argv[i][0] == '-') {
            /*
             * Process a command-line option...
             */

            switch (argv[i][1]) {
            case 'a': /* Architecture */
                if (argv[i][2])
                    temp = argv[i] + 2;
                else {
                    i++;
                    if (i >= argc) {
                        puts("epm: Expected architecture name.");
                        usage();
                    }

                    temp = argv[i];
                }

                strlcpy(platform.machine, temp, sizeof(platform.machine));
                break;

            case 'f': /* Format */
                if (argv[i][2])
                    temp = argv[i] + 2;
                else {
                    i++;
                    if (i >= argc) {
                        puts("epm: Expected format name.");
                        usage();
                    }

                    temp = argv[i];
                }

                if (!strcasecmp(temp, "portable"))
                    format = PACKAGE_PORTABLE;
                else if (!strcasecmp(temp, "aix"))
                    format = PACKAGE_AIX;
                else if (!strcasecmp(temp, "bsd"))
                    format = PACKAGE_BSD;
                else if (!strcasecmp(temp, "deb"))
                    format = PACKAGE_DEB;
                else if (!strcasecmp(temp, "inst") || !strcasecmp(temp, "tardist"))
                    format = PACKAGE_INST;
                else if (!strcasecmp(temp, "lsb"))
                    format = PACKAGE_LSB;
                else if (!strcasecmp(temp, "lsb-signed"))
                    format = PACKAGE_LSB_SIGNED;
                else if (!strcasecmp(temp, "macos") || !strcasecmp(temp, "osx"))
                    format = PACKAGE_MACOS;
                else if (!strcasecmp(temp, "macos-signed") ||
                         !strcasecmp(temp, "osx-signed"))
                    format = PACKAGE_MACOS_SIGNED;
                else if (!strcasecmp(temp, "pkg"))
                    format = PACKAGE_PKG;
                else if (!strcasecmp(temp, "rpm"))
                    format = PACKAGE_RPM;
                else if (!strcasecmp(temp, "rpm-signed"))
                    format = PACKAGE_RPM_SIGNED;
                else if (!strcasecmp(temp, "setld"))
                    format = PACKAGE_SETLD;
                else if (!strcasecmp(temp, "slackware"))
                    format = PACKAGE_SLACKWARE;
                else if (!strcasecmp(temp, "swinstall") || !strcasecmp(temp, "depot"))
                    format = PACKAGE_SWINSTALL;
                else if (!strcasecmp(temp, "native"))
#if defined(__linux)
                {
                    /*
                     * Use dpkg as the native format, if installed...
                     */

                    if (access("/usr/bin/dpkg", 0))
                        format = PACKAGE_RPM;
                    else
                        format = PACKAGE_DEB;
                }
#elif defined(__sgi)
                    format = PACKAGE_INST;
#elif defined(__osf__)
                    format = PACKAGE_SETLD;
#elif defined(__hpux)
                    format = PACKAGE_SWINSTALL;
#elif defined(_AIX)
                    format = PACKAGE_AIX;
#elif defined(__FreeBSD__) || defined(__NetBSD__) || defined(__OpenBSD__)
                    format = PACKAGE_BSD;
#elif defined(__svr4__) || defined(__SVR4) || defined(M_XENIX)
                    format = PACKAGE_PKG;
#elif defined(__APPLE__)
                    format = PACKAGE_MACOS;
#else
                    format = PACKAGE_PORTABLE;
#endif
                else {
                    printf("epm: Unknown format \"%s\".\n", temp);
                    usage();
                }
                break;

            case 'g': /* Don't strip */
                strip = 0;
                break;

            case 'k': /* Keep intermediate files */
                KeepFiles = 1;
                break;

            case 'm': /* Custom sysname-release-machine string */
                if (argv[i][2])
                    custom_name = argv[i] + 2;
                else {
                    i++;
                    if (i >= argc) {
                        puts("epm: Expected custom system name string.");
                        usage();
                    }

                    custom_name = argv[i];
                }
                break;

            case 'n': /* Name with sysname, machine, and/or release */
                namefmt = argv[i] + 2;
                break;

            case 's': /* Use setup GUI */
                if (argv[i][2])
                    setup = argv[i] + 2;
                else {
                    i++;
                    if (i >= argc) {
                        puts("epm: Expected setup image.");
                        usage();
                    }

                    setup = argv[i];
                }
                break;

            case 't': /* Test scripts */
                fputs("epm: Sorry, the \"test\" option is no longer available!\n",
                      stderr);
                break;

            case 'u': /* Uncompressed output */
                CompressFiles = 0;
                break;

            case 'v': /* Be verbose */
                Verbosity += strlen(argv[i]) - 1;
                break;

            case 'z': /* Compress output */
                CompressFiles = 1;
                break;

            case '-': /* --option */
                if (!strcmp(argv[i], "--data-dir")) {
                    i++;
                    if (i < argc)
                        DataDir = argv[i];
                    else {
                        puts("epm: Expected data directory.");
                        usage();
                    }
                } else if (!strcmp(argv[i], "--depend"))
                    show_depend = 1;
                else if (!strcmp(argv[i], "--keep-files"))
                    KeepFiles = 1;
                else if (!strcmp(argv[i], "--aoo-mode"))
                    AooMode = 1;
                else if (!strcmp(argv[i], "--output-dir")) {
                    i++;
                    if (i < argc)
                        strlcpy(directory, argv[i], sizeof(directory));
                    else {
                        puts("epm: Expected output directory.");
                        usage();
                    }
                } else if (!strcmp(argv[i], "--setup-image")) {
                    i++;
                    if (i < argc)
                        setup = argv[i];
                    else {
                        puts("epm: Expected setup image.");
                        usage();
                    }
                } else if (!strcmp(argv[i], "--setup-program")) {
                    i++;
                    if (i < argc)
                        SetupProgram = argv[i];
                    else {
                        puts("epm: Expected setup program.");
                        usage();
                    }
                } else if (!strcmp(argv[i], "--setup-types")) {
                    i++;
                    if (i < argc)
                        types = argv[i];
                    else {
                        puts("epm: Expected setup.types file.");
                        usage();
                    }
                } else if (!strcmp(argv[i], "--software-dir")) {
                    i++;
                    if (i < argc)
                        SoftwareDir = argv[i];
                    else {
                        puts("epm: Expected software directory.");
                        usage();
                    }
                } else if (!strcmp(argv[i], "--uninstall-program")) {
                    i++;
                    if (i < argc)
                        UninstProgram = argv[i];
                    else {
                        puts("epm: Expected uninstall program.");
                        usage();
                    }
                } else if (!strcmp(argv[i], "--version")) {
                    info();
                    return (0);
                } else {
                    printf("epm: Unknown option \"%s\".\n", argv[i]);
                    usage();
                }
                break;

            default:
                printf("epm: Unknown option \"%s\".\n", argv[i]);
                usage();
                break;
            }
        } else if (strchr(argv[i], '=') != NULL)
            putenv(argv[i]);
        else if (prodname[0] == '\0')
            strlcpy(prodname, argv[i], sizeof(prodname));
        else if (listname[0] == '\0')
            strlcpy(listname, argv[i], sizeof(listname));
        else {
            printf("epm: Unknown argument \"%s\".\n", argv[i]);
            usage();
        }

    /*
     * Check for product name and list file...
     */

    if (!prodname[0]) {
        puts("epm: No product name specified!");
        usage();
    }

    for (i = 0; prodname[i]; i++)
        if (!isalnum(prodname[i] & 255)) {
            puts("epm: Product names should only contain letters and numbers!");
            break;
        }

    if (!listname[0])
        snprintf(listname, sizeof(listname), "%s.list", prodname);

    /*
     * Format the build directory and platform name strings...
     */

    if (!directory[0]) {
        /*
         * User did not specify an output directory, so use our default...
         */

        if (custom_name)
            strlcpy(directory, custom_name, sizeof(directory));
        else
            snprintf(directory, sizeof(directory), "%s-%s-%s", platform.sysname,
                     platform.release, platform.machine);
    }

    platname[0] = '\0';

    if (custom_name)
        strlcat(platname, custom_name, sizeof(platname));
    else {
        for (temp = namefmt; *temp != '\0'; temp++) {
            if (platname[0])
                strlcat(platname, "-", sizeof(platname));

            if (*temp == 'm')
                strlcat(platname, platform.machine, sizeof(platname));
            else if (*temp == 'r')
                strlcat(platname, platform.release, sizeof(platname));
            else if (*temp == 's')
                strlcat(platname, platform.sysname, sizeof(platname));
            else {
                printf("epm: Bad name format character \"%c\" in \"%s\".\n", *temp,
                       namefmt);
                usage();
            }
        }
    }

    /*
     * Show program info...
     */

    if (Verbosity)
        info();

    /*
     * Read the distribution...
     */

    if ((dist = read_dist(listname, &platform, formats[format])) == NULL)
        return (1);

    /*
     * Check that all requires info is present!
     */

    if (!dist->product[0] || !dist->copyright[0] || !dist->vendor[0] ||
        (!dist->license[0] && !dist->readme[0]) || !dist->version[0]) {
        fputs("epm: Error - missing %product, %copyright, %vendor, %license,\n", stderr);
        fputs("     %readme, or %version attributes in list file!\n", stderr);

        free_dist(dist);

        return (1);
    }

    if (dist->num_files == 0) {
        fputs("epm: Error - no files for installation in list file!\n", stderr);

        free_dist(dist);

        return (1);
    }

    /*
     * Show dependencies?
     */

    if (show_depend) {
        depend(dist);

        free_dist(dist);

        return (0);
    }

    /*
     * Strip executables as needed...
     */

    if (strip) {
        if (Verbosity)
            puts("Stripping executables in distribution...");

        strip_execs(dist);
    }

    /*
     * Make build directory...
     */

    make_directory(directory, 0, getuid(), getgid());

    /*
     * Make the distribution in the correct format...
     */

    if (access(SetupProgram, 0) && setup) {
        puts("epm: Setup program not installed, creating non-GUI package.");
        setup = NULL;
    }

    switch (format) {
    case PACKAGE_PORTABLE:
        i = make_portable(prodname, directory, platname, dist, &platform, setup, types);
        break;
    case PACKAGE_AIX:
        i = make_aix(prodname, directory, platname, dist, &platform);
        break;
    case PACKAGE_BSD:
        i = make_bsd(prodname, directory, platname, dist, &platform);
        break;
    case PACKAGE_SLACKWARE:
        i = make_slackware(prodname, directory, platname, dist, &platform);
        break;
    case PACKAGE_DEB:
        if (geteuid() && run_command(NULL, "fakeroot --version"))
            fputs("epm: Warning - file permissions and ownership may not be correct\n"
                  "     in Debian packages unless you run EPM as root or the 'fakeroot'\n"
                  "     command is available!\n",
                  stderr);

        i = make_deb(prodname, directory, platname, dist, &platform);
        break;
    case PACKAGE_INST:
        i = make_inst(prodname, directory, platname, dist, &platform);
        break;
    case PACKAGE_MACOS:
    case PACKAGE_MACOS_SIGNED:
        i = make_macos(format, prodname, directory, platname, dist, &platform, setup);
        break;
    case PACKAGE_PKG:
        i = make_pkg(prodname, directory, platname, dist, &platform);
        break;
    case PACKAGE_LSB:
    case PACKAGE_LSB_SIGNED:
    case PACKAGE_RPM:
    case PACKAGE_RPM_SIGNED:
        i = make_rpm(format, prodname, directory, platname, dist, &platform, setup,
                     types);
        break;
    case PACKAGE_SETLD:
        if (geteuid())
            fputs("epm: Warning - file permissions and ownership may not be correct\n"
                  "     in Tru64 packages unless you run EPM as root!\n",
                  stderr);

        i = make_setld(prodname, directory, platname, dist, &platform);
        break;
    case PACKAGE_SWINSTALL:
        if (geteuid()) {
            fputs("epm: Error - HP-UX packages must be built as root!\n", stderr);
            i = 1;
        } else
            i = make_swinstall(prodname, directory, platname, dist, &platform);
        break;
    }

    /*
     * All done!
     */

    free_dist(dist);

    if (i)
        puts("Packaging failed!");
    else if (Verbosity)
        puts("Done!");

    return (i);
}

/*
 * 'depend()' - Show dependencies.
 */

static void depend(dist_t *dist) /* I - Distribution */
{
    int i;        /* Looping var */
    file_t *file; /* Current file */

    for (i = dist->num_files, file = dist->files; i > 0; i--, file++)
        switch (file->type) {
        case 'c':
        case 'f':
        case 'i':
        case 'C':
        case 'F':
        case 'I':
            puts(file->src);
            break;
        }
}

/*
 * 'info()' - Show the EPM copyright and license.
 */

static void info(void) {
    puts(EPM_VERSION);
    puts("Copyright (c) 1999-2020 by Michael R Sweet.");
    puts("Copyright (c) 2020 by Jim Jagielski.");
    puts("Apache OpenOffice compatible");
    puts("  url: https://github.com/jimjag/epm/");
    puts("");
    puts("EPM is free software and comes with ABSOLUTELY NO WARRANTY; for details");
    puts("see the Apache License version 2.0 in the file LICENSE or at");
    puts("\"https://www.apache.org/licenses/LICENSE-2.0\".  Report all problems to");
    puts("\"https://github.com/jimjag/epm/issues\".");
    puts("");
}

/*
 * 'usage()' - Show command-line usage instructions.
 */

static void usage(void) {
    info();

    puts("Usage: epm [options] [name=value ... name=value] product [list-file]");
    puts("Options:");
    puts("-a arch");
    puts("    Use the named architecture instead of the local one.");
    puts("-g");
    puts("    Don't strip executables in distributions.");
    puts("-f "
         "{aix,bsd,deb,depot,inst,macos,macos-signed,native,pkg,portable,rpm,rpm-signed,"
         "setld,slackware,swinstall,tardist}");
    puts("    Set distribution format.");
    puts("-k");
    puts("    Keep intermediate files (spec files, etc.)");
    puts("-m name");
    puts("    Set distribution filename to include the specified platform name.");
    puts("    This overrides \"-n\".");
    puts("-n[mrs]");
    puts("    Set distribution filename to include machine (m), OS release (r),");
    puts("    and/or OS name (s).");
    puts("-s setup.ext");
    puts("    Enable the setup GUI and use \"setup.ext\" for the setup image.");
    puts("-u");
#if EPM_COMPRESS == 0
    puts("    Do not compress files in packages (default).");
#else
    puts("    Do not compress files in packages.");
#endif /* EPM_COMPRESS == 0 */
    puts("-v");
    puts("    Be verbose.");
    puts("-z");
#if EPM_COMPRESS == 1
    puts("    Compress files in packages (default).");
#else
    puts("    Compress files in packages.");
#endif /* EPM_COMPRESS == 1 */
    puts("--data-dir /foo/bar/directory");
    puts("    Use the named setup data file directory instead of " EPM_DATADIR ".");
    puts("--help");
    puts("    Show this usage message.");
    puts("--keep-files");
    puts("    Keep temporary distribution files in the output directory.");
    puts("--aoo-mode");
    puts("    Modify rpm, deb, et.al. package names and format for Apache OpenOffice "
         "use.");
    puts("--output-dir /foo/bar/directory");
    puts("    Enable the setup GUI and use \"setup.xpm\" for the setup image.");
    puts("--setup-image setup.xpm");
    puts("    Enable the setup GUI and use \"setup.xpm\" for the setup image.");
    puts("--setup-program /foo/bar/setup");
    puts("    Use the named setup program instead of " EPM_LIBDIR "/setup.");
    puts("--setup-types setup.types");
    puts("    Include the named setup.types file with the distribution.");
    puts("--uninstalll-program /foo/bar/uninst");
    puts("    Use the named uninstall program instead of " EPM_LIBDIR "/uninst.");
    puts("--version");
    puts("    Show EPM version.");

    exit(1);
}