tPath Class Reference

#include <tDirectories.h>

Inheritance diagram for tPath:

[legend]

List of all members.

Public Member Functions
bool	Open (std::ifstream &f, const char *filename) const
bool	Open (std::ofstream &f, const char *filename, std::ios::openmode mode=std::ios::out, bool sensitive=false) const
bool	Open (std::fstream &f, const char *filename) const
tString	GetReadPath (const char *filename) const
tString	GetWritePath (const char *filename) const
tString	GetPaths (void) const
	Puts all paths into a tString for outputting to the user.
	tPath ()
virtual	~tPath ()
Static Public Member Functions
static bool	IsValidPath (char const *filename)
	checks whether filename is valid, i.e. does not endanger system security.
Protected Member Functions
virtual void	Paths (tArray< tString > &paths) const =0

---

Detailed Description

Definition at line 36 of file tDirectories.h.

---

Constructor & Destructor Documentation

tPath::tPath

(

)

[inline]

Definition at line 56 of file tDirectories.h.

{};

virtual tPath::~tPath

(

)

[inline, virtual]

Definition at line 57 of file tDirectories.h.

{};

---

Member Function Documentation

bool tPath::Open	(	std::ifstream &	f,
		const char *	filename
	)			const

Definition at line 729 of file tDirectories.cpp.

References IsValidPath(), GrowingArrayBase::Len(), and Paths().

Referenced by Load(), nServerInfo::Load(), tStatFile::open(), tTextFileRecorder::Open(), rModel::rModel(), and nServerInfo::Save().

{
    if ( !tPath::IsValidPath( filename ) )
        return false;

    tArray< tString > paths;
    Paths( paths );

    for ( int prio = paths.Len() - 1; prio>=0; --prio )
    {
        //  std::ifstream test;

        tString fullname;
        fullname << paths( prio ) << "/" << filename;

#ifdef PRINTSEARCH
#endif

        //  test.open( fullname );
        f.clear();
        f.open( fullname );

        //  if ( test )
        if ( f && f.good() )
        {
#ifdef PRINTSEARCH
            std::cout << "Trying to open " << fullname << " succeeded.";
#endif
            //   f.open( fullname );

            //   return f;
            return true;
        }

#ifdef PRINTSEARCH
        std::cout << "Trying to open " << fullname << " succeeded.";
#endif
    }

    return false;
}

Here is the call graph for this function:

Here is the caller graph for this function:

bool tPath::Open	(	std::ofstream &	f,
		const char *	filename,
		std::ios::openmode	mode = std::ios::out,
		bool	sensitive = false
	)			const

Definition at line 775 of file tDirectories.cpp.

References GetWritePath(), and IsValidPath().

{
    if ( !tPath::IsValidPath( filename ) )
        return false;

    // tArray< tString > paths;
    // Paths( paths );

    tString fullname = GetWritePath(filename);

#ifndef WIN32
    mode_t oldmask=0;
    if(sensitive && st_protectFiles)
    {
        oldmask = umask(0600);
    }
#endif
    f.open( fullname, mode );
#ifndef WIN32
    if(sensitive && st_protectFiles)
    {
        chmod( &fullname(0), 0600 );
        umask(oldmask);
    }
#endif

    return ( f && f.good() );
}

Here is the call graph for this function:

bool tPath::Open	(	std::fstream &	f,
		const char *	filename
	)			const

Definition at line 807 of file tDirectories.cpp.

References GetWritePath(), and in.

{
    //  std::cout << "open\n";

    tString fullname = GetWritePath(filename);
    f.open(fullname, std::ios::in | std::ios::out);

    return ( f.good() );
}

Here is the call graph for this function:

tString tPath::GetReadPath

(

const char *

filename

)

const

Definition at line 817 of file tDirectories.cpp.

References IsValidPath(), GrowingArrayBase::Len(), and Paths().

Referenced by rSurface::Create(), eSoundMixer::Init(), eWavData::Load(), tPlayList::LoadPlaylist(), eSoundMixer::LoadPlaylist(), tResourceManager::locateResource(), rFontContainer::New(), se_SoundInit(), sky_select(), and st_PrintPathInfo().

{
    if ( !tPath::IsValidPath( filename ) )
        return tString();

    tArray< tString > paths;
    Paths( paths );

    for ( int prio = paths.Len() - 1; prio>=0; --prio )
    {
        tString fullname;
        fullname << paths( prio ) << "/" << filename;
        std::ifstream f;

        //if (fullname != "./moviepack/sky.png")
#ifdef PRINTSEARCH
        printf("Searching %s...", (const char *)fullname);
#endif
        f.open( fullname );

        if ( f && f.good() )
        {
            //if (fullname != "./moviepack/sky.png")
#ifdef PRINTSEARCH
            printf("OK\n");
#endif
            return fullname;
        }
        //if (fullname != "./moviepack/sky.png")
#ifdef PRINTSEARCH
        printf("nope\n");
#endif
    }

    return tString();
}

Here is the call graph for this function:

Here is the caller graph for this function:

tString tPath::GetWritePath

(

const char *

filename

)

const

Reimplemented in tPathResource.

Definition at line 854 of file tDirectories.cpp.

References free, IsValidPath(), GrowingArrayBase::Len(), mkdir_recurse(), Paths(), strdup, and tERR_WARN.

Referenced by Open().

{
    if ( !tPath::IsValidPath( filename ) )
        return tString();

    tArray< tString > paths;
    Paths( paths );

    tString fullname;
    fullname << paths( paths.Len() -1 ) << "/" << filename;

    {
        bool s;

        char *fpmr = strdup( static_cast< char const * > ( fullname ) );
        s = mkdir_recurse(fpmr, paths( paths.Len() -1 ).Len());
        free(fpmr);

        if (!s)
        {
            tERR_WARN( "Could not create path to " << fullname << ". Check your user's rights." );
            return tString();
        }
    }

    return fullname;
}

Here is the call graph for this function:

Here is the caller graph for this function:

bool tPath::IsValidPath

(

char const *

filename

)

[static]

checks whether filename is valid, i.e. does not endanger system security.

checks whether a user given path, to be prepended with one of the AA directories, is a valid path (does not use dirty filename tricks to access portions of the file system it isn't supposed to access). It is called by all path finding functions of tPath automatically, you should only call it from outside of tDirectories.cpp if you want to avoid redundant error messages if you try several path resolutions.

Todo:

make this throw exceptions instead, right now nobody is there to catch them

Parameters:

filename

the user given filename to check

Returns:

true if no security issues were found

Definition at line 316 of file tDirectories.cpp.

References con, and st_IsPathDelimiter().

Referenced by _wrap_TPath_is_valid_path(), GetReadPath(), GetWritePath(), tPathResource::GetWritePath(), Open(), and st_Include().

{
    // always check for empty paths
    if ( !filename || filename[0] == 0 )
    {
        con << tOutput( "$directory_path_null" );
        return false;
    }

    // check for absolute paths (the system would not make them absolute, so no real
    // danger comes from them, but we check anyway)
    if ( st_checkPathAbsolute && ( st_IsPathDelimiter( filename[0] ) || strstr(filename,":") ) )
    {
        con << tOutput( "$directory_path_absolute", filename );
        return false;
    }

    // check for relative paths. Those are the real danger. Search for .. and see
    // if it surrounded by path delimiters or string ends.
    if ( st_checkPathRelative )
    {
        // traverse through occurences of ..
        char const * run = filename;
        while ( run && *run )
        {
            // find next ..
            run = strstr(run,"..");

            // check if before and after that come no path delimiters
            if ( run )
            {
                if ( ( run == filename || st_IsPathDelimiter( run[-1] ) ) &&
                        ( run[2] == 0 || st_IsPathDelimiter( run[2] ) ) )
                {
                    con << tOutput( "$directory_path_relative", filename );
                    return false;
                }

                // go on searching
                run ++;
            }
        }
    }

    // hidden paths are a path delimiter followed by a ., but not ..<delimiter>.
    if ( st_checkPathHidden )
    {
        // iterate path segments
        char const * run = filename;
        while ( run && *run )
        {
            // check if it is a hidden file
            if ( run[0] == '.' )
            {
                // don't give false alarm for relative paths
                if ( run[1] != '.' || ( !st_IsPathDelimiter( run[2] ) && run[2] != 0 ) )
                {
                    con << tOutput( "$directory_path_hidden", filename );
                    return false;
                }
            }

            // proceed to next path segments: find next path delimiter
            while ( *run && !st_IsPathDelimiter( *run ) )
                ++run;

            // go to next character after that
            if ( *run )
                ++run;
        }
    }

    return true;
}

Here is the call graph for this function:

Here is the caller graph for this function:

tString tPath::GetPaths

(

void

)

const

Puts all paths into a tString for outputting to the user.

Definition at line 1659 of file tDirectories.cpp.

References GrowingArrayBase::Len(), and Paths().

Referenced by st_PrintPathInfo().

                                  {
    tString ret;
    tArray<tString> paths;
    Paths(paths);
    for (int i = 0; i < paths.Len(); ++i) {
        if(i > 0 && paths[i - 1] == paths[i]) continue;
        ret << " - " << paths[i] << "\n";
    }
    return ret;
}

Here is the call graph for this function:

Here is the caller graph for this function:

virtual void tPath::Paths

(

tArray< tString > &

paths

)

const [protected, pure virtual]

Implemented in SwigDirector_TPath, tPathConfig, tPathData, tPathMusic, tPathVar, tPathScreenshot, tPathResource, and tPathScripts.

Referenced by GetPaths(), GetReadPath(), GetWritePath(), and Open().

Here is the caller graph for this function:

---

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

• src/tools/tDirectories.h
• src/tools/tDirectories.cpp

---