windows-server-2003/net/tapi/client/cplgeneraltab.cpp

/****************************************************************************
 
  Copyright (c) 1998-1999 Microsoft Corporation
                                                              
  Module Name:  cplgeneraltab.cpp
                                                              
       Author:  toddb - 10/06/98

****************************************************************************/


//
// Functions used only by the General tab of the New Location Property Sheet.
// Shared functions are in the Location.cpp file.
//
#include "cplPreComp.h"
#include "cplLocationPS.h"


void UpdateSampleString(HWND hwnd, CLocation * pLoc, PCWSTR pwszAddress, CCallingCard * pCard)
{
    CCallingCard cc;
    LPWSTR pwszDialable;
    LPWSTR pwszDisplayable;
    TCHAR szBuf[512];
    DWORD dwOptions = pLoc->HasCallWaiting() ? LINETRANSLATEOPTION_CANCELCALLWAITING : 0;

    if ( (NULL == pCard) && pLoc->HasCallingCard() )
    {
        if ( SUCCEEDED(cc.Initialize(pLoc->GetPreferredCardID())) )
        {
            pCard = &cc;
        }
    }

    if ( 0 == pLoc->TranslateAddress(pwszAddress, pCard, dwOptions, &dwOptions, NULL, &pwszDialable, &pwszDisplayable) )
    {
        SHUnicodeToTChar(pwszDisplayable, szBuf, ARRAYSIZE(szBuf));
        ClientFree(pwszDialable);
        ClientFree(pwszDisplayable);
    }
    else
    {
        LOG((TL_ERROR, "UpdateSampleString failed to call pLoc->TranslateAddress\n"));
        // REVIEW: Should we load some sort of error string instead?  Perhaps we should featch the
        // error text for the given error code from the message resources in tapiui?
        szBuf[0] = TEXT('\0');
    }
    SetWindowText(hwnd, szBuf);
}

INT_PTR CALLBACK CLocationPropSheet::General_DialogProc( HWND hwndDlg, UINT uMsg, WPARAM wParam, LPARAM lParam )
{
    CLocationPropSheet* pthis = (CLocationPropSheet*) GetWindowLongPtr(hwndDlg, GWLP_USERDATA);

    switch(uMsg)
    {
    case WM_INITDIALOG:
        pthis = (CLocationPropSheet*)(((PROPSHEETPAGE*)lParam)->lParam);
        SetWindowLongPtr(hwndDlg, GWLP_USERDATA, (LONG_PTR) pthis); 
        return pthis->General_OnInitDialog(hwndDlg);

    case WM_COMMAND:
        return pthis->General_OnCommand(hwndDlg, LOWORD(wParam), HIWORD(wParam), (HWND)lParam );

    case WM_NOTIFY:
        return pthis->General_OnNotify(hwndDlg, (LPNMHDR)lParam);
   
    case WM_HELP:
        // Process clicks on controls after Context Help mode selected
        TapiCplWinHelp ((HWND)((LPHELPINFO)lParam)->hItemHandle, gszHelpFile, HELP_WM_HELP, (DWORD_PTR)(LPTSTR) a102HelpIDs);
        break;
        
    case WM_CONTEXTMENU:
        // Process right-clicks on controls
        TapiCplWinHelp ((HWND) wParam, gszHelpFile, HELP_CONTEXTMENU, (DWORD_PTR)(LPVOID) a102HelpIDs);
        break;
    }

    return 0;
}

BOOL CLocationPropSheet::General_OnInitDialog(HWND hwndDlg)
{
    TCHAR szBuf[1024];
    HWND hwnd;
    hwnd = GetDlgItem( hwndDlg, IDC_LOCATIONNAME );
    SHUnicodeToTChar(m_pLoc->GetName(), szBuf, ARRAYSIZE(szBuf));
    SetWindowText(hwnd, szBuf);
    SendMessage(hwnd,EM_SETLIMITTEXT,CPL_SETTEXTLIMIT,0);

    hwnd = GetDlgItem( hwndDlg, IDC_COUNTRY );
    m_dwCountryID = m_pLoc->GetCountryID();
    PopulateCountryList( hwnd, m_dwCountryID );

    CCountry * pCountry;
    HRESULT hr;

    hr = CreateCountryObject(m_dwCountryID, &pCountry);
    if ( SUCCEEDED(hr) )
    {
        m_iCityRule = IsCityRule(pCountry->GetLongDistanceRule());
        m_iLongDistanceCarrierCodeRule = IsLongDistanceCarrierCodeRule( pCountry->GetLongDistanceRule() );
        m_iInternationalCarrierCodeRule = IsInternationalCarrierCodeRule( pCountry->GetInternationalRule() );
        delete pCountry;
    } else {
        LOG((TL_ERROR, "General_OnInitDialog failed to create country %d", m_dwCountryID));
        m_iCityRule = CITY_OPTIONAL;
        m_iLongDistanceCarrierCodeRule = LONG_DISTANCE_CARRIER_OPTIONAL;
        m_iInternationalCarrierCodeRule = INTERNATIONAL_CARRIER_OPTIONAL;
    }



    hwnd = GetDlgItem(hwndDlg,IDC_AREACODE);
    SHUnicodeToTChar(m_pLoc->GetAreaCode(), szBuf, ARRAYSIZE(szBuf));
    SetWindowText(hwnd, szBuf);
    SendMessage(hwnd,EM_SETLIMITTEXT,CPL_SETTEXTLIMIT,0);
    LimitInput(hwnd, LIF_ALLOWNUMBER);
    if ( m_iCityRule == CITY_NONE )
    {
        // The selected country does not have area codes
        EnableWindow(hwnd, FALSE);
    }

    hwnd = GetDlgItem(hwndDlg,IDC_LOCALACCESSNUM);
    SHUnicodeToTChar(m_pLoc->GetLocalAccessCode(), szBuf, ARRAYSIZE(szBuf));
    SetWindowText(hwnd, szBuf);
    SendMessage(hwnd,EM_SETLIMITTEXT,CPL_SETTEXTLIMIT,0);
    LimitInput(hwnd, LIF_ALLOWNUMBER|LIF_ALLOWPOUND|LIF_ALLOWSTAR|LIF_ALLOWCOMMA);

    hwnd = GetDlgItem(hwndDlg,IDC_LONGDISTANCEACCESSNUM);
    SHUnicodeToTChar(m_pLoc->GetLongDistanceAccessCode(), szBuf, ARRAYSIZE(szBuf));
    SetWindowText(hwnd, szBuf);
    SendMessage(hwnd,EM_SETLIMITTEXT,CPL_SETTEXTLIMIT,0);
    LimitInput(hwnd, LIF_ALLOWNUMBER|LIF_ALLOWPOUND|LIF_ALLOWSTAR|LIF_ALLOWCOMMA);

    hwnd = GetDlgItem(hwndDlg,IDC_LONGDISTANCECARRIERCODE);
    SHUnicodeToTChar(m_pLoc->GetLongDistanceCarrierCode(), szBuf, ARRAYSIZE(szBuf));
    SetWindowText(hwnd, szBuf);
    SendMessage(hwnd,EM_SETLIMITTEXT,CPL_SETTEXTLIMIT,0);
    LimitInput(hwnd, LIF_ALLOWNUMBER);
    if ( LONG_DISTANCE_CARRIER_NONE == m_iLongDistanceCarrierCodeRule )
    {
        // The selected country does not have long distance carrier codes
        EnableWindow(hwnd, FALSE);
        EnableWindow(GetDlgItem(hwndDlg, IDC_STATICLDC), FALSE);
    }

    hwnd = GetDlgItem(hwndDlg,IDC_INTERNATIONALCARRIERCODE);
    SHUnicodeToTChar(m_pLoc->GetInternationalCarrierCode(), szBuf, ARRAYSIZE(szBuf));
    SetWindowText(hwnd, szBuf);
    SendMessage(hwnd,EM_SETLIMITTEXT,CPL_SETTEXTLIMIT,0);
    LimitInput(hwnd, LIF_ALLOWNUMBER);
    if ( INTERNATIONAL_CARRIER_NONE == m_iInternationalCarrierCodeRule )
    {
        // The selected country does not have international carrier codes
        EnableWindow(hwnd, FALSE);
        EnableWindow(GetDlgItem(hwndDlg, IDC_STATICIC), FALSE);
    }

    hwnd = GetDlgItem(hwndDlg,IDC_DISABLESTRING);
    LPWSTR lpwsz = m_pLoc->GetDisableCallWaitingCode();
    SHUnicodeToTChar(lpwsz, szBuf, ARRAYSIZE(szBuf));
    SendMessage(hwnd, CB_LIMITTEXT, CPL_SETTEXTLIMIT, 0);
    PopulateDisableCallWaitingCodes(hwnd, szBuf);
    LimitCBInput(hwnd, LIF_ALLOWNUMBER|LIF_ALLOWPOUND|LIF_ALLOWSTAR|LIF_ALLOWCOMMA);
    if ( NULL == *lpwsz || !m_pLoc->HasCallWaiting() )
    {
        EnableWindow(hwnd, FALSE);
    }
    else
    {
        hwnd = GetDlgItem(hwndDlg,IDC_DISABLECALLWAITING);
        SendMessage(hwnd,BM_SETCHECK, BST_CHECKED, 0);
    }

    CheckRadioButton(hwndDlg,IDC_TONE,IDC_PULSE,m_pLoc->HasToneDialing()?IDC_TONE:IDC_PULSE);

    if (!m_pwszAddress)
    {
        ShowWindow(GetDlgItem(hwndDlg,IDC_PHONENUMBERTEXT), SW_HIDE);
    }

    return 0;
}

BOOL PopulateCountryList(HWND hwndCombo, DWORD dwSelectedCountry)
{
    BOOL bResult = FALSE;
    CCountries CountryList;

    SendMessage(hwndCombo,CB_RESETCONTENT,0,0);

    if ( SUCCEEDED(CountryList.Initialize()) )
    {
        TCHAR szText[1024];
        CCountry * pC;
        DWORD dwCurCountryID;
        LRESULT iIndex;

        CountryList.Reset();
        while ( S_OK == CountryList.Next(1,&pC,NULL) )
        {
            SHUnicodeToTChar(pC->GetCountryName(), szText, ARRAYSIZE(szText));
            iIndex = SendMessage(hwndCombo,CB_ADDSTRING,0,(LPARAM)szText);
            dwCurCountryID = pC->GetCountryID();
            SendMessage(hwndCombo,CB_SETITEMDATA,iIndex,(LPARAM)dwCurCountryID);

            if ( dwCurCountryID == dwSelectedCountry )
            {
                SendMessage(hwndCombo,CB_SETCURSEL,iIndex,0);
                bResult = TRUE;
            }
        }
    }

    // REVIEW: If no country was selected (bResult == FALSE) should we simply select some
    // arbitrary country?  First in the list?  The USA?

    return bResult;
}

BOOL CLocationPropSheet::PopulateDisableCallWaitingCodes(HWND hwndCombo, LPTSTR szSelected)
{
    TCHAR cszTelephonyKey[] = TEXT("SOFTWARE\\Microsoft\\Windows\\CurrentVersion\\Telephony\\Locations");
    HKEY hkey;
    int i;

    // These get read from the registry
    // NOTE: This might fail on a tightly locked down system, but there's nothing I can do
    // about that.  Worst case the list of codes is empty and the user just types the code.
    if ( ERROR_SUCCESS == RegOpenKeyEx(HKEY_LOCAL_MACHINE, cszTelephonyKey,
            0, KEY_QUERY_VALUE, &hkey) )
    {
        TCHAR szDisableCallWaiting[32];
        TCHAR szCode[32];
        DWORD dwType;
        DWORD dwSize;

        for ( i=0; ; i++ )
        {
            // This string is a reg value and is not localized
            wsprintf(szDisableCallWaiting, TEXT("DisableCallWaiting%d"), i);

            dwSize = sizeof(szCode);
            if ( ERROR_SUCCESS != RegQueryValueEx(hkey, szDisableCallWaiting, NULL, &dwType, (LPBYTE)szCode, &dwSize) )
            {
                // when we fail to read an item its most likely because their are no more items,
                // but even if it's some other error we don't know how to handle it anyhow.
                break;
            }

            if ( dwType != REG_SZ )
            {
                // I'll just skip any values that I don't know how to deal with
                continue;
            }

            SendMessage(hwndCombo,CB_ADDSTRING,0,(LPARAM)szCode);
        }
    }

    // and then we add a special one if the current code is not a standard code
    if ( szSelected && *szSelected )
    {
        LRESULT lResult;

        lResult = SendMessage(hwndCombo, CB_FINDSTRINGEXACT, -1, (LPARAM)szSelected);
        if ( lResult == (LRESULT)CB_ERR )
        {
            // if the item wasn't found, we add it
            lResult = SendMessage(hwndCombo, CB_ADDSTRING, 0, (LPARAM)szSelected);
        }

        SendMessage(hwndCombo, CB_SETCURSEL, lResult, 0);
    }

    return TRUE;
}

BOOL CLocationPropSheet::General_OnCommand(HWND hwndParent, int wID, int wNotifyCode, HWND hwndCtl)
{
    WCHAR wszBuf[512];

    switch (wID)
    {
    case IDC_DISABLECALLWAITING:
        if ( BN_CLICKED == wNotifyCode )
        {
            BOOL bOn = SendMessage(hwndCtl, BM_GETCHECK, 0,0) == BST_CHECKED;
            HWND hwnd = GetDlgItem(hwndParent, IDC_DISABLESTRING);
            EnableWindow(hwnd, bOn);
            m_pLoc->UseCallWaiting(bOn);
            if ( bOn )
            {
                SetFocus(hwnd);
            }
            break;
        }
        return 1;

    case IDC_TONE:
    case IDC_PULSE:
        m_pLoc->UseToneDialing(IDC_TONE==wID);
        break;

    case IDC_COUNTRY:
        if ( CBN_SELCHANGE == wNotifyCode )
        {
            LRESULT lrSel = SendMessage(hwndCtl,CB_GETCURSEL,0,0);
            m_dwCountryID = (DWORD)SendMessage(hwndCtl,CB_GETITEMDATA,lrSel,0);
            m_pLoc->SetCountryID(m_dwCountryID);

            CCountry * pCountry;
            HRESULT hr;

            hr = CreateCountryObject(m_dwCountryID, &pCountry);
            if ( SUCCEEDED(hr) )
            {
                m_iCityRule = IsCityRule(pCountry->GetLongDistanceRule());
                m_iLongDistanceCarrierCodeRule = IsLongDistanceCarrierCodeRule( pCountry->GetLongDistanceRule() );
                m_iInternationalCarrierCodeRule = IsInternationalCarrierCodeRule( pCountry->GetInternationalRule() );
                delete pCountry;
            } else {
                LOG((TL_ERROR, "General_OnInitDialog failed to create country %d", m_dwCountryID));
                m_iCityRule = CITY_OPTIONAL;
                m_iLongDistanceCarrierCodeRule = LONG_DISTANCE_CARRIER_OPTIONAL;
                m_iInternationalCarrierCodeRule = INTERNATIONAL_CARRIER_OPTIONAL;
            }


            HWND hwnd = GetDlgItem(hwndParent,IDC_AREACODE);
            if ( m_iCityRule == CITY_NONE )
            {
                SetWindowText(hwnd, TEXT(""));
                m_pLoc->SetAreaCode(L"");
                EnableWindow(hwnd, FALSE);
            }
            else
            {
                EnableWindow(hwnd, TRUE);
            }

            hwnd = GetDlgItem(hwndParent,IDC_LONGDISTANCECARRIERCODE);
            if ( LONG_DISTANCE_CARRIER_NONE == m_iLongDistanceCarrierCodeRule ) 
            {
                SetWindowText(hwnd, TEXT(""));
                m_pLoc->SetLongDistanceAccessCode(L"");
                EnableWindow(hwnd, FALSE);
                EnableWindow(GetDlgItem(hwndParent,IDC_STATICLDC), FALSE);
            }
            else
            {
                EnableWindow(hwnd, TRUE);
                EnableWindow(GetDlgItem(hwndParent,IDC_STATICLDC), TRUE);
            }

            hwnd = GetDlgItem(hwndParent,IDC_INTERNATIONALCARRIERCODE);
            if ( INTERNATIONAL_CARRIER_NONE == m_iInternationalCarrierCodeRule ) 
            {
                SetWindowText(hwnd, TEXT(""));
                m_pLoc->SetInternationalCarrierCode(L"");
                EnableWindow(hwnd, FALSE);
                EnableWindow(GetDlgItem(hwndParent,IDC_STATICIC), FALSE);
            }
            else
            {
                EnableWindow(hwnd, TRUE);
                EnableWindow(GetDlgItem(hwndParent,IDC_STATICIC), TRUE);
            }
            
            break;
        }
        return 1;

    case IDC_LOCATIONNAME:
    case IDC_AREACODE:
    case IDC_LONGDISTANCECARRIERCODE:
    case IDC_INTERNATIONALCARRIERCODE:
    case IDC_LOCALACCESSNUM:
    case IDC_LONGDISTANCEACCESSNUM:
        if ( EN_CHANGE == wNotifyCode )
        {
            TCHAR szValue[512];
            GetWindowText(hwndCtl, szValue, ARRAYSIZE(szValue));
            SHTCharToUnicode(szValue, wszBuf, ARRAYSIZE(wszBuf));
            switch (wID)
            {
                case IDC_LOCATIONNAME:
                    m_pLoc->SetName(wszBuf);
                    break;

                case IDC_AREACODE:
                    m_pLoc->SetAreaCode(wszBuf);
                    break;

                case IDC_LONGDISTANCECARRIERCODE:
                    m_pLoc->SetLongDistanceCarrierCode(wszBuf);
                    break;

                case IDC_INTERNATIONALCARRIERCODE:
                    m_pLoc->SetInternationalCarrierCode(wszBuf);
                    break;

                case IDC_LOCALACCESSNUM:
                    m_pLoc->SetLocalAccessCode(wszBuf);
                    break;

                case IDC_LONGDISTANCEACCESSNUM:
                    m_pLoc->SetLongDistanceAccessCode(wszBuf);
                    break;
            }
            break;
        }
        return 1;

    case IDC_DISABLESTRING:
        switch ( wNotifyCode )
        {
        case CBN_SELCHANGE:
            {
                TCHAR szDisableCode[128];
                LRESULT lr = SendMessage(hwndCtl, CB_GETCURSEL, 0,0);

                SendMessage(hwndCtl, CB_GETLBTEXT, lr, (LPARAM)szDisableCode);
                SHTCharToUnicode(szDisableCode, wszBuf, ARRAYSIZE(wszBuf));
                m_pLoc->SetDisableCallWaitingCode(wszBuf);
            }
            break;

        case CBN_EDITCHANGE:
            {
                TCHAR szDisableCode[128];

                GetWindowText(hwndCtl, szDisableCode, ARRAYSIZE(szDisableCode));
                SHTCharToUnicode(szDisableCode, wszBuf, ARRAYSIZE(wszBuf));
                m_pLoc->SetDisableCallWaitingCode(wszBuf);
            }
            break;
        default:
            return 1;
        }
        break;

    default:
        return 0;
    }

    if (m_pwszAddress)
    {
        CCallingCard * pCard = NULL;
        if (m_pLoc->HasCallingCard())
        {
            pCard = m_Cards.GetCallingCard(m_pLoc->GetPreferredCardID());
        }
        UpdateSampleString(GetDlgItem(hwndParent, IDC_PHONENUMBERSAMPLE), m_pLoc, m_pwszAddress, pCard);
    }

    m_pLoc->Changed();
    SendMessage(GetParent(hwndParent),PSM_CHANGED,(WPARAM)hwndParent,0);

    return 1;
}

BOOL CLocationPropSheet::General_OnNotify(HWND hwndDlg, LPNMHDR pnmhdr)
{
    // Let the generic handler have a crack at it first
    OnNotify(hwndDlg, pnmhdr);

    switch (pnmhdr->code)
    {
    case PSN_APPLY:     // user pressed OK or Apply
        return General_OnApply(hwndDlg);
     
    case PSN_SETACTIVE:
        if (m_pwszAddress)
        {
            CCallingCard * pCard = NULL;
            if (m_pLoc->HasCallingCard())
            {
                pCard = m_Cards.GetCallingCard(m_pLoc->GetPreferredCardID());
            }
            UpdateSampleString(GetDlgItem(hwndDlg, IDC_PHONENUMBERSAMPLE), m_pLoc, m_pwszAddress, pCard);
        }
        break;
    default:
        break;
    }
    return FALSE;
}

// General_OnApply
//
// Called when the user selects OK or APPLY on the prop sheet.
// Return PSNRET_INVALID_NOCHANGEPAGE if anything is wrong.
// Return PSNRET_NOERROR if everything is OK.
BOOL CLocationPropSheet::General_OnApply(HWND hwndDlg)
{
    PWSTR   pwszName;
    int     iCtl;
    int     iErr;

    // First we do the sanity checks.  We return without changing the object if any of these fail.
    //  * The location must have a name
    //  * The location must have an area code if it's not a CityRule
    //  * If "Disable call waiting" is checked, a disable code must have been entered
    //  * A Country must be selected (it should be impossible for this not to be true, but we check to be safe).
    //  * The name, as entered, must be unique
    pwszName = m_pLoc->GetName();
    if ( !*pwszName )
    {
        iCtl = IDC_LOCATIONNAME;
        iErr = IDS_NEEDALOCATIONNAME;
        goto ExitWithError;
    }

    if ( (CITY_MANDATORY==m_iCityRule) && !*(m_pLoc->GetAreaCode()) )
    {
        iCtl = IDC_AREACODE;
        iErr = IDS_NEEDANAREACODE;
        goto ExitWithError;
    }

    if ( (LONG_DISTANCE_CARRIER_MANDATORY == m_iLongDistanceCarrierCodeRule) && 
         !*(m_pLoc->GetLongDistanceCarrierCode()) )
    {
        iCtl = IDC_LONGDISTANCECARRIERCODE;
        iErr = IDS_NEEDALONGDISTANCECARRIERCODE;
        goto ExitWithError;
    }

    if ( (INTERNATIONAL_CARRIER_MANDATORY == m_iInternationalCarrierCodeRule) && 
         !*(m_pLoc->GetInternationalCarrierCode()) )
    {
        iCtl = IDC_INTERNATIONALCARRIERCODE;
        iErr = IDS_NEEDANINTERNATIONALCARRIERCODE;
        goto ExitWithError;
    }

    if ( m_pLoc->HasCallWaiting() && !*(m_pLoc->GetDisableCallWaitingCode()) )
    {
        iCtl = IDC_DISABLESTRING;
        iErr = IDS_NEEDADISABLESTRING;
        goto ExitWithError;
    }

    if ( !m_dwCountryID )
    {
        iCtl = IDC_COUNTRY;
        iErr = IDS_NEEDACOUNTRY;
        goto ExitWithError;
    }

    // We need to ensure that the name is unique.
    CLocation * pLoc;
    m_pLocList->Reset();
    while (S_OK == m_pLocList->Next(1, &pLoc, NULL))
    {
        // exclude ourselves from this comparision.
        if ( pLoc->GetLocationID() != m_pLoc->GetLocationID() )
        {
            // see if the names are identical
            if ( 0 == StrCmpIW(pLoc->GetName(), pwszName))
            {
                // yes, the name is in conflict
                iCtl = IDC_LOCATIONNAME;
                iErr = IDS_NEEDUNIQUENAME;
                goto ExitWithError;
            }
        }
    }

    // everything is OK
    m_bWasApplied = TRUE;

    return PSNRET_NOERROR;

ExitWithError:
    PropSheet_SetCurSelByID(GetParent(hwndDlg),IDD_LOC_GENERAL);
    ShowErrorMessage(GetDlgItem(hwndDlg,iCtl), iErr);
    SetWindowLongPtr(hwndDlg,DWLP_MSGRESULT,PSNRET_INVALID_NOCHANGEPAGE);
    return TRUE;
}