aboutsummaryrefslogtreecommitdiffstats
path: root/phpBB/phpbb/auth/provider/oauth/oauth.php
blob: fe826637998571e5e25d735c29c39ff3784a0f4d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
<?php
/**
 *
 * This file is part of the phpBB Forum Software package.
 *
 * @copyright (c) phpBB Limited <https://www.phpbb.com>
 * @license GNU General Public License, version 2 (GPL-2.0)
 *
 * For full copyright and license information, please see
 * the docs/CREDITS.txt file.
 *
 */

namespace phpbb\auth\provider\oauth;

use OAuth\ServiceFactory;
use OAuth\Common\Consumer\Credentials;
use OAuth\Common\Service\ServiceInterface;
use OAuth\OAuth1\Service\AbstractService as OAuth1Service;
use OAuth\OAuth2\Service\AbstractService as OAuth2Service;
use Symfony\Component\DependencyInjection\ContainerInterface;
use phpbb\auth\provider\oauth\service\exception;

/**
 * OAuth authentication provider for phpBB3
 */
class oauth extends \phpbb\auth\provider\base
{
	/** @var \phpbb\config\config */
	protected $config;

	/** @var ContainerInterface */
	protected $container;

	/** @var \phpbb\db\driver\driver_interface */
	protected $db;

	/** @var \phpbb\event\dispatcher */
	protected $dispatcher;

	/** @var \phpbb\language\language */
	protected $language;

	/** @var \phpbb\passwords\manager */
	protected $passwords_manager;

	/** @var \phpbb\request\request_interface */
	protected $request;

	/** @var \phpbb\di\service_collection */
	protected $service_providers;

	/** @var \phpbb\user */
	protected $user;

	/** @var string OAuth table: token storage */
	protected $oauth_token_table;

	/** @var string OAuth table: state */
	protected $oauth_state_table;

	/** @var string OAuth table: account association */
	protected $oauth_account_table;

	/** @var string Users table */
	protected $users_table;

	/** @var string phpBB root path */
	protected $root_path;

	/** @var string php File extension */
	protected $php_ext;

	/**
	 * Constructor.
	 *
	 * @param \phpbb\config\config				$config					Config object
	 * @param ContainerInterface				$container				Service container object
	 * @param \phpbb\db\driver\driver_interface	$db						Database object
	 * @param \phpbb\event\dispatcher			$dispatcher				Event dispatcher object
	 * @param \phpbb\language\language			$language				Language object
	 * @param \phpbb\passwords\manager			$passwords_manager		Password manager object
	 * @param \phpbb\request\request_interface	$request				Request object
	 * @param \phpbb\di\service_collection		$service_providers		OAuth providers service collection
	 * @param \phpbb\user						$user					User object
	 * @param string							$oauth_token_table		OAuth table: token storage
	 * @param string							$oauth_state_table		OAuth table: state
	 * @param string							$oauth_account_table	OAuth table: account association
	 * @param string							$users_table			User table
	 * @param string							$root_path				phpBB root path
	 * @param string							$php_ext				php File extension
	 */
	public function __construct(
		\phpbb\config\config $config,
		ContainerInterface $container,
		\phpbb\db\driver\driver_interface $db,
		\phpbb\event\dispatcher $dispatcher,
		\phpbb\language\language $language,
		\phpbb\passwords\manager $passwords_manager,
		\phpbb\request\request_interface $request,
		\phpbb\di\service_collection $service_providers,
		\phpbb\user $user,
		$oauth_token_table,
		$oauth_state_table,
		$oauth_account_table,
		$users_table,
		$root_path,
		$php_ext
	)
	{
		$this->config				= $config;
		$this->container			= $container;
		$this->db					= $db;
		$this->dispatcher			= $dispatcher;
		$this->passwords_manager	= $passwords_manager;
		$this->language				= $language;
		$this->service_providers	= $service_providers;
		$this->request				= $request;
		$this->user					= $user;

		$this->oauth_token_table	= $oauth_token_table;
		$this->oauth_state_table	= $oauth_state_table;
		$this->oauth_account_table	= $oauth_account_table;
		$this->users_table			= $users_table;
		$this->root_path			= $root_path;
		$this->php_ext				= $php_ext;
	}

	/**
	 * {@inheritdoc}
	 */
	public function init()
	{
		// This does not test whether or not the key and secret provided are valid.
		foreach ($this->service_providers as $service_provider)
		{
			$credentials = $service_provider->get_service_credentials();

			if (($credentials['key'] && !$credentials['secret']) || (!$credentials['key'] && $credentials['secret']))
			{
				return $this->language->lang('AUTH_PROVIDER_OAUTH_ERROR_ELEMENT_MISSING');
			}
		}

		return false;
	}

	/**
	 * {@inheritdoc}
	 */
	public function login($username, $password)
	{
		// Temporary workaround for only having one authentication provider available
		if (!$this->request->is_set('oauth_service'))
		{
			$provider = new \phpbb\auth\provider\db(
				$this->db,
				$this->config,
				$this->passwords_manager,
				$this->request,
				$this->user,
				$this->container,
				$this->root_path,
				$this->php_ext
			);

			return $provider->login($username, $password);
		}

		// Request the name of the OAuth service
		$provider = $this->request->variable('oauth_service', '', false);
		$service_name = $this->get_service_name($provider);

		if ($provider === '' || !array_key_exists($service_name, $this->service_providers))
		{
			return [
				'status'		=> LOGIN_ERROR_EXTERNAL_AUTH,
				'error_msg'		=> 'LOGIN_ERROR_OAUTH_SERVICE_DOES_NOT_EXIST',
				'user_row'		=> ['user_id' => ANONYMOUS],
			];
		}

		// Get the service credentials for the given service
		$storage = new token_storage($this->db, $this->user, $this->oauth_token_table, $this->oauth_state_table);
		$query = 'mode=login&login=external&oauth_service=' . $provider;

		try
		{
			/** @var OAuth1Service|OAuth2Service $service */
			$service = $this->get_service($provider, $storage, $query);
		}
		catch (\Exception $e)
		{
			return [
				'status'		=> LOGIN_ERROR_EXTERNAL_AUTH,
				'error_msg'		=> $e->getMessage(),
				'user_row'		=> ['user_id' => ANONYMOUS],
			];
		}

		if ($this->is_set_code($service))
		{
			$this->service_providers[$service_name]->set_external_service_provider($service);

			try
			{
				$unique_id = $this->service_providers[$service_name]->perform_auth_login();
			}
			catch (exception $e)
			{
				return [
					'status'		=> LOGIN_ERROR_EXTERNAL_AUTH,
					'error_msg'		=> $e->getMessage(),
					'user_row'		=> ['user_id' => ANONYMOUS],
				];
			}

			/**
			 * Check to see if this provider is already associated with an account.
			 *
			 * Enforcing a data type to make sure it are strings and not integers,
			 * so values are quoted in the SQL WHERE statement.
			 */
			$data = [
				'provider'			=> (string) utf8_strtolower($provider),
				'oauth_provider_id'	=> (string) $unique_id
			];

			$sql = 'SELECT user_id 
				FROM ' . $this->oauth_account_table . '
				WHERE ' . $this->db->sql_build_array('SELECT', $data);
			$result = $this->db->sql_query($sql);
			$row = $this->db->sql_fetchrow($result);
			$this->db->sql_freeresult($result);

			$redirect_data = array(
				'auth_provider'				=> 'oauth',
				'login_link_oauth_service'	=> $provider,
			);

			/**
			 * Event is triggered before check if provider is already associated with an account
			 *
			 * @event core.oauth_login_after_check_if_provider_id_has_match
			 * @var array				row				User row
			 * @var array				data			Provider data
			 * @var	array				redirect_data	Data to be appended to the redirect url
			 * @var ServiceInterface	service			OAuth service
			 * @since 3.2.3-RC1
			 * @changed 3.2.6-RC1						Added redirect_data
			 */
			$vars = [
				'row',
				'data',
				'redirect_data',
				'service',
			];
			extract($this->dispatcher->trigger_event('core.oauth_login_after_check_if_provider_id_has_match', compact($vars)));

			if (!$row)
			{
				// The user does not yet exist, ask to link or create profile
				return [
					'status'		=> LOGIN_SUCCESS_LINK_PROFILE,
					'error_msg'		=> 'LOGIN_OAUTH_ACCOUNT_NOT_LINKED',
					'user_row'		=> [],
					'redirect_data'	=> $redirect_data,
				];
			}

			// Retrieve the user's account
			$sql = 'SELECT user_id, username, user_password, user_passchg, user_email, user_ip, user_type, user_login_attempts
				FROM ' . $this->users_table . '
				WHERE user_id = ' . (int) $row['user_id'];
			$result = $this->db->sql_query($sql);
			$row = $this->db->sql_fetchrow($result);
			$this->db->sql_freeresult($result);

			if (!$row)
			{
				return [
					'status'		=> LOGIN_ERROR_EXTERNAL_AUTH,
					'error_msg'		=> 'AUTH_PROVIDER_OAUTH_ERROR_INVALID_ENTRY',
					'user_row'		=> ['user_id' => ANONYMOUS],
				];
			}

			/**
			 * Check if the user is banned.
			 * The fourth parameter (return) has to be true, otherwise the OAuth login is still called and
			 * an uncaught exception is thrown as there is no token stored in the database.
			 */
			$ban = $this->user->check_ban($row['user_id'], $row['user_ip'], $row['user_email'], true);

			if (!empty($ban))
			{
				$till_date = !empty($ban['ban_end']) ? $this->user->format_date($ban['ban_end']) : '';
				$message = !empty($ban['ban_end']) ? 'BOARD_BAN_TIME' : 'BOARD_BAN_PERM';

				$contact_link = phpbb_get_board_contact_link($this->config, $this->root_path, $this->php_ext);

				$message = $this->language->lang($message, $till_date, '<a href="' . $contact_link . '">', '</a>');
				$message .= !empty($ban['ban_give_reason']) ? '<br /><br />' . $this->language->lang('BOARD_BAN_REASON', $ban['ban_give_reason']) : '';
				$message .= !empty($ban['ban_triggered_by']) ? '<br /><br /><em>' . $this->language->lang('BAN_TRIGGERED_BY_' . utf8_strtoupper($ban['ban_triggered_by'])) . '</em>' : '';

				return [
					'status'	=> LOGIN_BREAK,
					'error_msg'	=> $message,
					'user_row'	=> $row,
				];
			}

			// Update token storage to store the user_id
			$storage->set_user_id($row['user_id']);

			/**
			 * Event is triggered after user is successfully logged in via OAuth.
			 *
			 * @event core.auth_oauth_login_after
			 * @var array	row		User row
			 * @since 3.1.11-RC1
			 */
			$vars = [
				'row',
			];
			extract($this->dispatcher->trigger_event('core.auth_oauth_login_after', compact($vars)));

			// The user is now authenticated and can be logged in
			return [
				'status'		=> LOGIN_SUCCESS,
				'error_msg'		=> false,
				'user_row'		=> $row,
			];
		}
		else
		{
			return $this->set_redirect($service);
		}
	}

	/**
	 * {@inheritdoc}
	 */
	public function get_login_data()
	{
		$login_data = [
			'TEMPLATE_FILE'		=> 'login_body_oauth.html',
			'BLOCK_VAR_NAME'	=> 'oauth',
			'BLOCK_VARS'		=> [],
		];

		foreach ($this->service_providers as $service_name => $service_provider)
		{
			// Only include data if the credentials are set
			$credentials = $service_provider->get_service_credentials();

			if ($credentials['key'] && $credentials['secret'])
			{
				$provider = $this->get_provider($service_name);
				$redirect_url = generate_board_url() . '/ucp.' . $this->php_ext . '?mode=login&login=external&oauth_service=' . $provider;

				$login_data['BLOCK_VARS'][$service_name] = [
					'REDIRECT_URL'	=> redirect($redirect_url, true),
					'SERVICE_NAME'	=> $this->get_provider_title($provider),
				];
			}
		}

		return $login_data;
	}

	/**
	 * {@inheritdoc}
	 */
	public function acp()
	{
		$ret = [];

		foreach ($this->service_providers as $service_name => $service_provider)
		{
			$provider = $this->get_provider($service_name);

			$provider = utf8_strtolower($provider);

			$ret[] = 'auth_oauth_' . $provider . '_key';
			$ret[] = 'auth_oauth_' . $provider . '_secret';
		}

		return $ret;
	}

	/**
	 * {@inheritdoc}
	 */
	public function get_acp_template($new_config)
	{
		$ret = [
			'BLOCK_VAR_NAME'	=> 'oauth_services',
			'BLOCK_VARS'		=> [],
			'TEMPLATE_FILE'		=> 'auth_provider_oauth.html',
			'TEMPLATE_VARS'		=> [],
		];

		foreach ($this->service_providers as $service_name => $service_provider)
		{
			$provider = $this->get_provider($service_name);

			$ret['BLOCK_VARS'][$provider] = [
				'NAME'			=> $provider,
				'ACTUAL_NAME'	=> $this->get_provider_title($provider),
				'KEY'			=> $new_config['auth_oauth_' . utf8_strtolower($provider) . '_key'],
				'SECRET'		=> $new_config['auth_oauth_' . utf8_strtolower($provider) . '_secret'],
			];
		}

		return $ret;
	}

	/**
	 * {@inheritdoc}
	 */
	public function login_link_has_necessary_data($login_link_data)
	{
		if (empty($login_link_data))
		{
			return 'LOGIN_LINK_NO_DATA_PROVIDED';
		}

		if (!array_key_exists('oauth_service', $login_link_data) || !$login_link_data['oauth_service'] ||
			!array_key_exists('link_method', $login_link_data) || !$login_link_data['link_method'])
		{
			return 'LOGIN_LINK_MISSING_DATA';
		}

		return null;
	}

	/**
	 * {@inheritdoc}
	 */
	public function link_account(array $link_data)
	{
		// Check for a valid link method (auth_link or login_link)
		if (!array_key_exists('link_method', $link_data) ||
			!in_array($link_data['link_method'], ['auth_link', 'login_link']))
		{
			return 'LOGIN_LINK_MISSING_DATA';
		}

		// We must have an oauth_service listed, check for it two ways
		if (!array_key_exists('oauth_service', $link_data) || !$link_data['oauth_service'])
		{
			$link_data['oauth_service'] = $this->request->variable('oauth_service', '');

			if (!$link_data['oauth_service'])
			{
				return 'LOGIN_LINK_MISSING_DATA';
			}
		}

		$service_name = $this->get_service_name($link_data['oauth_service']);

		if (!array_key_exists($service_name, $this->service_providers))
		{
			return 'LOGIN_ERROR_OAUTH_SERVICE_DOES_NOT_EXIST';
		}

		switch ($link_data['link_method'])
		{
			case 'auth_link':
				return $this->link_account_auth_link($link_data, $service_name);
			case 'login_link':
				return $this->link_account_login_link($link_data, $service_name);
			default:
				return 'LOGIN_LINK_MISSING_DATA';
		}
	}

	/**
	 * {@inheritdoc}
	 */
	public function logout($data, $new_session)
	{
		// Clear all tokens belonging to the user
		$storage = new token_storage($this->db, $this->user, $this->oauth_token_table, $this->oauth_state_table);
		$storage->clearAllTokens();

		return;
	}

	/**
	 * {@inheritdoc}
	 */
	public function get_auth_link_data($user_id = 0)
	{
		$user_ids	= [];
		$block_vars	= [];

		$sql = 'SELECT oauth_provider_id, provider
 			FROM ' . $this->oauth_account_table . '
			WHERE user_id = ' . ($user_id > 0 ? (int) $user_id : (int) $this->user->data['user_id']);
		$result = $this->db->sql_query($sql);
		while ($row = $this->db->sql_fetchrow($result))
		{
			$user_ids[$row['provider']] = $row['oauth_provider_id'];
		}
		$this->db->sql_freeresult($result);

		foreach ($this->service_providers as $service_name => $service_provider)
		{
			// Only include data if the credentials are set
			$credentials = $service_provider->get_service_credentials();

			if ($credentials['key'] && $credentials['secret'])
			{
				$provider = $this->get_provider($service_name);

				$block_vars[$service_name] = [
					'SERVICE_NAME'	=> $this->get_provider_title($provider),
					'UNIQUE_ID'		=> isset($user_ids[$provider]) ? $user_ids[$provider] : null,
					'HIDDEN_FIELDS'	=> [
						'link'			=> !isset($user_ids[$provider]),
						'oauth_service' => $provider,
					],
				];
			}
		}

		return [
			'BLOCK_VAR_NAME'	=> 'oauth',
			'BLOCK_VARS'		=> $block_vars,

			'TEMPLATE_FILE'		=> 'ucp_auth_link_oauth.html',
		];
	}

	/**
	 * {@inheritdoc}
	 */
	public function unlink_account(array $link_data)
	{
		if (!array_key_exists('oauth_service', $link_data) || !$link_data['oauth_service'])
		{
			return 'LOGIN_LINK_MISSING_DATA';
		}

		// Remove user specified in $link_data if possible
		$user_id = isset($link_data['user_id']) ? $link_data['user_id'] : $this->user->data['user_id'];

		// Remove the link
		$sql = 'DELETE FROM ' . $this->oauth_account_table . "
			WHERE provider = '" . $this->db->sql_escape($link_data['oauth_service']) . "'
				AND user_id = " . (int) $user_id;
		$this->db->sql_query($sql);

		$service_name = $this->get_service_name($link_data['oauth_service']);

		// Clear all tokens belonging to the user on this service
		$storage = new token_storage($this->db, $this->user, $this->oauth_token_table, $this->oauth_state_table);
		$storage->clearToken($service_name);

		return false;
	}

	/**
	 * Performs the account linking for login_link.
	 *
	 * @param array		$link_data		The same variable given to
	 * 									{@see \phpbb\auth\provider\provider_interface::link_account}
	 * @param string	$service_name	The name of the service being used in linking.
	 * @return string|false				Returns a language key (string) if an error is encountered,
	 * 									or false on success.
	 */
	protected function link_account_login_link(array $link_data, $service_name)
	{
		$storage = new token_storage($this->db, $this->user, $this->oauth_token_table, $this->oauth_state_table);

		// Check for an access token, they should have one
		if (!$storage->has_access_token_by_session($service_name))
		{
			return 'LOGIN_LINK_ERROR_OAUTH_NO_ACCESS_TOKEN';
		}

		// Prepare for an authentication request
		$query = 'mode=login_link&login_link_oauth_service=' . $link_data['oauth_service'];

		try
		{
			$service = $this->get_service($link_data['oauth_service'], $storage, $query);
		}
		catch (\Exception $e)
		{
			return $e->getMessage();
		}

		$this->service_providers[$service_name]->set_external_service_provider($service);

		try
		{
			// The user has already authenticated successfully, request to authenticate again
			$unique_id = $this->service_providers[$service_name]->perform_token_auth();
		}
		catch (exception $e)
		{
			return $e->getMessage();
		}

		// Insert into table, they will be able to log in after this
		$data = [
			'user_id'			=> $link_data['user_id'],
			'provider'			=> utf8_strtolower($link_data['oauth_service']),
			'oauth_provider_id'	=> $unique_id,
		];

		$this->link_account_perform_link($data);

		// Update token storage to store the user_id
		$storage->set_user_id($link_data['user_id']);

		return false;
	}

	/**
	 * Performs the account linking for auth_link.
	 *
	 * @param array		$link_data		The same variable given to
	 * 									{@see \phpbb\auth\provider\provider_interface::link_account}
	 * @param string	$service_name	The name of the service being used in linking.
	 * @return string|false				Returns a language constant (string) if an error is encountered,
	 * 									or false on success.
	 */
	protected function link_account_auth_link(array $link_data, $service_name)
	{
		$storage = new token_storage($this->db, $this->user, $this->oauth_token_table, $this->oauth_state_table);
		$query = 'i=ucp_auth_link&mode=auth_link&link=1&oauth_service=' . $link_data['oauth_service'];

		try
		{
			/** @var OAuth1Service|OAuth2Service $service */
			$service = $this->get_service($link_data['oauth_service'], $storage, $query);
		}
		catch (\Exception $e)
		{
			return $e->getMessage();
		}

		if ($this->is_set_code($service))
		{
			$this->service_providers[$service_name]->set_external_service_provider($service);

			try
			{
				$unique_id = $this->service_providers[$service_name]->perform_auth_login();
			}
			catch (exception $e)
			{
				return $e->getMessage();
			}

			// Insert into table, they will be able to log in after this
			$data = [
				'user_id'			=> $this->user->data['user_id'],
				'provider'			=> utf8_strtolower($link_data['oauth_service']),
				'oauth_provider_id'	=> $unique_id,
			];

			$this->link_account_perform_link($data);

			return false;
		}
		else
		{
			return $this->set_redirect($service);
		}
	}

	/**
	 * Performs the query that inserts an account link
	 *
	 * @param	array	$data	This array is passed to db->sql_build_array
	 */
	protected function link_account_perform_link(array $data)
	{
		// Check if the external account is already associated with other user
		$sql = 'SELECT user_id
			FROM ' . $this->oauth_account_table . "
			WHERE provider = '" . $this->db->sql_escape($data['provider']) . "'
				AND oauth_provider_id = '" . $this->db->sql_escape($data['oauth_provider_id']) . "'";
		$result = $this->db->sql_query($sql);
		$row = $this->db->sql_fetchrow($result);
		$this->db->sql_freeresult($result);

		if ($row)
		{
			trigger_error('AUTH_PROVIDER_OAUTH_ERROR_ALREADY_LINKED');
		}

		// Link account
		$sql = 'INSERT INTO ' . $this->oauth_account_table . ' ' . $this->db->sql_build_array('INSERT', $data);
		$this->db->sql_query($sql);

		/**
		 * Event is triggered after user links account.
		 *
		 * @event core.auth_oauth_link_after
		 * @var array	data	User row
		 * @since 3.1.11-RC1
		 */
		$vars = [
			'data',
		];
		extract($this->dispatcher->trigger_event('core.auth_oauth_link_after', compact($vars)));
	}

	/**
	 * Returns a new service object.
	 *
	 * @param string			$provider		The name of the provider
	 * @param token_storage		$storage		Token storage object
	 * @param string			$query			The query string used for the redirect uri
	 * @return ServiceInterface
	 * @throws exception						When OAuth service was not created
	 */
	protected function get_service($provider, token_storage $storage, $query)
	{
		$service_name = $this->get_service_name($provider);

		/** @see \phpbb\auth\provider\oauth\service\service_interface::get_service_credentials */
		$service_credentials = $this->service_providers[$service_name]->get_service_credentials();

		/** @see \phpbb\auth\provider\oauth\service\service_interface::get_auth_scope */
		$scopes = $this->service_providers[$service_name]->get_auth_scope();

		$callback = generate_board_url() . "/ucp.{$this->php_ext}?{$query}";

		// Setup the credentials for the requests
		$credentials = new Credentials(
			$service_credentials['key'],
			$service_credentials['secret'],
			$callback
		);

		$service_factory = new ServiceFactory;

		// Allow providers to register a custom class or override the provider name
		if ($class = $this->service_providers[$service_name]->get_external_service_class())
		{
			if (class_exists($class))
			{
				try
				{
					$service_factory->registerService($provider, $class);
				}
				catch (\OAuth\Common\Exception\Exception $e)
				{
					throw new exception('AUTH_PROVIDER_OAUTH_ERROR_INVALID_SERVICE_TYPE');
				}
			}
			else
			{
				$provider = $class;
			}
		}

		$service = $service_factory->createService($provider, $credentials, $storage, $scopes);

		if (!$service)
		{
			throw new exception('AUTH_PROVIDER_OAUTH_ERROR_SERVICE_NOT_CREATED');
		}

		return $service;
	}

	/**
	 * Returns the service name for an OAuth provider name.
	 *
	 * @param string	$provider		The OAuth provider name
	 * @return string					The service name
	 */
	protected function get_service_name($provider)
	{
		if (strpos($provider, 'auth.provider.oauth.service.') !== 0)
		{
			$provider = 'auth.provider.oauth.service.' . utf8_strtolower($provider);
		}

		return $provider;
	}

	/**
	 * Returns the OAuth provider name from a service name.
	 *
	 * @param string	$service_name	The service name
	 * @return string					The OAuth provider name
	 */
	protected function get_provider($service_name)
	{
		return str_replace('auth.provider.oauth.service.', '', $service_name);
	}

	/**
	 * Returns the localized title for the OAuth provider.
	 *
	 * @param string	$provider		The OAuth provider name
	 * @return string					The OAuth provider title
	 */
	protected function get_provider_title($provider)
	{
		return $this->language->lang('AUTH_PROVIDER_OAUTH_SERVICE_' . utf8_strtoupper($provider));
	}

	/**
	 * Returns whether or not the authorization code is set.
	 *
	 * @param OAuth1Service|OAuth2Service	$service	The external OAuth service
	 * @return bool										Whether or not the authorization code is set in the URL
	 *                       							for the respective OAuth service's version
	 */
	protected function is_set_code($service)
	{
		switch ($service::OAUTH_VERSION)
		{
			case 1:
				return $this->request->is_set('oauth_token', \phpbb\request\request_interface::GET);

			case 2:
				return $this->request->is_set('code', \phpbb\request\request_interface::GET);

			default:
				return false;
		}
	}

	/**
	 * Sets a redirect to the authorization uri.
	 *
	 * @param OAuth1Service|OAuth2Service $service		The external OAuth service
	 * @return array|false								Array if an error occurred,
	 *                            						false on success
	 */
	protected function set_redirect($service)
	{
		$parameters = [];

		if ($service::OAUTH_VERSION === 1)
		{
			try
			{
				$token		= $service->requestRequestToken();
				$parameters	= ['oauth_token' => $token->getRequestToken()];
			}
			catch (\OAuth\Common\Http\Exception\TokenResponseException $e)
			{
				return [
					'status'		=> LOGIN_ERROR_EXTERNAL_AUTH,
					'error_msg'		=> $e->getMessage(),
					'user_row'		=> ['user_id' => ANONYMOUS],
				];
			}
		}

		redirect($service->getAuthorizationUri($parameters), false, true);

		return false;
	}
}