FWD » Core Development » Conversion Tools

/*

** Module   : filesys.c

** Abstract : implementation for detection of symbolic links, non-FIFO pipes

**            and special devices (used by com.goldencode.p2j.util.FileChecker)

**

** Copyright (c) 2013-2018, Golden Code Development Corporation.

**

** -#- -I- --Date-- --------------------------------Description---------------------------------

** 001 CS  20130104 First version for OS-DIR support as an INPUT stream task.

** 002 CS  20130115 Task 1613: finish FILE-INFO system handle support (added a native function

**                  for getting the file creation date time).

** 003 EVL 20130329 Made changes to compile as a Windows DLL.

** 004 GES 20131029 Cleaned up possible memory leaks where we weren't releasing our reference to

**                  the string on the Java heap. Made code formatting improvements.

** 005 EVL 20140221 Adding call to check if the STDOUT is redirected in command line.

** 006 OM  20170206 Fixed file information bits for Windows OS.

** 007 EVL 20180206 Fix file separator platform dependency.

** 008 EVL 20180530 Adding support for native get/set working directory.

** 009 EVL 20181016 Fix for missing get_current_dir_name() function in MinGW fro Windows package.

**                  We have to use more common CRT function to get the current directory for both

**                  Windows and Linux/UNIX environments.

*/ 

/*

** This program is free software: you can redistribute it and/or modify

** it under the terms of the GNU Affero General Public License as

** published by the Free Software Foundation, either version 3 of the

** License, or (at your option) any later version.

**

** This program is distributed in the hope that it will be useful,

** but WITHOUT ANY WARRANTY; without even the implied warranty of

** MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

** GNU Affero General Public License for more details.

**

** You may find a copy of the GNU Affero GPL version 3 at the following

** location: https://www.gnu.org/licenses/agpl-3.0.en.html

** 

** Additional terms under GNU Affero GPL version 3 section 7:

** 

**   Under Section 7 of the GNU Affero GPL version 3, the following additional

**   terms apply to the works covered under the License.  These additional terms

**   are non-permissive additional terms allowed under Section 7 of the GNU

**   Affero GPL version 3 and may not be removed by you.

** 

**   0. Attribution Requirement.

** 

**     You must preserve all legal notices or author attributions in the covered

**     work or Appropriate Legal Notices displayed by works containing the covered

**     work.  You may not remove from the covered work any author or developer

**     credit already included within the covered work.

** 

**   1. No License To Use Trademarks.

** 

**     This license does not grant any license or rights to use the trademarks

**     Golden Code, FWD, any Golden Code or FWD logo, or any other trademarks

**     of Golden Code Development Corporation. You are not authorized to use the

**     name Golden Code, FWD, or the names of any author or contributor, for

**     publicity purposes without written authorization.

** 

**   2. No Misrepresentation of Affiliation.

** 

**     You may not represent yourself as Golden Code Development Corporation or FWD.

** 

**     You may not represent yourself for publicity purposes as associated with

**     Golden Code Development Corporation, FWD, or any author or contributor to

**     the covered work, without written authorization.

** 

**   3. No Misrepresentation of Source or Origin.

** 

**     You may not represent the covered work as solely your work.  All modified

**     versions of the covered work must be marked in a reasonable way to make it

**     clear that the modified work is not originating from Golden Code Development

**     Corporation or FWD.  All modified versions must contain the notices of

**     attribution required in this license.

*/

#include "filesys.h"

#include "com_goldencode_p2j_util_FileChecker.h"

#include "com_goldencode_p2j_util_FileSystemDaemon.h"

/**

 * Utility method to check the type of the given file.

 * <p>

 * There are 4 main types a file can be: Directory , File , Device and Unknown. In addition to

 * the 4 main types there are 3 additive stats (they can be added to the main type). For example,

 * FH has both FILE and HIDDEN flags marked and DL has both DIRECTORY and LINK flags.

 * <p>

 * In some cases the additive status can only be added to a specific main type.  For example,

 * in Progress only hidden files are marked as hidden, hidden directories are only marked as

 * directory.

 *

 * @param    env 

 *           pointer to a structure that provides access to JNI environment

 * @param    jc 

 *           reference to the Java class who called this function

 *           (from static context)

 * @param    fname 

 *           The file name to be checked passed from FileChecker.checkFileType()

 *

 * @return   An bitfield representing the status codes for the given pathname.

 */

JNIEXPORT jint JNICALL 

       Java_com_goldencode_p2j_util_FileChecker_checkFileType(JNIEnv  *env,

                                                              jclass  jc, 

                                                              jstring fname) 

{

   const char *file_path = (*env)->GetStringUTFChars(env, fname, NULL);

   if (file_path == NULL) 

   {

      return -1; /* OutOfMemoryError already thrown */

   }

   int status = UNIX;

   int fd     = open_native(file_path, O_RDONLY);

   if (fd < 0)

   {

      // free the string on the Java heap

      (*env)->ReleaseStringUTFChars(env, fname, file_path);

     return getSymLinkStatus(env, file_path, status);

   }

   struct stat st;

   // Use fstat to detect files and directories or links that point to files

   // and directories as files or directories

   if (fstat(fd, &st)) 

   {

      // close the file 

      close(fd);

      // free the string on the Java heap

      (*env)->ReleaseStringUTFChars(env, fname, file_path);

      // allow more advanced queries to be performed, that don't involve opening the file

      return getSymLinkStatus(env, file_path, status); 

   }

   // check if regular file

   if (S_ISREG(st.st_mode)) 

   {

      // file status is standalone status

      status |= FILE;

   }

   // extract the filename from the path

   // replicate the Unix 4GL bug in which upper dir appears as hidden

   // by nontreating .. special case when checking for hidden.

   char* filename = (strrchr(file_path, getFileSeparator())) + 1;

   // in unix hidden files don't have a property that determines if

   // they are hidden instead a hidden file will start with '.'

   //check if first letter is '.'

   if (*filename == '.')

   {

      // hidden status is additive status

      status |= HIDDEN;

   }

   // check if file is directory

   if (S_ISDIR(st.st_mode)) 

   { 

      status |= DIR;

   }

   // check for fifo pipe

   if (S_ISFIFO(st.st_mode))

   {

      // Pipe code status is additive but may not detected as file

      // File code status is also added if

      if (!(status & FILE))

      {

         status |= FILE;

      }

      status |= PIPE;

   }

   // close the file 

   close(fd);

   // get the platform specific sym link status

   status = getSymLinkStatus(env, file_path, status);

   // free the string on the Java heap

   (*env)->ReleaseStringUTFChars(env, fname, file_path);

   return status;

}

/**

 * Utility method that will return the creation date of a file 

 * represented as milliseconds from year 1970.

 * 

 * @param    env 

 *           pointer to a structure that provides access to JNI environment

 * @param    jc 

 *           reference to the Java class who called this function

 *           (from static context)

 * @param    fname 

 *           The file name to be checked passed from 

 *           FileChecker.getFileCreationTime.

 *           

 * @return   A wrapped integer representing the  file creation time in 

 *           milliseconds from 1970 or -1 if operation has failed , 

 *           (real data cannot be -1 since precision

 *           for returned date is at the level of seconds).

 */

JNIEXPORT jlong JNICALL 

   Java_com_goldencode_p2j_util_FileChecker_getFileCreationTime(JNIEnv  *env,

                                                                jclass  jc, 

                                                                jstring fname) 

{

   const char *file_path = (*env)->GetStringUTFChars(env, fname, NULL);

   if (file_path == NULL) 

   {

      return -1; // OutOfMemoryError already thrown

   }

   struct stat st;

   int rc = stat(file_path, &st);

   (*env)->ReleaseStringUTFChars(env, fname, file_path);

   if (rc != 0) 

   {

      return -1; 

   }

   // the return variable must be long long otherwise it will truncate

   // on Linux/UNIX the only date that is kept is last modify time

   long long m = (long long) st.st_ctime;

   return m * 1000L;

}

/**

 * Utility method that will return the value of the system environment variable with a given

 * name. 

 * 

 * @param    env 

 *           pointer to a structure that provides access to JNI environment

 * @param    jc 

 *           reference to the Java class who called this function

 *           (from static context)

 * @param    vname 

 *           The name of the environment variable to get.

 *           

 * @return   A string representing the system anvironment variable if exists or NULL pointer if 

 *           the varable is unknown.

 */

JNIEXPORT jstring JNICALL 

   Java_com_goldencode_p2j_util_FileSystemDaemon_getEnvironmentValue(JNIEnv  *env,

                                                                     jclass  jc, 

                                                                     jstring vname) 

{

   const char* env_var = (*env)->GetStringUTFChars(env, vname, NULL);

   char* result = NULL;

   if (env_var != NULL)

   {

      if (strlen(env_var) > 0)

      {

         result = getenv(env_var);

      }

      (*env)->ReleaseStringUTFChars(env, vname, env_var);

   }

   return (result != NULL) ? (*env)->NewStringUTF(env, result) : NULL;

}

/**

 * Checks if the current STDOUT handle is redirected to the file by command line option.

 *

 * @param    env 

 *           pointer to a structure that provides access to JNI environment

 * @param    jc 

 *           reference to the Java class who called this function

 *           (from static context)

 *

 * @return   <code>true</code> if STDOUT is redirected <code>false</code> otherwise.

 */

JNIEXPORT jboolean JNICALL

   Java_com_goldencode_p2j_util_FileChecker_isStdoutRedirected(JNIEnv *env, jclass  jc)

{

   struct stat st;

   return (fstat(STDOUT_FILENO, &st) == 0) && // Means success call to fstat

          (S_ISCHR(st.st_mode) == 0) &&       // The output is not character device

          (S_ISREG(st.st_mode) != 0);         // but regular file

}

/**

 * Gets current setting for working directory.

 *

 * @param    env 

 *           pointer to a structure that provides access to JNI environment

 * @param    jc 

 *           reference to the Java class who called this function

 *           (from static context)

 *

 * @return   string with requested current directory or NULL in case of failure.

 */

JNIEXPORT jstring JNICALL

   Java_com_goldencode_p2j_util_FileSystemDaemon_getWorkingDir(JNIEnv *env, jclass jc)

{

   char* curr_dir = NULL;

   jstring jsRes = NULL;

   // use the common CRT function which works on both Windows and Linux/UNIX

   curr_dir = (char*)getcwd(NULL, 0);

   if (curr_dir != NULL)

   {

      // make a copy to return to Java

      jsRes = (*env)->NewStringUTF(env, curr_dir);

      // get_current_dir_name() does malloc to store the value - we need to free memory

      free(curr_dir);

   }

   return jsRes;

}

/**

 * Sets new working directory.

 *

 * @param    env 

 *           pointer to a structure that provides access to JNI environment

 * @param    jc 

 *           reference to the Java class who called this function

 *           (from static context)

 *

 * @return   <code>true</code> if success <code>false</code> otherwise.

 */

JNIEXPORT jboolean JNICALL

   Java_com_goldencode_p2j_util_FileSystemDaemon_setWorkingDir(JNIEnv *env,

                                                               jclass jc,

                                                               jstring newDirName)

{

   int rc = -1;

   const char* new_dir = (*env)->GetStringUTFChars(env, newDirName, NULL);

   if (new_dir != NULL)

   {

      rc = chdir(new_dir);

      (*env)->ReleaseStringUTFChars(env, newDirName, new_dir);

   }

   return rc == 0;

}