Adds linking api

Author: AshCorr

.gitignore

@@ -0,0 +1,2 @@
+_data/
+_releases/

Api/Controller/Linking.php

@@ -0,0 +1,56 @@
+<?php
+
+namespace YogstationPermissions\Api\Controller;
+
+use XF\Api\Controller\AbstractController;
+use XF\Mvc\ParameterBag;
+
+/**
+ * @api-group Linking
+ */
+class Linking extends AbstractController
+{
+    /**
+	 * @api-desc Generates a new linking key for a external account.
+	 *
+	 * @api-in <req> str $account_type The type of account (Byond or Discord)
+	 * @api-in <req> str $account_id The external ID of the account being linked
+	 * @api-in str $limit_ip The IP that should be considered to be making the request. If provided, this will be used to prevent brute force attempts.
+	 *
+	 * @api-out str $key the linking key generated.
+     * @api-out str $url the url the end user needs to access to link.
+	 */
+    public function actionPost(ParameterBag $params)
+	{
+        $this->assertSuperUserKey();
+		$this->assertApiScope('linking');
+
+        $key = $this->service('YogstationPermissions:Linking\Generate', $params->account_type, $params->account_type)->generateKey();
+
+        return $this->apiSuccess([
+            'key' => $key,
+            'url' => \XF::app()->router('public')->buildLink('canonical:linking/link', $key, ["key" => $key]),
+		]);
+    }
+
+    public function actionGet(ParameterBag $params)
+    {
+        $this->assertSuperUserKey();
+        $this->assertApiScope('linking');
+        
+        $finder = \XF::finder('YogstationPermissions:LinkedAccount');
+
+        $user = $finder->where('account_id', $params->account_type)
+                       ->where('account_type', $params->account_type)
+                       ->with('User')->fetchOne();
+
+        if(!$user)
+        {
+            return $this->error(\XF::phrase('yg_no_linked_account'));
+        }
+
+        return $this->apiSuccess([
+            'user' => $user
+        ]);
+    }
+}

Entity/LinkedAccount.php

@@ -0,0 +1,31 @@
+<?php
+
+namespace YogstationPermissions\Entity;
+
+use XF\Mvc\Entity\Entity;
+use XF\Mvc\Entity\Structure;
+
+class LinkedAccount extends Entity
+{
+    public static function getStructure(Structure $structure)
+	{
+        $structure->table = 'yg_linked_account';
+		$structure->shortName = 'YG:LinkedAccount';
+        $structure->primaryKey = 'user_id';
+        $structure->columns = [
+            'user_id' => ['type' => self::UINT],
+            'account_type' => ['type' => self::STR, 'maxLength' => 50],
+            'account_id' => ['type' => self::STR, 'maxLength' => 255]
+        ];
+        $structure->relations = [
+			'User' => [
+				'entity' => 'XF:User',
+				'type' => self::TO_ONE,
+				'conditions' => 'user_id',
+				'primary' => true
+            ]
+        ];
+
+        return $structure;
+    }
+}

Entity/LinkingKey.php

@@ -0,0 +1,24 @@
+<?php
+
+namespace YogstationPermissions\Entity;
+
+use XF\Mvc\Entity\Entity;
+use XF\Mvc\Entity\Structure;
+
+class LinkingKey extends Entity
+{
+    public static function getStructure(Structure $structure)
+	{
+        $structure->table = 'yg_linking_key';
+		$structure->shortName = 'YG:LinkingKey';
+        $structure->primaryKey = 'linking_key';
+        $structure->columns = [
+            'linking_key' => ['type' => self::STR, 'maxLength' => 255],
+            'account_type' => ['type' => self::STR, 'maxLength' => 50],
+            'account_id' => ['type' => self::STR, 'maxLength' => 255],
+            'expires' => ['type' => self::UINT]
+        ];
+
+        return $structure;
+    }
+}

Pub/Controller/Linking.php

@@ -0,0 +1,33 @@
+<?php
+
+namespace YogstationPermissions\Pub\Controller;
+
+use XF\Pub\Controller\AbstractController;
+use XF\Mvc\ParameterBag;
+
+class Linking extends AbstractController {
+	protected function preDispatchController($action, ParameterBag $params)
+	{
+		$this->assertRegistrationRequired();
+	}
+
+    public function actionLink(ParameterBag $params) {
+        $visitor = \XF::visitor();
+
+        $linking_key = \XF::finder('YogstationPermissions:LinkingKey')
+            ->where('linking_key', $params->key)
+            ->fetchOne();
+
+        if(!$linking_key) {
+            return $this->error(\XF::phrase('yg_key_not_exist'));
+        }
+
+        $this->service('YogstationPermissions:Linking\Linking', $visitor->user_id, $linking_key)->link();
+
+        return $this->redirect($this->buildLink('linking/success'));
+    }
+
+    public function actionSuccess() {
+        return $this->view('YogstationPermissions:Linking\Success', 'yg_linking_success');
+    }
+}

Service/Linking/Generate.php

@@ -0,0 +1,32 @@
+<?php
+
+namespace YogstationPermissions\Service\Linking;
+
+class Generate extends \XF\Service\AbstractService
+{
+
+    protected $account_type;
+    protected $account_id;
+
+    public function __construct(\XF\App $app, $account_type, $account_id)
+	{
+		parent::__construct($app);
+        $this->account_type = $account_type;
+        $this->account_id = $account_id;
+    }
+    
+    public function generateKey()
+    {
+        $key = \XF::generateRandomString(255);
+
+        $linking_key = $this->em()->create('YogstationPermissions:LinkingKey');
+        $linking_key->linking_key = $key;
+        $linking_key->account_type = $this->account_type;
+        $linking_key->account_id = $this->account_id;
+        $linking_key->expires = \XF::$time + 60 * 15;
+
+        $linking_key->save();
+
+        return $key;
+    }
+}

Service/Linking/Linking.php

@@ -0,0 +1,43 @@
+<?php
+
+namespace YogstationPermissions\Service\Linking;
+
+class Linking extends \XF\Service\AbstractService
+{
+
+    protected $user_id;
+    protected $linking_key;
+
+    public function __construct(\XF\App $app, $user_id, $linking_key)
+	{
+		parent::__construct($app);
+        $this->user_id = $user_id;
+        $this->linking_key = $linking_key;
+    }
+    
+    public function link()
+    {
+        $this->removeOldAccounts();
+
+        $linked_account = $this->em()->create('YogstationPermissions:LinkedAccount');
+        $linked_account->user_id = $this->user_id;
+        $linked_account->account_type = $this->linking_key->account_type;
+        $linked_account->account_id = $this->linking_key->account_id;
+
+        $linked_account->save();
+
+        return $key;
+    }
+
+    public function removeOldAccounts() {
+        $finder = \XF::finder('YogstationPermissions:LinkedAccount');
+
+        $linked_account = $finder->where('account_id', $params->account_type)
+                       ->where('account_type', $params->account_type)
+                       ->fetchOne();
+
+        if($user) {
+            $linked_account->delete();
+        }
+    }
+}

Setup.php

@@ -16,4 +16,24 @@ class Setup extends AbstractSetup
 	use StepRunnerInstallTrait;
 	use StepRunnerUpgradeTrait;
 	use StepRunnerUninstallTrait;
+
+	public function installStep1()
+    {
+        $this->schemaManager()->createTable('yg_linked_account', function(\XF\Db\Schema\Create $table)
+		{
+			$table->addColumn('user_id', 'int');
+			$table->addColumn('account_type', 'varchar', 64);
+			$table->addColumn('account_id', 'varchar', 255);
+			$table->addPrimaryKey('user_id');
+		});
+
+		$this->schemaManager()->createTable('yg_linking_key', function(\XF\Db\Schema\Create $table)
+		{
+			$table->addColumn('linking_key', 'varchar', 255);
+			$table->addColumn('account_type', 'varchar', 64);
+			$table->addColumn('account_id', 'varchar', 255);
+			$table->addColumn('expires', 'int');
+			$table->addPrimaryKey('linking_key');
+		});
+    }
 }

_output/api_scopes/_metadata.json

@@ -0,0 +1,5 @@
+{
+    "linking.json": {
+        "hash": "5620c528fb9d686395a806aff70c7b60"
+    }
+}

_output/api_scopes/linking.json

@@ -0,0 +1,3 @@
+{
+    "api_scope_id": "linking"
+}