1*9c5db199SXin Li# Copyright 2017 The Chromium OS Authors. All rights reserved. 2*9c5db199SXin Li# Use of this source code is governed by a BSD-style license that can be 3*9c5db199SXin Li# found in the LICENSE file. 4*9c5db199SXin Li 5*9c5db199SXin Li"""This module contains Google Storage utilities. 6*9c5db199SXin Li 7*9c5db199SXin LiTODO(ayatane): This should be merged into chromite.lib.gs 8*9c5db199SXin Li""" 9*9c5db199SXin Li 10*9c5db199SXin Liimport re 11*9c5db199SXin Li 12*9c5db199SXin Li# See https://cloud.google.com/storage/docs/bucket-naming#objectnames 13*9c5db199SXin Li# Banned characters: []*?# 14*9c5db199SXin Li# and control characters (hex): 00-1f, 7f-84, 86-ff 15*9c5db199SXin Li_INVALID_GS_PATTERN = r'[[\]*?#\x00-\x1f\x7f-\x84\x86-\xff]' 16*9c5db199SXin Li 17*9c5db199SXin Li 18*9c5db199SXin Lidef escape(name): 19*9c5db199SXin Li """Escape GS object name. 20*9c5db199SXin Li 21*9c5db199SXin Li @param name: Name string. 22*9c5db199SXin Li @return: Escaped name string. 23*9c5db199SXin Li """ 24*9c5db199SXin Li return re.sub(_INVALID_GS_PATTERN, 25*9c5db199SXin Li lambda x: _percent_escape(x.group(0)), name) 26*9c5db199SXin Li 27*9c5db199SXin Li 28*9c5db199SXin Lidef _percent_escape(char): 29*9c5db199SXin Li """Percent escape a character. 30*9c5db199SXin Li 31*9c5db199SXin Li @param char: character to escape. 32*9c5db199SXin Li @return: Escaped string. 33*9c5db199SXin Li """ 34*9c5db199SXin Li return '%{:02x}'.format(ord(char)) 35