hadoop-common-project/hadoop-common/src/main/winutils/groups.c

/**
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements. See the NOTICE file distributed with this
 * work for additional information regarding copyright ownership. The ASF
 * licenses this file to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * 
 * http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
 * License for the specific language governing permissions and limitations under
 * the License.
 */
#include "winutils.h"

//----------------------------------------------------------------------------
// Function: PrintGroups
//
// Description:
//	Print group names to the console standard output for the given user
//
// Returns:
//	TRUE: on success
//
// Notes:
//   This function could fail on first pass when we fail to find groups for
//   domain account; so we do not report Windows API errors in this function.
//   If formatOutput is true, pipe character is used as separator for groups
//   otherwise, space.
//
static BOOL PrintGroups(
  LOCALGROUP_USERS_INFO_0 const *groups,
  DWORD entries,
  BOOL formatOutput)
{
  BOOL ret = TRUE;
  LOCALGROUP_USERS_INFO_0 const *pTmpBuf = groups;
  DWORD i;

  for (i = 0; i < entries; i++)
  {
    if (pTmpBuf == NULL)
    {
      ret = FALSE;
      break;
    }

    if (i != 0)
    {
      if (formatOutput)
      {
        wprintf(L"|");
      }
      else
      {
        wprintf(L" ");
      }
    }
    wprintf(L"%s", pTmpBuf->lgrui0_name);

    pTmpBuf++;
  }

  if (ret)
    wprintf(L"\n");

  return ret;
}

//----------------------------------------------------------------------------
// Function: ParseCommandLine
//
// Description:
//   Parses the command line
//
// Returns:
//   TRUE on the valid command line, FALSE otherwise
//
static BOOL ParseCommandLine(
  __in int argc,
  __in_ecount(argc) wchar_t *argv[],
  __out PWSTR *user,
  __out BOOL *formatOutput)
{
  *formatOutput = FALSE;

  assert(argv != NULL);
  assert(user != NULL);

  if (argc == 1)
  {
    // implicitly use the current user
    *user = NULL;
    return TRUE;
  }
  else if (argc == 2)
  {
    // check if the second argument is formating
    if (wcscmp(argv[1], L"-F") == 0)
    {
      *user = NULL;
      *formatOutput = TRUE;
      return TRUE;
    }
    else
    {
      *user = argv[1];
      return TRUE;
    }
  }
  else if (argc == 3 && wcscmp(argv[1], L"-F") == 0)
  {
    // if 3 args, the second argument must be "-F"

    *user = argv[2];
    *formatOutput = TRUE;
    return TRUE;
  }

  return FALSE;
}

//----------------------------------------------------------------------------
// Function: Groups
//
// Description:
//	The main method for groups command
//
// Returns:
//	0: on success
//
// Notes:
//
//
int Groups(__in int argc, __in_ecount(argc) wchar_t *argv[])
{
  LPWSTR input = NULL;

  LPWSTR currentUser = NULL;
  DWORD cchCurrentUser = 0;

  LPLOCALGROUP_USERS_INFO_0 groups = NULL;
  DWORD entries = 0;

  DWORD dwRtnCode = ERROR_SUCCESS;

  int ret = EXIT_SUCCESS;
  BOOL formatOutput = FALSE;

  if (!ParseCommandLine(argc, argv, &input, &formatOutput))
  {
    fwprintf(stderr, L"Incorrect command line arguments.\n\n");
    GroupsUsage(argv[0]);
    return EXIT_FAILURE;
  }

  // if username was not specified on the command line, fallback to the
  // current user
  if (input == NULL)
  {
    GetUserNameW(currentUser, &cchCurrentUser);
    if (GetLastError() == ERROR_INSUFFICIENT_BUFFER)
    {
      currentUser = (LPWSTR) LocalAlloc(LPTR,
        (cchCurrentUser + 1) * sizeof(wchar_t));
      if (!currentUser)
      {
        ReportErrorCode(L"LocalAlloc", GetLastError());
        ret = EXIT_FAILURE;
        goto GroupsEnd;
      }
      if (GetUserNameW(currentUser, &cchCurrentUser))
        input = currentUser;
      else
      {
        ReportErrorCode(L"GetUserName", GetLastError());
        ret = EXIT_FAILURE;
        goto GroupsEnd;
      }
    }
    else
    {
      ReportErrorCode(L"GetUserName", GetLastError());
      ret = EXIT_FAILURE;
      goto GroupsEnd;
    }
  }

  if ((dwRtnCode = GetLocalGroupsForUser(input, &groups, &entries))
    != ERROR_SUCCESS)
  {
    ReportErrorCode(L"GetLocalGroupsForUser", dwRtnCode);
    ret = EXIT_FAILURE;
    goto GroupsEnd;
  }

  if (!PrintGroups(groups, entries, formatOutput))
  {
    ret = EXIT_FAILURE;
  }

GroupsEnd:
  LocalFree(currentUser);
  if (groups != NULL) NetApiBufferFree(groups);
  return ret;
}

void GroupsUsage(LPCWSTR program)
{
  fwprintf(stdout, L"\
Usage: %s [OPTIONS] [USERNAME]\n\
Print group information of the specified USERNAME \
(the current user by default).\n\
\n\
OPTIONS: -F format the output by separating tokens with a pipe\n",
program);
}