github.com/minio/mc@v0.0.0-20240503112107-b471de8d1882/cmd/quota-info.go (about)

     1  // Copyright (c) 2015-2022 MinIO, Inc.
     2  //
     3  // This file is part of MinIO Object Storage stack
     4  //
     5  // This program is free software: you can redistribute it and/or modify
     6  // it under the terms of the GNU Affero General Public License as published by
     7  // the Free Software Foundation, either version 3 of the License, or
     8  // (at your option) any later version.
     9  //
    10  // This program is distributed in the hope that it will be useful
    11  // but WITHOUT ANY WARRANTY; without even the implied warranty of
    12  // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    13  // GNU Affero General Public License for more details.
    14  //
    15  // You should have received a copy of the GNU Affero General Public License
    16  // along with this program.  If not, see <http://www.gnu.org/licenses/>.
    17  
    18  package cmd
    19  
    20  import (
    21  	"github.com/fatih/color"
    22  	"github.com/minio/cli"
    23  	"github.com/minio/mc/pkg/probe"
    24  	"github.com/minio/pkg/v2/console"
    25  )
    26  
    27  var quotaInfoCmd = cli.Command{
    28  	Name:         "info",
    29  	Usage:        "show bucket quota",
    30  	Action:       mainQuotaInfo,
    31  	OnUsageError: onUsageError,
    32  	Before:       setGlobalsFromContext,
    33  	Flags:        globalFlags,
    34  	CustomHelpTemplate: `NAME:
    35    {{.HelpName}} - {{.Usage}}
    36  
    37  USAGE:
    38    {{.HelpName}} TARGET
    39  
    40  FLAGS:
    41    {{range .VisibleFlags}}{{.}}
    42    {{end}}
    43  EXAMPLES:
    44    1. Display bucket quota configured for "mybucket" on MinIO.
    45       {{.Prompt}} {{.HelpName}} myminio/mybucket
    46  `,
    47  }
    48  
    49  // checkQuotaInfoSyntax - validate all the passed arguments
    50  func checkQuotaInfoSyntax(ctx *cli.Context) {
    51  	if len(ctx.Args()) == 0 || len(ctx.Args()) > 1 {
    52  		showCommandHelpAndExit(ctx, 1) // last argument is exit code
    53  	}
    54  }
    55  
    56  // mainQuotaInfo is the handler for "mc quota info" command.
    57  func mainQuotaInfo(ctx *cli.Context) error {
    58  	checkQuotaInfoSyntax(ctx)
    59  
    60  	console.SetColor("QuotaMessage", color.New(color.FgGreen))
    61  	console.SetColor("QuotaInfo", color.New(color.FgCyan))
    62  
    63  	// Get the alias parameter from cli
    64  	args := ctx.Args()
    65  	aliasedURL := args.Get(0)
    66  
    67  	// Create a new MinIO Admin Client
    68  	client, err := newAdminClient(aliasedURL)
    69  	fatalIf(err, "Unable to initialize admin connection.")
    70  
    71  	_, targetURL := url2Alias(args[0])
    72  	qCfg, e := client.GetBucketQuota(globalContext, targetURL)
    73  	fatalIf(probe.NewError(e).Trace(args...), "Unable to get bucket quota")
    74  	printMsg(quotaMessage{
    75  		op:        ctx.Command.Name,
    76  		Bucket:    targetURL,
    77  		Quota:     qCfg.Quota,
    78  		QuotaType: string(qCfg.Type),
    79  		Status:    "success",
    80  	})
    81  
    82  	return nil
    83  }