# -*- coding: utf-8 -*- #
# Copyright 2022 Google LLC. 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.
"""Gsutil-specific formatting of BucketResource and ObjectResource."""

from __future__ import absolute_import
from __future__ import division
from __future__ import unicode_literals

from typing import Union

from googlecloudsdk.api_lib.storage import errors
from googlecloudsdk.command_lib.storage import storage_url
from googlecloudsdk.command_lib.storage.resources import full_resource_formatter as base
from googlecloudsdk.command_lib.storage.resources import resource_reference
from googlecloudsdk.command_lib.storage.resources import resource_util
from googlecloudsdk.command_lib.storage.resources import shim_format_util

_BUCKET_DISPLAY_TITLES_AND_DEFAULTS = base.BucketDisplayTitlesAndDefaults(
    default_storage_class=base.FieldDisplayTitleAndDefault(
        title='Storage class', default=None
    ),
    location_type=base.FieldDisplayTitleAndDefault(
        title='Location type', default=None
    ),
    # Using literal string 'None' as default so that it gets displayed
    # if the value is missing.
    location=base.FieldDisplayTitleAndDefault(
        title='Location constraint', default=shim_format_util.NONE_STRING
    ),
    data_locations=base.FieldDisplayTitleAndDefault(
        title='Placement locations', default=None
    ),
    versioning_enabled=base.FieldDisplayTitleAndDefault(
        title='Versioning enabled', default=shim_format_util.NONE_STRING
    ),
    logging_config=base.FieldDisplayTitleAndDefault(
        title='Logging configuration', default=shim_format_util.NONE_STRING
    ),
    website_config=base.FieldDisplayTitleAndDefault(
        title='Website configuration', default=shim_format_util.NONE_STRING
    ),
    cors_config=base.FieldDisplayTitleAndDefault(
        title='CORS configuration', default=shim_format_util.NONE_STRING
    ),
    lifecycle_config=base.FieldDisplayTitleAndDefault(
        title='Lifecycle configuration', default=shim_format_util.NONE_STRING
    ),
    requester_pays=base.FieldDisplayTitleAndDefault(
        title='Requester Pays enabled', default=shim_format_util.NONE_STRING
    ),
    per_object_retention=None,
    retention_policy=base.FieldDisplayTitleAndDefault(
        title='Retention Policy', default=None
    ),
    default_event_based_hold=base.FieldDisplayTitleAndDefault(
        title='Default Event-Based Hold', default=None
    ),
    labels=base.FieldDisplayTitleAndDefault(
        title='Labels', default=shim_format_util.NONE_STRING
    ),
    default_kms_key=base.FieldDisplayTitleAndDefault(
        title='Default KMS key', default=shim_format_util.NONE_STRING
    ),
    creation_time=base.FieldDisplayTitleAndDefault(
        title='Time created', default=None
    ),
    update_time=base.FieldDisplayTitleAndDefault(
        title='Time updated', default=None
    ),
    # Soft and hard delete are not supported in gsutil.
    soft_delete_time=None,
    hard_delete_time=None,
    generation=None,
    metageneration=base.FieldDisplayTitleAndDefault(
        title='Metageneration', default=None
    ),
    uniform_bucket_level_access=base.FieldDisplayTitleAndDefault(
        title='Bucket Policy Only enabled', default=None
    ),
    autoclass=None,
    autoclass_enabled_time=base.FieldDisplayTitleAndDefault(
        title='Autoclass', default=None
    ),
    public_access_prevention=base.FieldDisplayTitleAndDefault(
        title='Public access prevention', default=None
    ),
    rpo=base.FieldDisplayTitleAndDefault(title='RPO', default=None),
    satisfies_pzs=base.FieldDisplayTitleAndDefault(
        title='Satisfies PZS', default=None
    ),
    # Soft delete policy is not supported in gsutil.
    soft_delete_policy=None,
    # IP Filter is not supported in gsutil.
    ip_filter_config=None,
    acl=base.FieldDisplayTitleAndDefault(
        title='ACL', default=shim_format_util.EMPTY_LIST_STRING
    ),
    default_acl=base.FieldDisplayTitleAndDefault(
        title='Default ACL', default=None
    ),
    name=None,
)


def _get_gsutil_style_formatted_line_for_object_resource(
    display_name, value, default_value=None
):
  """Returns a gsutil-style formatted line for ls -L output for object."""
  if value is not None:
    if value and (isinstance(value, dict) or isinstance(value, list)):
      return resource_util.get_gsutil_object_metadata_json_section_string(
          display_name, value
      )
    elif isinstance(value, errors.CloudApiError):
      return resource_util.get_gsutil_padded_object_metadata_key_value_line(
          display_name, str(value),
      )
    return resource_util.get_gsutil_padded_object_metadata_key_value_line(
        display_name, value,
    )
  elif default_value is not None:
    return resource_util.get_gsutil_padded_object_metadata_key_value_line(
        display_name, default_value,
    )
  return None


def _get_gsutil_style_formatted_line_for_bucket_resource(
    display_name, value, default_value=None
):
  """Returns a gsutil-style formatted line for ls -L output for bucket resource."""
  if value is not None:
    if value and (isinstance(value, dict) or isinstance(value, list)):
      return resource_util.get_gsutil_bucket_metadata_json_section_string(
          display_name, value
      )
    elif isinstance(value, errors.CloudApiError):
      return resource_util.get_gsutil_padded_bucket_metadata_key_value_line(
          display_name, str(value),
      )
    return resource_util.get_gsutil_padded_bucket_metadata_key_value_line(
        display_name, value,
    )
  elif default_value is not None:
    return resource_util.get_gsutil_padded_bucket_metadata_key_value_line(
        display_name, default_value,
    )
  return None


def get_gsutil_style_formatted_string(
    resource: resource_reference.Resource,
    display_titles_and_defaults: Union[
        base.BucketDisplayTitlesAndDefaults, base.ObjectDisplayTitlesAndDefaults
    ],
    show_acl: bool = True,
    show_version_in_url: bool = False,
) -> str:
  """Returns the gsutil-style formatted string representing the resource.

  Args:
    resource: Object holding resource metadata that needs to be displayed.
    display_titles_and_defaults: Holds the display titles and default values for
      each field present in the Resource.
    show_acl: Include ACLs list in resource display.
    show_version_in_url: Display extended URL with versioning info.

  Returns:
    A string representing the Resource for ls -L command.
  """
  lines = []

  formatted_acl_dict = resource.get_formatted_acl() if show_acl else {}

  # In namedtuple, to prevent conflicts with field names,
  # the method and attribute names start with an underscore.
  for key in display_titles_and_defaults._fields:
    if not show_acl and key == base.ACL_KEY:
      continue
    field_display_title_and_default = getattr(display_titles_and_defaults, key)
    if field_display_title_and_default is None:
      # Field not supported for this output style.
      continue
    # The field_name present in field_display_title_and_default takes
    # precedence over the key in display_titles_and_defaults.
    field_name = (
        field_display_title_and_default.field_name
        or key
    )

    value = (
        formatted_acl_dict.get(field_name)
        if field_name in formatted_acl_dict
        else getattr(resource, field_name, None)
    )

    if value == resource_reference.NOT_SUPPORTED_DO_NOT_DISPLAY:
      continue

    if resource.storage_url.is_bucket():
      line = _get_gsutil_style_formatted_line_for_bucket_resource(
          field_display_title_and_default.title,
          value,
          field_display_title_and_default.default,
      )
    else:
      line = _get_gsutil_style_formatted_line_for_object_resource(
          field_display_title_and_default.title,
          value,
          field_display_title_and_default.default,
      )
    if line is not None:
      lines.append(line)

  url_string = (
      resource.storage_url.url_string
      if show_version_in_url
      else resource.storage_url.versionless_url_string
  )
  fields = '\n'.join(lines)
  optional_spacing = ' ' if resource.storage_url.is_bucket() else ''
  return f'{url_string}{optional_spacing}:\n{fields}'


class GsutilFullResourceFormatter(base.FullResourceFormatter):
  """Format a resource as per gsutil Storage style for ls -L output."""

  def format_bucket(self, bucket_resource):
    """See super class."""
    shim_format_util.replace_autoclass_value_with_prefixed_time(
        bucket_resource, use_gsutil_time_style=True)
    shim_format_util.replace_time_values_with_gsutil_style_strings(
        bucket_resource)
    shim_format_util.replace_bucket_values_with_present_string(bucket_resource)
    return get_gsutil_style_formatted_string(
        bucket_resource, _BUCKET_DISPLAY_TITLES_AND_DEFAULTS
    )

  def format_object(
      self, object_resource, show_acl=True, show_version_in_url=False, **kwargs
  ):
    """See super class."""
    del kwargs  # Unused.

    storage_class_update_time = None
    if (
        object_resource.scheme == storage_url.ProviderPrefix.GCS
        and object_resource.storage_class_update_time
        and object_resource.storage_class_update_time
        != object_resource.creation_time
    ):
      storage_class_update_time = base.FieldDisplayTitleAndDefault(
          title='Storage class update time',
          default=None,
      )

    object_display_title_and_defaults = base.ObjectDisplayTitlesAndDefaults(
        creation_time=base.FieldDisplayTitleAndDefault(
            title='Creation time', default=None
        ),
        update_time=base.FieldDisplayTitleAndDefault(
            title='Update time', default=None
        ),
        storage_class_update_time=storage_class_update_time,
        # Soft and hard delete are not supported in gsutil.
        soft_delete_time=None,
        hard_delete_time=None,
        storage_class=base.FieldDisplayTitleAndDefault(
            title='Storage class', default=None
        ),
        temporary_hold=base.FieldDisplayTitleAndDefault(
            title='Temporary Hold', default=None
        ),
        event_based_hold=base.FieldDisplayTitleAndDefault(
            title='Event-Based Hold', default=None
        ),
        retention_expiration=base.FieldDisplayTitleAndDefault(
            title='Retention Expiration', default=None
        ),
        # Retention settings is not supported in gsutil.
        retention_settings=None,
        kms_key=base.FieldDisplayTitleAndDefault(title='KMS key', default=None),
        cache_control=base.FieldDisplayTitleAndDefault(
            title='Cache-Control', default=None
        ),
        content_disposition=base.FieldDisplayTitleAndDefault(
            title='Content-Disposition', default=None
        ),
        content_encoding=base.FieldDisplayTitleAndDefault(
            title='Content-Encoding', default=None
        ),
        content_language=base.FieldDisplayTitleAndDefault(
            title='Content-Language', default=None
        ),
        size=base.FieldDisplayTitleAndDefault(
            title='Content-Length', default=shim_format_util.NONE_STRING
        ),
        content_type=base.FieldDisplayTitleAndDefault(
            title='Content-Type', default=shim_format_util.NONE_STRING
        ),
        component_count=base.FieldDisplayTitleAndDefault(
            title='Component-Count', default=None
        ),
        custom_time=base.FieldDisplayTitleAndDefault(
            title='Custom-Time', default=None
        ),
        noncurrent_time=base.FieldDisplayTitleAndDefault(
            title='Noncurrent time', default=None
        ),
        # Custom contexts are not supported in gsutil.
        contexts=None,
        custom_fields=base.FieldDisplayTitleAndDefault(
            title='Metadata', default=None
        ),
        crc32c_hash=base.FieldDisplayTitleAndDefault(
            title='Hash (crc32c)', default=None
        ),
        md5_hash=base.FieldDisplayTitleAndDefault(
            title='Hash (md5)', default=None
        ),
        encryption_algorithm=base.FieldDisplayTitleAndDefault(
            title='Encryption algorithm', default=None
        ),
        decryption_key_hash_sha256=base.FieldDisplayTitleAndDefault(
            title='Encryption key SHA256', default=None
        ),
        etag=base.FieldDisplayTitleAndDefault(
            title='ETag', default=shim_format_util.NONE_STRING
        ),
        generation=base.FieldDisplayTitleAndDefault(
            title='Generation', default=None
        ),
        metageneration=base.FieldDisplayTitleAndDefault(
            title='Metageneration', default=None
        ),
        acl=base.FieldDisplayTitleAndDefault(
            title='ACL', default=shim_format_util.EMPTY_LIST_STRING
        ),
        name=None,
        bucket=None,
    )

    shim_format_util.replace_time_values_with_gsutil_style_strings(
        object_resource
    )
    shim_format_util.replace_object_values_with_encryption_string(
        object_resource, 'encrypted'
    )
    shim_format_util.reformat_custom_fields_for_gsutil(object_resource)
    return get_gsutil_style_formatted_string(
        object_resource,
        object_display_title_and_defaults,
        show_acl=show_acl,
        show_version_in_url=show_version_in_url)