cmdLineRequestProvider Class Reference

#include <cmdLineRequestProvider.h>

Inheritance diagram for cmdLineRequestProvider:

Collaboration diagram for cmdLineRequestProvider:

Public Member Functions
	cmdLineRequestProvider (decltype(requests) aRequests, decltype(delayedRequests) aDelayedRequests, decltype(parents) aParents, decltype(InputHandler) aInputHandler, decltype(OutputHandler) aOutputHandler)
	~cmdLineRequestProvider () override=default
bool	isFollowMode () const override
void	prepareMappings (std::vector< std::string > &sources, std::string &destination) override
void	printMappings (std::ostream &stream) override
Public Member Functions inherited from noFollowRequestProvider
	noFollowRequestProvider (decltype(requests) aRequests, decltype(delayedRequests) aDelayedRequests, decltype(parents) aParents, decltype(InputHandler) aInputHandler, decltype(OutputHandler) aOutputHandler)
	~noFollowRequestProvider () override=default
bool	isFollowMode () const override
void	processSources (const std::vector< std::string > &sources) override
Public Member Functions inherited from requestProvider
	requestProvider (decltype(requests) aRequests, decltype(delayedRequests) aDelayedRequests, decltype(parents) aParents, decltype(InputHandler) aInputHandler, decltype(OutputHandler) aOutputHandler)
	! use only the file name part in the destination More...
virtual	~requestProvider ()=default

Protected Member Functions
void	processSource (const std::string &source) override
virtual void	addDirContent (const std::string &srcpath, const std::string &dstpath, const singleMap &mapEntry, const genericStat &dirStat)
const singleMap &	getDstPath (const std::string &source, std::string &destination, bool baseNameOnly=false) override
	get detstination papth for a given source path More...
Protected Member Functions inherited from noFollowRequestProvider
virtual copyRequest::base *	newRequest (inputHandler::base *InputHandler, const std::string &aSource, const std::string &aDestination, std::unique_ptr< const genericStat > &aStat, const singleMap &aMapEntry, bool remove, copyRequest::clock_type::time_point timestamp)

Protected Attributes
bool	processCmdLineDirs
Protected Attributes inherited from requestProvider
copyRequest::simpleQueue &	requests
copyRequest::timedQueue &	delayedRequests
bool	parents
inputHandler::base *	InputHandler
outputHandler::base *	OutputHandler

Static Protected Attributes
static options::single< bool >	recursive
static options::single< bool >	dereferenceCmdLine
static std::string	singleDestination
Static Protected Attributes inherited from noFollowRequestProvider
static options::single< std::string > &	sourceDecodeMethod
static options::single< bool >	ignoreMissing
static std::multiset< copyRequest::base *, copyRequest::base::pointerCompare >	requestSet
Static Protected Attributes inherited from requestProvider
static options::map< std::string, pathMapType >	pathMap
static singleMap	badMapEntry

Static Private Attributes
static factoryTemplate< cmdLineRequestProvider >	factory

Additional Inherited Members
Static Public Member Functions inherited from requestProvider
static requestProvider *	newProvider (const std::string &choice, decltype(requests) aRequests, decltype(delayedRequests) aDelayedRequests, decltype(parents) aParents, decltype(InputHandler) aInputHandler, decltype(OutputHandler) aOutputHandler)
static void	addAllowedNamesToOption (options::single< std::string > &option)
Static Protected Member Functions inherited from requestProvider
static std::map< std::string, factoryClass * > &	getFactoryMap ()

Detailed Description

Definition at line 9 of file cmdLineRequestProvider.h.

Constructor & Destructor Documentation

cmdLineRequestProvider()

cmdLineRequestProvider::cmdLineRequestProvider ( decltype(requests)  aRequests, decltype(delayedRequests)  aDelayedRequests, decltype(parents)  aParents, decltype(InputHandler)  aInputHandler, decltype(OutputHandler)  aOutputHandler  )

inline

Definition at line 28 of file cmdLineRequestProvider.h.

                                                                  :
        noFollowRequestProvider(aRequests, aDelayedRequests, aParents,
                                aInputHandler, aOutputHandler),
        processCmdLineDirs(false) {};

~cmdLineRequestProvider()

cmdLineRequestProvider::~cmdLineRequestProvider ( )

overridedefault

Member Function Documentation

addDirContent()

void cmdLineRequestProvider::addDirContent ( const std::string &  srcpath, const std::string &  dstpath, const singleMap &  mapEntry, const genericStat &  dirStat  )

protectedvirtual

Reimplemented in moveRequestProvider.

Definition at line 106 of file cmdLineRequestProvider.cpp.

                                    {
    // with the subdir list we have only one open dir at a time
    class subdirType {
      public:
        std::string srcPath;
        std::string dstPath;
        std::unique_ptr<const genericStat> dirStat;
        subdirType(const std::string& aSrcPath,
                   const std::string& aDstPath,
                   std::unique_ptr<const genericStat>& aDirStat) :
            srcPath(aSrcPath),
            dstPath(aDstPath),
            dirStat(std::move(aDirStat)) {};
    };
    std::list<subdirType> subdirs;
    {
        auto dir = InputHandler->getDirectory(srcpath);
        while (auto entry = dir->getNextEntry(ignoreMissing)) {
            std::string subpath(srcpath);
            subpath += "/";
            subpath += entry->getName();
            std::string destpath(dstpath);
            destpath += "/";
            destpath += entry->getName();
            auto entryStat = entry->getStat();
            if (entryStat->isDir() &&
                    entryStat->device == dirStat.device &&
                    recursive) {
                subdirs.emplace_back(subpath, destpath, entryStat);
            } else {
                if (entryStat->isRegularFile() || entryStat->isLink() || processCmdLineDirs) {
                    timerInst(emplace);
                    requestSet.emplace(newRequest(InputHandler, subpath, destpath, entryStat,
                                                  mapEntry,
                                                  false, copyRequest::clock_type::now()));
                }
            }
        }
    }
 
    for (auto& subdir : subdirs) {
        addDirContent(subdir.srcPath, subdir.dstPath, mapEntry, *(subdir.dirStat));
        if (processCmdLineDirs) { // special case for listingRequestProvider
            timerInst(emplace);
            requestSet.emplace(newRequest(InputHandler, subdir.srcPath, subdir.dstPath, subdir.dirStat,
                                          mapEntry,
                                          false, copyRequest::clock_type::now()));
        }
    }
}

References genericStat::device, inputHandler::base::getDirectory(), noFollowRequestProvider::ignoreMissing, requestProvider::InputHandler, noFollowRequestProvider::newRequest(), processCmdLineDirs, recursive, noFollowRequestProvider::requestSet, and timerInst.

Referenced by processSource().

Here is the call graph for this function:

Here is the caller graph for this function:

getDstPath()

const singleMap & cmdLineRequestProvider::getDstPath ( const std::string &  source, std::string &  destination, bool  baseNameOnly = false  )

overrideprotectedvirtual

get detstination papth for a given source path

Returns

path map entry used in this case

Parameters

destination	! [in] the source path
baseNameOnly	! [ou] the destination path

Reimplemented from requestProvider.

Definition at line 18 of file cmdLineRequestProvider.cpp.

                           {
    if (!singleDestination.empty() || noCopy) { // we have the special case that we have one destination file only
        destination = singleDestination;
        static singleMap singleDestMap(source, singleDestination);
        return singleDestMap;
    }
    return requestProvider::getDstPath(source, destination, baseNameOnly);
}

References requestProvider::getDstPath(), noCopy, and singleDestination.

Referenced by moveRequestProvider::processSource(), and processSource().

Here is the call graph for this function:

Here is the caller graph for this function:

isFollowMode()

bool cmdLineRequestProvider::isFollowMode ( ) const

inlineoverridevirtual

Implements requestProvider.

Definition at line 37 of file cmdLineRequestProvider.h.

                                       {
        return false;
    };

prepareMappings()

void cmdLineRequestProvider::prepareMappings ( std::vector< std::string > &  sources, std::string &  destination  )

overridevirtual

Reimplemented from requestProvider.

Reimplemented in listingRequestProvider.

Definition at line 29 of file cmdLineRequestProvider.cpp.

                                {
    std::string dstdir;
    auto dstStat = OutputHandler->getStat(destination);
    if (dstStat == nullptr) { // destination  does not exist, create the new file in the working dir
        if (recursive) {
            dstdir = destination;
        } else {
            singleDestination = destination;
        }
    } else {
        if (dstStat->isDir()) {
            dstdir = destination;
        } else {
            singleDestination = destination;
        }
    }
 
    if (!dstdir.empty()) {
        if (sources.size() == 1) { // special case
            auto srcStat = InputHandler->getStat(sources.front());
            if (srcStat && srcStat->isDir()) {
                pathMap.emplace(sources.front(), dstdir);
                return; // all set, we may return
            }
        }
 
        if (workDir.fIsSet()) {
            pathMap.emplace(workDir, dstdir);
        } else {
            pathMap.emplace("", dstdir);
        }
    }
    if (dstdir.empty() && pathMap.empty() &&
            (sources.size() > 1 || recursive)  && !noCopy) {
        throw std::runtime_error("multiple sources and destination is not a directory");
    }
}

References options::base::fIsSet(), pathHandler::getStat(), requestProvider::InputHandler, noCopy, requestProvider::OutputHandler, requestProvider::pathMap, recursive, singleDestination, and workDir.

Here is the call graph for this function:

printMappings()

void cmdLineRequestProvider::printMappings ( std::ostream &  stream )

overridevirtual

Reimplemented from requestProvider.

Definition at line 68 of file cmdLineRequestProvider.cpp.

                                                             {
    if (singleDestination.empty()) {
        stream << "no special singleDestination (used for cmdLineRequestProvider only)\n";
    } else {
        stream << "special destination: '" << singleDestination << "'\n";
    }
    requestProvider::printMappings(stream);
}

References requestProvider::printMappings(), and singleDestination.

Here is the call graph for this function:

processSource()

void cmdLineRequestProvider::processSource ( const std::string &  source )

overrideprotectedvirtual

Implements noFollowRequestProvider.

Reimplemented in moveRequestProvider.

Definition at line 76 of file cmdLineRequestProvider.cpp.

                                                                  {
    auto sourceStat = InputHandler->getStat(source, dereferenceCmdLine);
    if (!sourceStat) {
        if (ignoreMissing) {
            if (! quiet) {
                errMsg::emit(errMsg::level::warning, errMsg::location(),
                             source, "stat", "not found");
            }
            return;
        }
        throw std::runtime_error("can't stat " + source);
    }
    if (sourceStat->isDir()) {
        if (recursive || processCmdLineDirs) {
            std::string dstPath;
            auto mapEntry = getDstPath(source, dstPath, !parents);
            addDirContent(source, dstPath, mapEntry, *sourceStat);
        } else {
            throw std::runtime_error(source + " is a directory");
        }
    } else {
        std::string dst;
        auto mapEntry = getDstPath(source, dst, !parents);
        timerInst(emplace);
        requestSet.emplace(newRequest(InputHandler, source, dst, sourceStat,
                                      mapEntry,
                                      false, copyRequest::clock_type::now()));
    }
}

References addDirContent(), dereferenceCmdLine, errMsg::emit(), getDstPath(), pathHandler::getStat(), noFollowRequestProvider::ignoreMissing, requestProvider::InputHandler, noFollowRequestProvider::newRequest(), requestProvider::parents, processCmdLineDirs, quiet, recursive, noFollowRequestProvider::requestSet, timerInst, and errMsg::warning.

Here is the call graph for this function:

Member Data Documentation

dereferenceCmdLine

options::single<bool> cmdLineRequestProvider::dereferenceCmdLine

staticprotected

Definition at line 14 of file cmdLineRequestProvider.h.

Referenced by moveRequestProvider::processSource(), and processSource().

factory

factoryTemplate<cmdLineRequestProvider> cmdLineRequestProvider::factory

staticprivate

Definition at line 11 of file cmdLineRequestProvider.h.

processCmdLineDirs

bool cmdLineRequestProvider::processCmdLineDirs

protected

Definition at line 16 of file cmdLineRequestProvider.h.

Referenced by addDirContent(), listingRequestProvider::listingRequestProvider(), and processSource().

recursive

options::single<bool> cmdLineRequestProvider::recursive

staticprotected

Definition at line 13 of file cmdLineRequestProvider.h.

Referenced by addDirContent(), prepareMappings(), moveRequestProvider::processSource(), and processSource().

singleDestination

std::string cmdLineRequestProvider::singleDestination

staticprotected

Definition at line 15 of file cmdLineRequestProvider.h.

Referenced by getDstPath(), listingRequestProvider::prepareMappings(), prepareMappings(), and printMappings().

---

The documentation for this class was generated from the following files:

• src/cmdLineRequestProvider.h (v0.19-24-g0617ca1 with changes)
• src/cmdLineRequestProvider.cpp (v0.19-24-g0617ca1 with changes)