xmlappsaver.cpp

Go to the documentation of this file.

/*
 * SPDX-FileCopyrightText: 2006-2021 Istituto Italiano di Tecnologia (IIT)
 * SPDX-License-Identifier: BSD-3-Clause
 */
 
#include <yarp/manager/xmlappsaver.h>
#include <yarp/manager/utility.h>
#include <dirent.h>
 
#include <algorithm>
#include <cctype>
#include <string>
#include <fstream>
 
#include <tinyxml.h>
 
 
using namespace yarp::manager;
 
 
XmlAppSaver::XmlAppSaver(const char* szFileName)
{
    if (szFileName) {
        strFileName = szFileName;
    }
}
 
bool XmlAppSaver::save(Application* application)
{
    if (!strFileName.size()) {
        return serialXml(application, application->getXmlFile());
    }
 
    return serialXml(application, strFileName.c_str());
}
 
XmlAppSaver::~XmlAppSaver() = default;
 
bool XmlAppSaver::serialXml(Application* app, const char* szFile)
{
 
    // updating application xml file name
    app->setXmlFile(szFile);
 
    ErrorLogger* logger  = ErrorLogger::Instance();
 
    TiXmlDocument doc; //(szFile);
    auto* root = new TiXmlElement("application");
    doc.LinkEndChild( root );
    auto* appName = new TiXmlElement("name");  //are all these NEW ok?
    appName->LinkEndChild(new TiXmlText(app->getName()));
    root->LinkEndChild(appName);
 
 
    if (strcmp(app->getDescription(), "") != 0)
    {
        auto* desc= new TiXmlElement( "description");
        desc->LinkEndChild(new TiXmlText( app->getDescription()));
        root->LinkEndChild(desc);
    }
 
    if(strcmp (app->getVersion(), "") != 0)
    {
        auto* vers= new TiXmlElement( "version");
        vers->LinkEndChild(new TiXmlText( app->getVersion()));
        root->LinkEndChild(vers);
 
    }
 
    /*
     * TODO: setting prefix of the main application is inactivated.
     * Check this should be supported in future or not!
     */
    /*
    if(strcmp (app->getPrefix(), ""))
        {
        TiXmlElement * prefix= new TiXmlElement( "prefix");
        prefix->LinkEndChild(new TiXmlText( app->getPrefix()));
        root->LinkEndChild(prefix);
 
    }
    */
 
    if(app->authorCount()>0)
    {
        auto* auths=new TiXmlElement("authors");
        for (int i=0; i<app->authorCount(); i++)
        {
            //app->getAuthorAt(i);
            auto* auth=new TiXmlElement("author");
            auth->SetAttribute("email", app->getAuthorAt(i).getEmail());
            auth->LinkEndChild(new TiXmlText(app->getAuthorAt(i).getName()));
            auths->LinkEndChild(auth);
        }
        root->LinkEndChild(auths);
    }
 
    // iterate over modules
    {
        int nModules=app->imoduleCount();
        for (int modCt=0; modCt<nModules; ++modCt)
        {
            auto* newMod = new TiXmlElement("module");
            root->LinkEndChild(newMod); //add module element
            ModuleInterface curMod=app->getImoduleAt(modCt);
 
            auto* name = new TiXmlElement("name");
            name->LinkEndChild(new TiXmlText(curMod.getName()));
            newMod->LinkEndChild(name);
 
            auto* parameters=new TiXmlElement("parameters");
            parameters->LinkEndChild(new TiXmlText(curMod.getParam()));
            newMod->LinkEndChild(parameters);
 
            auto* node = new TiXmlElement("node");
            node->LinkEndChild(new TiXmlText(curMod.getHost())); //is host the same as node?
            newMod->LinkEndChild(node);
 
            auto* prefix=new TiXmlElement("prefix");
            prefix->LinkEndChild(new TiXmlText(curMod.getPrefix()));
            newMod->LinkEndChild(prefix);
 
            if(strcmp(curMod.getStdio(), "") != 0)
            {
                auto* stdio=new TiXmlElement("stdio");
                stdio->LinkEndChild(new TiXmlText(curMod.getStdio()));
                newMod->LinkEndChild(stdio);
            }
 
            if(strcmp(curMod.getWorkDir(), "") != 0)
            {
                auto* workdir=new TiXmlElement("workdir");
                workdir->LinkEndChild(new TiXmlText(curMod.getWorkDir()));
                newMod->LinkEndChild(workdir);
            }
 
            if(strcmp(curMod.getBroker(), "") != 0)
            {
                auto* broker=new TiXmlElement("deployer");
                broker->LinkEndChild(new TiXmlText(curMod.getBroker()));
                newMod->LinkEndChild(broker);
            }
            /*
            if(curMod.getRank()>0) //TODO check here how is rank handled
            {
                TiXmlElement *rank=new TiXmlElement("rank");
                char str[256];
                sprintf(str,"%d", curMod.getRank());
                rank->LinkEndChild(new TiXmlText(str));
                newMod->LinkEndChild(rank);
            }
            */
 
            GraphicModel model = curMod.getModelBase();
            OSTRINGSTREAM txt;
            if(model.points.size()>0)
            {
                txt<<"(Pos (x "<<model.points[0].x<<") "<<"(y "<<model.points[0].y<<"))";
                auto* geometry=new TiXmlElement("geometry");
                geometry->LinkEndChild(new TiXmlText(txt.str().c_str()));
                newMod->LinkEndChild(geometry);
            }
        }
 
    }
 
    // iterate over embedded applications
    {
        int nApps=app->iapplicationCount();
        for (int appCt=0; appCt<nApps; ++appCt)
        {
            auto* newApp  = new TiXmlElement("application");
            root->LinkEndChild(newApp); //add application element
            ApplicationInterface curApp=app->getIapplicationAt(appCt);
 
            auto* name = new TiXmlElement("name");
            name->LinkEndChild(new TiXmlText(curApp.getName()));
            newApp->LinkEndChild(name);
 
 
            auto* prefix=new TiXmlElement("prefix");
            prefix->LinkEndChild(new TiXmlText(curApp.getPrefix()));
            newApp->LinkEndChild(prefix);
 
            GraphicModel model = curApp.getModelBase();
            OSTRINGSTREAM txt;
            if(model.points.size()>0)
            {
                txt<<"(Pos (x "<<model.points[0].x<<") "<<"(y "<<model.points[0].y<<"))";
                auto* geometry=new TiXmlElement("geometry");
                geometry->LinkEndChild(new TiXmlText(txt.str().c_str()));
                newApp->LinkEndChild(geometry);
            }
 
        }
    }
 
    // iterate over connections
    {
        int nConns=app->connectionCount();
        for (int connCt=0; connCt<nConns; ++connCt)
        {
            auto* newConn=new TiXmlElement("connection");
            Connection curConn=app->getConnectionAt(connCt);
 
            if (strlen(curConn.getId())) {
                newConn->SetAttribute("id", curConn.getId());
            }
 
            if (curConn.isPersistent()) {
                newConn->SetAttribute("persist", "true");
            }
 
            auto* from = new TiXmlElement("from");
            if (curConn.isExternalFrom()) {
                from->SetAttribute("external", "true");
            }
            from->LinkEndChild(new TiXmlText(curConn.from()));
            newConn->LinkEndChild(from);
 
            auto* to = new TiXmlElement("to");
            if (curConn.isExternalTo()) {
                to->SetAttribute("external", "true");
            }
            to->LinkEndChild(new TiXmlText(curConn.to()));
            newConn->LinkEndChild(to);
 
            auto* protocol = new TiXmlElement("protocol");
            protocol->LinkEndChild(new TiXmlText(curConn.carrier()));
            newConn->LinkEndChild(protocol);
 
            GraphicModel model = curConn.getModelBase();
            OSTRINGSTREAM txt;
            if(model.points.size()>0)
            {
                txt<<"(Pos ";
                for (auto& point : model.points) {
                    txt << "((x " << point.x << ") "
                        << "(y " << point.y << ")) ";
                }
                txt<<" )";
                auto* geometry=new TiXmlElement("geometry");
                geometry->LinkEndChild(new TiXmlText(txt.str().c_str()));
                newConn->LinkEndChild(geometry);
            }
 
            root->LinkEndChild(newConn);
        }
 
    }
 
    // iterate over arbitrators
        for(int i=0; i<app->arbitratorCount(); i++)
        {
            Arbitrator& arb = app->getArbitratorAt(i);
            auto* newArb = new TiXmlElement("arbitrator");
 
            auto* port = new TiXmlElement("port");
            port->LinkEndChild(new TiXmlText(arb.getPort()));
            newArb->LinkEndChild(port);
 
            std::map<std::string, std::string> &rules = arb.getRuleMap();
            for(auto& it : rules)
            {
                auto* rule = new TiXmlElement("rule");
                rule->SetAttribute("connection", it.first.c_str());
                rule->LinkEndChild(new TiXmlText(it.second.c_str()));
                newArb->LinkEndChild(rule);
            }
 
            GraphicModel model = arb.getModelBase();
            OSTRINGSTREAM txt;
            if(model.points.size()>0)
            {
                txt<<"(Pos ";
                for (auto& point : model.points) {
                    txt << "((x " << point.x << ") "
                        << "(y " << point.y << ")) ";
                }
                txt<<" )";
                auto* geometry=new TiXmlElement("geometry");
                geometry->LinkEndChild(new TiXmlText(txt.str().c_str()));
                newArb->LinkEndChild(geometry);
            }
            root->LinkEndChild(newArb);
        }
 
 
    bool ok=doc.SaveFile(app->getXmlFile());
    if (!ok)
    {
 
        OSTRINGSTREAM err;
        err<<"tinyXml error for file " << app->getXmlFile();
        if (doc.Error()) {
            err << " at line " << doc.ErrorRow() << ", column " << doc.ErrorCol() << ": " << doc.ErrorDesc();
        }
        logger->addError(err);
        err <<"\n";
        return false;
    } else {
        return true;
    }
}