AudacityFileConfig Class Reference

Our own specialisation of FileConfig. More...

#include <AudacityFileConfig.h>

Inheritance diagram for AudacityFileConfig:

Collaboration diagram for AudacityFileConfig:

Public Member Functions
bool	Flush (bool bCurrentOnly) override
	~AudacityFileConfig () override
bool	RenameEntry (const wxString &oldName, const wxString &newName) override
bool	RenameGroup (const wxString &oldName, const wxString &newName) override
bool	DeleteEntry (const wxString &key, bool bDeleteGroupIfEmpty) override
bool	DeleteGroup (const wxString &key) override
bool	DeleteAll () override

Static Public Member Functions
static std::unique_ptr< AudacityFileConfig >	Create (const wxString &appName={}, const wxString &vendorName={}, const wxString &localFilename={}, const wxString &globalFilename={}, long style=wxCONFIG_USE_LOCAL_FILE|wxCONFIG_USE_GLOBAL_FILE, const wxMBConv &conv=wxConvAuto())
	Require a call to this factory, to guarantee proper two-phase initialization. More...

Protected Member Functions
bool	DoWriteString (const wxString &key, const wxString &szValue) override
bool	DoWriteLong (const wxString &key, long lValue) override

Private Member Functions
	AudacityFileConfig (const wxString &appName, const wxString &vendorName, const wxString &localFilename, const wxString &globalFilename, long style, const wxMBConv &conv)
	Disallow direct constructor call, because a two-phase initialization is required. More...
void	Init ()
void	Warn () const

Private Attributes
bool	mDirty {false}
const wxString	mLocalFilename

Detailed Description

Our own specialisation of FileConfig.

Definition at line 19 of file AudacityFileConfig.h.

Constructor & Destructor Documentation

~AudacityFileConfig()

AudacityFileConfig::~AudacityFileConfig ( )

override

Definition at line 83 of file AudacityFileConfig.cpp.

{
   wxASSERT(mDirty == false);
}

References mDirty.

AudacityFileConfig()

AudacityFileConfig::AudacityFileConfig ( const wxString &  appName, const wxString &  vendorName, const wxString &  localFilename, const wxString &  globalFilename, long  style, const wxMBConv &  conv  )

private

Disallow direct constructor call, because a two-phase initialization is required.

Definition at line 24 of file AudacityFileConfig.cpp.

: wxFileConfig{ appName, vendorName, localFilename, globalFilename, style, conv }
, mLocalFilename(localFilename)
{
  // https://github.com/audacity/audacity/issues/6448 :
  // We do not write environment variable names in the config files, and
  // wxWidgets' implementation of environment variable expansion thinks a dollar
  // sign at the beginning of a directory name is an environment variable - see
  // https://github.com/wxWidgets/wxWidgets/issues/19214
  SetExpandEnvVars(false);
}

Member Function Documentation

Create()

std::unique_ptr< AudacityFileConfig > AudacityFileConfig::Create ( const wxString &  appName = {}, const wxString &  vendorName = {}, const wxString &  localFilename = {}, const wxString &  globalFilename = {}, long  style = wxCONFIG_USE_LOCAL_FILE | wxCONFIG_USE_GLOBAL_FILE, const wxMBConv &  conv = wxConvAuto()  )

static

Require a call to this factory, to guarantee proper two-phase initialization.

Definition at line 88 of file AudacityFileConfig.cpp.

{
   // Private ctor means make_unique can't compile, so this verbosity:
   auto result = std::unique_ptr<AudacityFileConfig>{
      safenew AudacityFileConfig{
         appName, vendorName, localFilename, globalFilename, style, conv } };
   result->Init();
   return result;
}

References safenew, and anonymous_namespace{AudacityDontAskAgainMessageDialog.cpp}::style.

Referenced by AudacityApp::InitPart2(), and anonymous_namespace{AudacityApp.cpp}::PopulatePreferences().

Here is the caller graph for this function:

DeleteAll()

bool AudacityFileConfig::DeleteAll ( )

override

Definition at line 270 of file AudacityFileConfig.cpp.

{
   auto res = wxFileConfig::DeleteAll();
   if (res)
   {
      mDirty = true;
   }
   return res;
}

References mDirty.

DeleteEntry()

bool AudacityFileConfig::DeleteEntry ( const wxString &  key, bool  bDeleteGroupIfEmpty  )

override

Definition at line 250 of file AudacityFileConfig.cpp.

{
   auto res = wxFileConfig::DeleteEntry(key, bDeleteGroupIfEmpty);
   if (res)
   {
      mDirty = true;
   }
   return res;
}

References key, and mDirty.

DeleteGroup()

bool AudacityFileConfig::DeleteGroup ( const wxString &  key )

override

Definition at line 260 of file AudacityFileConfig.cpp.

{
   auto res = wxFileConfig::DeleteGroup(key);
   if (res)
   {
      mDirty = true;
   }
   return res;
}

References key, and mDirty.

DoWriteLong()

bool AudacityFileConfig::DoWriteLong ( const wxString &  key, long  lValue  )

overrideprotected

Definition at line 290 of file AudacityFileConfig.cpp.

{
   bool res = wxFileConfig::DoWriteLong(key, lValue);
   if (res)
   {
      mDirty = true;
   }
   return res;
}

References key, and mDirty.

DoWriteString()

bool AudacityFileConfig::DoWriteString ( const wxString &  key, const wxString &  szValue  )

overrideprotected

Definition at line 280 of file AudacityFileConfig.cpp.

{
   bool res = wxFileConfig::DoWriteString(key, szValue);
   if (res)
   {
      mDirty = true;
   }
   return res;
}

References key, and mDirty.

Flush()

bool AudacityFileConfig::Flush ( bool  bCurrentOnly )

override

Definition at line 105 of file AudacityFileConfig.cpp.

{
   if (!mDirty)
   {
      return true;
   }
 
   while (true)
   {
      FilePath backup = mLocalFilename + ".bkp";
 
      if (!wxFileExists(backup) || (wxRemove(backup) == 0))
      {
         if (!wxFileExists(mLocalFilename) || (wxRename(mLocalFilename, backup) == 0))
         {
            wxFileOutputStream stream(mLocalFilename);
            if (stream.IsOk())
            {
               if (Save(stream))
               {
                  stream.Sync();
                  if (stream.IsOk() && stream.Close())
                  {
                     if (!wxFileExists(backup) || (wxRemove(backup) == 0))
                     {
                        mDirty = false;
                        return true;
                     }
                  }
               }
            }
 
            if (wxFileExists(backup))
            {
               wxRemove(mLocalFilename);
               wxRename(backup, mLocalFilename);
            }
         }
      }
 
      Warn();
   }
}

References mDirty, mLocalFilename, and Warn().

Here is the call graph for this function:

Init()

void AudacityFileConfig::Init ( )

private

Definition at line 43 of file AudacityFileConfig.cpp.

{
   // Prevent wxFileConfig from attempting a Flush() during object deletion. This happens
   // because we don't use the wxFileConfig::Flush() method and so the wxFileConfig dirty
   // flag never gets reset. During deletion, the dirty flag is checked and a Flush()
   // performed. This can (and probably will) create bogus temporary files.
   DisableAutoSave();
 
   while (true)
   {
      bool canRead = false;
      bool canWrite = false;
      int fd;
 
      fd = wxOpen(mLocalFilename, O_RDONLY, S_IREAD);
      if (fd != -1 || errno == ENOENT)
      {
         canRead = true;
         if (fd != -1)
         {
            wxClose(fd);
         }
      }
 
      fd = wxOpen(mLocalFilename, O_WRONLY | O_CREAT, S_IWRITE);
      if (fd != -1)
      {
         canWrite = true;
         wxClose(fd);
      }
 
      if (canRead && canWrite)
      {
         break;
      }
 
      Warn();
   }
}

References mLocalFilename, and Warn().

Here is the call graph for this function:

RenameEntry()

bool AudacityFileConfig::RenameEntry ( const wxString &  oldName, const wxString &  newName  )

override

Definition at line 230 of file AudacityFileConfig.cpp.

{
   auto res = wxFileConfig::RenameEntry(oldName, newName);
   if (res)
   {
      mDirty = true;
   }
   return res;
}

References mDirty.

RenameGroup()

bool AudacityFileConfig::RenameGroup ( const wxString &  oldName, const wxString &  newName  )

override

Definition at line 240 of file AudacityFileConfig.cpp.

{
   auto res = wxFileConfig::RenameGroup(oldName, newName);
   if (res)
   {
      mDirty = true;
   }
   return res;
}

References mDirty.

Warn()

void AudacityFileConfig::Warn ( ) const

private

Definition at line 149 of file AudacityFileConfig.cpp.

{
   wxDialogWrapper dlg(nullptr, wxID_ANY, XO("Audacity Configuration Error"));
 
   ShuttleGui S(&dlg, eIsCreating);
 
   wxButton *retryButton;
   wxButton *quitButton;
 
   S.SetBorder(5);
   S.StartVerticalLay(wxEXPAND, 1);
   {
      S.SetBorder(15);
      S.StartHorizontalLay(wxALIGN_RIGHT, 0);
      {
         S.AddFixedText(
            XO("The following configuration file could not be accessed:\n\n"
               "\t%s\n\n"
               "This could be caused by many reasons, but the most likely are that "
               "the disk is full or you do not have write permissions to the file. "
               "\n\n"
               "You can attempt to correct the issue and then click \"Retry\" to continue.\n\n"
               "If you choose to \"Quit Audacity\", your project may be left in an unsaved "
               "state which will be recovered the next time you open it.")
            .Format(mLocalFilename),
            false,
            500);
      }
      S.EndHorizontalLay();
 
      S.SetBorder(5);
      S.StartHorizontalLay(wxALIGN_RIGHT, 0);
      {
         // Can't use themed bitmap since the theme manager might not be
         // initialized yet and it requires a configuration file.
         wxButton *b = S.Id(wxID_HELP).AddBitmapButton(wxBitmap(Help_xpm));
         b->SetToolTip( XO("Help").Translation() );
         b->SetLabel(XO("Help").Translation());       // for screen readers
 
         b = S.Id(wxID_CANCEL).AddButton(XXO("&Quit Audacity"));
         b = S.Id(wxID_OK).AddButton(XXO("&Retry"));
         dlg.SetAffirmativeId(wxID_OK);
 
         b->SetDefault();
         b->SetFocus();
      }
      S.EndHorizontalLay();
   }
   S.EndVerticalLay();
 
   dlg.Layout();
   dlg.GetSizer()->Fit(&dlg);
   dlg.SetMinSize(dlg.GetSize());
   dlg.Center();
 
   auto onButton = [&](wxCommandEvent &e)
   {
      dlg.EndModal(e.GetId());
   };
 
   dlg.Bind(wxEVT_BUTTON, onButton);
 
   switch (dlg.ShowModal())
   {
      case wxID_HELP:
         // Can't use the HelpSystem since the theme manager may not
         // yet be initialized and it requires a configuration file.
         OpenInDefaultBrowser("https://" +
                              HelpSystem::HelpHostname +
                              HelpSystem::HelpServerHomeDir +
                              "Error:_Audacity_settings_file_unwritable");
      break;
 
      case wxID_CANCEL:
         _exit(-1);
      break;
   }
 
   dlg.Unbind(wxEVT_BUTTON, onButton);
}

References eIsCreating, HelpSystem::HelpHostname, HelpSystem::HelpServerHomeDir, mLocalFilename, BasicUI::OpenInDefaultBrowser(), S, XO(), and XXO().

Referenced by Flush(), and Init().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

mDirty

bool AudacityFileConfig::mDirty {false}

private

Definition at line 64 of file AudacityFileConfig.h.

Referenced by DeleteAll(), DeleteEntry(), DeleteGroup(), DoWriteLong(), DoWriteString(), Flush(), RenameEntry(), RenameGroup(), and ~AudacityFileConfig().

mLocalFilename

const wxString AudacityFileConfig::mLocalFilename

private

Definition at line 65 of file AudacityFileConfig.h.

Referenced by Flush(), Init(), and Warn().

---

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

• AudacityFileConfig.h
• AudacityFileConfig.cpp