#include <sys/stat.h>
#include <sys/types.h>
#include "string_function.h"

Include dependency graph for string_system.h:

This graph shows which files directly or indirectly include this file:

Functions
bool	createDirIfNotExist (const std::string &directoryName)
	Creates a directory if it does not exist. More...

std::string	getCurrentNodeName ()
	Get the name of the current node on which the program is running. More...

time_t	getFileInDirPerTime (std::vector< std::string > &vecFile, const std::string &dirName, time_t mostRecentTime=0lu)
	Get the list of most recent files in a directory. More...

time_t	getFileModificationTime (const std::string &fileName)
	Get the last modification time of the given file. More...

std::string	getHomeDir ()
	Gets the $HOME directory. More...

bool	getListAllFileInDir (std::list< std::string > &listFile, const std::string &dirName)
	Get the list of files in a directory. More...

void	getListFileInCurrentDir (std::list< std::string > &listFile, const std::string &expr)
	Function like a ls in shell. More...

bool	getListFileInDir (std::list< std::string > &listFile, const std::string &dirName, const std::string &expr)
	Get the list of files in a directory. More...

std::string	getProgramDirectory ()
	Get the program directory. More...

std::string	getProgramLocation ()
	Get the program location. More...

std::string	getProgramPrefix ()
	Get the program prefix (installation directory without /bin) More...

bool	isStringMatchRegex (const std::string &str, const std::string &expression)
	Fonction qui dit si une chaine de caractère correspond à une expression régulière de regex. More...

void	makeListArgument (std::list< std::string > &listArgument, int argc, char **argv)
	Makes the argument list of a program. More...

bool	phoenix_chmod (const std::string &fileName, mode_t __mode=S_IRWXU\|S_IRWXG\|S_IROTH\|S_IXOTH)
	Change the mode of a file or directory. More...

std::vector< std::string >	phoenix_find (const std::string &path)
	Find all files which matches the path expression (example : /path/*.cpp) More...

void	phoenix_find (std::vector< std::string > &vecFile, const std::string &path)
	Find all files which matches the path expression (example : /path/*.cpp) More...

time_t	phoenix_getClock ()
	Get current time. More...

double	phoenix_getClockSec ()
	Get current time. More...

std::string	phoenix_getDate ()
	Get the current date. More...

std::string	phoenix_getDateCompact ()
	Get the current date. More...

std::string	phoenix_getenv (const std::string &varName)
	Get the value of the given environment variable. More...

time_t	phoenix_getTime ()
	Get the current time of the program. More...

std::string	phoenix_popen (const std::string &command)
	Execute the given command and returns the output of this command. More...

bool	phoenix_popen (const std::string &executionLogFile, const std::string &command, bool onlyLogOnFail)
	Execute the given command and returns the output of this command. More...

int	phoenix_popen (std::string &executionLog, const std::string &command)
	Execute the given command and returns the output of this command. More...

bool	phoenix_setenv (const std::string &name, const std::string &value, int overwrite=1)
	Set a environment variable. More...

bool	phoenix_unsetenv (const std::string &name)
	Unset a environment variable. More...

Function Documentation

◆ createDirIfNotExist()

bool createDirIfNotExist ( const std::string & directoryName )

Creates a directory if it does not exist.

Parameters

directoryName : name of the directory we want to create

Returns: true on success, false otherwise

Definition at line 242 of file string_system.cpp.

                                                          {
         if(directoryName == "") return false;
         if(isDirectoryExist(directoryName)){
                 return true;
         }
         int res = mkdir(directoryName.c_str(), S_IRWXU | S_IRWXG | S_IROTH | S_IXOTH);
         return res == 0 || res == EEXIST;
 }

References isDirectoryExist().

Referenced by testStringSystem().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getCurrentNodeName()

std::string getCurrentNodeName ( )

Get the name of the current node on which the program is running.

Returns: name of the current node on which the program is running

Definition at line 406 of file string_system.cpp.

                               {
         return eraseCharsInStr(phoenix_popen("uname -n"), " \n\t");
 }

References eraseCharsInStr(), and phoenix_popen().

Referenced by testStringSystem().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getFileInDirPerTime()

time_t getFileInDirPerTime	(	std::vector< std::string > &	vecFile,
		const std::string &	dirName,
		time_t	mostRecentTime
	)

Get the list of most recent files in a directory.

Parameters

[out]	vecFile	: vector of found files (without directory name)
	dirName	: name of the directory to be scanned
	mostRecentTime	: threshold time to select only most recent files

Returns: time of the most recent file found in the directory which is newer than the input mostRecentTime

Definition at line 274 of file string_system.cpp.

                                                                                                             {
         DIR * dp = opendir(dirName.c_str());
         if(dp == NULL){return mostRecentTime;}
         dirent * dptr = readdir(dp);
         while(NULL != dptr){
                 if(dptr->d_type == DT_REG){     //We search for directory only
                         std::string pathName(dptr->d_name);
                         time_t fileTime = getFileModificationTime(dirName + "/" + pathName);
                         if(fileTime > mostRecentTime){
                                 mostRecentTime = fileTime;
                                 vecFile.push_back(pathName);
                         }
                 }
                 dptr = readdir(dp);
         }
         return mostRecentTime;
 }

References getFileModificationTime().

Referenced by testStringSystem().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getFileModificationTime()

time_t getFileModificationTime ( const std::string & fileName )

Get the last modification time of the given file.

Parameters

fileName : name of the file we want the last modification time

Returns: last modification time of the given file

Definition at line 255 of file string_system.cpp.

                                                           {
         struct stat attr;
         if(stat(fileName.c_str(), &attr) == 0){
 #ifdef __APPLE__
                 return attr.st_mtimespec.tv_sec;
 #else
                 return attr.st_mtim.tv_sec;
 #endif
         }else{
                 return -1l;
         }
 }

Referenced by getFileInDirPerTime(), and testStringSystem().

Here is the caller graph for this function:

◆ getHomeDir()

std::string getHomeDir ( )

Gets the $HOME directory.

Returns: $HOME directory

Definition at line 234 of file string_system.cpp.

                       {
         return phoenix_getenv("HOME");
 }

References phoenix_getenv().

Referenced by testStringSystem().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getListAllFileInDir()

bool getListAllFileInDir	(	std::list< std::string > &	listFile,
		const std::string &	dirName
	)

Get the list of files in a directory.

Parameters

[out]	listFile	: list of files in the current directory
	dirName	: name of the directory to look in

Definition at line 171 of file string_system.cpp.

                                                                                   {
         // Open the current directory
         DIR * dp = opendir(dirName.c_str());
         if(NULL == dp){
                 return false;
         }
         dirent * dptr = readdir(dp);
         while(NULL != dptr){
                 std::string fileName(dptr->d_name);
                 if(fileName != ".." && fileName != "."){
                         listFile.push_back(fileName);
                 }
                 dptr = readdir(dp);
         }
         closedir(dp);
         return true;
 }

Referenced by testStringSystem().

Here is the caller graph for this function:

◆ getListFileInCurrentDir()

void getListFileInCurrentDir	(	std::list< std::string > &	listFile,
		const std::string &	expr
	)

Function like a ls in shell.

Parameters

listFile	: list of the files witch match with expr
expr	: expression like "name.txt" or ".dat" or "name__something_.ext"

Definition at line 126 of file string_system.cpp.

                                                                                    {
         char * curr_dir = getenv("PWD");
         if(NULL == curr_dir){
                 printf("getListFileInCurrentDir : Could not get the working directory\n");
                 return;
         }
         // Open the current directory
         DIR * dp = opendir((const char*)curr_dir);
         if(NULL == dp){
                 printf("getListFileInCurrentDir : Could not open the working directory\n");
                 return;
         }
         dirent * dptr = readdir(dp);
         while(NULL != dptr){
                 if(isStringMatchRegex(std::string(dptr->d_name), expr)) listFile.push_back(std::string(dptr->d_name));
                 dptr = readdir(dp);
         }
 }

References isStringMatchRegex().

Referenced by testStringSystem().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getListFileInDir()

bool getListFileInDir	(	std::list< std::string > &	listFile,
		const std::string &	dirName,
		const std::string &	expr
	)

Get the list of files in a directory.

Parameters

[out]	listFile	: list of files in the current directory
	dirName	: name of the directory to look in
	expr	: regular expression like .txt or

Definition at line 150 of file string_system.cpp.

                                                                                                        {
         // Open the current directory
         DIR * dp = opendir(dirName.c_str());
         if(NULL == dp){
 //              printf("getListFileInDir : Could not open the working directory\n");
                 return false;
         }
         dirent * dptr = readdir(dp);
         while(NULL != dptr){
                 if(isStringMatchRegex(std::string(dptr->d_name), expr)) listFile.push_back(std::string(dptr->d_name));
                 std::cout << "getListFileInDir : '" << std::string(dptr->d_name) << "'"<< std::endl;
                 dptr = readdir(dp);
         }
         closedir(dp);
         return true;
 }

References isStringMatchRegex().

Referenced by testStringSystem().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getProgramDirectory()

std::string getProgramDirectory ( )

Get the program directory.

Returns: directory of the program

Definition at line 317 of file string_system.cpp.

                                {
         std::string progLoc(getProgramLocation());
         if(progLoc != ""){
                 return getDirectory(progLoc);
         }else{
 #ifdef CMAKE_INSTALL_PREFIX
                 return CMAKE_INSTALL_PREFIX "/bin/";
 #else
                 return "/usr/bin/";
 #endif
         }
 }

References getDirectory(), and getProgramLocation().

Referenced by getProgramPrefix(), and testStringSystem().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getProgramLocation()

std::string getProgramLocation ( )

Get the program location.

Returns: location of the current program

Definition at line 296 of file string_system.cpp.

                               {
         char buffer[4096];
         ssize_t nbChar = readlink("/proc/self/exe", buffer, 2048);
 //      readlink("/proc/self/exe", buf, bufsize) (Linux)
 //      readlink("/proc/curproc/file", buf, bufsize) (FreeBSD)
 //      readlink("/proc/self/path/a.out", buf, bufsize) (Solaris)
         
         if(nbChar > 0l){
                 std::string outputBuf("");
                 for(ssize_t i(0l); i < nbChar; ++i){
                         outputBuf += buffer[i];
                 }
                 return outputBuf;
         }else{
                 return "";
         }
 }

Referenced by getProgramDirectory(), and testStringSystem().

Here is the caller graph for this function:

◆ getProgramPrefix()

std::string getProgramPrefix ( )

Get the program prefix (installation directory without /bin)

Returns: prefix of the program (installation directory without /bin)

Definition at line 333 of file string_system.cpp.

                             {
         return getDirectory(getProgramDirectory());
 }

References getDirectory(), and getProgramDirectory().

Referenced by testStringSystem().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isStringMatchRegex()

bool isStringMatchRegex	(	const std::string &	str,
		const std::string &	expression
	)

Fonction qui dit si une chaine de caractère correspond à une expression régulière de regex.

Parameters

str	: string dont on veut savoir si elle correspond à une expression régulière
expression	: expression régulière regex

Returns: true si str correspond à une expression régulière, false sinon

Definition at line 94 of file string_system.cpp.

                                                                             {
         if(str.size() == 0lu || expression.size() == 0lu){return false;}
         int err;
         regex_t preg;
         const char *str_request = str.c_str();
         const char *str_regex = expression.c_str();
         err = regcomp(&preg, str_regex, 0);     //REG_NOSUB | REG_EXTENDED
         if(err != 0) return false;
         int match = regexec(&preg, str_request, 0, NULL, 0);
         regfree (&preg);
         if(match == 0){return true;}
         else{return false;}//if (match == REG_NOMATCH){return false;}
 //      else{
 //              char *text;
 //              long unsigned int size;
 //              size = regerror (err, &preg, NULL, 0);
 //              text = new char[size];
 //              if (text){
 //                      regerror (err, &preg, text, size);
 //                      fprintf (stderr, "isStringMatchRegex : %s\n", text);
 //                      delete [] text;
 //              }else{
 //                      fprintf (stderr, "isStringMatchRegex : Memoire insuffisante\n");
 //              }
 //              return false;
 //      }
 }

References createReleaseCurl::str.

Referenced by getListFileInCurrentDir(), getListFileInDir(), testRegExpr(), and testStringSystem().

Here is the caller graph for this function:

◆ makeListArgument()

void makeListArgument	(	std::list< std::string > &	listArgument,
		int	argc,
		char **	argv
	)

Makes the argument list of a program.

Parameters

[out]	listArgument	: list of the program arguments
	argc	: number of arguments passed to the program
	argv	: array of the passed arguments to the program

Definition at line 193 of file string_system.cpp.

                                                                                {
         if(argc <= 0) return;
         for(int i(0); i < argc; ++i){
                 listArgument.push_back(argv[i]);
         }
 }

Referenced by main().

Here is the caller graph for this function:

◆ phoenix_chmod()

bool phoenix_chmod	(	const std::string &	fileName,
		mode_t	__mode
	)

Change the mode of a file or directory.

Parameters

fileName	: name of the file to be changed
__mode	: mode to be applied to the given file (Default value makes files executable S_IRWXU \| S_IRWXG \| S_IROTH \| S_IXOTH)

Returns: true on success, false otherwise

Definition at line 395 of file string_system.cpp.

                                                              {
         bool b(chmod(fileName.c_str(), __mode) >= 0);
         if(!b){
                 std::cerr << "phoenix_chmod : Cannot set mode of file '"<<fileName<<"'" << std::endl;
         }
         return b;
 }

Referenced by testStringSystem().

Here is the caller graph for this function:

◆ phoenix_find() [1/2]

std::vector<std::string> phoenix_find ( const std::string & path )

Find all files which matches the path expression (example : /path/*.cpp)

Parameters

path	: path which can matches several files

Returns: vector of found files

Definition at line 422 of file string_system.cpp.

                                                          {
         std::vector<std::string> vecFile;
         phoenix_find(vecFile, path);
         return vecFile;
 }

References phoenix_find().

Here is the call graph for this function:

◆ phoenix_find() [2/2]

void phoenix_find	(	std::vector< std::string > &	vecFile,
		const std::string &	path
	)

Find all files which matches the path expression (example : /path/*.cpp)

Parameters

[out]	vecFile	: vector of found files
	path	: path which can matches several files

Definition at line 414 of file string_system.cpp.

                                                                          {
         vecFile = cutStringVector(phoenix_popen("ls " + path), '\n');
 }

References cutStringVector(), and phoenix_popen().

Referenced by phoenix_find(), and testStringSystem().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ phoenix_getClock()

time_t phoenix_getClock ( )

Get current time.

Returns: current time

Definition at line 431 of file string_system.cpp.

                          {
         return clock();
 }

Referenced by phoenix_getClockSec().

Here is the caller graph for this function:

◆ phoenix_getClockSec()

double phoenix_getClockSec ( )

Get current time.

Returns: current time

Definition at line 438 of file string_system.cpp.

                             {
         return ((double)phoenix_getClock())/((double)CLOCKS_PER_SEC);
 }

References phoenix_getClock().

Here is the call graph for this function:

◆ phoenix_getDate()

std::string phoenix_getDate ( )

Get the current date.

Returns: current date

Definition at line 452 of file string_system.cpp.

                            {
         std::time_t currentTime = phoenix_getTime();
         std::tm* now_tm = std::gmtime(&currentTime);
         char buf[42];
         std::strftime(buf, 42, "%Y/%m/%d : %X", now_tm);
         return buf;
 }

References phoenix_getTime().

Referenced by PLog::close(), and PLog::open().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ phoenix_getDateCompact()

std::string phoenix_getDateCompact ( )

Get the current date.

Returns: current date

Definition at line 463 of file string_system.cpp.

                                   {
         std::time_t currentTime = phoenix_getTime();
         std::tm* now_tm = std::gmtime(&currentTime);
         char buf[42];
         std::strftime(buf, 42, "%Y/%m/%d-%X", now_tm);
         return buf;
 }

References phoenix_getTime().

Referenced by PLog::getLog().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ phoenix_getenv()

std::string phoenix_getenv ( const std::string & varName )

Get the value of the given environment variable.

Parameters

varName : name of the environment variable to be used

Returns: value of the variable, or empty string of the variable does not exist

Definition at line 204 of file string_system.cpp.

                                                    {
         char * curr_var = getenv(varName.c_str());
         if(NULL == curr_var){
                 return "";
         }else{
                 return std::string(curr_var);
         }
 }

Referenced by getCurrentDirectory(), getHomeDir(), and testStringSystem().

Here is the caller graph for this function:

◆ phoenix_getTime()

time_t phoenix_getTime ( )

Get the current time of the program.

Returns: current time of the program

Definition at line 445 of file string_system.cpp.

                         {
         return std::time(0);
 }

Referenced by PLog::getLog(), phoenix_getDate(), and phoenix_getDateCompact().

Here is the caller graph for this function:

◆ phoenix_popen() [1/3]

std::string phoenix_popen ( const std::string & command )

Execute the given command and returns the output of this command.

Parameters

command : command to be executed

Returns: output of the given command, empty string if the command is empty or null character on fail

Definition at line 341 of file string_system.cpp.

                                                   {
         if(command == ""){return "";}
         FILE * fp = popen(command.c_str(), "r");
         if(fp == NULL){
                 std::cerr << "phoenix_popen : cannot get result of command '"<<command<<"'" << std::endl;
                 return "";
         }
         std::string resultCommand(getFileContent(fp));
         pclose(fp);
         return resultCommand;
 }

References getFileContent().

Referenced by checkOptionCompletion(), getCurrentNodeName(), phoenix_find(), phoenix_popen(), and testPoenixPOpen().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ phoenix_popen() [2/3]

bool phoenix_popen	(	const std::string &	executionLogFile,
		const std::string &	command,
		bool	onlyLogOnFail
	)

Execute the given command and returns the output of this command.

Parameters

[out]	executionLogFile	: file which will get output of the given command, empty string if the command is empty or full log on fail
	command	: command to be executed
	onlyLogOnFail	: true to log only if the command fails

Returns: true if the command was successful, false otherwise (in this case, log file will be created)

Definition at line 376 of file string_system.cpp.

                                                                                                      {
         std::string executionLog("");
         bool b(phoenix_popen(executionLog, command) == 0);
         if(!b){
                 std::cerr << "phoenix_popen : command '"<<command<<"' failed. To get more information see log '"<<executionLogFile<<"'" << std::endl;
         }
         if((onlyLogOnFail && !b) || !onlyLogOnFail){
                 if(!saveFileContent(executionLogFile, executionLog)){
                         std::cerr << "phoenix_popen : cannot create log file '"<<executionLogFile<<"'" << std::endl;
                 }
         }
         return b;
 }

References phoenix_popen(), and saveFileContent().

Here is the call graph for this function:

◆ phoenix_popen() [3/3]

int phoenix_popen	(	std::string &	executionLog,
		const std::string &	command
	)

Execute the given command and returns the output of this command.

Parameters

[out]	executionLog	: output of the given command, empty string if the command is empty or null character on fail
	command	: command to be executed

Returns: exit status of the command

Definition at line 358 of file string_system.cpp.

                                                                       {
         executionLog = "";
         if(command == ""){return -1;}
         FILE * fp = popen(command.c_str(), "r");
         if(fp == NULL){
                 std::cerr << "phoenix_popen : cannot get result of command '"<<command<<"'" << std::endl;
                 return -1;
         }
         executionLog = getFileContent(fp);
         return pclose(fp);
 }

References getFileContent().

Here is the call graph for this function:

◆ phoenix_setenv()

bool phoenix_setenv	(	const std::string &	name,
		const std::string &	value,
		int	overwrite
	)

Set a environment variable.

Parameters

name	: name of the variable to be created
value	: value of the variable to be created
overwrite	: 1 to overwrite an existing variable, 0 to not to

Returns: true on success, false otherwise

Definition at line 219 of file string_system.cpp.

                                                                                     {
         return setenv(name.c_str(), value.c_str(), overwrite) == 0;
 }

Referenced by testStringSystem().

Here is the caller graph for this function:

◆ phoenix_unsetenv()

bool phoenix_unsetenv ( const std::string & name )

Unset a environment variable.

Parameters

name	: name of the variable to be unset

Returns: true on success, false otherwise

Definition at line 227 of file string_system.cpp.

                                              {
         return unsetenv(name.c_str()) == 0;
 }

Referenced by testStringSystem().

Here is the caller graph for this function:

Functions

Function Documentation

◆ createDirIfNotExist()

◆ getCurrentNodeName()

◆ getFileInDirPerTime()

◆ getFileModificationTime()

◆ getHomeDir()

◆ getListAllFileInDir()

◆ getListFileInCurrentDir()

◆ getListFileInDir()

◆ getProgramDirectory()

◆ getProgramLocation()

◆ getProgramPrefix()

◆ isStringMatchRegex()

◆ makeListArgument()

◆ phoenix_chmod()

◆ phoenix_find() [1/2]

◆ phoenix_find() [2/2]

◆ phoenix_getClock()

◆ phoenix_getClockSec()

◆ phoenix_getDate()

◆ phoenix_getDateCompact()

◆ phoenix_getenv()

◆ phoenix_getTime()

◆ phoenix_popen() [1/3]

◆ phoenix_popen() [2/3]

◆ phoenix_popen() [3/3]

◆ phoenix_setenv()

◆ phoenix_unsetenv()