shell32.cpp

Go to the documentation of this file.

/*
 *                 Shell basics
 *
 * Copyright 1998 Marcus Meissner
 * Copyright 1998 Juergen Schmied (jsch)  *  <juergen.schmied@metronet.de>
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
 */
 
#include "precomp.h"
 
#include "shell32_version.h"
 
WINE_DEFAULT_DEBUG_CHANNEL(shell);
 
/*
 * Implemented
 */
EXTERN_C LPWSTR
WINAPI
AddCommasW(DWORD lValue, LPWSTR lpNumber)
{
    WCHAR szValue[MAX_PATH], szSeparator[8 + 1], szGrouping[10 + 1];
    NUMBERFMTW numFormat;
 
    GetLocaleInfoW(LOCALE_USER_DEFAULT,
                   LOCALE_STHOUSAND,
                   szSeparator,
                   _countof(szSeparator));
 
    /* Parse LOCALE_SGROUPING into NUMBERFMTW::Grouping.
     * Accumulate the digit groups left-to-right. If there's no trailing ';0'
     * the last group repeats, so multiply by 10. */
    DWORD dwGrouping = 3;
    if (GetLocaleInfoW(LOCALE_USER_DEFAULT,
                       LOCALE_SGROUPING,
                       szGrouping,
                       _countof(szGrouping)))
    {
        PWSTR p = szGrouping;
        dwGrouping = 0;
        while (*p)
        {
            if (*p >= L'1' && *p <= L'9')
                dwGrouping = dwGrouping * 10 + (*p - L'0');
            p++;
        }
        if (p > szGrouping && *(p - 1) != L'0')
            dwGrouping *= 10;
    }
    numFormat.NumDigits = 0;
    numFormat.LeadingZero = 0;
    numFormat.Grouping = dwGrouping;
    numFormat.lpDecimalSep = szSeparator;
    numFormat.lpThousandSep = szSeparator;
    numFormat.NegativeOrder = 0;
 
    _swprintf(szValue, L"%lu", lValue);
 
    if (GetNumberFormatW(LOCALE_USER_DEFAULT,
                         0,
                         szValue,
                         &numFormat,
                         lpNumber,
                         MAX_PATH) != 0)
    {
        return lpNumber;
    }
 
    wcscpy(lpNumber, szValue);
    return lpNumber;
}
 
/*
 * Implemented
 */
EXTERN_C BOOL
WINAPI
RegenerateUserEnvironment(LPVOID *lpEnvironment, BOOL bUpdateSelf)
{
    HANDLE hUserToken = NULL;
    LPVOID pEnv = NULL;
    BOOL bResult = FALSE;
 
    if (!lpEnvironment)
        return FALSE;
 
    if (!OpenProcessToken(GetCurrentProcess(),
                          TOKEN_QUERY | TOKEN_DUPLICATE | TOKEN_ASSIGN_PRIMARY,
                          &hUserToken))
    {
        return FALSE;
    }
 
    if (!CreateEnvironmentBlock(&pEnv, hUserToken, TRUE))
    {
        CloseHandle(hUserToken);
        return FALSE;
    }
 
    *lpEnvironment = pEnv;
    bResult = TRUE;
 
    if (bUpdateSelf)
    {
        CSimpleMap<CStringW, bool> newVarNames;
 
        LPWSTR pszz = (LPWSTR)pEnv;
        while (pszz && *pszz)
        {
            if (pszz[0] != L'=')
            {
                LPWSTR pchEqual = wcschr(pszz, L'=');
                if (pchEqual)
                {
                    *pchEqual = L'\0';
                    CStringW key(pszz);
                    key.MakeUpper();
                    newVarNames.Add(key, true);
                    SetEnvironmentVariableW(pszz, pchEqual + 1);
                    *pchEqual = L'=';
                }
            }
            pszz += wcslen(pszz) + 1;
        }
 
        LPWCH pCurEnv = GetEnvironmentStringsW();
        if (pCurEnv)
        {
            LPWSTR pCur = (LPWSTR)pCurEnv;
            while (pCur && *pCur)
            {
                if (pCur[0] != L'=')
                {
                    LPWSTR pchEqual = wcschr(pCur, L'=');
                    if (pchEqual)
                    {
                        *pchEqual = L'\0';
                        CStringW key(pCur);
                        key.MakeUpper();
                        if (newVarNames.FindKey(key) < 0)
                            SetEnvironmentVariableW(pCur, NULL);
                        *pchEqual = L'=';
                    }
                }
                pCur += wcslen(pCur) + 1;
            }
            FreeEnvironmentStringsW(pCurEnv);
        }
 
        /* We free the environment block now that we have applied it to the process;
         * the caller gets NULL back in *lpEnvironment in this case. */
        DestroyEnvironmentBlock(pEnv);
        *lpEnvironment = NULL;
    }
 
    CloseHandle(hUserToken);
    return bResult;
}
 
/**************************************************************************
 * Default ClassFactory types
 */
typedef HRESULT (CALLBACK *LPFNCREATEINSTANCE)(IUnknown* pUnkOuter, REFIID riid, LPVOID* ppvObject);
HRESULT IDefClF_fnConstructor(LPFNCREATEINSTANCE lpfnCI, PLONG pcRefDll, const IID *riidInst, IClassFactory **theFactory);
 
 
/**************************************************************************
 * Default ClassFactory Implementation
 *
 * SHCreateDefClassObject
 *
 * NOTES
 *  Helper function for dlls without their own classfactory.
 *  A generic classfactory is returned.
 *  When the CreateInstance of the cf is called the callback is executed.
 */
 
class IDefClFImpl :
    public CComObjectRootEx<CComMultiThreadModelNoCS>,
    public IClassFactory
{
private:
    CLSID                    *rclsid;
    LPFNCREATEINSTANCE        lpfnCI;
    const IID                *riidInst;
    LONG                    *pcRefDll;        /* pointer to refcounter in external dll (ugrrr...) */
public:
    IDefClFImpl();
    HRESULT Initialize(LPFNCREATEINSTANCE lpfnCI, PLONG pcRefDll, const IID *riidInstx);
 
    // IClassFactory
    STDMETHOD(CreateInstance)(IUnknown * pUnkOuter, REFIID riid, LPVOID *ppvObject) override;
    STDMETHOD(LockServer)(BOOL fLock) override;
 
BEGIN_COM_MAP(IDefClFImpl)
    COM_INTERFACE_ENTRY_IID(IID_IClassFactory, IClassFactory)
END_COM_MAP()
};
 
IDefClFImpl::IDefClFImpl()
{
    lpfnCI = NULL;
    riidInst = NULL;
    pcRefDll = NULL;
    rclsid = NULL;
}
 
HRESULT IDefClFImpl::Initialize(LPFNCREATEINSTANCE lpfnCIx, PLONG pcRefDllx, const IID *riidInstx)
{
    lpfnCI = lpfnCIx;
    riidInst = riidInstx;
    pcRefDll = pcRefDllx;
 
    if (pcRefDll)
        InterlockedIncrement(pcRefDll);
 
    TRACE("(%p)%s\n", this, shdebugstr_guid(riidInst));
    return S_OK;
}
 
/******************************************************************************
 * IDefClF_fnCreateInstance
 */
HRESULT WINAPI IDefClFImpl::CreateInstance(IUnknown * pUnkOuter, REFIID riid, LPVOID *ppvObject)
{
    TRACE("%p->(%p,%s,%p)\n", this, pUnkOuter, shdebugstr_guid(&riid), ppvObject);
 
    *ppvObject = NULL;
 
    if (riidInst == NULL || IsEqualCLSID(riid, *riidInst) || IsEqualCLSID(riid, IID_IUnknown))
    {
        return lpfnCI(pUnkOuter, riid, ppvObject);
    }
 
    ERR("unknown IID requested %s\n", shdebugstr_guid(&riid));
    return E_NOINTERFACE;
}
 
/******************************************************************************
 * IDefClF_fnLockServer
 */
HRESULT WINAPI IDefClFImpl::LockServer(BOOL fLock)
{
    TRACE("%p->(0x%x)\n", this, fLock);
 
    if (fLock)
    {
        if (pcRefDll)
        {
            if (*pcRefDll == LONG_MAX)
                ERR("pcRefDll is pinned, not incrementing\n");
            else
                InterlockedIncrement(pcRefDll);
        }
        _pAtlModule->Lock();
    }
    else
    {
        _pAtlModule->Unlock();
        if (pcRefDll)
        {
            if (*pcRefDll == LONG_MAX)
                ERR("pcRefDll is pinned, not decrementing\n");
            else if (*pcRefDll > 0)
                InterlockedDecrement(pcRefDll);
            else
                ERR("pcRefDll underflow\n");
        }
    }
 
    return S_OK;
}
 
/**************************************************************************
 *  IDefClF_fnConstructor
 */
 
HRESULT IDefClF_fnConstructor(LPFNCREATEINSTANCE lpfnCI, PLONG pcRefDll, const IID *riidInst, IClassFactory **theFactory)
{
    return ShellObjectCreatorInit<IDefClFImpl>(lpfnCI, pcRefDll, riidInst, IID_PPV_ARG(IClassFactory, theFactory));
}
 
/******************************************************************************
 * SHCreateDefClassObject            [SHELL32.70]
 */
HRESULT WINAPI SHCreateDefClassObject(
    REFIID    riid,
    LPVOID*    ppv,
    LPFNCREATEINSTANCE lpfnCI,    /* [in] create instance callback entry */
    LPDWORD    pcRefDll,        /* [in/out] ref count of the dll */
    REFIID    riidInst)        /* [in] optional interface to the instance */
{
    IClassFactory                *pcf;
    HRESULT                        hResult;
 
    TRACE("%s %p %p %p %s\n", shdebugstr_guid(&riid), ppv, lpfnCI, pcRefDll, shdebugstr_guid(&riidInst));
 
    if (!IsEqualCLSID(riid, IID_IClassFactory))
        return E_NOINTERFACE;
    hResult = IDefClF_fnConstructor(lpfnCI, (PLONG)pcRefDll, &riidInst, &pcf);
    if (FAILED(hResult))
        return hResult;
    *ppv = pcf;
    return S_OK;
}
 
/**************************************************************************
 *  CStartMenuDummy
 */
class CStartMenuDummy :
    public CComCoClass<CStartMenuDummy, &CLSID_StartMenu>,
    public CComObjectRootEx<CComMultiThreadModelNoCS>
{
private:
    CStartMenuDummy();
    virtual ~CStartMenuDummy();
 
public:
    DECLARE_REGISTRY_RESOURCEID(IDR_STARTMENU)
 
    class _CreatorClass
    {
    public:
        static STDMETHODIMP CreateInstance(void *pv, REFIID riid, LPVOID *ppv)
        {
            if (ppv == NULL)
                return E_POINTER;
            *ppv = NULL;
            if (pv != NULL)
                return CLASS_E_NOAGGREGATION;
            return RSHELL_CStartMenu_CreateInstance(riid, ppv);
        }
    };
};
 
/**************************************************************************
 *  CShell32Module
 */
class CShell32Module : public CComModule
{
public:
    void Term()
    {
        CComCreatorCentralInstance< ATL::CComObject< CDrivesFolder > >::Term();
        CComCreatorCentralInstance< ATL::CComObject< CDesktopFolder > >::Term();
        CComModule::Term();
    }
};
 
 
BEGIN_OBJECT_MAP(ObjectMap)
    OBJECT_ENTRY(CLSID_ActiveDesktop, CActiveDesktop)
    OBJECT_ENTRY(CLSID_ShellFSFolder, CFSFolder)
    OBJECT_ENTRY(CLSID_MyComputer, CDrivesFolder)
    OBJECT_ENTRY(CLSID_ShellDesktop, CDesktopFolder)
    OBJECT_ENTRY(CLSID_ShellFileDefExt, CFileDefExt)
    OBJECT_ENTRY(CLSID_ShellDrvDefExt, CDrvDefExt)
    OBJECT_ENTRY(CLSID_ShellItem, CShellItem)
    OBJECT_ENTRY(CLSID_ShellLink, CShellLink)
    OBJECT_ENTRY(CLSID_Shell, CShellDispatch)
    OBJECT_ENTRY(CLSID_ShellLibrary, CShellLibrary)
    OBJECT_ENTRY(CLSID_DragDropHelper, CDropTargetHelper)
    OBJECT_ENTRY(CLSID_ControlPanel, CControlPanelFolder)
    OBJECT_ENTRY(CLSID_OpenControlPanel, COpenControlPanel)
    OBJECT_ENTRY(CLSID_MyDocuments, CMyDocsFolder)
    OBJECT_ENTRY(CLSID_NetworkPlaces, CNetFolder)
    OBJECT_ENTRY(CLSID_FontsFolderShortcut, CFontsFolder)
    OBJECT_ENTRY(CLSID_Printers, CPrinterFolder)
    OBJECT_ENTRY(CLSID_AdminFolderShortcut, CAdminToolsFolder)
    OBJECT_ENTRY(CLSID_ShellFldSetExt, CFolderOptions)
    OBJECT_ENTRY(CLSID_RecycleBin, CRecycleBin)
    OBJECT_ENTRY(CLSID_OpenWithMenu, COpenWithMenu)
    OBJECT_ENTRY(CLSID_NewMenu, CNewMenu)
    OBJECT_ENTRY(CLSID_SendToMenu, CSendToMenu)
    OBJECT_ENTRY(CLSID_CopyAsPathMenu, CCopyAsPathMenu)
    OBJECT_ENTRY(CLSID_CopyToMenu, CCopyToMenu)
    OBJECT_ENTRY(CLSID_MoveToMenu, CMoveToMenu)
    OBJECT_ENTRY(CLSID_StartMenu, CStartMenuDummy)
    OBJECT_ENTRY(CLSID_MenuBandSite, CMenuSite)
    OBJECT_ENTRY(CLSID_MenuBand, CMenuBand)
    OBJECT_ENTRY(CLSID_MenuDeskBar, CMenuDeskBar)
    OBJECT_ENTRY(CLSID_MergedFolder, CMergedFolder)
    OBJECT_ENTRY(CLSID_ExeDropHandler, CExeDropHandler)
    OBJECT_ENTRY(CLSID_QueryAssociations, CQueryAssociations)
    OBJECT_ENTRY(CLSID_UserNotification, CUserNotification)
    OBJECT_ENTRY(CLSID_UserEventTimer, CUserEventTimer)
END_OBJECT_MAP()
 
CShell32Module  gModule;
 
 
/***********************************************************************
 * DllGetVersion [SHELL32.@]
 *
 * Retrieves version information of the 'SHELL32.DLL'
 *
 * PARAMS
 *     pdvi [O] pointer to version information structure.
 *
 * RETURNS
 *     Success: S_OK
 *     Failure: E_INVALIDARG
 *
 * NOTES
 *     Returns version of a shell32.dll from IE4.01 SP1.
 */
 
STDAPI DllGetVersion(DLLVERSIONINFO *pdvi)
{
    /* FIXME: shouldn't these values come from the version resource? */
    if (pdvi->cbSize == sizeof(DLLVERSIONINFO) ||
        pdvi->cbSize == sizeof(DLLVERSIONINFO2))
    {
        pdvi->dwMajorVersion = WINE_FILEVERSION_MAJOR;
        pdvi->dwMinorVersion = WINE_FILEVERSION_MINOR;
        pdvi->dwBuildNumber = WINE_FILEVERSION_BUILD;
        pdvi->dwPlatformID = WINE_FILEVERSION_PLATFORMID;
        if (pdvi->cbSize == sizeof(DLLVERSIONINFO2))
        {
            DLLVERSIONINFO2 *pdvi2 = (DLLVERSIONINFO2 *)pdvi;
 
            pdvi2->dwFlags = 0;
            pdvi2->ullVersion = MAKEDLLVERULL(WINE_FILEVERSION_MAJOR,
                                              WINE_FILEVERSION_MINOR,
                                              WINE_FILEVERSION_BUILD,
                                              WINE_FILEVERSION_PLATFORMID);
        }
        TRACE("%u.%u.%u.%u\n",
              pdvi->dwMajorVersion, pdvi->dwMinorVersion,
              pdvi->dwBuildNumber, pdvi->dwPlatformID);
        return S_OK;
    }
    else
    {
        WARN("wrong DLLVERSIONINFO size from app\n");
        return E_INVALIDARG;
    }
}
 
/*************************************************************************
 * global variables of the shell32.dll
 * all are once per process
 *
 */
HINSTANCE   shell32_hInstance;
 
/*************************************************************************
 * SHELL32 DllMain
 *
 * NOTES
 *  calling oleinitialize here breaks sone apps.
 */
STDAPI_(BOOL) DllMain(HINSTANCE hInstance, DWORD dwReason, LPVOID fImpLoad)
{
    TRACE("%p 0x%x %p\n", hInstance, dwReason, fImpLoad);
    if (dwReason == DLL_PROCESS_ATTACH)
    {
        shell32_hInstance = hInstance;
        gModule.Init(ObjectMap, hInstance, &LIBID_Shell32);
 
        DisableThreadLibraryCalls (hInstance);
 
        /* get full path to this DLL for IExtractIconW_fnGetIconLocation() */
        GetModuleFileNameW(hInstance, swShell32Name, MAX_PATH);
        swShell32Name[MAX_PATH - 1] = '\0';
 
        /* Initialize comctl32 */
        INITCOMMONCONTROLSEX InitCtrls;
        InitCtrls.dwSize = sizeof(INITCOMMONCONTROLSEX);
        InitCtrls.dwICC = ICC_WIN95_CLASSES | ICC_DATE_CLASSES | ICC_USEREX_CLASSES;
        InitCommonControlsEx(&InitCtrls);
 
        /* Bad idea, initialization in DllMain! */
        InitChangeNotifications();
    }
    else if (dwReason == DLL_PROCESS_DETACH)
    {
        shell32_hInstance = NULL;
        SIC_Destroy();
        FreeChangeNotifications();
        gModule.Term();
    }
    return TRUE;
}
 
/***********************************************************************
 *              DllCanUnloadNow (SHELL32.@)
 */
STDAPI DllCanUnloadNow()
{
    return gModule.DllCanUnloadNow();
}
 
/*************************************************************************
 *              DllGetClassObject     [SHELL32.@]
 *              SHDllGetClassObject   [SHELL32.128]
 */
STDAPI DllGetClassObject(REFCLSID rclsid, REFIID riid, LPVOID *ppv)
{
    HRESULT                                hResult;
 
    TRACE("CLSID:%s,IID:%s\n", shdebugstr_guid(&rclsid), shdebugstr_guid(&riid));
 
    hResult = gModule.DllGetClassObject(rclsid, riid, ppv);
    TRACE("-- pointer to class factory: %p\n", *ppv);
    return hResult;
}
 
static HRESULT UpdateRegistryFromResource(BOOL Register)
{
    static const BYTE resid[] =
    {
        IDR_FOLDEROPTIONS,
        IDR_EXPLORER,
        IDR_SYSTEMFILEASSOC,
    };
    HRESULT hr = S_OK;
    for (SIZE_T i = 0; i < _countof(resid) && SUCCEEDED(hr); ++i)
        hr = gModule.UpdateRegistryFromResource(resid[i], Register, NULL);
    return hr;
}
 
/***********************************************************************
 *              DllRegisterServer (SHELL32.@)
 */
STDAPI DllRegisterServer()
{
    HRESULT hr;
 
    hr = gModule.DllRegisterServer(TRUE);
    if (FAILED(hr))
        return hr;
 
    if (FAILED(hr = UpdateRegistryFromResource(TRUE)))
        return hr;
 
    hr = SHELL_RegisterShellFolders();
    if (FAILED(hr))
        return hr;
 
    return S_OK;
}
 
/***********************************************************************
 *              DllUnregisterServer (SHELL32.@)
 */
STDAPI DllUnregisterServer()
{
    HRESULT hr;
 
    hr = gModule.DllUnregisterServer(TRUE);
    if (FAILED(hr))
        return hr;
 
    if (FAILED(hr = UpdateRegistryFromResource(FALSE)))
        return hr;
 
    return S_OK;
}
 
/*************************************************************************
 * DllInstall         [SHELL32.@]
 *
 * PARAMETERS
 *
 *    BOOL bInstall - TRUE for install, FALSE for uninstall
 *    LPCWSTR pszCmdLine - command line (unused by shell32?)
 */
 
HRESULT WINAPI DllInstall(BOOL bInstall, LPCWSTR cmdline)
{
    FIXME("%s %s: stub\n", bInstall ? "TRUE":"FALSE", debugstr_w(cmdline));
    return S_OK;        /* indicate success */
}