CommonLibraries.cpp File Reference

#include "CommonLibraries.h"
#include <string.h>
#include <stdlib.h>
#include <errno.h>
#include <sys/types.h>
#include <sys/stat.h>
#include <unistd.h>
#include <time.h>
#include <stdio.h>

Go to the source code of this file.

Functions
bool	RIOmktemp (char *temp_file_template)
	RIOmktemp recebe um char* do tipo [<path>/]blablablaXXXXXX com no minimo 6 X's, e retorna um nome de arquivo valido substituindo os X's por uma sequencia de caracteres aleatarios de mesmo tamanho da cadeia de X's e acrescentando o path do diretorio de arquivos temporartios, se nao existir um path no nome.
bool	RIOmktempAndID (char *temp_file_template, unsigned long long int *temp_file_id)
	Funcao para retornar alterar o nome do arquivo passado como parametro (usando a funcao RIOmktemp dada acima) e retornar um identificador unico para este nome.
bool	IdRandomName (unsigned long long int NameId, char *RandomName, unsigned int RandomNameSize)
	Funcao para retornar a parte aleatoria de um arquivo correspondente a identificacao passada como parametro (esta identificacao foi provavelmente obtida ao chamar a funcao RIOmktempAndID.
Variables
static const char	padchar []
static const unsigned int	padcharlen = 62

---

Function Documentation

bool IdRandomName	(	unsigned long long int	NameId,
		char *	RandomName,
		unsigned int	RandomNameSize
	)

Funcao para retornar a parte aleatoria de um arquivo correspondente a identificacao passada como parametro (esta identificacao foi provavelmente obtida ao chamar a funcao RIOmktempAndID.

Parameters:

	RandomId	identificacao associada a parte aleatoria do nome retornado por RIOmktempAndID.
	RandomName	ponteiro para a string com a parte aleatoria do nome. A string deve ter espaco para armazenar pelo menos RandomNameSize + 1 caracteres (os RandomNameSize do nome aleatorio mais o terminador).
	RandomNameSize	Tamanho desejado para o nome aleatorio.

Returns:

true se a conversao foi feita com sucesso e false se algum erro ocorreu (no caso, o identificador e muito grande e nao esta associado a nenhuma parte aleatoria do nome que usa no maximo 10 caracteres aleatorios).

Definition at line 192 of file CommonLibraries.cpp.

{
    // Valor auxiliar usado para armazenar o identificador.
    unsigned long long int TempId;
    unsigned int RandomCharPos, TotalChars;
    
    // Inicializa o nome com o primeiro caractere do vetor aleatorio (necessario
    // para tratar o caso em que o nome do arquivo termina com um ou mais destes
    // caracteres).
    for( unsigned int i = 0; i < RandomNameSize; i++ )
        RandomName[ i ] = padchar[ 0 ];
    RandomName[ RandomNameSize ] = 0;        
    
    TotalChars = 0;
    TempId = NameId;    

    // Converte o identificador em um nome randomico.
    while( TempId )
    {
        if( TotalChars >= 10 )
            return false;        

        RandomCharPos = ( unsigned int ) ( TempId % padcharlen );
        RandomName[ TotalChars ] = padchar[ RandomCharPos ];
        TempId = TempId / padcharlen;
        TotalChars++;
    }
    // Finaliza o nome randomico.
    //RandomName[ TotalChars ] = 0;
    
    return true;
}

bool RIOmktemp

(

char *

temp_file_template

)

RIOmktemp recebe um char* do tipo [<path>/]blablablaXXXXXX com no minimo 6 X's, e retorna um nome de arquivo valido substituindo os X's por uma sequencia de caracteres aleatarios de mesmo tamanho da cadeia de X's e acrescentando o path do diretorio de arquivos temporartios, se nao existir um path no nome.

Ex: rio_XXXXXX retorna /tmp/rio_5tKp9q. Se a cadeia de X's tiver menos de 6 caracteres ou lstat falhar por outro motivo, que nao a inexistencia de um arquivo com o nome aleatorio gerado, a funcao retorna false (caso o nome aleatorio gerado ja exista, RIOmktemp insiste ate conseguir um que ainda nao exista).

Definition at line 31 of file CommonLibraries.cpp.

{
    int          len;
    int     randnum;
    char        *trv;
    char        *random_file;
    char        *temp_dir;
    char        *endpath, *filename;
    struct stat  mystat;
    bool         status = true;
    bool         remove_temp_dir;

    //Se n�o tiver ao menos 6 X's no template, n�o criar o nome aleat�rio
    len = strlen( temp_file_template );
    if( len < 6 || strcmp( &temp_file_template[len - 6], "XXXXXX" ) )
        return false;
        
    // Verifica se existe o caminho em temp_file_template, procurando a posicao
    // da ultima "/" no nome.
    endpath = strrchr( temp_file_template, '/' );
    remove_temp_dir = false; 
    if( endpath == NULL )
    { 
        // Try to get TMPDIR environment variable
        // If failed, set to '/tmp/'
        temp_dir = getenv( "TMPDIR" );

        if( ( temp_dir == NULL ) || ( strlen( temp_dir ) == 0 ) )
        {
            temp_dir = strdup( "/tmp" );
            remove_temp_dir = true;
        }
        filename = temp_file_template;
    }
    else
    {
        // Substitui temporariamente o '/' por '\0', para podermos duplicar o
        // nome do caminho.
        *endpath = 0; 
        // Salva o inicio do nome do arquivo no caminho.
        filename = endpath + 1;
        temp_dir = strdup( temp_file_template );
        // Recoloca no nome o caractere '/' temporariamente removido.
        *endpath = '/';
        remove_temp_dir = true;
    } 
    // Assembly random file template
    random_file = (char *)malloc( sizeof( char ) *
                                  ( strlen( temp_dir ) + 2 + // '/' e '\0'
                                    strlen( filename )
                                  )
                                );
    while( status )
    {
        strcpy( random_file, temp_dir           );
        strcat( random_file, "/"                );
        strcat( random_file, filename           );

        // Randomize file name
        srandom( time(NULL) );

        for( trv = random_file + strlen( random_file ) - 1;
             *trv == 'X';
             trv--
           )
        {
            randnum = random() % ( sizeof( padchar ) - 1 );
            *trv    = padchar[ randnum ];
        }

        if( lstat( random_file, &mystat ) < 0 )
        {
            if( errno == ENOENT )//arquivo n�o existe, nome pode ser usado
                break;
            else //erro n�o trat�vel (neste caso ) no lstat
                status = false;
        }
    }

    if( status )
        strcpy( temp_file_template, random_file );

    free( random_file );

    if( remove_temp_dir )
        free( temp_dir );

    return status;
}

bool RIOmktempAndID	(	char *	temp_file_template,
		unsigned long long int *	temp_file_id
	)

Funcao para retornar alterar o nome do arquivo passado como parametro (usando a funcao RIOmktemp dada acima) e retornar um identificador unico para este nome.

Para que a funcao seja executada com sucesso, o numero de caracteres a serem substituidos pela funcao RIOmktemp deve ser entre 6 (o valor minimo aceito pela funcao) ate 10 (o valor maximo de caracteres para podermos criar um identificador unico de 64 bits para o arquivo).

Parameters:

	FileName	nome do arquivo a ser alterado pela funcao RIOmktemp
	FileId	ponteiro para o inteiro nao sinalizado de 64 bits que armazenara o identificador.

Returns:

true se o nome e o identificador forem criados com sucesso e false, em caso contrario.

Definition at line 134 of file CommonLibraries.cpp.

{
    bool status;
    unsigned int TotalRandomChars;
    const char *PosRandomName, *PosRandomChar;
    
    // Se nao tiver ao menos 6 X's no template e mais do que 10 X's, nao criar o
    // nome aleatorio. Para isso, precisamos descobrir o numero de caracteres
    // usados pelo nome aleatorio.
    TotalRandomChars = 0;
    for( int i = strlen( temp_file_template ) - 1; i >=0; i-- )
    {
        if( temp_file_template[ i ] != 'X' )
            break;
        TotalRandomChars++;    
    }  
    
    if( ( TotalRandomChars < 6 ) || ( TotalRandomChars > 10 ) )
        return false;
    
    // Chama a funcao RIOmktemp para criar um nome aleatorio    
    status = RIOmktemp( temp_file_template  );
    if( status )
    {
        *temp_file_id = 0;
        PosRandomName = temp_file_template + strlen( temp_file_template ) - 1;
        for( unsigned int i = 0; i < TotalRandomChars; i++ )
        {
           *temp_file_id = *temp_file_id * padcharlen;
           PosRandomChar = strchr( padchar, *PosRandomName );
           if( PosRandomChar == NULL )
           {
               // Se isso ocorrer, existe um erro no nome do arquivo.
               *temp_file_id = 0;
               return false;
           }
           *temp_file_id = *temp_file_id + ( PosRandomChar - padchar ); 
           PosRandomName--;
        }
    } 
    return true;
}

---

Variable Documentation

const char padchar[] [static]

Initial value:

               "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz"

Definition at line 15 of file CommonLibraries.cpp.

const unsigned int padcharlen = 62 [static]

Definition at line 18 of file CommonLibraries.cpp.