update/updater/progressui_win.cxx

/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* vim:set ts=2 sw=2 sts=2 et cindent: */
/* This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */

#ifdef _WIN32
#include <stdio.h>
#ifndef UNICODE
#define UNICODE
#endif
#include <windows.h>
#include <commctrl.h>
#include <process.h>
#include <io.h>

#include "resource.h"
#include "progressui.h"
#include "readstrings.h"
#include "errors.h"

#define TIMER_ID 1
#define TIMER_INTERVAL 100

#define RESIZE_WINDOW(hwnd, extrax, extray) \
  { \
    RECT windowSize; \
    GetWindowRect(hwnd, &windowSize); \
    SetWindowPos(hwnd, 0, 0, 0, windowSize.right - windowSize.left + extrax, \
                 windowSize.bottom - windowSize.top + extray, \
                 SWP_NOMOVE | SWP_NOZORDER); \
  }

#define MOVE_WINDOW(hwnd, dx, dy) \
  { \
    RECT rc; \
    POINT pt; \
    GetWindowRect(hwnd, &rc); \
    pt.x = rc.left; \
    pt.y = rc.top; \
    ScreenToClient(GetParent(hwnd), &pt); \
    SetWindowPos(hwnd, 0, pt.x + dx, pt.y + dy, 0, 0, \
                 SWP_NOSIZE | SWP_NOZORDER); \
  }

static float sProgress;  // between 0 and 100
static BOOL  sQuit = FALSE;
static BOOL sIndeterminate = FALSE;
static StringTable sUIStrings;

static BOOL
GetStringsFile(WCHAR filename[MAX_PATH])
{
    if (!GetModuleFileNameW(nullptr, filename, MAX_PATH))
        return FALSE;

    WCHAR *dot = wcsrchr(filename, '.');
    if (!dot || wcsicmp(dot + 1, L"exe"))
        return FALSE;

    wcscpy(dot + 1, L"ini");
    return TRUE;
}

static void
UpdateDialog(HWND hDlg)
{
    int pos = int(sProgress + 0.5f);
    HWND hWndPro = GetDlgItem(hDlg, IDC_PROGRESS);
    SendMessage(hWndPro, PBM_SETPOS, pos, 0L);
}

// The code in this function is from MSDN:
// http://msdn.microsoft.com/library/default.asp?url=/library/en-us/winui/winui/windowsuserinterface/windowing/dialogboxes/usingdialogboxes.asp
static void
CenterDialog(HWND hDlg)
{
    RECT rc, rcOwner, rcDlg;

    // Get the owner window and dialog box rectangles.
    HWND desktop = GetDesktopWindow();

    GetWindowRect(desktop, &rcOwner);
    GetWindowRect(hDlg, &rcDlg);
    CopyRect(&rc, &rcOwner);

    // Offset the owner and dialog box rectangles so that
    // right and bottom values represent the width and
    // height, and then offset the owner again to discard
    // space taken up by the dialog box.

    OffsetRect(&rcDlg, -rcDlg.left, -rcDlg.top);
    OffsetRect(&rc, -rc.left, -rc.top);
    OffsetRect(&rc, -rcDlg.right, -rcDlg.bottom);

    // The new position is the sum of half the remaining
    // space and the owner's original position.

    SetWindowPos(hDlg,
                 HWND_TOP,
                 rcOwner.left + (rc.right / 2),
                 rcOwner.top + (rc.bottom / 2),
                 0, 0,          // ignores size arguments
                 SWP_NOSIZE);
}

static void
InitDialog(HWND hDlg)
{
    WCHAR szwTitle[MAX_TEXT_LEN];
    WCHAR szwInfo[MAX_TEXT_LEN];

    MultiByteToWideChar(CP_UTF8, 0, sUIStrings.title, -1, szwTitle,
                        sizeof(szwTitle)/sizeof(szwTitle[0]));
    MultiByteToWideChar(CP_UTF8, 0, sUIStrings.info, -1, szwInfo,
                        sizeof(szwInfo)/sizeof(szwInfo[0]));

    SetWindowTextW(hDlg, szwTitle);
    SetWindowTextW(GetDlgItem(hDlg, IDC_INFO), szwInfo);

    // Set dialog icon
    HICON hIcon = LoadIcon(GetModuleHandle(nullptr),
                           MAKEINTRESOURCE(IDI_DIALOG));
    if (hIcon)
        SendMessage(hDlg, WM_SETICON, ICON_BIG, (LPARAM) hIcon);

    HWND hWndPro = GetDlgItem(hDlg, IDC_PROGRESS);
    SendMessage(hWndPro, PBM_SETRANGE, 0, MAKELPARAM(0, 100));
    if (sIndeterminate)
    {
        LONG_PTR val = GetWindowLongPtr(hWndPro, GWL_STYLE);
        SetWindowLongPtr(hWndPro, GWL_STYLE, val|PBS_MARQUEE);
        SendMessage(hWndPro,(UINT) PBM_SETMARQUEE,(WPARAM) TRUE,(LPARAM)50 );
    }

    // Resize the dialog to fit all of the text if necessary.
    RECT infoSize, textSize;
    HWND hWndInfo = GetDlgItem(hDlg, IDC_INFO);

    // Get the control's font for calculating the new size for the control
    HDC hDCInfo = GetDC(hWndInfo);
    HFONT hInfoFont;
    HFONT hOldFont = 0;
    hInfoFont = (HFONT)SendMessage(hWndInfo, WM_GETFONT, 0, 0);

    if (hInfoFont)
        hOldFont = (HFONT)SelectObject(hDCInfo, hInfoFont);

    // Measure the space needed for the text on a single line. DT_CALCRECT means
    // nothing is drawn.
    if (DrawText(hDCInfo, szwInfo, -1, &textSize,
                 DT_CALCRECT | DT_NOCLIP | DT_SINGLELINE))
    {
        GetClientRect(hWndInfo, &infoSize);
        SIZE extra;
        // Calculate the additional space needed for the text by subtracting from
        // the rectangle returned by DrawText the existing client rectangle's width
        // and height.
        extra.cx = (textSize.right - textSize.left) - \
                   (infoSize.right - infoSize.left);
        extra.cy = (textSize.bottom - textSize.top) - \
                   (infoSize.bottom - infoSize.top);
        if (extra.cx < 0)
            extra.cx = 0;
        if (extra.cy < 0)
            extra.cy = 0;
        if ((extra.cx > 0) || (extra.cy > 0))
        {
            RESIZE_WINDOW(hDlg, extra.cx, extra.cy);
            RESIZE_WINDOW(hWndInfo, extra.cx, extra.cy);
            RESIZE_WINDOW(hWndPro, extra.cx, 0);
            MOVE_WINDOW(hWndPro, 0, extra.cy);
        }
    }

    if (hOldFont)
        SelectObject(hDCInfo, hOldFont);

    ReleaseDC(hWndInfo, hDCInfo);

    CenterDialog(hDlg);  // make dialog appear in the center of the screen

    SetTimer(hDlg, TIMER_ID, TIMER_INTERVAL, nullptr);
}

// Message handler for update dialog.
static LRESULT CALLBACK
DialogProc(HWND hDlg, UINT message, WPARAM /*wParam*/, LPARAM /*lParam*/)
{
    switch (message)
    {
        case WM_INITDIALOG:
            InitDialog(hDlg);
            return TRUE;

        case WM_TIMER:
            if (sQuit)
            {
                EndDialog(hDlg, 0);
            }
            else
            {
                UpdateDialog(hDlg);
            }
            return TRUE;

        case WM_COMMAND:
            return TRUE;
    }
    return FALSE;
}

int
InitProgressUI(int* /*argc*/, WCHAR*** /*argv*/)
{
    return 0;
}

/**
 * Initializes the progress UI strings
 *
 * @return 0 on success, -1 on error
*/
int
InitProgressUIStrings()
{
    // If we do not have updater.ini, then we should not bother showing UI.
    WCHAR filename[MAX_PATH];
    if (!GetStringsFile(filename))
    {
        strcpy(sUIStrings.title, "LibreOffice Update");
        strcpy(sUIStrings.info, "Please wait while we update your installation.");
        return 0;
    }

    if (_waccess(filename, 04))
    {
        strcpy(sUIStrings.title, "LibreOffice Update");
        strcpy(sUIStrings.info, "Please wait while we update your installation.");
        return 0;
    }

    // If the updater.ini doesn't have the required strings, then we should not
    // bother showing UI.
    if (ReadStrings(filename, &sUIStrings) != OK)
    {
        strcpy(sUIStrings.title, "LibreOffice Update");
        strcpy(sUIStrings.info, "Please wait while we update your installation.");
    }

    return 0;
}

int
ShowProgressUI(bool indeterminate, bool initUIStrings)
{
    sIndeterminate = indeterminate;
    if (!indeterminate)
    {
        // Only show the Progress UI if the process is taking a significant amount of
        // time where a significant amount of time is defined as .5 seconds after
        // ShowProgressUI is called sProgress is less than 70.
        Sleep(500);

        if (sQuit || sProgress > 70.0f)
            return 0;
    }

    // Don't load the UI if there's an <exe_name>.Local directory for redirection.
    WCHAR appPath[MAX_PATH + 1] = { L'\0' };
    if (!GetModuleFileNameW(nullptr, appPath, MAX_PATH))
    {
        return -1;
    }

    if (wcslen(appPath) + wcslen(L".Local") >= MAX_PATH)
    {
        return -1;
    }

    wcscat(appPath, L".Local");

    if (!_waccess(appPath, 04))
    {
        return -1;
    }

    // Don't load the UI if the strings for the UI are not provided.
    if (initUIStrings && InitProgressUIStrings() == -1)
    {
        return -1;
    }

    if (!GetModuleFileNameW(nullptr, appPath, MAX_PATH))
    {
        return -1;
    }

    // Use an activation context that supports visual styles for the controls.
    ACTCTXW actx = {0};
    actx.cbSize = sizeof(ACTCTXW);
    actx.dwFlags = ACTCTX_FLAG_RESOURCE_NAME_VALID | ACTCTX_FLAG_HMODULE_VALID;
    actx.hModule = GetModuleHandle(NULL); // Use the embedded manifest
    // This is needed only for Win XP but doesn't cause a problem with other
    // versions of Windows.
    actx.lpSource = appPath;
    actx.lpResourceName = MAKEINTRESOURCE(IDR_COMCTL32_MANIFEST);

    HANDLE hactx = CreateActCtxW(&actx);
    ULONG_PTR actxCookie = NULL;
    if (hactx != INVALID_HANDLE_VALUE)
    {
        // Push the specified activation context to the top of the activation stack.
        ActivateActCtx(hactx, &actxCookie);
    }

    INITCOMMONCONTROLSEX icc =
    {
        sizeof(INITCOMMONCONTROLSEX),
        ICC_PROGRESS_CLASS
    };
    InitCommonControlsEx(&icc);

    DialogBox(GetModuleHandle(nullptr),
              MAKEINTRESOURCE(IDD_DIALOG), nullptr,
              (DLGPROC) DialogProc);

    if (hactx != INVALID_HANDLE_VALUE)
    {
        // Deactivate the context now that the comctl32.dll is loaded.
        DeactivateActCtx(0, actxCookie);
    }

    return 0;
}

void
QuitProgressUI()
{
    sQuit = TRUE;
}

void
UpdateProgressUI(float progress)
{
    sProgress = progress;  // 32-bit writes are atomic
}
#endif  // WNT