CAvailableApplicationInfo Class Reference

#include <available.h>

Collaboration diagram for CAvailableApplicationInfo:

Public Member Functions
	CAvailableApplicationInfo (const ATL::CStringW &sFileNameParam, AvailableStrings &m_Strings)
VOID	RefreshAppInfo (AvailableStrings &m_Strings)
BOOL	HasLanguageInfo () const
BOOL	HasNativeLanguage () const
BOOL	HasEnglishLanguage () const
BOOL	IsInstalled () const
BOOL	HasInstalledVersion () const
BOOL	HasUpdate () const
BOOL	RetrieveScrnshot (UINT Index, ATL::CStringW &ScrnshotLocation) const
BOOL	RetrieveIcon (ATL::CStringW &IconLocation) const
VOID	SetLastWriteTime (FILETIME *ftTime)

Public Attributes
INT	m_Category
LicenseType	m_LicenseType
ATL::CStringW	m_szName
ATL::CStringW	m_szRegName
ATL::CStringW	m_szVersion
ATL::CStringW	m_szLicense
ATL::CStringW	m_szDesc
ATL::CStringW	m_szSize
ATL::CStringW	m_szUrlSite
ATL::CStringW	m_szUrlDownload
ATL::CSimpleArray< LCID >	m_LanguageLCIDs
ATL::CSimpleArray< ATL::CStringW >	m_szScrnshotLocation
ATL::CStringW	m_szIconLocation
ATL::CStringW	m_szPkgName
ULONG	m_SizeBytes
ATL::CStringW	m_sFileName
FILETIME	m_ftCacheStamp
ATL::CStringW	m_szSHA1
ATL::CStringW	m_szInstalledVersion

Private Member Functions
BOOL	GetString (LPCWSTR lpKeyName, ATL::CStringW &ReturnedString)
VOID	RetrieveGeneralInfo (AvailableStrings &m_Strings)
VOID	RetrieveInstalledStatus ()
VOID	RetrieveInstalledVersion ()
VOID	RetrieveLanguages ()
VOID	RetrieveLicenseType ()
VOID	RetrieveSize ()
BOOL	FindInLanguages (LCID what) const

Private Attributes
BOOL	m_IsInstalled
BOOL	m_HasLanguageInfo
BOOL	m_HasInstalledVersion
CConfigParser *	m_Parser

Detailed Description

Definition at line 41 of file available.h.

Constructor & Destructor Documentation

CAvailableApplicationInfo()

CAvailableApplicationInfo::CAvailableApplicationInfo	(	const ATL::CStringW &	sFileNameParam,
		AvailableStrings &	m_Strings
	)

Definition at line 19 of file available.cpp.

    : m_LicenseType(LICENSE_NONE), m_SizeBytes(0), m_sFileName(sFileNameParam),
    m_IsInstalled(FALSE), m_HasLanguageInfo(FALSE), m_HasInstalledVersion(FALSE)
{
    RetrieveGeneralInfo(AvlbStrings);
}

Member Function Documentation

FindInLanguages()

BOOL CAvailableApplicationInfo::FindInLanguages ( LCID  what ) const

inlineprivate

Definition at line 225 of file available.cpp.

{
    if (!m_HasLanguageInfo)
    {
        return FALSE;
    }

    //Find locale code in the list
    const INT nLanguagesSize = m_LanguageLCIDs.GetSize();
    for (INT i = 0; i < nLanguagesSize; ++i)
    {
        if (m_LanguageLCIDs[i] == what)
        {
            return TRUE;
        }
    }

    return FALSE;
}

Referenced by HasEnglishLanguage(), and HasNativeLanguage().

GetString()

BOOL CAvailableApplicationInfo::GetString ( LPCWSTR  lpKeyName, ATL::CStringW &  ReturnedString  )

inlineprivate

Definition at line 300 of file available.cpp.

{
    if (!m_Parser->GetString(lpKeyName, ReturnedString))
    {
        ReturnedString.Empty();
        return FALSE;
    }
    return TRUE;
}

Referenced by RetrieveGeneralInfo().

HasEnglishLanguage()

BOOL CAvailableApplicationInfo::HasEnglishLanguage

(

)

const

Definition at line 255 of file available.cpp.

{
    return FindInLanguages(MAKELCID(MAKELANGID(LANG_ENGLISH, SUBLANG_DEFAULT), SORT_DEFAULT));
}

HasInstalledVersion()

BOOL CAvailableApplicationInfo::HasInstalledVersion

(

)

const

Definition at line 265 of file available.cpp.

{
    return m_HasInstalledVersion;
}

HasLanguageInfo()

BOOL CAvailableApplicationInfo::HasLanguageInfo

(

)

const

Definition at line 245 of file available.cpp.

{
    return m_HasLanguageInfo;
}

HasNativeLanguage()

BOOL CAvailableApplicationInfo::HasNativeLanguage

(

)

const

Definition at line 250 of file available.cpp.

{
    return FindInLanguages(GetUserDefaultLCID());
}

HasUpdate()

BOOL CAvailableApplicationInfo::HasUpdate

(

)

const

Definition at line 270 of file available.cpp.

{
    return (m_szInstalledVersion.Compare(m_szVersion) < 0) ? TRUE : FALSE;
}

IsInstalled()

BOOL CAvailableApplicationInfo::IsInstalled

(

)

const

Definition at line 260 of file available.cpp.

{
    return m_IsInstalled;
}

RefreshAppInfo()

VOID CAvailableApplicationInfo::RefreshAppInfo

(

AvailableStrings &

m_Strings

)

Definition at line 26 of file available.cpp.

{
    if (m_szUrlDownload.IsEmpty())
    {
        RetrieveGeneralInfo(AvlbStrings);
    }
}

RetrieveGeneralInfo()

VOID CAvailableApplicationInfo::RetrieveGeneralInfo ( AvailableStrings &  m_Strings )

private

Definition at line 35 of file available.cpp.

{
    m_Parser = new CConfigParser(m_sFileName);

    // TODO: I temporarily use the file name (without suffix) as package name.
    // It should be better to put this in a field of ini file.
    // Consider writing a converter to do this and write a github action for
    // rapps-db to ensure package_name is unique.
    m_szPkgName = m_sFileName;
    PathRemoveExtensionW(m_szPkgName.GetBuffer(MAX_PATH));
    m_szPkgName.ReleaseBuffer();

    m_Parser->GetInt(L"Category", m_Category);

    if (!GetString(L"Name", m_szName)
        || !GetString(L"URLDownload", m_szUrlDownload))
    {
        delete m_Parser;
        return;
    }

    GetString(L"RegName", m_szRegName);
    GetString(L"Version", m_szVersion);
    GetString(L"License", m_szLicense);
    GetString(L"Description", m_szDesc);
    GetString(L"URLSite", m_szUrlSite);
    GetString(L"SHA1", m_szSHA1);

    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 (!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);
        }
        else
        {
            // TODO: Does the filename contain anything stuff like ":" "<" ">" ?
            // these stuff may lead to security issues
            ATL::CStringW ScrnshotName = AvlbStrings.szAppsPath;
            PathAppendW(ScrnshotName.GetBuffer(MAX_PATH), L"screenshots");
            BOOL bSuccess = PathAppendNoDirEscapeW(ScrnshotName.GetBuffer(), ScrnshotLocation.GetString());
            ScrnshotName.ReleaseBuffer();
            if (bSuccess)
            {
                m_szScrnshotLocation.Add(ScrnshotName);
            }
        }
    }

    ATL::CStringW IconPath = AvlbStrings.szAppsPath;
    PathAppendW(IconPath.GetBuffer(MAX_PATH), L"icons");

    // TODO: are we going to support specify an URL for an icon ?
    ATL::CStringW IconLocation;
    if (GetString(L"Icon", IconLocation))
    {
        BOOL bSuccess = PathAppendNoDirEscapeW(IconPath.GetBuffer(), IconLocation.GetString());
        IconPath.ReleaseBuffer();

        if (!bSuccess)
        {
            IconPath.Empty();
        }
    }
    else
    {
        // inifile.ico
        PathAppendW(IconPath.GetBuffer(), m_szPkgName);
        IconPath.ReleaseBuffer();
        IconPath += L".ico";
    }

    if (!IconPath.IsEmpty())
    {
        if (PathFileExistsW(IconPath))
        {
            m_szIconLocation = IconPath;
        }
    }

    RetrieveSize();
    RetrieveLicenseType();
    RetrieveLanguages();
    RetrieveInstalledStatus();

    if (m_IsInstalled)
    {
        RetrieveInstalledVersion();
    }

    delete m_Parser;
}

Referenced by CAvailableApplicationInfo(), and RefreshAppInfo().

RetrieveIcon()

BOOL CAvailableApplicationInfo::RetrieveIcon

(

ATL::CStringW &

IconLocation

)

const

Definition at line 285 of file available.cpp.

{
    if (m_szIconLocation.IsEmpty())
    {
        return FALSE;
    }
    IconLocation = m_szIconLocation;
    return TRUE;
}

Referenced by CAppsListView::AddAvailableApplication().

RetrieveInstalledStatus()

VOID CAvailableApplicationInfo::RetrieveInstalledStatus ( )

private

Definition at line 139 of file available.cpp.

{
    m_IsInstalled = ::GetInstalledVersion(NULL, m_szRegName)
        || ::GetInstalledVersion(NULL, m_szName);
}

Referenced by RetrieveGeneralInfo().

RetrieveInstalledVersion()

VOID CAvailableApplicationInfo::RetrieveInstalledVersion ( )

private

Definition at line 145 of file available.cpp.

{
    ATL::CStringW szNameVersion;
    szNameVersion = m_szName + L" " + m_szVersion;
    m_HasInstalledVersion = ::GetInstalledVersion(&m_szInstalledVersion, m_szRegName)
        || ::GetInstalledVersion(&m_szInstalledVersion, m_szName)
        || ::GetInstalledVersion(&m_szInstalledVersion, szNameVersion);
}

Referenced by RetrieveGeneralInfo().

RetrieveLanguages()

VOID CAvailableApplicationInfo::RetrieveLanguages ( )

private

Definition at line 154 of file available.cpp.

{
    const WCHAR cDelimiter = L'|';
    ATL::CStringW szBuffer;

    // TODO: Get multiline parameter
    if (!m_Parser->GetString(L"Languages", szBuffer))
    {
        m_HasLanguageInfo = FALSE;
        return;
    }

    // Parse parameter string
    ATL::CStringW m_szLocale;
    INT iLCID;
    for (INT i = 0; szBuffer[i] != UNICODE_NULL; ++i)
    {
        if (szBuffer[i] != cDelimiter && szBuffer[i] != L'\n')
        {
            m_szLocale += szBuffer[i];
        }
        else
        {
            if (StrToIntExW(m_szLocale.GetString(), STIF_DEFAULT, &iLCID))
            {
                m_LanguageLCIDs.Add(static_cast<LCID>(iLCID));
                m_szLocale.Empty();
            }
        }
    }

    // For the text after delimiter
    if (!m_szLocale.IsEmpty())
    {
        if (StrToIntExW(m_szLocale.GetString(), STIF_DEFAULT, &iLCID))
        {
            m_LanguageLCIDs.Add(static_cast<LCID>(iLCID));
        }
    }

    m_HasLanguageInfo = TRUE;
}

Referenced by RetrieveGeneralInfo().

RetrieveLicenseType()

VOID CAvailableApplicationInfo::RetrieveLicenseType ( )

private

Definition at line 197 of file available.cpp.

{
    INT IntBuffer;

    m_Parser->GetInt(L"LicenseType", IntBuffer);

    if (IsLicenseType(IntBuffer))
    {
        m_LicenseType = static_cast<LicenseType>(IntBuffer);
    }
    else
    {
        m_LicenseType = LICENSE_NONE;
    }
}

Referenced by RetrieveGeneralInfo().

RetrieveScrnshot()

BOOL CAvailableApplicationInfo::RetrieveScrnshot	(	UINT	Index,
		ATL::CStringW &	ScrnshotLocation
	)		const

Definition at line 275 of file available.cpp.

{
    if (Index >= (UINT)m_szScrnshotLocation.GetSize())
    {
        return FALSE;
    }
    ScrnshotLocation = m_szScrnshotLocation[Index];
    return TRUE;
}

RetrieveSize()

VOID CAvailableApplicationInfo::RetrieveSize ( )

private

Definition at line 213 of file available.cpp.

{
    INT iSizeBytes;

    if (!m_Parser->GetInt(L"SizeBytes", iSizeBytes))
        return;

    m_SizeBytes = iSizeBytes;
    StrFormatByteSizeW(iSizeBytes, m_szSize.GetBuffer(MAX_PATH), MAX_PATH);
    m_szSize.ReleaseBuffer();
}

Referenced by RetrieveGeneralInfo().

SetLastWriteTime()

VOID CAvailableApplicationInfo::SetLastWriteTime

(

FILETIME *

ftTime

)

Definition at line 295 of file available.cpp.

{
    RtlCopyMemory(&m_ftCacheStamp, ftTime, sizeof(FILETIME));
}

Member Data Documentation

m_Category

INT CAvailableApplicationInfo::m_Category

Definition at line 44 of file available.h.

Referenced by RetrieveGeneralInfo().

m_ftCacheStamp

FILETIME CAvailableApplicationInfo::m_ftCacheStamp

Definition at line 64 of file available.h.

Referenced by SetLastWriteTime().

m_HasInstalledVersion

BOOL CAvailableApplicationInfo::m_HasInstalledVersion

private

Definition at line 89 of file available.h.

Referenced by HasInstalledVersion(), and RetrieveInstalledVersion().

m_HasLanguageInfo

BOOL CAvailableApplicationInfo::m_HasLanguageInfo

private

Definition at line 88 of file available.h.

Referenced by FindInLanguages(), HasLanguageInfo(), and RetrieveLanguages().

m_IsInstalled

BOOL CAvailableApplicationInfo::m_IsInstalled

private

Definition at line 87 of file available.h.

Referenced by IsInstalled(), RetrieveGeneralInfo(), and RetrieveInstalledStatus().

m_LanguageLCIDs

ATL::CSimpleArray<LCID> CAvailableApplicationInfo::m_LanguageLCIDs

Definition at line 55 of file available.h.

Referenced by FindInLanguages(), and RetrieveLanguages().

m_LicenseType

LicenseType CAvailableApplicationInfo::m_LicenseType

Definition at line 46 of file available.h.

Referenced by RetrieveLicenseType().

m_Parser

CConfigParser* CAvailableApplicationInfo::m_Parser

private

Definition at line 90 of file available.h.

Referenced by GetString(), RetrieveGeneralInfo(), RetrieveLanguages(), RetrieveLicenseType(), and RetrieveSize().

m_sFileName

ATL::CStringW CAvailableApplicationInfo::m_sFileName

Definition at line 63 of file available.h.

Referenced by RetrieveGeneralInfo().

m_SizeBytes

ULONG CAvailableApplicationInfo::m_SizeBytes

Definition at line 60 of file available.h.

Referenced by RetrieveSize().

m_szDesc

ATL::CStringW CAvailableApplicationInfo::m_szDesc

Definition at line 51 of file available.h.

Referenced by CAppsListView::AddAvailableApplication(), HandleInfoCommand(), and RetrieveGeneralInfo().

m_szIconLocation

ATL::CStringW CAvailableApplicationInfo::m_szIconLocation

Definition at line 57 of file available.h.

Referenced by RetrieveGeneralInfo(), and RetrieveIcon().

m_szInstalledVersion

ATL::CStringW CAvailableApplicationInfo::m_szInstalledVersion

Definition at line 68 of file available.h.

Referenced by HasUpdate(), and RetrieveInstalledVersion().

m_szLicense

ATL::CStringW CAvailableApplicationInfo::m_szLicense

Definition at line 50 of file available.h.

Referenced by HandleInfoCommand(), and RetrieveGeneralInfo().

m_szName

ATL::CStringW CAvailableApplicationInfo::m_szName

Definition at line 47 of file available.h.

Referenced by CAppsListView::AddAvailableApplication(), HandleInfoCommand(), RetrieveGeneralInfo(), RetrieveInstalledStatus(), and RetrieveInstalledVersion().

m_szPkgName

ATL::CStringW CAvailableApplicationInfo::m_szPkgName

Definition at line 58 of file available.h.

Referenced by RetrieveGeneralInfo().

m_szRegName

ATL::CStringW CAvailableApplicationInfo::m_szRegName

Definition at line 48 of file available.h.

Referenced by RetrieveGeneralInfo(), RetrieveInstalledStatus(), and RetrieveInstalledVersion().

m_szScrnshotLocation

ATL::CSimpleArray<ATL::CStringW> CAvailableApplicationInfo::m_szScrnshotLocation

Definition at line 56 of file available.h.

Referenced by RetrieveGeneralInfo(), and RetrieveScrnshot().

m_szSHA1

ATL::CStringW CAvailableApplicationInfo::m_szSHA1

Definition at line 67 of file available.h.

Referenced by RetrieveGeneralInfo().

m_szSize

ATL::CStringW CAvailableApplicationInfo::m_szSize

Definition at line 52 of file available.h.

Referenced by HandleInfoCommand(), and RetrieveSize().

m_szUrlDownload

ATL::CStringW CAvailableApplicationInfo::m_szUrlDownload

Definition at line 54 of file available.h.

Referenced by HandleInfoCommand(), RefreshAppInfo(), and RetrieveGeneralInfo().

m_szUrlSite

ATL::CStringW CAvailableApplicationInfo::m_szUrlSite

Definition at line 53 of file available.h.

Referenced by HandleInfoCommand(), and RetrieveGeneralInfo().

m_szVersion

ATL::CStringW CAvailableApplicationInfo::m_szVersion

Definition at line 49 of file available.h.

Referenced by CAppsListView::AddAvailableApplication(), HandleInfoCommand(), HasUpdate(), RetrieveGeneralInfo(), and RetrieveInstalledVersion().

---

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

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