Open Source Projects Europe

#define _PATHUT_H_INCLUDED_

#define _PATHUT_H_INCLUDED_

#include <unistd.h>

#include <unistd.h>

#include <string>

#include <string>

#include <vector>

#include <vector>

#include "refcntr.h"

#include "refcntr.h"

/// Add a / at the end if none there yet.

/// Add a / at the end if none there yet.

extern void path_catslash(string &s);

/// Concatenate 2 paths

/// Concatenate 2 paths

extern string path_cat(const string &s1, const string &s2);

/// Get the simple file name (get rid of any directory path prefix

/// Get the simple file name (get rid of any directory path prefix

extern string path_getsimple(const string &s);

/// Simple file name + optional suffix stripping

/// Simple file name + optional suffix stripping

/// Get the father directory

/// Get the father directory

extern string path_getfather(const string &s);

/// Get the current user's home directory

/// Get the current user's home directory

extern string path_home();

/// Expand ~ at the beginning of string 

extern string path_tildexpand(const string &s);

/// Use getcwd() to make absolute path if needed. Beware: ***this can fail***

/// Use getcwd() to make absolute path if needed. Beware: ***this can fail***

/// we return an empty path in this case.

/// we return an empty path in this case.

extern string path_absolute(const string &s);

/// Clean up path by removing duplicated / and resolving ../ + make it absolute

/// Clean up path by removing duplicated / and resolving ../ + make it absolute

extern string path_canon(const string &s);

/// Use glob(3) to return the file names matching pattern inside dir

/// Use glob(3) to return the file names matching pattern inside dir

extern vector<string> path_dirglob(const string &dir, 

                   const string pattern);

/// Encode according to rfc 1738

/// Encode according to rfc 1738

extern string url_encode(const string& url, 

                  string::size_type offs = 0);

/// Transcode to utf-8 if possible or url encoding, for display.

/// Transcode to utf-8 if possible or url encoding, for display.

extern bool printableUrl(const string &fcharset, 

             const string &in, string &out);

//// Convert to file path if url is like file://. This modifies the

//// Convert to file path if url is like file://. This modifies the

//// input (and returns a copy for convenience)

//// input (and returns a copy for convenience)

extern string fileurltolocalpath(string url);

/// Test for file:/// url

/// Test for file:/// url

extern bool urlisfileurl(const string& url);

/// Return the host+path part of an url. This is not a general

/// Return the host+path part of an url. This is not a general

/// routine, it does the right thing only in the recoll context

/// routine, it does the right thing only in the recoll context

extern string url_gpath(const string& url);

/// Stat parameter and check if it's a directory

/// Stat parameter and check if it's a directory

extern bool path_isdir(const string& path);

/** A small wrapper around statfs et al, to return percentage of disk

/** A small wrapper around statfs et al, to return percentage of disk

    occupation */

    occupation */

bool fsocc(const string &path, int *pc, // Percent occupied

       long *avmbs = 0 // Mbs available to non-superuser

       long *avmbs = 0 // Mbs available to non-superuser

       );

       );

/// Retrieve the temp dir location: $RECOLL_TMPDIR else $TMPDIR else /tmp

/// Retrieve the temp dir location: $RECOLL_TMPDIR else $TMPDIR else /tmp

extern const string& tmplocation();

/// Create temporary directory (inside the temp location)

/// Create temporary directory (inside the temp location)

/// mkdir -p

/// mkdir -p

extern bool makepath(const string& path);

/// Temporary file class

/// Temporary file class

class TempFileInternal {

class TempFileInternal {

public:

public:

    TempFileInternal(const string& suffix);

    ~TempFileInternal();

    ~TempFileInternal();

    const char *filename() 

    const char *filename() 

    {

    {

    return m_filename.c_str();

    return m_filename.c_str();

    }

    }

    const string &getreason() 

    {

    {

    return m_reason;

    return m_reason;

    }

    }

    void setnoremove(bool onoff)

    void setnoremove(bool onoff)

    {

    {

    bool ok() 

    bool ok() 

    {

    {

    return !m_filename.empty();

    return !m_filename.empty();

    }

    }

private:

private:

    string m_filename;

    string m_reason;

    bool m_noremove;

    bool m_noremove;

};

};

typedef RefCntr<TempFileInternal> TempFile;

typedef RefCntr<TempFileInternal> TempFile;

class TempDir {

class TempDir {

public:

public:

    TempDir();

    TempDir();

    ~TempDir();

    ~TempDir();

    const char *dirname() {return m_dirname.c_str();}

    const char *dirname() {return m_dirname.c_str();}

    const string &getreason() {return m_reason;}

    bool ok() {return !m_dirname.empty();}

    bool ok() {return !m_dirname.empty();}

    /// Recursively delete contents but not self.

    /// Recursively delete contents but not self.

    bool wipe();

    bool wipe();

private:

private:

    string m_dirname;

    string m_reason;

    TempDir(const TempDir &) {}

    TempDir(const TempDir &) {}

    TempDir& operator=(const TempDir &) {return *this;};

    TempDir& operator=(const TempDir &) {return *this;};

};

};

/// Lock/pid file class. This is quite close to the pidfile_xxx

/// Lock/pid file class. This is quite close to the pidfile_xxx

/// utilities in FreeBSD with a bit more encapsulation. I'd have used

/// utilities in FreeBSD with a bit more encapsulation. I'd have used

/// the freebsd code if it was available elsewhere

/// the freebsd code if it was available elsewhere

class Pidfile {

class Pidfile {

public:

public:

    Pidfile(const string& path) : m_path(path), m_fd(-1) {}

    ~Pidfile();

    ~Pidfile();

    /// Open/create the pid file.

    /// Open/create the pid file.

    /// @return 0 if ok, > 0 for pid of existing process, -1 for other error.

    /// @return 0 if ok, > 0 for pid of existing process, -1 for other error.

    pid_t open();

    pid_t open();

    /// Write pid into the pid file

    /// Write pid into the pid file

    int write_pid();

    int write_pid();

    /// Close the pid file (unlocks)

    /// Close the pid file (unlocks)

    int close();

    int close();

    /// Delete the pid file

    /// Delete the pid file

    int remove();

    int remove();

    const string& getreason() {return m_reason;}

private:

private:

    string m_path;

    int    m_fd;

    int    m_fd;

    string m_reason;

    pid_t read_pid();

    pid_t read_pid();

    int flopen();

    int flopen();

};

};

// Freedesktop thumbnail standard path routine

// Freedesktop thumbnail standard path routine

// On return, path will have the appropriate value in all cases,

// On return, path will have the appropriate value in all cases,

// returns true if the file already exists

// returns true if the file already exists

extern bool thumbPathForUrl(const string& url, int size, string& path);

// Must be called in main thread before starting other threads

// Must be called in main thread before starting other threads

extern void pathut_init_mt();

extern void pathut_init_mt();

#endif /* _PATHUT_H_INCLUDED_ */

#endif /* _PATHUT_H_INCLUDED_ */