OpenSpace/modules/fieldlinessequence/util/webfieldlinesmanager.cpp

/*****************************************************************************************
 *                                                                                       *
 * OpenSpace                                                                             *
 *                                                                                       *
 * Copyright (c) 2014-2019                                                               *
 *                                                                                       *
 * Permission is hereby granted, free of charge, to any person obtaining a copy of this  *
 * software and associated documentation files (the "Software"), to deal in the Software *
 * without restriction, including without limitation the rights to use, copy, modify,    *
 * merge, publish, distribute, sublicense, and/or sell copies of the Software, and to    *
 * permit persons to whom the Software is furnished to do so, subject to the following   *
 * conditions:                                                                           *
 *                                                                                       *
 * The above copyright notice and this permission notice shall be included in all copies *
 * or substantial portions of the Software.                                              *
 *                                                                                       *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,   *
 * INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A         *
 * PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT    *
 * HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF  *
 * CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE  *
 * OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.                                         *
 ****************************************************************************************/

#include <modules/fieldlinessequence/util/webfieldlinesmanager.h>

#include <ghoul/logging/logmanager.h>
#include <openspace/util/httprequest.h>
#include <modules/sync/syncs/httpsynchronization.h>
#include <ghoul/filesystem/filesystem.h>
#include <ghoul/filesystem/file.h>
#include <openspace/util/timemanager.h>
#include <openspace/engine/globals.h>


namespace {
    constexpr const char* _loggerCat = "FieldlinesSequence[ Web FLs Manager ]";
    
} // namespace

namespace openspace{
    
    
    // --------------------------- PUBLIC FUNCTIONS --------------------------- //
    void WebFieldlinesManager::initializeWebFieldlinesManager(std::string identifier, std::string fieldLineModelType, size_t& _nStates, std::vector<std::string>& _sourceFiles,
                                                              std::vector<double>& _startTimes)
    {
        
        _flsType = fieldLineModelType;

        // Initialize the sliding window
        _webFieldlinesWindow = WebFieldlinesWindow(_syncDir, "http://localhost:3000/", _sourceFiles, _startTimes, _nStates);

        
        LERROR("WebFieldlinesManager initialized");
        
    }
    
    // Make sure that the sync directory exists
    // Also creates a new directory in the web_fieldlines directory corresponding to the field line identifier
    std::string WebFieldlinesManager::initializeSyncDirectory(std::string identifier) {
        std::string path = absPath("${BASE}/sync/http/web_fieldlines") + FileSys.PathSeparator;
        
        if (!FileSys.directoryExists(path)) {
            FileSys.createDirectory(path);
        }
        path = absPath(path + identifier);
        if(!FileSys.directoryExists(path)) {
            FileSys.createDirectory(path);
        }
        
        _syncDir = path;
        return _syncDir;
    }
    
    // Temporary function - this should be moved to the worker. It's to download
    // the start latest line
    // this could be used to test the connection too
    void WebFieldlinesManager::preDownload(){
        // for some reason the fieldlines looks f-ed up when downloaded and read fromt his endpoint???? so weird
        // could it have something to do with endianness?
        //std::string url = "http://localhost:3000/WSA/fieldline/2019-05-02T20-00-00.000/PfssIo";
        std::string url = "http://localhost:3000/WSA/PfssIo2019-05-02T20-00-00.000.osfls"; // temp thing, should be the latest one
        std::string destinationpath = absPath(_syncDir + ghoul::filesystem::FileSystem::PathSeparator + "2019-05-02T20-00-00.000.osfls"); // what the downloaded filename is to be
        AsyncHttpFileDownload ashd = AsyncHttpFileDownload(url, destinationpath, HttpFileDownload::Overwrite::Yes);
        HttpRequest::RequestOptions opt = {};
        opt.requestTimeoutSeconds = 0;
        ashd.start(opt);
        ashd.wait();
        if(ashd.hasSucceeded() == true ){
            LERROR("succeeeded: " + destinationpath);
        }
        if(ashd.hasFailed() == true ){
            LERROR("failed: " + destinationpath);
        }
    }
    
    
    void WebFieldlinesManager::update(){
        const double openspaceTime = global::timeManager.time().j2000Seconds();
        
        // First it checks the time against the "bigger window" aka the long list of
        // timesteps we know are available online. If it's outside that we're gonna need a new one
        if(_webFieldlinesWindow.timeIsInTriggerTimesWebList(openspaceTime)){
            
            // Check if in window
            if(_webFieldlinesWindow.timeIsInWindow(openspaceTime)){
                //LERROR("we're in the window");
                const double openspaceTimeDirection = global::timeManager.deltaTime();
                // Check if in the edge of the window, so we can start downloading a new one
                if(_webFieldlinesWindow.timeIsInWindowMargin(openspaceTime, openspaceTimeDirection)){
                    // get new window
                    //LERROR("in margin, new window");
                    _webFieldlinesWindow.newWindow(openspaceTime);
                }
                else{
                    // If it's in the middle of the window, we can just sit back and relax
                    //LERROR("nothing happens, all gucci");
                }
                
            }else{
                // get new window
                _webFieldlinesWindow.newWindow(openspaceTime);
            }
        }
        else{
            _webFieldlinesWindow.getNewTriggerTimesWebList(openspaceTime);
        }
        
        
    }
    
    // --------------------------- PRIVATE FUNCTIONS --------------------------- //
    
    
    
    
    
    
    
    
    
    
    
    // --------------- OLD FUNCTIONS - some to be recycled --------------------- //
    
//    // dowload files specified in _filestodownload
//    void WebFieldlinesManager::downloadFieldlines(){
//        LERROR("starting download");
//        for (int index : _filesToDownload){
//
//
//            std::string downloadkey = _availableTriggertimes[index].second;
//            double timetrigger = _availableTriggertimes[index].first;
//
//            // download fieldlines file
//            //std::string destPath = downloadOsfls(downloadkey);
//
//            //add the timetrigger at the right place in the list
//            int i = 0;
//            if(*rfs_nStates > 0){
//                while(timetrigger > (*rfs_startTimes)[i]){
//                    i++;
//                    if( i == static_cast<int>(*rfs_nStates)) break;
//
//                }
//            }
//            //rfs_sourceFiles->insert(rfs_sourceFiles->begin() + i, destPath);
//            rfs_startTimes->insert(rfs_startTimes->begin() + i, timetrigger);
//            (*rfs_nStates) += 1;
//        }
//    }



    std::string WebFieldlinesManager::getDirectory(){
        return _syncDir;
    }


    
} // namespace openspace