diff --git a/admin/schema_updates/2024-12-11-add-user-table.sql b/admin/schema_updates/2024-12-11-add-user-table.sql new file mode 100644 index 00000000..ac31b754 --- /dev/null +++ b/admin/schema_updates/2024-12-11-add-user-table.sql @@ -0,0 +1,18 @@ +BEGIN; + +CREATE TABLE "user" ( + id INTEGER GENERATED BY DEFAULT AS IDENTITY, + name TEXT NOT NULL, + password TEXT NOT NULL, + email TEXT UNIQUE, + unconfirmed_email TEXT, + email_confirmed_at TIMESTAMP WITH TIME ZONE, + member_since TIMESTAMP WITH TIME ZONE NOT NULL DEFAULT NOW(), + last_login_at TIMESTAMP WITH TIME ZONE, + last_updated TIMESTAMP WITH TIME ZONE, + deleted BOOLEAN +); + +ALTER TABLE "user" ADD CONSTRAINT user_pkey PRIMARY KEY (id); + +COMMIT; diff --git a/admin/schema_updates/2024-12-12-link-user-and-supporter-table.sql b/admin/schema_updates/2024-12-12-link-user-and-supporter-table.sql new file mode 100644 index 00000000..60ff53fe --- /dev/null +++ b/admin/schema_updates/2024-12-12-link-user-and-supporter-table.sql @@ -0,0 +1,10 @@ +BEGIN; + +ALTER TABLE supporter ADD COLUMN user_id INTEGER; +UPDATE supporter SET user_id = musicbrainz_row_id; + +ALTER TABLE supporter ADD CONSTRAINT supporter_user_id_fkey + FOREIGN KEY (user_id) REFERENCES "user" (id) + ON UPDATE CASCADE ON DELETE SET NULL; + +COMMIT; diff --git a/admin/schema_updates/2025-02-15-add-moderation-log.sql b/admin/schema_updates/2025-02-15-add-moderation-log.sql new file mode 100644 index 00000000..84936f60 --- /dev/null +++ b/admin/schema_updates/2025-02-15-add-moderation-log.sql @@ -0,0 +1,22 @@ +CREATE TYPE moderation_action_type AS ENUM ('block', 'unblock'); + +BEGIN; + +ALTER TABLE "user" ADD COLUMN is_blocked BOOLEAN NOT NULL DEFAULT FALSE; +CREATE TABLE moderation_log ( + id INTEGER GENERATED BY DEFAULT AS IDENTITY, + user_id INTEGER NOT NULL, + moderator_id INTEGER NOT NULL, + action moderation_action_type NOT NULL, + reason TEXT NOT NULL, + timestamp TIMESTAMP WITH TIME ZONE NOT NULL DEFAULT NOW() +); +ALTER TABLE moderation_log ADD CONSTRAINT moderation_log_pkey PRIMARY KEY (id); +ALTER TABLE moderation_log ADD CONSTRAINT moderation_log_user_id_fkey FOREIGN KEY (user_id) REFERENCES "user" (id); +ALTER TABLE moderation_log ADD CONSTRAINT moderation_log_moderator_id_fkey FOREIGN KEY (moderator_id) REFERENCES "user" (id); +CREATE INDEX moderation_log_user_id_idx ON moderation_log (user_id); + +ALTER TABLE "user" ADD COLUMN login_id UUID NOT NULL; +CREATE UNIQUE INDEX user_login_id_idx ON "user" (login_id); + +COMMIT; diff --git a/admin/schema_updates/2025-add-nonce-to-authorization-code.sql b/admin/schema_updates/2025-07-01-add-nonce-to-authorization-code.sql similarity index 100% rename from admin/schema_updates/2025-add-nonce-to-authorization-code.sql rename to admin/schema_updates/2025-07-01-add-nonce-to-authorization-code.sql diff --git a/admin/schema_updates/2025-09-18-add-moderation-action-types.sql b/admin/schema_updates/2025-09-18-add-moderation-action-types.sql new file mode 100644 index 00000000..373dea6c --- /dev/null +++ b/admin/schema_updates/2025-09-18-add-moderation-action-types.sql @@ -0,0 +1,2 @@ +ALTER TYPE moderation_action_type ADD VALUE 'comment'; +ALTER TYPE moderation_action_type ADD VALUE 'verify_email'; diff --git a/admin/sql/create_foreign_keys.sql b/admin/sql/create_foreign_keys.sql index b0fc6ca8..202215a7 100644 --- a/admin/sql/create_foreign_keys.sql +++ b/admin/sql/create_foreign_keys.sql @@ -5,6 +5,10 @@ ALTER TABLE token REFERENCES supporter (id) MATCH SIMPLE ON UPDATE CASCADE ON DELETE SET NULL; +ALTER TABLE supporter ADD CONSTRAINT supporter_user_id_fkey + FOREIGN KEY (user_id) REFERENCES "user" (id) + ON UPDATE CASCADE ON DELETE SET NULL; + ALTER TABLE supporter ADD CONSTRAINT supporter_tier_id_fkey FOREIGN KEY (tier_id) REFERENCES tier (id) MATCH SIMPLE @@ -17,7 +21,7 @@ ALTER TABLE dataset_supporter ALTER TABLE dataset_supporter ADD CONSTRAINT dataset_supporter_dataset_id_fkey FOREIGN KEY (dataset_id) - REFERENCES "dataset" (id) MATCH SIMPLE + REFERENCES dataset (id) MATCH SIMPLE ON UPDATE NO ACTION ON DELETE NO ACTION; ALTER TABLE token_log @@ -35,4 +39,14 @@ ALTER TABLE access_log REFERENCES token (value) MATCH SIMPLE ON UPDATE NO ACTION ON DELETE NO ACTION; +ALTER TABLE moderation_log + ADD CONSTRAINT moderation_log_user_id_fkey FOREIGN KEY (user_id) + REFERENCES "user" (id) MATCH SIMPLE + ON UPDATE CASCADE ON DELETE SET NULL; + +ALTER TABLE moderation_log + ADD CONSTRAINT moderation_log_moderator_id_fkey FOREIGN KEY (moderator_id) + REFERENCES "user" (id) MATCH SIMPLE + ON UPDATE CASCADE ON DELETE SET NULL; + COMMIT; diff --git a/admin/sql/create_indexes.sql b/admin/sql/create_indexes.sql index be997d2e..acd9b057 100644 --- a/admin/sql/create_indexes.sql +++ b/admin/sql/create_indexes.sql @@ -2,4 +2,6 @@ BEGIN; -- TODO: Add some, if needed. +CREATE INDEX moderation_log_user_id_idx ON moderation_log (user_id); + COMMIT; diff --git a/admin/sql/create_primary_keys.sql b/admin/sql/create_primary_keys.sql index 0cc42a1f..03ec1294 100644 --- a/admin/sql/create_primary_keys.sql +++ b/admin/sql/create_primary_keys.sql @@ -1,5 +1,7 @@ BEGIN; +ALTER TABLE "user" ADD CONSTRAINT user_pkey PRIMARY KEY (id); +ALTER TABLE moderation_log ADD CONSTRAINT moderation_log_pkey PRIMARY KEY (id); ALTER TABLE tier ADD CONSTRAINT tier_pkey PRIMARY KEY (id); ALTER TABLE supporter ADD CONSTRAINT supporter_pkey PRIMARY KEY (id); ALTER TABLE token ADD CONSTRAINT token_pkey PRIMARY KEY (value); diff --git a/admin/sql/create_tables.sql b/admin/sql/create_tables.sql index fbdbba9c..5cf8ccb5 100644 --- a/admin/sql/create_tables.sql +++ b/admin/sql/create_tables.sql @@ -1,5 +1,29 @@ BEGIN; +CREATE TABLE "user" ( + id INTEGER GENERATED BY DEFAULT AS IDENTITY, + login_id UUID NOT NULL, + name TEXT NOT NULL, + password TEXT NOT NULL, + email TEXT UNIQUE, + unconfirmed_email TEXT, + email_confirmed_at TIMESTAMP WITH TIME ZONE, + member_since TIMESTAMP WITH TIME ZONE NOT NULL DEFAULT NOW(), + last_login_at TIMESTAMP WITH TIME ZONE, + last_updated TIMESTAMP WITH TIME ZONE, + deleted BOOLEAN NOT NULL DEFAULT FALSE, + is_blocked BOOLEAN NOT NULL DEFAULT FALSE +); + +CREATE TABLE moderation_log ( + id INTEGER GENERATED BY DEFAULT AS IDENTITY, + user_id INTEGER NOT NULL, + moderator_id INTEGER NOT NULL, + action moderation_action_type NOT NULL, + reason TEXT NOT NULL, + timestamp TIMESTAMP WITH TIME ZONE NOT NULL DEFAULT NOW() +); + CREATE TABLE tier ( id SERIAL NOT NULL, -- PK name CHARACTER VARYING NOT NULL, @@ -20,12 +44,10 @@ CREATE TABLE dataset ( CREATE TABLE supporter ( id SERIAL NOT NULL, -- PK is_commercial BOOLEAN NOT NULL, - musicbrainz_id CHARACTER VARYING UNIQUE, - musicbrainz_row_id INTEGER UNIQUE, + user_id INTEGER UNIQUE, created TIMESTAMP WITH TIME ZONE, state state_types NOT NULL, contact_name CHARACTER VARYING NOT NULL, - contact_email CHARACTER VARYING NOT NULL, data_usage_desc TEXT, org_name CHARACTER VARYING, logo_filename CHARACTER VARYING, diff --git a/admin/sql/create_types.sql b/admin/sql/create_types.sql index 877be599..a60cd510 100644 --- a/admin/sql/create_types.sql +++ b/admin/sql/create_types.sql @@ -1,3 +1,7 @@ +BEGIN; + +CREATE TYPE moderation_action_type AS ENUM ('block', 'unblock', 'comment'); + CREATE TYPE payment_method_types AS ENUM ( 'stripe', 'paypal', @@ -29,3 +33,5 @@ CREATE TYPE dataset_project_type AS ENUM ( 'listenbrainz', 'critiquebrainz' ); + +COMMIT; diff --git a/admin/sql/drop_tables.sql b/admin/sql/drop_tables.sql index edad1384..1946a2ce 100644 --- a/admin/sql/drop_tables.sql +++ b/admin/sql/drop_tables.sql @@ -1,10 +1,12 @@ BEGIN; +DROP TABLE IF EXISTS "user" CASCADE; DROP TABLE IF EXISTS payment CASCADE; DROP TABLE IF EXISTS oauth_grant CASCADE; DROP TABLE IF EXISTS oauth_token CASCADE; DROP TABLE IF EXISTS oauth_client CASCADE; DROP TABLE IF EXISTS access_log CASCADE; +DROP TABLE IF EXISTS moderation_log CASCADE; DROP TABLE IF EXISTS token_log CASCADE; DROP TABLE IF EXISTS token CASCADE; DROP TABLE IF EXISTS supporter CASCADE; diff --git a/admin/sql/oauth/create_tables.sql b/admin/sql/oauth/create_tables.sql index 32beab33..133f7034 100644 --- a/admin/sql/oauth/create_tables.sql +++ b/admin/sql/oauth/create_tables.sql @@ -1,3 +1,5 @@ +BEGIN; + CREATE schema oauth; CREATE TABLE oauth.scope ( @@ -109,3 +111,5 @@ CREATE TABLE oauth.l_code_scope ( FOREIGN KEY(code_id) REFERENCES oauth.code (id) ON DELETE CASCADE, FOREIGN KEY(scope_id) REFERENCES oauth.scope (id) ON DELETE CASCADE ); + +COMMIT; diff --git a/config.py.example b/config.py.example index 01c94cd3..2c541193 100644 --- a/config.py.example +++ b/config.py.example @@ -1,9 +1,19 @@ +from datetime import timedelta + # CUSTOM CONFIGURATION DEBUG = True # set to False in production mode SECRET_KEY = "CHANGE_THIS" +EMAIL_VERIFICATION_SECRET_KEY = "CHANGE THIS" +EMAIL_VERIFICATION_EXPIRY = timedelta(hours=24) +EMAIL_RESET_PASSWORD_EXPIRY = timedelta(hours=24) + +# Bcrypt +BCRYPT_HASH_PREFIX = "2a" +BCRYPT_LOG_ROUNDS = 12 + # DATABASE SQLALCHEMY_DATABASE_URI = "postgresql://metabrainz:metabrainz@meb_db:5432/metabrainz" SQLALCHEMY_MUSICBRAINZ_URI = "" diff --git a/consul_config.py.ctmpl b/consul_config.py.ctmpl index 766e7e92..66039627 100644 --- a/consul_config.py.ctmpl +++ b/consul_config.py.ctmpl @@ -10,9 +10,19 @@ {{- end -}} {{- end -}} +from datetime import timedelta + SECRET_KEY = '''{{template "KEY" "secret_key"}}''' DEBUG = False +EMAIL_VERIFICATION_SECRET_KEY = '''{{template "KEY" "email_verification_secret_key"}}''' +EMAIL_VERIFICATION_EXPIRY = timedelta(hours=24) +EMAIL_RESET_PASSWORD_EXPIRY = timedelta(hours=24) + +# Bcrypt +BCRYPT_HASH_PREFIX = "2a" +BCRYPT_LOG_ROUNDS = 12 + {{if service "pgbouncer-master"}} {{with index (service "pgbouncer-master") 0}} SQLALCHEMY_DATABASE_URI = "postgresql://{{template "KEY" "postgresql/username"}}:{{template "KEY" "postgresql/password"}}@{{.Address}}:{{.Port}}/{{template "KEY" "postgresql/db_name"}}" diff --git a/docker/docker-compose.dev.yml b/docker/docker-compose.dev.yml index 8b3a1677..ddf57d3c 100644 --- a/docker/docker-compose.dev.yml +++ b/docker/docker-compose.dev.yml @@ -9,7 +9,9 @@ services: context: .. dockerfile: Dockerfile target: metabrainz-dev - command: python manage.py runserver -h 0.0.0.0 -p 8000 + command: flask run --debug -h 0.0.0.0 -p 8000 + environment: + FLASK_APP: "metabrainz:create_app()" volumes: - ../data/replication_packets:/data/replication_packets - ../data/json_dumps:/data/json_dumps diff --git a/frontend/css/auth-page.less b/frontend/css/auth-page.less new file mode 100644 index 00000000..331a8971 --- /dev/null +++ b/frontend/css/auth-page.less @@ -0,0 +1,107 @@ +#auth-page { + font-style: normal; + font-weight: 400; + min-height: 500px; + background: linear-gradient(90deg, #3b9766 0%, #ffa500 100%); + margin: 0 -1em; + padding: 2em; + + .form-label { + font-weight: normal; + } + .label-with-link { + display: flex; + justify-content: space-between; + width: 100%; + label { + flex-shrink: 0; + } + } + .form-label-link { + text-align: right; + } + + .auth-page-container { + max-width: 600px; + margin-left: auto; + margin-right: auto; + } + .auth-card-container { + background: #e7e7e7; + box-shadow: 0px 4px 4px rgba(0, 0, 0, 0.2); + border-radius: 3px; + } + .auth-card { + h1, + h2, + h3, + h4, + h5, + h6 { + font-weight: bold; + } + background: #ffffff; + box-shadow: 0px 4px 4px rgba(0, 0, 0, 0.2); + padding: 1rem 6rem; + border-radius: 3px; + @media screen and (max-width: @screen-xs-max) { + padding: 1rem 3rem; + } + } + .auth-card-bottom { + display: flex; + align-items: center; + justify-content: space-between; + } + .auth-card-footer { + display: flex; + flex-wrap: wrap; + justify-content: space-between; + padding: 1rem; + font-size: 1.3rem; + line-height: 1.6rem; + color: #808080; + } + .main-action-button { + display: block; + font-size: 1.1em; + margin: 1em auto; + } + .modal-content { + padding: 1.5em; + } +} + +#conditions-modal { + font-size: initial; +} +@icon-pill-size: 50px; +@icon-logo-size: 40px; +@icon-pill-padding: 8px; +.icon-pills { + display: flex; + justify-content: space-evenly; + margin-bottom: 2rem; + .icon-pill { + background: #d9d9d9; + box-shadow: 0px 4px 4px rgba(0, 0, 0, 0.2); + text-align: center; + width: @icon-pill-size; + height: @icon-pill-size; + border-radius: @icon-pill-size; + padding: @icon-pill-padding; + display: flex; + align-items: center; + justify-content: flex-start; + overflow: hidden; + transition: width 0.42s; + &:hover { + width: 160px; // Fallback + width: calc(attr(data-logo-width px) + @icon-pill-padding * 2); + } + img { + height: @icon-logo-size; + max-width: unset; + } + } +} diff --git a/frontend/css/main.less b/frontend/css/main.less index 0d642ed6..56c47162 100644 --- a/frontend/css/main.less +++ b/frontend/css/main.less @@ -1,5 +1,6 @@ @import "theme/theme.less"; @import "carousel.less"; +@import "auth-page.less"; // fixme: need to make it configurable for production and development and meb.org container and oauth container @icon-font-path:"/static/fonts/"; diff --git a/frontend/css/theme/boostrap/boostrap.less b/frontend/css/theme/boostrap/boostrap.less index c55b2fd9..8a7204e0 100644 --- a/frontend/css/theme/boostrap/boostrap.less +++ b/frontend/css/theme/boostrap/boostrap.less @@ -40,7 +40,7 @@ @import "panels.less"; //@import "responsive-embed.less"; @import "wells.less"; -//@import "close.less"; +@import "close.less"; // Components w/ JavaScript @import "modals.less"; diff --git a/frontend/img/logos/listenbrainz.svg b/frontend/img/logos/listenbrainz.svg index 09454870..631b161b 100644 --- a/frontend/img/logos/listenbrainz.svg +++ b/frontend/img/logos/listenbrainz.svg @@ -1 +1,38 @@ - \ No newline at end of file + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/frontend/js/src/Profile.tsx b/frontend/js/src/Profile.tsx new file mode 100644 index 00000000..41576090 --- /dev/null +++ b/frontend/js/src/Profile.tsx @@ -0,0 +1,372 @@ +import React, { JSX, useCallback, useState } from "react"; +import { createRoot } from "react-dom/client"; +import { getPageProps } from "./utils"; + +type ProfileProps = { + user: User; + csrf_token?: string; +}; + +type EmailProps = { + label: string; + is_email_confirmed: boolean; + email: string; + csrf_token?: string; +}; + +function Email({ + label, + is_email_confirmed, + email, + csrf_token, +}: EmailProps): JSX.Element { + return ( + <> + {label}: {email}{" "} + {is_email_confirmed ? ( + + Verified + + ) : ( + <> + + Unverified + +
+ + +
+ + )} +
+ + ); +} + +function SupporterProfile({ user, csrf_token }: ProfileProps) { + const { email, is_email_confirmed, supporter } = user; + const { + is_commercial, + tier, + state, + contact_name, + org_name, + website_url, + api_url, + datasets, + good_standing, + token, + } = supporter!!; + const [currentToken, setCurrentToken] = useState(token); + + const regenerateToken = useCallback(async () => { + if ( + !currentToken || + // eslint-disable-next-line no-alert + window.confirm( + "Are you sure you want to generate new access token? Current token will be revoked!" + ) + ) { + const response = await fetch("/supporters/profile/regenerate-token", { + method: "POST", + }); + if (!response.ok) { + // eslint-disable-next-line no-alert + window.alert("Failed to generate new access token!"); + } else { + const data = await response.json(); + setCurrentToken(data.token); + } + } + }, [currentToken]); + + let applicationState; + if (state === "rejected") { + applicationState = ( + <> +

+ + Your application for using the Live Data Feed has been rejected. + +

+

+ You do not have permission to use our data in a public commercial + product. +

+ + ); + } else if (state === "pending") { + applicationState = ( + <> +

+ Your application for using the Live Data Feed is still pending. +

+

+ You may use our data and APIs for evaluation/development purposes + while your application is pending. +

+ + ); + } else if (state === "waiting") { + applicationState = ( + <> +

+ + Your application for using the Live Data Feed is waiting to finalize + our support agreement. + +

+

+ You may use our data and APIs for evaluation and development purposes, + but you may not use the data in a public commercial product. Once you + are nearing the public release of a product that contains our data, + please + contact us again to finalize our support + agreement. +

+ + ); + } else if (!good_standing) { + applicationState = ( + <> +

+ Your use of the Live Data Feed is pending suspension. +

+

+ Your account is in bad standing, which means that you are more than 60 + days behind in support payments. If you think this is a mistake, + please contact us. +

+ + ); + } else { + applicationState =

Unknown. :(

; + } + + let stateClass; + if (state === "active") { + stateClass = "text-success"; + } else if (state === "rejected") { + stateClass = "text-danger"; + } else if (state === "pending") { + stateClass = "text-primary"; + } else { + stateClass = "text-warning"; + } + return ( + <> +

+ Type: {is_commercial ? "Commercial" : "Non-commercial"} +
+ {is_commercial && ( + <> + Tier: {tier.name} +
+ + )} + State: + {state.toUpperCase()} +

+ {!is_commercial && ( +

+ NOTE: If you would like to change your account from non-commercial to + commercial, please + contact us. +

+ )} +
+ {is_commercial && ( +
+

Organization information

+

+ Name:{" "} + {org_name || Unspecified} +
+ Website URL:{" "} + {website_url || Unspecified} +
+ API URL:{" "} + {api_url || Unspecified} +
+

+

+ Please contact us if you wish for us to + update this information. +

+
+ )} +
+

Contact information

+

+ Contact Name: {contact_name} +
+ + {!is_commercial && ( + <> + Datasets used:{" "} + {datasets.map((d) => d.name).join(", ")} +
+ + )} +

+

+ + {is_commercial + ? "Edit contact information" + : "Edit datasets/contact information"} + +

+
+
+ {is_commercial && + ((state === "active" || state === "limited") && good_standing ? ( + <> +

Data use permission granted

+
+

+ Your support agreement has been completed -- thank you! +

+

+ You have permission to use any of the data published by the + MetaBrainz Foundation. This includes data dumps released under a + Creative Commons non-commercial license. Thank you for your + support! +

+

+ Note 1: If your support falls behind by more than 60 days, this + permission may be withdrawn. You can always check your current + permission status on this page. +

+

+ Note 2: The IP addresses from which replication packets for the + Live Data Feed are downloaded are logged. +

+
+ + ) : ( + <> +

Limited/no data use permission granted

+
{applicationState}
+ + ))} + {(state === "active" || state === "limited") && good_standing && ( + <> +

Data Download

+
+ {!is_commercial && ( +

+ Thank you for registering with us -- we really appreciate it! +

+ )} +

Please proceed to our download page to download our datasets:

+

+ + Download Datasets + +

+
+ + )} + {state === "active" && ( + <> +

Live Data Feed Access token

+

+ This access token should be considered private. Don't check + this token into any publicly visible version control systems and + similar places. If the token has been exposed, you should + immediately immediately generate a new one! When you generate a new + token, your token is revoked. +

+
+

+

+ {currentToken || "[ there is no valid token currently ]"} +
+

+

+ +

+
+

+ See the API documentation for more information. +

+ + )} + + ); +} + +function UserProfile({ user, csrf_token }: ProfileProps): JSX.Element { + const { name, is_email_confirmed, email } = user; + return ( + <> +

Contact information

+

+ Name: {name} +
+ +

+

+ + Edit information + +

+ + ); +} + +function Profile({ user, csrf_token }: ProfileProps): JSX.Element { + return ( + <> +

Your Profile

+ {user.supporter ? ( + + ) : ( + + )} + + ); +} + +document.addEventListener("DOMContentLoaded", () => { + const { domContainer, reactProps } = getPageProps(); + const { user, csrf_token } = reactProps; + + const renderRoot = createRoot(domContainer!); + renderRoot.render(); +}); diff --git a/frontend/js/src/forms/ConditionsModal.tsx b/frontend/js/src/forms/ConditionsModal.tsx new file mode 100644 index 00000000..d99573c2 --- /dev/null +++ b/frontend/js/src/forms/ConditionsModal.tsx @@ -0,0 +1,82 @@ +import React from "react"; +import { ProjectIconPills } from "./utils"; + +export default function ConditionsModal() { + return ( +
+
+
+
+ +

Privacy policy

+
+
Licensing
+

+ Any contributions you make to MusicBrainz will be released into the + Public Domain and/or licensed under a Creative Commons by-nc-sa + license. Furthermore, you give the MetaBrainz Foundation the right + to license this data for commercial use. +
+ Please read our{" "} + + {" "} + license page + {" "} + for more details. +

+
Privacy
+

+ MusicBrainz strongly believes in the privacy of its users. Any + personal information you choose to provide will not be sold or + shared with anyone else. +
+ Please read our{" "} + + privacy policy + {" "} + for more details. +

+
GDPR compliance
+

+ You may remove your personal information from our services anytime + by deleting your account. +
+ Please read our{" "} + + GDPR compliance statement + {" "} + for more details. +

+
+ +

+ Creating an account on MetaBrainz will give you access to all of our + projects, such as MusicBrainz, ListenBrainz, BookBrainz, and more. +
+ We do not automatically create accounts for these services when you + create a MetaBrainz account, but you will be just a few clicks away + from doing so. +

+ +
+
+
+ ); +} diff --git a/frontend/js/src/forms/LoginUser.tsx b/frontend/js/src/forms/LoginUser.tsx new file mode 100644 index 00000000..528ca912 --- /dev/null +++ b/frontend/js/src/forms/LoginUser.tsx @@ -0,0 +1,126 @@ +import { Formik } from "formik"; +import React, { JSX } from "react"; +import { createRoot } from "react-dom/client"; +import * as Yup from "yup"; +import { getPageProps } from "../utils"; +import { + AuthCardCheckboxInput, + AuthCardContainer, + AuthCardPasswordInput, + AuthCardTextInput, +} from "./utils"; + +type LoginUserProps = { + csrf_token: string; + initial_form_data: any; + initial_errors: any; +}; + +function LoginUser({ + csrf_token, + initial_form_data, + initial_errors, +}: LoginUserProps): JSX.Element { + return ( + +
+
+

Welcome back!

+ {}} + > + {({ errors }) => ( +
+ + Forgot username? + + } + type="text" + name="username" + id="username" + required + /> + + + Forgot password? + + } + name="password" + id="password" + required + /> + + + + + +
+
+ +
+ {errors.csrf_token && ( +
+ {errors.csrf_token} +
+ )} +
+ + + + )} +
+
+ Don't have an account? Sign up +
+
+
+ + ); +} + +document.addEventListener("DOMContentLoaded", () => { + const { domContainer, reactProps } = getPageProps(); + const { csrf_token, initial_form_data, initial_errors } = reactProps; + + const renderRoot = createRoot(domContainer!); + renderRoot.render( + + ); +}); diff --git a/frontend/js/src/forms/LostPassword.tsx b/frontend/js/src/forms/LostPassword.tsx new file mode 100644 index 00000000..3116b3d2 --- /dev/null +++ b/frontend/js/src/forms/LostPassword.tsx @@ -0,0 +1,98 @@ +import { Formik } from "formik"; +import React, { JSX } from "react"; +import { createRoot } from "react-dom/client"; +import * as Yup from "yup"; +import { getPageProps } from "../utils"; +import { AuthCardContainer, AuthCardTextInput } from "./utils"; + +type LostPasswordProps = { + csrf_token: string; + initial_form_data: any; + initial_errors: any; +}; + +function LostPassword({ + csrf_token, + initial_form_data, + initial_errors, +}: LostPasswordProps): JSX.Element { + return ( + +
+
+

Forgot your password?

+ {}} + > + {({ errors }) => ( +
+ + + + +
+
+ +
+ {errors.csrf_token && ( +
+ {errors.csrf_token} +
+ )} +
+ + + )} +
+
+
+ + ); +} + +document.addEventListener("DOMContentLoaded", () => { + const { domContainer, reactProps } = getPageProps(); + const { csrf_token, initial_form_data, initial_errors } = reactProps; + + const renderRoot = createRoot(domContainer!); + renderRoot.render( + + ); +}); diff --git a/frontend/js/src/forms/LostUsername.tsx b/frontend/js/src/forms/LostUsername.tsx new file mode 100644 index 00000000..b65f4b02 --- /dev/null +++ b/frontend/js/src/forms/LostUsername.tsx @@ -0,0 +1,89 @@ +import { Formik } from "formik"; +import React, { JSX } from "react"; +import { createRoot } from "react-dom/client"; +import * as Yup from "yup"; +import { getPageProps } from "../utils"; +import { AuthCardContainer, AuthCardTextInput } from "./utils"; + +type LostUsernameProps = { + csrf_token: string; + initial_form_data: any; + initial_errors: any; +}; + +function LostUsername({ + csrf_token, + initial_form_data, + initial_errors, +}: LostUsernameProps): JSX.Element { + return ( + +
+
+

Forgot your username?

+ {}} + > + {({ errors }) => ( +
+ + +
+
+ +
+ {errors.csrf_token && ( +
+ {errors.csrf_token} +
+ )} +
+ + + + )} +
+
+
+ + ); +} + +document.addEventListener("DOMContentLoaded", () => { + const { domContainer, reactProps } = getPageProps(); + const { csrf_token, initial_form_data, initial_errors } = reactProps; + + const renderRoot = createRoot(domContainer!); + renderRoot.render( + + ); +}); diff --git a/frontend/js/src/forms/SupporterProfileEdit.tsx b/frontend/js/src/forms/ProfileEdit.tsx similarity index 62% rename from frontend/js/src/forms/SupporterProfileEdit.tsx rename to frontend/js/src/forms/ProfileEdit.tsx index b3ed8b53..7d916e50 100644 --- a/frontend/js/src/forms/SupporterProfileEdit.tsx +++ b/frontend/js/src/forms/ProfileEdit.tsx @@ -3,44 +3,46 @@ import React, { JSX } from "react"; import { createRoot } from "react-dom/client"; import * as Yup from "yup"; import { getPageProps } from "../utils"; -import { Dataset, DatasetsInput, TextInput } from "./utils"; +import { DatasetsInput, TextInput } from "./utils"; -type SupporterProfileEditProps = { +type ProfileEditProps = { datasets: Dataset[]; + is_supporter: boolean; is_commercial: boolean; csrf_token: string; initial_form_data: any; initial_errors: any; }; -function SupporterProfileEdit({ +function ProfileEdit({ datasets, is_commercial, + is_supporter, csrf_token, initial_form_data, initial_errors, -}: SupporterProfileEditProps): JSX.Element { +}: ProfileEditProps): JSX.Element { + const schema: any = { + email: Yup.string().email().required("Email address is required!"), + }; + if (is_supporter) { + schema.contact_name = Yup.string().required("Contact name is required!"); + } return ( <>

Your Profile

Edit contact information

- x.toString()) ?? [], - contact_name: initial_form_data.contact_name ?? "", - contact_email: initial_form_data.contact_email ?? "", + contact_name: initial_form_data?.contact_name ?? "", + email: initial_form_data?.email ?? "", csrf_token, }} initialErrors={initial_errors} initialTouched={initial_errors} - validationSchema={Yup.object({ - contact_name: Yup.string().required("Contact name is required!"), - contact_email: Yup.string() - .email() - .required("Email address is required!"), - })} + validationSchema={Yup.object(schema)} onSubmit={() => {}} > {({ errors }) => ( @@ -59,24 +61,35 @@ function SupporterProfileEdit({ )} - + {is_supporter && ( + + )}
- {!is_commercial && } + {is_supporter && !is_commercial && ( +
+
+ Datasets +
+
+ +
+
+ )}
@@ -93,10 +106,11 @@ function SupporterProfileEdit({ } document.addEventListener("DOMContentLoaded", () => { - const { domContainer, reactProps, globalProps } = getPageProps(); + const { domContainer, reactProps } = getPageProps(); const { datasets, is_commercial, + is_supporter, csrf_token, initial_form_data, initial_errors, @@ -104,8 +118,9 @@ document.addEventListener("DOMContentLoaded", () => { const renderRoot = createRoot(domContainer!); renderRoot.render( - +
+
+

Reset your password

+ {}} + > + {({ errors }) => ( +
+
+
+ +
+ {errors.csrf_token && ( +
+ {errors.csrf_token} +
+ )} +
+ + + + + + + + )} +
+
+
+ + ); +} + +document.addEventListener("DOMContentLoaded", () => { + const { domContainer, reactProps } = getPageProps(); + const { csrf_token, initial_errors } = reactProps; + + const renderRoot = createRoot(domContainer!); + renderRoot.render( + + ); +}); diff --git a/frontend/js/src/forms/SignupCommercial.tsx b/frontend/js/src/forms/SignupCommercial.tsx index 0c9e0ffc..c41bebc8 100644 --- a/frontend/js/src/forms/SignupCommercial.tsx +++ b/frontend/js/src/forms/SignupCommercial.tsx @@ -4,7 +4,13 @@ import { createRoot } from "react-dom/client"; import ReCAPTCHA from "react-google-recaptcha"; import * as Yup from "yup"; import { getPageProps } from "../utils"; -import { CheckboxInput, TextAreaInput, TextInput } from "./utils"; +import { + AuthCardContainer, + AuthCardPasswordInput, + AuthCardTextInput, + CheckboxInput, + TextAreaInput, +} from "./utils"; type AmountPledgedFieldProps = JSX.IntrinsicElements["input"] & FieldConfig & { @@ -18,11 +24,11 @@ function AmountPledgedField({ tier, ...props }: AmountPledgedFieldProps) { const [field, meta] = useField(props); return (
-
+ + ); +} + +document.addEventListener("DOMContentLoaded", () => { + const { domContainer, reactProps } = getPageProps(); + const { recaptcha_site_key, csrf_token, initial_form_data, initial_errors } = + reactProps; + + const renderRoot = createRoot(domContainer!); + renderRoot.render( + + ); +}); diff --git a/frontend/js/src/forms/UserProfileEdit.tsx b/frontend/js/src/forms/UserProfileEdit.tsx new file mode 100644 index 00000000..82c981f9 --- /dev/null +++ b/frontend/js/src/forms/UserProfileEdit.tsx @@ -0,0 +1,86 @@ +import { Formik } from "formik"; +import React, { JSX } from "react"; +import { createRoot } from "react-dom/client"; +import * as Yup from "yup"; +import { getPageProps } from "../utils"; +import { TextInput } from "./utils"; + +type UserProfileEditProps = { + csrf_token: string; + initial_form_data: any; + initial_errors: any; +}; + +function UserProfileEdit({ + csrf_token, + initial_form_data, + initial_errors, +}: UserProfileEditProps): JSX.Element { + return ( + <> +

Your Profile

+

Edit contact information

+ + {}} + > + {({ errors }) => ( +
+
+
+ +
+ {errors.csrf_token && ( +
{errors.csrf_token}
+ )} +
+ + + +
+
+ +
+
+ + )} +
+ + ); +} + +document.addEventListener("DOMContentLoaded", () => { + const { domContainer, reactProps } = getPageProps(); + const { csrf_token, initial_form_data, initial_errors } = reactProps; + + const renderRoot = createRoot(domContainer!); + renderRoot.render( + + ); +}); diff --git a/frontend/js/src/forms/utils.tsx b/frontend/js/src/forms/utils.tsx index 499717bd..d0da0dbc 100644 --- a/frontend/js/src/forms/utils.tsx +++ b/frontend/js/src/forms/utils.tsx @@ -8,8 +8,9 @@ export type TextInputProps = JSX.IntrinsicElements["input"] & export function TextInput({ label, children, ...props }: TextInputProps) { const [field, meta] = useField(props); + const hasError = meta.touched && meta.error; return ( -
+
@@ -17,11 +18,8 @@ export function TextInput({ label, children, ...props }: TextInputProps) {
{children} - {meta.touched && meta.error ? ( -
+ {hasError ? ( +
{meta.error}
) : null} @@ -40,22 +38,16 @@ export function TextAreaInput({ ...props }: TextAreaInputProps) { const [field, meta] = useField(props); + const hasError = meta.touched && meta.error; return ( -
-
+
+
+
+
+ + +
+
+

Moderation History

+
+
+ {% if model.moderation_logs %} +
+ + + + + + + + + + + {% for log in model.moderation_logs %} + + + + + + + {% endfor %} + +
DateActionModeratorReason
{{ log.timestamp.strftime('%Y-%m-%d %H:%M:%S') }} + + {{ log.action }} + + {{ log.moderator.name }}{{ log.reason }}
+
+ {% else %} +

No moderation history found.

+ {% endif %} +
+
+ +{% endblock %} \ No newline at end of file diff --git a/metabrainz/templates/admin/users/index.html b/metabrainz/templates/admin/users/index.html new file mode 100644 index 00000000..1d098248 --- /dev/null +++ b/metabrainz/templates/admin/users/index.html @@ -0,0 +1,28 @@ +{% extends "admin/model/list.html" %} + +{% block list_row %} + + {{ row.id }} + {{ row.name }} + + {{ row.get_email_any() }} + + {{ 'Confirmed' if row.is_email_confirmed() else 'Unconfirmed' }} + + + {{ row.member_since.strftime('%Y-%m-%d %H:%M:%S') }} + + + {{ 'Blocked' if row.is_blocked else 'Active' }} + + + + View Details + + +{% endblock %} + +{% block empty_list_message %} +

No users found.

+{% endblock %} diff --git a/metabrainz/templates/api/info.html b/metabrainz/templates/api/info.html index 5738ba0f..35e07cad 100644 --- a/metabrainz/templates/api/info.html +++ b/metabrainz/templates/api/info.html @@ -9,7 +9,7 @@

{{ _('MetaBrainz API') }}

{{ _('All endpoints require an access token which you can get from your - profile page.', profile_url=url_for('supporters.profile')) }} + profile page.', profile_url=url_for('index.profile')) }}

{{ _('MusicBrainz Live Data Feed') }}

diff --git a/metabrainz/templates/base.html b/metabrainz/templates/base.html index 0a8489a1..dd9eba0f 100644 --- a/metabrainz/templates/base.html +++ b/metabrainz/templates/base.html @@ -70,11 +70,11 @@
{{ _('Supporters') }}
diff --git a/metabrainz/templates/email/supporter-commercial-welcome-email-address-verification.txt b/metabrainz/templates/email/supporter-commercial-welcome-email-address-verification.txt new file mode 100644 index 00000000..5dc6bcd9 --- /dev/null +++ b/metabrainz/templates/email/supporter-commercial-welcome-email-address-verification.txt @@ -0,0 +1,20 @@ +Dear {{ username }}, + +Thank you for signing up! + +Before we can review your application, we request you to verify your MetaBrainz account. Please +click on the link below to verify your email address: + +{{ verification_link }} + +If clicking the link above doesn't work, please copy and paste the URL in a new browser window instead. + +Once your email is verified, we will start reviewing your application. We will send you updates via email. +Please know that you may use our APIs and static data dumps for evaluation purposes while your application +is pending. You do not need any API keys to do this. + +This email was triggered by a request from the IP address [{{ ip }}]. + +Thanks for using MetaBrainz! + +-- The MetaBrainz Team diff --git a/metabrainz/templates/email/supporter-noncommercial-welcome-email-address-verification.txt b/metabrainz/templates/email/supporter-noncommercial-welcome-email-address-verification.txt new file mode 100644 index 00000000..0be9808f --- /dev/null +++ b/metabrainz/templates/email/supporter-noncommercial-welcome-email-address-verification.txt @@ -0,0 +1,17 @@ +Dear {{ username }}, + +Thank you for signing up! + +We request you to verify your MetaBrainz account. Please click on the link below to verify your email address: + +{{ verification_link }} + +If clicking the link above doesn't work, please copy and paste the URL in a new browser window instead. + +Once your email is verified, you can generate an access token for the MetaBrainz API on your profile page. + +This email was triggered by a request from the IP address [{{ ip }}]. + +Thanks for using MetaBrainz! + +-- The MetaBrainz Team diff --git a/metabrainz/templates/email/user-email-address-verification.txt b/metabrainz/templates/email/user-email-address-verification.txt new file mode 100644 index 00000000..38006a7c --- /dev/null +++ b/metabrainz/templates/email/user-email-address-verification.txt @@ -0,0 +1,15 @@ +Hello {{ username }}, + +This is a verification email for your MetaBrainz account. Please click +on the link below to verify your email address: + +{{ verification_link }} + +If clicking the link above doesn't work, please copy and paste the URL in a +new browser window instead. + +This email was triggered by a request from the IP address [{{ ip }}]. + +Thanks for using MetaBrainz! + +-- The MetaBrainz Team diff --git a/metabrainz/templates/email/user-forgot-username.txt b/metabrainz/templates/email/user-forgot-username.txt new file mode 100644 index 00000000..1516dcb3 --- /dev/null +++ b/metabrainz/templates/email/user-forgot-username.txt @@ -0,0 +1,13 @@ +Someone, probably you, asked to look up the username of the +MetaBrainz account associated with this email address. + +Your MetaBrainz username is: {{ username }} + +If you have also forgotten your password, use this username and your email address +to reset your password here - {{ forgot_password_link }} + +If you didn't initiate this request and feel that you've received this email in +error, don't worry, you don't need to take any further action and can safely +disregard this email. + +-- The MetaBrainz Team diff --git a/metabrainz/templates/email/user-password-reset.txt b/metabrainz/templates/email/user-password-reset.txt new file mode 100644 index 00000000..94d37d81 --- /dev/null +++ b/metabrainz/templates/email/user-password-reset.txt @@ -0,0 +1,17 @@ +Someone, probably you, asked that your MetaBrainz password be reset. + +To reset your password, click the link below: + +{{ reset_password_link }} + +If clicking the link above doesn't work, please copy and paste the URL in a +new browser window instead. + +If you didn't initiate this request and feel that you've received this email in +error, don't worry, you don't need to take any further action and can safely +disregard this email. + +If you still have problems logging in, please drop us a line - see +{{ contact_url }} for details. + +-- The MetaBrainz Team diff --git a/metabrainz/templates/supporters/profile-edit.html b/metabrainz/templates/index/profile-edit.html similarity index 65% rename from metabrainz/templates/supporters/profile-edit.html rename to metabrainz/templates/index/profile-edit.html index 33b8d69a..8e84f39e 100644 --- a/metabrainz/templates/supporters/profile-edit.html +++ b/metabrainz/templates/index/profile-edit.html @@ -4,5 +4,5 @@ {% block scripts %} {{ super() }} - + {% endblock %} diff --git a/metabrainz/templates/index/profile.html b/metabrainz/templates/index/profile.html new file mode 100644 index 00000000..0dc6cd24 --- /dev/null +++ b/metabrainz/templates/index/profile.html @@ -0,0 +1,8 @@ +{% extends 'base-react.html' %} + +{% block title %}{{ _('Your Profile') }} - MetaBrainz Foundation{% endblock %} + +{% block scripts %} + {{ super() }} + +{% endblock %} diff --git a/metabrainz/templates/navbar.html b/metabrainz/templates/navbar.html index 045bc4cd..cdc37af0 100644 --- a/metabrainz/templates/navbar.html +++ b/metabrainz/templates/navbar.html @@ -57,16 +57,16 @@
    {% if not current_user or current_user.is_anonymous %}
  • {{ _('Register') }}
    • -
  • {{ _('Sign in') }}
    • +
  • {{ _('Sign in') }}
    • {% else %}
  • - {{ current_user.musicbrainz_id }} + {{ current_user.name }}
    • {% endif %} diff --git a/metabrainz/templates/supporters/mb-login.html b/metabrainz/templates/supporters/mb-login.html deleted file mode 100644 index 22978ab3..00000000 --- a/metabrainz/templates/supporters/mb-login.html +++ /dev/null @@ -1,15 +0,0 @@ -{% extends 'base.html' %} - -{% block title %}{{ _('Log in') }} - MetaBrainz Foundation{% endblock %} - -{% block content %} -

    {{ _('Log in') }}

    - -

    {{ _('To log in you need to have a MusicBrainz account.') }}

    - -
    -
    - {{ _('Log in with MusicBrainz') }} -
    -{% endblock %} diff --git a/metabrainz/templates/supporters/mb-signup.html b/metabrainz/templates/supporters/mb-signup.html deleted file mode 100644 index e44a9f1c..00000000 --- a/metabrainz/templates/supporters/mb-signup.html +++ /dev/null @@ -1,19 +0,0 @@ -{% extends 'base.html' %} - -{% block title %}{{ _('Sign up') }} - MetaBrainz Foundation{% endblock %} - -{% block content %} -

    {{ _('Sign up') }}

    - -

    - {{ _('Please sign in with the MusicBrainz account that will be associated with - your MetaBrainz profile. If you don\'t have a MusicBrainz account or wish to - use a new MusicBrainz account, you can register on the page linked below.') }} -

    - -
    -
    - {{ _('Sign up with MusicBrainz') }} -
    -{% endblock %} diff --git a/metabrainz/templates/supporters/profile.html b/metabrainz/templates/supporters/profile.html deleted file mode 100644 index 651af629..00000000 --- a/metabrainz/templates/supporters/profile.html +++ /dev/null @@ -1,215 +0,0 @@ -{% extends 'base.html' %} - -{% block title %}{{ _('Your Profile') }} - MetaBrainz Foundation{% endblock %} - -{% block content %} -

    {{ _('Your Profile') }}

    - -

    - Type: - {{ 'Commercial' if current_user.is_commercial else 'Non-commercial' }} -
    - {% if current_user.is_commercial %} - Tier: {{ current_user.tier.name }}
    - {% endif %} - State: - - {{ current_user.state|upper }} - -

    - - {% if not current_user.is_commercial %} -

    - NOTE: If you would like to change your account from non-commercial to commercial, please - contact us. -

    - {% endif %} - -
    - {% if current_user.is_commercial %} -
    -

    {{ _('Organization information') }}

    -

    - {{ _('Name:') }} {{ current_user.org_name or - 'Unspecified'|safe }}
    - {{ _('Website URL:') }} {{ current_user.website_url or - 'Unspecified'|safe }}
    - {{ _('API URL:') }} {{ current_user.api_url or - 'Unspecified'|safe }}
    -

    -

    - {{ _('Please contact us - if you wish for us to update this information.', contact_url=url_for('index.contact')) }} -

    -
    - {% endif %} - -
    -

    {{ _('Contact information') }}

    -

    - {{ _('Name:') }} {{ current_user.contact_name }}
    - {{ _('Email:') }} {{ current_user.contact_email }}
    - {% if not current_user.is_commercial %} - {{ _('Datasets used:') }} - {% if current_user.datasets %} - {{ current_user.datasets|map(attribute="name")|join(", ") }} - {% endif %} -
    - {% endif %} -

    -

    - - {% if current_user.is_commercial %} - Edit contact information - {% else %} - Edit datasets/contact information - {% endif %} - -

    -
    -
    - - {% if current_user.is_commercial %} - {% if current_user.state in ('active', 'limited') and current_user.good_standing %} -

    {{ _('Data use permission granted') }}

    -
    -

    - Your support agreement has been completed -- thank you! -

    -

    - {{ _('You have permission to use any of the data published by the MetaBrainz - Foundation. This includes data dumps released under a Creative Commons - non-commercial license. Thank you for your support!') }} -

    -

    - {{ _('Note 1: If your support falls behind by more than 60 days, this - permission may be withdrawn. You can always check your current permission - status on this page.') }} -

    -

    - {{ _('Note 2: The IP addresses from which replication packets for the Live Data Feed are downloaded are logged.') }} -

    -
    - {% else %} -

    Limited/no data use permission granted

    -
    - {% if current_user.state == 'rejected' %} -

    - Your application for using the Live Data Feed has been rejected. -

    -

    - You do not have permission to use our data in a public commercial product. -

    - {% elif current_user.state == 'pending' %} -

    - Your application for using the Live Data Feed is still pending. -

    -

    - You may use our data and APIs for evaluation/development purposes - while your application is pending. -

    - {% elif current_user.state == 'waiting' %} -

    - Your application for using the Live Data Feed is waiting to finalize our support agreement. -

    -

    - You may use our data and APIs for evaluation and development purposes, but you may not use the data in a public - commercial product. Once you are nearing the public release of a product that contains our data, please - contact us again to finalize our support agreement. -

    - {% elif not current_user.good_standing %} -

    - Your use of the Live Data Feed is pending suspension. -

    -

    - Your account is in bad standing, which means that you are more than 60 days behind in support payments. If you think - this is a mistake, please contact us. -

    - {% else %} - {{ _('Unknown. :(') }} - {% endif %} -
    - {% endif %} - {% endif %} - - {% if current_user.state in ('active', 'limited') and current_user.good_standing %} -

    {{ _('Data Download') }}

    - -
    - {% if not current_user.is_commercial %} -

    - Thank you for registering with us -- we really appreciate it! -

    - {% endif %} - -

    - Please proceed to our download page to download our datasets: -

    - -

    - Download Datasets -

    -
    - {% endif %} - - {% if current_user.state == 'active' %} -

    {{ _('Live Data Feed Access token') }}

    -

    - {{ _('This access token should be considered private. Don\'t check this token - into any publicly visible version control systems and similar places. - If the token has been exposed, you should immediately generate a new one! - When you generate a new token, your current token is revoked.') }} -

    -
    -

    - {% if current_user.token %} -

    {{ current_user.token.value }}
    - {% else %} -
    [ there is no valid token currently ]
    - {% endif %} -

    -

    - {{ _('Generate new token') }} -

    -
    -

    {{ _('See the API documentation for more information.', api_docs_url=url_for('api_index.info')) }}

    - - {% endif %} -{% endblock %} - -{% block scripts %} - {{ super() }} - {% if current_user.state == 'active' %} - - {% endif %} -{% endblock %} diff --git a/metabrainz/templates/users/base.html b/metabrainz/templates/users/base.html new file mode 100644 index 00000000..572d070b --- /dev/null +++ b/metabrainz/templates/users/base.html @@ -0,0 +1,34 @@ +{% extends 'base-react.html' %} + +{% block title %}{{ _('Sign in') }} - MetaBrainz Foundation{% endblock %} + +{% block content %} +
    +
    +
    +
    + MusicBrainz +
    +
    + ListenBrainz +
    +
    + BookBrainz +
    +
    + CritiqueBrainz +
    +
    + Picard +
    +
    + {% block auth_form %} + + {% endblock %} +
    +
    +{% endblock %} diff --git a/metabrainz/templates/users/login.html b/metabrainz/templates/users/login.html new file mode 100644 index 00000000..82f8ef9e --- /dev/null +++ b/metabrainz/templates/users/login.html @@ -0,0 +1,8 @@ +{% extends 'base-react.html' %} + +{% block title %}{{ _('Sign in') }} - MetaBrainz Foundation{% endblock %} + +{% block scripts %} + {{ super() }} + +{% endblock %} diff --git a/metabrainz/templates/users/lost-password.html b/metabrainz/templates/users/lost-password.html new file mode 100644 index 00000000..dde80de7 --- /dev/null +++ b/metabrainz/templates/users/lost-password.html @@ -0,0 +1,8 @@ +{% extends 'base-react.html' %} + +{% block title %}{{ _('Forgot password') }} - MetaBrainz Foundation{% endblock %} + +{% block scripts %} + {{ super() }} + +{% endblock %} diff --git a/metabrainz/templates/users/lost-username.html b/metabrainz/templates/users/lost-username.html new file mode 100644 index 00000000..a12bf266 --- /dev/null +++ b/metabrainz/templates/users/lost-username.html @@ -0,0 +1,8 @@ +{% extends 'base-react.html' %} + +{% block title %}{{ _('Forgot username') }} - MetaBrainz Foundation{% endblock %} + +{% block scripts %} + {{ super() }} + +{% endblock %} diff --git a/metabrainz/templates/users/reset-password.html b/metabrainz/templates/users/reset-password.html new file mode 100644 index 00000000..8a2ef10b --- /dev/null +++ b/metabrainz/templates/users/reset-password.html @@ -0,0 +1,8 @@ +{% extends 'users/base.html' %} + +{% block title %}{{ _('Reset your password') }} - MetaBrainz Foundation{% endblock %} + +{% block scripts %} + {{ super() }} + +{% endblock %} diff --git a/metabrainz/templates/users/signup.html b/metabrainz/templates/users/signup.html new file mode 100644 index 00000000..447a9b20 --- /dev/null +++ b/metabrainz/templates/users/signup.html @@ -0,0 +1,8 @@ +{% extends 'base-react.html' %} + +{% block title %}{{ _('Sign up') }} - MetaBrainz Foundation{% endblock %} + +{% block scripts %} + {{ super() }} + +{% endblock %} diff --git a/metabrainz/testing.py b/metabrainz/testing.py index 71c60ede..e49e2884 100644 --- a/metabrainz/testing.py +++ b/metabrainz/testing.py @@ -42,44 +42,35 @@ def temporary_login(self, user_login_id): @classmethod def setUpClass(cls): - logging.basicConfig(level=logging.DEBUG) - cls.app = cls.create_app() cls.client = cls.app.test_client() - template_rendered.connect(cls._set_template) - message_flashed.connect(cls._add_flash_message) - - cls.template = None - cls.flashed_messages = [] - def setUp(self): self._ctx = self.app.test_request_context() self._ctx.push() self.reset_db() + self.template = None + self.flashed_messages = [] + template_rendered.connect(self._set_template) + message_flashed.connect(self._add_flash_message) - FlaskTestCase.template = None - FlaskTestCase.flashed_messages = [] + def _add_flash_message(self, app, message, category): + self.flashed_messages.append((message, category)) - @classmethod - def _add_flash_message(cls, app, message, category): - cls.flashed_messages.append((message, category)) - - @classmethod - def _set_template(cls, app, template, context): - cls.template = (template, context) + def _set_template(self, app, template, context): + self.template = (template, context) def tearDown(self): model.db.session.remove() + template_rendered.disconnect(self._set_template) + message_flashed.disconnect(self._add_flash_message) self._ctx.pop() del self._ctx - del FlaskTestCase.template - del FlaskTestCase.flashed_messages + del self.template + del self.flashed_messages @classmethod def tearDownClass(cls): - template_rendered.disconnect(cls._set_template) - message_flashed.disconnect(cls._add_flash_message) del cls.client del cls.app @@ -104,7 +95,7 @@ def assertMessageFlashed(self, message, category='message'): :param message: expected message :param category: expected message category """ - for _message, _category in FlaskTestCase.flashed_messages: + for _message, _category in self.flashed_messages: if _message == message and _category == category: return True @@ -121,11 +112,11 @@ class attribute name which contains the provided ``name`` value. :versionadded: 0.2 :param name: template name """ - used_template = FlaskTestCase.template[0].name + used_template = self.template[0].name self.assertEqual(used_template, name, f"Template {name} not used. Template used: {used_template}") def get_context_variable(self, name): - context = FlaskTestCase.template[1] + context = self.template[1] if name in context: return context[name] raise ValueError() diff --git a/metabrainz/user/__init__.py b/metabrainz/user/__init__.py new file mode 100644 index 00000000..d28eaba3 --- /dev/null +++ b/metabrainz/user/__init__.py @@ -0,0 +1,27 @@ +from uuid import UUID +from flask import redirect, url_for +from flask_login import LoginManager, current_user +from functools import wraps + +from metabrainz.model.user import User + +login_manager = LoginManager() +login_manager.login_view = "users.login" + + +@login_manager.user_loader +def load_user(user_id): + try: + login_id = UUID(user_id) + return User.get(login_id=login_id) + except (ValueError, TypeError): + return None + +def login_forbidden(f): + @wraps(f) + def decorated(*args, **kwargs): + if current_user.is_anonymous is False: + return redirect(url_for("index.home")) + return f(*args, **kwargs) + + return decorated diff --git a/metabrainz/user/email.py b/metabrainz/user/email.py new file mode 100644 index 00000000..b6dffa3a --- /dev/null +++ b/metabrainz/user/email.py @@ -0,0 +1,68 @@ +import hashlib +from datetime import datetime + +from flask import url_for, request, render_template, current_app + +from brainzutils.mail import send_mail +from metabrainz.model.user import User + +VERIFY_EMAIL = "verify-email" +RESET_PASSWORD = "reset-password" + + +def create_email_link_checksum(purpose: str, user_id: int, email: str, timestamp: int) -> str: + """ Create a checksum based on user details, time and a secret key for the user's email verification """ + text = f"{purpose}; user_id: {user_id}; email: {email}; timestamp: {timestamp}; secret: {current_app.config['EMAIL_VERIFICATION_SECRET_KEY']}" + m = hashlib.sha256() + m.update(text.encode("utf-8")) + return m.hexdigest() + + +def _send_user_email(username: str, email: str, subject: str, content: str): + if not current_app.config["DEBUG"]: + send_mail(subject=subject, text=content, recipients=[f"{username} <{email}>"]) + + +def send_verification_email(user: User, subject, template): + """ Send email for verification of user's email address. """ + timestamp = int(datetime.now().timestamp()) + email = user.unconfirmed_email + + checksum = create_email_link_checksum(VERIFY_EMAIL, user.id, email, timestamp) + verification_link = url_for( + "users.verify_email", + user_id=user.id, + timestamp=timestamp, + checksum=checksum, + _external=True + ) + content = render_template( + template, + username=user.name, + verification_link=verification_link, + ip=request.remote_addr + ) + _send_user_email(user.name, email, subject, content) + + +def send_forgot_username_email(user: User): + """ Send email for forgotten username. """ + content = render_template( + "email/user-forgot-username.txt", + username=user.name, + forgot_password_link=url_for("users.lost_password") + ) + _send_user_email(user.name, user.email, "Lost username", content) + + +def send_forgot_password_email(user: User): + """ Send email for resetting the user's password. """ + timestamp = int(datetime.now().timestamp()) + checksum = create_email_link_checksum(RESET_PASSWORD, user.id, user.get_email_any(), timestamp) + reset_password_link = url_for("users.reset_password", user_id=user.id, timestamp=timestamp, checksum=checksum, _external=True) + content = render_template( + "email/user-password-reset.txt", + reset_password_link=reset_password_link, + contact_url="https://metabrainz.org/contact" + ) + _send_user_email(user.name, user.get_email_any(), "Password reset request", content) diff --git a/metabrainz/user/forms.py b/metabrainz/user/forms.py new file mode 100644 index 00000000..b0274588 --- /dev/null +++ b/metabrainz/user/forms.py @@ -0,0 +1,57 @@ +from flask_babel import gettext +from flask_wtf import RecaptchaField +from wtforms import BooleanField, PasswordField +from wtforms.fields import StringField, EmailField +from wtforms.validators import DataRequired, EqualTo, Length + +from metabrainz.index.forms import MeBFlaskForm + + +class UserSignupForm(MeBFlaskForm): + """ Sign up form for new users. """ + username = StringField(gettext("Username"), validators=[DataRequired(gettext("Username is required!"))]) + email = EmailField(validators=[DataRequired(gettext("Email address is required!"))]) + password = PasswordField(validators=[ + DataRequired(gettext("Password is required!")), + Length(min=8, max=64) + ]) + confirm_password = PasswordField(validators=[ + DataRequired(gettext("Confirm Password is required!")), + Length(min=8, max=64), + EqualTo("password", gettext("Confirm Password should match password!")) + ]) + recaptcha = RecaptchaField("Recaptcha") + + +# TODO: Consider adding recaptcha fields to remaining forms + + +class UserLoginForm(MeBFlaskForm): + """ Login form for existing users. """ + username = StringField(gettext("Username"), validators=[DataRequired(gettext("Username is required!"))]) + password = PasswordField(gettext("Password"), validators=[DataRequired(gettext("Password is required!"))]) + remember_me = BooleanField(gettext("Remember me"), default="checked") + + +class ForgotUsernameForm(MeBFlaskForm): + """ Form to request lost username email. """ + email = EmailField(validators=[DataRequired(gettext("Email address is required!"))]) + + +class ForgotPasswordForm(MeBFlaskForm): + """ Form to request reset password link. """ + username = StringField(gettext("Username"), validators=[DataRequired(gettext("Username is required!"))]) + email = EmailField(validators=[DataRequired(gettext("Email address is required!"))]) + + +class ResetPasswordForm(MeBFlaskForm): + """ Form for a user to reset their password. """ + password = PasswordField(validators=[ + DataRequired(gettext("Password is required!")), + Length(min=8, max=64) + ]) + confirm_password = PasswordField(validators=[ + DataRequired(gettext("Confirm Password is required!")), + Length(min=8, max=64), + EqualTo("password", gettext("Confirm Password should match password!")) + ]) diff --git a/metabrainz/user/views.py b/metabrainz/user/views.py new file mode 100644 index 00000000..bdae2e14 --- /dev/null +++ b/metabrainz/user/views.py @@ -0,0 +1,244 @@ +import json +from datetime import datetime, timezone + +from flask import Blueprint, current_app, redirect, render_template, request, url_for +from flask_login import logout_user, login_required, login_user, current_user +from flask_wtf.csrf import generate_csrf +from sqlalchemy.exc import IntegrityError + +from metabrainz import bcrypt, flash +from metabrainz.index.forms import MeBFlaskForm +from metabrainz.model import db +from metabrainz.model.user import User +from metabrainz.user import login_forbidden +from metabrainz.user.email import send_forgot_password_email, send_forgot_username_email, create_email_link_checksum, \ + VERIFY_EMAIL, RESET_PASSWORD, send_verification_email +from metabrainz.user.forms import UserLoginForm, UserSignupForm, ForgotPasswordForm, ForgotUsernameForm, \ + ResetPasswordForm + +users_bp = Blueprint("users", __name__) + + +@users_bp.route("/signup", methods=["GET", "POST"]) +@login_forbidden +def signup(): + """ User signup endpoint. """ + form = UserSignupForm() + if form.validate_on_submit(): + user = User.get(name=form.username.data) + if user is not None: + form.username.errors.append(f"Another user with username '{form.username.data}' exists.") + else: + # TODO: Handle the case where multiple users sign up with same email but haven"t verified it yet + user = User.get(email=form.email.data) + if user is not None: + form.email.errors.append(f"Another user with email '{form.email.data}' exists.") + else: + user = User.add(name=form.username.data, unconfirmed_email=form.email.data, password=form.password.data) + db.session.commit() + send_verification_email( + user, + "Please verify your email address", + "email/user-email-address-verification.txt" + ) + login_user(user) + flash.success("Account created. Please check your inbox to complete verification.") + redirect_to = request.args.get("next") + if not redirect_to: + redirect_to = url_for("index.home") + return redirect(redirect_to) + + form_data = dict(**form.data) + form_data.pop("csrf_token", None) + + return render_template("users/signup.html", props=json.dumps({ + "recaptcha_site_key": current_app.config["RECAPTCHA_PUBLIC_KEY"], + "csrf_token": generate_csrf(), + "initial_form_data": form_data, + "initial_errors": form.props_errors + })) + + +@users_bp.route("/login", methods=["GET", "POST"]) +@login_forbidden +def login(): + """ User login endpoint. """ + form = UserLoginForm() + if form.validate_on_submit(): + user = User.get(name=form.username.data) + if user is None: + form.username.errors.append(f"Username {form.username.data} not found.") + else: + if not bcrypt.check_password_hash(user.password, form.password.data): + form.password.errors.append("Invalid username or password.") + else: + if user.is_blocked: + form.username.errors.append( + "Your account has been blocked. Please contact support if" + " you believe this is an error." + ) + else: + login_user(user, remember=form.remember_me.data) + user.last_login_at = datetime.now(timezone.utc) + db.session.commit() + + flash.success("Logged in successfully.") + redirect_to = request.args.get("next") + if not redirect_to: + redirect_to = url_for("index.home") + return redirect(redirect_to) + + form_errors = {k: ". ".join(v) for k, v in form.errors.items()} + form_data = dict(**form.data) + form_data.pop("csrf_token", None) + + return render_template("users/login.html", props=json.dumps({ + "recaptcha_site_key": current_app.config["RECAPTCHA_PUBLIC_KEY"], + "csrf_token": generate_csrf(), + "initial_form_data": form_data, + "initial_errors": form_errors + })) + + +@users_bp.route("/verify-email") +def verify_email(): + """ User"s email verification endpoint. """ + user_id = request.args.get("user_id") + timestamp = int(request.args.get("timestamp")) + if datetime.fromtimestamp(timestamp) + current_app.config["EMAIL_VERIFICATION_EXPIRY"] <= datetime.now(): + flash.error("Email verification link expired.") + return redirect(url_for("index.home")) + + received_checksum = request.args.get("checksum") + + user = User.get(id=user_id) + if user is None: + flash.error("User not found.") + return redirect(url_for("index.home")) + + checksum = create_email_link_checksum(VERIFY_EMAIL, user.id, user.unconfirmed_email, timestamp) + if checksum != received_checksum: + flash.error("Unable to verify email.") + return redirect(url_for("index.home")) + + try: + user.email = user.unconfirmed_email + user.unconfirmed_email = None + user.email_confirmed_at = datetime.now(tz=timezone.utc) + db.session.commit() + flash.success("Email verified!") + except IntegrityError: + flash.error(f"The email is already associated with an another account.") + db.session.rollback() + + return redirect(url_for("index.home")) + + +@users_bp.route("/resend-verification-email", methods=["POST"]) +@login_required +def resend_verification_email(): + form = MeBFlaskForm() + if form.validate_on_submit(): + send_verification_email( + current_user, + "Please verify your email address", + "email/user-email-address-verification.txt" + ) + flash.success("Verification email sent!") + return redirect(url_for("index.profile")) + + +@users_bp.route("/lost-username", methods=["GET", "POST"]) +@login_forbidden +def lost_username(): + """ User's forgot username, request email with info endpoint. """ + form = ForgotUsernameForm() + if form.validate_on_submit(): + user = User.get(email=form.email.data) + if user is None: + form.email.errors.append(f"The given email address ({form.email.data}) does not exist in our database.") + else: + send_forgot_username_email(user) + flash.success("Username recovery email sent!") + return redirect(url_for("index.home")) + + form_errors = {k: ". ".join(v) for k, v in form.errors.items()} + form_data = dict(**form.data) + form_data.pop("csrf_token", None) + + return render_template("users/lost-username.html", props=json.dumps({ + "recaptcha_site_key": current_app.config["RECAPTCHA_PUBLIC_KEY"], + "csrf_token": generate_csrf(), + "initial_form_data": form_data, + "initial_errors": form_errors + })) + + +@users_bp.route("/lost-password", methods=["GET", "POST"]) +@login_forbidden +def lost_password(): + """ User's forgot password, request email to reset password endpoint. """ + form = ForgotPasswordForm() + if form.validate_on_submit(): + user = User.get(name=form.username.data, email=form.email.data) + if user is None: + form.email.errors.append(f"User with given username ({form.username.data}) and email ({form.email.data}) combination not found.") + else: + send_forgot_password_email(user) + flash.success("Password reset link sent!") + return redirect(url_for("index.home")) + + form_errors = {k: ". ".join(v) for k, v in form.errors.items()} + form_data = dict(**form.data) + form_data.pop("csrf_token", None) + + return render_template("users/lost-password.html", props=json.dumps({ + "recaptcha_site_key": current_app.config["RECAPTCHA_PUBLIC_KEY"], + "csrf_token": generate_csrf(), + "initial_form_data": form_data, + "initial_errors": form_errors + })) + + +@users_bp.route("/reset-password", methods=["GET", "POST"]) +@login_forbidden +def reset_password(): + """ User"s reset password endpoint. """ + user_id = request.args.get("user_id") + + timestamp = int(request.args.get("timestamp")) + if datetime.fromtimestamp(timestamp) + current_app.config["EMAIL_RESET_PASSWORD_EXPIRY"] <= datetime.now(): + flash.error("Password reset link expired.") + return redirect(url_for("index.home")) + + user = User.get(id=user_id) + if user is None: + flash.error("User not found.") + return redirect(url_for("index.home")) + + received_checksum = request.args.get("checksum") + checksum = create_email_link_checksum(RESET_PASSWORD, user.id, user.get_email_any(), timestamp) + if checksum != received_checksum: + flash.error("Unable to reset password.") + return redirect(url_for("index.home")) + + form = ResetPasswordForm() + if form.validate_on_submit(): + user.password = bcrypt.generate_password_hash(form.password.data).decode("utf-8") + db.session.commit() + + flash.success("Password reset!") + return redirect(url_for("index.home")) + + form_errors = {k: ". ".join(v) for k, v in form.errors.items()} + return render_template("users/reset-password.html", props=json.dumps({ + "csrf_token": generate_csrf(), + "initial_errors": form_errors + })) + + +@users_bp.route("/logout") +@login_required +def logout(): + logout_user() + return redirect(url_for("index.home")) diff --git a/metabrainz/user/views_test.py b/metabrainz/user/views_test.py new file mode 100644 index 00000000..d5947ce7 --- /dev/null +++ b/metabrainz/user/views_test.py @@ -0,0 +1,659 @@ +import json +from datetime import datetime, timezone, timedelta +from urllib.parse import urlparse, parse_qs + +from flask import g, url_for +from flask_login import current_user +from flask_wtf.csrf import generate_csrf +from freezegun import freeze_time +from sqlalchemy import delete + +from metabrainz.model import db +from metabrainz.model.user import User +from metabrainz.testing import FlaskTestCase +from metabrainz.user.email import VERIFY_EMAIL, create_email_link_checksum, RESET_PASSWORD + + +class UsersViewsTestCase(FlaskTestCase): + + def setUp(self): + super(UsersViewsTestCase, self).setUp() + + def tearDown(self): + db.session.rollback() + db.session.execute(delete(User)) + db.session.commit() + super(UsersViewsTestCase, self).tearDown() + + def create_user(self, data=None): + if data is None: + data = { + "username": "test_user_1", + "email": "test@example.com", + "password": "", + "confirm_password": "", + } + self._test_user_signup_helper(data, 302) + self.client.get("/logout") + + def _test_user_signup_helper(self, data, expected_status_code, include_csrf_token=True): + self.client.get("/signup") + if include_csrf_token: + data["csrf_token"] = g.csrf_token + response = self.client.post("/signup", data=data) + self.assertEqual(response.status_code, expected_status_code) + + def _test_user_signup_missing_fields_helper(self, data, errors, include_csrf_token=True): + self._test_user_signup_helper(data, 200, include_csrf_token) + props = json.loads(self.get_context_variable("props")) + self.assertEqual(props["initial_errors"], errors) + user = User.get(name="test_user_1") + self.assertIsNone(user) + + def test_user_signup_success(self): + self._test_user_signup_helper({ + "username": "test_user_1", + "email": "test@example.com", + "password": "", + "confirm_password": "", + }, 302) + self.assertMessageFlashed("Account created. Please check your inbox to complete verification.", "success") + + user = User.get(name="test_user_1") + self.assertEqual(user.name, "test_user_1") + self.assertIsNone(user.email) + self.assertEqual(user.unconfirmed_email, "test@example.com") + self.assertIsNone(user.email_confirmed_at) + self.assertNotEqual(user.password, "") + self.assertIsNotNone(user.member_since) + self.assertIsNotNone(user.last_login_at) + self.assertIsNotNone(user.last_updated) + self.assertEqual(current_user, user) + + def test_user_signup_missing_csrf_token(self): + self._test_user_signup_missing_fields_helper({ + "username": "test_user_1", + "email": "test@example.com", + "password": "", + "confirm_password": "", + }, {"csrf_token": "The CSRF token is missing."}, False) + user = User.get(name="test_user_1") + self.assertIsNone(user) + + def test_user_signup_missing_username(self): + self._test_user_signup_missing_fields_helper({ + "email": "test@example.com", + "password": "", + "confirm_password": "", + }, {"username": "Username is required!"}) + user = User.get(email="test@example.com") + self.assertIsNone(user) + + def test_user_signup_missing_email(self): + self._test_user_signup_missing_fields_helper({ + "username": "test_user_1", + "password": "", + "confirm_password": "", + }, {"email": "Email address is required!"}) + user = User.get(name="test_user_1") + self.assertIsNone(user) + + def test_user_signup_missing_password(self): + self._test_user_signup_missing_fields_helper({ + "username": "test_user_1", + "email": "test@example.com", + "confirm_password": "", + }, { + "password": "Password is required!", + "confirm_password": "Confirm Password should match password!" + }) + user = User.get(name="test_user_1") + self.assertIsNone(user) + + def test_user_signup_missing_confirm_password(self): + self._test_user_signup_missing_fields_helper({ + "username": "test_user_1", + "email": "test@example.com", + "password": "", + }, {"confirm_password": "Confirm Password is required!"}) + user = User.get(name="test_user_1") + self.assertIsNone(user) + + def test_user_signup_missing_password_mismatch(self): + self._test_user_signup_missing_fields_helper({ + "username": "test_user_1", + "email": "test@example.com", + "password": "", + "confirm_password": "", + }, {"confirm_password": "Confirm Password should match password!"}) + user = User.get(name="test_user_1") + self.assertIsNone(user) + + def test_user_signup_username_exists(self): + self.create_user() + + self._test_user_signup_helper({ + "username": "test_user_1", + "email": "test2@gmail.com", + "password": "", + "confirm_password": "", + }, 200) + props = json.loads(self.get_context_variable("props")) + self.assertEqual(props["initial_errors"], {"username": "Another user with username 'test_user_1' exists."}) + + def test_user_signup_logged_in(self): + data = { + "username": "test_user_1", + "email": "test@example.com", + "password": "", + "confirm_password": "", + } + self._test_user_signup_helper(data, 302) + + response = self.client.get("/signup") + self.assertEqual(response.status_code, 302) + self.assertEqual(response.location, "/") + + response = self.client.post("/signup", data={ + **data, + "csrf_token": g.csrf_token, + }) + self.assertEqual(response.status_code, 302) + self.assertEqual(response.location, "/") + + def _test_user_login_helper(self, data, expected_status_code, include_csrf_token=True): + self.client.get("/login") + if include_csrf_token: + data["csrf_token"] = g.csrf_token + response = self.client.post("/login", data=data) + self.assertEqual(response.status_code, expected_status_code) + + def _test_user_login_error(self, data, errors, include_csrf_token=True): + self._test_user_login_helper(data, 200, include_csrf_token) + props = json.loads(self.get_context_variable("props")) + self.assertEqual(props["initial_errors"], errors) + self.assertTrue(current_user.is_anonymous) + + def test_user_login_success(self): + self.create_user() + + current_dt = datetime.now(timezone.utc) + self._test_user_login_helper({ + "username": "test_user_1", + "password": "", + }, 302) + self.assertEqual(current_user.name, "test_user_1") + self.assertFalse(current_user.is_anonymous) + self.assertGreater(current_user.last_login_at, current_dt) + + self.client.get("/logout") + self.assertTrue(current_user.is_anonymous) + + def test_user_login_missing_username(self): + self.create_user() + + self._test_user_login_error({ + "password": "", + }, {"username": "Username is required!"}) + self.assertTrue(current_user.is_anonymous) + + def test_user_login_missing_password(self): + self.create_user() + + self._test_user_login_error({ + "username": "test_user_1", + }, {"password": "Password is required!"}) + self.assertTrue(current_user.is_anonymous) + + def test_user_login_missing_csrf_token(self): + self.create_user() + + self._test_user_login_error({ + "username": "test_user_1", + "password": "", + }, {"csrf_token": "The CSRF token is missing."}, False) + self.assertTrue(current_user.is_anonymous) + + def test_user_login_wrong_password(self): + self.create_user() + + self._test_user_login_error({ + "username": "test_user_1", + "password": "", + }, {"password": "Invalid username or password."}) + self.assertTrue(current_user.is_anonymous) + + def test_user_login_mismatched_password(self): + self.create_user() + self.create_user({ + "username": "test_user_2", + "email": "test2@example.org", + "password": "", + "confirm_password": "", + }) + + self._test_user_login_error({ + "username": "test_user_1", + "password": "", + }, {"password": "Invalid username or password."}) + self.assertTrue(current_user.is_anonymous) + + def test_user_login_logged_in(self): + data = { + "username": "test_user_1", + "email": "test@example.com", + "password": "", + "confirm_password": "", + } + self._test_user_signup_helper(data, 302) + + response = self.client.get("/login") + self.assertEqual(response.status_code, 302) + self.assertEqual(response.location, "/") + + response = self.client.post("/login", data={ + **data, + "csrf_token": g.csrf_token, + }) + self.assertEqual(response.status_code, 302) + self.assertEqual(response.location, "/") + + def test_user_verify_email_success(self): + self.create_user() + timestamp = datetime.now(timezone.utc) + + verification_link = self.get_context_variable("verification_link") + response = self.client.get(verification_link) + self.assertEqual(response.status_code, 302) + user = User.get(name="test_user_1") + self.assertIsNone(user.unconfirmed_email) + self.assertEqual(user.email, "test@example.com") + self.assertGreater(user.email_confirmed_at, timestamp) + + def test_user_email_verify_invalid_checksum(self): + self.create_user() + + user = User.get(name="test_user_1") + timestamp = int(datetime.now().timestamp()) + checksum = create_email_link_checksum(VERIFY_EMAIL, user.id, "abc@abc.com", timestamp) + url = url_for( + "users.verify_email", + user_id=user.id, + timestamp=timestamp, + checksum=checksum, + _external=True + ) + response = self.client.get(url) + self.assertEqual(response.status_code, 302) + self.assertMessageFlashed("Unable to verify email.", "error") + + def test_user_email_verify_missing_checksum(self): + self.create_user() + + user = User.get(name="test_user_1") + timestamp = int(datetime.now().timestamp()) + url = url_for( + "users.verify_email", + user_id=user.id, + timestamp=timestamp, + _external=True + ) + response = self.client.get(url) + self.assertEqual(response.status_code, 302) + self.assertMessageFlashed("Unable to verify email.", "error") + + def test_user_email_verify_user_invalid(self): + self.create_user() + + verification_link = self.get_context_variable("verification_link") + query = parse_qs(urlparse(verification_link).query) + url = url_for( + "users.verify_email", + user_id=1000, + timestamp=query.get("timestamp")[0], + checksum=query.get("checksum")[0], + _external=True + ) + response = self.client.get(url) + self.assertEqual(response.status_code, 302) + self.assertMessageFlashed("User not found.", "error") + + def test_user_email_verify_expired(self): + self.create_user() + verification_link = self.get_context_variable("verification_link") + + with freeze_time(datetime.now(timezone.utc) + timedelta(days=1)): + response = self.client.get(verification_link) + self.assertEqual(response.status_code, 302) + self.assertMessageFlashed("Email verification link expired.", "error") + + def test_user_exists_verified_email(self): + self.create_user() + + verification_link = self.get_context_variable("verification_link") + response = self.client.get(verification_link) + self.assertEqual(response.status_code, 302) + user = User.get(name="test_user_1") + self.assertEqual(user.email, "test@example.com") + + self._test_user_signup_helper({ + "username": "test_user_2", + "email": "test@example.com", + "password": "", + "confirm_password": "", + }, 200) + props = json.loads(self.get_context_variable("props")) + self.assertEqual(props["initial_errors"], {"email": "Another user with email 'test@example.com' exists."}) + + def test_multiple_users_verify_same_email_fails(self): + """ Ideally, it shouldn't be possible to create two users with the same unconfirmed email but assuming + it happens due to some race condition etc. handle the case. + """ + self.create_user() + verification_link = self.get_context_variable("verification_link") + + user2 = User.add(name="test_user_2", unconfirmed_email="test@example.com", password="") + db.session.commit() + + timestamp = int(datetime.now().timestamp()) + checksum = create_email_link_checksum(VERIFY_EMAIL, user2.id, "test@example.com", timestamp) + verification_link2 = url_for( + "users.verify_email", + user_id=user2.id, + timestamp=timestamp, + checksum=checksum, + _external=True + ) + + response = self.client.get(verification_link) + self.assertEqual(response.status_code, 302) + user = User.get(name="test_user_1") + self.assertEqual(user.email, "test@example.com") + + response = self.client.get(verification_link2) + self.assertEqual(response.status_code, 302) + user2 = User.get(name="test_user_2") + self.assertIsNone(user2.email) + + def test_resend_verification_email(self): + self.create_user() + + verification_link = self.get_context_variable("verification_link") + with freeze_time(datetime.now(timezone.utc) + timedelta(days=1)) as frozen_time: + # freezing and moving time expires the csrf_token which is constant for a given test request context + # unless manually deleted + del g.csrf_token + + response = self.client.get(verification_link) + self.assertEqual(response.status_code, 302) + self.assertMessageFlashed("Email verification link expired.", "error") + + self._test_user_login_helper({ + "username": "test_user_1", + "password": "" + }, 302) + + response = self.client.post("/resend-verification-email", data={"csrf_token": g.csrf_token}) + self.assertEqual(response.status_code, 302) + new_verification_link = self.get_context_variable("verification_link") + self.assertNotEqual(new_verification_link, verification_link) + + frozen_time.tick(60) + response = self.client.get(new_verification_link) + self.assertEqual(response.status_code, 302) + user = User.get(name="test_user_1") + self.assertIsNone(user.unconfirmed_email) + self.assertEqual(user.email, "test@example.com") + + def test_resend_verification_email_error(self): + self.create_user() + response = self.client.post("/resend-verification-email") + self.assertEqual(response.status_code, 302) + self.assertTrue(response.location.startswith("/login")) + + def test_forgot_username_success(self): + self.create_user() + + self.client.get("/lost-username") + response = self.client.post("/lost-username", data={ + "email": "test@example.com", + "csrf_token": g.csrf_token + }) + self.assertEqual(response.status_code, 302) + self.assertEqual(self.get_context_variable("username"), "test_user_1") + self.assertMessageFlashed("Username recovery email sent!", "success") + + def test_forgot_username_logged_in(self): + self.create_user() + self.client.post("/login", data={ + "username": "test_user_1", + "password": "", + "csrf_token": g.csrf_token + }) + response = self.client.get("/lost-username") + self.assertEqual(response.status_code, 302) + self.assertEqual(response.location, "/") + + response = self.client.post("/lost-username") + self.assertEqual(response.status_code, 302) + self.assertEqual(response.location, "/") + + def test_forgot_username_email_not_exist(self): + self.create_user() + self.client.get("/lost-username") + response = self.client.post("/lost-username", data={ + "email": "test1@example.com", + "csrf_token": g.csrf_token + }) + self.assertEqual(response.status_code, 200) + self.assertEqual( + json.loads(self.get_context_variable("props"))["initial_errors"], + {"email": "The given email address (test1@example.com) does not exist in our database."} + ) + + def test_forgot_username_email_missing(self): + self.create_user() + self.client.get("/lost-username") + response = self.client.post("/lost-username", data={ + "csrf_token": g.csrf_token + }) + self.assertEqual(response.status_code, 200) + self.assertEqual( + json.loads(self.get_context_variable("props"))["initial_errors"], + {"email": "Email address is required!"} + ) + + def test_forgot_username_csrf_token_missing(self): + self.create_user() + self.client.get("/lost-username") + response = self.client.post("/lost-username", data={ + "email": "test@example.com" + }) + self.assertEqual(response.status_code, 200) + self.assertEqual( + json.loads(self.get_context_variable("props"))["initial_errors"], + {"csrf_token": "The CSRF token is missing."} + ) + + def _test_forgot_password_helper(self, data, expected_status_code, include_csrf_token=True): + self.create_user() + self.client.get("/lost-password") + if include_csrf_token: + data["csrf_token"] = g.csrf_token + response = self.client.post("/lost-password", data=data) + self.assertEqual(response.status_code, expected_status_code) + + def _test_forgot_password_helper_error(self, data, errors, include_csrf_token=True): + self._test_forgot_password_helper(data, 200, include_csrf_token) + props = json.loads(self.get_context_variable("props")) + self.assertEqual(props["initial_errors"], errors) + + def test_forgot_password_verified_email_success(self): + self.create_user() + verification_link = self.get_context_variable("verification_link") + response = self.client.get(verification_link) + self.assertEqual(response.status_code, 302) + + self.client.get("/lost-password") + response = self.client.post("/lost-password", data={ + "username": "test_user_1", + "email": "test@example.com", + "csrf_token": g.csrf_token + }) + self.assertEqual(response.status_code, 302) + self.assertMessageFlashed("Password reset link sent!", "success") + + def test_forgot_password_logged_in(self): + self.create_user() + self.client.post("/login", data={ + "username": "test_user_1", + "password": "", + "csrf_token": g.csrf_token + }) + response = self.client.get("/lost-password") + self.assertEqual(response.status_code, 302) + self.assertEqual(response.location, "/") + + response = self.client.post("/lost-password") + self.assertEqual(response.status_code, 302) + self.assertEqual(response.location, "/") + + def test_forgot_password_missing_username(self): + self._test_forgot_password_helper_error({ + "email": "test@example.com", + }, {"username": "Username is required!"}) + + def test_forgot_password_missing_email(self): + self._test_forgot_password_helper_error({ + "username": "test_user_1", + }, {"email": "Email address is required!"}) + + def test_forgot_password_missing_csrf_token(self): + self._test_forgot_password_helper_error({ + "username": "test_user_1", + "email": "test@example.com", + }, {"csrf_token": "The CSRF token is missing."}, False) + + def test_forgot_password_user_email_mismatch(self): + self.create_user({ + "username": "test_user_2", + "email": "test2@example.com", + "password": "", + "confirm_password": "", + }) + self._test_forgot_password_helper_error({ + "email": "test2@example.com", + "username": "test_user_1" + }, {"email": "User with given username (test_user_1) and email (test2@example.com) combination not found."}) + + def test_reset_password_logged_in(self): + self.create_user() + self.client.post("/login", data={ + "username": "test_user_1", + "password": "", + "csrf_token": g.csrf_token + }) + response = self.client.get("/reset-password") + self.assertEqual(response.status_code, 302) + self.assertEqual(response.location, "/") + + response = self.client.post("/reset-password") + self.assertEqual(response.status_code, 302) + self.assertEqual(response.location, "/") + + def test_reset_password_success(self): + self._test_forgot_password_helper({ + "username": "test_user_1", + "email": "test@example.com", + }, 302) + self.assertMessageFlashed("Password reset link sent!", "success") + reset_password_link = self.get_context_variable("reset_password_link") + response = self.client.post(reset_password_link, data={ + "password": "", + "confirm_password": "", + "csrf_token": g.csrf_token + }) + self.assertEqual(response.status_code, 302) + self.assertMessageFlashed("Password reset!", "success") + + # test old password doesn't work + response = self.client.post("/login", data={ + "username": "test_user_1", + "password": "", + "csrf_token": g.csrf_token + }) + self.assertEqual(response.status_code, 200) + self.assertTrue(current_user.is_anonymous) + self.assertEqual( + json.loads(self.get_context_variable("props"))["initial_errors"], + {"password": "Invalid username or password."} + ) + + # test new password works + response = self.client.post("/login", data={ + "username": "test_user_1", + "password": "", + "csrf_token": g.csrf_token + }) + self.assertEqual(response.status_code, 302) + self.assertFalse(current_user.is_anonymous) + self.assertEqual(current_user.name, "test_user_1") + + def test_reset_password_missing_checksum(self): + self.create_user() + timestamp = int(datetime.now().timestamp()) + user = User.get(name="test_user_1") + reset_password_link = url_for("users.reset_password", user_id=user.id, timestamp=timestamp, _external=True) + + response = self.client.get(reset_password_link) + self.assertEqual(response.status_code, 302) + self.assertEqual(response.location, "/") + self.assertMessageFlashed("Unable to reset password.", "error") + + response = self.client.post(reset_password_link, data={ + "password": "", + "confirm_password": "", + "csrf_token": g.csrf_token + }) + self.assertEqual(response.location, "/") + self.assertMessageFlashed("Unable to reset password.", "error") + + def test_reset_password_invalid_user(self): + self.create_user() + timestamp = int(datetime.now().timestamp()) + checksum = checksum = create_email_link_checksum(RESET_PASSWORD, 1000, "test@example.com", timestamp) + reset_password_link = url_for("users.reset_password", user_id=1000, timestamp=timestamp, checksum=checksum, _external=True) + + response = self.client.get(reset_password_link) + self.assertEqual(response.status_code, 302) + self.assertEqual(response.location, "/") + self.assertMessageFlashed("User not found.", "error") + + response = self.client.post(reset_password_link, data={ + "password": "", + "confirm_password": "", + "csrf_token": g.csrf_token + }) + self.assertEqual(response.location, "/") + self.assertMessageFlashed("User not found.", "error") + + def test_reset_password_expired(self): + self._test_forgot_password_helper({ + "username": "test_user_1", + "email": "test@example.com", + }, 302) + self.assertMessageFlashed("Password reset link sent!", "success") + reset_password_link = self.get_context_variable("reset_password_link") + + with freeze_time(datetime.now(timezone.utc) + timedelta(days=1)) as frozen_time: + # freezing and moving time expires the csrf_token which is constant for a given test request context + # unless manually reset + g.csrf_token = generate_csrf() + + response = self.client.post(reset_password_link, data={ + "password": "", + "confirm_password": "", + "csrf_token": g.csrf_token + }) + self.assertEqual(response.status_code, 302) + self.assertMessageFlashed("Password reset link expired.", "error") diff --git a/metabrainz/views.py b/metabrainz/views.py deleted file mode 100644 index 8808e3b5..00000000 --- a/metabrainz/views.py +++ /dev/null @@ -1,126 +0,0 @@ -import datetime -from flask import Blueprint, render_template, redirect, url_for, make_response -from flask_login import current_user -from metabrainz.model.supporter import Supporter - -index_bp = Blueprint('index', __name__) - - -@index_bp.route('/') -def home(): - return render_template( - 'index/index.html', - good_supporters=Supporter.get_featured(limit=4, with_logos=True), - bad_supporters=Supporter.get_featured(in_deadbeat_club=True, limit=4), - ) - - -@index_bp.route('/about') -def about(): - return render_template('index/about.html') - - -@index_bp.route('/projects') -def projects(): - return render_template('index/projects.html') - - -@index_bp.route('/team') -def team(): - return render_template('index/team.html') - - -@index_bp.route('/contact') -def contact(): - # Dear intelligent people who hate advertisers: - # No, we have no plans to add advertising, SEO, or software monetization to any of our pages. - # We are sick of being constantly harassed by advertisers, so we are giving them a place - # to send their proposals to. We're never going to read them. We're never going to respond to - # any of the proposals. And the deadline will always be extended to next month. :) - today = datetime.date.today() - today += datetime.timedelta(31) - ad_deadline = today.replace(day=1) - return render_template('index/contact.html', ad_deadline=ad_deadline) - - -@index_bp.route('/social-contract') -def social_contract(): - return render_template('index/social-contract.html') - - -@index_bp.route('/code-of-conduct') -def code_of_conduct(): - return render_template('index/code-of-conduct.html') - - -@index_bp.route('/conflict-policy') -def conflict_policy(): - return render_template('index/conflict-policy.html') - - -@index_bp.route('/sponsors') -def sponsors(): - return render_template('index/sponsors.html') - - -@index_bp.route('/bad-customers') -def bad_customers(): - return render_template( - 'index/bad-customers.html', - bad_supporters=Supporter.get_featured(in_deadbeat_club=True), - ) - - -@index_bp.route('/privacy') -def privacy_policy(): - return render_template('index/privacy.html') - - -@index_bp.route('/gdpr') -def gdpr_statement(): - return render_template('index/gdpr.html') - - -@index_bp.route('/about/customers.html') -def about_customers_redirect(): - return redirect(url_for('supporters.supporters_list'), 301) - - -@index_bp.route('/shop') -def shop(): - return render_template('index/shop.html') - - -@index_bp.route('/datasets') -def datasets(): - return render_template('index/datasets.html') - - -@index_bp.route('/datasets/postgres-dumps') -def postgres_dumps(): - return render_template('index/datasets/postgres-dumps.html') - - -@index_bp.route('/datasets/derived-dumps') -def derived_dumps(): - return render_template('index/datasets/derived-dumps.html') - - -@index_bp.route('/datasets/signup') -def signup(): - if current_user.is_authenticated: - return redirect(url_for("index.download")) - - return render_template('index/datasets/signup.html') - - -@index_bp.route('/datasets/download') -def download(): - return render_template('index/datasets/download.html') - - -@index_bp.route('/funding.json') -def funding_json(): - r = make_response(render_template('index/funding.json')) - r.mimetype = 'application/json' - return r diff --git a/reports/tests.xml b/reports/tests.xml new file mode 100644 index 00000000..4388c20e --- /dev/null +++ b/reports/tests.xml @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/requirements.txt b/requirements.txt index 8fc0cc46..9c9677b9 100644 --- a/requirements.txt +++ b/requirements.txt @@ -3,17 +3,17 @@ certifi==2025.1.31 click==8.1.7 email_validator==2.1.1 Flask==3.0.2 -Flask-Admin==1.6.1 +git+https://github.com/pallets-eco/flask-admin.git@a4e7be8b08c6b95179dc691f9887d96be32b68e7 Flask-Babel==4.0.0 Flask-Bcrypt==1.0.1 Flask-DebugToolbar@git+https://github.com/amCap1712/flask-debugtoolbar.git@f42bb238cd3fbc79c51b93c341164c2be820025e Flask-Login==0.6.3 -Flask-SQLAlchemy==3.0.5 +Flask-SQLAlchemy==3.1.1 Flask-Testing==0.8.1 Flask-UUID==0.2 -Flask-WTF==1.2.1 +Flask-WTF==1.2.2 git+https://github.com/maxcountryman/flask-uploads.git@f66d7dc93e68#egg=Flask_Uploads -git+https://github.com/metabrainz/brainzutils-python.git@v2.7.1 +git+https://github.com/metabrainz/brainzutils-python.git@v2.9.0 idna==3.7 importlib-metadata>=3.10.0 intuit-oauth==1.2.5 @@ -24,7 +24,7 @@ msgpack==0.5.6 psycopg2-binary==2.9.10 pytest==8.1.1 pytest-cov==4.1.0 -freezegun==1.4.0 +freezegun==1.5.1 python-dateutil==2.9.0.post0 python-quickbooks==0.9.7 pytz==2024.1 @@ -34,9 +34,9 @@ reportlab==4.1.0 requests==2.32.4 sentry-sdk[flask]==2.10.0 six==1.16.0 -SQLAlchemy==1.4.52 +SQLAlchemy==2.0.36 sqlalchemy-dst>=1.0.1 stripe==8.7.0 urllib3==2.5.0 Werkzeug==3.0.6 -WTForms==3.1.2 +WTForms==3.2.1 diff --git a/webpack.config.js b/webpack.config.js index 47b5f33e..38a8161e 100644 --- a/webpack.config.js +++ b/webpack.config.js @@ -49,15 +49,18 @@ module.exports = function (env, argv) { jsDir, "src/forms/SignupNonCommercial.tsx" ), - supporterProfileEdit: path.resolve( - jsDir, - "src/forms/SupporterProfileEdit.tsx" - ), createApplication: path.resolve(jsDir, "src/forms/CreateApplication.tsx"), deleteApplication: path.resolve(jsDir, "src/forms/DeleteApplication.tsx"), oauthPrompt: path.resolve(jsDir, "src/forms/OAuthPrompt.tsx"), applications: path.resolve(jsDir, "src/Applications.tsx"), oauthError: path.resolve(jsDir, "src/OAuthError.tsx"), + signupUser: path.resolve(jsDir, "src/forms/SignupUser.tsx"), + loginUser: path.resolve(jsDir, "src/forms/LoginUser.tsx"), + lostPassword: path.resolve(jsDir, "src/forms/LostPassword.tsx"), + lostUsername: path.resolve(jsDir, "src/forms/LostUsername.tsx"), + resetPassword: path.resolve(jsDir, "src/forms/ResetPassword.tsx"), + profileEdit: path.resolve(jsDir, "src/forms/ProfileEdit.tsx"), + profile: path.resolve(jsDir, "src/Profile.tsx"), }, output: { filename: isProd ? "[name].[contenthash].js" : "[name].js",