CAvailableApplicationInfo Class Reference

#include <appinfo.h>

Inheritance diagram for CAvailableApplicationInfo:

Collaboration diagram for CAvailableApplicationInfo:

Public Member Functions
	CAvailableApplicationInfo (CConfigParser *Parser, const CStringW &PkgName, AppsCategories Category, const CPathW &BasePath)
	~CAvailableApplicationInfo ()
virtual BOOL	Valid () const override
virtual BOOL	CanModify () override
virtual BOOL	RetrieveIcon (CStringW &Path) const override
virtual BOOL	RetrieveScreenshot (CStringW &Path) override
virtual VOID	ShowAppInfo (CAppRichEdit *RichEdit) override
virtual VOID	GetDownloadInfo (CStringW &Url, CStringW &Sha1, ULONG &SizeInBytes) const override
virtual VOID	GetDisplayInfo (CStringW &License, CStringW &Size, CStringW &UrlSite, CStringW &UrlDownload) override
virtual BOOL	UninstallApplication (BOOL bModify) override
Public Member Functions inherited from CAppInfo
	CAppInfo (const CStringW &Identifier, AppsCategories Category)
virtual	~CAppInfo ()
virtual BOOL	Valid () const =0
virtual BOOL	CanModify ()=0
virtual BOOL	RetrieveIcon (CStringW &Path) const =0
virtual BOOL	RetrieveScreenshot (CStringW &Path)=0
virtual VOID	ShowAppInfo (CAppRichEdit *RichEdit)=0
virtual VOID	GetDownloadInfo (CStringW &Url, CStringW &Sha1, ULONG &SizeInBytes) const =0
virtual VOID	GetDisplayInfo (CStringW &License, CStringW &Size, CStringW &UrlSite, CStringW &UrlDownload)=0
virtual BOOL	UninstallApplication (BOOL bModify)=0

Private Member Functions
VOID	InsertVersionInfo (CAppRichEdit *RichEdit)
VOID	InsertLanguageInfo (CAppRichEdit *RichEdit)
VOID	RetrieveLanguages ()
CStringW	LicenseString ()

Private Attributes
class CConfigParser *	m_Parser
CSimpleArray< CStringW >	m_szScrnshotLocation
bool	m_ScrnshotRetrieved
CStringW	m_szUrlDownload
CStringW	m_szSize
CStringW	m_szUrlSite
CSimpleArray< LCID >	m_LanguageLCIDs
bool	m_LanguagesLoaded

Additional Inherited Members
Public Attributes inherited from CAppInfo
const CStringW	szIdentifier
const AppsCategories	iCategory
CStringW	szDisplayIcon
CStringW	szDisplayName
CStringW	szDisplayVersion
CStringW	szComments

Detailed Description

Definition at line 100 of file appinfo.h.

Constructor & Destructor Documentation

CAvailableApplicationInfo()

CAvailableApplicationInfo::CAvailableApplicationInfo	(	CConfigParser *	Parser,
		const CStringW &	PkgName,
		AppsCategories	Category,
		const CPathW &	BasePath
	)

Definition at line 22 of file appinfo.cpp.

    : CAppInfo(PkgName, Category), m_Parser(Parser), m_ScrnshotRetrieved(false), m_LanguagesLoaded(false)
{
    m_Parser->GetString(L"Name", szDisplayName);
    m_Parser->GetString(L"Version", szDisplayVersion);
    m_Parser->GetString(L"URLDownload", m_szUrlDownload);
    m_Parser->GetString(L"Description", szComments);
 
    CPathW IconPath = BasePath;
    IconPath += L"icons";
 
    CStringW IconName;
    if (m_Parser->GetString(L"Icon", IconName))
    {
        IconPath += IconName;
    }
    else
    {
        // inifile.ico
        IconPath += (szIdentifier + L".ico");
    }
 
    if (PathFileExistsW(IconPath))
    {
        szDisplayIcon = (LPCWSTR)IconPath;
    }
 
    INT iSizeBytes;
 
    if (m_Parser->GetInt(L"SizeBytes", iSizeBytes))
    {
        StrFormatByteSizeW(iSizeBytes, m_szSize.GetBuffer(MAX_PATH), MAX_PATH);
        m_szSize.ReleaseBuffer();
    }
 
    m_Parser->GetString(L"URLSite", m_szUrlSite);
}

~CAvailableApplicationInfo()

CAvailableApplicationInfo::~CAvailableApplicationInfo

(

)

Definition at line 64 of file appinfo.cpp.

{
    delete m_Parser;
}

Member Function Documentation

CanModify()

BOOL CAvailableApplicationInfo::CanModify ( )

overridevirtual

Implements CAppInfo.

Definition at line 287 of file appinfo.cpp.

{
    return FALSE;
}

GetDisplayInfo()

VOID CAvailableApplicationInfo::GetDisplayInfo ( CStringW &  License, CStringW &  Size, CStringW &  UrlSite, CStringW &  UrlDownload  )

overridevirtual

Implements CAppInfo.

Definition at line 352 of file appinfo.cpp.

{
    License = LicenseString();
    Size = m_szSize;
    UrlSite = m_szUrlSite;
    UrlDownload = m_szUrlDownload;
}

GetDownloadInfo()

VOID CAvailableApplicationInfo::GetDownloadInfo ( CStringW &  Url, CStringW &  Sha1, ULONG &  SizeInBytes  ) const

overridevirtual

Implements CAppInfo.

Definition at line 335 of file appinfo.cpp.

{
    Url = m_szUrlDownload;
    m_Parser->GetString(L"SHA1", Sha1);
    INT iSizeBytes;
 
    if (m_Parser->GetInt(L"SizeBytes", iSizeBytes))
    {
        SizeInBytes = (ULONG)iSizeBytes;
    }
    else
    {
        SizeInBytes = 0;
    }
}

InsertLanguageInfo()

VOID CAvailableApplicationInfo::InsertLanguageInfo ( CAppRichEdit *  RichEdit )

private

Definition at line 191 of file appinfo.cpp.

{
    if (!m_LanguagesLoaded)
    {
        RetrieveLanguages();
    }
 
    if (m_LanguageLCIDs.GetSize() == 0)
    {
        return;
    }
 
    const INT nTranslations = m_LanguageLCIDs.GetSize();
    CStringW szLangInfo;
    CStringW szLoadedTextAvailability;
    CStringW szLoadedAInfoText;
 
    szLoadedAInfoText.LoadStringW(IDS_AINFO_LANGUAGES);
 
    const LCID lcEnglish = MAKELCID(MAKELANGID(LANG_ENGLISH, SUBLANG_DEFAULT), SORT_DEFAULT);
    if (m_LanguageLCIDs.Find(GetUserDefaultLCID()) >= 0)
    {
        szLoadedTextAvailability.LoadStringW(IDS_LANGUAGE_AVAILABLE_TRANSLATION);
        if (nTranslations > 1)
        {
            CStringW buf;
            buf.LoadStringW(IDS_LANGUAGE_MORE_PLACEHOLDER);
            szLangInfo.Format(buf, nTranslations - 1);
        }
        else
        {
            szLangInfo.LoadStringW(IDS_LANGUAGE_SINGLE);
            szLangInfo = L" (" + szLangInfo + L")";
        }
    }
    else if (m_LanguageLCIDs.Find(lcEnglish) >= 0)
    {
        szLoadedTextAvailability.LoadStringW(IDS_LANGUAGE_ENGLISH_TRANSLATION);
        if (nTranslations > 1)
        {
            CStringW buf;
            buf.LoadStringW(IDS_LANGUAGE_AVAILABLE_PLACEHOLDER);
            szLangInfo.Format(buf, nTranslations - 1);
        }
        else
        {
            szLangInfo.LoadStringW(IDS_LANGUAGE_SINGLE);
            szLangInfo = L" (" + szLangInfo + L")";
        }
    }
    else
    {
        szLoadedTextAvailability.LoadStringW(IDS_LANGUAGE_NO_TRANSLATION);
    }
 
    RichEdit->InsertText(szLoadedAInfoText, CFE_BOLD);
    RichEdit->InsertText(szLoadedTextAvailability, NULL);
    RichEdit->InsertText(szLangInfo, CFE_ITALIC);
}

Referenced by ShowAppInfo().

InsertVersionInfo()

VOID CAvailableApplicationInfo::InsertVersionInfo ( CAppRichEdit *  RichEdit )

private

Definition at line 116 of file appinfo.cpp.

{
    CStringW szRegName;
    m_Parser->GetString(L"RegName", szRegName);
 
    BOOL bIsInstalled = ::GetInstalledVersion(NULL, szRegName) || ::GetInstalledVersion(NULL, szDisplayName);
    if (bIsInstalled)
    {
        CStringW szInstalledVersion;
        CStringW szNameVersion = szDisplayName + L" " + szDisplayVersion;
        BOOL bHasInstalledVersion = ::GetInstalledVersion(&szInstalledVersion, szRegName) ||
                                    ::GetInstalledVersion(&szInstalledVersion, szDisplayName) ||
                                    ::GetInstalledVersion(&szInstalledVersion, szNameVersion);
 
        if (bHasInstalledVersion)
        {
            BOOL bHasUpdate = CompareVersion(szInstalledVersion, szDisplayVersion) < 0;
            if (bHasUpdate)
                RichEdit->LoadAndInsertText(IDS_STATUS_UPDATE_AVAILABLE, CFE_ITALIC);
            else
                RichEdit->LoadAndInsertText(IDS_STATUS_INSTALLED, CFE_ITALIC);
 
            RichEdit->LoadAndInsertText(IDS_AINFO_VERSION, szInstalledVersion, 0);
        }
        else
        {
            RichEdit->LoadAndInsertText(IDS_STATUS_INSTALLED, CFE_ITALIC);
        }
    }
    else
    {
        RichEdit->LoadAndInsertText(IDS_STATUS_NOTINSTALLED, CFE_ITALIC);
    }
 
    RichEdit->LoadAndInsertText(IDS_AINFO_AVAILABLEVERSION, szDisplayVersion, 0);
}

Referenced by ShowAppInfo().

LicenseString()

CStringW CAvailableApplicationInfo::LicenseString ( )

private

Definition at line 154 of file appinfo.cpp.

{
    INT IntBuffer;
    m_Parser->GetInt(L"LicenseType", IntBuffer);
    CStringW szLicenseString;
    m_Parser->GetString(L"License", szLicenseString);
    LicenseType licenseType;
 
    if (IsLicenseType(IntBuffer))
    {
        licenseType = static_cast<LicenseType>(IntBuffer);
    }
    else
    {
        licenseType = LICENSE_NONE;
    }
 
    CStringW szLicense;
    switch (licenseType)
    {
        case LICENSE_OPENSOURCE:
            szLicense.LoadStringW(IDS_LICENSE_OPENSOURCE);
            break;
        case LICENSE_FREEWARE:
            szLicense.LoadStringW(IDS_LICENSE_FREEWARE);
            break;
        case LICENSE_TRIAL:
            szLicense.LoadStringW(IDS_LICENSE_TRIAL);
            break;
        default:
            return szLicenseString;
    }
 
    return szLicense + L" (" + szLicenseString + L")";
}

Referenced by GetDisplayInfo(), and ShowAppInfo().

RetrieveIcon()

BOOL CAvailableApplicationInfo::RetrieveIcon ( CStringW &  Path ) const

overridevirtual

Implements CAppInfo.

Definition at line 293 of file appinfo.cpp.

{
    Path = szDisplayIcon;
    return !Path.IsEmpty();
}

RetrieveLanguages()

VOID CAvailableApplicationInfo::RetrieveLanguages ( )

private

Definition at line 252 of file appinfo.cpp.

{
    m_LanguagesLoaded = true;
 
    CStringW szBuffer;
    if (!m_Parser->GetString(L"Languages", szBuffer))
    {
        return;
    }
 
    // Parse parameter string
    int iIndex = 0;
    while (true)
    {
        CStringW szLocale = szBuffer.Tokenize(L"|", iIndex);
        if (szLocale.IsEmpty())
            break;
 
        szLocale = L"0x" + szLocale;
 
        INT iLCID;
        if (StrToIntExW(szLocale, STIF_SUPPORT_HEX, &iLCID))
        {
            m_LanguageLCIDs.Add(static_cast<LCID>(iLCID));
        }
    }
}

Referenced by InsertLanguageInfo().

RetrieveScreenshot()

BOOL CAvailableApplicationInfo::RetrieveScreenshot ( CStringW &  Path )

overridevirtual

Implements CAppInfo.

Definition at line 301 of file appinfo.cpp.

{
    if (!m_ScrnshotRetrieved)
    {
        static_assert(MAX_SCRNSHOT_NUM < 10000, "MAX_SCRNSHOT_NUM is too big");
        for (int i = 0; i < MAX_SCRNSHOT_NUM; i++)
        {
            CStringW ScrnshotField;
            ScrnshotField.Format(L"Screenshot%d", i + 1);
            CStringW ScrnshotLocation;
            if (!m_Parser->GetString(ScrnshotField, ScrnshotLocation))
            {
                // We stop at the first screenshot not found,
                // so screenshots _have_ to be consecutive
                break;
            }
 
            if (PathIsURLW(ScrnshotLocation.GetString()))
            {
                m_szScrnshotLocation.Add(ScrnshotLocation);
            }
        }
        m_ScrnshotRetrieved = true;
    }
 
    if (m_szScrnshotLocation.GetSize() > 0)
    {
        Path = m_szScrnshotLocation[0];
    }
 
    return !Path.IsEmpty();
}

ShowAppInfo()

VOID CAvailableApplicationInfo::ShowAppInfo ( CAppRichEdit *  RichEdit )

overridevirtual

Implements CAppInfo.

Definition at line 70 of file appinfo.cpp.

{
    RichEdit->SetText(szDisplayName, CFE_BOLD);
    InsertVersionInfo(RichEdit);
    RichEdit->LoadAndInsertText(IDS_AINFO_LICENSE, LicenseString(), 0);
    InsertLanguageInfo(RichEdit);
 
    RichEdit->LoadAndInsertText(IDS_AINFO_SIZE, m_szSize, 0);
    RichEdit->LoadAndInsertText(IDS_AINFO_URLSITE, m_szUrlSite, CFE_LINK);
    RichEdit->LoadAndInsertText(IDS_AINFO_DESCRIPTION, szComments, 0);
    RichEdit->LoadAndInsertText(IDS_AINFO_URLDOWNLOAD, m_szUrlDownload, CFE_LINK);
    RichEdit->LoadAndInsertText(IDS_AINFO_PACKAGE_NAME, szIdentifier, 0);
}

UninstallApplication()

BOOL CAvailableApplicationInfo::UninstallApplication ( BOOL  bModify )

overridevirtual

Implements CAppInfo.

Definition at line 361 of file appinfo.cpp.

{
    ATLASSERT(FALSE && "Should not be called");
    return FALSE;
}

Valid()

BOOL CAvailableApplicationInfo::Valid ( ) const

overridevirtual

Implements CAppInfo.

Definition at line 281 of file appinfo.cpp.

{
    return !szDisplayName.IsEmpty() && !m_szUrlDownload.IsEmpty();
}

Member Data Documentation

m_LanguageLCIDs

CSimpleArray<LCID> CAvailableApplicationInfo::m_LanguageLCIDs

private

Definition at line 108 of file appinfo.h.

Referenced by InsertLanguageInfo(), and RetrieveLanguages().

m_LanguagesLoaded

bool CAvailableApplicationInfo::m_LanguagesLoaded

private

Definition at line 109 of file appinfo.h.

Referenced by InsertLanguageInfo(), and RetrieveLanguages().

m_Parser

class CConfigParser* CAvailableApplicationInfo::m_Parser

private

Definition at line 102 of file appinfo.h.

Referenced by CAvailableApplicationInfo(), GetDownloadInfo(), InsertVersionInfo(), LicenseString(), RetrieveLanguages(), RetrieveScreenshot(), and ~CAvailableApplicationInfo().

m_ScrnshotRetrieved

bool CAvailableApplicationInfo::m_ScrnshotRetrieved

private

Definition at line 104 of file appinfo.h.

Referenced by RetrieveScreenshot().

m_szScrnshotLocation

CSimpleArray<CStringW> CAvailableApplicationInfo::m_szScrnshotLocation

private

Definition at line 103 of file appinfo.h.

Referenced by RetrieveScreenshot().

m_szSize

CStringW CAvailableApplicationInfo::m_szSize

private

Definition at line 106 of file appinfo.h.

Referenced by CAvailableApplicationInfo(), GetDisplayInfo(), and ShowAppInfo().

m_szUrlDownload

CStringW CAvailableApplicationInfo::m_szUrlDownload

private

Definition at line 105 of file appinfo.h.

Referenced by CAvailableApplicationInfo(), GetDisplayInfo(), GetDownloadInfo(), ShowAppInfo(), and Valid().

m_szUrlSite

CStringW CAvailableApplicationInfo::m_szUrlSite

private

Definition at line 107 of file appinfo.h.

Referenced by CAvailableApplicationInfo(), GetDisplayInfo(), and ShowAppInfo().

---

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

• base/applications/rapps/include/appinfo.h
• base/applications/rapps/appinfo.cpp