bmqstoragetool.m.cpp

// Copyright 2014-2023 Bloomberg Finance L.P.
// SPDX-License-Identifier: Apache-2.0
//
// 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.

//@PURPOSE: Provide the main function for the 'bmqstoragetool' application.
//
//@DESCRIPTION: This component provides the 'main' function and arguments
// parsing scheme for the 'bmqstoragetool' application.

// bmqstoragetool
#include <m_bmqstoragetool_commandprocessorfactory.h>
#include <m_bmqstoragetool_parameters.h>

// BDE
#include <balcl_commandline.h>
#include <bdls_filesystemutil.h>
#include <bsl_iostream.h>
#include <bslma_managedptr.h>

using namespace BloombergLP;
using namespace m_bmqstoragetool;

static bool parseArgs(CommandLineArguments& arguments,
                      int                   argc,
                      const char*           argv[],
                      bslma::Allocator*     allocator)
{
    bool showHelp = false;

    balcl::OptionInfo specTable[] = {
        {"r|record-type",
         "record type",
         "record type to search {<message>|queue-op|journal-op}",
         balcl::TypeInfo(&arguments.d_recordType,
                         CommandLineArguments::isValidRecordType),
         balcl::OccurrenceInfo::e_OPTIONAL},
        {"csl-record-type",
         "csl record type",
         "CSL record type to search {<snapshot>|update|commit|ack}",
         balcl::TypeInfo(&arguments.d_cslRecordType,
                         CommandLineArguments::isValidCslRecordType),
         balcl::OccurrenceInfo::e_OPTIONAL},
        {"journal-path",
         "journal path",
         "'*'-ended file path pattern, where the tool will try to find "
         "journal and data files",
         balcl::TypeInfo(&arguments.d_journalPath),
         balcl::OccurrenceInfo::e_OPTIONAL},
        {"journal-file",
         "journal file",
         "path to a .bmq_journal file",
         balcl::TypeInfo(&arguments.d_journalFile,
                         CommandLineArguments::isValidFileName),
         balcl::OccurrenceInfo::e_OPTIONAL},
        {"data-file",
         "data file",
         "path to a .bmq_data file",
         balcl::TypeInfo(&arguments.d_dataFile,
                         CommandLineArguments::isValidFileName),
         balcl::OccurrenceInfo::e_OPTIONAL},
        {"csl-file",
         "csl file",
         "path to a .bmq_csl file",
         balcl::TypeInfo(&arguments.d_cslFile,
                         CommandLineArguments::isValidFileName),
         balcl::OccurrenceInfo::e_OPTIONAL},
        {"csl-from-begin",
         "start from begin",
         "force to iterate CSL file from the beginning. By default: iterate "
         "from the latest snapshot",
         balcl::TypeInfo(&arguments.d_cslFromBegin),
         balcl::OccurrenceInfo::e_OPTIONAL},
        {"print-mode",
         "print mode",
         "can be one of the following {human|json-pretty|json-line}",
         balcl::TypeInfo(&arguments.d_printMode,
                         CommandLineArguments::isValidPrintMode),
         balcl::OccurrenceInfo("human")},
        {"guid",
         "guid",
         "message guid",
         balcl::TypeInfo(&arguments.d_guid),
         balcl::OccurrenceInfo::e_OPTIONAL},
        {"seqnum",
         "seqnum",
         "message composite sequence number",
         balcl::TypeInfo(&arguments.d_seqNum),
         balcl::OccurrenceInfo::e_OPTIONAL},
        {"offset",
         "offset",
         "message offset",
         balcl::TypeInfo(&arguments.d_offset),
         balcl::OccurrenceInfo::e_OPTIONAL},
        {"queue-name",
         "queue name",
         "message queue name",
         balcl::TypeInfo(&arguments.d_queueName),
         balcl::OccurrenceInfo::e_OPTIONAL},
        {"queue-key",
         "queue key",
         "message queue key",
         balcl::TypeInfo(&arguments.d_queueKey),
         balcl::OccurrenceInfo::e_OPTIONAL},
        {"timestamp-gt",
         "timestamp greater than",
         "lower timestamp bound",
         balcl::TypeInfo(&arguments.d_timestampGt),
         balcl::OccurrenceInfo::e_OPTIONAL},
        {"timestamp-lt",
         "timestamp less than",
         "higher timestamp bound",
         balcl::TypeInfo(&arguments.d_timestampLt),
         balcl::OccurrenceInfo::e_OPTIONAL},
        {"seqnum-gt",
         "message composite sequence number greater than",
         "lower record sequence number bound, defined in form "
         "<leaseId-sequenceNumber>",
         balcl::TypeInfo(&arguments.d_seqNumGt),
         balcl::OccurrenceInfo::e_OPTIONAL},
        {"seqnum-lt",
         "message composite sequence number less than",
         "higher sequence number bound, defined in form "
         "<leaseId-sequenceNumber>",
         balcl::TypeInfo(&arguments.d_seqNumLt),
         balcl::OccurrenceInfo::e_OPTIONAL},
        {"offset-gt",
         "message offset greater than",
         "lower record offset bound",
         balcl::TypeInfo(&arguments.d_offsetGt),
         balcl::OccurrenceInfo::e_OPTIONAL},
        {"offset-lt",
         "message offset less than",
         "higher record offset bound",
         balcl::TypeInfo(&arguments.d_offsetLt),
         balcl::OccurrenceInfo::e_OPTIONAL},
        {"outstanding",
         "only outstanding",
         "show only outstanding (not deleted) messages",
         balcl::TypeInfo(&arguments.d_outstanding),
         balcl::OccurrenceInfo::e_OPTIONAL},
        {"confirmed",
         "only confirmed",
         "show only messages, confirmed by all the appId's",
         balcl::TypeInfo(&arguments.d_confirmed),
         balcl::OccurrenceInfo::e_OPTIONAL},
        {"partially-confirmed",
         "only partially confirmed",
         "show only messages, confirmed by some of the appId's",
         balcl::TypeInfo(&arguments.d_partiallyConfirmed),
         balcl::OccurrenceInfo::e_OPTIONAL},
        {"details",
         "details",
         "specify if you need message details",
         balcl::TypeInfo(&arguments.d_details),
         balcl::OccurrenceInfo::e_OPTIONAL},
        {"dump-payload",
         "dump payload",
         "specify if you need message payload",
         balcl::TypeInfo(&arguments.d_dumpPayload),
         balcl::OccurrenceInfo::e_OPTIONAL},
        {"dump-limit",
         "dump limit",
         "limit of payload output",
         balcl::TypeInfo(&arguments.d_dumpLimit),
         balcl::OccurrenceInfo(1024)},
        {"summary",
         "summary",
         "summary of all matching records",
         balcl::TypeInfo(&arguments.d_summary),
         balcl::OccurrenceInfo::e_OPTIONAL},
        {"min-records-per-queue",
         "min records per queue",
         "min number of records per queue for detailed info to be displayed",
         balcl::TypeInfo(&arguments.d_minRecordsPerQueue),
         balcl::OccurrenceInfo(0LL)},
        {"summary-queues-limit",
         "queues limit",
         "limit of queues to display in CSL file summary",
         balcl::TypeInfo(&arguments.d_cslSummaryQueuesLimit),
         balcl::OccurrenceInfo(50)},
        {"h|help",
         "help",
         "print usage)",
         balcl::TypeInfo(&showHelp),
         balcl::OccurrenceInfo::e_OPTIONAL}};
    balcl::CommandLine commandLine(specTable);
    if (commandLine.parse(argc, argv) != 0 || showHelp) {
        commandLine.printUsage();
        return false;  // RETURN
    }

    bsl::string error;
    if (!arguments.validate(&error, allocator)) {
        bsl::cerr << "Arguments validation failed:\n" << error;
        return false;  // RETURN
    }

    return true;
}

// ====
// main
// ====

int main(int argc, const char* argv[])
{
    enum RcEnum {
        // Enum for the various RC error categories
        rc_SUCCESS                       = 0,
        rc_ARGUMENTS_PARSING_FAILED      = -1,
        rc_FILE_MANAGER_INIT_FAILED      = -2,
        rc_COMMAND_PROCESSOR_INIT_FAILED = -3
    };

    // Init allocator
    bslma::Allocator* allocator = bslma::Default::allocator();

    // Arguments parsing
    CommandLineArguments arguments(allocator);
    if (!parseArgs(arguments, argc, argv, allocator)) {
        return rc_ARGUMENTS_PARSING_FAILED;  // RETURN
    }

    // Create parameters
    Parameters parameters(arguments, allocator);

    // Create file manager
    bslma::ManagedPtr<FileManager> fileManager;
    try {
        fileManager.load(new (*allocator)
                             FileManagerImpl(arguments.d_journalFile,
                                             arguments.d_dataFile,
                                             arguments.d_cslFile,
                                             arguments.d_cslFromBegin,
                                             allocator));
        if (!arguments.d_cslFile.empty()) {
            fileManager->fillQueueMapFromCslFile(&parameters.d_queueMap);
            parameters.validateQueueNames();
        }
    }
    catch (const bsl::exception& e) {
        bsl::cerr << e.what();
        return rc_FILE_MANAGER_INIT_FAILED;  // RETURN
    }

    // Create command processor
    bslma::ManagedPtr<CommandProcessor> processor =
        CommandProcessorFactory::createCommandProcessor(&parameters,
                                                        fileManager,
                                                        bsl::cout,
                                                        allocator);

    if (!processor) {
        bsl::cerr << "Failed to create processor";
        return rc_COMMAND_PROCESSOR_INIT_FAILED;  // RETURN
    }

    // Run command processor
    processor->process();

    return rc_SUCCESS;
}