source: vbox/trunk/src/VBox/Main/src-server/USBIdDatabaseGenerator.cpp@ 58005

/* $Id: USBIdDatabaseGenerator.cpp 58001 2015-10-02 10:15:58Z vboxsync $ */
/** @file
 * USB device vendor and product ID database - generator.
 */

/*
 * Copyright (C) 2015 Oracle Corporation
 *
 * This file is part of VirtualBox Open Source Edition (OSE), as
 * available from http://www.virtualbox.org. This file is free software;
 * you can redistribute it and/or modify it under the terms of the GNU
 * General Public License (GPL) as published by the Free Software
 * Foundation, in version 2 as it comes in the "COPYING" file of the
 * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
 * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
 */

#include <stdio.h>
#include <fstream>
#include <iostream>
#include <iomanip>
#include <algorithm>
#include <vector>
#include <string>

#include <iprt/initterm.h>
#include <iprt/message.h>
#include <iprt/string.h>
#include <iprt/stream.h>

using namespace std;

static const char * const header =
    "/** @file\n"
    " * USB device vendor and product ID database - Autogenerated from <stupid C++ cannot do %s>\n"
    " */\n"
    "\n"
    "/*\n"
    " * Copyright (C) 2015 Oracle Corporation\n"
    " *\n"
    " * This file is part of VirtualBox Open Source Edition(OSE), as\n"
    " * available from http ://www.virtualbox.org. This file is free software;\n"
    " * you can redistribute it and / or modify it under the terms of the GNU\n"
    " * General Public License(GPL) as published by the Free Software\n"
    " * Foundation, in version 2 as it comes in the \"COPYING\" file of the\n"
    " * VirtualBox OSE distribution.VirtualBox OSE is distributed in the\n"
    " * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.\n"
    " */"
    "\n"
    "\n"
    "#include \"USBIdDatabase.h\"\n"
    "\n"
    "/**\n"
    " * USB devices aliases array.\n"
    " * Format: VendorId, ProductId, Vendor Name, Product Name\n"
    " * The source of the list is http://www.linux-usb.org/usb.ids\n"
    " */\n"
    "Product const AliasDictionary::aProducts[] =\n"
    "{\n";

const char *footer =
    "};\n"
    "\n"
    "const size_t AliasDictionary::cProducts = RT_ELEMENTS(AliasDictionary::aProducts);\n";

const char *vendor_header =
    "\nVendor const AliasDictionary::aVendors[] =\n"
    "{\n";
const char *vendor_footer =
    "};\n"
    "\n"
    "const size_t AliasDictionary::cVendors = RT_ELEMENTS(AliasDictionary::aVendors);\n";

const char *start_block = "# Vendors, devices and interfaces. Please keep sorted.";
const char *end_block = "# List of known device classes, subclasses and protocols";

#define USBKEY(vendorId, productId) (((vendorId) << 16) | (productId))

// error codes
#define ERROR_INVALID_ARGUMENTS (1)
#define ERROR_OPEN_FILE         (2)
#define ERROR_IN_PARSE_LINE     (3)
#define ERROR_DUPLICATE_ENTRY   (4)
#define ERROR_WRONG_FILE_FORMAT (5)

struct VendorRecord
{
    size_t vendorID;
    string vendor;
};

struct ProductRecord
{
    size_t key;
    size_t vendorID;
    size_t productID;
    string product;
};

bool operator < (const ProductRecord& lh, const ProductRecord& rh)
{
    return lh.key < rh.key;
}

bool operator < (const VendorRecord& lh, const VendorRecord& rh)
{
    return lh.vendorID < rh.vendorID;
}

bool operator == (const ProductRecord& lh, const ProductRecord& rh)
{
    return lh.key == rh.key;
}

bool operator == (const VendorRecord& lh, const VendorRecord& rh)
{
    return lh.vendorID == rh.vendorID;
}

string conv(const string& src)
{
    string res = src;
    for (size_t i = 0; i < res.length(); ++i)
    {
        switch (res[i])
        {
            case '"':
            case '\\': res.insert(i++, "\\"); break;
            default:
            {
                // encode multibyte UTF-8 symbols to be sure that they
                // will be safely read by compiler
                if ((unsigned char)res[i] >= 127)
                {
                    size_t start = i;
                    string temp = "\" \"";
                    char buffer[8] = { 0 };
                    do
                    {
                        RTStrPrintf(buffer, sizeof(buffer), "\\x%x", (unsigned char)res[i]);
                        temp.append(buffer);
                    } while ((unsigned char)res[++i] & 0x80);
                    // splitting string after escape sequence to finish number sequence
                    // otherwise it could lead to situation when "\x88a" will threathened as
                    // multibyte symbol '\x88a' instead of two symbols '\x88' and 'a'
                    temp.append("\" \"");
                    res.replace(start, i - start, temp);
                    i += temp.length();
                }
            }
        }
    }
    return res;
}

ostream& operator <<(ostream& stream, const ProductRecord product)
{
    stream << "    { USBKEY(0x" << setfill('0') << setw(4) << hex << product.vendorID
           <<            ", 0x" << setfill('0') << setw(4) << product.productID << "), "
           << "\"" << conv(product.product).c_str() << "\" }," << endl;
    return stream;
}

ostream& operator <<(ostream& stream, const VendorRecord vendor)
{
    stream << "    { 0x" << setfill('0') << setw(4) << hex << vendor.vendorID
           << ", \"" << conv(vendor.vendor).c_str() << "\" }," << endl;
    return stream;
}

namespace State
{
    typedef int Value;
    enum
    {
        lookForStartBlock,
        lookForEndBlock,
        finished
    };
}

typedef vector<ProductRecord> ProductsSet;
typedef vector<VendorRecord> VendorsSet;
ProductsSet g_products;
VendorsSet g_vendors;


int ParseAlias(const string& src, size_t& id, string& desc)
{
    unsigned int i = 0;
    int idx = 0;
    string sin;

    if (sscanf(src.c_str(), "%x", &i) != 1)
        return ERROR_IN_PARSE_LINE;

    size_t index = src.find_first_of(" \t", 1);
    index = src.find_first_not_of(" \t", index);

    if (index == string::npos)
        return ERROR_IN_PARSE_LINE;

    sin = src.substr(index);
    id = i;
    desc = sin;

    return 0;
}

bool IsCommentOrEmptyLine(const string& str)
{
    size_t index = str.find_first_not_of(" \t");// skip left spaces
    return index == string::npos || str[index] == '#';
}

bool getline(PRTSTREAM instream, string& resString)
{
    const size_t szBuf = 4096;
    char buf[szBuf] = { 0 };

    int rc = RTStrmGetLine(instream, buf, szBuf);
    if (RT_SUCCESS(rc))
    {
        resString = buf;
        return true;
    }
    else if (rc != VERR_EOF)
    {
        cerr << "Warning: Invalid line in file. Error: " << hex << rc << endl;
    }
    return false;
}

int ParseUsbIds(PRTSTREAM instream)
{
    State::Value state = State::lookForStartBlock;
    string line;
    int res = 0;
    VendorRecord vendor = { 0, "" };

    while (state != State::finished && getline(instream, line))
    {
        switch (state)
        {
            case State::lookForStartBlock:
            {
                if (line.find(start_block) != string::npos)
                    state = State::lookForEndBlock;
                break;
            }
            case State::lookForEndBlock:
            {
                if (line.find(end_block) != string::npos)
                    state = State::finished;
                else
                {
                    if (!IsCommentOrEmptyLine(line))
                    {
                        if (line[0] == '\t')
                        {
                            // Parse Product line
                            // first line should be vendor
                            if (vendor.vendorID == 0)
                            {
                                cerr << "Wrong file format. Product before vendor: "
                                    << line.c_str() << "'" << endl;
                                return ERROR_WRONG_FILE_FORMAT;
                            }
                            ProductRecord product = { 0, vendor.vendorID, 0, "" };
                            if (ParseAlias(line.substr(1), product.productID, product.product) != 0)
                            {
                                cerr << "Error in parsing product line: '"
                                    << line.c_str() << "'" << endl;
                                return ERROR_IN_PARSE_LINE;
                            }
                            product.key = USBKEY(product.vendorID, product.productID);
                            Assert(product.vendorID != 0);
                            g_products.push_back(product);
                        }
                        else
                        {
                            // Parse vendor line
                            if (ParseAlias(line, vendor.vendorID, vendor.vendor) != 0)
                            {
                                cerr << "Error in parsing vendor line: '"
                                    << line.c_str() << "'" << endl;
                                return ERROR_IN_PARSE_LINE;
                            }
                            g_vendors.push_back(vendor);
                        }
                    }
                }
                break;
            }
        }
    }
    if (state == State::lookForStartBlock)
    {
        cerr << "Error: wrong format of input file. Start line is not found." << endl;
        return ERROR_WRONG_FILE_FORMAT;
    }
    return 0;
}

int main(int argc, char *argv[])
{
    int rc = RTR3InitExe(argc, &argv, 0);
    if (RT_FAILURE(rc))
        return RTMsgInitFailure(rc);

    if (argc < 4)
    {
        cerr << "Format: " << argv[0] <<
            " [linux.org usb list file] [custom usb list file] [-o output file]" << endl;
        cerr << "Error: Invalid arguments." << endl;
        return ERROR_INVALID_ARGUMENTS;
    }
    ofstream fout;
    PRTSTREAM fin;
    g_products.reserve(20000);
    g_vendors.reserve(3500);

    const char *outName = NULL;
    for (int i = 1; i < argc; i++)
    {
        if (strcmp(argv[i], "-o") == 0)
        {
            outName = argv[++i];
            continue;
        }

        rc = RTStrmOpen(argv[i], "r", &fin);
        if (RT_FAILURE(rc))
        {
            cerr << "Format: " << argv[0] <<
                " [linux.org usb list file] [custom usb list file] [-o output file]" << endl;
            cerr << "Error: Can not open file '" << argv[i] << "'. Error: " << hex << rc << endl;
            return ERROR_OPEN_FILE;
        }

        int res = ParseUsbIds(fin);
        if (res != 0)
        {
            cerr << "Error in parsing USB devices file '" <<
                argv[i] << "'" << endl;
            RTStrmClose(fin);
            return res;
        }
        RTStrmClose(fin);
    }

    sort(g_products.begin(), g_products.end());
    sort(g_vendors.begin(), g_vendors.end());

    // validate that all records are unique
    ProductsSet::iterator ita = adjacent_find(g_products.begin(), g_products.end());
    if (ita != g_products.end())
    {
        cerr << "Warning: Duplicate alias detected. " << *ita << endl;
        /** @todo r=bird: Why return success (0) when we didn't generate the
         *        file?!?!? */
        return 0;
    }

    if (!outName)
    {
        cerr << "Format: " << argv[0] <<
            " [linux.org usb list file] [custom usb list file] [-o output file]" << endl;
        cerr << "Error: Output file is not defined." << endl;
        return ERROR_OPEN_FILE;
    }

/** @todo String compression. */

    fout.open(outName);
    if (!fout.is_open())
    {
        cerr << "Format: " << argv[0] <<
            " [linux.org usb list file] [custom usb list file] [-o output file]" << endl;
        cerr << "Error: Can not open file to write '" << argv[1] << "'." << endl;
        return ERROR_OPEN_FILE;
    }

    fout << header;
    for (ProductsSet::iterator itp = g_products.begin(); itp != g_products.end(); ++itp)
    {
        fout << *itp;
    }
    fout << footer;

    fout << vendor_header;
    for (VendorsSet::iterator itv = g_vendors.begin(); itv != g_vendors.end(); ++itv)
    {
        fout << *itv;
    }
    fout << vendor_footer;

    fout.close();


    return 0;
}