PackagesAuth Class Reference

Public Member Functions
	__construct (\Zend\ServiceManager\ServiceLocatorInterface $serviceLocator, \Magento\Framework\HTTP\Client\Curl $curl, \Magento\Framework\Filesystem $filesystem, \Magento\Framework\Serialize\Serializer\Json $serializer=null)
	getCredentialBaseUrl ()
	checkCredentials ($token, $secretKey)
	getAuthJsonData ()
	removeCredentials ()
	saveAuthJson ($username, $password)

Data Fields
const	KEY_HTTPBASIC = 'http-basic'
const	KEY_USERNAME = 'username'
const	KEY_PASSWORD = 'password'
const	PATH_TO_AUTH_FILE = 'auth.json'
const	PATH_TO_PACKAGES_FILE = 'packages.json'

Protected Attributes
	$serviceLocator
	$curlClient
	$urlPrefix = 'https://'

Detailed Description

Class PackagesAuth, checks, saves and removes auth details related to packages.

Definition at line 15 of file PackagesAuth.php.

Constructor & Destructor Documentation

__construct()

__construct	(	\Zend\ServiceManager\ServiceLocatorInterface	$serviceLocator,
		\Magento\Framework\HTTP\Client\Curl	$curl,
		\Magento\Framework\Filesystem	$filesystem,
		\Magento\Framework\Serialize\Serializer\Json	$serializer = null
	)

Parameters

\Zend\ServiceManager\ServiceLocatorInterface	$serviceLocator
\Magento\Framework\HTTP\Client\Curl	$curl
\Magento\Framework\Filesystem	$filesystem
\Magento\Framework\Serialize\Serializer\Json | null	$serializer

Exceptions

Definition at line 64 of file PackagesAuth.php.

      {
        $this->serviceLocator = $serviceLocator;
        $this->curlClient = $curl;
        $this->filesystem = $filesystem;
        $this->serializer = $serializer?: \Magento\Framework\App\ObjectManager::getInstance()
            ->get(\Magento\Framework\Serialize\Serializer\Json::class);
    }

Member Function Documentation

checkCredentials()

checkCredentials	(		$token,
			$secretKey
	)

Parameters

string	$token
string	$secretKey

Returns

string

Exceptions

Definition at line 100 of file PackagesAuth.php.

    {
        $response = ['success' => true];
        $serviceUrl = $this->getPackagesJsonUrl();
        $this->curlClient->setCredentials($token, $secretKey);
        try {
            $this->curlClient->post($serviceUrl, []);
            if ($this->curlClient->getStatus() == 200) {
                $packagesInfo = $this->curlClient->getBody();
                $directory = $this->filesystem->getDirectoryWrite(DirectoryList::COMPOSER_HOME);
                $directory->writeFile(self::PATH_TO_PACKAGES_FILE, $packagesInfo);
            } else {
                $response = ['success' => false, 'message' => 'Bad credentials'];
            }
        } catch (\Exception $e) {
            $response = ['success' => false, 'message' => $e->getMessage()];
        }
        return $this->serializer->serialize($response);
    }

getAuthJsonData()

getAuthJsonData

(

)

Gets auth.json file

Returns

array|false

Definition at line 125 of file PackagesAuth.php.

    {
        try {
            $authJson = $this->getAuthJson();
            $serviceUrl = $this->getCredentialBaseUrl();
            $authJsonData = isset($authJson['http-basic'][$serviceUrl]) ? $authJson['http-basic'][$serviceUrl] : false;
        } catch (\Exception $e) {
            $authJsonData = false;
        }
        return $authJsonData;
    }

getCredentialBaseUrl()

getCredentialBaseUrl

(

)

Returns

string

Definition at line 88 of file PackagesAuth.php.

    {
        $config = $this->serviceLocator->get('config');
        return $config['marketplace']['check_credentials_url'];
    }

removeCredentials()

removeCredentials

(

)

Removes credentials from auth.json

Returns

bool

Exceptions

Definition at line 163 of file PackagesAuth.php.

    {
        $serviceUrl = $this->getCredentialBaseUrl();
        $directory = $this->filesystem->getDirectoryWrite(DirectoryList::COMPOSER_HOME);
        if ($directory->isExist(self::PATH_TO_AUTH_FILE) && $directory->isReadable(self::PATH_TO_AUTH_FILE)) {
            $authJsonData = $this->getAuthJson();
            if (isset($authJsonData['http-basic']) && isset($authJsonData['http-basic'][$serviceUrl])) {
                unset($authJsonData['http-basic'][$serviceUrl]);
                if ($authJsonData === ['http-basic' => []]) {
                    return $directory->delete(self::PATH_TO_AUTH_FILE);
                } else {
                    $data = json_encode($authJsonData, JSON_UNESCAPED_SLASHES|JSON_PRETTY_PRINT);
                    return $data !== false && $directory->writeFile(self::PATH_TO_AUTH_FILE, $data);
                }
            }
        }
        return false;
    }

saveAuthJson()

saveAuthJson	(		$username,
			$password
	)

Saves auth.json file

Parameters

string	$username
string	$password

Returns

bool

Exceptions

Definition at line 190 of file PackagesAuth.php.

    {
        $directory = $this->filesystem->getDirectoryWrite(DirectoryList::COMPOSER_HOME);
        $authContent = [
            PackagesAuth::KEY_HTTPBASIC => [
                $this->getCredentialBaseUrl() => [
                    PackagesAuth::KEY_USERNAME => "$username",
                    PackagesAuth::KEY_PASSWORD => "$password"
                ]
            ]
        ];
        $json = new \Zend\View\Model\JsonModel($authContent);
        $json->setOption('prettyPrint', true);
        $jsonContent = $json->serialize();

        return $directory->writeFile(self::PATH_TO_AUTH_FILE, $jsonContent);
    }

Field Documentation

$curlClient

$curlClient

protected

Definition at line 40 of file PackagesAuth.php.

$serviceLocator

$serviceLocator

protected

Definition at line 35 of file PackagesAuth.php.

$urlPrefix

$urlPrefix = 'https://'

protected

Definition at line 45 of file PackagesAuth.php.

KEY_HTTPBASIC

const KEY_HTTPBASIC = 'http-basic'

#+ Composer auth.json keys

Definition at line 20 of file PackagesAuth.php.

KEY_PASSWORD

const KEY_PASSWORD = 'password'

Definition at line 22 of file PackagesAuth.php.

KEY_USERNAME

const KEY_USERNAME = 'username'

Definition at line 21 of file PackagesAuth.php.

PATH_TO_AUTH_FILE

const PATH_TO_AUTH_FILE = 'auth.json'

#- #+ Filenames for auth and package info

Definition at line 28 of file PackagesAuth.php.

PATH_TO_PACKAGES_FILE

const PATH_TO_PACKAGES_FILE = 'packages.json'

Definition at line 29 of file PackagesAuth.php.

---

The documentation for this class was generated from the following file:

• vendor/magento/magento2-base/setup/src/Magento/Setup/Model/PackagesAuth.php