JUCE  v5.4.1-191-g0ab5e696f
JUCE API
Looking for a senior C++ dev?
I'm looking for work. Hire me!
juce::OnlineUnlockStatus Class Referenceabstract

A base class for online unlocking systems. More...

#include <juce_OnlineUnlockStatus.h>

Inheritance diagram for juce::OnlineUnlockStatus:
Collaboration diagram for juce::OnlineUnlockStatus:

Classes

struct  MachineIDUtilities
 This class contains some utility functions that might help with machine ID generation. More...
 
struct  UnlockResult
 This provides some details about the reply that the server gave in a call to attemptWebserverUnlock(). More...
 

Public Member Functions

 OnlineUnlockStatus ()
 
virtual ~OnlineUnlockStatus ()
 Destructor. More...
 
bool applyKeyFile (String keyFileContent)
 Attempts to perform an unlock using a block of key-file data provided. More...
 
UnlockResult attemptWebserverUnlock (const String &email, const String &password)
 Contacts the webserver and attempts to perform a registration with the given user details. More...
 
virtual bool doesProductIDMatch (const String &returnedIDFromServer)=0
 This must check whether a product ID string that the server returned is OK for unlocking the current app. More...
 
Time getExpiryTime () const
 Returns the Time when the keyfile expires. More...
 
virtual StringArray getLocalMachineIDs ()
 Returns a list of strings, any of which should be unique to this physical computer. More...
 
virtual String getMessageForConnectionFailure (bool isInternetConnectionWorking)
 
virtual String getMessageForUnexpectedReply ()
 
virtual String getProductID ()=0
 This must return your product's ID, as allocated by the store. More...
 
virtual RSAKey getPublicKey ()=0
 This must return the RSA public key for authenticating responses from the server for this app. More...
 
virtual URL getServerAuthenticationURL ()=0
 Returns the URL of the authentication API. More...
 
virtual String getState ()=0
 This method must retrieve the last state that was provided by the saveState method. More...
 
String getUserEmail () const
 Returns the user's email address if known. More...
 
virtual String getWebsiteName ()=0
 Returns the name of the web-store website, not for communication, but for presenting to the user. More...
 
var isUnlocked () const
 Returns true if the product has been successfully authorised for this machine. More...
 
void load ()
 Attempts to load the status from the state retrieved by getState(). More...
 
virtual String readReplyFromWebserver (const String &email, const String &password)=0
 Subclasses that talk to a particular web-store will implement this method to contact their webserver and attempt to unlock the current machine for the given username and password. More...
 
void save ()
 Triggers a call to saveState which you can use to store the current unlock status in your app's settings. More...
 
virtual void saveState (const String &)=0
 This method must store the given string somewhere in your app's persistent properties, so it can be retrieved later by getState(). More...
 
void setUserEmail (const String &usernameOrEmail)
 Optionally allows the app to provide the user's email address if it is known. More...
 
virtual void userCancelled ()
 This method will be called if the user cancels the connection to the webserver by clicking the cancel button in OnlineUnlockForm::OverlayComp. More...
 

Private Member Functions

UnlockResult handleFailedConnection ()
 
UnlockResult handleXmlReply (XmlElement)
 

Private Attributes

ValueTree status
 

Static Private Attributes

static const char * expiryTimeProp
 
static const char * unlockedProp
 

Detailed Description

A base class for online unlocking systems.

This class stores information about whether your app has been unlocked for the current machine, and handles communication with a web-store to perform the unlock procedure.

You probably won't ever use this base class directly, but rather a store-specific subclass such as TracktionMarketplaceStatus, which knows how to talk to the particular online store that you're using.

To use it, you create a subclass which implements all the pure virtual methods (see their comments to find out what you'll need to make them do).

Then you can create an instance of your subclass which will hold the registration state. Typically, you'll want to just keep a single instance of the class around for the duration of your app. You can then call its methods to handle the various registration tasks.

Areas of your code that need to know whether the user is registered (e.g. to decide whether a particular feature is available) should call isUnlocked() to find out.

If you want to create a GUI that allows your users to enter their details and register, see the OnlineUnlockForm class.

See also
OnlineUnlockForm, KeyGeneration

{ProductUnlocking}

Constructor & Destructor Documentation

◆ OnlineUnlockStatus()

juce::OnlineUnlockStatus::OnlineUnlockStatus ( )

◆ ~OnlineUnlockStatus()

virtual juce::OnlineUnlockStatus::~OnlineUnlockStatus ( )
virtual

Destructor.

Member Function Documentation

◆ applyKeyFile()

bool juce::OnlineUnlockStatus::applyKeyFile ( String  keyFileContent)

Attempts to perform an unlock using a block of key-file data provided.

You may wish to use this as a way of allowing a user to unlock your app by drag-and-dropping a file containing the key data, or by letting them select such a file. This is often needed for allowing registration on machines without internet access.

◆ attemptWebserverUnlock()

UnlockResult juce::OnlineUnlockStatus::attemptWebserverUnlock ( const String email,
const String password 
)

Contacts the webserver and attempts to perform a registration with the given user details.

The return value will either be a success, or a failure with an error message from the server, so you should show this message to your user.

Because this method blocks while it contacts the server, you must run it on a background thread, not on the message thread. For an easier way to create a GUI to do the unlocking, see OnlineUnlockForm.

◆ doesProductIDMatch()

virtual bool juce::OnlineUnlockStatus::doesProductIDMatch ( const String returnedIDFromServer)
pure virtual

This must check whether a product ID string that the server returned is OK for unlocking the current app.

Implemented in juce::TracktionMarketplaceStatus.

◆ getExpiryTime()

Time juce::OnlineUnlockStatus::getExpiryTime ( ) const
inline

Returns the Time when the keyfile expires.

If a the key file obtained has an expiry time, isUnlocked will return false and this will return a non-zero time. The interpretation of this is up to your app but could be used for subscription based models or trial periods.

◆ getLocalMachineIDs()

virtual StringArray juce::OnlineUnlockStatus::getLocalMachineIDs ( )
virtual

Returns a list of strings, any of which should be unique to this physical computer.

When testing whether the user is allowed to use the product on this machine, this list of tokens is compared to the ones that were stored on the webserver.

The default implementation of this method will simply call MachineIDUtilities::getLocalMachineIDs(), which provides a default version of this functionality.

◆ getMessageForConnectionFailure()

virtual String juce::OnlineUnlockStatus::getMessageForConnectionFailure ( bool  isInternetConnectionWorking)
virtual

◆ getMessageForUnexpectedReply()

virtual String juce::OnlineUnlockStatus::getMessageForUnexpectedReply ( )
virtual

◆ getProductID()

virtual String juce::OnlineUnlockStatus::getProductID ( )
pure virtual

This must return your product's ID, as allocated by the store.

◆ getPublicKey()

virtual RSAKey juce::OnlineUnlockStatus::getPublicKey ( )
pure virtual

This must return the RSA public key for authenticating responses from the server for this app.

You can get this key from your marketplace account page.

◆ getServerAuthenticationURL()

virtual URL juce::OnlineUnlockStatus::getServerAuthenticationURL ( )
pure virtual

Returns the URL of the authentication API.

Implemented in juce::TracktionMarketplaceStatus.

◆ getState()

virtual String juce::OnlineUnlockStatus::getState ( )
pure virtual

This method must retrieve the last state that was provided by the saveState method.

On first-run, it should just return an empty string.

◆ getUserEmail()

String juce::OnlineUnlockStatus::getUserEmail ( ) const

Returns the user's email address if known.

◆ getWebsiteName()

virtual String juce::OnlineUnlockStatus::getWebsiteName ( )
pure virtual

Returns the name of the web-store website, not for communication, but for presenting to the user.

Implemented in juce::TracktionMarketplaceStatus.

◆ handleFailedConnection()

UnlockResult juce::OnlineUnlockStatus::handleFailedConnection ( )
private

◆ handleXmlReply()

UnlockResult juce::OnlineUnlockStatus::handleXmlReply ( XmlElement  )
private

◆ isUnlocked()

var juce::OnlineUnlockStatus::isUnlocked ( ) const
inline

Returns true if the product has been successfully authorised for this machine.

The reason it returns a variant rather than a bool is just to make it marginally more tedious for crackers to work around. Hopefully if this method gets inlined they'll need to hack all the places where you call it, rather than just the function itself.

Bear in mind that each place where you check this return value will need to be changed by a cracker in order to unlock your app, so the more places you call this method, the more hassle it will be for them to find and crack them all.

◆ load()

void juce::OnlineUnlockStatus::load ( )

Attempts to load the status from the state retrieved by getState().

Call this somewhere in your app's startup code.

◆ readReplyFromWebserver()

virtual String juce::OnlineUnlockStatus::readReplyFromWebserver ( const String email,
const String password 
)
pure virtual

Subclasses that talk to a particular web-store will implement this method to contact their webserver and attempt to unlock the current machine for the given username and password.

The return value is the XML text from the server which contains error information and/or the encrypted keyfile.

Implemented in juce::TracktionMarketplaceStatus.

◆ save()

void juce::OnlineUnlockStatus::save ( )

Triggers a call to saveState which you can use to store the current unlock status in your app's settings.

◆ saveState()

virtual void juce::OnlineUnlockStatus::saveState ( const String )
pure virtual

This method must store the given string somewhere in your app's persistent properties, so it can be retrieved later by getState().

◆ setUserEmail()

void juce::OnlineUnlockStatus::setUserEmail ( const String usernameOrEmail)

Optionally allows the app to provide the user's email address if it is known.

You don't need to call this, but if you do it may save the user typing it in.

◆ userCancelled()

virtual void juce::OnlineUnlockStatus::userCancelled ( )
virtual

This method will be called if the user cancels the connection to the webserver by clicking the cancel button in OnlineUnlockForm::OverlayComp.

The default implementation of this method does nothing but you should use it to cancel any WebInputStreams that may be connecting.

Reimplemented in juce::TracktionMarketplaceStatus.

Member Data Documentation

◆ expiryTimeProp

const char* juce::OnlineUnlockStatus::expiryTimeProp
staticprivate

◆ status

ValueTree juce::OnlineUnlockStatus::status
private

◆ unlockedProp

const char* juce::OnlineUnlockStatus::unlockedProp
staticprivate

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