PhabricatorOAuthServerScope.php
View Options

	<?php

	final class PhabricatorOAuthServerScope extends Phobject {

	const SCOPE_OFFLINE_ACCESS = 'offline_access';
	const SCOPE_WHOAMI = 'whoami';
	const SCOPE_NOT_ACCESSIBLE = 'not_accessible';

	/*
	* Note this does not contain SCOPE_NOT_ACCESSIBLE which is magic
	* used to simplify code for data that is not currently accessible
	* via OAuth.
	*/
	public static function getScopesDict() {
	return array(
	self::SCOPE_OFFLINE_ACCESS => 1,
	self::SCOPE_WHOAMI => 1,
	);
	}

	public static function getDefaultScope() {
	return self::SCOPE_WHOAMI;
	}

	public static function getCheckboxControl(
	array $current_scopes) {

	$have_options = false;
	$scopes = self::getScopesDict();
	$scope_keys = array_keys($scopes);
	sort($scope_keys);
	$default_scope = self::getDefaultScope();

	$checkboxes = new AphrontFormCheckboxControl();
	foreach ($scope_keys as $scope) {
	if ($scope == $default_scope) {
	continue;
	}
	if (!isset($current_scopes[$scope])) {
	continue;
	}

	$checkboxes->addCheckbox(
	$name = $scope,
	$value = 1,
	$label = self::getCheckboxLabel($scope),
	$checked = isset($current_scopes[$scope]));
	$have_options = true;
	}

	if ($have_options) {
	$checkboxes->setLabel(pht('Scope'));
	return $checkboxes;
	}

	return null;
	}

	private static function getCheckboxLabel($scope) {
	$label = null;
	switch ($scope) {
	case self::SCOPE_OFFLINE_ACCESS:
	$label = pht('Make access tokens granted to this client never expire.');
	break;
	case self::SCOPE_WHOAMI:
	$label = pht('Read access to Conduit method %s.', 'user.whoami');
	break;
	}

	return $label;
	}

	public static function getScopesFromRequest(AphrontRequest $request) {
	$scopes = self::getScopesDict();
	$requested_scopes = array();
	foreach ($scopes as $scope => $bit) {
	if ($request->getBool($scope)) {
	$requested_scopes[$scope] = 1;
	}
	}
	$requested_scopes[self::getDefaultScope()] = 1;
	return $requested_scopes;
	}

	/**
	* A scopes list is considered valid if each scope is a known scope
	* and each scope is seen only once. Otherwise, the list is invalid.
	*/
	public static function validateScopesList($scope_list) {
	$scopes = explode(' ', $scope_list);
	$known_scopes = self::getScopesDict();
	$seen_scopes = array();
	foreach ($scopes as $scope) {
	if (!isset($known_scopes[$scope])) {
	return false;
	}
	if (isset($seen_scopes[$scope])) {
	return false;
	}
	$seen_scopes[$scope] = 1;
	}

	return true;
	}

	/**
	* A scopes dictionary is considered valid if each key is a known scope.
	* Otherwise, the dictionary is invalid.
	*/
	public static function validateScopesDict($scope_dict) {
	$known_scopes = self::getScopesDict();
	$unknown_scopes = array_diff_key($scope_dict,
	$known_scopes);
	return empty($unknown_scopes);
	}

	/**
	* Transforms a space-delimited scopes list into a scopes dict. The list
	* should be validated by @{method:validateScopesList} before
	* transformation.
	*/
	public static function scopesListToDict($scope_list) {
	$scopes = explode(' ', $scope_list);
	return array_fill_keys($scopes, 1);
	}

	}

File Metadata

Mime Type: text/x-php
Expires: Mon, Jun 9, 06:40 (1 d, 9 h)
Storage Engine: blob
Storage Format: Raw Data
Storage Handle: 1759391
Default Alt Text: PhabricatorOAuthServerScope.php (3 KB)

PhabricatorOAuthServerScope.php
No OneTemporary
Actions

PhabricatorOAuthServerScope.php
View Options

File Metadata

Event Timeline

PhabricatorOAuthServerScope.phpNo OneTemporaryActions

PhabricatorOAuthServerScope.phpView Options

File Metadata

Event Timeline

PhabricatorOAuthServerScope.php
No OneTemporary
Actions

PhabricatorOAuthServerScope.php
View Options