remote_cgiapp.cpp

Go to the documentation of this file.

Go to the SVN repository for this file.

/*  $Id: remote_cgiapp.cpp 92112 2020-12-22 16:22:46Z grichenk $
 * ===========================================================================
 *
 *                            PUBLIC DOMAIN NOTICE
 *               National Center for Biotechnology Information
 *
 *  This software/database is a "United States Government Work" under the
 *  terms of the United States Copyright Act.  It was written as part of
 *  the author's official duties as a United States Government employee and
 *  thus cannot be copyrighted.  This software/database is freely available
 *  to the public for use. The National Library of Medicine and the U.S.
 *  Government have not placed any restriction on its use or reproduction.
 *
 *  Although all reasonable efforts have been taken to ensure the accuracy
 *  and reliability of the software and data, the NLM and the U.S.
 *  Government do not and cannot warrant the performance or results that
 *  may be obtained by using this software or data. The NLM and the U.S.
 *  Government disclaim all warranties, express or implied, including
 *  warranties of performance, merchantability or fitness for any particular
 *  purpose.
 *
 *  Please cite the author in any work or product based on this material.
 *
 * ===========================================================================
 *
 * Author:  Maxim Didenko
 *
 * File Description:
 *
 */
 
#include <ncbi_pch.hpp>
 
#include <misc/grid_cgi/remote_cgiapp.hpp>
 
#define GRID_APP_NAME "remote_cgiapp"
 
#include <connect/services/grid_app_version_info.hpp>
 
#if defined(NCBI_OS_UNIX)
# include <corelib/ncbi_process.hpp>
# include <signal.h>
 
/// @internal
extern "C" 
void CgiGridWorker_SignalHandler( int )
{
    try {
        ncbi::CRemoteCgiApp* app = 
            dynamic_cast<ncbi::CRemoteCgiApp*>(ncbi::CNcbiApplication::Instance());
        if (app) {
            app->RequestShutdown();
        }
    }
    catch (...) {}   // Make sure we don't throw an exception through the "C" layer
}
#endif
 
 
BEGIN_NCBI_SCOPE
 
/////////////////////////////////////////////////////////////////////////////
//
 
class CCgiWorkerNodeJob : public IWorkerNodeJob
{
public:
    CCgiWorkerNodeJob(CRemoteCgiApp& app) : m_App(app) {}
    virtual ~CCgiWorkerNodeJob() {} 
 
    int Do(CWorkerNodeJobContext& job_context)
    {
        CNcbiIstream& is = job_context.GetIStream();
        CNcbiOstream& os = job_context.GetOStream();
 
        int ret = m_App.RunJob(is, os, job_context);
 
        job_context.CommitJob();
        return ret;
    }
 
private:
    CRemoteCgiApp& m_App;
};
 
class CCgiWorkerNodeJobFactory : public IWorkerNodeJobFactory
{
public:
    CCgiWorkerNodeJobFactory(CRemoteCgiApp& app): m_App(app) {}
    virtual IWorkerNodeJob* CreateInstance(void)
    {
        return new  CCgiWorkerNodeJob(m_App);
    }
    virtual string GetJobVersion() const
    {
        return GRID_APP_VERSION_INFO;
    }
    virtual string GetAppName() const
    {
        return GRID_APP_NAME;
    }
    virtual string GetAppVersion() const
    {
        return GRID_APP_VERSION;
    }
 
private:
    CRemoteCgiApp& m_App;
};
 
 
/////////////////////////////////////////////////////////////////////////////
//
CRemoteCgiApp::CRemoteCgiApp()
    : m_JobContext(NULL)
{
    m_AppImpl.reset(new CGridWorkerNode(*this,
        new CCgiWorkerNodeJobFactory(*this)));
 
#if defined(NCBI_OS_UNIX)
    // attempt to get server gracefully shutdown on signal
    signal(SIGINT,  CgiGridWorker_SignalHandler);
    signal(SIGTERM, CgiGridWorker_SignalHandler);    
#endif
    // Enable parsing of std args
    DisableArgDescriptions(0);
}
 
void CRemoteCgiApp::Init(void)
{
    CCgiApplication::Init();
 
    unique_ptr<CArgDescriptions> arg_desc(new CArgDescriptions);
    // Specify USAGE context
    arg_desc->SetUsageContext(GetArguments().GetProgramBasename(),
                              "Worker Node");
    SetupArgDescriptions(arg_desc.release());
 
    IRWRegistry& reg = GetRWConfig();
    reg.Set("netcache_client", "cache_output", "true");
 
    m_AppImpl->Init();
}
 
void CRemoteCgiApp::SetupArgDescriptions(CArgDescriptions* arg_desc)
{
    arg_desc->AddOptionalKey("control_port", 
                             "control_port",
                             "A TCP port number",
                             CArgDescriptions::eInteger);
 
    CCgiApplication::SetupArgDescriptions(arg_desc);
}
 
int CRemoteCgiApp::Run(void)
{
    m_AppImpl->ForceSingleThread();
    return m_AppImpl->Run();
}
 
void CRemoteCgiApp::RequestShutdown()
{
    if (m_AppImpl.get())
        m_AppImpl->RequestShutdown();
}
 
string CRemoteCgiApp::GetJobVersion() const
{
    return GRID_APP_VERSION_INFO;
}
 
int CRemoteCgiApp::RunJob(CNcbiIstream& is, CNcbiOstream& os,
                              CWorkerNodeJobContext& job_context)
{
    unique_ptr<CCgiContext> cgi_context( 
                         new CCgiContext(*this, &is, &os,
                         m_RequestFlags | CCgiRequest::fSetDiagProperties) );
 
    m_JobContext = &job_context;
    CDiagRestorer diag_restorer;
 
    int ret;
    try {
        ConfigureDiagnostics(*cgi_context);
        ret = CCgiContext::ProcessCORSRequest(
            cgi_context->GetRequest(), cgi_context->GetResponse()) ?
            0 : ProcessRequest(*cgi_context);
        OnEvent(ret == 0 ? eSuccess : eError, ret);
        cgi_context->GetResponse().Finalize();
        OnEvent(eExit, ret);
    } catch (exception& ex) {
        ret = OnException(ex, os);
        OnEvent(eException, ret);
    }
    OnEvent(eEndRequest, 120);
    OnEvent(eExit, ret);
    m_JobContext = NULL;
    return ret;
}
 
void  CRemoteCgiApp::PutProgressMessage(const string& msg, bool send_immediately)
{
    if (m_JobContext)
        m_JobContext->PutProgressMessage(msg, send_immediately);
}
 
 
/////////////////////////////////////////////////////////////////////////////
 
END_NCBI_SCOPE