tpcfileutil.h File Reference

Header file for libtpcfileutil. More...

#include "tpcclibConfig.h"
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <ctype.h>
#include <time.h>
#include <unistd.h>
#include <dirent.h>
#include <sys/stat.h>
#include "tpcextensions.h"
#include "tpcift.h"

Go to the source code of this file.

Functions
int	fileBackup (const char *filename, const char *backup_ext, char *status)
int	fileExist (const char *filename)
unsigned short int	pathFileNr (const char *pathname)
unsigned short int	pathFileList (const char *pathname, IFT *ift)
int	pathExist (const char *pathname)
int	pathRemove (const char *pathname)
int	pathRemoveFiles (const char *pathname)
int	pathCreate (const char *pathname)

Detailed Description

Header file for libtpcfileutil.

Requires POSIX compatible compiler. The idea is to isolate system dependent functions from most of the code base to allow easier code changes when necessary.

Author

Vesa Oikonen

Definition in file tpcfileutil.h.

Function Documentation

fileBackup()

int fileBackup ( const char * filename, const char * backup_ext, char * status )

extern

Check if specified file exists; rename existing file to a backup file. If also backup file exists, then remove that.

Returns

Returns 0, if successful, and <>0 in case of an error.

Parameters

filename	Name of file which, if it exists, is renamed to a backup file.
backup_ext	Extension for backup file; NULL will set the default ".bak" extension.
status	Pointer to a string (allocated for at least 64 chars) where error message or other execution status will be written; enter NULL, if not needed.

Definition at line 17 of file backup.c.

  {
  char bakfile[FILENAME_MAX];
  int ret;
 
  // Check the input
  if(filename==NULL || strlen(filename)<1) {
    if(status!=NULL) sprintf(status, "invalid filename");
    return 1;
  }
 
  // Check if file exists; if not then no need to make any backup
  if(access(filename, 0) == -1) {
    if(status!=NULL) sprintf(status, "file does not pre-exist");
    return 0;
  }
  // Create filename for the backup file
  strlcpy(bakfile, filename, FILENAME_MAX);
  if(backup_ext==NULL) strlcat(bakfile, ".bak", FILENAME_MAX);
  else strlcat(bakfile, backup_ext, FILENAME_MAX);
  // If also backup file exists, then just delete it 
  if(access(bakfile, 0) != -1) {
    ret=remove(bakfile);
    if(ret!=0) {
      if(status!=NULL) sprintf(status, "cannot delete previous backup file");
      return 3;
    }
  }
  // Rename file
  ret=rename(filename, bakfile);
  if(ret!=0) {
    if(status!=NULL) sprintf(status, "cannot rename file as backup");
    return 5;
  }
  if(status!=NULL) sprintf(status, "file renamed as backup");
  return 0;
}

fileExist()

int fileExist ( const char * filename )

extern

Check if specified file (not path) exists.

See also

pathExist, pathFileNr, pathFileList, filenameRmPath, fncasematch, asciiFileRead

Returns

Returns 1, if file exists, and 0 if it does not or is not a regular file.

Parameters

filename

Name of file to check.

Definition at line 17 of file filexist.c.

  {
  if(filename==NULL || strnlen(filename, 2)<1) return(0);
  struct stat fst;
  if(stat(filename, &fst)!=0) return(0);
  if(S_ISREG(fst.st_mode)) return(1);
  return(0);
}

Referenced by anaExists(), dcmFileList(), imgRead(), imgWriteNifti(), micropetExists(), niftiExists(), niftiWriteHeader(), pathCreate(), pathFileList(), pathFileNr(), pathRemove(), and pathRemoveFiles().

pathCreate()

int pathCreate ( const char * pathname )

extern

Create path.

See also

pathExist, pathRemove, pathFileNr, filenameRmFile

Returns

Returns 0, if path could be created or exists already, 1, if it does not exist and cannot be created.

Parameters

pathname

Name of path to create; can contain subdirectories.

Definition at line 81 of file pathexist.c.

  {
  //printf("pathname='%s'\n", pathname);
  if(pathname==NULL || strnlen(pathname, 2)<1) return(1);
  if(fileExist(pathname)) return(1);
  if(pathExist(pathname)) return(0); // exists already
  // check if this is a subfolder
  char *lpath=strdup(pathname);
  char *cptr=strrchr(lpath, '/'); if(cptr==NULL) cptr=strrchr(lpath, '\\');
  if(cptr!=NULL) { // it is a subfolder, so call recursively with the parent folder name
    *cptr=(char)0;
    int ret=pathCreate(lpath);
    if(ret!=0) {free(lpath); return(1);}
  }
  free(lpath);
  // now try to create the folder
#ifndef HAVE__MKDIR
  // other than Windows
  if(mkdir(pathname, 0777)!=0 && errno!=EEXIST) return(1); else return(0);
#else
  // Windows (MinGW)
  if(_mkdir(pathname)!=0 && errno!=EEXIST) return(1); else return(0);
#endif
}

Referenced by imgWriteDICOM(), imgWriteNifti(), and pathCreate().

pathExist()

int pathExist ( const char * pathname )

extern

Check if specified directory (path) exists.

See also

fileExist, pathFileNr, filenameRmFile

Returns

Returns 1, if path exists, and 0 if it does not or is not a directory.

Parameters

pathname

Name of path to check.

Definition at line 17 of file pathexist.c.

  {
  if(pathname==NULL) return(0);
  int len=strlen(pathname);
  if(len<1) return(0);
  char *str=strdup(pathname);
  if(len>1 && str[len-1]=='/') {
    if(len<2) {free(str); return(0);}
    str[len-1]='\0';
  }
  struct stat fst;
  if(stat(str, &fst)!=0) {free(str); return(0);}
  free(str);
  if(S_ISDIR(fst.st_mode)) return(1);
  return(0);
}

Referenced by dcmFileList(), imgFormatFromFName(), imgRead(), imgWriteDICOM(), pathCreate(), pathFileList(), pathFileNr(), pathRemove(), and pathRemoveFiles().

pathFileList()

unsigned short int pathFileList ( const char * pathname, IFT * ift )

extern

List the names regular files in specified path into IFT structure. File names will contain the directory path.

Returns

Returns the number of stored regular file names.

See also

pathFileNr, iftInit, iftFree

Parameters

pathname	Name of path.
ift	Pointer to initiated IFT structure; any previous contents are kept.

Definition at line 83 of file filexist.c.

  {
  if(pathname==NULL || strnlen(pathname, 2)<1) return(0);
  if(ift==NULL) return(0);
  /* Check that path exists */
  if(!pathExist(pathname)) return(0);
  /* Open the directory */
  DIR *dp;
  dp=opendir(pathname); if(dp==NULL) return(0);
#if(1)
  char tempname[2*FILENAME_MAX];
  unsigned short int n=0;
  struct dirent *de;
  /* Go throught the directory */
  while((de=readdir(dp))!=NULL) {
    if(de->d_name[0]=='.') continue; /* Ignore hidden and 'system' dirs */
    /* Combine path and name */
    sprintf(tempname, "%s/%s", pathname, de->d_name);
    /* Check that it is regular file */
    if(!fileExist(tempname)) continue;
    /* Add to IFT */
    if(iftPut(ift, NULL, tempname, 0, NULL)) break;
    n++;
  }
#else  // readdir_r deprecated
  struct dirent de, *deptr;
  char tempname[2*FILENAME_MAX];
  unsigned short int n=0;
  /* Go throught the directory */
  while(readdir_r(dp, &de, &deptr)==0 && deptr!=NULL) {
    if(de.d_name[0]=='.') continue; /* Ignore hidden and 'system' dirs */
    /* Combine path and name */
    sprintf(tempname, "%s/%s", pathname, de.d_name);
    /* Check that it is regular file */
    if(!fileExist(tempname)) continue;
    /* Add to IFT */
    if(iftPut(ift, NULL, tempname, 0, NULL)) break;
    n++;
  }
#endif
  closedir(dp);
  return(n);
}

Referenced by dcmFileList(), imgRead(), and pathRemoveFiles().

pathFileNr()

unsigned short int pathFileNr ( const char * pathname )

extern

Returns

Returns the number of regular files in specified path.

See also

pathExist, fileExist, pathFileList

Parameters

pathname

Name of path.

Definition at line 33 of file filexist.c.

  {
  if(pathname==NULL || strnlen(pathname, 2)<1) return(0);
  /* Check that path exists */
  if(!pathExist(pathname)) return(0);
  /* Open the directory */
  DIR *dp;
  dp=opendir(pathname); if(dp==NULL) return(0);
#if(1)
  char tempname[2*FILENAME_MAX];
  unsigned short int n=0;
  struct dirent *de;
  /* Go through the directory */
  while((de=readdir(dp))!=NULL) {
    //printf("d_name='%s'\n", de.d_name);
    if(de->d_name[0]=='.') continue; /* Ignore hidden and 'system' dirs */
    /* Combine path and name */
    sprintf(tempname, "%s/%s", pathname, de->d_name);
    //printf("name='%s'\n", tempname);
    /* Check that it is regular file */
    if(fileExist(tempname)) n++;
  }
#else  // readdir_r deprecated
  struct dirent de, *deptr;
  char tempname[2*FILENAME_MAX];
  unsigned short int n=0;
  /* Go through the directory */
  while(readdir_r(dp, &de, &deptr)==0 && deptr!=NULL) {
    //printf("d_name='%s'\n", de.d_name);
    if(de.d_name[0]=='.') continue; /* Ignore hidden and 'system' dirs */
    /* Combine path and name */
    sprintf(tempname, "%s/%s", pathname, de.d_name);
    //printf("name='%s'\n", tempname);
    /* Check that it is regular file */
    if(fileExist(tempname)) n++;
  }
#endif
  closedir(dp);
  return(n);
}

Referenced by imgRead(), and imgWriteDICOM().

pathRemove()

int pathRemove ( const char * pathname )

extern

Remove path.

See also

fileExist, pathFileNr, filenameRmFile

Returns

Returns 0, if path could be removed or it did not exist, 1, if it exists and cannot be removed.

Parameters

pathname

Name of path to remove.

Definition at line 43 of file pathexist.c.

  {
  if(fileExist(pathname)) return(1);
  if(!pathExist(pathname)) return(0);
  if(rmdir(pathname)==0) return(0); else return(1);
}

Referenced by imgWriteDICOM().

pathRemoveFiles()

int pathRemoveFiles ( const char * pathname )

extern

Remove regular files in specified path. Subfolders are not affected.

See also

fileExist, pathFileNr, pathFileList, pathRemove

Returns

Returns 0, if files could be removed or did not exist, 1, in case of an error.

Parameters

pathname

Name of path from where to remove files.

Definition at line 58 of file pathexist.c.

  {
  if(fileExist(pathname)) return(1); // Error if filename was given
  if(!pathExist(pathname)) return(0); // No error if path does not exist
  IFT ift; iftInit(&ift);
  unsigned short int n=pathFileList(pathname, &ift);
  if(n==0) {iftFree(&ift); return(0);}
  for(int i=0; i<ift.keyNr; i++) {
    if(remove(ift.item[i].value)) {iftFree(&ift); return(1);}
  }
  iftFree(&ift);
  return(0);
}