| OLD | NEW |
| 1 # -*- coding: utf-8 -*- |
| 1 # Copyright 2012 Google Inc. All Rights Reserved. | 2 # Copyright 2012 Google Inc. All Rights Reserved. |
| 2 # | 3 # |
| 3 # Licensed under the Apache License, Version 2.0 (the "License"); | 4 # Licensed under the Apache License, Version 2.0 (the "License"); |
| 4 # you may not use this file except in compliance with the License. | 5 # you may not use this file except in compliance with the License. |
| 5 # You may obtain a copy of the License at | 6 # You may obtain a copy of the License at |
| 6 # | 7 # |
| 7 # http://www.apache.org/licenses/LICENSE-2.0 | 8 # http://www.apache.org/licenses/LICENSE-2.0 |
| 8 # | 9 # |
| 9 # Unless required by applicable law or agreed to in writing, software | 10 # Unless required by applicable law or agreed to in writing, software |
| 10 # distributed under the License is distributed on an "AS IS" BASIS, | 11 # distributed under the License is distributed on an "AS IS" BASIS, |
| 11 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | 12 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 12 # See the License for the specific language governing permissions and | 13 # See the License for the specific language governing permissions and |
| 13 # limitations under the License. | 14 # limitations under the License. |
| 15 """Additional help text for anonymous access.""" |
| 14 | 16 |
| 15 from gslib.help_provider import HELP_NAME | 17 from __future__ import absolute_import |
| 16 from gslib.help_provider import HELP_NAME_ALIASES | 18 |
| 17 from gslib.help_provider import HELP_ONE_LINE_SUMMARY | |
| 18 from gslib.help_provider import HelpProvider | 19 from gslib.help_provider import HelpProvider |
| 19 from gslib.help_provider import HELP_TEXT | |
| 20 from gslib.help_provider import HelpType | |
| 21 from gslib.help_provider import HELP_TYPE | |
| 22 | 20 |
| 23 _detailed_help_text = (""" | 21 _DETAILED_HELP_TEXT = (""" |
| 24 <B>OVERVIEW</B> | 22 <B>OVERVIEW</B> |
| 25 gsutil users can access publicly readable data without obtaining | 23 gsutil users can access publicly readable data without obtaining |
| 26 credentials. For example, the gs://uspto-pair bucket contains a number | 24 credentials. For example, the gs://uspto-pair bucket contains a number |
| 27 of publicly readable objects, so any user can run the following command | 25 of publicly readable objects, so any user can run the following command |
| 28 without first obtaining credentials: | 26 without first obtaining credentials: |
| 29 | 27 |
| 30 gsutil ls gs://uspto-pair/applications/0800401* | 28 gsutil ls gs://uspto-pair/applications/0800401* |
| 31 | 29 |
| 32 Users can similarly download objects they find via the above gsutil ls | 30 Users can similarly download objects they find via the above gsutil ls |
| 33 command. | 31 command. |
| 34 | 32 |
| 35 If a user without credentials attempts to access protected data using gsutil, | 33 If a user without credentials attempts to access protected data using gsutil, |
| 36 they will be prompted to run "gsutil config" to obtain credentials. | 34 they will be prompted to run "gsutil config" to obtain credentials. |
| 37 | 35 |
| 38 See "gsutil help acls" for more details about data protection. | 36 See "gsutil help acls" for more details about data protection. |
| 39 """) | 37 """) |
| 40 | 38 |
| 41 | 39 |
| 42 class CommandOptions(HelpProvider): | 40 class CommandOptions(HelpProvider): |
| 43 """Additional help about Access Control Lists.""" | 41 """Additional help text for anonymous access.""" |
| 44 | 42 |
| 45 help_spec = { | 43 # Help specification. See help_provider.py for documentation. |
| 46 # Name of command or auxiliary help info for which this help applies. | 44 help_spec = HelpProvider.HelpSpec( |
| 47 HELP_NAME : 'anon', | 45 help_name='anon', |
| 48 # List of help name aliases. | 46 help_name_aliases=['anonymous', 'public'], |
| 49 HELP_NAME_ALIASES : ['anonymous', 'public'], | 47 help_type='additional_help', |
| 50 # Type of help: | 48 help_one_line_summary='Accessing Public Data Without Credentials', |
| 51 HELP_TYPE : HelpType.ADDITIONAL_HELP, | 49 help_text=_DETAILED_HELP_TEXT, |
| 52 # One line summary of this help. | 50 subcommand_help_text={}, |
| 53 HELP_ONE_LINE_SUMMARY : | 51 ) |
| 54 'Accessing Public Data Without Credentials', | |
| 55 # The full help text. | |
| 56 HELP_TEXT : _detailed_help_text, | |
| 57 } | |
| OLD | NEW |