LoginDialog Class Reference

#include <LoginDialog.h>

Inheritance diagram for LoginDialog:

Collaboration diagram for LoginDialog:

Public Types
enum class	Mode { Create , SignIn }

Static Public Member Functions
static bool	SignIn (wxWindow *parent, Mode mode=Mode::SignIn)

Private Member Functions
	LoginDialog (wxWindow *parent, wxWindowID id=wxID_ANY, Mode mode=Mode::SignIn)
void	LayoutControls ()
void	OnSignIn (wxHyperlinkEvent &)
void	OnCreateAccount (wxHyperlinkEvent &)
void	OnContinue (wxCommandEvent &)
void	OnContinueWithGoogle (wxCommandEvent &)
void	OnContinueWithFacebook (wxCommandEvent &)
void	onUserCredentialsChange (wxCommandEvent &)
void	ContinueCreateAccount ()
void	ContinueSignIn ()
void	OnOAuthStateChanged (audacity::cloud::audiocom::AuthStateChangedMessage)

Static Private Member Functions
static void	ContinueAuthorize (std::string_view authClientId)

Private Attributes
const Mode	mMode
wxTextCtrl *	mEmail {}
wxTextCtrl *	mPassword {}
wxButton *	mContinue {}
Observer::Subscription	mOAuthStateSubscription

Additional Inherited Members
Public Member Functions inherited from wxDialogWrapper
	wxDialogWrapper ()
	wxDialogWrapper (wxWindow *parent, wxWindowID id, const TranslatableString &title, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxDefaultSize, long style=wxDEFAULT_DIALOG_STYLE, const TranslatableString &name=XO("Dialog"))
bool	Create (wxWindow *parent, wxWindowID id, const TranslatableString &title, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxDefaultSize, long style=wxDEFAULT_DIALOG_STYLE, const TranslatableString &name=XO("Dialog"))
void	SetTitle (const TranslatableString &title)
void	SetLabel (const TranslatableString &title)
void	SetName (const TranslatableString &title)
void	SetName ()
Public Member Functions inherited from wxTabTraversalWrapper< wxDialog >
	wxTabTraversalWrapper (Args &&... args)
	wxTabTraversalWrapper (const wxTabTraversalWrapper &)=delete
	wxTabTraversalWrapper (wxTabTraversalWrapper &&)=delete
wxTabTraversalWrapper &	operator= (const wxTabTraversalWrapper &)=delete
wxTabTraversalWrapper &	operator= (wxTabTraversalWrapper &&)=delete

Detailed Description

Definition at line 13 of file LoginDialog.h.

Member Enumeration Documentation

Mode

enum class LoginDialog::Mode

strong

Enumerator
Create
SignIn

Definition at line 17 of file LoginDialog.h.

   {
      Create,
      SignIn,
   };

Constructor & Destructor Documentation

LoginDialog()

LoginDialog::LoginDialog ( wxWindow *  parent, wxWindowID  id = wxID_ANY, Mode  mode = Mode::SignIn  )

private

Definition at line 97 of file LoginDialog.cpp.

   : wxDialogWrapper(parent, id, DialogNameForMode(mode))
   , mMode(mode)
{
   mOAuthStateSubscription =
      audacity::cloud::audiocom::GetOAuthService().Subscribe(*this, &LoginDialog::OnOAuthStateChanged);
#if defined(__WXMSW__)
   SetBackgroundColour(theTheme.Colour(clrMedium));
#endif
 
   LayoutControls();
}

References ThemeBase::Colour(), audacity::cloud::audiocom::GetOAuthService(), OnOAuthStateChanged(), Observer::Publisher< Message, NotifyAll >::Subscribe(), and theTheme.

Here is the call graph for this function:

Member Function Documentation

ContinueAuthorize()

void LoginDialog::ContinueAuthorize ( std::string_view  authClientId )

staticprivate

Definition at line 311 of file LoginDialog.cpp.

{
   BasicUI::OpenInDefaultBrowser(
      audacity::cloud::audiocom::OAuthService::MakeOAuthRequestURL(authClientId)
   );
}

References audacity::cloud::audiocom::OAuthService::MakeOAuthRequestURL(), and BasicUI::OpenInDefaultBrowser().

Referenced by OnContinueWithFacebook(), and OnContinueWithGoogle().

Here is the call graph for this function:

Here is the caller graph for this function:

ContinueCreateAccount()

void LoginDialog::ContinueCreateAccount ( )

private

Definition at line 247 of file LoginDialog.cpp.

{
   Disable();
 
   const auto email = mEmail->GetValue().ToStdString();
   const auto password = mPassword->GetValue().ToStdString();
 
   auto& oauthService = audacity::cloud::audiocom::GetOAuthService();
   oauthService.Register(
      email,
      password,
      [weakThis = wxWeakRef(this)](auto token)
      {
         BasicUI::CallAfter([weakThis, token = std::string(token)]()
         {
            if(!weakThis)
               return;
 
            if(token.empty())
            {
               weakThis->Enable();
            }
            else
               weakThis->EndModal(wxID_OK);
         });
      },
      DefaultErrorHandler(this, mMode),
      AudiocomTrace::ignore);
}

References BasicUI::CallAfter(), anonymous_namespace{LoginDialog.cpp}::DefaultErrorHandler(), audacity::cloud::audiocom::GetOAuthService(), ignore, mEmail, mMode, and mPassword.

Referenced by OnContinue().

Here is the call graph for this function:

Here is the caller graph for this function:

ContinueSignIn()

void LoginDialog::ContinueSignIn ( )

private

Definition at line 277 of file LoginDialog.cpp.

{
   Disable();
 
   const auto email = mEmail->GetValue().ToStdString();
   const auto password = mPassword->GetValue().ToStdString();
 
   auto& oauthService = audacity::cloud::audiocom::GetOAuthService();
   oauthService.Authorize(email, password,
      [weakThis = wxWeakRef(this)](auto token)
      {
         BasicUI::CallAfter([weakThis, token = std::string(token)]()
         {
            if(!weakThis)
               return;
 
            if(token.empty())
            {
               weakThis->Enable();
            }
            else
               weakThis->EndModal(wxID_OK);
         });
      },
      DefaultErrorHandler(this, mMode),
      AudiocomTrace::ignore);
}

References BasicUI::CallAfter(), anonymous_namespace{LoginDialog.cpp}::DefaultErrorHandler(), audacity::cloud::audiocom::GetOAuthService(), ignore, mEmail, mMode, and mPassword.

Referenced by OnContinue().

Here is the call graph for this function:

Here is the caller graph for this function:

LayoutControls()

void LoginDialog::LayoutControls ( )

private

Definition at line 126 of file LoginDialog.cpp.

{
   wxFont titleFont = GetFont();
   titleFont.SetWeight(wxFONTWEIGHT_BOLD);
   titleFont.SetPixelSize({ 0, 18 });
 
   auto topSizer = std::make_unique<wxBoxSizer>(wxVERTICAL);
   wxStaticText* title;
   topSizer->Add(
      title = MakeLabel(this,
                        mMode == Mode::Create
                           ? _("Create an account to save to the cloud")
                           : _("Sign in to save to the cloud")),
      0, wxALL, 16);
   title->SetFont(titleFont);
   {
      auto hSizer = std::make_unique<wxBoxSizer>(wxHORIZONTAL);
      hSizer->Add(MakeLoginButton(this, ID_WITH_GOOGLE, bmpGoogleLogo, XO("Continue with Google")), 1, wxEXPAND);
      hSizer->AddSpacer(8);
      hSizer->Add(MakeLoginButton(this, ID_WITH_FACEBOOK, bmpFacebookLogo, XO("Continue with Facebook")), 1, wxEXPAND);
 
      topSizer->Add(hSizer.release(), 0, wxEXPAND | wxLEFT | wxRIGHT | wxBOTTOM, 16);
   }
 
   {
      auto vSizer = std::make_unique<wxBoxSizer>(wxVERTICAL);
      vSizer->Add(MakeLabel(this, _("Email")), 0, wxBOTTOM, 5);
      vSizer->Add(mEmail = safenew wxTextCtrl(this, wxID_ANY), 0, wxEXPAND);
      topSizer->Add(vSizer.release(), 0, wxEXPAND | wxLEFT | wxRIGHT | wxBOTTOM, 16);
   }
   {
      auto vSizer = std::make_unique<wxBoxSizer>(wxVERTICAL);
      vSizer->Add(MakeLabel(this, _("Password")), 0, wxBOTTOM, 5);
      vSizer->Add(mPassword = 
         safenew wxTextCtrl(
            this,
            wxID_ANY,
            wxEmptyString,
            wxDefaultPosition,
            wxDefaultSize,
            wxTE_PASSWORD),
         0, wxEXPAND);
      if(mMode == Mode::SignIn)
         vSizer->Add(safenew wxHyperlinkCtrl(this, wxID_ANY, _("Forgot your password?"), RestorePasswordURL), 0, wxTOP, 10);
         
      topSizer->Add(vSizer.release(), 0, wxEXPAND | wxLEFT | wxRIGHT | wxBOTTOM, 16);
 
      mEmail->Bind(wxEVT_TEXT, &LoginDialog::onUserCredentialsChange, this);
      mPassword->Bind(wxEVT_TEXT, &LoginDialog::onUserCredentialsChange, this);
   }
   if(mMode == Mode::Create)
   {
      auto hSizer = std::make_unique<wxBoxSizer>(wxHORIZONTAL);
      //i18b-hint: followed by hyperlink, keep whitespace at the end
      hSizer->Add(MakeLabel(this, _("Already have an account? ")), 0, wxALIGN_CENTER_VERTICAL);
      hSizer->Add(safenew wxHyperlinkCtrl(this, ID_SIGNIN, _("Sign in here"), ""));
      topSizer->Add(hSizer.release(), 0, wxEXPAND | wxLEFT | wxRIGHT, 16);
   }
   else
   {
      auto hSizer = std::make_unique<wxBoxSizer>(wxHORIZONTAL);
      //i18b-hint: followed by hyperlink, keep whitespace at the end
      hSizer->Add(MakeLabel(this, _("Need an account? ")), 0, wxALIGN_CENTER_VERTICAL);
      hSizer->Add(safenew wxHyperlinkCtrl(this, ID_CREATE_ACCOUNT, _("Create cloud account"), ""));
      topSizer->Add(hSizer.release(), 0, wxEXPAND | wxALL, 16);
   }
 
   {
      auto hSizer = std::make_unique<wxBoxSizer>(wxHORIZONTAL);
      hSizer->Add(safenew wxButton(this, wxID_CANCEL, _("Cancel")));
      hSizer->AddSpacer(8);
      hSizer->Add(mContinue = safenew wxButton(this, wxID_OK, _("Continue")));
      topSizer->Add(hSizer.release(), 0, wxALIGN_RIGHT | wxALL, 16);
      mContinue->Disable();
   }
 
   mEmail->SetFocus();
 
   SetSizerAndFit(topSizer.release());
}

References _, Create, anonymous_namespace{LoginDialog.cpp}::ID_CREATE_ACCOUNT, anonymous_namespace{LoginDialog.cpp}::ID_SIGNIN, anonymous_namespace{LoginDialog.cpp}::ID_WITH_FACEBOOK, anonymous_namespace{LoginDialog.cpp}::ID_WITH_GOOGLE, anonymous_namespace{LoginDialog.cpp}::MakeLabel(), anonymous_namespace{LoginDialog.cpp}::MakeLoginButton(), mContinue, mEmail, mMode, mPassword, onUserCredentialsChange(), anonymous_namespace{LoginDialog.cpp}::RestorePasswordURL, safenew, SignIn, title, and XO().

Here is the call graph for this function:

OnContinue()

void LoginDialog::OnContinue ( wxCommandEvent &  )

private

Definition at line 217 of file LoginDialog.cpp.

{
   if(mMode == Mode::Create)
      ContinueCreateAccount();
   else
      ContinueSignIn();
}

References ContinueCreateAccount(), ContinueSignIn(), Create, and mMode.

Here is the call graph for this function:

OnContinueWithFacebook()

void LoginDialog::OnContinueWithFacebook ( wxCommandEvent &  )

private

Definition at line 230 of file LoginDialog.cpp.

{
   ContinueAuthorize("facebook");
}

References ContinueAuthorize().

Here is the call graph for this function:

OnContinueWithGoogle()

void LoginDialog::OnContinueWithGoogle ( wxCommandEvent &  )

private

Definition at line 225 of file LoginDialog.cpp.

{
   ContinueAuthorize("google");
}

References ContinueAuthorize().

Here is the call graph for this function:

OnCreateAccount()

void LoginDialog::OnCreateAccount ( wxHyperlinkEvent &  )

private

Definition at line 212 of file LoginDialog.cpp.

{
   EndModal(ID_CREATE_ACCOUNT);
}

References anonymous_namespace{LoginDialog.cpp}::ID_CREATE_ACCOUNT.

OnOAuthStateChanged()

void LoginDialog::OnOAuthStateChanged ( audacity::cloud::audiocom::AuthStateChangedMessage  message )

private

Definition at line 305 of file LoginDialog.cpp.

{
   if(message.authorised)
      EndModal(wxOK);
}

References audacity::cloud::audiocom::AuthStateChangedMessage::authorised.

Referenced by LoginDialog().

Here is the caller graph for this function:

OnSignIn()

void LoginDialog::OnSignIn ( wxHyperlinkEvent &  )

private

Definition at line 207 of file LoginDialog.cpp.

{
   EndModal(ID_SIGNIN);
}

References anonymous_namespace{LoginDialog.cpp}::ID_SIGNIN.

onUserCredentialsChange()

void LoginDialog::onUserCredentialsChange ( wxCommandEvent &  )

private

Definition at line 235 of file LoginDialog.cpp.

{
   if (mEmail->IsEmpty() || mPassword->IsEmpty())
   {
      mContinue->Disable();
   }
   else
   {
      mContinue->Enable();
   }
}

References mContinue, mEmail, and mPassword.

Referenced by LayoutControls().

Here is the caller graph for this function:

SignIn()

bool LoginDialog::SignIn ( wxWindow *  parent, Mode  mode = Mode::SignIn  )

static

Definition at line 110 of file LoginDialog.cpp.

{
   while(true)
   {
      LoginDialog dialog(parent, wxID_ANY, mode);
      dialog.wxDialogWrapper::Center();
      auto result = dialog.wxDialogWrapper::ShowModal();
      if(result == ID_SIGNIN)
         mode = Mode::SignIn;
      else if(result == ID_CREATE_ACCOUNT)
         mode = Mode::Create;
      else
         return result == wxID_OK;
   }
}

References Create, anonymous_namespace{LoginDialog.cpp}::ID_CREATE_ACCOUNT, anonymous_namespace{LoginDialog.cpp}::ID_SIGNIN, and SignIn.

Referenced by audacity::cloud::audiocom::sync::CloudProjectPropertiesDialog::SetupEvents().

Here is the caller graph for this function:

Member Data Documentation

mContinue

wxButton* LoginDialog::mContinue {}

private

Definition at line 48 of file LoginDialog.h.

Referenced by LayoutControls(), and onUserCredentialsChange().

mEmail

wxTextCtrl* LoginDialog::mEmail {}

private

Definition at line 46 of file LoginDialog.h.

Referenced by ContinueCreateAccount(), ContinueSignIn(), LayoutControls(), and onUserCredentialsChange().

mMode

const Mode LoginDialog::mMode

private

Definition at line 45 of file LoginDialog.h.

Referenced by ContinueCreateAccount(), ContinueSignIn(), LayoutControls(), and OnContinue().

mOAuthStateSubscription

Observer::Subscription LoginDialog::mOAuthStateSubscription

private

Definition at line 50 of file LoginDialog.h.

mPassword

wxTextCtrl* LoginDialog::mPassword {}

private

Definition at line 47 of file LoginDialog.h.

Referenced by ContinueCreateAccount(), ContinueSignIn(), LayoutControls(), and onUserCredentialsChange().

---

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

• LoginDialog.h
• LoginDialog.cpp