// Copyright 2026 Versity Software
// This file is 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.

package s3err

import "encoding/xml"

// InvalidRangeError is returned when the requested byte range cannot be satisfied.
// Produces <RangeRequested> and <ActualObjectSize> fields in the XML response.
type InvalidRangeError struct {
	APIError
	RangeRequested   string
	ActualObjectSize int64
}

func (e InvalidRangeError) XMLBody(requestID, hostID string) []byte {
	return encodeResponse(struct {
		XMLName          xml.Name `xml:"Error"`
		Code             string
		Message          string
		RangeRequested   string `xml:",omitempty"`
		ActualObjectSize int64  `xml:",omitempty"`
		RequestID        string `xml:"RequestId,omitempty"`
		HostID           string `xml:"HostId,omitempty"`
	}{
		Code:             e.Code,
		Message:          e.Description,
		RangeRequested:   e.RangeRequested,
		ActualObjectSize: e.ActualObjectSize,
		RequestID:        requestID,
		HostID:           hostID,
	})
}

func (e InvalidRangeError) HTMLBody(requestID, hostID string) []byte {
	return e.APIError.encodeHTMLResponse(requestID, hostID,
		ErrorField{Name: "RangeRequested", Value: e.RangeRequested},
		ErrorField{Name: "ActualObjectSize", Value: e.ActualObjectSize},
	)
}

func (e InvalidRangeError) Is(target error) bool {
	t, ok := target.(APIError)
	return ok && e.APIError == t
}

func GetInvalidRangeErr(rangeRequested string, actualObjectSize int64) InvalidRangeError {
	return InvalidRangeError{
		APIError:         GetAPIError(ErrInvalidRange),
		RangeRequested:   rangeRequested,
		ActualObjectSize: actualObjectSize,
	}
}