mirror of
				https://github.com/superseriousbusiness/gotosocial.git
				synced 2025-10-30 22:42:24 -05:00 
			
		
		
		
	[chore] Convert some settings / admin panel JS to TypeScript (#2247)
* initial conversion of STUFF to typescript * more stuff * update babel deps, include commonjs transform * update bundler & eslint configuration * eslint --fix * upgrade deps * update docs, build stuff, peripheral stuff --------- Co-authored-by: f0x <f0x@cthu.lu>
This commit is contained in:
		
					parent
					
						
							
								6e508830e1
							
						
					
				
			
			
				commit
				
					
						d173fcdfa3
					
				
			
		
					 84 changed files with 2365 additions and 1621 deletions
				
			
		
							
								
								
									
										204
									
								
								web/source/settings/lib/query/oauth/index.ts
									
										
									
									
									
										Normal file
									
								
							
							
						
						
									
										204
									
								
								web/source/settings/lib/query/oauth/index.ts
									
										
									
									
									
										Normal file
									
								
							|  | @ -0,0 +1,204 @@ | |||
| /* | ||||
| 	GoToSocial | ||||
| 	Copyright (C) GoToSocial Authors admin@gotosocial.org | ||||
| 	SPDX-License-Identifier: AGPL-3.0-or-later | ||||
| 
 | ||||
| 	This program is free software: you can redistribute it and/or modify | ||||
| 	it under the terms of the GNU Affero General Public License as published by | ||||
| 	the Free Software Foundation, either version 3 of the License, or | ||||
| 	(at your option) any later version. | ||||
| 
 | ||||
| 	This program is distributed in the hope that it will be useful, | ||||
| 	but WITHOUT ANY WARRANTY; without even the implied warranty of | ||||
| 	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the | ||||
| 	GNU Affero General Public License for more details. | ||||
| 
 | ||||
| 	You should have received a copy of the GNU Affero General Public License | ||||
| 	along with this program.  If not, see <http://www.gnu.org/licenses/>.
 | ||||
| */ | ||||
| 
 | ||||
| import type { FetchBaseQueryError } from '@reduxjs/toolkit/query'; | ||||
| 
 | ||||
| import { gtsApi } from "../gts-api"; | ||||
| import { | ||||
| 	setToken as oauthSetToken, | ||||
| 	remove as oauthRemove, | ||||
| 	authorize as oauthAuthorize, | ||||
| } from "../../../redux/oauth"; | ||||
| import { RootState } from '../../../redux/store'; | ||||
| 
 | ||||
| export interface OauthTokenRequestBody { | ||||
| 	client_id: string; | ||||
| 	client_secret: string; | ||||
| 	redirect_uri: string; | ||||
| 	grant_type: string; | ||||
| 	code: string; | ||||
| } | ||||
| 
 | ||||
| function getSettingsURL() { | ||||
| 	/* | ||||
| 		needed in case the settings interface isn't hosted at /settings but | ||||
| 		some subpath like /gotosocial/settings. Other parts of the code don't | ||||
| 		take this into account yet so mostly future-proofing. | ||||
| 
 | ||||
| 		 Also drops anything past /settings/, because authorization urls that are too long | ||||
| 		 get rejected by GTS. | ||||
| 	*/ | ||||
| 	let [pre, _past] = window.location.pathname.split("/settings"); | ||||
| 	return `${window.location.origin}${pre}/settings`; | ||||
| } | ||||
| 
 | ||||
| const SETTINGS_URL = (getSettingsURL()); | ||||
| 
 | ||||
| // Couple auth functions here require multiple requests as
 | ||||
| // part of an OAuth token 'flow'. To keep things simple for
 | ||||
| // callers of these query functions, the multiple requests
 | ||||
| // are chained within one query.
 | ||||
| //
 | ||||
| // https://redux-toolkit.js.org/rtk-query/usage/customizing-queries#performing-multiple-requests-with-a-single-query
 | ||||
| const extended = gtsApi.injectEndpoints({ | ||||
| 	endpoints: (builder) => ({ | ||||
| 		verifyCredentials: builder.query<any, void>({ | ||||
| 			providesTags: (_res, error) => | ||||
| 				error == undefined ? ["Auth"] : [], | ||||
| 			async queryFn(_arg, api, _extraOpts, fetchWithBQ) { | ||||
| 				const state = api.getState() as RootState; | ||||
| 				const oauthState = state.oauth; | ||||
| 
 | ||||
| 				// If we're not in the middle of an auth/callback,
 | ||||
| 				// we may already have an auth token, so just
 | ||||
| 				// return a standard verify_credentials query.
 | ||||
| 				if (oauthState.loginState != 'callback') { | ||||
| 					return fetchWithBQ({ | ||||
| 						url: `/api/v1/accounts/verify_credentials` | ||||
| 					}); | ||||
| 				} | ||||
| 
 | ||||
| 				// We're in the middle of an auth/callback flow.
 | ||||
| 				// Try to retrieve callback code from URL query.
 | ||||
| 				let urlParams = new URLSearchParams(window.location.search); | ||||
| 				let code = urlParams.get("code"); | ||||
| 				if (code == undefined) { | ||||
| 					return { | ||||
| 						error: { | ||||
| 							status: 400, | ||||
| 							statusText: 'Bad Request', | ||||
| 							data: {"error":"Waiting for callback, but no ?code= provided in url."}, | ||||
| 						}, | ||||
| 					}; | ||||
| 				} | ||||
| 				 | ||||
| 				// Retrieve app with which the
 | ||||
| 				// callback code was generated.
 | ||||
| 				let app = oauthState.app; | ||||
| 				if (app == undefined || app.client_id == undefined) { | ||||
| 					return { | ||||
| 						error: { | ||||
| 							status: 400, | ||||
| 							statusText: 'Bad Request', | ||||
| 							data: {"error":"No stored app registration data, can't finish login flow."}, | ||||
| 						}, | ||||
| 					}; | ||||
| 				} | ||||
| 				 | ||||
| 				// Use the provided code and app
 | ||||
| 				// secret to request an auth token.
 | ||||
| 				const tokenReqBody: OauthTokenRequestBody = { | ||||
| 					client_id: app.client_id, | ||||
| 					client_secret: app.client_secret, | ||||
| 					redirect_uri: SETTINGS_URL, | ||||
| 					grant_type: "authorization_code", | ||||
| 					code: code | ||||
| 				}; | ||||
| 
 | ||||
| 				const tokenResult = await fetchWithBQ({ | ||||
| 					method: "POST", | ||||
| 					url: "/oauth/token", | ||||
| 					body: tokenReqBody, | ||||
| 				}); | ||||
| 				if (tokenResult.error) { | ||||
| 					return { error: tokenResult.error as FetchBaseQueryError }; | ||||
| 				} | ||||
| 				 | ||||
| 				// Remove ?code= query param from
 | ||||
| 				// url, we don't want it anymore.
 | ||||
| 				window.history.replaceState({}, document.title, window.location.pathname); | ||||
| 				 | ||||
| 				// Store returned token in redux.
 | ||||
| 				api.dispatch(oauthSetToken(tokenResult.data)); | ||||
| 				 | ||||
| 				// We're now authed! So return
 | ||||
| 				// standard verify_credentials query.
 | ||||
| 				return fetchWithBQ({ | ||||
| 					url: `/api/v1/accounts/verify_credentials` | ||||
| 				}); | ||||
| 			} | ||||
| 		}), | ||||
| 
 | ||||
| 		authorizeFlow: builder.mutation({ | ||||
| 			async queryFn(formData, api, _extraOpts, fetchWithBQ) { | ||||
| 				const state = api.getState() as RootState; | ||||
| 				const oauthState = state.oauth; | ||||
| 
 | ||||
| 				let instanceUrl: string; | ||||
| 				if (!formData.instance.startsWith("http")) { | ||||
| 					formData.instance = `https://${formData.instance}`; | ||||
| 				} | ||||
| 
 | ||||
| 				instanceUrl = new URL(formData.instance).origin; | ||||
| 				if (oauthState?.instanceUrl == instanceUrl && oauthState.app) { | ||||
| 					return { data: oauthState.app }; | ||||
| 				} | ||||
| 				 | ||||
| 				const appResult = await fetchWithBQ({ | ||||
| 					method: "POST", | ||||
| 					baseUrl: instanceUrl, | ||||
| 					url: "/api/v1/apps", | ||||
| 					body: { | ||||
| 						client_name: "GoToSocial Settings", | ||||
| 						scopes: formData.scopes, | ||||
| 						redirect_uris: SETTINGS_URL, | ||||
| 						website: SETTINGS_URL | ||||
| 					} | ||||
| 				}); | ||||
| 				if (appResult.error) { | ||||
| 					return { error: appResult.error as FetchBaseQueryError }; | ||||
| 				} | ||||
| 
 | ||||
| 				let app = appResult.data as any; | ||||
| 
 | ||||
| 				app.scopes = formData.scopes; | ||||
| 				api.dispatch(oauthAuthorize({ | ||||
| 					instanceUrl: instanceUrl, | ||||
| 					app: app, | ||||
| 					loginState: "callback", | ||||
| 					expectingRedirect: true | ||||
| 				})); | ||||
| 
 | ||||
| 				let url = new URL(instanceUrl); | ||||
| 				url.pathname = "/oauth/authorize"; | ||||
| 				url.searchParams.set("client_id", app.client_id); | ||||
| 				url.searchParams.set("redirect_uri", SETTINGS_URL); | ||||
| 				url.searchParams.set("response_type", "code"); | ||||
| 				url.searchParams.set("scope", app.scopes); | ||||
| 				 | ||||
| 				let redirectURL = url.toString(); | ||||
| 				window.location.assign(redirectURL); | ||||
| 				return { data: null }; | ||||
| 			}, | ||||
| 		}), | ||||
| 		logout: builder.mutation({ | ||||
| 			queryFn: (_arg, api) => { | ||||
| 				api.dispatch(oauthRemove()); | ||||
| 				return { data: null }; | ||||
| 			}, | ||||
| 			invalidatesTags: ["Auth"] | ||||
| 		}) | ||||
| 	}) | ||||
| }); | ||||
| 
 | ||||
| export const { | ||||
| 	useVerifyCredentialsQuery, | ||||
| 	useAuthorizeFlowMutation, | ||||
| 	useLogoutMutation, | ||||
| } = extended; | ||||
		Loading…
	
	Add table
		Add a link
		
	
		Reference in a new issue