Files checking feature added

A check is done on the type before opening
  parameters input, parameters output or wave sound output.
The regular file type is always allowed.
The directory type is always rejected.
Others are accepted or rejected depending the calling parameters.

Author: ElecGeek

cpp_version/params_io_handler.cpp

@@ -43,6 +43,44 @@ string params_fio_handler_base::GetInfos()
   info_fio_params.clear();
   return the_return;
 }
+optional<string> params_fio_handler_base::
+FileTypeChecker( const filesystem::path& the_path,
+				 const string&prefix,
+				 const bool&check_exists, const bool& check_not_fifo, const bool&check_not_dev_char)
+{
+  filesystem::file_status the_file_status( filesystem::status( the_path ));
+  if ( filesystem::exists( the_file_status ) == false )
+	{
+	  if ( check_exists )
+		return prefix + string(" file ") + the_path.filename().string() + string(" not found");
+	  else
+		return nullopt;
+	}
+  if ( filesystem::is_regular_file( the_file_status ))
+	return nullopt;
+  if ( filesystem::is_fifo( the_file_status ) )
+	{
+	  if ( check_not_fifo ) 
+		  return prefix + string(" ") + the_path.filename().string() + string(" should NOT be a fifo");
+	  else
+		return nullopt;
+	}
+  if (filesystem::is_directory( the_file_status ) )
+	return prefix + string(" ") + the_path.filename().string() + string(" should NOT be a directory");
+	   
+  // Since we ask to follow symlinks to the destination,
+  //   it is claimed as a symlink only if it points on nothing.
+  if (filesystem::is_symlink( the_file_status ) )
+	return prefix + string(" ") + the_path.filename().string() + string(" should NOT be a symlink");
+  if ( filesystem::is_character_file( the_file_status ) )
+	{
+	  if ( check_not_dev_char ) 
+		  return prefix + string(" ") + the_path.filename().string() + string(" should NOT be a char device");
+	  else
+		return nullopt;
+	}
+  return prefix + string(" ") + the_path.filename().string() + string(" should NOT be a dev block nor socket");
+}
 
 
 params_input_handler::params_input_handler():
@@ -59,11 +97,11 @@ params_input_handler::params_input_handler():
 {}
 
 
-/* @breif Validate options in the current channel
+/* @brief Validate options in the current channel
  *
  * Each time the software receives a new input (-i), a new output (-o)
  * or a flush (calling parameters are over), the pending input options are tested and
- * if everythingare is correct, a structure is added to the input channels list.
+ * if everything is correct, a structure is added to the input channels list.
  * If something is wrong, the options of this input are discarded.
  * That does NOT prevent the usage of other input channels
  */
@@ -101,7 +139,7 @@ void params_input_handler::AddChannelOptions( const options_list_t  & opts_list
 		if( it.second == in_format->second )
 		  {
 			info_fio_params << "The input commands format "<<in_format->second;
-			info_fio_params << " is not yet supported, comming soon"<<endl;
+			info_fio_params << " is not yet supported, coming soon"<<endl;
 			return;
 		  }
 	  info_fio_params << "The input commands format "<<in_format->second;
@@ -114,7 +152,7 @@ void params_input_handler::AddChannelOptions( const options_list_t  & opts_list
 void params_input_handler::CreateInputChannels(const unsigned short&loop_counter)
 {
   // For the input channels there is a sanity check.
-  // If the type is explicitely defined, the check verifies the input. If false, the input is omitted.
+  // If the type is explicitly defined, the check verifies the input. If false, the input is omitted.
   // If the type is not defined, the software tries to identify with the sanity checks.
   for( auto& chan : fio_channels_with_opts )
 	{
@@ -136,8 +174,20 @@ void params_input_handler::CreateInputChannels(const unsigned short&loop_counter
 			  ifstream input_stream;
 			  if( (*in_opt_name).second.compare( "-" ))
 				{
-		   		  input_stream.open( (*in_opt_name).second, ios_base::in );
-				  if( input_stream.is_open() )
+				  bool file_is_opened = false;
+				  filesystem::path the_path( (*in_opt_name).second );
+				  optional<string> ftc = FileTypeChecker( the_path, "Input commands", true, false, true );
+				  if ( ftc )
+					info_fio_params << *ftc << endl;
+				  else
+					{
+					  input_stream.open( the_path, ios_base::in );
+					  file_is_opened = input_stream.is_open();
+					  if ( file_is_opened == false )
+						cout << "Problem opening " << the_path.filename() << ", check the permissions" << endl;
+					}
+
+				  if( file_is_opened )
 					{
 					  switch( chan.first )
 						{
@@ -169,11 +219,6 @@ void params_input_handler::CreateInputChannels(const unsigned short&loop_counter
 						  break;
 						}
 					}
-				  else
-					{
-					  info_fio_params << "Problem opening file " << (*in_opt_name).second;
-					  info_fio_params << ", check directory and permissions" << endl;
-					}
 				}
 			  else
 				switch( chan.first )
@@ -233,7 +278,7 @@ params_output_handler::params_output_handler():
  *
  * Each time the software receives a new input (-i), a new output (-o)
  * or a flush (calling parameters are over), the pending output options are tested and
- * if everythingare is correct, a structure is added to the output channels list.
+ * if everything is correct, a structure is added to the output channels list.
  * If something is wrong, the options of this output are discarded.
  * That does NOT prevent the usage of other output channels
  */
@@ -264,14 +309,14 @@ void params_output_handler::AddChannelOptions( const options_list_t  & opts_list
 		if( it.second == out_format->second )
 		  {
 			info_fio_params << "The output commands format "<<out_format->second;
-			info_fio_params << " is not yet supported, comming soon"<<endl;
+			info_fio_params << " is not yet supported, coming soon"<<endl;
 			return;
 		  }
 	  info_fio_params << "The output commands format "<<out_format->second;
 	  info_fio_params << " is unknown"<<endl;
 	  return;
 	}
-  // no format info, use a defult
+  // no format info, use a default
   else
 	fio_channels_with_opts.push_back( make_pair( params_io_text, opts_list ));
 }
@@ -301,8 +346,20 @@ void params_output_handler::CreateOutputChannels(void)
 
 			  if( (*out_opt_name).second.compare( "-" ))
 				{
-				  output_stream.open( (*out_opt_name).second, ios_base::out );
-				  if( output_stream.is_open() )
+				  bool file_is_opened = false;
+				  filesystem::path the_path( (*out_opt_name).second );
+				  optional<string> ftc = FileTypeChecker( the_path, "Output commands", false, false, true );
+				  if ( ftc )
+					info_fio_params << *ftc << endl;
+				  else
+					{
+					  output_stream.open( the_path, ios_base::out );
+					  file_is_opened = output_stream.is_open();
+					  if ( file_is_opened == false )
+						cout << "Problem opening " << the_path.filename() << ", check the permissions" << endl;
+					}
+
+				  if( file_is_opened )
 					{
 					  switch( chan.first )
 						{
@@ -325,11 +382,6 @@ void params_output_handler::CreateOutputChannels(void)
 						  break;
 						}
 					}
-				  else
-					{
-					  info_fio_params << "Problem opening file " << (*out_opt_name).second;
-					  info_fio_params << ", check directory and permissions" << endl;
-					}
 				}
 			  else
 				switch( chan.first )
@@ -418,22 +470,22 @@ void params_file_handler::AddChannelOptions( const options_list_t & opts_list )
 		if( it.second == out_format->second )
 		  {
 			info_fio_params << "The file format format "<<out_format->second;
-			info_fio_params << " is not yet supported, comming soon"<<endl;
+			info_fio_params << " is not yet supported, coming soon"<<endl;
 			return;
 		  }
 	  info_fio_params << "The file format "<<out_format->second;
 	  info_fio_params << " is unknown"<<endl;
 	  return;
 	}
-  // no format info, use a defult
+  // no format info, use a default
   else
 	fio_channels_with_opts.push_back( make_pair( params_file_16BE, opts_list ));
 }
 void params_file_handler::EnvironementNeeds(void)
 {}
 void params_file_handler::CreateOutputFile()
 {
-  // This may be temporary as today, there is only one possiblie file at a time
+  // This may be temporary as today, there is only one possible file at a time
   if ( fio_channels_with_opts.empty() == false )
 	{
 	  auto chan = fio_channels_with_opts.rbegin();
@@ -458,8 +510,23 @@ void params_file_handler::CreateOutputFile()
 		{
 		  if( (*file_opt_name).second.compare( "-" ))
 			{
-			  output_file_stream.open( (*file_opt_name).second, ostream::binary | ostream::trunc );
-			  info_fio_params << "Opening the output file" << (*file_opt_name).second << endl; 
+				  bool file_is_opened = false;
+				  filesystem::path the_path( (*file_opt_name).second );
+				  optional<string> ftc = FileTypeChecker( the_path, "Output sound file", false, true, true );
+				  if ( ftc )
+					info_fio_params << *ftc << endl;
+				  else
+					{
+					  output_file_stream.open( the_path, ostream::binary | ostream::trunc );
+					  file_is_opened = output_file_stream.is_open();
+					  if ( file_is_opened == false )
+						cout << "Problem opening " << the_path.filename() << ", check the permissions" << endl;
+					  else
+						info_fio_params << "Opening the output file" << the_path.filename() << endl; 
+					}
+				  // *************************************************
+				  // Should do something if the file can not be opened
+				  // *************************************************
 			}else{
 			info_fio_params << "Using the standard output for the file output is discourageous" << endl;
 		  }

cpp_version/params_io_handler.hxx

@@ -5,6 +5,8 @@
 #include <iostream>
 #include <sstream>
 #include <set>
+#include <optional>
+#include <filesystem>
 // #include <execution>
 
 #ifndef __PARAMS_IO_HANDLER__
@@ -60,12 +62,25 @@ protected:
   virtual void AddChannelOptions( const options_list_t & ) = 0;
   virtual void EnvironementNeeds(void) = 0;
 
-  /** @brief parse a boolean parameter
+  /** @brief Parse a boolean parameter
    *
    * @return the result or the default
    */
   bool GetBoolParam(const options_list_t&the_params_list,
 					const unsigned char&param_code, const bool default_data = false );
+  /** @brief Check the files type
+   *
+   * Sanity check on the file type before opening it.
+   * It is used by the input parameters, output parameters wave sound output,
+   *   trigger output (to be written).
+   * The type regular file is always allowed.
+   * Some types, such as directory are always rejected.
+   * Other types are accepted or rejected according with the calling parameters.
+   * @return nothing if it is accepted, an error string if the type is rejected.
+   */
+  optional<string> FileTypeChecker( const filesystem::path& the_path,
+						const string&prefix,
+						const bool&check_exists, const bool&check_not_fifo, const bool&check_not_dev_char);
 /** \brief Get information
    *
    * This returns both the notes and the errors
@@ -98,9 +113,9 @@ class params_input_handler : public params_fio_handler_base {
    * and perform the last checks
    */
   void CreateInputChannels(const unsigned short&);
-  /** @brief environement needs
+  /** @brief environment needs
    *
-   * Make the list of environement needs
+   * Make the list of environment needs
    *   such as network alive, jackaudio etc...
    */
   void EnvironementNeeds(void);
@@ -134,9 +149,9 @@ class params_output_handler  : public params_fio_handler_base {
    * and perform the last checks
    */
   void CreateOutputChannels(void);
-  /** @brief environement needs
+  /** @brief environment needs
    *
-   * Make the list of environement needs
+   * Make the list of environment needs
    *   such as network alive, jackaudio etc...
    */
   void EnvironementNeeds(void);
@@ -167,9 +182,9 @@ class params_file_handler  : public params_fio_handler_base {
    * and add it to the list
    */
   void AddChannelOptions( const options_list_t & );
-  /** @brief environement needs
+  /** @brief environment needs
    *
-   * Make the list of environement needs
+   * Make the list of environment needs
    *   such as network alive, jackaudio etc...
    */
   void EnvironementNeeds(void);
@@ -209,9 +224,9 @@ public:
    * and perform the last checks
    */
   void CreateChannels(const unsigned short&n_loops);
-  /** @brief environement needs
+  /** @brief environment needs
    *
-   * Make the list of environement needs
+   * Make the list of environment needs
    *   such as network alive, jackaudio etc...
    */
   void EnvironementNeeds(void);
@@ -232,14 +247,14 @@ public:
    *
    * Tells if there is at least one output that passed the first sanity check.\n
    * That is not a guarantee there is at least one valid channel
-   * @return true if there is atr least one
+   * @return true if there is at least one
    */ 
   bool hasOutputChannels()const;
   /** @brief Has file defined
    *
-   * Tells if there is a filename (or pipe) that passed the first sanity check.\n
+   * Tells if there is a file-name (or pipe) that passed the first sanity check.\n
    * That is not a guarantee there is at least one valid channel
-   * @return true if there is atr least one
+   * @return true if there is at least one
    */ 
   bool hasFileOutput()const;
   /** @brief Has really file output