<?php
/*
 * Copyright 2026 Google LLC
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are
 * met:
 *
 *     * Redistributions of source code must retain the above copyright
 * notice, this list of conditions and the following disclaimer.
 *     * Redistributions in binary form must reproduce the above
 * copyright notice, this list of conditions and the following disclaimer
 * in the documentation and/or other materials provided with the
 * distribution.
 *     * Neither the name of Google Inc. nor the names of its
 * contributors may be used to endorse or promote products derived from
 * this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

namespace Google\ApiCore\ResumableUpload;

/**
 * Trait for GAPIC clients that support resumable uploads.
 *
 * @internal
 */
trait ResumableUploadTrait
{
    private ResumableUploadClient $resumableUploadClient;

    /**
     * Resume an existing resumable upload session.
     *
     * When resuming an upload, it is recommended that the data stream is rewound to offset 0.
     * If the stream is not rewound and not seekable, an error may occur if unconfirmed
     * chunks must be re-read.
     *
     * @param string $uploadUrl The resumable upload session URL.
     * @param string $methodName The API method name.
     * @param array $optionalArgs {
     *     Optional.
     *
     *     @type int $chunkSize Optional. The chunk size in bytes to use for resuming the upload.
     *     @type array $headers Optional. Key-value array of custom HTTP headers to
     *           include with upload requests.
     *     @type int $timeoutMillis Optional. The timeout in milliseconds for the
     *           initial start call.
     *     @type RetrySettings|array $retrySettings Optional. Retry settings to use for the
     *           initial start call.
     * }
     * @return ResumableUpload
     */
    public function resumeUpload(
        string $uploadUrl,
        string $methodName,
        array $optionalArgs = []
    ): ResumableUpload {
        $optionalArgs['uploadUrl'] = $uploadUrl;
        return $this->startApiCall(ucfirst($methodName), null, $optionalArgs);
    }

    /**
     * Create the ResumableUploadClient for this GAPIC client.
     *
     * @param array $options
     * @return ResumableUploadClient
     */
    private function createResumableUploadClient(array $options): ResumableUploadClient
    {
        $transport = $options['transport'] ?? null;
        if (!$transport instanceof ResumableUploadTransportInterface) {
            $transport = $this->createTransport(
                $options['apiEndpoint'] ?? '',
                'rest',
                $options['transportConfig'] ?? [],
                $options['clientCertSource'] ?? null,
                $options['hasEmulator'] ?? false
            );
        }

        return new ResumableUploadClient(
            $transport,
            $this->credentialsWrapper,
            $this->agentHeader
        );
    }
}