RioMd5 Class Reference

#include <RioExplorer.h>

Public Member Functions
bool	getMd5Sum (char *, char *, bool=false)
	getMd5sum obtém o md5 checksum do arquivo objectName e armazena em md5sum; armazena NULL caso objectName seja um diretório ou a operação falhe; retorna true se a operação for realizada com sucesso, e false caso contrário.
bool	updateCache ()
	This method ensures that the cache, if existant, is fully updated.
void	copyCache (RioMd5 *)
	copyCache makes md5Cache equal as srcMd5.md5Cache, if this instance of RioMd5 was created with cache; used to load cache from another cache
bool	importData (QString, CRioSession *)
	importData gets data from all files in srcDirectory and stores on md5Cache if RioMd5 was created with cache; used to load cache from remote md5 data
	RioMd5 (RioExplorer *, CRioSession *)
	RioMd5 is the class that is responsible for returning the md5 checksums for both local and remote files.
	RioMd5 (RioExplorer *, CRioSession *, char *)
	~RioMd5 ()
Private Member Functions
char *	calculateMD5 (const char *, char *)
void	loadCache (QString, vector< QDomElement > &)
	loadCache carrega todos os itens armazenados na cache do diretório src e de todos os seus subdiretórios no vetor md5Cache.
Private Attributes
RioExplorer *	parent
CRioSession *	md5Session
QString	srcDirectory
vector< QDomElement >	md5Cache
QString	MD5CACHEFILE

---

Detailed Description

Definition at line 228 of file RioExplorer.h.

---

Constructor & Destructor Documentation

RioMd5::RioMd5	(	RioExplorer *	explorer,
		CRioSession *	session
	)

RioMd5 is the class that is responsible for returning the md5 checksums for both local and remote files.

It may or may not load previously calculated checksums from am XML cache located at a local directory. //continue

Definition at line 3287 of file RioExplorer.cpp.

{
    parent = explorer;
    md5Session = session;
}

RioMd5::RioMd5	(	RioExplorer *	explorer,
		CRioSession *	session,
		char *	src
	)

Definition at line 3293 of file RioExplorer.cpp.

{
    parent = explorer;
    md5Session = session;
    srcDirectory = QString( src );
    MD5CACHEFILE = explorer->md5CacheFile();
    loadCache( srcDirectory , md5Cache );
}

RioMd5::~RioMd5

(

)

Definition at line 3302 of file RioExplorer.cpp.

{
    if( srcDirectory.isNull() ) return; //RioMd5 created without loading cache

    #ifdef RIO_DEBUG2
    RioErr << "Destroying cache for " << srcDirectory.latin1() << endl;
    #endif
    //this element will store directory elements; each of these elements will
    //be children of the root elememnt and will contain the tag elements that
    //will be stored to the XML files on the respective directory
    QDomDocument doc( "document" );
    QDomElement root = doc.createElement( "root" );
    doc.appendChild( root );

    vector<QDomElement>::iterator elemIt;
    for( elemIt = md5Cache.begin(); elemIt != md5Cache.end(); elemIt++ )
    {
        //getting directory
        QString dir = (*elemIt).attribute( "name" ).copy();
        if( dir.findRev( '/' ) == -1 )
            dir = "";
        else
            dir.truncate( dir.findRev( '/' ) ); //getting directory

        //getting name
        QString newName = (*elemIt).attribute( "name" );
        if( dir != "" )
            newName.remove( 0, dir.length() + 1 );
        (*elemIt).setAttribute( "name", newName );

        //checking if the directory has already being added to the document
        bool found = false;
        QDomNode node = root.firstChild();
        while( !node.isNull() && !found )
        {
            if( node.isElement() )
            {
                QDomElement elem = node.toElement();
                if( ( elem.attribute( "dir" ) == dir ) ) //case positive
                {
                    elem.appendChild( *elemIt );
                    found = true;
                }
            }
            node = node.nextSibling();
        }
        if( !found ) //case negative
        {
            QDomElement newDir = doc.createElement( "root" );
            newDir.setAttribute( "dir", dir );
            newDir.appendChild( *elemIt ); //adding tag to directory
            root.appendChild( newDir ); //adding directory to main document
        }
    }

    QDomNode exportNode = root.firstChild();
    while( !exportNode.isNull() )
    {
        //constructing XML file path
        QString fileOutput = exportNode.toElement().attribute( "dir" ).copy();
        if( fileOutput == "" )
            fileOutput = srcDirectory;
        else
            fileOutput = srcDirectory + '/' + fileOutput;
        fileOutput += '/';
        fileOutput += MD5CACHEFILE;

        #ifdef RIO_DEBUG2
        RioErr << "Exporting node to file: " << fileOutput.latin1() << endl; 
        #endif

        //root element can't contain attributes
        exportNode.toElement().removeAttribute( "dir" );
        QFile file( fileOutput );
        if( file.exists() && !file.remove() )
        {
            #ifdef RIO_DEBUG2
            RioErr << "Couldn't reset file " << fileOutput.latin1() << endl;
            #endif

            exportNode = exportNode.nextSibling();
            continue;
        }
        file.open( IO_ReadWrite );
        QTextStream stream( &file );
        exportNode.save( stream, 0 );

        exportNode = exportNode.nextSibling();
    }
}

---

Member Function Documentation

char * RioMd5::calculateMD5	(	const char *	filename,
		char *	buf
	)			[private]

Definition at line 3835 of file RioExplorer.cpp.

{
    MD5_CTX state;

    // Tamanho máximo do arquivo a ser lido
    unsigned int size = UINT_MAX;
    unsigned char digest[16];
    char hex[17] = "0123456789abcdef";
    char temp[100];
    char *m;
    int fd;
    int di = 0;
    int rc;
    struct stat st;

    fd = open( filename, O_RDONLY );
    MD5_Init( &state );

    if( fstat( fd, &st ) == -1 ) 
    {
        close( fd );
        if( buf )
            strcpy( buf, "0" );
        else
            buf = strdup( "0" );
        return buf;
    }

    if( (unsigned int) st.st_size < size )
        size = st.st_size;

    if( ( m = (char *) mmap(
             (void *) 0, size, PROT_READ, MAP_PRIVATE, fd, 0 ) ) != MAP_FAILED ) 
    {
        MD5_Update( &state, (unsigned char *) m, size );
        MD5_Final( digest, &state );
        munmap( m, size );

        for ( di = 0, rc = 0; di < 16; ++di, rc += 2 ) 
        {
            temp[ rc ] = hex[ digest[di] >> 4 ];
            temp[ rc + 1 ] = hex[ digest[di] & 15 ];
        }
        temp[ 32 ] = 0;
        sprintf( temp, "%s", temp );

        if( buf == NULL )
            buf = strdup( temp );
        else
            strcpy( buf, temp );
    }
    else
    {
        if( buf )
            strcpy( buf, "0" );
        else
            buf = strdup( "0" );
        return buf;
    }
    close( fd );
    return buf;
}

void RioMd5::copyCache

(

RioMd5 *

srcMd5

)

copyCache makes md5Cache equal as srcMd5.md5Cache, if this instance of RioMd5 was created with cache; used to load cache from another cache

Definition at line 3721 of file RioExplorer.cpp.

{
    if( !srcDirectory.isNull() ) //cache created
    {
        md5Cache.clear();

        vector<QDomElement>::iterator it;
        for( it = srcMd5->md5Cache.begin(); it != srcMd5->md5Cache.end(); it++ )
        {
            QDomElement newElement = it->cloneNode().toElement();
            md5Cache.push_back( newElement );
        }
    }
}

bool RioMd5::getMd5Sum	(	char *	objectName,
		char *	md5sum,
		bool	notifyError = false
	)

getMd5sum obtém o md5 checksum do arquivo objectName e armazena em md5sum; armazena NULL caso objectName seja um diretório ou a operação falhe; retorna true se a operação for realizada com sucesso, e false caso contrário.

O checksum é obtido, para arquivos locais, através de cálculo ou, se possível, busca na cache (que já está carregada), e para arquivos remotos, solicitando ao servidor. O parâmetro booleano notifyError (default true) indica se getObjectMd5Sum deve ou não imprimir erro caso objectName não exista. Se a cache for utilizada, ela é atualizada conforme seja necessário.

Definition at line 3463 of file RioExplorer.cpp.

{
    bool found = false;

    QString name( objectName );
    // MD5Sum cannot be calculated if the cache is used, but the searched file
    // is outside the scope of the source directory of the cache
    if( !srcDirectory.isNull() &&
        name.left( srcDirectory.length() ) != srcDirectory )
    {
        md5sum = NULL;
        return false;
    }

    if( !parent->checkSession( md5Session ) )
    {
        md5sum = NULL;
        return false;
    }
    ObjectInfo searchInfo;
    if (!parent->getObjectInfo( (char *)objectName, md5Session, &searchInfo,
                                notifyError ))
    {
        md5sum = NULL;
        return false;
    }

    #ifdef RIO_DEBUG2
    RioErr << "getMd5Sum for " << objectName << endl;
    #endif

    if( md5Session == NULL ) //LOCAL object
    {
        if( !srcDirectory.isEmpty() ) //cache is used
        {
            //consistency check information: size and modification time
            RioObjectSize size = searchInfo.getSize();
            AccessTime date = searchInfo.getTime();

            QString stringSize;
            stringSize += QString::number( size );

            //in the following lines, the method QString::rightJustify is used
            //to ensure formatting of date with the right amount of digits for
            //each parameter
            QString stringDate;
            stringDate += QString::number( date.Year ).rightJustify( 4, '0' );
            stringDate += QString::number( date.Month ).rightJustify( 2, '0' );
            stringDate += QString::number( date.Day ).rightJustify( 2, '0' );
            stringDate += QString::number( date.Hour ).rightJustify( 2, '0' );
            stringDate += QString::number( date.Minute ).rightJustify( 2, '0' );

            //relative path (to the main cache directory) of the file
            QString searchName = QString( objectName );
            searchName.remove( 0, srcDirectory.length() );
            searchName.remove( 0, 1 );
            
            vector<QDomElement>::iterator it;
            for( it = md5Cache.begin(); it != md5Cache.end() && !found; it++ )
            {
                if( (*it).attribute( "name" ) == searchName )
                //found file on the cache
                {
                    if( searchInfo.isDir() )
                    //don't check consistency for directories
                    {
                        md5sum = NULL;
                        return true;
                    }

                    found = true;

                    //CASE 1: consistency OK
                    if( stringSize == (*it).attribute( "size" ) &&
                        stringDate == (*it).attribute( "date" ) )
                    {
                        #ifdef RIO_DEBUG2
                        RioErr << "CASE 1: cache updated" << endl;
                        #endif

                        strcpy( md5sum,
                        (char *)(*it).attribute( "md5sum" ).latin1() );
                        //Why explicit typecast?
                    }
                    //CASE 2: consistency not OK: update cache
                    else
                    {
                        #ifdef RIO_DEBUG2
                        RioErr << "CASE 2: cache outdated" << endl;
                        RioErr << " file size = " << stringSize.latin1()
                               << ",  file date = " << stringDate.latin1() << endl;
                        RioErr << "cache size = " << (*it).attribute( "size" ).latin1()
                               << ", cache date = " << (*it).attribute( "date" ).latin1() << endl;
                        #endif

                        (*it).setAttribute( "size", stringSize );
                        (*it).setAttribute( "date", stringDate );

                        char buffer[MD5SIZE];
                        parent->setMD5Calculation( objectName, false );
                        QString md5 = calculateMD5( objectName, buffer );
                        parent->setMD5Calculation( objectName, true );
                        (*it).setAttribute( "md5sum", md5 );
                        strcpy( md5sum, (char *)md5.latin1() );
                    }
                    return true;
                }
            }
            //CASE 3: file not found on the cache: add it
            if( !found )
            {
                #ifdef RIO_DEBUG2
                RioErr << "CASE 3: no entry on cache" << endl;
                #endif

                char buffer[MD5SIZE];
                parent->setMD5Calculation( objectName, false );
                QString md5 = calculateMD5( objectName, buffer );
                parent->setMD5Calculation( objectName, true );

                if( searchInfo.isDir() ) //md5sum of a directory is NULL
                {
                    md5sum = NULL;
                    QDomDocument doc( "document" );
                    QDomElement newElement = doc.createElement( "dir" );
                    newElement.setAttribute( "name", searchName );
                    md5Cache.push_back( newElement );

                    return true;
                }

                QDomDocument doc( "document" );
                QDomElement newElement = doc.createElement( "file" );
                newElement.setAttribute( "name", searchName );
                newElement.setAttribute( "md5sum", md5 );
                newElement.setAttribute( "size", stringSize );
                newElement.setAttribute( "date", stringDate );
                md5Cache.push_back( newElement );

                strcpy( md5sum, (char *)md5.latin1() );
                return true;
                }
        }
        // CASE 4: cache not used
        else
        {
            #ifdef RIO_DEBUG2
            RioErr << "CASE 4: cache not used" << endl;
            #endif

            if( searchInfo.isDir() ) //md5sum of a directory is NULL
            {
                md5sum = NULL;
                return true;
            }
            char buffer[MD5SIZE];
            parent->setMD5Calculation( objectName, false );
            QString md5 = calculateMD5( objectName, buffer );
            parent->setMD5Calculation( objectName, true );
            strcpy( md5sum, (char *)md5.latin1() );
            return true;
        }
    }
    // CASE 5: REMOTE or SERVER object
    else
    {
        #ifdef RIO_DEBUG2
        RioErr << "CASE 5: not a local file" << endl;
        #endif

        searchInfo.getMd5sum( md5sum );
        return true;
    }
    //any existing file must fit any of the five cases; otherwise, it's an error
    md5sum = NULL;
    return false;
}

bool RioMd5::importData	(	QString	srcDirectory,
		CRioSession *	srcSession
	)

importData gets data from all files in srcDirectory and stores on md5Cache if RioMd5 was created with cache; used to load cache from remote md5 data

Definition at line 3740 of file RioExplorer.cpp.

{
    #ifdef RIO_DEBUG2
    RioErr << "Importing MD5 data from the RIO Session" << endl;
    #endif

    if( !srcDirectory.isNull() ) //cache created
    {
        md5Cache.clear();

        ObjectInfo dirInfo;
        vector<ObjectInfo> objInfo;
        vector<ObjectInfo> localObjInfo;
        vector<ObjectInfo>::iterator objIterator;
        vector<ObjectInfo>::iterator localObjIterator;

        if( !parent->getObjectInfo( (char*)srcDirectory.latin1(), srcSession,
            &dirInfo, false ) )
            return false;

        if( !parent->ls( &dirInfo, &objInfo, srcSession, true, true ) )
            return false;

        if( !parent->getObjectInfo( this->srcDirectory.latin1(), md5Session,
            &dirInfo, false ) )
            return false;

        if( !parent->ls( &dirInfo, &localObjInfo, md5Session, true, true ) )
            return false;

        for( objIterator = objInfo.begin();
             objIterator != objInfo.end();
             objIterator++ )
        {
            char          md5[MD5SIZE];
            QString       relativePath;
            QString       stringSize;
            QString       stringDate;
            AccessTime    date;
            RioObjectSize size;

            if( objIterator->isDir() )
            {
                relativePath = objIterator->getFullName();

                QDomDocument doc( "document" );
                QDomElement newElement = doc.createElement( "dir" );
                newElement.setAttribute( "name", relativePath );
                md5Cache.push_back( newElement );
            }
            else
            {
                relativePath = objIterator->getFullName();

                size = objIterator->getSize();
                stringSize += QString::number( size );

                objIterator->getMd5sum( md5 );
                // Unlike the "name", "md5sum" and "size" properties, the "date"
                // property does not need to be equal for both files in order
                // for them to match. We must use the local file as source of
                // this property's value, or we run the risk of causing an
                // inconsistency when checking whether the MD5Sum needs to be
                // recalculated.
                for( localObjIterator = localObjInfo.begin();
                     localObjIterator != localObjInfo.end();
                     localObjIterator++ )
                    if( localObjIterator->getFullName() == objIterator->getFullName() )
                        break;

                date = localObjIterator->getTime();

                // In the following lines, the method QString::rightJustify is
                // used to ensure formatting of date with the right amount of
                // digits for each parameter.
            stringDate += QString::number( date.Year ).rightJustify( 4, '0' );
            stringDate += QString::number( date.Month ).rightJustify( 2, '0' );
            stringDate += QString::number( date.Day ).rightJustify( 2, '0' );
            stringDate += QString::number( date.Hour ).rightJustify( 2, '0' );
            stringDate += QString::number( date.Minute ).rightJustify( 2, '0' );

                QDomDocument doc( "document" );
                QDomElement newElement = doc.createElement( "file" );
                newElement.setAttribute( "name", relativePath );
                newElement.setAttribute( "md5sum", md5 );
                newElement.setAttribute( "size", stringSize );
                newElement.setAttribute( "date", stringDate );
                md5Cache.push_back( newElement );
            }
        }
    }
    return true;
}

void RioMd5::loadCache	(	QString	src,
		vector< QDomElement > &	md5Cache
	)			[private]

loadCache carrega todos os itens armazenados na cache do diretório src e de todos os seus subdiretórios no vetor md5Cache.

Definition at line 3397 of file RioExplorer.cpp.

{
    //loading main XML structure
    QString cacheFile = src + '/' + MD5CACHEFILE;
    QDomDocument doc( cacheFile );
    QFile file( cacheFile );
    #ifdef RIO_DEBUG2
    RioErr << "Loading cache: " << cacheFile.latin1() << endl;
    #endif
    if ( !file.open( IO_ReadWrite ) )
    {
        #ifdef RIO_DEBUG2
        RioErr << "Could not open/create MD5Sum cache file." << endl;
        #endif
        return;
    }
    if ( !doc.setContent( &file ) )
    {
        #ifdef RIO_DEBUG2
        RioErr << "Could not set content: probably a corrupted or empty MD5Sum "
               << "cache file."
               << endl;
        #endif
        file.close();
        return;
    }

    //for each element:
    //1) add it to the cache vector
    //2) if it's a directory, load its cache too
    QDomNode node = doc.documentElement().firstChild();
    while( !node.isNull() )
    {
        if( node.isElement() )
        {
            QDomElement elem = node.toElement();
            QString path = src.copy();

            //getting relative path (to the main cache directory) of the file
            path.remove( 0, srcDirectory.length() );
            path.remove( 0, 1 );
            if( !path.isEmpty() ) path += '/';
            path += elem.attribute( "name" );
            elem.setAttribute( "name", path );

            md5Cache.push_back( elem );
            if( ( elem.tagName() == "dir" ) )
                loadCache( src + "/" +
                               elem.attribute( "name" ).section( '/', -1 ),
                           md5Cache );
        }
        node = node.nextSibling();
    }
    file.close();
}

bool RioMd5::updateCache

(

)

This method ensures that the cache, if existant, is fully updated.

That is, a file is present in the cache if, an only if, it exists in srcDirectory.

Definition at line 3645 of file RioExplorer.cpp.

{
    #ifdef RIO_DEBUG1
    RioErr << "Entered updateCache" << endl;
    #endif

    if( !parent->checkSession( md5Session ) )
        return false;

    #ifdef RIO_DEBUG2
    if( !srcDirectory.isEmpty() )
        RioErr << "Updating cache for " << srcDirectory.latin1() << endl;
    #endif

    if( !srcDirectory.isEmpty() ) //cache is used
    {
        ObjectInfo objInfo;
        vector<ObjectInfo> objectsInfo;
        vector<ObjectInfo>::iterator lsIterator;
        vector<QDomElement>::iterator cacheIterator;
        char md5Buffer[MD5SIZE];    
        memset( md5Buffer, 0, sizeof( md5Buffer ) );

        if( !parent->getObjectInfo( (char*)srcDirectory.latin1(), md5Session,
                                    &objInfo ) ||
            !parent->ls( &objInfo, &objectsInfo, md5Session, true, true )
          )
        {
            #ifdef RIO_DEBUG1
            RioErr << "Leaving updateCache [1]" << endl;
            #endif
            return false;
        }

        //this loop gets the MD5 checksum for all files in srcDirectory. This
        //will ensure the cache contains all existent files
        for( lsIterator = objectsInfo.begin(); lsIterator != objectsInfo.end();
            lsIterator++ )
        {
            if( (char *)MD5CACHEFILE.latin1() != lsIterator->getName() )
            {
                QString fileName = srcDirectory + '/' +
                                                      lsIterator->getFullName();
                getMd5Sum( (char *)fileName.latin1(), md5Buffer );
            }
        }
        //this loop removes from the cache all files that no inter exist
        for( cacheIterator = md5Cache.begin();
             cacheIterator != md5Cache.end(); )
        {
            QString fileName = srcDirectory + '/' +
                                             cacheIterator->attribute( "name" );
            if( !parent->getObjectInfo( (char *)fileName.latin1(), md5Session,
                    &objInfo ) )
                 md5Cache.erase( cacheIterator );
            else
                cacheIterator++;
        }
        #ifdef RIO_DEBUG1
        RioErr << "Leaving updateCache [2]" << endl;
        #endif
        return true;
    }
    else //cache isn't used: no need to update
    {
        #ifdef RIO_DEBUG1
        RioErr << "Leaving updateCache [3]" << endl;
        #endif
        return true;
    }
}

---

Field Documentation

vector<QDomElement> RioMd5::md5Cache [private]

Definition at line 244 of file RioExplorer.h.

QString RioMd5::MD5CACHEFILE [private]

Definition at line 245 of file RioExplorer.h.

CRioSession* RioMd5::md5Session [private]

Definition at line 242 of file RioExplorer.h.

RioExplorer* RioMd5::parent [private]

Definition at line 241 of file RioExplorer.h.

QString RioMd5::srcDirectory [private]

Definition at line 243 of file RioExplorer.h.

---

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

• RioExplorer.h
• RioExplorer.cpp