| Server IP : 88.222.222.100 / Your IP : 216.73.216.217 Web Server : LiteSpeed System : Linux id-dci-web1986.main-hosting.eu 5.14.0-611.26.1.el9_7.x86_64 #1 SMP PREEMPT_DYNAMIC Thu Jan 29 05:24:47 EST 2026 x86_64 User : u686484674 ( 686484674) PHP Version : 8.0.30 Disable Function : system, exec, shell_exec, passthru, mysql_list_dbs, ini_alter, dl, symlink, link, chgrp, leak, popen, apache_child_terminate, virtual, mb_send_mail MySQL : OFF | cURL : ON | WGET : ON | Perl : OFF | Python : OFF | Sudo : OFF | Pkexec : OFF Directory : /opt/gsutil/gslib/commands/ |
Upload File : |
# -*- coding: utf-8 -*-
# Copyright 2017 Google Inc. All Rights Reserved.
#
# Licensed 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.
"""Implementation of requesterpays configuration command for buckets."""
from __future__ import absolute_import
from __future__ import print_function
from __future__ import division
from __future__ import unicode_literals
from gslib import metrics
from gslib.command import Command
from gslib.command_argument import CommandArgument
from gslib.cs_api_map import ApiSelector
from gslib.exception import CommandException
from gslib.exception import NO_URLS_MATCHED_TARGET
from gslib.help_provider import CreateHelpText
from gslib.third_party.storage_apitools import storage_v1_messages as apitools_messages
from gslib.utils.constants import NO_MAX
from gslib.utils.shim_util import GcloudStorageMap
from gslib.utils import shim_util
_SET_SYNOPSIS = """
gsutil requesterpays set (on|off) gs://<bucket_name>...
"""
_GET_SYNOPSIS = """
gsutil requesterpays get gs://<bucket_name>...
"""
_SYNOPSIS = _SET_SYNOPSIS + _GET_SYNOPSIS.lstrip('\n')
_SET_DESCRIPTION = """
<B>SET</B>
The "set" sub-command requires an additional sub-command, either "on" or
"off", which, respectively, will enable or disable Requester Pays for the
specified bucket.
"""
_GET_DESCRIPTION = """
<B>GET</B>
The "get" sub-command gets the Requester Pays configuration for a
bucket and displays whether or not it is enabled.
"""
_DESCRIPTION = """
The `Requester Pays
<https://cloud.google.com/storage/docs/requester-pays>`_ feature enables you
to configure a Google Cloud Storage bucket so that the requester
pays all costs related to accessing the bucket and its objects.
The gsutil requesterpays command has two sub-commands:
""" + _SET_DESCRIPTION + _GET_DESCRIPTION
_DETAILED_HELP_TEXT = CreateHelpText(_SYNOPSIS, _DESCRIPTION)
_get_help_text = CreateHelpText(_GET_SYNOPSIS, _GET_DESCRIPTION)
_set_help_text = CreateHelpText(_SET_SYNOPSIS, _SET_DESCRIPTION)
_GCLOUD_FORMAT_STRING = ('--format=value[separator=": "](' + 'name.sub("' +
shim_util.get_format_flag_caret() + '", "gs://"),' +
'requester_pays.yesno("Enabled", "Disabled"))')
class RequesterPaysCommand(Command):
"""Implementation of gsutil requesterpays command."""
# Command specification. See base class for documentation.
command_spec = Command.CreateCommandSpec(
'requesterpays',
usage_synopsis=_SYNOPSIS,
min_args=2,
max_args=NO_MAX,
supported_sub_args='',
file_url_ok=False,
provider_url_ok=False,
urls_start_arg=2,
gs_api_support=[
# ApiSelector.XML, # TODO: Uncomment once boto changes are added.
ApiSelector.JSON,
],
gs_default_api=ApiSelector.JSON,
argparse_arguments={
'set': [
CommandArgument('mode', choices=['on', 'off']),
CommandArgument.MakeZeroOrMoreCloudBucketURLsArgument(),
],
'get': [CommandArgument.MakeZeroOrMoreCloudBucketURLsArgument(),]
},
)
# Help specification. See help_provider.py for documentation.
help_spec = Command.HelpSpec(
help_name='requesterpays',
help_name_aliases=[],
help_type='command_help',
help_one_line_summary=(
'Enable or disable requester pays for one or more buckets'),
help_text=_DETAILED_HELP_TEXT,
subcommand_help_text={
'get': _get_help_text,
'set': _set_help_text,
},
)
gcloud_storage_map = GcloudStorageMap(
gcloud_command={
'get':
GcloudStorageMap(
gcloud_command=[
'storage', 'buckets', 'list', _GCLOUD_FORMAT_STRING
],
flag_map={},
supports_output_translation=True,
),
'set':
GcloudStorageMap(
gcloud_command={
'on':
GcloudStorageMap(
gcloud_command=[
'storage', 'buckets', 'update',
'--requester-pays'
],
flag_map={},
),
'off':
GcloudStorageMap(
gcloud_command=[
'storage',
'buckets',
'update',
'--no-requester-pays',
],
flag_map={},
),
},
flag_map={},
)
},
flag_map={},
)
def _CalculateUrlsStartArg(self):
if not self.args:
self.RaiseWrongNumberOfArgumentsException()
if self.args[0].lower() == 'set':
return 2
else:
return 1
def _SetRequesterPays(self):
"""Gets requesterpays configuration for a bucket."""
requesterpays_arg = self.args[0].lower()
if requesterpays_arg not in ('on', 'off'):
raise CommandException('Argument to "%s set" must be either <on|off>' %
(self.command_name))
url_args = self.args[1:]
if not url_args:
self.RaiseWrongNumberOfArgumentsException()
# Iterate over URLs, expanding wildcards and set the requesterpays
# configuration on each.
some_matched = False
for url_str in url_args:
bucket_iter = self.GetBucketUrlIterFromArg(url_str, bucket_fields=['id'])
for blr in bucket_iter:
url = blr.storage_url
some_matched = True
bucket_metadata = apitools_messages.Bucket(
billing=apitools_messages.Bucket.BillingValue())
if requesterpays_arg == 'on':
self.logger.info('Enabling requester pays for %s...', url)
bucket_metadata.billing.requesterPays = True
else:
self.logger.info('Disabling requester pays for %s...', url)
bucket_metadata.billing.requesterPays = False
self.gsutil_api.PatchBucket(url.bucket_name,
bucket_metadata,
provider=url.scheme,
fields=['id'])
if not some_matched:
raise CommandException(NO_URLS_MATCHED_TARGET % list(url_args))
def _GetRequesterPays(self):
"""Gets requesterpays configuration for one or more buckets."""
url_args = self.args
# Iterate over URLs, expanding wildcards and getting the requesterpays
# configuration on each.
some_matched = False
for url_str in url_args:
bucket_iter = self.GetBucketUrlIterFromArg(url_str,
bucket_fields=['billing'])
for blr in bucket_iter:
some_matched = True
if blr.root_object.billing and blr.root_object.billing.requesterPays:
print('%s: Enabled' % blr.url_string.rstrip('/'))
else:
print('%s: Disabled' % blr.url_string.rstrip('/'))
if not some_matched:
raise CommandException(NO_URLS_MATCHED_TARGET % list(url_args))
def RunCommand(self):
"""Command entry point for the requesterpays command."""
action_subcommand = self.args.pop(0)
if action_subcommand == 'get':
func = self._GetRequesterPays
metrics.LogCommandParams(subcommands=[action_subcommand])
elif action_subcommand == 'set':
func = self._SetRequesterPays
requesterpays_arg = self.args[0].lower()
if requesterpays_arg in ('on', 'off'):
metrics.LogCommandParams(
subcommands=[action_subcommand, requesterpays_arg])
else:
raise CommandException(
('Invalid subcommand "%s" for the %s command.\n'
'See "gsutil help %s".') %
(action_subcommand, self.command_name, self.command_name))
func()
return 0