PTBatcherGUI.cpp

Go to the documentation of this file.

// -*- c-basic-offset: 4 -*-

#include "PTBatcherGUI.h"
#include <wx/cshelp.h>
#if defined __WXMSW__ || defined UNIX_SELF_CONTAINED_BUNDLE
#include <wx/stdpaths.h>
#endif
#include "lensdb/LensDB.h"
#include "base_wx/wxutils.h"

// make wxwindows use this class as the main application
#if defined USE_GDKBACKEND_X11
// wxWidgets does not support wxTaskBarIcon::IsAvailable on Wayland
// so until it is fixed upstream enforce using x11 backendj
// see ticket http://trac.wxwidgets.org/ticket/17779
#warning Using Hugin with hard coded GDK_BACKEND=x11
wxIMPLEMENT_WX_THEME_SUPPORT
wxIMPLEMENT_APP_NO_MAIN(PTBatcherGUI);
#include <stdlib.h>
int main(int argc, char **argv)
{   
    wxDISABLE_DEBUG_SUPPORT();
    char backend[]="GDK_BACKEND=x11";
    putenv(backend);
    return wxEntry(argc, argv);
};
#else
wxIMPLEMENT_APP(PTBatcherGUI);
#endif

bool PTBatcherGUI::OnInit()
{
#if wxUSE_ON_FATAL_EXCEPTION
    wxHandleFatalExceptions();
#endif
    // Required to access the preferences of hugin
    SetAppName("hugin");
#if defined __WXMSW__ && wxCHECK_VERSION(3,3,0)
    // automatically switch between light and dark mode
    SetAppearance(Appearance::System);
#endif
#if defined __WXGTK__
    CheckConfigFilename();
#endif

    // need to explicitly initialize locale for C++ library/runtime
    setlocale(LC_ALL, "");
#if defined __WXMSW__
    int localeID = wxConfigBase::Get()->Read("language", (long) wxLANGUAGE_DEFAULT);
    m_locale.Init(localeID);
#else
    m_locale.Init(wxLANGUAGE_DEFAULT);
#endif
    // initialize help provider
    wxHelpControllerHelpProvider* provider = new wxHelpControllerHelpProvider;
    wxHelpProvider::Set(provider);

    // setup the environment for the different operating systems
#if defined __WXMSW__
    wxFileName exePath(wxStandardPaths::Get().GetExecutablePath());
    exePath.RemoveLastDir();
    const wxString huginRoot(exePath.GetPath(wxPATH_GET_VOLUME | wxPATH_GET_SEPARATOR));
    m_xrcPrefix = huginRoot + "share\\hugin\\xrc\\";

    // locale setup
    m_locale.AddCatalogLookupPathPrefix(huginRoot + "share\\locale");
#elif defined __WXMAC__ && defined MAC_SELF_CONTAINED_BUNDLE
    {
        wxString exec_path = MacGetPathToBundledResourceFile(CFSTR("xrc"));
        if(exec_path != wxEmptyString)
        {
            m_xrcPrefix = exec_path + "/";
        }
        else
        {
            hugin_utils::HuginMessageBox(_("xrc directory not found in bundle"), _("PTBatcherGUI"), wxOK|wxICON_ERROR, wxGetActiveWindow());
            return false;
        }

    }

#elif defined UNIX_SELF_CONTAINED_BUNDLE
    // initialize paths
    {
      wxFileName exePath(wxStandardPaths::Get().GetExecutablePath());
      exePath.RemoveLastDir();
      const wxString huginRoot(exePath.GetPath(wxPATH_GET_VOLUME | wxPATH_GET_SEPARATOR));
      m_xrcPrefix = huginRoot + "share/hugin/xrc/";

      // locale setup
      m_locale.AddCatalogLookupPathPrefix(huginRoot + "share/locale");
    }
#else
    // add the locale directory specified during configure
    m_xrcPrefix = INSTALL_XRC_DIR;
    m_locale.AddCatalogLookupPathPrefix(INSTALL_LOCALE_DIR);
#endif

    // set the name of locale recource to look for
    m_locale.AddCatalog("hugin");

    const wxString name = wxString::Format(_T("PTBatcherGUI-%s"), wxGetUserId().c_str());
    m_checker = new wxSingleInstanceChecker(name+".lock",wxFileName::GetTempDir());
    bool IsFirstInstance=(!m_checker->IsAnotherRunning());

    if(IsFirstInstance)
    {
        if ( ! wxFile::Exists(m_xrcPrefix + "/batch_frame.xrc") )
        {
            hugin_utils::HuginMessageBox(wxString::Format(_("xrc directory not found, hugin needs to be properly installed\nTried Path: %s"), m_xrcPrefix), _("PTBatcherGUI"), wxOK | wxICON_ERROR, wxGetActiveWindow());
            return false;
        }
        // initialize image handlers
        wxInitAllImageHandlers();

        // Initialize all the XRC handlers.
        wxXmlResource::Get()->InitAllHandlers();
        wxXmlResource::Get()->AddHandler(new ProjectListBoxXmlHandler());
        // load XRC files
        wxXmlResource::Get()->Load(m_xrcPrefix + "batch_frame.xrc");
        wxXmlResource::Get()->Load(m_xrcPrefix + "batch_toolbar.xrc");
        wxXmlResource::Get()->Load(m_xrcPrefix + "batch_menu.xrc");
        wxXmlResource::Get()->Load(m_xrcPrefix + "lensdb_dialogs.xrc");
        wxXmlResource::Get()->Load(m_xrcPrefix + "dlg_warning.xrc");
    };

    // parse arguments
    static const wxCmdLineEntryDesc cmdLineDesc[] =
    {
        {
            wxCMD_LINE_SWITCH, "h", "help", "show this help message",
            wxCMD_LINE_VAL_NONE, wxCMD_LINE_OPTION_HELP
        },
        { wxCMD_LINE_SWITCH, "b", "batch",  "run batch immediately" },
        { wxCMD_LINE_SWITCH, "o", "overwrite",  "overwrite previous files without asking" },
        { wxCMD_LINE_SWITCH, "s", "shutdown",  "shutdown computer after batch is complete" },
        { wxCMD_LINE_SWITCH, "v", "verbose",  "show verbose output when processing projects" },
        { wxCMD_LINE_SWITCH, "a", "assistant", "run the assistant on the given projects" },
        { wxCMD_LINE_OPTION, "u", "user-defined", "use the given user defined sequence" },
        {
            wxCMD_LINE_PARAM,  NULL, NULL, "stitch_project.pto [output prefix]|assistant_project.pto",
            wxCMD_LINE_VAL_STRING, wxCMD_LINE_PARAM_OPTIONAL + wxCMD_LINE_PARAM_MULTIPLE
        },
        { wxCMD_LINE_NONE }
    };
    wxCmdLineParser parser(cmdLineDesc, argc, argv);

    switch ( parser.Parse() )
    {
        case -1: // -h or --help was given, and help displayed so exit
            return false;
            break;
        case 0:  // all is well
            break;
        default:
            wxLogError(_("Syntax error in parameters detected, aborting."));
            return false;
            break;
    }

    wxClient client;
    wxConnectionBase* conn;
    wxString servername;
#ifdef _WIN32
    servername=name;
#else
    servername=wxFileName::GetTempDir()+wxFileName::GetPathSeparator()+name+".ipc";
#endif
    if(IsFirstInstance)
    {
        m_frame = new BatchFrame(&m_locale,m_xrcPrefix);
        m_frame->RestoreSize();
        // init help system
        provider->SetHelpController(&m_frame->GetHelpController());
#ifdef __WXMSW__
        m_frame->GetHelpController().Initialize(m_xrcPrefix + "data/hugin_help_en_EN.chm");
#else
#if wxUSE_WXHTML_HELP
        // using wxHtmlHelpController
#if defined __WXMAC__ && defined MAC_SELF_CONTAINED_BUNDLE
        // On Mac, xrc/data/help_LOCALE should be in the bundle as LOCALE.lproj/help
        // which we can rely on the operating sytem to pick the right locale's.
        wxString strFile = MacGetPathToBundledResourceFile(CFSTR("help"));
        if (!strFile.IsEmpty())
        {
            m_frame->GetHelpController().AddBook(wxFileName(strFile + "/hugin_help_en_EN.hhp"));
        }
        else
        {
            wxLogError(wxString::Format("Could not find help directory in the bundle", strFile.c_str()));
            return false;
        }
#else
        m_frame->GetHelpController().AddBook(wxFileName(m_xrcPrefix + "data/help_en_EN/hugin_help_en_EN.hhp"));
#endif
#else
        // using wxExtHelpController
        m_frame->GetHelpController().Initialize(Initialize(m_xrcPrefix + "data/help_en_EN"));
#endif
#endif

        SetTopWindow(m_frame);
        if(!(m_frame->IsStartedMinimized()))
        {
            m_frame->Show(true);
        };
        m_server = new BatchIPCServer();
        if (!m_server->Create(servername))
        {
            delete m_server;
            m_server = NULL;
        };
    }
    else
    {
        conn=client.MakeConnection(wxEmptyString, servername, IPC_START);
        if(!conn)
        {
            return false;
        }
    };

    size_t count = 0;
    if (parser.Found("a"))
    {
        //added assistant files
        wxString userDefined;
        parser.Found("u", &userDefined);
        while (parser.GetParamCount() > count)
        {
            wxString param = parser.GetParam(count);
            count++;
            wxFileName name(param);
            name.MakeAbsolute();
            if (name.FileExists())
            {
                //only add existing pto files
                if (name.GetExt().CmpNoCase("pto") == 0)
                {
                    if (IsFirstInstance)
                    {
                        m_frame->AddToList(name.GetFullPath(), Project::DETECTING, userDefined);
                    }
                    else
                    {
                        conn->Request("D " + name.GetFullPath());
                        if (!userDefined.IsEmpty())
                        {
                            conn->Request("U " + userDefined);
                        };
                    };
                };
            };
        };
    }
    else
    {
        bool projectSpecified = false;
        wxString userDefined;
        parser.Found("u", &userDefined);
        //we collect all parameters - all project files <and their output prefixes>
        while (parser.GetParamCount() > count)
        {
            wxString param = parser.GetParam(count);
            count++;
            if (!projectSpecified)      //next parameter must be new script file
            {
                wxFileName name(param);
                name.MakeAbsolute();
                if (IsFirstInstance)
                {
                    m_frame->AddToList(name.GetFullPath(), Project::STITCHING, userDefined);
                }
                else
                {
                    conn->Request("A " + name.GetFullPath());
                    if (!userDefined.IsEmpty())
                    {
                        conn->Request("U " + userDefined);
                    };
                }
                projectSpecified = true;
            }
            else        //parameter could be previous project's output prefix
            {
                wxFileName fn(param);
                fn.MakeAbsolute();
                if (!fn.HasExt())       //if there is no extension we have a prefix
                {
                    if (IsFirstInstance)
                    {
                        m_frame->ChangePrefix(-1, fn.GetFullPath());
                    }
                    else
                    {
                        conn->Request("P " + fn.GetFullPath());
                    };
                    projectSpecified = false;
                }
                else
                {
                    wxString ext = fn.GetExt();
                    //we may still have a prefix, but with added image extension
                    if (ext.CmpNoCase("jpg") == 0 || ext.CmpNoCase("jpeg") == 0 ||
                        ext.CmpNoCase("tif") == 0 || ext.CmpNoCase("tiff") == 0 ||
                        ext.CmpNoCase("png") == 0 || ext.CmpNoCase("exr") == 0 ||
                        ext.CmpNoCase("pnm") == 0 || ext.CmpNoCase("hdr") == 0)
                    {
                        //extension will be removed before stitch, so there is no need to do it now
                        if (IsFirstInstance)
                        {
                            m_frame->ChangePrefix(-1, fn.GetFullPath());
                        }
                        else
                        {
                            conn->Request("P " + fn.GetFullPath());
                        };
                        projectSpecified = false;
                    }
                    else //if parameter has a different extension we presume it is a new script file
                    {
                        //we add the new project
                        if (IsFirstInstance)
                        {
                            m_frame->AddToList(fn.GetFullPath(), Project::STITCHING, userDefined);
                        }
                        else
                        {
                            conn->Request("A " + fn.GetFullPath());
                            if (!userDefined.IsEmpty())
                            {
                                conn->Request("U " + userDefined);
                            };
                        }
                        projectSpecified = true;
                    }
                } //else of if(!fn.HasExt())
            }
        }
    };

    if(IsFirstInstance)
    {
        wxConfigBase* config=wxConfigBase::Get();
        if (parser.Found("s"))
        {
            config->DeleteEntry("/BatchFrame/ShutdownCheck");
#if !defined __WXMAC__ && !defined __WXOSX_COCOA__
            // wxMac has not wxShutdown
            config->Write("/BatchFrame/AtEnd", static_cast<long>(Batch::SHUTDOWN));
#endif
        }
        if (parser.Found("o"))
        {
            config->Write("/BatchFrame/OverwriteCheck", 1l);
        }
        if (parser.Found("v"))
        {
            config->Write("/BatchFrame/VerboseCheck", 1l);
        }
        config->Flush();
    }
    else
    {
        if (parser.Found("s"))
        {
#if !defined __WXMAC__ && !defined __WXOSX_COCOA__
            // wxMac has not wxShutdown
            conn->Request("SetShutdownCheck");
#endif
        }
        if (parser.Found("o"))
        {
            conn->Request("SetOverwriteCheck");
        }
        if (parser.Found("v"))
        {
            conn->Request("SetVerboseCheck");
        }
        conn->Request("BringWindowToTop");
        if(parser.Found("b"))
        {
            conn->Request("RunBatch");
        }
        conn->Disconnect();
        delete conn;
        delete m_checker;
        return false;
    };
    m_frame->SetCheckboxes();
    m_frame->PropagateDefaults();
    //deactivate verbose output if started minimized
    if(m_frame->IsStartedMinimized())
    {
        m_frame->SetInternalVerbose(false);
    };
    if (parser.Found("b") )
    {
        m_frame->RunBatch();
    }
#ifdef __WXMAC__
    // if there are command line parameters they are handled all by the code above
    // but wxMac calls also MacOpenFiles after OnInit with the command line
    // parameters again, so the files get added twice. To prevent this we
    // reset the internal file list for MacOpenFiles here
    // but we need to process the files when PTBatcherGUI is called from finder
    // with an open files AppleEvent, in this case the argv is empty (except argc[0])
    // and we don't want to skip the MacOpenFile function
    if (argc > 1)
    {
        wxArrayString emptyFiles;
        OSXStoreOpenFiles(emptyFiles);
    };
#endif
    return true;
}

int PTBatcherGUI::OnExit()
{
    HuginBase::LensDB::LensDB::Clean();
    delete m_checker;
    delete m_server;
    delete wxHelpProvider::Set(NULL);
    return 0;
}

#if wxUSE_ON_FATAL_EXCEPTION
void PTBatcherGUI::OnFatalException()
{
    GenerateReport(wxDebugReport::Context_Exception);
};
#endif

#ifdef __WXMAC__
// wx calls this method when the app gets "Open files" AppleEvent
void PTBatcherGUI::MacOpenFiles(const wxArrayString &fileNames) 
{
    if(m_frame)
    {
        for (int i = 0; i < fileNames.GetCount(); ++i)
        {
            wxFileName fn(fileNames[i]);
            m_frame->AddToList(fn.GetFullPath());
        };
    };
}
#endif

const void* BatchIPCConnection::OnRequest(const wxString& topic, const wxString& item, size_t* size, wxIPCFormat format)
{
    *size=wxNO_LEN;
    BatchFrame* MyBatchFrame=wxGetApp().GetFrame();
    if(item.Left(1)=="A")
    {
        MyBatchFrame->AddToList(item.Mid(2));
        return wxEmptyString;
    };
    if(item.Left(1)=="D")
    {
        MyBatchFrame->AddToList(item.Mid(2), Project::DETECTING);
        return wxEmptyString;
    };
    if(item.Left(1)=="P")
    {
        MyBatchFrame->ChangePrefix(-1,item.Mid(2));
        return wxEmptyString;
    };
    if (item.Left(1) == "U")
    {
        MyBatchFrame->ChangeUserDefined(-1, item.Mid(2));
        return wxEmptyString;
    };
    wxCommandEvent event;
    event.SetInt(1);
#if !defined __WXMAC__ && !defined __WXOSX_COCOA__
    // wxMac has not wxShutdown
    if(item=="SetShutdownCheck")
        if (MyBatchFrame->GetEndTask()!=Batch::SHUTDOWN)
        {
            wxCommandEvent choiceEvent;
            choiceEvent.SetInt(Batch::SHUTDOWN);
            MyBatchFrame->OnChoiceEnd(choiceEvent);
            MyBatchFrame->SetCheckboxes();
        };
#endif
    if(item=="SetOverwriteCheck")
        if(!MyBatchFrame->GetCheckOverwrite())
        {
            MyBatchFrame->OnCheckOverwrite(event);
            MyBatchFrame->SetCheckboxes();
        };
    if(item=="SetVerboseCheck")
        if(!MyBatchFrame->GetCheckVerbose())
        {
            MyBatchFrame->OnCheckVerbose(event);
            MyBatchFrame->SetCheckboxes();
        };
    if(item=="BringWindowToTop")
    {
        MyBatchFrame->RequestUserAttention();
    }
    if(item=="RunBatch")
    {
        wxCommandEvent myEvent(wxEVT_COMMAND_TOOL_CLICKED ,XRCID("tool_start"));
        MyBatchFrame->GetEventHandler()->AddPendingEvent(myEvent);
    };
    return wxEmptyString;
};

wxConnectionBase* BatchIPCServer::OnAcceptConnection (const wxString& topic)
{
    if(topic==IPC_START)
    {
        return new BatchIPCConnection;
    }
    return NULL;
};