TempDirectory Namespace Reference

Functions
FILES_API wxString	TempDir ()
FILES_API void	ResetTempDir ()
FILES_API const FilePath &	DefaultTempDir ()
FILES_API void	SetDefaultTempDir (const FilePath &tempDir)
FILES_API bool	IsTempDirectoryNameOK (const FilePath &Name)
FILES_API wxString	UnsavedProjectFileName ()
FILES_API bool	FATFilesystemDenied (const FilePath &path, const TranslatableString &msg, const BasicUI::WindowPlacement &placement={})
FILES_API Observer::Publisher< FilePath > &	GetTempPathObserver ()

Function Documentation

DefaultTempDir()

const FilePath & TempDirectory::DefaultTempDir

(

)

Definition at line 82 of file TempDirectory.cpp.

{
   return sDefaultTempDir;
}

References sDefaultTempDir.

Referenced by audacity::cloud::audiocom::GetUploadTempPath(), AudacityApp::InitTempDir(), anonymous_namespace{PluginMenus.cpp}::OnResetConfig(), DirectoriesPrefs::OnTempBrowse(), and TempDir().

Here is the caller graph for this function:

FATFilesystemDenied()

bool TempDirectory::FATFilesystemDenied	(	const FilePath &	path,
		const TranslatableString &	msg,
		const BasicUI::WindowPlacement &	placement = {}
	)

Definition at line 140 of file TempDirectory.cpp.

{
   if (FileNames::IsOnFATFileSystem(path))
   {
      BasicUI::ShowErrorDialog( placement,
         XO("Unsuitable"),
         XO("%s\n\nFor tips on suitable drives, click the help button.").Format(msg),
         "Error:_Unsuitable_drive"
         );
 
      return true;
   }
 
   return false;
}

References FileNames::IsOnFATFileSystem(), BasicUI::ShowErrorDialog(), and XO().

Referenced by anonymous_namespace{AudioComPrefsPanel.cpp}::AudioComPrefsPanel::Browse(), ProjectFileManager::DoSave(), IsTempDirectoryNameOK(), DirectoriesPrefs::OnBrowse(), FilesystemValidator::OnChar(), DirectoriesPrefs::OnTempBrowse(), ProjectFileManager::OpenFile(), ProjectFileManager::SaveCopy(), and FilesystemValidator::Validate().

Here is the call graph for this function:

Here is the caller graph for this function:

GetTempPathObserver()

Observer::Publisher< FilePath > & TempDirectory::GetTempPathObserver

(

)

Definition at line 157 of file TempDirectory.cpp.

{
   return GetTempDirChangedPublisher();
}

References anonymous_namespace{TempDirectory.cpp}::GetTempDirChangedPublisher().

Here is the call graph for this function:

IsTempDirectoryNameOK()

bool TempDirectory::IsTempDirectoryNameOK

(

const FilePath &

Name

)

Definition at line 95 of file TempDirectory.cpp.

{
   if( Name.empty() )
      return false;
 
   wxFileName tmpFile;
   tmpFile.AssignTempFileName(wxT("nn"));
   // use Long Path to expand out any abbreviated long substrings.
   wxString BadPath = tmpFile.GetLongPath();
   ::wxRemoveFile(tmpFile.GetFullPath());
 
#ifdef __WXMAC__
   // This test is to fix bug 1220 on a 1.x to 2.x to 2.1.3 upgrade.
   // It is less permissive than we could be as it stops a path
   // with this string ANYWHERE within it rather than excluding just
   // the paths that the earlier Audacities used to create.
   if( Name.Contains( "/tmp/") )
      return false;
   BadPath = BadPath.BeforeLast( '/' ) + "/";
   wxFileName cmpFile( Name );
   wxString NameCanonical = cmpFile.GetLongPath( ) + "/";
#else
   BadPath = BadPath.BeforeLast( '\\' ) + "\\";
   wxFileName cmpFile( Name );
   wxString NameCanonical = cmpFile.GetLongPath( ) + "\\";
#endif
 
   if (FATFilesystemDenied(NameCanonical,
                                      XO("The temporary files directory is on a FAT formatted drive.\n"
                                         "Resetting to default location.")))
   {
      return false;
   }
 
   return !(NameCanonical.StartsWith( BadPath ));
}

References anonymous_namespace{Registry.cpp}::BadPath(), FATFilesystemDenied(), wxT(), and XO().

Referenced by AudacityApp::InitTempDir(), DirectoriesPrefs::OnTempBrowse(), and DirectoriesPrefs::Validate().

Here is the call graph for this function:

Here is the caller graph for this function:

ResetTempDir()

void TempDirectory::ResetTempDir

(

)

Definition at line 74 of file TempDirectory.cpp.

{
   TempDirPath().clear();
}

References TempDirPath().

Referenced by AudacityApp::InitTempDir().

Here is the call graph for this function:

Here is the caller graph for this function:

SetDefaultTempDir()

void TempDirectory::SetDefaultTempDir

(

const FilePath &

tempDir

)

Definition at line 87 of file TempDirectory.cpp.

{
   sDefaultTempDir = tempDir;
   GetTempDirChangedPublisher().UpdateTempPath(tempDir);
}

References anonymous_namespace{TempDirectory.cpp}::GetTempDirChangedPublisher(), sDefaultTempDir, and anonymous_namespace{TempDirectory.cpp}::TempDirChangedPublisher::UpdateTempPath().

Here is the call graph for this function:

TempDir()

wxString TempDirectory::TempDir

(

)

Returns the directory used for temp files.

Todo:

put a counter in here to see if it gets used a lot. if it does, then maybe we should cache the path name each time.

Definition at line 50 of file TempDirectory.cpp.

{
   auto &path = TempDirPath();
   if (gPrefs && path.empty())
      path =
         gPrefs->Read(PreferenceKey(FileNames::Operation::Temp,
            FileNames::PathType::_None), wxT(""));
 
   if (FileNames::IsOnFATFileSystem(path))
   {
      BasicUI::ShowErrorDialog( {},
         XO("Unsuitable"),
         XO("The temporary files directory is on a FAT formatted drive.\n"
            "Resetting to default location."),
         "Error:_Unsuitable_drive"
         );
 
      path = DefaultTempDir();
      UpdateDefaultPath(FileNames::Operation::Temp, path);
   }
 
   return FileNames::MkDir(path);
}

References DefaultTempDir(), gPrefs, FileNames::IsOnFATFileSystem(), FileNames::MkDir(), FileNames::PreferenceKey(), audacity::BasicSettings::Read(), BasicUI::ShowErrorDialog(), TempDirPath(), FileNames::UpdateDefaultPath(), wxT(), and XO().

Referenced by ProjectFileIO::CloseProject(), ProjectFileIO::DiscardConnection(), AudacityApp::InitTempDir(), AutoRecoveryDialog::OnDiscardSelected(), ProjectFileIO::OpenConnection(), AutoRecoveryDialog::PopulateList(), NyquistEffect::Process(), ProjectFileIO::ProjectFileIO(), UnsavedProjectFileName(), and DirectoriesPrefs::Validate().

Here is the call graph for this function:

Here is the caller graph for this function:

UnsavedProjectFileName()

wxString TempDirectory::UnsavedProjectFileName

(

)

Definition at line 132 of file TempDirectory.cpp.

{
   wxFileName fn(TempDir(),
                 FileNames::CreateUniqueName(wxT("New Project"), FileNames::UnsavedProjectExtension()));
 
   return fn.GetFullPath();
}

References FileNames::CreateUniqueName(), fn, TempDir(), FileNames::UnsavedProjectExtension(), and wxT().

Referenced by ProjectFileIO::OpenConnection(), and ProjectFileManager::OpenNewProject().

Here is the call graph for this function:

Here is the caller graph for this function: