org.danilopianini.plagiarismdetector.provider.BitbucketProvider.kt Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of code-plagiarism-detector Show documentation
A tool for scanning existing projects in search of potential signs of plagiarism
There is a newer version: 9.0.6
Show newest version
package org.danilopianini.plagiarismdetector.provider

import com.mashape.unirest.http.Unirest
import org.apache.commons.io.IOUtils
import org.json.JSONObject
import org.danilopianini.plagiarismdetector.provider.criteria.BitbucketSearchCriteria
import org.danilopianini.plagiarismdetector.repository.BitbucketRepository
import org.danilopianini.plagiarismdetector.repository.Repository
import org.danilopianini.plagiarismdetector.provider.authentication.AuthenticationTokenSupplierStrategy
import java.net.URL
import java.nio.charset.StandardCharsets
import java.util.Base64

/**
 * A provider of Bitbucket repositories.
 */
class BitbucketProvider private constructor(
    private var encodedAuthenticationToken: String? = null
) : AbstractRepositoryProvider() {
    companion object {
        private const val BITBUCKET_HOST = "bitbucket.org"
        private const val BASE_URL = "https://api.bitbucket.org/2.0/repositories"
        private const val ERROR_FIELD = "error"
        private const val NEXT_PAGE_FIELD = "next"
        private const val VALUES_FIELD = "values"
        private const val MESSAGE_FIELD = "message"
        private const val ACCEPT_HEADER_FIELD = "Accept"
        private const val ACCEPT_HEADER_VALUE = "application/json"
        private const val AUTH_HEADER_FIELD = "Authorization"
        private const val AUTH_HEADER_PREFIX = "Basic"
        private const val UNAUTHORIZED_CODE = 401
        private const val FORBIDDEN_CODE = 403

        /**
         * Creates a [BitbucketProvider] with anonymous authentication: this is **not** recommended due to
         * rate limits. In case limits are reached an exception is thrown.
         * See Bitbucket API doc [here](https://support.atlassian.com/bitbucket-cloud/docs/api-request-limits).
         */
        fun connectAnonymously() = BitbucketProvider()

        /**
         * Creates a [BitbucketProvider] with an authenticated connection.
         * @param tokenSupplier the supplier of the token
         */
        fun connectWithToken(tokenSupplier: AuthenticationTokenSupplierStrategy) =
            BitbucketProvider(
                Base64.getEncoder().encodeToString(
                    tokenSupplier.token.toByteArray(StandardCharsets.UTF_8)
                )
            )
    }

    override fun urlIsValid(url: URL): Boolean = url.host == BITBUCKET_HOST

    override fun getRepoByUrl(url: URL): Repository {
        return BitbucketRepository(
            getResponses(BASE_URL.plus(url.path)).first()
        )
    }

    override fun byCriteria(criteria: BitbucketSearchCriteria): Sequence {
        return getResponses(criteria.apply(BASE_URL)).asSequence()
            .flatMap { it.getJSONArray(VALUES_FIELD) }
            .map { BitbucketRepository(JSONObject("$it")) }
    }

    private fun getResponses(url: String): Set {
        val responses = mutableSetOf()
        responses.add(doGETRequest(url))
        check(!responses.last().hasError()) {
            responses.last().getJSONObject(ERROR_FIELD).get(MESSAGE_FIELD).toString()
        }
        if (responses.last().hasNext()) {
            responses.addAll(getResponses(responses.last().get(NEXT_PAGE_FIELD).toString()))
        }
        return responses
    }

    private fun doGETRequest(url: String): JSONObject {
        val request = Unirest.get(url)
            .header(ACCEPT_HEADER_FIELD, ACCEPT_HEADER_VALUE)
        encodedAuthenticationToken?.let { request.header(AUTH_HEADER_FIELD, "$AUTH_HEADER_PREFIX $it") }
        val response = request.asBinary()
        check(response.status != UNAUTHORIZED_CODE && response.status != FORBIDDEN_CODE) {
            "HTTP Response: ${response.statusText}. ${IOUtils.toString(response.body, StandardCharsets.UTF_8)}"
        }
        return JSONObject(IOUtils.toString(response.body, StandardCharsets.UTF_8))
    }

    private fun JSONObject.hasError(): Boolean = !isNull(ERROR_FIELD)

    private fun JSONObject.hasNext(): Boolean = !isNull(NEXT_PAGE_FIELD)
}