DirectoriesPrefs Class Reference

A PrefsPanel used to select directories. More...

#include <DirectoriesPrefs.h>

Inheritance diagram for DirectoriesPrefs:

Collaboration diagram for DirectoriesPrefs:

Public Member Functions
	DirectoriesPrefs (wxWindow *parent, wxWindowID winid)
	~DirectoriesPrefs ()
ComponentInterfaceSymbol	GetSymbol () const override
TranslatableString	GetDescription () const override
bool	Commit () override
bool	Validate () override
ManualPageID	HelpPageName () override
	If not empty string, the Help button is added below the panel. More...
void	PopulateOrExchange (ShuttleGui &S) override
Public Member Functions inherited from PrefsPanel
	PrefsPanel (wxWindow *parent, wxWindowID winid, const TranslatableString &title)
virtual	~PrefsPanel ()
virtual void	Preview ()
virtual bool	Commit ()=0
virtual PluginPath	GetPath () const override
virtual VendorSymbol	GetVendor () const override
virtual wxString	GetVersion () const override
virtual bool	ShowsPreviewButton ()
virtual void	PopulateOrExchange (ShuttleGui &WXUNUSED(S))
virtual ManualPageID	HelpPageName ()
	If not empty string, the Help button is added below the panel. More...
virtual void	Cancel ()
Public Member Functions inherited from wxPanelWrapper
	wxPanelWrapper ()
	wxPanelWrapper (wxWindow *parent, wxWindowID winid=wxID_ANY, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxDefaultSize, long style=wxTAB_TRAVERSAL|wxNO_BORDER, const TranslatableString &name=XO("Panel"))
bool	Create (wxWindow *parent, wxWindowID winid=wxID_ANY, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxDefaultSize, long style=wxTAB_TRAVERSAL|wxNO_BORDER, const TranslatableString &name=XO("Panel"))
void	SetLabel (const TranslatableString &label)
void	SetName (const TranslatableString &name)
void	SetToolTip (const TranslatableString &toolTip)
void	SetName ()
Public Member Functions inherited from wxTabTraversalWrapper< wxPanel >
	wxTabTraversalWrapper (Args &&... args)
	wxTabTraversalWrapper (const wxTabTraversalWrapper &)=delete
	wxTabTraversalWrapper (wxTabTraversalWrapper &&)=delete
wxTabTraversalWrapper &	operator= (const wxTabTraversalWrapper &)=delete
wxTabTraversalWrapper &	operator= (wxTabTraversalWrapper &&)=delete

Private Member Functions
void	Populate ()
	Creates the dialog and its contents. More...
void	OnTempText (wxCommandEvent &evt)
void	OnTempBrowse (wxCommandEvent &evt)
void	OnBrowse (wxCommandEvent &evt)
void	OnText (wxCommandEvent &evt)

Private Attributes
ReadOnlyText *	mFreeSpace
wxTextCtrl *	mTempText
wxTextCtrl *	mOpenText
wxTextCtrl *	mSaveText
wxTextCtrl *	mImportText
wxTextCtrl *	mExportText
wxTextCtrl *	mMacrosText

Additional Inherited Members
Public Types inherited from PrefsPanel
using	Factories = std::vector< PrefsPanel::PrefsNode >
using	Factory = std::function< PrefsPanel *(wxWindow *parent, wxWindowID winid, AudacityProject *) >
Static Public Member Functions inherited from PrefsPanel
static Factories &	DefaultFactories ()

Detailed Description

A PrefsPanel used to select directories.

Definition at line 24 of file DirectoriesPrefs.h.

Constructor & Destructor Documentation

DirectoriesPrefs()

DirectoriesPrefs::DirectoriesPrefs	(	wxWindow *	parent,
		wxWindowID	winid
	)

Definition at line 139 of file DirectoriesPrefs.cpp.

:  PrefsPanel(parent, winid, XO("Directories")),
   mFreeSpace(NULL),
   mTempText(NULL)
{
   Populate();
}

~DirectoriesPrefs()

DirectoriesPrefs::~DirectoriesPrefs

(

)

Definition at line 148 of file DirectoriesPrefs.cpp.

{
}

Member Function Documentation

Commit()

bool DirectoriesPrefs::Commit ( )

overridevirtual

Implements PrefsPanel.

Definition at line 507 of file DirectoriesPrefs.cpp.

{
   ShuttleGui S(this, eIsSavingToPrefs);
   PopulateOrExchange(S);
 
   return true;
}

References eIsSavingToPrefs, PopulateOrExchange(), and S.

Here is the call graph for this function:

GetDescription()

TranslatableString DirectoriesPrefs::GetDescription ( ) const

overridevirtual

Implements ComponentInterface.

Definition at line 157 of file DirectoriesPrefs.cpp.

{
   return XO("Preferences for Directories");
}

References XO().

Here is the call graph for this function:

GetSymbol()

ComponentInterfaceSymbol DirectoriesPrefs::GetSymbol ( ) const

overridevirtual

Implements ComponentInterface.

Definition at line 152 of file DirectoriesPrefs.cpp.

{
   return DIRECTORIES_PREFS_PLUGIN_SYMBOL;
}

References DIRECTORIES_PREFS_PLUGIN_SYMBOL.

HelpPageName()

ManualPageID DirectoriesPrefs::HelpPageName ( )

overridevirtual

If not empty string, the Help button is added below the panel.

Default returns empty string.

Reimplemented from PrefsPanel.

Definition at line 162 of file DirectoriesPrefs.cpp.

{
   return "Directories_Preferences";
}

OnBrowse()

void DirectoriesPrefs::OnBrowse ( wxCommandEvent &  evt )

private

Definition at line 350 of file DirectoriesPrefs.cpp.

{
   long id = evt.GetId() - ButtonsStart;
   wxTextCtrl *tc = (wxTextCtrl *) FindWindow(id + TextsStart);
 
   wxString location = tc->GetValue();
 
   wxDirDialogWrapper dlog(this,
                           XO("Choose a location"),
                           location);
   int retval = dlog.ShowModal();
 
   if (retval == wxID_CANCEL)
   {
      return;
   }
 
   if (evt.GetId() == SaveButtonID)
   {
      if (FATFilesystemDenied(dlog.GetPath(),
                              XO("Projects cannot be saved to FAT drives.")))
      {
         return;
      }
   }
 
   //Checks if the location for Open,Save.Import,Export and Macro Output has write permissions(Browse Buttons)
   if (!FileNames::WritableLocationCheck(dlog.GetPath(), XO("Cannot set the preference.")))
   {
      return;
   }
 
   tc->SetValue(dlog.GetPath());
}

References TempDirectory::FATFilesystemDenied(), SaveButtonID, FileNames::WritableLocationCheck(), and XO().

Here is the call graph for this function:

OnTempBrowse()

void DirectoriesPrefs::OnTempBrowse ( wxCommandEvent &  evt )

private

Definition at line 266 of file DirectoriesPrefs.cpp.

{
   wxString oldTemp = gPrefs->Read(PreferenceKey(Operation::Open, PathType::_None),
                                   DefaultTempDir());
 
   // Because we went through InitTemp() during initialisation,
   // the old temp directory name in prefs should already be OK.  Just in case there is 
   // some way we hadn't thought of for it to be not OK, 
   // we avoid prompting with it in that case and use the suggested default instead.
   if (!IsTempDirectoryNameOK(oldTemp))
   {
      oldTemp = DefaultTempDir();
   }
 
   wxDirDialogWrapper dlog(this,
                           XO("Choose a location to place the temporary directory"),
                           oldTemp);
   int retval = dlog.ShowModal();
   if (retval != wxID_CANCEL && !dlog.GetPath().empty())
   {
      wxFileName tmpDirPath;
      tmpDirPath.AssignDir(dlog.GetPath());
 
      if (FATFilesystemDenied(tmpDirPath.GetFullPath(),
          XO("Temporary files directory cannot be on a FAT drive."))) {
         return;
      }
 
      //Checks if the temporary directory has write permissions(via Browse Button)
      if (!FileNames::WritableLocationCheck(dlog.GetPath(), XO("Cannot set the preference.")))
      {
         return;
      }
 
      // Append an "audacity_temp" directory to this path if necessary (the
      // default, the existing pref (as stored in the control), and any path
      // ending in a directory with the same name as what we'd add should be OK
      // already)
      wxString newDirName;
#if defined(__WXMAC__)
      newDirName = wxT("SessionData");
#elif defined(__WXMSW__) 
      // Clearing Bug 1271 residual issue.  Let's NOT have temp in the name.
      newDirName = wxT("SessionData");
#else
      newDirName = wxT(".audacity_temp");
#endif
      auto dirsInPath = tmpDirPath.GetDirs();
 
      // If the default temp dir or user's pref dir don't end in '/' they cause
      // wxFileName's == operator to construct a wxFileName representing a file
      // (that doesn't exist) -- hence the constructor calls
      if (tmpDirPath != wxFileName(DefaultTempDir(), wxT("")) &&
            tmpDirPath != wxFileName(mTempText->GetValue(), wxT("")) &&
            (dirsInPath.size() == 0 ||
             dirsInPath[dirsInPath.size()-1] != newDirName))
      {
         tmpDirPath.AppendDir(newDirName);
      }
 
      mTempText->SetValue(tmpDirPath.GetPath(wxPATH_GET_VOLUME|wxPATH_GET_SEPARATOR));
      OnTempText(evt);
   }
}

References TempDirectory::DefaultTempDir(), TempDirectory::FATFilesystemDenied(), gPrefs, TempDirectory::IsTempDirectoryNameOK(), mTempText, OnTempText(), FileNames::PreferenceKey(), audacity::BasicSettings::Read(), FileNames::WritableLocationCheck(), wxT(), and XO().

Here is the call graph for this function:

OnTempText()

void DirectoriesPrefs::OnTempText ( wxCommandEvent &  evt )

private

Definition at line 331 of file DirectoriesPrefs.cpp.

{
   TranslatableString label;
 
   if (mTempText && mFreeSpace)
   {
      FilePath path = mTempText->GetValue();
 
      wxLongLong space;
      wxGetDiskSpace(path, NULL, &space);
 
      label = wxDirExists(path)
         ? Internat::FormatSize(space)
         : XO("unavailable - above location doesn't exist");
 
      mFreeSpace->SetValue(label.Translation());
   }
}

References Internat::FormatSize(), label, mFreeSpace, mTempText, ReadOnlyText::SetValue(), TranslatableString::Translation(), and XO().

Referenced by OnTempBrowse(), and Populate().

Here is the call graph for this function:

Here is the caller graph for this function:

OnText()

void DirectoriesPrefs::OnText ( wxCommandEvent &  evt )

private

Populate()

void DirectoriesPrefs::Populate ( )

private

Creates the dialog and its contents.

Definition at line 168 of file DirectoriesPrefs.cpp.

{
   //------------------------- Main section --------------------
   // Now construct the GUI itself.
   // Use 'eIsCreatingFromPrefs' so that the GUI is
   // initialised with values from gPrefs.
   ShuttleGui S(this, eIsCreatingFromPrefs);
   PopulateOrExchange(S);
   // ----------------------- End of main section --------------
 
   wxCommandEvent e;
   OnTempText(e);
}

References eIsCreatingFromPrefs, OnTempText(), PopulateOrExchange(), and S.

Here is the call graph for this function:

PopulateOrExchange()

void DirectoriesPrefs::PopulateOrExchange ( ShuttleGui &  S )

override

Definition at line 182 of file DirectoriesPrefs.cpp.

{
   S.SetBorder(2);
   S.StartScroller();
 
   S.StartStatic(XO("Default directories"));
   {
      S.AddSpace(1);
      S.AddFixedText(XO("Leave a field empty to go to the last directory used for that operation.\n"
         "Fill in a field to always go to that directory for that operation."), false, 450);
      S.AddSpace(5);
 
      S.StartMultiColumn(3, wxEXPAND);
      {
         S.SetStretchyCol(1);
 
         S.Id(OpenTextID);
         mOpenText = S.TieTextBox(XXO("O&pen:"),
                                      {PreferenceKey(Operation::Open, PathType::User),
                                       wxT("")},
                                      30);
         S.Id(OpenButtonID).AddButton(XXO("&Browse..."));
 
         S.Id(SaveTextID);
         mSaveText = S.TieTextBox(XXO("S&ave:"),
                                      {PreferenceKey(Operation::Save, PathType::User),
                                       wxT("")},
                                      30);
         if( mSaveText )
            mSaveText->SetValidator(FilesystemValidator(XO("Projects cannot be saved to FAT drives.")));
         S.Id(SaveButtonID).AddButton(XXO("B&rowse..."));
 
         S.Id(ImportTextID);
         mImportText = S.TieTextBox(XXO("&Import:"),
                                    {PreferenceKey(Operation::Import, PathType::User),
                                     wxT("")},
                                    30);
         S.Id(ImportButtonID).AddButton(XXO("Br&owse..."));
 
         S.Id(ExportTextID);
         mExportText = S.TieTextBox(XXO("&Export:"),
                                    {PreferenceKey(Operation::Export, PathType::User),
                                     wxT("")},
                                    30);
         S.Id(ExportButtonID).AddButton(XXO("Bro&wse..."));
 
         S.Id(MacrosTextID);
         mMacrosText = S.TieTextBox(XXO("&Macro output:"),
                                    {PreferenceKey(Operation::MacrosOut, PathType::User),
                                     wxT("")},
                                    30);
         S.Id(MacrosButtonID).AddButton(XXO("Bro&wse..."));
 
 
      }
      S.EndMultiColumn();
   }
   S.EndStatic();
 
   S.StartStatic(XO("Temporary files directory"));
   {
      S.StartMultiColumn(3, wxEXPAND);
      {
         S.SetStretchyCol(1);
 
         S.Id(TempTextID);
         mTempText = S.TieTextBox(XXO("&Location:"),
                                  {PreferenceKey(Operation::Temp, PathType::_None),
                                   wxT("")},
                                  30);
         if( mTempText )
            mTempText->SetValidator(FilesystemValidator(XO("Temporary files directory cannot be on a FAT drive.")));
         S.Id(TempButtonID).AddButton(XXO("Brow&se..."));
 
         mFreeSpace = S
            .AddReadOnlyText(XXO("&Free Space:"), "");
      }
      S.EndMultiColumn();
   }
   S.EndStatic();
 
   S.EndScroller();
}

References ExportButtonID, ImportButtonID, mExportText, mFreeSpace, mImportText, mMacrosText, mOpenText, mSaveText, mTempText, FileNames::PreferenceKey(), S, SaveButtonID, wxT(), XO(), and XXO().

Referenced by Commit(), and Populate().

Here is the call graph for this function:

Here is the caller graph for this function:

Validate()

bool DirectoriesPrefs::Validate ( )

override

Definition at line 416 of file DirectoriesPrefs.cpp.

{
   wxFileName Temp;
   Temp.SetPath(mTempText->GetValue());
 
   wxString path{Temp.GetPath()};
   if( !IsTempDirectoryNameOK( path ) ) {
      AudacityMessageBox(
         XO("Directory %s is not suitable (at risk of being cleaned out)")
            .Format( path ),
         XO("Error"),
         wxOK | wxICON_ERROR);
      return false;
   }
 
   if (!Temp.DirExists()) {
      if(CreateDirectory(path, XO("'Temporary Directory' cannot be set.")) == false)
         return false;
   }
   else {
      /* If the directory already exists, make sure it is writable */
      if (!FileNames::WritableLocationCheck(mTempText->GetValue(), 
                                          XO("'Temporary files' directory cannot be set.")))
      {
         return false;
      }
      wxLogNull logNo;
      Temp.AppendDir(wxT("canicreate"));
      path =  Temp.GetPath();
      if (!Temp.Mkdir(0755)) {
         AudacityMessageBox(
            XO("Directory %s is not writable")
               .Format( path ),
            XO("Error"),
            wxOK | wxICON_ERROR);
         return false;
      }
      Temp.Rmdir();
      Temp.RemoveLastDir();
   }
 
   wxFileName oldDir;
   oldDir.SetPath(TempDir());
   if (Temp != oldDir) {
      AudacityMessageBox(
         XO(
"Changes to temporary directory will not take effect until Audacity is restarted"),
         XO("Temp Directory Update"),
         wxOK | wxCENTRE | wxICON_INFORMATION);
   }
 
   const wxString openPathString = mOpenText->GetValue();
   const wxString savePathString = mSaveText->GetValue();
   const wxString importPathString = mImportText->GetValue();
   const wxString exportPathString = mExportText->GetValue();
   const wxString macroPathString = mMacrosText->GetValue();
   //error messages if the directories could not be set.
   const std::initializer_list<TranslatableString> messagesPreference{
      XO("'Open' directory cannot be set.") ,
      XO("'Save' directory cannot be set.") ,
      XO("'Import' directory cannot be set.") ,
      XO("'Export' directory cannot be set.") ,
      XO("'Macro Output' directory cannot be set.") ,
   };
 
   //flag for checking if at least one directory write protected 
   //will not be 0 if any of the paths are not writable
   int flag = 0;
   //id for indexing error messages to the initializer_list.
   int id = 0;
   //Checks if the location for Open,Save,Import,Export and Macro Output has write permissions(When OK is clicked)
   for (auto &string : { openPathString, savePathString, importPathString, exportPathString, macroPathString} ) {
      const wxFileName currentPath { string };
      const auto & message = *(messagesPreference.begin() + id);
      if(!string.empty()){
         if (currentPath.DirExists()){
            if(!FileNames::WritableLocationCheck(string, message))
               flag++;
         }
         else {
            return CreateDirectory(string, message);
         }
      }
      id++;
   }
   if (flag != 0)
      return false;
 
   return true;
}

References AudacityMessageBox(), CreateDirectory(), flag, id, TempDirectory::IsTempDirectoryNameOK(), mExportText, mImportText, mMacrosText, mOpenText, mSaveText, mTempText, TempDirectory::TempDir(), FileNames::WritableLocationCheck(), wxT(), and XO().

Here is the call graph for this function:

Member Data Documentation

mExportText

wxTextCtrl* DirectoriesPrefs::mExportText

private

Definition at line 51 of file DirectoriesPrefs.h.

Referenced by PopulateOrExchange(), and Validate().

mFreeSpace

ReadOnlyText* DirectoriesPrefs::mFreeSpace

private

Definition at line 46 of file DirectoriesPrefs.h.

Referenced by OnTempText(), and PopulateOrExchange().

mImportText

wxTextCtrl* DirectoriesPrefs::mImportText

private

Definition at line 50 of file DirectoriesPrefs.h.

Referenced by PopulateOrExchange(), and Validate().

mMacrosText

wxTextCtrl* DirectoriesPrefs::mMacrosText

private

Definition at line 52 of file DirectoriesPrefs.h.

Referenced by PopulateOrExchange(), and Validate().

mOpenText

wxTextCtrl* DirectoriesPrefs::mOpenText

private

Definition at line 48 of file DirectoriesPrefs.h.

Referenced by PopulateOrExchange(), and Validate().

mSaveText

wxTextCtrl* DirectoriesPrefs::mSaveText

private

Definition at line 49 of file DirectoriesPrefs.h.

Referenced by PopulateOrExchange(), and Validate().

mTempText

wxTextCtrl* DirectoriesPrefs::mTempText

private

Definition at line 47 of file DirectoriesPrefs.h.

Referenced by OnTempBrowse(), OnTempText(), PopulateOrExchange(), and Validate().

---

The documentation for this class was generated from the following files:

• DirectoriesPrefs.h
• DirectoriesPrefs.cpp