gzLicense.h

Go to the documentation of this file.

//******************************************************************************
// File         : gzLicense.h
// Module       : gzBase
// Description  : Class definition of the gzLicense class
// Author       : Anders Modén      
// Product      : GizmoBase 2.1.1
//      
// Copyright © 2003- Saab Training Systems AB, Sweden
//          
// NOTE:    GizmoBase is a platform abstraction utility layer for C++. It contains 
//          design patterns and C++ solutions for the advanced programmer.
//
//
// Revision History...                          
//                                  
// Who  Date    Description                     
//                                  
// AMO  990420  Created file    
//
//******************************************************************************
#ifndef __GZ_LICENSE_H__
#define __GZ_LICENSE_H__

#include "gzBase.h"
#include "gzService.h"
#include "gzThread.h"


enum gzLicenceFeature
{   
    GZ_LICENSE_FEATURE_NONE     =   0 , 
    GZ_LICENSE_FEATURE_GRAPHICS =   (1<<0),
    GZ_LICENSE_FEATURE_SAVERS   =   (1<<1),
    GZ_LICENSE_FEATURE_DEVELOPER=   (1<<2)

};

GZ_USE_BIT_LOGIC(gzLicenceFeature);

enum gzLicenseCheckFeature
{   
    GZ_LICENSE_CHECK_FEATURE_VALID          =    1,
    GZ_LICENSE_CHECK_FEATURE_INVALID        =   -1,
    GZ_LICENSE_CHECK_FEATURE_WRONG_VERSION  =   -2,
    GZ_LICENSE_CHECK_FEATURE_EXPIRED        =   -3,
    GZ_LICENSE_CHECK_FEATURE_NOT_STARTED    =   -4,
    GZ_LICENSE_CHECK_FEATURE_NOT_LICENSED   =   -5,
    GZ_LICENSE_CHECK_FEATURE_PERMANENT      =   32767,
};

//******************************************************************************
// Class    : gzLicense
//                                  
// Purpose  : Manage GizmoSDK Licenses 
//                                  
// Notes    : - 
//                                  
// Revision History...                          
//                                  
// Who  Date    Description                     
//                                  
// AMO  981128  Created 
//                                  
//******************************************************************************
class gzLicense
{
public:
        
    GZ_BASE_EXPORT static gzULongLong   getMachineID();                                             

    GZ_BASE_EXPORT static gzUShort      getFeatureKey(const gzString &licenseName=GZ_EMPTY_STRING); 

    GZ_BASE_EXPORT static gzUShort      getFeatureKey(const gzULongLong &licenseKey);               

    GZ_BASE_EXPORT static gzVoid        notifyDefaultLicense();                                     

    GZ_BASE_EXPORT static gzULongLong   getLicenseKey(const gzString & licenseName=GZ_EMPTY_STRING);                

    GZ_BASE_EXPORT static gzULongLong   createLicenseKey(const gzString & licenseName,gzULongLong machid ,gzUShort start,gzUShort stop,gzUShort features,const gzString &password);

    GZ_BASE_EXPORT static gzLicenseCheckFeature getEncodedKey(gzULongLong &key,gzString licenseName=GZ_EMPTY_STRING);

    GZ_BASE_EXPORT static gzULongLong   getLicenseIdentifier(gzULongLong UID);

    GZ_BASE_EXPORT static gzULongLong   splashLicenseText(const gzString &header,const gzString &text,gzULongLong checkid=0);

    GZ_BASE_EXPORT static gzString      getLicenseInfoText();

    GZ_BASE_EXPORT static gzLong        getLicenseExpirationDays(const gzString &licenseName=GZ_EMPTY_STRING);

    GZ_BASE_EXPORT static gzBool        isPermanentLicense(const gzString &licenseName);

    GZ_BASE_EXPORT static gzBool        isPermanentLicenseSet(const gzString &licenseName);

    GZ_BASE_EXPORT static gzVoid        setPermanentLicense(const gzString &licenseName);

};

//******************************************************************************
// Class    : gzLicenseManager
//                                  
// Purpose  : Manage licese server
//                                  
// Notes    : - 
//                                  
// Revision History...                          
//                                  
// Who  Date    Description                     
//                                  
// AMO  981128  Created 
//                                  
//******************************************************************************
class  gzLicenseManager : public gzService , public gzThread
{
public:

    GZ_BASE_EXPORT gzLicenseManager();

    GZ_BASE_EXPORT virtual ~gzLicenseManager();

    GZ_BASE_EXPORT gzVoid process();

    GZ_BASE_EXPORT gzVoid process(const gzArgumentParser &args,gzBool runAsService);
};

enum gzFeatureInfo
{
    GZ_FEATURE_OK,
    GZ_FEATURE_MISSING,
    GZ_FEATURE_NOT_ACTIVATED,
    GZ_FEATURE_APPLICATION_MASK_MISMATCH,
    GZ_FEATURE_USER_ROLE_MISMATCH,
    GZ_FEATURE_LICENSE_MISMATCH
};

//******************************************************************************
// Class    : gzFeature
//                                  
// Purpose  : Manage license features, applications and roles
//                                  
// Notes    : - 
//                                  
// Revision History...                          
//                                  
// Who  Date    Description                     
//                                  
// AMO  070416  Created 
//                                  
//******************************************************************************
class  gzFeature : public gzThreadSafeReference
{
public:

    GZ_BASE_EXPORT virtual ~gzFeature();
    GZ_BASE_EXPORT  gzBool  useDeepCopy() { return FALSE; } // Shallow share

    // Properties --------------------------

    GZ_PROPERTY_GET_EXPORT( gzString,       Name,           GZ_BASE_EXPORT);
    GZ_PROPERTY_GET_EXPORT( gzString,       Description,    GZ_BASE_EXPORT);
    GZ_PROPERTY_GET_EXPORT( gzULong,        AppMask,        GZ_BASE_EXPORT);
    GZ_PROPERTY_GET_EXPORT( gzULong,        RoleMask,       GZ_BASE_EXPORT);
    GZ_PROPERTY_GET_EXPORT( gzString,       License,        GZ_BASE_EXPORT);
    GZ_PROPERTY_GET_EXPORT( gzUShort,       FeatureMask,    GZ_BASE_EXPORT);
    GZ_PROPERTY_GET_EXPORT( gzBool,         Activated,      GZ_BASE_EXPORT);


    // Application Feature management ------------------

    GZ_BASE_EXPORT static gzVoid setFeature(    const gzString &    name,
                                                const gzString &    description,
                                                const gzULong       appMask,
                                                const gzULong       roleMask,
                                                const gzString &    license=GZ_EMPTY_STRING,
                                                const gzUShort      featureMask=0);

    GZ_BASE_EXPORT static gzRefPointer<gzFeature> getFeature(const gzString &name );

    GZ_BASE_EXPORT static gzVoid removeFeature( const gzString &name );

    GZ_BASE_EXPORT static gzVoid clearFeatures();

    GZ_BASE_EXPORT static gzVoid setActivated(const gzString &featureName , gzBool activated);

    GZ_BASE_EXPORT static gzArray<gzRefPointer<gzFeature> > getFeatures();

    // Application & Role --------------------------

    GZ_BASE_EXPORT static gzVoid setApplicationMask(gzULong mask);
    GZ_BASE_EXPORT static gzULong getApplicationMask();
    GZ_BASE_EXPORT static gzVoid setSystemRoleMask(gzULong mask);
    GZ_BASE_EXPORT static gzULong getSystemRoleMask();

    // User Utilities -----------------------------------

    GZ_BASE_EXPORT static gzBool hasAllowedFeature(const gzString &featureName,gzFeatureInfo *info=NULL);
    GZ_BASE_EXPORT static gzLong getFeatureExpirationDays(const gzString &featureName);

    GZ_BASE_EXPORT static gzString getFeatureSetIdentification();
    GZ_BASE_EXPORT static gzVoid setFeatureSetIdentification(const gzString &string);

    GZ_BASE_EXPORT static gzBool readFeatures(const gzString &url,const gzString &elementName);
    GZ_BASE_EXPORT static gzBool writeFeatures(const gzString &url,const gzString &elementName,gzBool onlyActivated=TRUE,gzBool noDescriptions=FALSE);

    GZ_BASE_EXPORT static gzBool readFeatures(gzSerializeAdapter *adapter);
    GZ_BASE_EXPORT static gzBool writeFeatures(gzSerializeAdapter *adapter,gzBool onlyActivated=TRUE,gzBool noDescriptions=FALSE);

private:

    GZ_BASE_EXPORT gzFeature();

    static  gzRefDict<gzString,gzFeature>   s_featureDict;
    static  gzMutex                         s_featureDictLocker;
    static  gzULong                         s_applicationMask;
    static  gzULong                         s_roleMask;
    static  gzString                        s_identification;
};

#endif

---