 }})
{{else}}{{ getInitials(user.fullname) }}
{{/if}}{{else}}{{#if user.avatar }}{{else}}{{ getInitials(user.fullname) }}
{{/if}}{{/if}}`,
+ template: `{{#if user.profile_url && addprofilelink }}{{#if user.logo_url }}{{else}}{{ getInitials(user.fullname) }}
{{/if}}{{else}}{{#if user.logo_url }}{{else}}{{ getInitials(user.fullname) }}
{{/if}}{{/if}}`,
data: {
addprofilelink: true,
size: 'medium',
- getInitials: window.Hasgeek.Utils.getInitials,
+ getInitials: Utils.getInitials,
imgurl() {
- return `${this.get('user').avatar}?size=${encodeURIComponent(
- window.Hasgeek.Config.userAvatarImgSize[this.get('size')]
+ return `${this.get('user').logo_url}?size=${encodeURIComponent(
+ USER_AVATAR_IMG_SIZE[this.get('size')]
)}`;
},
getAvatarColour(name) {
- return window.Hasgeek.Utils.getAvatarColour(name);
+ return Utils.getAvatarColour(name);
},
},
});
diff --git a/funnel/assets/js/utils/read_status.js b/funnel/assets/js/utils/read_status.js
new file mode 100644
index 000000000..71fe7e1e3
--- /dev/null
+++ b/funnel/assets/js/utils/read_status.js
@@ -0,0 +1,167 @@
+import { MOBILE_BREAKPOINT, NOTIFICATION_REFRESH_INTERVAL } from '../constants';
+import Utils from './helper';
+
+const ReadStatus = {
+ setNotifyIcon(unread) {
+ if (unread) {
+ $('.header__nav-links--updates').addClass('header__nav-links--updates--unread');
+ } else {
+ $('.header__nav-links--updates').removeClass(
+ 'header__nav-links--updates--unread'
+ );
+ }
+ },
+ async updateNotificationStatus() {
+ const response = await fetch(window.Hasgeek.Config.notificationCount, {
+ headers: {
+ Accept: 'application/x.html+json',
+ 'X-Requested-With': 'XMLHttpRequest',
+ },
+ });
+ if (response && response.ok) {
+ const responseData = await response.json();
+ ReadStatus.setNotifyIcon(responseData.unread);
+ }
+ },
+ async sendNotificationReadStatus() {
+ const notificationID = Utils.getQueryString('utm_source');
+ const Base58regex = /[\d\w]{21,22}/;
+
+ if (notificationID && Base58regex.test(notificationID)) {
+ const url = window.Hasgeek.Config.markNotificationReadUrl.replace(
+ 'eventid_b58',
+ notificationID
+ );
+ const response = await fetch(url, {
+ method: 'POST',
+ headers: {
+ Accept: 'application/json',
+ 'Content-Type': 'application/x-www-form-urlencoded',
+ },
+ body: new URLSearchParams({
+ csrf_token: $('meta[name="csrf-token"]').attr('content'),
+ }).toString(),
+ });
+ if (response && response.ok) {
+ const responseData = await response.json();
+ if (responseData) {
+ ReadStatus.setNotifyIcon(responseData.unread);
+ }
+ }
+ }
+ },
+ headerMenuDropdown(menuBtnClass, menuWrapper, menu, url) {
+ const menuBtn = $(menuBtnClass);
+ const topMargin = 1;
+ const headerHeight = $('.header').height() + topMargin;
+ let page = 1;
+ let lazyLoader;
+ let observer;
+
+ const openMenu = () => {
+ if ($(window).width() < MOBILE_BREAKPOINT) {
+ $(menuWrapper).find(menu).animate({ top: '0' });
+ } else {
+ $(menuWrapper).find(menu).animate({ top: headerHeight });
+ }
+ $('.header__nav-links--active').addClass('header__nav-links--menuOpen');
+ menuBtn.addClass('header__nav-links--active');
+ $('body').addClass('body-scroll-lock');
+ };
+
+ const closeMenu = () => {
+ if ($(window).width() < MOBILE_BREAKPOINT) {
+ $(menuWrapper).find(menu).animate({ top: '100vh' });
+ } else {
+ $(menuWrapper).find(menu).animate({ top: '-100vh' });
+ }
+ menuBtn.removeClass('header__nav-links--active');
+ $('body').removeClass('body-scroll-lock');
+ $('.header__nav-links--active').removeClass('header__nav-links--menuOpen');
+ };
+
+ const updatePageNumber = () => {
+ page += 1;
+ };
+
+ const fetchMenu = async (pageNo = 1) => {
+ const menuUrl = `${url}?${new URLSearchParams({
+ page: pageNo,
+ }).toString()}`;
+ const response = await fetch(menuUrl, {
+ headers: {
+ 'X-Requested-With': 'XMLHttpRequest',
+ },
+ });
+ if (response && response.ok) {
+ const responseData = await response.text();
+ if (responseData) {
+ if (observer) {
+ observer.unobserve(lazyLoader);
+ $('.js-load-comments').remove();
+ }
+ $(menuWrapper).find(menu).append(responseData);
+ updatePageNumber();
+ lazyLoader = document.querySelector('.js-load-comments');
+ if (lazyLoader) {
+ observer = new IntersectionObserver(
+ (entries) => {
+ entries.forEach((entry) => {
+ if (entry.isIntersecting) {
+ fetchMenu(page);
+ }
+ });
+ },
+ {
+ rootMargin: '0px',
+ threshold: 0,
+ }
+ );
+ observer.observe(lazyLoader);
+ }
+ }
+ }
+ };
+
+ // If user logged in, preload menu
+ if ($(menuWrapper).length) {
+ fetchMenu();
+ }
+
+ // Open full screen account menu in mobile
+ menuBtn.on('click', function clickOpenCloseMenu() {
+ if ($(this).hasClass('header__nav-links--active')) {
+ closeMenu();
+ } else {
+ openMenu();
+ }
+ });
+
+ $('body').on('click', (event) => {
+ const totalBtn = $(menuBtn).toArray();
+ let isChildElem = false;
+ totalBtn.forEach((element) => {
+ isChildElem = isChildElem || $.contains(element, event.target);
+ });
+ if (
+ $(menuBtn).hasClass('header__nav-links--active') &&
+ !$(event.target).is(menuBtn) &&
+ !isChildElem
+ ) {
+ closeMenu();
+ }
+ });
+ },
+ init() {
+ ReadStatus.sendNotificationReadStatus();
+ if ($('.header__nav-links--updates').length) {
+ ReadStatus.updateNotificationStatus();
+ window.setInterval(
+ ReadStatus.updateNotificationStatus,
+ NOTIFICATION_REFRESH_INTERVAL
+ );
+ }
+ },
+};
+
+export default ReadStatus;
diff --git a/funnel/assets/js/utils/scrollhelper.js b/funnel/assets/js/utils/scrollhelper.js
index f96d152dd..068ef821e 100644
--- a/funnel/assets/js/utils/scrollhelper.js
+++ b/funnel/assets/js/utils/scrollhelper.js
@@ -1,3 +1,5 @@
+import { MOBILE_BREAKPOINT } from '../constants';
+
const ScrollHelper = {
animateScrollTo(offsetY) {
$('html,body').animate(
@@ -14,7 +16,7 @@ const ScrollHelper = {
},
getPageHeaderHeight() {
let headerHeight;
- if ($(window).width() < window.Hasgeek.Config.mobileBreakpoint) {
+ if ($(window).width() < MOBILE_BREAKPOINT) {
headerHeight = $('.mobile-nav').height();
} else {
headerHeight = $('header').height() + $('nav').height();
diff --git a/funnel/assets/js/utils/sort.js b/funnel/assets/js/utils/sort.js
index 9ccd7b194..5a879eff7 100644
--- a/funnel/assets/js/utils/sort.js
+++ b/funnel/assets/js/utils/sort.js
@@ -1,6 +1,7 @@
import 'jquery-ui';
import 'jquery-ui-sortable-npm';
import 'jquery-ui-touch-punch';
+import toastr from 'toastr';
import Form from './formhelper';
function SortItem(wrapperJqueryElem, placeholderClass, sortUrl) {
@@ -30,9 +31,10 @@ function SortItem(wrapperJqueryElem, placeholderClass, sortUrl) {
function handleError(error) {
if (!error.response) {
- Form.handleFetchNetworkError();
+ toastr.error(window.Hasgeek.Config.errorMsg.networkError);
} else {
- Form.handleAjaxError(error);
+ const errorMsg = Form.handleAjaxError(error);
+ toastr.error(errorMsg);
}
wrapperJqueryElem.sortable('cancel');
}
diff --git a/funnel/assets/js/utils/spahelper.js b/funnel/assets/js/utils/spahelper.js
index 7072480f3..0cfec5fb5 100644
--- a/funnel/assets/js/utils/spahelper.js
+++ b/funnel/assets/js/utils/spahelper.js
@@ -1,3 +1,4 @@
+import toastr from 'toastr';
import Form from './formhelper';
const Spa = {
@@ -65,7 +66,7 @@ const Spa = {
},
handleError(error) {
const errorMsg = Form.getFetchError(error);
- window.toastr.error(errorMsg);
+ toastr.error(errorMsg);
},
async fetchPage(url, currentNavId, updateHistory) {
const response = await fetch(url, {
@@ -73,7 +74,9 @@ const Spa = {
Accept: 'application/x.html+json',
'X-Requested-With': 'XMLHttpRequest',
},
- }).catch(Form.handleFetchNetworkError);
+ }).catch(() => {
+ toastr.error(window.Hasgeek.Config.errorMsg.networkError);
+ });
if (response && response.ok) {
const responseData = await response.json();
if (responseData) {
diff --git a/funnel/assets/js/utils/tabs.js b/funnel/assets/js/utils/tabs.js
new file mode 100644
index 000000000..1a3259cc5
--- /dev/null
+++ b/funnel/assets/js/utils/tabs.js
@@ -0,0 +1,230 @@
+import Utils from './helper';
+
+const Tabs = {
+ overflowObserver: new ResizeObserver(function checkOverflow(entries) {
+ entries.forEach((entry) => {
+ if (Tabs.helpers.hasOverflow(entry.target))
+ $(entry.target).parent().addClass('has-overflow');
+ else $(entry.target).parent().removeClass('has-overflow');
+ });
+ }),
+ getIntersectionObserver(tablist) {
+ return new IntersectionObserver((entries) => {
+ entries.forEach(
+ (entry) => {
+ $(entry.target).data('isIntersecting', entry.isIntersecting);
+ },
+ {
+ root: tablist,
+ threshold: 1,
+ }
+ );
+ });
+ },
+ wrapAndAddIcons(tablist) {
+ const icons = Tabs.helpers.createIconset();
+ // Wrap the tabs bar with a container, to allow introduction of
+ // tabs navigation arrow icons.
+ const $leftIcons = $('').html(
+ Object.values(icons.left)
+ );
+ const $rightIcons = $('').html(
+ Object.values(icons.right)
+ );
+ $(tablist)
+ .wrap('')
+ .before($leftIcons)
+ .after($rightIcons);
+ $(icons.left.touch).click(function previousTab() {
+ tablist.dispatchEvent(new Event('previous-tab'));
+ });
+ $(icons.right.touch).click(function nextTab() {
+ tablist.dispatchEvent(new Event('next-tab'));
+ });
+ $(icons.left.scroll).click(function scrollLeft() {
+ tablist.dispatchEvent(new Event('scroll-left'));
+ });
+ $(icons.right.scroll).click(function scrollRight() {
+ tablist.dispatchEvent(new Event('scroll-right'));
+ });
+ },
+ checkScrollability() {
+ // Function to update no-scroll-left and no-scroll-right
+ // classes for tabs bar wrapper.
+ if (!Tabs.helpers.hasLeftOverflow(this))
+ $(this).parent().addClass('no-scroll-left');
+ else $(this).parent().removeClass('no-scroll-left');
+ if (!Tabs.helpers.hasRightOverflow(this))
+ $(this).parent().addClass('no-scroll-right');
+ else $(this).parent().removeClass('no-scroll-right');
+ },
+ getLeftScrollIndex(tablist, $tabs) {
+ const tablistWidth = tablist.clientWidth;
+ // Find the first visible tab.
+ let firstVisible = 0;
+ while (
+ firstVisible < $tabs.length - 1 &&
+ !$($tabs.get(firstVisible)).data('isIntersecting')
+ )
+ firstVisible += 1;
+ // Calculate the tab to switch to.
+ let switchTo = firstVisible;
+ const end = tablist.scrollLeft;
+ while (
+ switchTo >= 0 &&
+ end - $tabs.get(switchTo).parentElement.offsetLeft < tablistWidth
+ )
+ switchTo -= 1;
+ return switchTo + 1;
+ },
+ getRightScrollIndex($tabs) {
+ // Calculate tab to switch to.
+ let switchTo = $tabs.length - 1;
+ while (switchTo > 0 && !$($tabs[switchTo]).data('isIntersecting')) switchTo -= 1;
+ return switchTo;
+ },
+ addScrollListeners(tablist, $tabs) {
+ function scrollTo(i) {
+ tablist.scrollLeft = $tabs.get(i).offsetLeft - tablist.offsetLeft;
+ }
+ tablist.addEventListener('scroll-left', function scrollLeft() {
+ scrollTo(Tabs.getLeftScrollIndex(tablist, $tabs));
+ });
+ tablist.addEventListener('scroll-right', function scrollRight() {
+ scrollTo(Tabs.getRightScrollIndex($tabs));
+ });
+ $(tablist).scroll(Utils.debounce(Tabs.checkScrollability, 500));
+ },
+ addNavListeners(tablist, $tabs) {
+ let index = 0;
+ function activateCurrent() {
+ window.mui.tabs.activate($($tabs.get(index)).data('mui-controls'));
+ }
+ tablist.addEventListener('previous-tab', function previousTab() {
+ if (index > 0) index -= 1;
+ else index = $tabs.length - 1;
+ activateCurrent();
+ });
+ tablist.addEventListener('next-tab', function nextTab() {
+ if (index < $tabs.length - 1) index += 1;
+ else index = 0;
+ activateCurrent();
+ });
+ $tabs.each(function addTabListeners(tabIndex, tab) {
+ tab.addEventListener('mui.tabs.showend', function tabActivated(ev) {
+ index = tabIndex;
+ ev.srcElement.scrollIntoView();
+ });
+ });
+ },
+ enhanceARIA(tablist, $tabs) {
+ $tabs.on('keydown', function addArrowNav(event) {
+ const [LEFT, UP, RIGHT, DOWN] = [37, 38, 39, 40];
+ const k = event.which || event.keyCode;
+ if (k >= LEFT && k <= DOWN) {
+ switch (k) {
+ case LEFT:
+ case UP:
+ tablist.dispatchEvent(new Event('previous-tab'));
+ break;
+ case RIGHT:
+ case DOWN:
+ tablist.dispatchEvent(new Event('next-tab'));
+ break;
+ default:
+ }
+ event.preventDefault();
+ }
+ });
+ $tabs.each(function addTabListeners(tabIndex, tab) {
+ tab.addEventListener('mui.tabs.showend', function tabActivated(ev) {
+ $(ev.srcElement).attr({ tabindex: 0, 'aria-selected': 'true' }).focus();
+ });
+ tab.addEventListener('mui.tabs.hideend', function tabDeactivated(ev) {
+ $(ev.srcElement).attr({ tabindex: -1, 'aria-selected': 'false' }).focus();
+ });
+ });
+ },
+ async processTablist(index, tablist) {
+ const $tablist = $(tablist);
+ const $tabs = $tablist.find('[role=tab]');
+ const isMarkdown = $tablist.parent().hasClass('md-tabset');
+ let visibilityObserver;
+ let $tablistContainer;
+ Tabs.addNavListeners(tablist, $tabs);
+ if (isMarkdown) {
+ $tablist.addClass('mui-tabs__bar');
+ Tabs.addScrollListeners(tablist, $tabs);
+ Tabs.wrapAndAddIcons(tablist);
+ $tablistContainer = $tablist.parent();
+ Tabs.overflowObserver.observe(tablist);
+ visibilityObserver = Tabs.getIntersectionObserver(tablist);
+ Tabs.checkScrollability.bind(tablist)();
+ }
+ $tabs.each(function processTab(tabIndex, tab) {
+ if (isMarkdown) {
+ $(tab)
+ .attr('data-mui-toggle', 'tab')
+ .attr('data-mui-controls', $(tab).attr('aria-controls'));
+ visibilityObserver.observe(tab);
+ const $panel = $(`#${$(tab).attr('aria-controls')}`);
+ $panel.mouseenter(
+ $tablistContainer.addClass.bind($tablistContainer, 'has-panel-hover')
+ );
+ $panel.mouseleave(
+ $tablistContainer.removeClass.bind($tablistContainer, 'has-panel-hover')
+ );
+ }
+ });
+ Tabs.enhanceARIA(tablist, $tabs);
+ $tablist.addClass('activated').removeClass('activating');
+ },
+ process($parentElement, $tablists) {
+ $parentElement.find('.md-tabset [role=tabpanel]').addClass('mui-tabs__pane');
+ $parentElement.find('.md-tabset .md-tab-active').addClass('mui--is-active');
+ $tablists.each(this.processTablist);
+ },
+ async init(container) {
+ const $parentElement = $(container || 'body');
+ const $tablists = $parentElement.find(
+ '[role=tablist]:not(.activating, .activated)'
+ );
+ $tablists.addClass('activating');
+ this.process($parentElement, $tablists);
+ },
+ helpers: {
+ createIconset() {
+ return {
+ left: {
+ touch: this.createIcon('touch', 'left'),
+ scroll: this.createIcon('scroll', 'left'),
+ },
+ right: {
+ touch: this.createIcon('touch', 'right'),
+ scroll: this.createIcon('scroll', 'right'),
+ },
+ };
+ },
+ createIcon(mode, direction) {
+ return Utils.getFaiconHTML(`angle-${direction}`, 'body', true, [
+ `tabs-nav-icon-${direction}`,
+ `js-tabs-${mode}`,
+ ]);
+ },
+ hasOverflow(el) {
+ return el.scrollLeft + el.scrollWidth > el.clientWidth;
+ },
+ hasLeftOverflow(el) {
+ return Boolean(el.scrollLeft);
+ },
+ hasRightOverflow(el) {
+ return (
+ el.scrollLeft + el.clientWidth + el.offsetLeft <
+ el.children[el.children.length - 1].offsetLeft +
+ el.children[el.children.length - 1].clientWidth
+ );
+ },
+ },
+};
+
+export default Tabs;
diff --git a/funnel/assets/js/utils/ticket_widget.js b/funnel/assets/js/utils/ticket_widget.js
new file mode 100644
index 000000000..f791cd843
--- /dev/null
+++ b/funnel/assets/js/utils/ticket_widget.js
@@ -0,0 +1,158 @@
+import { AJAX_TIMEOUT, RETRY_INTERVAL } from '../constants';
+import Analytics from './analytics';
+
+const Ticketing = {
+ init(tickets) {
+ if (tickets.boxofficeUrl) {
+ this.initBoxfficeWidget(tickets);
+ }
+
+ this.initTicketModal();
+ },
+
+ initBoxfficeWidget({
+ boxofficeUrl,
+ widgetElem,
+ org,
+ itemCollectionId,
+ itemCollectionTitle,
+ }) {
+ let url;
+
+ if (boxofficeUrl.slice(-1) === '/') {
+ url = `${boxofficeUrl}boxoffice.js`;
+ } else {
+ url = `${boxofficeUrl}/boxoffice.js`;
+ }
+
+ $.get({
+ url,
+ crossDomain: true,
+ timeout: AJAX_TIMEOUT,
+ retries: 5,
+ retryInterval: RETRY_INTERVAL,
+
+ success(data) {
+ const boxofficeScript = document.createElement('script');
+ boxofficeScript.innerHTML = data.script;
+ document.getElementsByTagName('body')[0].appendChild(boxofficeScript);
+ },
+
+ error(response) {
+ const ajaxLoad = this;
+ ajaxLoad.retries -= 1;
+ let errorMsg;
+
+ if (response.readyState === 4) {
+ errorMsg = window.gettext(
+ 'The server is experiencing difficulties. Try again in a few minutes'
+ );
+ $(widgetElem).html(errorMsg);
+ } else if (response.readyState === 0) {
+ if (ajaxLoad.retries < 0) {
+ if (!navigator.onLine) {
+ errorMsg = window.gettext('This device has no internet connection');
+ } else {
+ errorMsg = window.gettext(
+ 'Unable to connect. If this device is behind a firewall or using any script blocking extension (like Privacy Badger), please ensure your browser can load boxoffice.hasgeek.com, api.razorpay.com and checkout.razorpay.com'
+ );
+ }
+
+ $(widgetElem).html(errorMsg);
+ } else {
+ setTimeout(() => {
+ $.get(ajaxLoad);
+ }, ajaxLoad.retryInterval);
+ }
+ }
+ },
+ });
+ window.addEventListener(
+ 'onBoxofficeInit',
+ () => {
+ window.Boxoffice.init({
+ org,
+ itemCollection: itemCollectionId,
+ paymentDesc: itemCollectionTitle,
+ });
+ },
+ false
+ );
+ $(document).on('boxofficeTicketingEvents', (event, userAction, label, value) => {
+ Analytics.sendToGA('ticketing', userAction, label, value);
+ });
+ $(document).on(
+ 'boxofficeShowPriceEvent',
+ (event, prices, currency, quantityAvailable) => {
+ let price;
+ let maxPrice;
+ const isTicketAvailable =
+ quantityAvailable.length > 0
+ ? Math.min.apply(null, quantityAvailable.filter(Boolean))
+ : 0;
+ const minPrice = prices.length > 0 ? Math.min(...prices) : -1;
+ if (!isTicketAvailable || minPrice < 0) {
+ $('.js-tickets-available').addClass('mui--hide');
+ $('.js-tickets-not-available').removeClass('mui--hide');
+ $('.js-open-ticket-widget')
+ .addClass('mui--is-disabled')
+ .prop('disabled', true);
+ } else {
+ price = `${currency}${minPrice}`;
+ if (prices.length > 1) {
+ maxPrice = Math.max(...prices);
+ price = `${currency}${minPrice} - ${currency}${maxPrice}`;
+ }
+ $('.js-ticket-price').text(price);
+ }
+ }
+ );
+ },
+
+ initTicketModal() {
+ this.urlHash = '#tickets';
+ if (window.location.hash.indexOf(this.urlHash) > -1) {
+ this.openTicketModal();
+ }
+
+ $('.js-open-ticket-widget').click((event) => {
+ event.preventDefault();
+ this.openTicketModal();
+ });
+
+ $('body').on('click', '#close-ticket-widget', (event) => {
+ event.preventDefault();
+ this.hideTicketModal();
+ });
+
+ $(window).on('popstate', () => {
+ this.hideTicketModal();
+ });
+ },
+
+ openTicketModal() {
+ window.history.pushState(
+ {
+ openModal: true,
+ },
+ '',
+ this.urlHash
+ );
+ $('.header').addClass('header--lowzindex');
+ $('.tickets-wrapper__modal').addClass('tickets-wrapper__modal--show');
+ $('.tickets-wrapper__modal').show();
+ },
+
+ hideTicketModal() {
+ if ($('.tickets-wrapper__modal').hasClass('tickets-wrapper__modal--show')) {
+ $('.header').removeClass('header--lowzindex');
+ $('.tickets-wrapper__modal').removeClass('tickets-wrapper__modal--show');
+ $('.tickets-wrapper__modal').hide();
+ if (window.history.state.openModal) {
+ window.history.back();
+ }
+ }
+ },
+};
+
+export default Ticketing;
diff --git a/funnel/assets/js/utils/timezone.js b/funnel/assets/js/utils/timezone.js
new file mode 100644
index 000000000..500be97fc
--- /dev/null
+++ b/funnel/assets/js/utils/timezone.js
@@ -0,0 +1,15 @@
+import 'jquery.cookie';
+
+// Detect timezone for login
+async function setTimezoneCookie() {
+ if (!$.cookie('timezone')) {
+ let timezone = Intl.DateTimeFormat()?.resolvedOptions()?.timeZone;
+ if (!timezone) {
+ const { default: jstz } = await import('jstz');
+ timezone = jstz.determine().name();
+ }
+ $.cookie('timezone', timezone, { path: '/' });
+ }
+}
+
+export default setTimezoneCookie;
diff --git a/funnel/assets/js/utils/translations.js b/funnel/assets/js/utils/translations.js
index c7d3c7a3e..28ec47b1c 100644
--- a/funnel/assets/js/utils/translations.js
+++ b/funnel/assets/js/utils/translations.js
@@ -1,11 +1,15 @@
import Gettext from './gettext';
+const AVAILABLE_LANGUAGES = {
+ en: 'en_IN',
+ hi: 'hi_IN',
+};
+
function getLocale() {
// Instantiate i18n with browser context
const { lang } = document.documentElement;
const langShortForm = lang.substring(0, 2);
- window.Hasgeek.Config.locale =
- window.Hasgeek.Config.availableLanguages[langShortForm];
+ window.Hasgeek.Config.locale = AVAILABLE_LANGUAGES[langShortForm];
return window.Hasgeek.Config.locale;
}
diff --git a/funnel/assets/js/utils/update_parsley_config.js b/funnel/assets/js/utils/update_parsley_config.js
new file mode 100644
index 000000000..8fdb4dd17
--- /dev/null
+++ b/funnel/assets/js/utils/update_parsley_config.js
@@ -0,0 +1,49 @@
+function updateParsleyConfig() {
+ // Override Parsley.js's default messages after the page loads.
+ // Our versions don't use full stops after phrases.
+ window.ParsleyConfig = {
+ errorsWrapper: '',
+ errorTemplate: '',
+ errorClass: 'has-error',
+ classHandler(ParsleyField) {
+ return ParsleyField.$element.closest('.mui-form__fields');
+ },
+ errorsContainer(ParsleyField) {
+ return ParsleyField.$element.closest('.mui-form__controls');
+ },
+ i18n: {
+ en: {},
+ },
+ };
+
+ window.ParsleyConfig.i18n.en = $.extend(window.ParsleyConfig.i18n.en || {}, {
+ defaultMessage: 'This value seems to be invalid',
+ notblank: 'This value should not be blank',
+ required: 'This value is required',
+ pattern: 'This value seems to be invalid',
+ min: 'This value should be greater than or equal to %s',
+ max: 'This value should be lower than or equal to %s',
+ range: 'This value should be between %s and %s',
+ minlength: 'This value is too short. It should have %s characters or more',
+ maxlength: 'This value is too long. It should have %s characters or fewer',
+ length: 'This value should be between %s and %s characters long',
+ mincheck: 'You must select at least %s choices',
+ maxcheck: 'You must select %s choices or fewer',
+ check: 'You must select between %s and %s choices',
+ equalto: 'This value should be the same',
+ });
+
+ window.ParsleyConfig.i18n.en.type = $.extend(
+ window.ParsleyConfig.i18n.en.type || {},
+ {
+ email: 'This value should be a valid email',
+ url: 'This value should be a valid url',
+ number: 'This value should be a valid number',
+ integer: 'This value should be a valid integer',
+ digits: 'This value should be digits',
+ alphanum: 'This value should be alphanumeric',
+ }
+ );
+}
+
+export default updateParsleyConfig;
diff --git a/funnel/assets/js/utils/vegaembed.js b/funnel/assets/js/utils/vegaembed.js
index b23077e13..c409a708a 100644
--- a/funnel/assets/js/utils/vegaembed.js
+++ b/funnel/assets/js/utils/vegaembed.js
@@ -1,8 +1,7 @@
async function addVegaSupport(container) {
const parentElement = $(container || 'body');
if (
- parentElement.find('.md-embed-vega-lite:not(.activating):not(.activated)').length >
- 0
+ parentElement.find('.md-embed-vega-lite:not(.activating, .activated)').length > 0
) {
const { default: embed } = await import('vega-embed');
const options = {
diff --git a/funnel/assets/js/utils/vue_util.js b/funnel/assets/js/utils/vue_util.js
index 23ada85d9..f4078556c 100644
--- a/funnel/assets/js/utils/vue_util.js
+++ b/funnel/assets/js/utils/vue_util.js
@@ -1,9 +1,11 @@
import Vue from 'vue/dist/vue.min';
import Utils from './helper';
+import WebShare from './webshare';
+import { USER_AVATAR_IMG_SIZE } from '../constants';
export const userAvatarUI = Vue.component('useravatar', {
template:
- '{{ getInitials(user.fullname) }}
{{ getInitials(user.fullname) }}',
+ '![]()
![]()
@@ -48,11 +49,11 @@
{{ getInitials(user.fullname) }}
{{ getInitials(user.fullname) }}',
props: {
user: Object,
addprofilelink: {
@@ -16,15 +18,15 @@ export const userAvatarUI = Vue.component('useravatar', {
},
},
methods: {
- getInitials: window.Hasgeek.Utils.getInitials,
- getAvatarColour: window.Hasgeek.Utils.getAvatarColour,
+ getInitials: Utils.getInitials,
+ getAvatarColour: Utils.getAvatarColour,
},
computed: {
imgsize() {
- return window.Hasgeek.Config.userAvatarImgSize[this.size];
+ return USER_AVATAR_IMG_SIZE[this.size];
},
imgurl() {
- return `${this.user.avatar}?size=${encodeURIComponent(this.imgsize)}`;
+ return `${this.user.logo_url}?size=${encodeURIComponent(this.imgsize)}`;
},
},
});
@@ -94,6 +96,6 @@ export const shareDropdown = Vue.component('sharedropdown', {
},
},
mounted() {
- Utils.enableWebShare();
+ WebShare.enableWebShare();
},
});
diff --git a/funnel/assets/js/utils/webshare.js b/funnel/assets/js/utils/webshare.js
new file mode 100644
index 000000000..c989b2f95
--- /dev/null
+++ b/funnel/assets/js/utils/webshare.js
@@ -0,0 +1,91 @@
+/* global gettext */
+import toastr from 'toastr';
+import Utils from './helper';
+
+const WebShare = {
+ addWebShare() {
+ if (navigator.share) {
+ $('.project-links').hide();
+ $('.hg-link-btn').removeClass('mui--hide');
+
+ const mobileShare = (title, url, text) => {
+ navigator.share({
+ title,
+ url,
+ text,
+ });
+ };
+
+ $('body').on('click', '.hg-link-btn', function clickWebShare(event) {
+ event.preventDefault();
+ const linkElem = this;
+ let url =
+ $(linkElem).data('url') ||
+ (document.querySelector('link[rel=canonical]') &&
+ document.querySelector('link[rel=canonical]').href) ||
+ window.location.href;
+ const title = $(this).data('title') || document.title;
+ const text = $(this).data('text') || '';
+ if ($(linkElem).attr('data-shortlink')) {
+ mobileShare(title, url, text);
+ } else {
+ Utils.fetchShortUrl(url)
+ .then((shortlink) => {
+ url = shortlink;
+ $(linkElem).attr('data-shortlink', true);
+ })
+ .finally(() => {
+ mobileShare(title, url, text);
+ });
+ }
+ });
+ } else {
+ $('body').on('click', '.js-copy-link', function clickCopyLink(event) {
+ event.preventDefault();
+ const linkElem = this;
+ const copyLink = () => {
+ const url = $(linkElem).find('.js-copy-url').first().text();
+ if (navigator.clipboard) {
+ navigator.clipboard.writeText(url).then(
+ () => toastr.success(gettext('Link copied')),
+ () => toastr.success(gettext('Could not copy link'))
+ );
+ } else {
+ const selection = window.getSelection();
+ const range = document.createRange();
+ range.selectNodeContents($(linkElem).find('.js-copy-url')[0]);
+ selection.removeAllRanges();
+ selection.addRange(range);
+ if (document.execCommand('copy')) {
+ toastr.success(gettext('Link copied'));
+ } else {
+ toastr.error(gettext('Could not copy link'));
+ }
+ selection.removeAllRanges();
+ }
+ };
+ if ($(linkElem).attr('data-shortlink')) {
+ copyLink();
+ } else {
+ Utils.fetchShortUrl($(linkElem).find('.js-copy-url').first().html())
+ .then((shortlink) => {
+ $(linkElem).find('.js-copy-url').text(shortlink);
+ $(linkElem).attr('data-shortlink', true);
+ copyLink();
+ })
+ .catch((errMsg) => {
+ toastr.error(errMsg);
+ });
+ }
+ });
+ }
+ },
+ enableWebShare() {
+ if (navigator.share) {
+ $('.project-links').hide();
+ $('.hg-link-btn').removeClass('mui--hide');
+ }
+ },
+};
+
+export default WebShare;
diff --git a/funnel/assets/sass/app.scss b/funnel/assets/sass/app.scss
index 5a94594b5..d576e4a32 100644
--- a/funnel/assets/sass/app.scss
+++ b/funnel/assets/sass/app.scss
@@ -27,7 +27,6 @@
@import 'components/chip';
@import 'components/alert';
@import 'components/thumbnail';
-@import 'components/modal';
@import 'components/tabs';
@import 'components/responsive-table';
@import 'components/card';
@@ -41,3 +40,7 @@
@import 'base/base';
@import 'base/layout';
@import 'base/utils';
+
+@import 'toastr';
+@import 'jquery-modal';
+@import 'components/modal';
diff --git a/funnel/assets/sass/base/_base.scss b/funnel/assets/sass/base/_base.scss
index ae090b7dd..089c0c25a 100644
--- a/funnel/assets/sass/base/_base.scss
+++ b/funnel/assets/sass/base/_base.scss
@@ -21,7 +21,7 @@ h3,
h4,
h5,
h6 {
- margin-top: $mui-grid-padding/2;
+ margin-top: $mui-grid-padding * 0.5;
margin-bottom: 14px;
}
@@ -125,7 +125,7 @@ samp {
blockquote {
border-left: 3px solid $mui-text-accent;
margin: 0;
- padding: 0 0 0 $mui-grid-padding/2;
+ padding: 0 0 0 $mui-grid-padding * 0.5;
margin-bottom: 14px;
}
diff --git a/funnel/assets/sass/base/_formvariable.scss b/funnel/assets/sass/base/_formvariable.scss
new file mode 100644
index 000000000..a8f76df38
--- /dev/null
+++ b/funnel/assets/sass/base/_formvariable.scss
@@ -0,0 +1,10 @@
+$mui-form-group-margin-bottom: $mui-grid-padding * 0.5;
+$mui-input-height: 32px !default;
+$mui-input-border-color: $mui-text-accent !default;
+$mui-input-border-color-focus: $mui-text-hyperlink !default;
+$mui-input-bg-color: transparent !default;
+$mui-input-font-color: $mui-text-dark;
+$mui-cursor-disabled: not-allowed;
+$mui-input-bg-color-disabled: transparent;
+$mui-text-dark-hint: rgba(#000, 0.38);
+$mui-text-dark-secondary: rgba(#000, 0.54);
diff --git a/funnel/assets/sass/base/_layout.scss b/funnel/assets/sass/base/_layout.scss
index b85911068..22b940b75 100644
--- a/funnel/assets/sass/base/_layout.scss
+++ b/funnel/assets/sass/base/_layout.scss
@@ -34,7 +34,7 @@
padding-top: $mui-grid-padding;
padding-bottom: $mui-grid-padding;
border-bottom: 1px solid $mui-divider-color;
- margin-bottom: $mui-grid-padding/2;
+ margin-bottom: $mui-grid-padding * 0.5;
}
.page-content--mob-nav {
@@ -258,7 +258,7 @@
.link-icon {
font-size: 12px;
font-weight: normal;
- padding: 0 $mui-grid-padding/2 $mui-grid-padding/2;
+ padding: 0 $mui-grid-padding * 0.5 $mui-grid-padding * 0.5;
line-height: 1;
text-transform: capitalize;
text-decoration: none !important;
diff --git a/funnel/assets/sass/base/_mui_form_essentials.scss b/funnel/assets/sass/base/_mui_form_essentials.scss
new file mode 100644
index 000000000..23d53968a
--- /dev/null
+++ b/funnel/assets/sass/base/_mui_form_essentials.scss
@@ -0,0 +1,10 @@
+@import '../base/variable';
+@import '../base/formvariable';
+@import '../mui/mixins/forms';
+@import '../mui/colors_custom';
+
+.mui--z1 {
+ box-shadow:
+ 0 1px 3px rgba(mui-color('grey'), 0.12),
+ 0 1px 2px rgba(mui-color('grey'), 0.24);
+}
diff --git a/funnel/assets/sass/base/_utils.scss b/funnel/assets/sass/base/_utils.scss
index 69ce44328..ad53ee2f1 100644
--- a/funnel/assets/sass/base/_utils.scss
+++ b/funnel/assets/sass/base/_utils.scss
@@ -11,19 +11,19 @@
}
.margin-bottom {
- margin-bottom: $mui-grid-padding/2;
+ margin-bottom: $mui-grid-padding * 0.5;
}
.margin-top {
- margin-top: $mui-grid-padding/2;
+ margin-top: $mui-grid-padding * 0.5;
}
.margin-right {
- margin-right: $mui-grid-padding/2;
+ margin-right: $mui-grid-padding * 0.5;
}
.margin-left {
- margin-left: $mui-grid-padding/2;
+ margin-left: $mui-grid-padding * 0.5;
}
.margin-auto {
@@ -71,7 +71,7 @@
}
.mui-divider--custom {
- margin: $mui-grid-padding/2 0 $mui-grid-padding * 1.5;
+ margin: $mui-grid-padding * 0.5 0 $mui-grid-padding * 1.5;
}
.separator {
@@ -98,6 +98,10 @@
align-items: flex-start;
}
+.flex-wrapper--end {
+ align-items: flex-end;
+}
+
.flex-wrapper--space-between {
justify-content: space-between;
}
@@ -194,6 +198,10 @@
color: $mui-primary-color;
}
+.primary-color-lighter-txt {
+ color: rgba($mui-primary-color-lighter, 0.75);
+}
+
.secondary-color-txt {
color: $mui-accent-color;
}
@@ -235,6 +243,17 @@
width: 100%;
}
+.img-rounded-border {
+ border-radius: 16px;
+}
+
+.img-fit {
+ position: absolute;
+ object-fit: fill;
+ width: 100%;
+ height: 100%;
+}
+
// ============================================================================
// Overlay
// ============================================================================
diff --git a/funnel/assets/sass/base/_variable.scss b/funnel/assets/sass/base/_variable.scss
index 9a492e584..c69482172 100644
--- a/funnel/assets/sass/base/_variable.scss
+++ b/funnel/assets/sass/base/_variable.scss
@@ -38,3 +38,10 @@ $xFormLabelLineHeight: 15px;
$mui-base-font-size: 14px;
$mui-base-line-height: 1.5;
$mui-box-shadow-grey: rgba(158, 158, 158, 0.12);
+
+// MUI Tabs
+$mui-tab-font-color: $mui-text-accent;
+$mui-tab-font-color-active: $mui-primary-color;
+$mui-tab-border-color-active: $mui-primary-color;
+$mui-tab-font-color-hover: $mui-neutral-color;
+$mui-tab-border-color-hover: $mui-neutral-color;
diff --git a/funnel/assets/sass/components/_button.scss b/funnel/assets/sass/components/_button.scss
index 1bef6a0a6..064ff09bd 100644
--- a/funnel/assets/sass/components/_button.scss
+++ b/funnel/assets/sass/components/_button.scss
@@ -94,6 +94,16 @@
box-shadow: none;
}
+.mui-btn--accent.mui--is-disabled,
+.mui-btn--accent.mui--is-disabled:hover,
+.mui-btn--accent.mui--is-disabled:active,
+.mui-btn--accent.mui--is-disabled:focus .mui-btn--accent.mui--is-disabled:active:hover {
+ background: $mui-bg-color-primary;
+ color: $mui-primary-color;
+ border: 1px solid $mui-primary-color;
+ box-shadow: none;
+}
+
.mui-btn--accent.mui-btn--flat {
border: none !important;
}
@@ -198,10 +208,10 @@
.nav-btn-wrapper,
.prev-next-btn-wrapper {
.btn-margin-right {
- margin-right: $mui-grid-padding/4;
+ margin-right: $mui-grid-padding * 0.25;
}
.btn-margin-left {
- margin-left: $mui-grid-padding/4;
+ margin-left: $mui-grid-padding * 0.25;
}
}
diff --git a/funnel/assets/sass/components/_card.scss b/funnel/assets/sass/components/_card.scss
index b38f71b28..879bf8f80 100644
--- a/funnel/assets/sass/components/_card.scss
+++ b/funnel/assets/sass/components/_card.scss
@@ -13,7 +13,7 @@
}
.card__title__heading {
- margin: $mui-grid-padding/4 auto;
+ margin: $mui-grid-padding * 0.25 auto;
}
.card__header {
@@ -23,16 +23,22 @@
.card__header__title {
width: 80%;
+ margin-top: 8px;
+ margin-bottom: 8px;
}
+ .card__header--danger {
+ padding: $mui-grid-padding;
+ background: $mui-danger-color;
+ }
.card__body {
- padding: $mui-grid-padding/2 $mui-grid-padding;
+ padding: $mui-grid-padding * 0.5 $mui-grid-padding;
word-break: break-word;
}
.card__footer {
clear: both;
- padding: 0 $mui-grid-padding/2;
+ padding: 0 $mui-grid-padding * 0.5;
}
.mui-btn + .mui-btn {
@@ -53,6 +59,10 @@
.card--shaped {
border-radius: 16px 16px 0 16px;
+ .card__image-wrapper {
+ border-radius: 16px 16px 0 0;
+ overflow: hidden;
+ }
}
.clickable-card:focus,
@@ -102,7 +112,7 @@
}
.card__calendar {
- padding: $mui-grid-padding/2 0 $mui-grid-padding-double;
+ padding: $mui-grid-padding * 0.5 0 $mui-grid-padding-double;
margin-left: -$mui-grid-padding;
margin-right: -$mui-grid-padding;
@@ -364,18 +374,13 @@
padding: 0 $mui-grid-padding $mui-grid-padding;
position: relative;
- .card__body__location {
- float: left;
- max-width: 90%;
- }
-
.card__body__bookmark {
float: right;
- margin: $mui-grid-padding/4 0 0;
+ margin: $mui-grid-padding * 0.25 0 0;
}
.card__body__title {
- margin: 0 0 $mui-grid-padding/2;
+ margin: 0 0 $mui-grid-padding * 0.5;
}
.card__body__title--smaller {
@@ -387,10 +392,6 @@
max-width: calc(100% - 20px);
}
- .card__body__location {
- margin: 0 0 $mui-grid-padding/2;
- float: left;
- }
.card__body__divider {
height: 4px;
background-color: $mui-bg-color-primary-dark;
@@ -404,7 +405,9 @@
}
.card--upcoming:hover {
- box-shadow: 0 14px 28px rgba(0, 0, 0, 0.25), 0 10px 10px rgba(0, 0, 0, 0.22);
+ box-shadow:
+ 0 14px 28px rgba(0, 0, 0, 0.25),
+ 0 10px 10px rgba(0, 0, 0, 0.22);
}
@media (min-width: 1200px) {
@@ -423,7 +426,7 @@
.card__image-wrapper--default:after {
content: '';
position: absolute;
- z-index: 2;
+ z-index: 1;
top: 0;
left: 0;
background-color: $mui-primary-color;
@@ -484,7 +487,7 @@
}
.profile-card__btn-wrapper {
margin-top: auto;
- margin-bottom: $mui-grid-padding/2;
+ margin-bottom: $mui-grid-padding * 0.5;
}
}
diff --git a/funnel/assets/sass/components/_chip.scss b/funnel/assets/sass/components/_chip.scss
index 949eaf11a..4d80fb1bf 100644
--- a/funnel/assets/sass/components/_chip.scss
+++ b/funnel/assets/sass/components/_chip.scss
@@ -1,5 +1,5 @@
.chip {
- padding: 0 8px 2px;
+ padding: 2px 8px 2px;
border-radius: 16px;
display: inline-block;
white-space: nowrap;
@@ -34,6 +34,12 @@
color: mui-color('white');
}
+.chip--bg-success {
+ background-color: $mui-success-color;
+ border-color: transparentize($mui-text-success, 0.8);
+ color: $mui-text-success;
+}
+
.chip + .chip {
margin-left: $mui-btn-spacing-horizontal;
}
diff --git a/funnel/assets/sass/components/_collapsible.scss b/funnel/assets/sass/components/_collapsible.scss
index c956144d9..91c3e29f4 100644
--- a/funnel/assets/sass/components/_collapsible.scss
+++ b/funnel/assets/sass/components/_collapsible.scss
@@ -16,7 +16,7 @@
}
.collapsible__header--inner {
- padding: $mui-grid-padding/2;
+ padding: $mui-grid-padding * 0.5;
background: $mui-bg-color-accent;
}
diff --git a/funnel/assets/sass/components/_draggablebox.scss b/funnel/assets/sass/components/_draggablebox.scss
index 89fa3d69f..3f0162022 100644
--- a/funnel/assets/sass/components/_draggablebox.scss
+++ b/funnel/assets/sass/components/_draggablebox.scss
@@ -81,9 +81,9 @@
}
.drag-box__body {
- padding-bottom: $mui-grid-padding/2;
+ padding-bottom: $mui-grid-padding * 0.5;
.drag-box__body__options {
- margin-right: $mui-grid-padding/4;
+ margin-right: $mui-grid-padding * 0.25;
}
}
@@ -91,7 +91,7 @@
display: flex;
float: right;
.drag-box__action-btn {
- padding-right: $mui-grid-padding/4;
+ padding-right: $mui-grid-padding * 0.25;
}
}
}
diff --git a/funnel/assets/sass/components/_header.scss b/funnel/assets/sass/components/_header.scss
index ead55bcfa..02a476f6f 100644
--- a/funnel/assets/sass/components/_header.scss
+++ b/funnel/assets/sass/components/_header.scss
@@ -45,7 +45,8 @@
bottom: $mui-header-height;
width: 100%;
left: 0;
- box-shadow: 0 1px 3px rgba(158, 158, 158, 0.12),
+ box-shadow:
+ 0 1px 3px rgba(158, 158, 158, 0.12),
0 1px 2px rgba(158, 158, 158, 0.24);
display: none;
@@ -214,7 +215,7 @@
}
}
li .header__dropdown__item {
- padding: $mui-grid-padding/2 $mui-grid-padding $mui-grid-padding/2;
+ padding: $mui-grid-padding * 0.5 $mui-grid-padding $mui-grid-padding * 0.5;
}
li .header__dropdown__item--morepadding {
padding-left: 24px;
@@ -264,7 +265,7 @@
align-items: end;
.user__box__banner {
width: 60px;
- margin-right: $mui-grid-padding/2;
+ margin-right: $mui-grid-padding * 0.5;
.user__box__banner__wrapper {
position: relative;
width: 100%;
@@ -279,15 +280,15 @@
}
.user__box__banner__wrapper__icon {
position: absolute;
- bottom: $mui-grid-padding/4;
- right: $mui-grid-padding/4;
+ bottom: $mui-grid-padding * 0.25;
+ right: $mui-grid-padding * 0.25;
}
}
}
.user__box__header.comment__details {
width: calc(100% - 70px);
.user__box__fullname {
- margin: 0 0 $mui-grid-padding/4;
+ margin: 0 0 $mui-grid-padding * 0.25;
line-height: 1;
display: flex;
width: 100%;
@@ -302,7 +303,7 @@
}
.comment__details__title {
width: calc(100% - 88px);
- margin-right: $mui-grid-padding/2;
+ margin-right: $mui-grid-padding * 0.5;
}
.comment__details__title--long {
width: 100%;
@@ -312,7 +313,7 @@
}
}
.user__box__subcontent {
- margin: 0 0 $mui-grid-padding/4;
+ margin: 0 0 $mui-grid-padding * 0.25;
line-height: 1;
display: flex;
width: 100%;
@@ -327,7 +328,7 @@
}
.comment__details__user--truncated {
width: calc(100% - 24px);
- margin-right: $mui-grid-padding/2;
+ margin-right: $mui-grid-padding * 0.5;
}
}
}
@@ -489,7 +490,9 @@
.comments-sidebar {
width: 360px;
max-height: 90vh;
- box-shadow: 0 0 2px rgba(0, 0, 0, 0.12), 0 2px 2px rgba(0, 0, 0, 0.2);
+ box-shadow:
+ 0 0 2px rgba(0, 0, 0, 0.12),
+ 0 2px 2px rgba(0, 0, 0, 0.2);
border-radius: 16px 0 16px 16px;
position: absolute;
top: -100vh;
@@ -499,7 +502,7 @@
bottom: auto;
}
.comments-sidebar {
- padding: $mui-grid-padding/2 0;
+ padding: $mui-grid-padding * 0.5 0;
}
}
}
@@ -528,7 +531,7 @@
align-items: center;
.header__site-title__home__logo,
.header__nav-links__icon {
- margin: 0 $mui-grid-padding/4 0 0;
+ margin: 0 $mui-grid-padding * 0.25 0 0;
}
.header__nav-links__text {
font-size: 14px;
@@ -619,7 +622,8 @@
.mobile-nav__icon {
display: inline-block;
- padding: $mui-grid-padding $mui-grid-padding/2 $mui-grid-padding $mui-grid-padding;
+ padding: $mui-grid-padding $mui-grid-padding * 0.5 $mui-grid-padding
+ $mui-grid-padding;
line-height: 1;
}
.mobile-nav__icon--right {
diff --git a/funnel/assets/sass/components/_list.scss b/funnel/assets/sass/components/_list.scss
index 887a3338b..58aabc962 100644
--- a/funnel/assets/sass/components/_list.scss
+++ b/funnel/assets/sass/components/_list.scss
@@ -23,7 +23,7 @@
.list--border--padding {
li {
- padding: $mui-grid-padding/2 $mui-grid-padding;
+ padding: $mui-grid-padding * 0.5 $mui-grid-padding;
}
}
diff --git a/funnel/assets/sass/components/_markdown.scss b/funnel/assets/sass/components/_markdown.scss
index f82ea65d8..4184faf36 100644
--- a/funnel/assets/sass/components/_markdown.scss
+++ b/funnel/assets/sass/components/_markdown.scss
@@ -1,4 +1,6 @@
@import 'table';
+@import 'node_modules/prismjs/themes/prism';
+@import 'node_modules/prismjs/plugins/match-braces/prism-match-braces';
.markdown {
overflow-wrap: break-word;
@@ -13,16 +15,7 @@
font-weight: 700;
a {
color: $mui-text-dark;
- display: none;
- }
- &:hover a {
- display: inline;
- }
- @media (any-pointer: coarse) {
- a {
- display: inline;
- color: $mui-text-accent;
- }
+ text-decoration: none;
}
}
diff --git a/funnel/assets/sass/components/_menu.scss b/funnel/assets/sass/components/_menu.scss
index 76b14111e..548d50bd3 100644
--- a/funnel/assets/sass/components/_menu.scss
+++ b/funnel/assets/sass/components/_menu.scss
@@ -2,9 +2,11 @@
border-radius: 0 16px 16px 16px;
padding: 0;
overflow: hidden;
- box-shadow: 0 0 2px rgba(0, 0, 0, 0.12), 0 2px 2px rgba(0, 0, 0, 0.2);
+ box-shadow:
+ 0 0 2px rgba(0, 0, 0, 0.12),
+ 0 2px 2px rgba(0, 0, 0, 0.2);
> li > a {
- padding: $mui-grid-padding/2 $mui-grid-padding;
+ padding: $mui-grid-padding * 0.5 $mui-grid-padding;
// hover & focus state
&:hover,
diff --git a/funnel/assets/sass/components/_modal.scss b/funnel/assets/sass/components/_modal.scss
index 9bceed198..ac804a51b 100644
--- a/funnel/assets/sass/components/_modal.scss
+++ b/funnel/assets/sass/components/_modal.scss
@@ -34,12 +34,6 @@
margin-top: $mui-grid-padding;
}
}
- .modal--form {
- width: 100%;
- border-radius: 0;
- overflow: auto;
- min-height: 100%;
- }
.modal--fullscreen {
width: 100%;
height: 100%;
@@ -56,7 +50,6 @@
max-width: 500px;
width: 90%;
padding: $mui-grid-padding;
- min-height: auto;
border-radius: 8px;
}
.modal--fullscreen {
diff --git a/funnel/assets/sass/components/_profileavatar.scss b/funnel/assets/sass/components/_profileavatar.scss
index 57960c426..51f362f4e 100644
--- a/funnel/assets/sass/components/_profileavatar.scss
+++ b/funnel/assets/sass/components/_profileavatar.scss
@@ -9,6 +9,7 @@
align-items: center;
justify-content: center;
overflow: hidden;
+ box-sizing: border-box;
img {
width: 100%;
height: 100%;
diff --git a/funnel/assets/sass/components/_proposal-card.scss b/funnel/assets/sass/components/_proposal-card.scss
index 6b7b90652..9df7a1e01 100644
--- a/funnel/assets/sass/components/_proposal-card.scss
+++ b/funnel/assets/sass/components/_proposal-card.scss
@@ -3,7 +3,7 @@
.proposal-card__body__inner {
.proposal-card__body__inner__headline {
.proposal-card__body__inner__headline__content {
- margin-bottom: $mui-grid-padding/2;
+ margin-bottom: $mui-grid-padding * 0.5;
}
.proposal-card__body__inner__headline__info__icon {
position: relative;
@@ -15,8 +15,8 @@
.proposal-card__body__inner__details__video {
position: relative;
width: 100%;
- margin-right: $mui-grid-padding/2;
- margin-bottom: $mui-grid-padding/2;
+ margin-right: $mui-grid-padding * 0.5;
+ margin-bottom: $mui-grid-padding * 0.5;
.proposal-card__body__inner__details__video__thumbnail {
position: relative;
width: 100%;
@@ -62,7 +62,7 @@
.proposal-card__body__inner__details__txt {
position: absolute;
left: 0;
- bottom: $mui-grid-padding/2;
+ bottom: $mui-grid-padding * 0.5;
}
}
}
diff --git a/funnel/assets/sass/components/_responsive-table.scss b/funnel/assets/sass/components/_responsive-table.scss
index b93b16b23..887622b91 100644
--- a/funnel/assets/sass/components/_responsive-table.scss
+++ b/funnel/assets/sass/components/_responsive-table.scss
@@ -28,11 +28,11 @@
padding: 10px 0;
&:first-child {
- padding-top: $mui-grid-padding/2;
+ padding-top: $mui-grid-padding * 0.5;
}
&:last-child {
- padding-bottom: $mui-grid-padding/2;
+ padding-bottom: $mui-grid-padding * 0.5;
}
&:before {
diff --git a/funnel/assets/sass/components/_search-field.scss b/funnel/assets/sass/components/_search-field.scss
index 690935c63..702671e2d 100644
--- a/funnel/assets/sass/components/_search-field.scss
+++ b/funnel/assets/sass/components/_search-field.scss
@@ -11,8 +11,8 @@
.search {
width: 100%;
- margin: 0 0 $mui-grid-padding/2;
- padding: 0 $mui-grid-padding/2;
+ margin: 0 0 $mui-grid-padding * 0.5;
+ padding: 0 $mui-grid-padding * 0.5;
border: 1px solid $mui-divider-color;
border-radius: 2px;
position: relative;
diff --git a/funnel/assets/sass/components/_subnavbar.scss b/funnel/assets/sass/components/_subnavbar.scss
index a17bf9595..4f221e422 100644
--- a/funnel/assets/sass/components/_subnavbar.scss
+++ b/funnel/assets/sass/components/_subnavbar.scss
@@ -22,7 +22,9 @@
right: 0;
z-index: 1000;
border-bottom: none;
- box-shadow: 0 1px 3px rgba(158, 158, 158, 0.12), 0 1px 2px rgba(158, 158, 158, 0.24);
+ box-shadow:
+ 0 1px 3px rgba(158, 158, 158, 0.12),
+ 0 1px 2px rgba(158, 158, 158, 0.24);
}
.sub-navbar__item:nth-child(2) {
diff --git a/funnel/assets/sass/components/_switch.scss b/funnel/assets/sass/components/_switch.scss
index 8e1e82da3..fe0957417 100644
--- a/funnel/assets/sass/components/_switch.scss
+++ b/funnel/assets/sass/components/_switch.scss
@@ -34,7 +34,9 @@
height: 20px;
background-color: #fafafa;
border-radius: 50%;
- box-shadow: 0 2px 1px -1px rgba(0, 0, 0, 0.2), 0 1px 1px 0 rgba(0, 0, 0, 0.14),
+ box-shadow:
+ 0 2px 1px -1px rgba(0, 0, 0, 0.2),
+ 0 1px 1px 0 rgba(0, 0, 0, 0.14),
0 1px 3px 0 rgba(0, 0, 0, 0.12);
}
.switch-input:checked + .switch-label:before {
diff --git a/funnel/assets/sass/components/_tabs.scss b/funnel/assets/sass/components/_tabs.scss
index 9c7b5f92e..82aa73c03 100644
--- a/funnel/assets/sass/components/_tabs.scss
+++ b/funnel/assets/sass/components/_tabs.scss
@@ -1,3 +1,138 @@
+.mui-tabs__bar:not(.mui-tabs__bar--pills) {
+ border-bottom: 1px solid $mui-tab-font-color;
+ scroll-behavior: smooth;
+ > li {
+ transition: transform 150ms ease;
+ > a {
+ text-transform: capitalize;
+ height: auto;
+ line-height: 21px;
+ padding: 6px 0 2px;
+ text-decoration: none;
+ cursor: pointer;
+ &:hover {
+ border-bottom: 2px solid $mui-tab-border-color-hover;
+ }
+ }
+ &:not(.mui--is-active) > a:hover {
+ color: $mui-tab-font-color-hover;
+ }
+ &:not(:last-child) {
+ margin-right: 12px;
+ }
+ &.mui--is-active > a {
+ border-bottom: none;
+ }
+ }
+
+ &::-webkit-scrollbar {
+ -ms-overflow-style: none; /* Internet Explorer 10+ */
+ scrollbar-width: none; /* Firefox */
+ position: relative;
+ display: none; /* Safari and Chrome */
+ }
+}
+
+.md-tablist-wrapper {
+ display: flex;
+ margin: -$mui-grid-padding * 0.5;
+ align-items: center;
+
+ > .mui-tabs__bar:not(.mui-tabs__bar--pills) {
+ display: inline-block;
+ width: calc(100% - 28px);
+ }
+
+ > [class*='tabs-nav-icons-'] {
+ width: 14px;
+ height: 16px;
+ display: inline-flex;
+ visibility: hidden;
+
+ > [class*='tabs-nav-icon-'] {
+ display: none;
+ height: 100%;
+ width: auto;
+ cursor: pointer;
+ color: $mui-tab-font-color;
+
+ &:hover {
+ color: $mui-tab-font-color-hover;
+ }
+ }
+ }
+
+ > .tabs-nav-icons-left > [class*='tabs-nav-icon-']:hover {
+ padding-right: 3px;
+ }
+
+ > .tabs-nav-icons-right > [class*='tabs-nav-icon-']:hover {
+ padding-left: 3px;
+ }
+
+ &:hover > [class*='tabs-nav-icons-'] {
+ visibility: visible;
+ }
+
+ &.has-overflow > [class*='tabs-nav-icons-'] > [class*='tabs-nav-icon-'] {
+ &.js-tabs-scroll {
+ display: inline;
+ }
+
+ &.js-tabs-touch {
+ display: none;
+ }
+
+ @media (any-pointer: coarse) {
+ &.js-tabs-scroll {
+ display: none;
+ }
+
+ &.js-tabs-touch {
+ display: inline;
+ }
+ }
+ }
+ &.no-scroll-left > .tabs-nav-icons-left,
+ &.no-scroll-right > .tabs-nav-icons-right {
+ .js-tabs-scroll {
+ visibility: hidden !important;
+ }
+ }
+
+ // Uncomment to enable hiding of nav on
+ // non-touch devices, when first / last tab
+ // is activated.
+
+ // &.tabs-active-first > .tabs-nav-icons-left,
+ // &.tabs-active-last > .tabs-nav-icons-right {
+ // .js-tabs-touch {
+ // visibility: hidden !important;
+ // }
+ // }
+
+ @media (any-pointer: coarse) {
+ > [class*='tabs-nav-icons-'] {
+ visibility: visible;
+ }
+ }
+
+ &.has-panel-hover > [class*='tabs-nav-icons-'] {
+ visibility: visible;
+ }
+}
+
+.mui-tabs__pane {
+ .mui-tabs__bar--wrapper {
+ margin: 0 -5px;
+ }
+
+ .mui-tabs__pane {
+ padding-left: 9px;
+ padding-right: 9px;
+ }
+}
+
.tab-container {
display: flex;
padding: 0;
@@ -6,7 +141,7 @@
.tab-container__tab {
flex: 1 0 0;
- padding: $mui-grid-padding/2;
+ padding: $mui-grid-padding * 0.5;
opacity: 0.4;
text-align: center;
border-bottom: 2px solid transparent;
@@ -34,7 +169,7 @@
.mui-tabs__bar--pills {
li {
border-radius: 16px;
- margin-right: $mui-grid-padding/2;
+ margin-right: $mui-grid-padding * 0.5;
color: $mui-text-light;
border: 1px solid $mui-bg-color-dark;
background: $mui-bg-color-primary;
@@ -42,7 +177,7 @@
li a {
height: auto;
line-height: inherit;
- padding: $mui-grid-padding/4 $mui-grid-padding;
+ padding: $mui-grid-padding * 0.25 $mui-grid-padding;
cursor: pointer;
color: $mui-text-light;
text-decoration: none !important;
@@ -70,12 +205,12 @@
width: 100%;
overflow: auto;
align-items: center;
- margin: $mui-grid-padding/2 0;
+ margin: $mui-grid-padding * 0.5 0;
-ms-overflow-style: none; /* IE and Edge */
scrollbar-width: none; /* Firefox */
.tabs__item {
- padding: $mui-grid-padding/4 $mui-grid-padding;
+ padding: $mui-grid-padding * 0.25 $mui-grid-padding;
cursor: pointer;
position: relative;
min-width: 2 * $mui-grid-padding;
@@ -96,7 +231,7 @@
}
.tabs__item--badge {
- padding: $mui-grid-padding/4 0 $mui-grid-padding/4 $mui-grid-padding;
+ padding: $mui-grid-padding * 0.25 0 $mui-grid-padding * 0.25 $mui-grid-padding;
}
.tabs__item:hover,
@@ -148,7 +283,7 @@
display: inline-block;
background-color: transparentize($mui-primary-color, 0.85);
border-radius: 2px;
- padding: 0 $mui-grid-padding/2;
+ padding: 0 $mui-grid-padding * 0.5;
font-size: 10px;
text-transform: uppercase;
font-weight: 600;
@@ -167,8 +302,8 @@
}
.badge--tab {
- margin-right: $mui-grid-padding/4;
- margin-left: $mui-grid-padding/4;
+ margin-right: $mui-grid-padding * 0.25;
+ margin-left: $mui-grid-padding * 0.25;
border-radius: 16px;
padding: 0 4px;
width: auto;
@@ -183,3 +318,15 @@
border: 1px solid transparent;
background: transparentize($mui-primary-color, 0.85);
}
+
+.md-tabset {
+ ul[role='tablist'] {
+ @extend .mui-tabs__bar;
+ a[role='tab'] {
+ @extend .mui--text-body2;
+ }
+ }
+ [role='tabpanel'] {
+ @extend .mui-tabs__pane, .top-padding;
+ }
+}
diff --git a/funnel/assets/sass/components/_ticket-modal.scss b/funnel/assets/sass/components/_ticket-modal.scss
new file mode 100644
index 000000000..6da18efba
--- /dev/null
+++ b/funnel/assets/sass/components/_ticket-modal.scss
@@ -0,0 +1,103 @@
+.tickets-wrapper {
+ .tickets-wrapper__modal {
+ display: none;
+ }
+
+ .tickets-wrapper__modal__back {
+ display: none;
+ }
+
+ .tickets-wrapper__modal__body__close {
+ display: block;
+ float: right;
+ }
+
+ .tickets-wrapper__modal--show {
+ position: fixed;
+ top: 0;
+ background: $mui-bg-color-primary;
+ left: 0;
+ right: 0;
+ padding: $mui-grid-padding;
+ z-index: 1001;
+ bottom: 0;
+ overflow: auto;
+
+ .tickets-wrapper__modal__back {
+ display: block;
+ }
+ }
+ .tickets-wrapper__modal--project-page.tickets-wrapper__modal--show {
+ top: 52px; // Below the header
+ }
+ .tickets-wrapper__modal--project-page .tickets-wrapper__modal__body__close {
+ display: none;
+ }
+}
+
+@media (min-width: 768px) {
+ .tickets-wrapper {
+ .tickets-wrapper__modal {
+ top: 0;
+ width: 100%;
+ height: 100%;
+ background-color: rgba(0, 0, 0, 0.75);
+ }
+ .tickets-wrapper__modal--project-page.tickets-wrapper__modal--show {
+ top: 0;
+ }
+ .tickets-wrapper__modal--project-page .tickets-wrapper__modal__body__close {
+ display: block;
+ }
+
+ .tickets-wrapper__modal__body {
+ max-width: 500px;
+ margin: auto;
+ width: 90%;
+ padding: 0;
+ min-height: auto;
+ border-radius: 16px;
+ background-color: $mui-bg-color-primary;
+ overflow: auto;
+ .tickets-wrapper__modal__body__close {
+ margin-right: $mui-grid-padding * 0.5;
+ margin-top: $mui-grid-padding * 0.5;
+ }
+ }
+ }
+}
+
+.price-btn {
+ min-width: 200px;
+ font-size: inherit;
+ padding: 0;
+ display: flex;
+ flex-direction: column;
+ align-items: center;
+ margin: 0 0 2px;
+ justify-content: center;
+ height: 42px;
+ line-height: 16px;
+ text-overflow: ellipsis;
+ white-space: nowrap;
+ overflow: hidden;
+}
+
+.price-btn__txt {
+ display: block;
+ width: 100%;
+ font-size: 14px;
+ line-height: 16px;
+ text-overflow: ellipsis;
+ white-space: nowrap;
+ overflow: hidden;
+}
+.price-btn__txt--smaller {
+ font-size: 12px;
+ line-height: 16px;
+ text-transform: initial;
+ font-weight: 400;
+ text-overflow: ellipsis;
+ white-space: nowrap;
+ overflow: auto;
+}
diff --git a/funnel/assets/sass/form.scss b/funnel/assets/sass/form.scss
index c4be2625e..fc5b85a84 100644
--- a/funnel/assets/sass/form.scss
+++ b/funnel/assets/sass/form.scss
@@ -4,6 +4,7 @@
'mui/form';
@import 'base/variable', 'base/typography', 'components/draggablebox',
'components/switch', 'components/codemirror';
+@import 'node_modules/select2/dist/css/select2';
// ============================================================================
// Form
@@ -15,13 +16,13 @@
.mui-form {
.mui-form__fields {
- margin-bottom: $mui-grid-padding/2;
+ margin-bottom: $mui-grid-padding * 0.5;
}
.mui-textfield,
.mui-radio,
.mui-checkbox {
- margin-bottom: $mui-grid-padding/4;
+ margin-bottom: $mui-grid-padding * 0.25;
}
.mui-radio,
@@ -34,7 +35,7 @@
> input[type='radio'],
> input[type='checkbox'] {
position: relative;
- margin: 0 $mui-grid-padding/2 0 0;
+ margin: 0 $mui-grid-padding * 0.5 0 0;
}
}
}
@@ -53,7 +54,7 @@
.mui-form__sidetext,
.mui-form__helptext {
color: $mui-text-light;
- margin: $mui-grid-padding/2 0 0;
+ margin: $mui-grid-padding * 0.5 0 0;
@extend .mui--text-caption;
}
@@ -87,23 +88,24 @@
}
// Codemirror editor will be initialized
- textarea.markdown {
+ textarea.markdown,
+ textarea.stylesheet {
display: none;
}
.mui-form__label {
position: static;
- margin: 0 0 $mui-grid-padding/2;
+ margin: 0 0 $mui-grid-padding * 0.5;
color: $mui-label-font-color;
@extend .mui--text-subhead;
}
.mui-form__error {
color: $mui-text-white;
- margin: $mui-grid-padding/2 0 0;
+ margin: $mui-grid-padding * 0.5 0 0;
background: $mui-text-danger;
border: 1px solid transparentize($mui-text-danger, 0.8);
- padding: $mui-grid-padding/2 $mui-grid-padding;
+ padding: $mui-grid-padding * 0.5 $mui-grid-padding;
position: relative;
box-shadow: 0 2px 4px 0 rgba(0, 0, 0, 0.14);
border-radius: 2px;
@@ -112,7 +114,7 @@
> li {
list-style: none;
- margin-top: $mui-grid-padding/2;
+ margin-top: $mui-grid-padding * 0.5;
}
}
@@ -159,7 +161,7 @@
font-weight: 500;
@extend .mui--text-body2;
transform: none;
- top: -$mui-grid-padding/4;
+ top: -$mui-grid-padding * 0.25;
}
}
}
@@ -174,10 +176,10 @@
// ============================================================================
.mui-select {
- margin-top: $mui-grid-padding/2;
+ margin-top: $mui-grid-padding * 0.5;
margin-bottom: 0;
> label {
- top: -$mui-grid-padding/4;
+ top: -$mui-grid-padding * 0.25;
}
.select2 {
width: 100% !important;
@@ -231,7 +233,7 @@
.imgee__url-holder {
display: block;
max-width: 200px;
- margin-bottom: $mui-grid-padding/2;
+ margin-bottom: $mui-grid-padding * 0.5;
}
.imgee__loader {
@@ -243,7 +245,7 @@
}
.imgee__button {
- margin-bottom: $mui-grid-padding/2;
+ margin-bottom: $mui-grid-padding * 0.5;
}
}
@@ -301,9 +303,10 @@
.modal--form {
min-width: 100%;
- min-height: 325px;
+ min-height: 100%;
height: 100%;
border-radius: 0;
+ overflow: auto;
.modal--form__action-box {
padding: 20px;
@@ -345,7 +348,6 @@
@media (min-width: 768px) {
.jquery-modal.blocker.current .modal.modal--form {
min-width: 50%;
- min-height: 80%;
height: auto;
border-radius: 4px;
}
@@ -396,8 +398,7 @@
cursor: not-allowed;
height: 32px !important;
position: relative !important;
- padding-left: $mui-grid-padding/2 !important;
- width: calc(100% + $mui-grid-padding) !important;
+ padding-left: $mui-grid-padding * 0.5 !important;
}
.mui-select:focus > label,
.mui-select > select:focus ~ label {
@@ -414,23 +415,75 @@
}
// ============================================================================
-// Keyboard switcher
+// Input field helper icon (keyboard switch/Show password)
// ============================================================================
-.tabs.keyboard-switch {
+.field-toggle {
display: none;
- justify-content: space-between;
- position: fixed;
- left: 0;
- bottom: 0;
- width: 100%;
- z-index: 2;
- padding: $mui-grid-padding/2;
- margin: 0;
- background: $mui-bg-color-primary;
- margin-bottom: calc(env(keyboard-inset-height)); // Position it above the keyboard
-}
-
-input#username:focus ~ .keyboard-switch {
- display: flex;
+}
+
+// ============================================================================
+// Select2
+// ============================================================================
+
+.select2-hidden-accessible ~ .mui-select__menu {
+ display: none !important;
+}
+
+.select2-container .select2-selection {
+ border: none;
+ border-radius: 0;
+ background-image: none;
+ background-color: transparent;
+ border-bottom: 1px solid #ccc;
+ box-shadow: none;
+}
+
+.select2-container .select2-dropdown {
+ border: none;
+ border-radius: 0;
+ -webkit-box-shadow:
+ 0 1px 3px rgba(0, 0, 0, 0.12),
+ 0 1px 2px rgba(0, 0, 0, 0.24);
+ box-shadow:
+ 0 1px 3px rgba(0, 0, 0, 0.12),
+ 0 1px 2px rgba(0, 0, 0, 0.24);
+}
+
+.select2-container.select2-container--focus .select2-selection,
+.select2-container.select2-container--open .select2-selection {
+ box-shadow: none;
+ border: none;
+ border-bottom: 1px solid #ccc;
+}
+
+.select2-container .select2-results__option--highlighted[aria-selected] {
+ background-color: #eee;
+ color: #1f2d3d;
+}
+
+.select2-container .select2-selection--single .select2-selection__arrow {
+ background-color: transparent;
+ border: none;
+ background-image: none;
+}
+
+// ============================================================================
+// Google Map in the form
+// ============================================================================
+
+.map {
+ position: relative;
+ .map__marker {
+ margin-top: $mui-grid-padding * 0.5;
+ width: 100%;
+ height: 40em;
+ }
+ .map__clear {
+ position: absolute;
+ top: 22px;
+ right: 0;
+ z-index: 2;
+ background: #fff;
+ }
}
diff --git a/funnel/assets/sass/mui/_buttons.scss b/funnel/assets/sass/mui/_buttons.scss
index 2c0c5925f..d8bb914e1 100644
--- a/funnel/assets/sass/mui/_buttons.scss
+++ b/funnel/assets/sass/mui/_buttons.scss
@@ -3,31 +3,38 @@
*/
@mixin x-btn-box-shadow-raised() {
- box-shadow: 0 0px 2px rgba(mui-color('black'), 0.12),
+ box-shadow:
+ 0 0px 2px rgba(mui-color('black'), 0.12),
0 2px 2px rgba(mui-color('black'), 0.2);
// IE10+
@media all and (-ms-high-contrast: none), (-ms-high-contrast: active) {
- box-shadow: 0 -1px 2px rgba(mui-color('black'), 0.12),
+ box-shadow:
+ 0 -1px 2px rgba(mui-color('black'), 0.12),
-1px 0px 2px rgba(mui-color('black'), 0.12),
- 0 0px 2px rgba(mui-color('black'), 0.12), 0 2px 2px rgba(mui-color('black'), 0.2);
+ 0 0px 2px rgba(mui-color('black'), 0.12),
+ 0 2px 2px rgba(mui-color('black'), 0.2);
}
// Edge
@supports (-ms-ime-align: auto) {
- box-shadow: 0 -1px 2px rgba(mui-color('black'), 0.12),
+ box-shadow:
+ 0 -1px 2px rgba(mui-color('black'), 0.12),
-1px 0px 2px rgba(mui-color('black'), 0.12),
- 0 0px 2px rgba(mui-color('black'), 0.12), 0 2px 2px rgba(mui-color('black'), 0.2);
+ 0 0px 2px rgba(mui-color('black'), 0.12),
+ 0 2px 2px rgba(mui-color('black'), 0.2);
}
}
@mixin x-btn-box-shadow-active() {
- box-shadow: 0 0px 4px rgba(mui-color('black'), 0.12),
+ box-shadow:
+ 0 0px 4px rgba(mui-color('black'), 0.12),
1px 3px 4px rgba(mui-color('black'), 0.2);
// IE10+
@media all and (-ms-high-contrast: none), (-ms-high-contrast: active) {
- box-shadow: 0 -1px 2px rgba(mui-color('black'), 0.12),
+ box-shadow:
+ 0 -1px 2px rgba(mui-color('black'), 0.12),
-1px 0px 2px rgba(mui-color('black'), 0.12),
0 0px 4px rgba(mui-color('black'), 0.12),
1px 3px 4px rgba(mui-color('black'), 0.2);
@@ -35,7 +42,8 @@
// Edge
@supports (-ms-ime-align: auto) {
- box-shadow: 0 -1px 2px rgba(mui-color('black'), 0.12),
+ box-shadow:
+ 0 -1px 2px rgba(mui-color('black'), 0.12),
-1px 0px 2px rgba(mui-color('black'), 0.12),
0 0px 4px rgba(mui-color('black'), 0.12),
1px 3px 4px rgba(mui-color('black'), 0.2);
diff --git a/funnel/assets/sass/mui/_custom.scss b/funnel/assets/sass/mui/_custom.scss
index 191b977b9..781d0873b 100644
--- a/funnel/assets/sass/mui/_custom.scss
+++ b/funnel/assets/sass/mui/_custom.scss
@@ -95,3 +95,9 @@ $mui-grid-gutter-width: 32px !default;
// ============================================================================
$mui-panel-padding: 16px !default;
+
+// ============================================================================
+// TABS
+// ============================================================================
+
+$mui-tab-font-color: $mui-text-accent !default;
diff --git a/funnel/assets/sass/mui/_form.scss b/funnel/assets/sass/mui/_form.scss
index bfdb6f2bb..e560cd402 100644
--- a/funnel/assets/sass/mui/_form.scss
+++ b/funnel/assets/sass/mui/_form.scss
@@ -7,7 +7,7 @@
display: block;
width: 100%;
padding: 0;
- margin-bottom: $mui-base-line-height-computed / 2;
+ margin-bottom: $mui-base-line-height-computed * 0.5;
font-size: $mui-form-legend-font-size;
color: $mui-form-legend-font-color;
line-height: inherit;
diff --git a/funnel/assets/sass/mui/_globals.scss b/funnel/assets/sass/mui/_globals.scss
index 34082e6f4..43adce953 100644
--- a/funnel/assets/sass/mui/_globals.scss
+++ b/funnel/assets/sass/mui/_globals.scss
@@ -37,14 +37,14 @@
// paragraphs
p {
- margin: 0 0 ($mui-base-line-height-computed / 2);
+ margin: 0 0 ($mui-base-line-height-computed * 0.5);
}
// lists
ul,
ol {
margin-top: 0;
- margin-bottom: ($mui-base-line-height-computed / 2);
+ margin-bottom: ($mui-base-line-height-computed * 0.5);
}
// Horizontal rules
@@ -92,14 +92,14 @@
h2,
h3 {
margin-top: $mui-base-line-height-computed;
- margin-bottom: ($mui-base-line-height-computed / 2);
+ margin-bottom: ($mui-base-line-height-computed * 0.5);
}
h4,
h5,
h6 {
- margin-top: ($mui-base-line-height-computed / 2);
- margin-bottom: ($mui-base-line-height-computed / 2);
+ margin-top: ($mui-base-line-height-computed * 0.5);
+ margin-bottom: ($mui-base-line-height-computed * 0.5);
}
} @else {
// Cherry pick from normalize.css
diff --git a/funnel/assets/sass/mui/_helpers.scss b/funnel/assets/sass/mui/_helpers.scss
index e18595852..b77a887ae 100644
--- a/funnel/assets/sass/mui/_helpers.scss
+++ b/funnel/assets/sass/mui/_helpers.scss
@@ -181,27 +181,32 @@
// ============================================================================
.mui--z1 {
- box-shadow: 0 1px 3px rgba(mui-color('grey'), 0.12),
+ box-shadow:
+ 0 1px 3px rgba(mui-color('grey'), 0.12),
0 1px 2px rgba(mui-color('grey'), 0.24);
}
.mui--z2 {
- box-shadow: 0 3px 6px rgba(mui-color('black'), 0.16),
+ box-shadow:
+ 0 3px 6px rgba(mui-color('black'), 0.16),
0 3px 6px rgba(mui-color('black'), 0.23);
}
.mui--z3 {
- box-shadow: 0 10px 20px rgba(mui-color('black'), 0.19),
+ box-shadow:
+ 0 10px 20px rgba(mui-color('black'), 0.19),
0 6px 6px rgba(mui-color('black'), 0.23);
}
.mui--z4 {
- box-shadow: 0 14px 28px rgba(mui-color('black'), 0.25),
+ box-shadow:
+ 0 14px 28px rgba(mui-color('black'), 0.25),
0 10px 10px rgba(mui-color('black'), 0.22);
}
.mui--z5 {
- box-shadow: 0 19px 38px rgba(mui-color('black'), 0.3),
+ box-shadow:
+ 0 19px 38px rgba(mui-color('black'), 0.3),
0 15px 12px rgba(mui-color('black'), 0.22);
}
diff --git a/funnel/assets/sass/mui/_panel.scss b/funnel/assets/sass/mui/_panel.scss
index 11567f36d..058604b13 100644
--- a/funnel/assets/sass/mui/_panel.scss
+++ b/funnel/assets/sass/mui/_panel.scss
@@ -9,12 +9,14 @@
margin-bottom: $mui-base-line-height-computed;
border-radius: $mui-panel-border-radius;
background-color: $mui-panel-bg-color;
- box-shadow: 0 2px 2px 0 rgba(mui-color('black'), 0.16),
+ box-shadow:
+ 0 2px 2px 0 rgba(mui-color('black'), 0.16),
0 0px 2px 0 rgba(mui-color('black'), 0.12);
// IE10+ bugfix
@media all and (-ms-high-contrast: none), (-ms-high-contrast: active) {
- box-shadow: 0 -1px 2px 0 rgba(mui-color('black'), 0.12),
+ box-shadow:
+ 0 -1px 2px 0 rgba(mui-color('black'), 0.12),
-1px 0px 2px 0 rgba(mui-color('black'), 0.12),
0 2px 2px 0 rgba(mui-color('black'), 0.16),
0 0px 2px 0 rgba(mui-color('black'), 0.12);
@@ -22,7 +24,8 @@
// Edge
@supports (-ms-ime-align: auto) {
- box-shadow: 0 -1px 2px 0 rgba(mui-color('black'), 0.12),
+ box-shadow:
+ 0 -1px 2px 0 rgba(mui-color('black'), 0.12),
-1px 0px 2px 0 rgba(mui-color('black'), 0.12),
0 2px 2px 0 rgba(mui-color('black'), 0.16),
0 0px 2px 0 rgba(mui-color('black'), 0.12);
diff --git a/funnel/assets/sass/mui/_ripple.scss b/funnel/assets/sass/mui/_ripple.scss
index 156153b34..d183357d7 100644
--- a/funnel/assets/sass/mui/_ripple.scss
+++ b/funnel/assets/sass/mui/_ripple.scss
@@ -25,8 +25,10 @@
&.mui--is-animating {
transform: none;
- transition: transform 0.3s cubic-bezier(0, 0, 0.2, 1),
- width 0.3s cubic-bezier(0, 0, 0.2, 1), height 0.3s cubic-bezier(0, 0, 0.2, 1),
+ transition:
+ transform 0.3s cubic-bezier(0, 0, 0.2, 1),
+ width 0.3s cubic-bezier(0, 0, 0.2, 1),
+ height 0.3s cubic-bezier(0, 0, 0.2, 1),
opacity 0.3s cubic-bezier(0, 0, 0.2, 1);
}
diff --git a/funnel/assets/sass/mui/_tabs.scss b/funnel/assets/sass/mui/_tabs.scss
index 1b0265cba..0b74a1183 100644
--- a/funnel/assets/sass/mui/_tabs.scss
+++ b/funnel/assets/sass/mui/_tabs.scss
@@ -1,7 +1,3 @@
-/**
- * MUI Tabs module
- */
-
.mui-tabs__bar {
list-style: none;
padding-left: 0;
diff --git a/funnel/assets/sass/mui/_variables.scss b/funnel/assets/sass/mui/_variables.scss
index 583d9b817..77eba1dd8 100644
--- a/funnel/assets/sass/mui/_variables.scss
+++ b/funnel/assets/sass/mui/_variables.scss
@@ -157,7 +157,7 @@ $mui-label-font-color: mui-color('black-alpha-54') !default;
$mui-label-margin-bottom: 3px !default;
$mui-form-legend-font-size: $mui-base-font-size * 1.5 !default;
-$mui-form-legend-margin-bottom: $mui-form-legend-font-size / 2 !default;
+$mui-form-legend-margin-bottom: $mui-form-legend-font-size * 0.5 !default;
$mui-form-legend-font-color: $mui-base-font-color !default;
$mui-form-group-margin-bottom: 20px !default;
@@ -216,6 +216,8 @@ $mui-table-border-color: $mui-divider-color !default;
$mui-tab-font-color: $mui-base-font-color !default;
$mui-tab-font-color-active: $mui-primary-color !default;
$mui-tab-border-color-active: $mui-primary-color !default;
+$mui-tab-font-color-hover: $mui-text-light !default;
+$mui-tab-border-color-hover: $mui-text-light !default;
// ============================================================================
// CARET
diff --git a/funnel/assets/sass/mui/mixins/_grid-framework.scss b/funnel/assets/sass/mui/mixins/_grid-framework.scss
index 297eadf1d..9aff1cc24 100644
--- a/funnel/assets/sass/mui/mixins/_grid-framework.scss
+++ b/funnel/assets/sass/mui/mixins/_grid-framework.scss
@@ -1,5 +1,7 @@
// Overrides bootstrap functions to add prfx support
+@use 'sass:math';
+
@mixin mui-make-grid-columns(
$i: 1,
$list: '.mui-col-xs-#{$i}, .mui-col-sm-#{$i}, .mui-col-md-#{$i}, .mui-col-lg-#{$i}'
@@ -16,8 +18,8 @@
min-height: 1px;
// Inner gutter via padding
- padding-left: ($mui-grid-gutter-width / 2);
- padding-right: ($mui-grid-gutter-width / 2);
+ padding-left: ($mui-grid-gutter-width * 0.5);
+ padding-right: ($mui-grid-gutter-width * 0.5);
}
}
@@ -34,12 +36,12 @@
@mixin mui-calc-grid-column($i, $class, $type) {
@if ($type == 'width') and ($i > 0) {
.mui-col-#{$class}-#{$i} {
- width: percentage(($i / $mui-grid-columns));
+ width: percentage(math.div($i, $mui-grid-columns));
}
}
@if ($type == 'offset') {
.mui-col-#{$class}-offset-#{$i} {
- margin-left: percentage(($i / $mui-grid-columns));
+ margin-left: percentage(math.div($i, $mui-grid-columns));
}
}
}
diff --git a/funnel/assets/sass/mui/mixins/_util.scss b/funnel/assets/sass/mui/mixins/_util.scss
index 40c69fe2c..27d70093d 100644
--- a/funnel/assets/sass/mui/mixins/_util.scss
+++ b/funnel/assets/sass/mui/mixins/_util.scss
@@ -27,8 +27,8 @@
box-sizing: border-box;
margin-right: auto;
margin-left: auto;
- padding-left: ($gutter / 2);
- padding-right: ($gutter / 2);
+ padding-left: ($gutter * 0.5);
+ padding-right: ($gutter * 0.5);
}
@mixin mui-tab-focus() {
@@ -187,7 +187,7 @@
b,
strong {
- font-weight: 700er;
+ font-weight: 700;
}
/**
diff --git a/funnel/assets/sass/pages/account.scss b/funnel/assets/sass/pages/account.scss
index 77a7fc3c7..fe30e9588 100644
--- a/funnel/assets/sass/pages/account.scss
+++ b/funnel/assets/sass/pages/account.scss
@@ -54,12 +54,12 @@
float: left;
}
.preference__switch__txt--noswitch {
- margin-bottom: $mui-grid-padding/2;
+ margin-bottom: $mui-grid-padding * 0.5;
}
}
.preference__title {
width: calc(100% - 45px);
- margin-bottom: $mui-grid-padding/2;
+ margin-bottom: $mui-grid-padding * 0.5;
.preference__title__header {
font-size: 14px;
margin-bottom: 0;
diff --git a/funnel/assets/sass/pages/comments.scss b/funnel/assets/sass/pages/comments.scss
index 4e5e29ea3..2addbf5d4 100644
--- a/funnel/assets/sass/pages/comments.scss
+++ b/funnel/assets/sass/pages/comments.scss
@@ -67,7 +67,7 @@
align-content: center;
.comment__header__expand {
- margin-right: $mui-grid-padding/4;
+ margin-right: $mui-grid-padding * 0.25;
}
.mui-btn--nostyle + .mui-btn--nostyle {
margin-left: 0;
@@ -77,7 +77,7 @@
width: 100%;
max-width: calc(100% - 36px);
.commenter {
- margin-right: $mui-grid-padding/4;
+ margin-right: $mui-grid-padding * 0.25;
}
.comment__header__details__user {
min-height: 40px;
@@ -86,8 +86,8 @@
padding-bottom: 0;
}
.badge {
- margin-left: $mui-grid-padding/4;
- margin-bottom: $mui-grid-padding/4;
+ margin-left: $mui-grid-padding * 0.25;
+ margin-bottom: $mui-grid-padding * 0.25;
}
}
}
@@ -102,17 +102,17 @@
blockquote {
border-left: 3px solid $mui-text-accent;
- padding: 0 0 0 $mui-grid-padding/2;
+ padding: 0 0 0 $mui-grid-padding * 0.5;
}
.comment__body__inner,
.comment--children {
- padding-left: $mui-grid-padding/2;
+ padding-left: $mui-grid-padding * 0.5;
word-break: break-word;
margin-bottom: 14px;
}
.js-comment-form {
.ajax-form {
- margin-top: $mui-grid-padding/2;
+ margin-top: $mui-grid-padding * 0.5;
}
> .comment__body__links.link-icon:first-child {
padding-left: 0;
@@ -151,7 +151,7 @@
right: 0;
z-index: 1002;
background: $mui-bg-color-primary;
- padding: $mui-grid-padding/2 $mui-grid-padding 56px;
+ padding: $mui-grid-padding * 0.5 $mui-grid-padding 56px;
margin: 0;
overflow-y: scroll;
@@ -183,7 +183,6 @@
.cm-editor {
border: 1px solid $mui-primary-color;
border-radius: 16px 16px 0 16px;
- min-height: 56px;
padding: $mui-grid-padding;
height: auto;
.cm-scroller {
@@ -200,7 +199,7 @@
}
.icon-btn {
min-width: 40px;
- margin: 0 0 0 8px;
+ margin: 0;
}
.user {
display: inline-block;
@@ -231,22 +230,17 @@
max-height: 100%;
overflow-y: scroll;
.mui-form {
+ align-items: center;
.mui-form__fields .cm-editor {
border: none;
border-radius: 0;
background: $mui-bg-color-primary;
+ min-height: 72px; // height of navbar on project page
}
}
- .mui-btn--raised.icon-btn {
- border-radius: 0;
- box-shadow: none;
- padding-bottom: 16px;
- background: inherit;
- }
- .user {
- padding-bottom: $mui-grid-padding/2;
- padding-right: $mui-grid-padding;
- margin-right: 0;
+ .user,
+ .icon-btn {
+ margin: 0 $mui-grid-padding * 0.5 0 0;
}
}
.ajax-form--block.ajax-form--mob {
diff --git a/funnel/assets/sass/pages/event.scss b/funnel/assets/sass/pages/event.scss
index 878371c31..239380564 100644
--- a/funnel/assets/sass/pages/event.scss
+++ b/funnel/assets/sass/pages/event.scss
@@ -1,3 +1,6 @@
+@import '../base/mui_form_essentials';
+@import '../mui/select';
+
.attendee-table .buttongrp-column {
min-width: 250px;
}
diff --git a/funnel/assets/sass/pages/index.scss b/funnel/assets/sass/pages/index.scss
index f404b5a19..522672d30 100644
--- a/funnel/assets/sass/pages/index.scss
+++ b/funnel/assets/sass/pages/index.scss
@@ -1,4 +1,5 @@
@import '../base/variable';
+@import '../components/ticket-modal';
.homepage {
.logo-about {
@@ -42,10 +43,11 @@
}
}
-.spotlight-container {
- padding: 0 40px;
- .spotlight-container__details {
- margin-top: 40px;
+@media (min-width: 992px) {
+ .spotlight-container {
+ .spotlight-container__details {
+ margin-top: 40px;
+ }
}
}
@@ -132,7 +134,9 @@
}
.card--spotlight:hover {
- box-shadow: 0 14px 28px rgba(0, 0, 0, 0.25), 0 10px 10px rgba(0, 0, 0, 0.22);
+ box-shadow:
+ 0 14px 28px rgba(0, 0, 0, 0.25),
+ 0 10px 10px rgba(0, 0, 0, 0.22);
}
.card--new {
diff --git a/funnel/assets/sass/pages/login_form.scss b/funnel/assets/sass/pages/login_form.scss
index 39cb2b7fa..d2091a3e1 100644
--- a/funnel/assets/sass/pages/login_form.scss
+++ b/funnel/assets/sass/pages/login_form.scss
@@ -72,7 +72,7 @@
left: 0;
right: 0;
text-align: right;
- padding: $mui-grid-padding/2;
+ padding: $mui-grid-padding * 0.5;
}
.header,
.footer {
@@ -80,7 +80,7 @@
}
.login-page__box {
position: relative;
- padding: ($mui-grid-padding * 2 + $mui-grid-padding/2) $mui-grid-padding * 2
+ padding: ($mui-grid-padding * 2 + $mui-grid-padding * 0.5) $mui-grid-padding * 2
$mui-grid-padding * 2;
border-radius: 16px;
margin: 0 auto $mui-grid-padding * 2;
@@ -171,16 +171,26 @@ a.loginbutton.hidden,
background-color: $mui-bg-color-primary !important;
}
+// ============================================================================
+// Input field helper icon
+// ============================================================================
+
+.field-toggle {
+ padding: $mui-grid-padding * 0.5;
+ position: absolute;
+ right: -$mui-grid-padding * 0.5;
+ bottom: -$mui-grid-padding * 0.25;
+ float: right;
+ z-index: 3;
+}
+
// ============================================================================
// Password field
// ============================================================================
.mui-textfield--password {
.password-toggle {
- position: relative;
- right: 0;
- bottom: 22px;
- float: right;
+ display: inline-block;
}
.password-strength-icon {
position: absolute;
@@ -193,10 +203,12 @@ a.loginbutton.hidden,
}
.progress {
height: 4px;
- margin: $mui-grid-padding/2 0 25px;
+ margin: $mui-grid-padding * 0.5 0 25px;
background-color: #f5f5f5;
border-radius: 4px;
- box-shadow: 0 1px 3px $mui-box-shadow-grey, 0 1px 2px $mui-box-shadow-grey;
+ box-shadow:
+ 0 1px 3px $mui-box-shadow-grey,
+ 0 1px 2px $mui-box-shadow-grey;
position: relative;
display: none;
@@ -249,3 +261,22 @@ a.loginbutton.hidden,
.password-field-sidetext {
margin: 0 0 20px;
}
+
+// ============================================================================
+// Keyboard switcher
+// ============================================================================
+
+.mui-textfield {
+ .field-toggle:last-child {
+ right: 20px;
+ }
+ input#username:focus ~ .keyboard-switch .field-toggle {
+ display: inline-block;
+ }
+ .field-toggle {
+ color: $mui-text-accent;
+ }
+ .field-toggle.active {
+ color: $mui-text-light;
+ }
+}
diff --git a/funnel/assets/sass/pages/membership.scss b/funnel/assets/sass/pages/membership.scss
index 9e4e85560..5cea115a7 100644
--- a/funnel/assets/sass/pages/membership.scss
+++ b/funnel/assets/sass/pages/membership.scss
@@ -3,7 +3,7 @@
@media (min-width: 1200px) {
.membership-wrapper--half {
float: left;
- width: calc(50% - #{$mui-grid-padding/2});
+ width: calc(50% - #{$mui-grid-padding * 0.5});
}
.membership-wrapper--half:first-child {
margin-right: $mui-grid-padding;
diff --git a/funnel/assets/sass/pages/profile.scss b/funnel/assets/sass/pages/profile.scss
index 3e02245d4..bf489b456 100644
--- a/funnel/assets/sass/pages/profile.scss
+++ b/funnel/assets/sass/pages/profile.scss
@@ -113,7 +113,7 @@
.profile-dropdown-btn {
background-color: $mui-bg-color-primary-dark;
- padding: $mui-grid-padding/2 $mui-grid-padding;
+ padding: $mui-grid-padding * 0.5 $mui-grid-padding;
text-align: center;
}
@@ -173,7 +173,7 @@
.profile__logo__details {
position: absolute;
left: 136px;
- bottom: -$mui-grid-padding/2;
+ bottom: -$mui-grid-padding * 0.5;
min-width: 450px;
}
}
@@ -199,7 +199,7 @@
font-size: 20px;
margin-bottom: $mui-grid-padding;
display: inline-block;
- margin-right: $mui-grid-padding/2;
+ margin-right: $mui-grid-padding * 0.5;
}
}
.profile-subheader__description {
diff --git a/funnel/assets/sass/pages/project.scss b/funnel/assets/sass/pages/project.scss
index 5369eb34b..9bb8650d9 100644
--- a/funnel/assets/sass/pages/project.scss
+++ b/funnel/assets/sass/pages/project.scss
@@ -3,6 +3,8 @@
@import '../components/proposal-card';
@import '../components/switch';
@import '../components/footable';
+@import '../components/draggablebox';
+@import '../components/ticket-modal';
@import 'leaflet';
@media (min-width: 768px) {
@@ -16,7 +18,7 @@
width: 100%;
left: 0;
bottom: 0;
- padding: $mui-grid-padding/4 $mui-grid-padding !important;
+ padding: $mui-grid-padding * 0.25 $mui-grid-padding $mui-grid-padding * 0.25 !important;
box-shadow: 0 0 4px 0 rgba(0, 0, 0, 0.1);
background-color: #ffffff;
z-index: 1000;
@@ -56,68 +58,93 @@
width: 100%;
flex-wrap: wrap;
.register-block__content {
- width: 45%;
- align-self: end;
- }
- .register-block__content--margin {
- width: calc(55% - #{$mui-grid-padding});
- margin-right: $mui-grid-padding;
- align-self: center;
- }
- .register-block__txt {
- font-size: 12px;
- margin: 0 0 $mui-grid-padding/2;
- }
- .register-block__btn {
width: 100%;
- font-size: 10px;
- padding: 0 $mui-grid-padding/2;
- }
- .register-block__btn--small {
- width: calc(100% - 30px);
- }
- .register-block__right__menu {
- margin-left: $mui-grid-padding/2;
+ .register-block__content__rsvp-txt {
+ display: none;
+ }
+ .register-block__content__txt {
+ font-size: 9px;
+ line-height: 16px;
+ width: 100%;
+ display: block;
+ font-style: italic;
+ margin-bottom: $mui-grid-padding * 0.25;
+ }
+ .register-block__btn {
+ @extend .price-btn;
+ width: 100%;
+ .register-block__btn__txt {
+ @extend .price-btn__txt;
+ }
+ .register-block__btn__txt--hover--show {
+ display: none;
+ }
+ .register-block__btn__txt--smaller {
+ @extend .price-btn__txt--smaller;
+ }
+ &:hover .register-block__btn__txt--hover {
+ display: none;
+ }
+ &:hover .register-block__btn__txt--hover--show {
+ display: block;
+ color: $mui-text-danger;
+ }
+ &:hover {
+ border-color: $mui-text-danger;
+ }
+ }
+ .register-block__btn.mui--is-disabled:hover {
+ border-color: inherit;
+ }
}
- .register-block__btnwrapper {
- width: 100%;
+ .register-block__content--half {
+ width: calc(50% - 8px);
+ align-self: flex-end;
}
- .register-block__btnwrapper--width {
- width: auto;
- display: inline-flex;
+ .register-block__content--half:first-child {
+ margin-right: 16px;
}
}
-.project-footer {
+@media (min-width: 380px) {
.register-block {
- .register-block__content--flex {
- display: flex;
- align-items: center;
- justify-content: space-between;
- width: 100%;
- flex-wrap: wrap;
- }
- .register-block__txt {
- margin: 0;
- }
- .register-block__btnwrapper {
- width: auto;
- }
- .register-block__btn.full-width-btn {
- width: 100%;
+ .register-block__content {
+ .register-block__content__txt {
+ font-size: 10px;
+ }
}
}
}
-@media (min-width: 360px) {
+@media (any-pointer: coarse) {
.register-block {
- .register-block__txt {
- font-size: 14px;
- white-space: normal;
+ .register-block__content {
+ .register-block__content__rsvp-txt {
+ display: block;
+ font-size: 12px;
+ font-weight: 500;
+ }
+ .register-block__btn {
+ border-color: $mui-text-danger;
+ .register-block__btn__txt--hover {
+ display: none;
+ }
+ .register-block__btn__txt--hover--show {
+ display: block;
+ color: $mui-text-danger;
+ }
+ .register-block__btn__txt--mobile {
+ display: none;
+ }
+ }
+ .register-block__btn.mui--is-disabled {
+ border-color: inherit;
+ }
}
- .register-block__txt--longer {
- max-width: calc(100% - 30px);
- display: inline-block;
+ .register-block__content--half {
+ .register-block__content__rsvp-txt {
+ font-size: 9px;
+ }
}
}
}
@@ -126,32 +153,29 @@
.project-footer {
.register-block {
display: block;
- .register-block__content--flex {
- display: block;
- }
- .register-block__content,
- .register-block__content--margin {
+ .register-block__content {
width: 100%;
margin-right: 0;
- }
- .register-block__content--padding {
- margin: $mui-grid-padding 0 0;
- }
- .register-block__txt {
- margin: 0 0 $mui-grid-padding;
- max-width: 100%;
- }
- .register-block__btn {
- width: 100%;
- font-size: inherit;
- }
- .register-block__btnwrapper {
- width: 100%;
- display: inline-flex;
- align-items: center;
- }
- .register-block__btnwrapper--width {
- width: auto;
+ margin-bottom: $mui-grid-padding;
+ .register-block__content__rsvp-txt {
+ font-size: 12px;
+ }
+ .register-block__content__txt {
+ font-size: 14px;
+ line-height: 21px;
+ margin-bottom: $mui-grid-padding * 0.5;
+ }
+ .register-block__btn {
+ width: 100%;
+ font-size: inherit;
+ height: 42px;
+ .register-block__btn__txt {
+ font-size: 14px;
+ }
+ .register-block__btn__txt--smaller {
+ font-size: 12px;
+ }
+ }
}
}
}
@@ -238,7 +262,8 @@
.project-banner__profile-details {
display: flex;
align-items: center;
- margin-bottom: $mui-grid-padding/2;
+ margin-bottom: $mui-grid-padding * 0.5;
+ flex-wrap: wrap;
.project-banner__profile-details__logo-wrapper {
display: inline-block;
@@ -246,7 +271,7 @@
width: 24px;
border-radius: 50%;
overflow: hidden;
- margin-right: $mui-grid-padding/2;
+ margin-right: $mui-grid-padding * 0.5;
.project-banner__profile-details__logo_wrapper__logo {
height: 100%;
@@ -254,6 +279,9 @@
object-fit: cover;
}
}
+ .project-banner__profile-details__badge {
+ margin-left: auto;
+ }
}
.project-banner__profile-details--center {
@@ -326,7 +354,7 @@
.calendar__weekdays .calendar__month--latest,
.calendar__weekdays .calendar__weekdays__dates--latest {
display: flex;
- margin-bottom: $mui-grid-padding/2;
+ margin-bottom: $mui-grid-padding * 0.5;
}
.calendar__weekdays .calendar__weekdays__dates:last-child {
@@ -412,7 +440,7 @@
@media (min-width: 992px) {
.project-banner {
.profile-text {
- margin: 0 0 $mui-grid-padding/4;
+ margin: 0 0 $mui-grid-padding * 0.25;
p {
margin: 0;
@@ -452,7 +480,7 @@
text-decoration: none !important;
display: inline-block;
width: 100%;
- padding: $mui-grid-padding/2 0;
+ padding: $mui-grid-padding * 0.5 0;
border-bottom: 1px solid $mui-divider-color;
}
.pinned__update__heading {
@@ -461,6 +489,7 @@
}
.pinned__update__body {
margin-bottom: 0;
+ word-break: break-word;
> * {
display: inline-block;
margin-bottom: 0;
@@ -499,64 +528,6 @@
padding-bottom: $mui-grid-padding;
}
-.tickets-wrapper {
- .tickets-wrapper__modal {
- display: none;
- }
-
- .tickets-wrapper__modal__back {
- display: none;
- }
-
- .tickets-wrapper__modal__body__close {
- display: none;
- }
-
- .tickets-wrapper__modal--show {
- position: fixed;
- top: 52px;
- background: $mui-bg-color-primary;
- left: 0;
- right: 0;
- padding: $mui-grid-padding;
- z-index: 1001;
- bottom: 0;
- overflow: auto;
-
- .tickets-wrapper__modal__back {
- display: block;
- }
- }
-}
-
-@media (min-width: 768px) {
- .tickets-wrapper {
- .tickets-wrapper__modal {
- top: 0;
- width: 100%;
- height: 100%;
- background-color: rgba(0, 0, 0, 0.75);
- }
-
- .tickets-wrapper__modal__body {
- max-width: 500px;
- margin: auto;
- width: 90%;
- padding: 0;
- min-height: auto;
- border-radius: 16px;
- background-color: $mui-bg-color-primary;
- overflow: auto;
- .tickets-wrapper__modal__body__close {
- display: block;
- float: right;
- margin-right: $mui-grid-padding/2;
- margin-top: $mui-grid-padding/2;
- }
- }
- }
-}
-
.about .rsvp-wrapper {
padding-top: 50px;
}
@@ -564,7 +535,9 @@
@media (min-width: 768px) {
.about .rsvp-wrapper {
padding: 10px;
- box-shadow: 0 1px 3px rgba(158, 158, 158, 0.12), 0 1px 2px rgba(158, 158, 158, 0.24);
+ box-shadow:
+ 0 1px 3px rgba(158, 158, 158, 0.12),
+ 0 1px 2px rgba(158, 158, 158, 0.24);
}
}
@@ -597,13 +570,13 @@
flex-shrink: 0;
margin-top: 0;
border-right: 1px solid $mui-text-light;
- padding-right: $mui-grid-padding/2;
- margin-right: $mui-grid-padding/2;
+ padding-right: $mui-grid-padding * 0.5;
+ margin-right: $mui-grid-padding * 0.5;
line-height: 1;
}
.setting__separator {
display: block;
- margin: 0 $mui-grid-padding/2;
+ margin: 0 $mui-grid-padding * 0.5;
}
.setting__sub {
font-size: 16px;
@@ -616,22 +589,6 @@
background: $mui-bg-color-primary;
}
-.map {
- position: relative;
- .map__marker {
- margin-top: $mui-grid-padding/2;
- width: 100%;
- height: 40em;
- }
- .map__clear {
- position: absolute;
- top: 22px;
- right: 0;
- z-index: 2;
- background: #fff;
- }
-}
-
.label {
padding: 4px 8px;
font-size: 12px;
diff --git a/funnel/assets/sass/pages/schedule.scss b/funnel/assets/sass/pages/schedule.scss
index 1483a50ef..3d2e60d50 100644
--- a/funnel/assets/sass/pages/schedule.scss
+++ b/funnel/assets/sass/pages/schedule.scss
@@ -43,13 +43,27 @@
.schedule__row__column__content__description {
clear: both;
- padding-top: $mui-grid-padding;
+ padding-top: $mui-grid-padding/4;
padding-bottom: $mui-grid-padding;
word-break: break-word;
+ a {
+ color: inherit;
+ }
+
img {
width: 100%;
}
+
+ h1,
+ h2,
+ h3,
+ h4,
+ h5 {
+ font-size: 12px;
+ margin-top: 0;
+ margin-bottom: $mui-grid-padding/4;
+ }
}
p {
@@ -94,11 +108,10 @@
.schedule__row--sticky {
display: flex;
- align-items: center;
overflow-x: auto;
position: sticky;
position: -webkit-sticky;
- top: 0;
+ top: 0; // header height in home page
order: 1;
z-index: 2;
border: none;
@@ -108,7 +121,7 @@
.schedule__row__column--header {
display: flex !important;
- padding: 0 $mui-grid-padding/2;
+ padding: 0 $mui-grid-padding * 0.5;
margin: 0;
align-items: center;
justify-content: center;
@@ -116,12 +129,14 @@
background-image: none !important;
border-bottom: 2px solid $mui-divider-color;
min-height: 50px;
- min-width: 100px;
+ min-width: 60%;
width: 100% !important;
+ padding: $mui-grid-padding/2;
}
.schedule__row__column--header.js-tab-active {
- border-bottom: 2px solid $mui-accent-color;
+ background: transparentize($mui-primary-color, 0.85);
+ border-bottom-color: transparentize($mui-primary-color, 0.8);
}
.schedule__row__column--time {
@@ -136,28 +151,34 @@
}
@media (max-width: 767px) {
- .schedule {
- .schedule__row {
- display: none;
- height: auto !important;
-
- .schedule__row__column {
+ .schedule-grid {
+ .schedule {
+ .schedule__row {
display: none;
- .schedule__row__column__content {
- min-height: 50px;
+ height: auto !important;
+
+ .schedule__row__column {
+ display: none;
+ .schedule__row__column__content {
+ min-height: 50px;
+ }
}
}
- }
- .schedule__row--sticky {
- display: flex;
- }
- .schedule__row.js-active {
- display: flex;
- .schedule__row__column.js-active {
- display: block;
+ .schedule__row--sticky {
+ display: flex;
+ top: 36px;
+ }
+ .schedule__row.js-active {
+ display: flex;
+ .schedule__row__column.js-active {
+ display: block;
+ }
}
}
}
+ .mobile-header .schedule-grid .schedule .schedule__row--sticky {
+ top: 52px;
+ }
}
@media (min-width: 768px) {
@@ -187,7 +208,7 @@
.schedule__row__column__content {
width: calc(100% - 1px);
height: 100%;
- padding: $mui-grid-padding $mui-grid-padding/2;
+ padding: $mui-grid-padding $mui-grid-padding * 0.5;
.schedule__row__column__content__title__duration {
top: 205px;
}
@@ -203,7 +224,7 @@
margin: 0;
background-color: $mui-bg-color-primary;
display: block;
- padding: $mui-grid-padding/4 0 0;
+ padding: $mui-grid-padding * 0.25 0 0;
text-align: center;
color: $mui-accent-color;
text-decoration: none;
@@ -221,10 +242,12 @@
.schedule__row__column--header {
outline: 1px solid $mui-divider-color;
border: none !important;
+ background-color: $mui-bg-color-primary;
}
.schedule__row__column--time--header {
display: block;
- padding: $mui-grid-padding/2 0;
+ padding: $mui-grid-padding * 0.5 0;
+ align-self: center;
}
}
.schedule__row--calendar {
@@ -272,12 +295,12 @@
min-height: 100%;
.modal__header {
- padding: 0 $mui-grid-padding $mui-grid-padding/4;
+ padding: 0 $mui-grid-padding $mui-grid-padding * 0.25;
border-bottom: 1px solid $mui-divider-color;
.session-modal__title {
max-width: calc(100% - 20px);
- margin: $mui-grid-padding/2 0 $mui-grid-padding/2;
+ margin: $mui-grid-padding * 0.5 0 $mui-grid-padding * 0.5;
position: static;
}
@@ -286,12 +309,12 @@
}
.modal__header__title {
- margin-bottom: $mui-grid-padding/4;
+ margin-bottom: $mui-grid-padding * 0.25;
font-weight: 700;
}
.modal__header__text {
- margin: 0 0 $mui-grid-padding/4;
+ margin: 0 0 $mui-grid-padding * 0.25;
}
}
@@ -323,7 +346,7 @@
margin-top: 0;
position: relative;
top: -6px;
- margin-bottom: $mui-grid-padding/2;
+ margin-bottom: $mui-grid-padding * 0.5;
}
}
@@ -407,7 +430,7 @@
}
.fc-event .fc-event-custom a {
- font-weight: 700er;
+ font-weight: 700;
color: #c33;
font-size: 1.2em;
}
@@ -419,8 +442,8 @@
.proposal-box,
body > .proposal-box.ui-draggable {
- margin: $mui-grid-padding/2 0;
- padding: $mui-grid-padding/4 $mui-grid-padding/2;
+ margin: $mui-grid-padding * 0.5 0;
+ padding: $mui-grid-padding * 0.25 $mui-grid-padding * 0.5;
background: $mui-bg-color-primary;
color: $mui-text-dark;
border-radius: 4px;
diff --git a/funnel/assets/sass/pages/submission.scss b/funnel/assets/sass/pages/submission.scss
index 9ad0bab12..c2f891f6e 100644
--- a/funnel/assets/sass/pages/submission.scss
+++ b/funnel/assets/sass/pages/submission.scss
@@ -10,6 +10,7 @@
.details__box {
position: relative;
overflow: visible;
+ border-bottom: none;
}
}
}
@@ -99,7 +100,7 @@
}
.mui--is-active.gallery__thumbnail {
- background-color: rgba(255, 255, 255, 0.16);
+ background-color: $mui-bg-color-accent !important;
}
.gallery__thumbnail__play-icon {
@@ -190,14 +191,28 @@
left: 0px;
width: calc(100% - 16px);
margin: 0px;
- padding: $mui-grid-padding/2;
- box-shadow: 0 1px 3px rgba(0, 0, 0, 0.12), 0 1px 2px rgba(0, 0, 0, 0.24);
+ padding: $mui-grid-padding * 0.5;
+ box-shadow:
+ 0 1px 3px rgba(0, 0, 0, 0.12),
+ 0 1px 2px rgba(0, 0, 0, 0.24);
background-color: white;
margin: 0;
- -webkit-transition: top 0.25s linear, z-index 0.1s step-start, opacity 0.25s linear;
- -moz-transition: top 0.25s linear, z-index 0.1s step-start, opacity 0.25s linear;
- -ms-transition: top 0.25s linear, z-index 0.1s step-start, opacity 0.25s linear;
- -o-transition: top 0.25s linear, z-index 0.1s step-start, opacity 0.25s linear;
+ -webkit-transition:
+ top 0.25s linear,
+ z-index 0.1s step-start,
+ opacity 0.25s linear;
+ -moz-transition:
+ top 0.25s linear,
+ z-index 0.1s step-start,
+ opacity 0.25s linear;
+ -ms-transition:
+ top 0.25s linear,
+ z-index 0.1s step-start,
+ opacity 0.25s linear;
+ -o-transition:
+ top 0.25s linear,
+ z-index 0.1s step-start,
+ opacity 0.25s linear;
max-width: 100%;
legend {
@@ -209,11 +224,26 @@
top: 0;
z-index: 1000;
opacity: 1;
- -webkit-transition: top 0.25s linear, z-index 0.25s step-end, opacity 0.25s linear;
- -moz-transition: top 0.25s linear, z-index 0.25s step-end, opacity 0.25s linear;
- -ms-transition: top 0.25s linear, z-index 0.25s step-end, opacity 0.25s linear;
- -o-transition: top 0.25s linear, z-index 0.25s step-end, opacity 0.25s linear;
- transition: top 0.25s linear, z-index 0.25s step-end, opacity 0.25s linear;
+ -webkit-transition:
+ top 0.25s linear,
+ z-index 0.25s step-end,
+ opacity 0.25s linear;
+ -moz-transition:
+ top 0.25s linear,
+ z-index 0.25s step-end,
+ opacity 0.25s linear;
+ -ms-transition:
+ top 0.25s linear,
+ z-index 0.25s step-end,
+ opacity 0.25s linear;
+ -o-transition:
+ top 0.25s linear,
+ z-index 0.25s step-end,
+ opacity 0.25s linear;
+ transition:
+ top 0.25s linear,
+ z-index 0.25s step-end,
+ opacity 0.25s linear;
}
.listwidget {
diff --git a/funnel/assets/sass/pages/submission_form.scss b/funnel/assets/sass/pages/submission_form.scss
index 6cdf8b813..f3692d8a0 100644
--- a/funnel/assets/sass/pages/submission_form.scss
+++ b/funnel/assets/sass/pages/submission_form.scss
@@ -16,7 +16,7 @@
}
}
.mui-form__fields {
- margin-bottom: $mui-grid-padding/4;
+ margin-bottom: $mui-grid-padding * 0.25;
}
#title {
font-size: 18px;
@@ -73,7 +73,7 @@
.submission-form {
.submission-header {
box-shadow: 0 2px 4px 0 rgba(0, 0, 0, 0.15);
- padding: $mui-grid-padding/2 0;
+ padding: $mui-grid-padding * 0.5 0;
margin-bottom: $mui-grid-padding;
position: sticky;
top: $mui-header-height;
diff --git a/funnel/assets/sass/pages/update.scss b/funnel/assets/sass/pages/update.scss
index d1a5bac68..c6d2002cc 100644
--- a/funnel/assets/sass/pages/update.scss
+++ b/funnel/assets/sass/pages/update.scss
@@ -32,8 +32,8 @@
}
.update {
- padding: $mui-grid-padding/2 0 0;
- margin: $mui-grid-padding/2 0;
+ padding: $mui-grid-padding * 0.5 0 0;
+ margin: $mui-grid-padding * 0.5 0;
position: relative;
.update__content {
@@ -48,7 +48,7 @@
}
.update--border {
- padding: $mui-grid-padding/2 $mui-grid-padding 0;
+ padding: $mui-grid-padding * 0.5 $mui-grid-padding 0;
border-radius: 4px;
background: $mui-bg-color-accent;
}
diff --git a/funnel/assets/sass/reflex/_mixins.scss b/funnel/assets/sass/reflex/_mixins.scss
index 8fcdfc43b..30dd8985d 100644
--- a/funnel/assets/sass/reflex/_mixins.scss
+++ b/funnel/assets/sass/reflex/_mixins.scss
@@ -6,6 +6,8 @@
// reflex grid generation mixins
// --------------------------------------------------
+@use 'sass:math';
+
@mixin make-reflex-grid($class) {
@include loop-reflex-columns($reflex-columns, $class, width);
}
@@ -13,8 +15,8 @@
@mixin calc-reflex-columns($index, $class, $type) {
@if $type == width and $index > 0 {
.#{$reflex-prefix}#{$class}#{$index} {
- width: percentage(($index / $reflex-columns));
- *width: percentage(($index / $reflex-columns)) - 0.1;
+ width: percentage(math.div($index, $reflex-columns));
+ *width: percentage(math.div($index, $reflex-columns)) - 0.1;
//for ie6 support you can uncomment this line but it will increase css filesize dramatically
//@include setupCols();
diff --git a/funnel/assets/sass/reflex/_mixins_custom.scss b/funnel/assets/sass/reflex/_mixins_custom.scss
index c72937cb9..2e0979b92 100644
--- a/funnel/assets/sass/reflex/_mixins_custom.scss
+++ b/funnel/assets/sass/reflex/_mixins_custom.scss
@@ -6,6 +6,8 @@
// reflex grid generation mixins
// --------------------------------------------------
+@use 'sass:math';
+
@mixin make-reflex-grid($class) {
@include loop-reflex-columns($reflex-columns, $class, width);
}
@@ -13,8 +15,8 @@
@mixin calc-reflex-columns($index, $class, $type) {
@if $type == width and $index > 0 {
.#{$reflex-prefix}#{$class}#{$index} {
- width: percentage(($index / $reflex-columns));
- *width: percentage(($index / $reflex-columns)) - 0.1;
+ width: percentage(math.div($index, $reflex-columns));
+ *width: percentage(math.div($index, $reflex-columns)) - 0.1;
//for ie6 support you can uncomment this line but it will increase css filesize dramatically
//@include setupCols();
diff --git a/funnel/assets/sass/reflex/_variables.scss b/funnel/assets/sass/reflex/_variables.scss
index 66fc6417a..6b3d050d8 100644
--- a/funnel/assets/sass/reflex/_variables.scss
+++ b/funnel/assets/sass/reflex/_variables.scss
@@ -62,6 +62,6 @@ $reflex-lg-max: ($reflex-xlg - 1);
$reflex-grid-spacing: 16px !default;
$reflex-cell-spacing: 16px !default;
-$reflex-cell-spacing-sm: ($reflex-cell-spacing / 2);
+$reflex-cell-spacing-sm: ($reflex-cell-spacing * 0.5);
$reflex-cell-spacing-md: $reflex-cell-spacing;
$reflex-cell-spacing-lg: ($reflex-cell-spacing * 2);
diff --git a/funnel/assets/service-worker-template.js b/funnel/assets/service-worker-template.js
index 33659ac2b..33e54e9eb 100644
--- a/funnel/assets/service-worker-template.js
+++ b/funnel/assets/service-worker-template.js
@@ -2,7 +2,11 @@ import { precacheAndRoute } from 'workbox-precaching';
import { registerRoute, setCatchHandler } from 'workbox-routing';
import { NetworkFirst, NetworkOnly } from 'workbox-strategies';
import { skipWaiting, clientsClaim } from 'workbox-core';
-precacheAndRoute(self.__WB_MANIFEST);
+const filteredManifest = self.__WB_MANIFEST.filter((entry) => {
+ return !entry.url.match('prism-');
+});
+
+precacheAndRoute(filteredManifest);
skipWaiting();
clientsClaim();
diff --git a/funnel/cli/geodata.py b/funnel/cli/geodata.py
index 68d199b84..978f03850 100644
--- a/funnel/cli/geodata.py
+++ b/funnel/cli/geodata.py
@@ -2,23 +2,21 @@
from __future__ import annotations
-from dataclasses import dataclass
-from datetime import datetime
-from decimal import Decimal
-from typing import Optional
-from urllib.parse import urljoin
import csv
import os
import sys
import time
import zipfile
+from dataclasses import dataclass
+from datetime import datetime
+from decimal import Decimal
+from urllib.parse import urljoin
-from flask.cli import AppGroup
import click
-
-from unidecode import unidecode
import requests
import rich.progress
+from flask.cli import AppGroup
+from unidecode import unidecode
from coaster.utils import getbool
@@ -34,7 +32,7 @@
csv.field_size_limit(sys.maxsize)
-geo = AppGroup('geoname', help="Process geoname data.")
+geo = AppGroup('geonames', help="Process geonames data.")
@dataclass
@@ -111,7 +109,7 @@ class GeoAltNameRecord:
is_historic: str
-def downloadfile(basepath: str, filename: str, folder: Optional[str] = None) -> None:
+def downloadfile(basepath: str, filename: str, folder: str | None = None) -> None:
"""Download a geoname record file."""
if not folder:
folder_file = filename
@@ -372,7 +370,7 @@ def load_admin1_codes(filename: str) -> None:
if item.geonameid:
rec = GeoAdmin1Code.query.get(item.geonameid)
if rec is None:
- rec = GeoAdmin1Code(geonameid=item.geonameid)
+ rec = GeoAdmin1Code(geonameid=int(item.geonameid))
db.session.add(rec)
rec.title = item.title
rec.ascii_title = item.ascii_title
@@ -413,7 +411,7 @@ def load_admin2_codes(filename: str) -> None:
@geo.command('download')
def download() -> None:
"""Download geoname data."""
- os.makedirs('geoname_data', exist_ok=True)
+ os.makedirs('download/geonames', exist_ok=True)
for filename in (
'countryInfo.txt',
'admin1CodesASCII.txt',
@@ -423,19 +421,19 @@ def download() -> None:
'alternateNames.zip',
):
downloadfile(
- 'http://download.geonames.org/export/dump/', filename, 'geoname_data'
+ 'http://download.geonames.org/export/dump/', filename, 'download/geonames'
)
@geo.command('process')
def process() -> None:
"""Process downloaded geonames data."""
- load_country_info('geoname_data/countryInfo.txt')
- load_admin1_codes('geoname_data/admin1CodesASCII.txt')
- load_admin2_codes('geoname_data/admin2Codes.txt')
- load_geonames('geoname_data/IN.txt')
- load_geonames('geoname_data/allCountries.txt')
- load_alt_names('geoname_data/alternateNames.txt')
+ load_country_info('download/geonames/countryInfo.txt')
+ load_admin1_codes('download/geonames/admin1CodesASCII.txt')
+ load_admin2_codes('download/geonames/admin2Codes.txt')
+ load_geonames('download/geonames/IN.txt')
+ load_geonames('download/geonames/allCountries.txt')
+ load_alt_names('download/geonames/alternateNames.txt')
app.cli.add_command(geo)
diff --git a/funnel/cli/misc.py b/funnel/cli/misc.py
index d5f924bf8..2c02c7ed0 100644
--- a/funnel/cli/misc.py
+++ b/funnel/cli/misc.py
@@ -2,9 +2,11 @@
from __future__ import annotations
-from typing import Any, Dict
+from pathlib import Path
+from typing import Any
import click
+from dotenv import dotenv_values
from baseframe import baseframe_translations
@@ -13,7 +15,7 @@
@app.shell_context_processor
-def shell_context() -> Dict[str, Any]:
+def shell_context() -> dict[str, Any]:
"""Insert variables into flask shell locals."""
return {'db': db, 'models': models}
@@ -45,3 +47,13 @@ def dbcreate() -> None:
def baseframe_translations_path() -> None:
"""Show path to Baseframe translations."""
click.echo(list(baseframe_translations.translation_directories)[0])
+
+
+@app.cli.command('checkenv')
+@click.argument('file', type=click.Path(exists=True, path_type=Path), default='.env')
+def check_env(file: Path) -> None:
+ """Compare environment file with sample.env and lists variables that do not exist."""
+ env = dotenv_values(file)
+ for var in dotenv_values('sample.env'):
+ if var not in env:
+ click.echo(var + ' does not exist')
diff --git a/funnel/cli/periodic.py b/funnel/cli/periodic.py
deleted file mode 100644
index 43e05b47b..000000000
--- a/funnel/cli/periodic.py
+++ /dev/null
@@ -1,259 +0,0 @@
-"""Periodic maintenance actions."""
-
-from __future__ import annotations
-
-from dataclasses import dataclass
-from datetime import timedelta
-from typing import Any, Dict
-
-from flask.cli import AppGroup
-import click
-
-from dateutil.relativedelta import relativedelta
-import pytz
-import requests
-
-from coaster.utils import midnight_to_utc, utcnow
-
-from .. import app, models
-from ..models import db, sa
-from ..views.notification import dispatch_notification
-
-# --- Data sources ---------------------------------------------------------------------
-
-
-@dataclass
-class DataSource:
- """Source for data (query object and datetime column)."""
-
- basequery: Any
- datecolumn: Any
-
-
-def data_sources() -> Dict[str, DataSource]:
- """Return sources for daily growth report."""
- return {
- # `user_sessions`, `app_user_sessions` and `returning_users` (added below) are
- # lookup keys, while the others are titles
- 'user_sessions': DataSource(
- models.UserSession.query.distinct(models.UserSession.user_id),
- models.UserSession.accessed_at,
- ),
- 'app_user_sessions': DataSource(
- db.session.query(sa.func.distinct(models.UserSession.user_id))
- .select_from(models.auth_client_user_session, models.UserSession)
- .filter(
- models.auth_client_user_session.c.user_session_id
- == models.UserSession.id
- ),
- models.auth_client_user_session.c.accessed_at,
- ),
- "New users": DataSource(
- models.User.query.filter(models.User.state.ACTIVE),
- models.User.created_at,
- ),
- "RSVPs": DataSource(
- models.Rsvp.query.filter(models.Rsvp.state.YES), models.Rsvp.created_at
- ),
- "Saved projects": DataSource(
- models.SavedProject.query, models.SavedProject.saved_at
- ),
- "Saved sessions": DataSource(
- models.SavedSession.query, models.SavedSession.saved_at
- ),
- }
-
-
-# --- Commands -------------------------------------------------------------------------
-
-
-periodic = AppGroup(
- 'periodic', help="Periodic tasks from cron (with recommended intervals)"
-)
-
-
-@periodic.command('project_starting_alert')
-def project_starting_alert() -> None:
- """Send notifications for projects that are about to start schedule (5m)."""
- # Rollback to the most recent 5 minute interval, to account for startup delay
- # for periodic job processes.
- use_now = db.session.query(
- sa.func.date_trunc('hour', sa.func.utcnow())
- + sa.cast(sa.func.date_part('minute', sa.func.utcnow()), sa.Integer)
- / 5
- * timedelta(minutes=5)
- ).scalar()
-
- # Find all projects that have a session starting between 10 and 15 minutes from
- # use_now, and where the same project did not have a session ending within
- # the prior hour.
-
- # Any eager-loading columns and relationships should be deferred with
- # sa.orm.defer(column) and sa.orm.noload(relationship). There are none as of this
- # commit.
- for project in (
- models.Project.starting_at(
- use_now + timedelta(minutes=10),
- timedelta(minutes=5),
- timedelta(minutes=60),
- )
- .options(sa.orm.load_only(models.Project.uuid))
- .all()
- ):
- dispatch_notification(
- models.ProjectStartingNotification(
- document=project,
- fragment=project.next_session_from(use_now + timedelta(minutes=10)),
- )
- )
-
-
-@periodic.command('growthstats')
-def growthstats() -> None:
- """Publish growth statistics to Telegram (midnight)."""
- if not app.config.get('TELEGRAM_STATS_APIKEY') or not app.config.get(
- 'TELEGRAM_STATS_CHATID'
- ):
- raise click.UsageError(
- "Configure TELEGRAM_STATS_APIKEY and TELEGRAM_STATS_CHATID in settings",
- )
- # Dates in report timezone (for display)
- tz = pytz.timezone('Asia/Kolkata')
- now = utcnow().astimezone(tz)
- display_date = now - relativedelta(days=1)
- # Dates cast into UTC (for db queries)
- today = midnight_to_utc(now)
- yesterday = today - relativedelta(days=1)
- two_days_ago = today - relativedelta(days=2)
- last_week = today - relativedelta(weeks=1)
- last_week_and_a_day = today - relativedelta(days=8)
- two_weeks_ago = today - relativedelta(weeks=2)
- last_month = today - relativedelta(months=1)
- two_months_ago = today - relativedelta(months=2)
-
- stats = {
- key: {
- 'day': ds.basequery.filter(
- ds.datecolumn >= yesterday, ds.datecolumn < today
- ).count(),
- 'day_before': ds.basequery.filter(
- ds.datecolumn >= two_days_ago, ds.datecolumn < yesterday
- ).count(),
- 'weekday_before': ds.basequery.filter(
- ds.datecolumn >= last_week_and_a_day, ds.datecolumn < last_week
- ).count(),
- 'week': ds.basequery.filter(
- ds.datecolumn >= last_week, ds.datecolumn < today
- ).count(),
- 'week_before': ds.basequery.filter(
- ds.datecolumn >= two_weeks_ago, ds.datecolumn < last_week
- ).count(),
- 'month': ds.basequery.filter(
- ds.datecolumn >= last_month, ds.datecolumn < today
- ).count(),
- 'month_before': ds.basequery.filter(
- ds.datecolumn >= two_months_ago, ds.datecolumn < last_month
- ).count(),
- }
- for key, ds in data_sources().items()
- }
-
- stats.update(
- {
- 'returning_users': {
- # User from day before was active yesterday
- 'day': models.UserSession.query.join(models.User)
- .filter(
- models.UserSession.accessed_at >= yesterday,
- models.UserSession.accessed_at < today,
- models.User.created_at >= two_days_ago,
- models.User.created_at < yesterday,
- )
- .distinct(models.UserSession.user_id)
- .count(),
- # User from last week was active this week
- 'week': models.UserSession.query.join(models.User)
- .filter(
- models.UserSession.accessed_at >= last_week,
- models.UserSession.accessed_at < today,
- models.User.created_at >= two_weeks_ago,
- models.User.created_at < last_week,
- )
- .distinct(models.UserSession.user_id)
- .count(),
- # User from last month was active this month
- 'month': models.UserSession.query.join(models.User)
- .filter(
- models.UserSession.accessed_at >= last_month,
- models.UserSession.accessed_at < today,
- models.User.created_at >= two_months_ago,
- models.User.created_at < last_month,
- )
- .distinct(models.UserSession.user_id)
- .count(),
- }
- }
- )
-
- def trend_symbol(current: int, previous: int) -> str:
- """Return a trend symbol based on difference between current and previous."""
- if current > previous * 1.5:
- return '⏫'
- if current > previous:
- return '🔼'
- if current == previous:
- return '▶️'
- if current * 1.5 < previous:
- return '⏬'
- return '🔽'
-
- for key in stats:
- if key not in ('user_sessions', 'app_user_sessions', 'returning_users'):
- for period in ('day', 'week', 'month'):
- stats[key][period + '_trend'] = trend_symbol(
- stats[key][period], stats[key][period + '_before']
- )
- stats[key]['weekday_trend'] = trend_symbol(
- stats[key]['day'], stats[key]['weekday_before']
- )
-
- message = (
- f"*Growth #statistics for {display_date.strftime('%a, %-d %b %Y')}*\n"
- f"\n"
- f"*Active users*, of which\n"
- f"↝ also using other apps, and\n"
- f"⟳ returning new users from last period\n\n"
- f"*{display_date.strftime('%A')}:* {stats['user_sessions']['day']}"
- f" ↝ {stats['app_user_sessions']['day']}"
- f" ⟳ {stats['returning_users']['day']}\n"
- f"*Week:* {stats['user_sessions']['week']}"
- f" ↝ {stats['app_user_sessions']['week']}"
- f" ⟳ {stats['returning_users']['week']}\n"
- f"*Month:* {stats['user_sessions']['month']}"
- f" ↝ {stats['app_user_sessions']['month']}"
- f" ⟳ {stats['returning_users']['month']}\n"
- f"\n"
- )
- for key, data in stats.items():
- if key not in ('user_sessions', 'app_user_sessions', 'returning_users'):
- message += (
- f"*{key}:*\n"
- f"{data['day_trend']}{data['weekday_trend']} {data['day']} day,"
- f" {data['week_trend']} {data['week']} week,"
- f" {data['month_trend']} {data['month']} month\n"
- f"\n"
- )
-
- requests.post(
- f'https://api.telegram.org/bot{app.config["TELEGRAM_STATS_APIKEY"]}'
- f'/sendMessage',
- timeout=30,
- data={
- 'chat_id': app.config['TELEGRAM_STATS_CHATID'],
- 'parse_mode': 'markdown',
- 'text': message,
- },
- )
-
-
-app.cli.add_command(periodic)
diff --git a/funnel/cli/periodic/__init__.py b/funnel/cli/periodic/__init__.py
new file mode 100644
index 000000000..7d0e34674
--- /dev/null
+++ b/funnel/cli/periodic/__init__.py
@@ -0,0 +1,13 @@
+"""Periodic commands."""
+
+from flask.cli import AppGroup
+
+from ... import app
+
+periodic = AppGroup(
+ 'periodic', help="Periodic tasks from cron (with recommended intervals)"
+)
+
+from . import mnrl, notification, stats # noqa: F401
+
+app.cli.add_command(periodic)
diff --git a/funnel/cli/periodic/mnrl.py b/funnel/cli/periodic/mnrl.py
new file mode 100644
index 000000000..32ed7289f
--- /dev/null
+++ b/funnel/cli/periodic/mnrl.py
@@ -0,0 +1,279 @@
+"""
+Validate Indian phone numbers against the Mobile Number Revocation List.
+
+About MNRL: https://mnrl.trai.gov.in/homepage
+API details (requires login): https://mnrl.trai.gov.in/api_details, contents reproduced
+here:
+
+.. list-table:: API Description
+ :header-rows: 1
+
+ * - №
+ - API Name
+ - API URL
+ - Method
+ - Remark
+ * - 1
+ - Get MNRL Status
+ - https://mnrl.trai.gov.in/api/mnrl/status/{key}
+ - GET
+ - Returns the current status of MNRL.
+ * - 2
+ - Get MNRL Files
+ - https://mnrl.trai.gov.in/api/mnrl/files/{key}
+ - GET
+ - Returns the summary of MNRL files, to be used for further API calls to get the
+ list of mobile numbers or download the file.
+ * - 3
+ - Get MNRL
+ - https://mnrl.trai.gov.in/api/mnrl/json/{file_name}/{key}
+ - GET
+ - Returns the list of mobile numbers of the requested (.json) file.
+ * - 4
+ - Download MNRL
+ - https://mnrl.trai.gov.in/api/mnrl/download/{file_name}/{key}
+ - GET
+ - Can be used to download the file. (xlsx, pdf, json, rar)
+"""
+
+import asyncio
+
+import click
+import httpx
+import ijson
+from rich import get_console, print as rprint
+from rich.progress import Progress
+
+from ... import app
+from ...models import AccountPhone, PhoneNumber, db
+from . import periodic
+
+
+class KeyInvalidError(ValueError):
+ """MNRL API key is invalid."""
+
+ message = "MNRL API key is invalid"
+
+
+class KeyExpiredError(ValueError):
+ """MNRL API key has expired."""
+
+ message = "MNRL API key has expired"
+
+
+class AsyncStreamAsFile:
+ """Provide a :meth:`read` interface to a HTTPX async stream response for ijson."""
+
+ def __init__(self, response: httpx.Response) -> None:
+ self.data = response.aiter_bytes()
+
+ async def read(self, size: int) -> bytes:
+ """Async read method for ijson (which expects this to be 'read' not 'aread')."""
+ if size == 0:
+ # ijson calls with size 0 and expect b'', using it only to
+ # print a warning if the return value is '' (str instead of bytes)
+ return b''
+ # Python >= 3.10 supports `return await anext(self.data, b'')` but for older
+ # versions we need this try/except block
+ try:
+ # Ignore size parameter since anext doesn't take it
+ # pylint: disable=unnecessary-dunder-call
+ return await self.data.__anext__()
+ except StopAsyncIteration:
+ return b''
+
+
+async def get_existing_phone_numbers(prefix: str) -> set[str]:
+ """Async wrapper for PhoneNumber.get_numbers."""
+ # TODO: This is actually an async-blocking call. We need full stack async here.
+ return PhoneNumber.get_numbers(prefix=prefix, remove=True)
+
+
+async def get_mnrl_json_file_list(apikey: str) -> list[str]:
+ """
+ Return filenames for the currently published MNRL JSON files.
+
+ TRAI publishes the MNRL as a monthly series of files in Excel, PDF and JSON
+ formats, of which we'll use JSON (plaintext format isn't offered).
+ """
+ response = await httpx.AsyncClient(http2=True).get(
+ f'https://mnrl.trai.gov.in/api/mnrl/files/{apikey}', timeout=300
+ )
+ if response.status_code == 401:
+ raise KeyInvalidError()
+ if response.status_code == 407:
+ raise KeyExpiredError()
+ response.raise_for_status()
+
+ result = response.json()
+ # Fallback tests for non-200 status codes in a 200 response (current API behaviour)
+ if result['status'] == 401:
+ raise KeyInvalidError()
+ if result['status'] == 407:
+ raise KeyExpiredError()
+ return [row['file_name'] for row in result['mnrl_files']['json']]
+
+
+async def get_mnrl_json_file_numbers(
+ client: httpx.AsyncClient, apikey: str, filename: str
+) -> tuple[str, set[str]]:
+ """Return phone numbers from an MNRL JSON file URL."""
+ async with client.stream(
+ 'GET',
+ f'https://mnrl.trai.gov.in/api/mnrl/json/{filename}/{apikey}',
+ timeout=300,
+ ) as response:
+ response.raise_for_status()
+ # The JSON structure is {"payload": [{"n": "number"}, ...]}
+ # The 'item' in 'payload.item' is ijson's code for array elements
+ return filename, {
+ value
+ async for key, value in ijson.kvitems(
+ AsyncStreamAsFile(response), 'payload.item'
+ )
+ if key == 'n' and value is not None
+ }
+
+
+async def forget_phone_numbers(phone_numbers: set[str], prefix: str) -> None:
+ """Mark phone numbers as forgotten."""
+ for unprefixed in phone_numbers:
+ number = prefix + unprefixed
+ userphone = AccountPhone.get(number)
+ if userphone is not None:
+ # TODO: Dispatch a notification to userphone.account, but since the
+ # notification will not know the phone number (it'll already be forgotten),
+ # we need a new db model to contain custom messages
+ # TODO: Also delay dispatch until the full MNRL scan is complete -- their
+ # backup contact phone number may also have expired. That means this
+ # function will create notifications and return them, leaving dispatch to
+ # the outermost function
+ rprint(f"{userphone} - owned by {userphone.account.pickername}")
+ # TODO: MNRL isn't foolproof. Don't delete! Instead, notify the user and
+ # only delete if they don't respond (How? Maybe delete and send them a
+ # re-add token?)
+ # db.session.delete(userphone)
+ phone_number = PhoneNumber.get(number)
+ if phone_number is not None:
+ rprint(
+ f"{phone_number} - since {phone_number.created_at:%Y-%m-%d}, updated"
+ f" {phone_number.updated_at:%Y-%m-%d}"
+ )
+ # phone_number.mark_forgotten()
+ db.session.commit()
+
+
+async def process_mnrl_files(
+ apikey: str,
+ existing_phone_numbers: set[str],
+ phone_prefix: str,
+ mnrl_filenames: list[str],
+) -> tuple[set[str], int, int]:
+ """
+ Scan all MNRL files and return a tuple of results.
+
+ :return: Tuple of number to be revoked (set), total expired numbers in the MNRL,
+ and count of failures when accessing the MNRL lists
+ """
+ revoked_phone_numbers: set[str] = set()
+ mnrl_total_count = 0
+ failures = 0
+ async_tasks: set[asyncio.Task] = set()
+ with Progress(transient=True) as progress:
+ ptask = progress.add_task(
+ f"Processing {len(mnrl_filenames)} MNRL files", total=len(mnrl_filenames)
+ )
+ async with httpx.AsyncClient(
+ http2=True, limits=httpx.Limits(max_connections=3)
+ ) as client:
+ for future in asyncio.as_completed(
+ [
+ get_mnrl_json_file_numbers(client, apikey, filename)
+ for filename in mnrl_filenames
+ ]
+ ):
+ try:
+ filename, mnrl_set = await future
+ except httpx.HTTPError as exc:
+ progress.advance(ptask)
+ failures += 1
+ # Extract filename from the URL (ends with /filename/apikey) as we
+ # can't get any context from asyncio.as_completed's future
+ filename = exc.request.url.path.split('/')[-2]
+ progress.update(ptask, description=f"Error in {filename}...")
+ if isinstance(exc, httpx.HTTPStatusError):
+ rprint(
+ f"[red]{filename}: Server returned HTTP status code"
+ f" {exc.response.status_code}"
+ )
+ else:
+ rprint(f"[red]{filename}: Failed with {exc!r}")
+ else:
+ progress.advance(ptask)
+ mnrl_total_count += len(mnrl_set)
+ progress.update(ptask, description=f"Processing {filename}...")
+ found_expired = existing_phone_numbers.intersection(mnrl_set)
+ if found_expired:
+ revoked_phone_numbers.update(found_expired)
+ rprint(
+ f"[blue]{filename}: {len(found_expired):,} matches in"
+ f" {len(mnrl_set):,} total"
+ )
+ async_tasks.add(
+ asyncio.create_task(
+ forget_phone_numbers(found_expired, phone_prefix)
+ )
+ )
+ else:
+ rprint(
+ f"[cyan]{filename}: No matches in {len(mnrl_set):,} total"
+ )
+
+ # Await all the background tasks
+ for task in async_tasks:
+ try:
+ # TODO: Change this to `notifications = await task` then return them too
+ await task
+ except Exception as exc: # noqa: B902 # pylint: disable=broad-except
+ app.logger.exception("%s in forget_phone_numbers", repr(exc))
+ return revoked_phone_numbers, mnrl_total_count, failures
+
+
+async def process_mnrl(apikey: str) -> None:
+ """Process MNRL data using the API key."""
+ console = get_console()
+ phone_prefix = '+91'
+ task_numbers = asyncio.create_task(get_existing_phone_numbers(phone_prefix))
+ task_files = asyncio.create_task(get_mnrl_json_file_list(apikey))
+ with console.status("Loading phone numbers..."):
+ existing_phone_numbers = await task_numbers
+ rprint(f"Evaluating {len(existing_phone_numbers):,} phone numbers for expiry")
+ try:
+ with console.status("Getting MNRL download list..."):
+ mnrl_filenames = await task_files
+ except httpx.HTTPError as exc:
+ err = f"{exc!r} in MNRL API getting download list"
+ rprint(f"[red]{err}")
+ raise click.ClickException(err)
+
+ revoked_phone_numbers, mnrl_total_count, failures = await process_mnrl_files(
+ apikey, existing_phone_numbers, phone_prefix, mnrl_filenames
+ )
+ rprint(
+ f"Processed {mnrl_total_count:,} expired phone numbers in MNRL with"
+ f" {failures:,} failure(s) and revoked {len(revoked_phone_numbers):,} phone"
+ f" numbers"
+ )
+
+
+@periodic.command('mnrl')
+def periodic_mnrl() -> None:
+ """Remove expired phone numbers using TRAI's MNRL (1 week)."""
+ apikey = app.config.get('MNRL_API_KEY')
+ if not apikey:
+ raise click.UsageError("App config is missing `MNRL_API_KEY`")
+ try:
+ asyncio.run(process_mnrl(apikey))
+ except (KeyInvalidError, KeyExpiredError) as exc:
+ app.logger.error(exc.message)
+ raise click.ClickException(exc.message) from exc
diff --git a/funnel/cli/periodic/notification.py b/funnel/cli/periodic/notification.py
new file mode 100644
index 000000000..5d0c62315
--- /dev/null
+++ b/funnel/cli/periodic/notification.py
@@ -0,0 +1,46 @@
+"""Periodic scans for notifications to be sent out."""
+
+from __future__ import annotations
+
+from datetime import timedelta
+
+from ... import models
+from ...models import db, sa
+from ...views.notification import dispatch_notification
+from . import periodic
+
+
+@periodic.command('project_starting_alert')
+def project_starting_alert() -> None:
+ """Send notifications for projects that are about to start schedule (5m)."""
+ # Rollback to the most recent 5 minute interval, to account for startup delay
+ # for periodic job processes.
+ use_now = db.session.query(
+ sa.func.date_trunc('hour', sa.func.utcnow())
+ + sa.cast(sa.func.date_part('minute', sa.func.utcnow()), sa.Integer)
+ / 5
+ * timedelta(minutes=5)
+ ).scalar()
+
+ # Find all projects that have a session starting between 10 and 15 minutes from
+ # use_now, and where the same project did not have a session ending within
+ # the prior hour.
+
+ # Any eager-loading columns and relationships should be deferred with
+ # sa.orm.defer(column) and sa.orm.noload(relationship). There are none as of this
+ # commit.
+ for project in (
+ models.Project.starting_at(
+ use_now + timedelta(minutes=10),
+ timedelta(minutes=5),
+ timedelta(minutes=60),
+ )
+ .options(sa.orm.load_only(models.Project.uuid))
+ .all()
+ ):
+ dispatch_notification(
+ models.ProjectStartingNotification(
+ document=project,
+ fragment=project.next_session_from(use_now + timedelta(minutes=10)),
+ )
+ )
diff --git a/funnel/cli/periodic/stats.py b/funnel/cli/periodic/stats.py
new file mode 100644
index 000000000..a36d783a4
--- /dev/null
+++ b/funnel/cli/periodic/stats.py
@@ -0,0 +1,466 @@
+"""Periodic statistics."""
+
+from __future__ import annotations
+
+import asyncio
+from collections.abc import Sequence
+from dataclasses import dataclass
+from datetime import datetime
+from typing import Literal, cast, overload
+from urllib.parse import unquote
+
+import click
+import httpx
+import pytz
+import telegram
+from dataclasses_json import DataClassJsonMixin
+from dateutil.relativedelta import relativedelta
+from furl import furl
+
+from coaster.utils import midnight_to_utc, utcnow
+
+from ... import app, models
+from ...models import Mapped, Query, db, sa
+from . import periodic
+
+# --- Data structures ------------------------------------------------------------------
+
+
+def trend_symbol(current: int, previous: int) -> str:
+ """Return a trend symbol based on difference between current and previous."""
+ if current > previous * 1.5:
+ return '⏫'
+ if current > previous:
+ return '🔼'
+ if current == previous:
+ return '⏸️'
+ if current * 1.5 < previous:
+ return '⏬'
+ return '🔽'
+
+
+@dataclass
+class DataSource:
+ """Source for data (query object and datetime column)."""
+
+ basequery: Query
+ datecolumn: Mapped[datetime]
+
+
+@dataclass
+class ResourceStats:
+ """Periodic counts for a resource."""
+
+ day: int
+ week: int
+ month: int
+ # The previous period counts are optional
+ day_before: int = 0
+ weekday_before: int = 0
+ week_before: int = 0
+ month_before: int = 0
+ # Trend symbols are also optional
+ day_trend: str = ''
+ weekday_trend: str = ''
+ week_trend: str = ''
+ month_trend: str = ''
+
+ def set_trend_symbols(self) -> None:
+ self.day_trend = trend_symbol(self.day, self.day_before)
+ self.weekday_trend = trend_symbol(self.day, self.weekday_before)
+ self.week_trend = trend_symbol(self.week, self.week_before)
+ self.month_trend = trend_symbol(self.month, self.month_before)
+
+
+@dataclass
+class MatomoResponse(DataClassJsonMixin):
+ """Data in Matomo's API response."""
+
+ label: str = ''
+ nb_visits: int = 0
+ nb_uniq_visitors: int = 0
+ nb_users: int = 0
+ url: str | None = None
+ segment: str = ''
+
+ def get_url(self) -> str | None:
+ url = self.url
+ if url:
+ # If URL is a path (/path) or schemeless (//host/path), return as is
+ if url.startswith('/'):
+ return url
+ # If there's no leading `/` and no `://`, prefix `https://`
+ if '://' not in url:
+ return f'https://{url}'
+ # If neither, assume fully formed URL and return as is
+ return url
+ # If there's no URL in the data, look for a URL in the segment identifier
+ if self.segment.startswith('pageUrl='):
+ # Known prefixes: `pageUrl==` and `pageUrl=^` (9 chars)
+ # The rest of the string is double escaped, so unquote twice
+ return unquote(unquote(self.segment[9:]))
+ return None
+
+
+@dataclass
+class MatomoData:
+ """Matomo API data."""
+
+ referrers: Sequence[MatomoResponse]
+ socials: Sequence[MatomoResponse]
+ pages: Sequence[MatomoResponse]
+ visits_day: MatomoResponse | None = None
+ visits_week: MatomoResponse | None = None
+ visits_month: MatomoResponse | None = None
+
+
+# --- Matomo analytics -----------------------------------------------------------------
+
+
+@overload
+async def matomo_response_json(
+ client: httpx.AsyncClient, url: str, sequence: Literal[True] = True
+) -> Sequence[MatomoResponse]:
+ ...
+
+
+@overload
+async def matomo_response_json(
+ client: httpx.AsyncClient, url: str, sequence: Literal[False]
+) -> MatomoResponse | None:
+ ...
+
+
+async def matomo_response_json(
+ client: httpx.AsyncClient, url: str, sequence: bool = True
+) -> MatomoResponse | Sequence[MatomoResponse] | None:
+ """Process Matomo's JSON response."""
+ try:
+ response = await client.get(url, timeout=30)
+ response.raise_for_status()
+ result = response.json()
+ if sequence:
+ if isinstance(result, list):
+ return [MatomoResponse.from_dict(r) for r in result]
+ return [] # Expected a list but didn't get one; treat as invalid response
+ return MatomoResponse.from_dict(result)
+ except httpx.HTTPError:
+ return [] if sequence else None
+
+
+async def matomo_stats() -> MatomoData:
+ """Get stats from Matomo."""
+ tz = pytz.timezone(app.config['TIMEZONE'])
+ now = utcnow().astimezone(tz)
+ today = midnight_to_utc(now)
+ yesterday = today - relativedelta(days=1)
+ last_week = yesterday - relativedelta(weeks=1)
+ last_month = yesterday - relativedelta(months=1)
+ week_range = f'{last_week.strftime("%Y-%m-%d")},{yesterday.strftime("%Y-%m-%d")}'
+ month_range = f'{last_month.strftime("%Y-%m-%d")},{yesterday.strftime("%Y-%m-%d")}'
+ if (
+ not app.config.get('MATOMO_URL')
+ or not app.config.get('MATOMO_ID')
+ or not app.config.get('MATOMO_TOKEN')
+ ):
+ # No Matomo config
+ return MatomoData(referrers=[], socials=[], pages=[])
+ matomo_url = furl(app.config['MATOMO_URL'])
+ matomo_url.add(
+ {
+ 'token_auth': app.config['MATOMO_TOKEN'],
+ 'module': 'API',
+ 'idSite': app.config['MATOMO_ID'],
+ 'filter_limit': 10, # Get top 10
+ 'format': 'json',
+ }
+ )
+ referrers_url = matomo_url.copy().add(
+ {
+ 'method': 'Referrers.getWebsites',
+ 'period': 'day',
+ 'date': 'yesterday',
+ }
+ )
+ socials_url = matomo_url.copy().add(
+ {
+ 'method': 'Referrers.getSocials',
+ 'period': 'day',
+ 'date': 'yesterday',
+ }
+ )
+ pages_url = matomo_url.copy().add(
+ {
+ 'method': 'Actions.getPageUrls',
+ 'period': 'day',
+ 'date': 'yesterday',
+ }
+ )
+ visits_day_url = matomo_url.copy().add(
+ {
+ 'method': 'VisitsSummary.get',
+ 'period': 'day',
+ 'date': 'yesterday',
+ }
+ )
+ visits_week_url = matomo_url.copy().add(
+ {
+ 'method': 'VisitsSummary.get',
+ 'period': 'range',
+ 'date': week_range,
+ }
+ )
+ visits_month_url = matomo_url.copy().add(
+ {
+ 'method': 'VisitsSummary.get',
+ 'period': 'range',
+ 'date': month_range,
+ }
+ )
+
+ async with httpx.AsyncClient(follow_redirects=True) as client:
+ (
+ referrers,
+ socials,
+ pages,
+ visits_day,
+ visits_week,
+ visits_month,
+ ) = await asyncio.gather(
+ matomo_response_json(client, str(referrers_url)),
+ matomo_response_json(client, str(socials_url)),
+ matomo_response_json(client, str(pages_url)),
+ matomo_response_json(client, str(visits_day_url), sequence=False),
+ matomo_response_json(client, str(visits_week_url), sequence=False),
+ matomo_response_json(client, str(visits_month_url), sequence=False),
+ )
+ return MatomoData(
+ referrers=referrers,
+ socials=socials,
+ pages=pages,
+ visits_day=visits_day,
+ visits_week=visits_week,
+ visits_month=visits_month,
+ )
+
+
+# --- Internal database analytics ------------------------------------------------------
+
+
+def data_sources() -> dict[str, DataSource]:
+ """Return sources for daily stats report."""
+ return {
+ # `login_sessions`, `app_login_sessions` and `returning_users` (added below) are
+ # lookup keys, while the others are titles
+ 'login_sessions': DataSource(
+ models.LoginSession.query.distinct(models.LoginSession.account_id),
+ models.LoginSession.accessed_at,
+ ),
+ 'app_login_sessions': DataSource(
+ db.session.query(sa.func.distinct(models.LoginSession.account_id))
+ .select_from(models.auth_client_login_session, models.LoginSession)
+ .filter(
+ models.auth_client_login_session.c.login_session_id
+ == models.LoginSession.id
+ ),
+ cast(Mapped[datetime], models.auth_client_login_session.c.accessed_at),
+ ),
+ "New users": DataSource(
+ models.Account.query.filter(models.Account.state.ACTIVE),
+ models.Account.created_at,
+ ),
+ "RSVPs": DataSource(
+ models.Rsvp.query.filter(models.Rsvp.state.YES), models.Rsvp.created_at
+ ),
+ "Saved projects": DataSource(
+ models.SavedProject.query, models.SavedProject.saved_at
+ ),
+ "Saved sessions": DataSource(
+ models.SavedSession.query, models.SavedSession.saved_at
+ ),
+ }
+
+
+async def user_stats() -> dict[str, ResourceStats]:
+ """Retrieve user statistics from internal database."""
+ # Dates in report timezone (for display)
+ tz = pytz.timezone(app.config['TIMEZONE'])
+ now = utcnow().astimezone(tz)
+ # Dates cast into UTC (for db queries)
+ today = midnight_to_utc(now)
+ yesterday = today - relativedelta(days=1)
+ two_days_ago = today - relativedelta(days=2)
+ last_week = today - relativedelta(weeks=1)
+ last_week_and_a_day = today - relativedelta(days=8)
+ two_weeks_ago = today - relativedelta(weeks=2)
+ last_month = today - relativedelta(months=1)
+ two_months_ago = today - relativedelta(months=2)
+
+ stats: dict[str, ResourceStats] = {
+ key: ResourceStats(
+ day=ds.basequery.filter(
+ ds.datecolumn >= yesterday, ds.datecolumn < today
+ ).count(),
+ day_before=ds.basequery.filter(
+ ds.datecolumn >= two_days_ago, ds.datecolumn < yesterday
+ ).count(),
+ weekday_before=ds.basequery.filter(
+ ds.datecolumn >= last_week_and_a_day, ds.datecolumn < last_week
+ ).count(),
+ week=ds.basequery.filter(
+ ds.datecolumn >= last_week, ds.datecolumn < today
+ ).count(),
+ week_before=ds.basequery.filter(
+ ds.datecolumn >= two_weeks_ago, ds.datecolumn < last_week
+ ).count(),
+ month=ds.basequery.filter(
+ ds.datecolumn >= last_month, ds.datecolumn < today
+ ).count(),
+ month_before=ds.basequery.filter(
+ ds.datecolumn >= two_months_ago, ds.datecolumn < last_month
+ ).count(),
+ )
+ for key, ds in data_sources().items()
+ }
+
+ stats.update(
+ {
+ 'returning_users': ResourceStats(
+ # User from day before was active yesterday
+ day=models.LoginSession.query.join(models.Account)
+ .filter(
+ models.LoginSession.accessed_at >= yesterday,
+ models.LoginSession.accessed_at < today,
+ models.Account.created_at >= two_days_ago,
+ models.Account.created_at < yesterday,
+ )
+ .distinct(models.LoginSession.account_id)
+ .count(),
+ # User from last week was active this week
+ week=models.LoginSession.query.join(models.Account)
+ .filter(
+ models.LoginSession.accessed_at >= last_week,
+ models.LoginSession.accessed_at < today,
+ models.Account.created_at >= two_weeks_ago,
+ models.Account.created_at < last_week,
+ )
+ .distinct(models.LoginSession.account_id)
+ .count(),
+ # User from last month was active this month
+ month=models.LoginSession.query.join(models.Account)
+ .filter(
+ models.LoginSession.accessed_at >= last_month,
+ models.LoginSession.accessed_at < today,
+ models.Account.created_at >= two_months_ago,
+ models.Account.created_at < last_month,
+ )
+ .distinct(models.LoginSession.account_id)
+ .count(),
+ )
+ }
+ )
+
+ for key in stats:
+ if key not in ('login_sessions', 'app_login_sessions', 'returning_users'):
+ stats[key].set_trend_symbols()
+
+ return stats
+
+
+# --- Commands -------------------------------------------------------------------------
+
+
+async def dailystats() -> None:
+ """Publish daily stats to Telegram."""
+ if (
+ not app.config.get('TELEGRAM_STATS_APIKEY')
+ or not app.config.get('TELEGRAM_STATS_CHATID')
+ or not app.config.get('TIMEZONE')
+ ):
+ raise click.UsageError(
+ "Configure TELEGRAM_STATS_APIKEY, TELEGRAM_STATS_CHATID and TIMEZONE in"
+ " settings",
+ )
+
+ tz = pytz.timezone(app.config['TIMEZONE'])
+ now = utcnow().astimezone(tz)
+ display_date = now - relativedelta(days=1)
+
+ user_data, matomo_data = await asyncio.gather(user_stats(), matomo_stats())
+ message = (
+ f"*Traffic #statistics for {display_date.strftime('%a, %-d %b %Y')}*\n"
+ f"\n"
+ f"*Active users*, of which\n"
+ f"→ logged in, and\n"
+ f"↝ also using other apps, and\n"
+ f"⟳ returning new registered users from last period\n\n"
+ f"*{display_date.strftime('%A')}:*"
+ )
+ if matomo_data.visits_day:
+ message += f' {matomo_data.visits_day.nb_uniq_visitors}'
+ message += (
+ f" → {user_data['login_sessions'].day}"
+ f" ↝ {user_data['app_login_sessions'].day}"
+ f" ⟳ {user_data['returning_users'].day}\n"
+ f"*Week:*"
+ )
+ if matomo_data.visits_week:
+ message += f' {matomo_data.visits_week.nb_uniq_visitors}'
+ message += (
+ f" → {user_data['login_sessions'].week}"
+ f" ↝ {user_data['app_login_sessions'].week}"
+ f" ⟳ {user_data['returning_users'].week}\n"
+ f"*Month:*"
+ )
+ if matomo_data.visits_month:
+ message += f' {matomo_data.visits_month.nb_uniq_visitors}'
+ message += (
+ f" → {user_data['login_sessions'].month}"
+ f" ↝ {user_data['app_login_sessions'].month}"
+ f" ⟳ {user_data['returning_users'].month}\n"
+ f"\n"
+ )
+ for key, data in user_data.items():
+ if key not in ('login_sessions', 'app_login_sessions', 'returning_users'):
+ message += (
+ f"*{key}:*\n"
+ f"{data.day_trend}{data.weekday_trend} {data.day} day,"
+ f" {data.week_trend} {data.week} week,"
+ f" {data.month_trend} {data.month} month\n"
+ f"\n"
+ )
+
+ if matomo_data.pages:
+ message += "\n*Top pages:* _(by visits)_\n"
+ for mdata in matomo_data.pages:
+ url = mdata.get_url()
+ if url:
+ message += f"{mdata.nb_visits}: [{mdata.label.strip()}]({url})\n"
+ else:
+ message += f"{mdata.nb_visits}: {mdata.label.strip()}\n"
+
+ if matomo_data.referrers:
+ message += "\n*Referrers:*\n"
+ for mdata in matomo_data.referrers:
+ message += f"{mdata.nb_visits}: {mdata.label.strip()}\n"
+
+ if matomo_data.socials:
+ message += "\n*Socials:*\n"
+ for mdata in matomo_data.socials:
+ message += f"{mdata.nb_visits}: {mdata.label.strip()}\n"
+
+ bot = telegram.Bot(app.config["TELEGRAM_STATS_APIKEY"])
+ await bot.send_message(
+ text=message,
+ parse_mode='markdown',
+ chat_id=app.config['TELEGRAM_STATS_CHATID'],
+ disable_notification=True,
+ disable_web_page_preview=True,
+ message_thread_id=app.config.get('TELEGRAM_STATS_THREADID'),
+ )
+
+
+@periodic.command('dailystats')
+def periodic_dailystats() -> None:
+ """Publish daily stats to Telegram (midnight)."""
+ asyncio.run(dailystats())
diff --git a/funnel/cli/refresh/markdown.py b/funnel/cli/refresh/markdown.py
index 9f3df7543..17e9d0086 100644
--- a/funnel/cli/refresh/markdown.py
+++ b/funnel/cli/refresh/markdown.py
@@ -2,41 +2,43 @@
from __future__ import annotations
-from typing import ClassVar, Dict, List, Optional, Set
+from collections.abc import Iterable
+from typing import ClassVar, Generic, TypeVar
import click
-
import rich.progress
from ... import models
-from ...models import db, sa
+from ...models import MarkdownModelUnion, db, sa
from . import refresh
+_M = TypeVar('_M', bound=MarkdownModelUnion)
+
-class MarkdownModel:
+class MarkdownModel(Generic[_M]):
"""Holding class for a model that has markdown fields with custom configuration."""
- registry: ClassVar[Dict[str, MarkdownModel]] = {}
- config_registry: ClassVar[Dict[str, Set[MarkdownModel]]] = {}
+ registry: ClassVar[dict[str, MarkdownModel]] = {}
+ config_registry: ClassVar[dict[str, set[MarkdownModel]]] = {}
- def __init__(self, model, fields: Set[str]):
+ def __init__(self, model: type[_M], fields: set[str]) -> None:
self.name = model.__tablename__
self.model = model
self.fields = fields
- self.config_fields: Dict[str, Set[str]] = {}
+ self.config_fields: dict[str, set[str]] = {}
for field in fields:
config = getattr(model, field).original_property.composite_class.config.name
self.config_fields.setdefault(config, set()).add(field)
@classmethod
- def register(cls, model, fields: Set[str]):
+ def register(cls, model: type[_M], fields: set[str]) -> None:
"""Create an instance and add it to the registry."""
obj = cls(model, fields)
for config in obj.config_fields:
cls.config_registry.setdefault(config, set()).add(obj)
cls.registry[obj.name] = obj
- def reparse(self, config: Optional[str] = None, obj=None):
+ def reparse(self, config: str | None = None, obj: _M | None = None) -> None:
"""Reparse Markdown fields, optionally for a single config profile."""
if config and config not in self.config_fields:
return
@@ -45,17 +47,19 @@ def reparse(self, config: Optional[str] = None, obj=None):
else:
fields = self.fields
+ iter_list: Iterable[_M]
+
if obj is not None:
iter_list = [obj]
iter_total = 1
else:
load_columns = (
- ['id']
- + [f'{field}_text'.lstrip('_') for field in fields]
- + [f'{field}_html'.lstrip('_') for field in fields]
+ [self.model.id]
+ + [getattr(self.model, f'{field}_text'.lstrip('_')) for field in fields]
+ + [getattr(self.model, f'{field}_html'.lstrip('_')) for field in fields]
)
iter_list = (
- self.model.query.order_by('id')
+ self.model.query.order_by(self.model.id)
.options(sa.orm.load_only(*load_columns))
.yield_per(10)
)
@@ -78,7 +82,7 @@ def reparse(self, config: Optional[str] = None, obj=None):
MarkdownModel.register(models.Comment, {'_message'})
-MarkdownModel.register(models.Profile, {'description'})
+MarkdownModel.register(models.Account, {'description'})
MarkdownModel.register(models.Project, {'description', 'instructions'})
MarkdownModel.register(models.Proposal, {'body'})
MarkdownModel.register(models.Session, {'description'})
@@ -88,7 +92,9 @@ def reparse(self, config: Optional[str] = None, obj=None):
@refresh.command('markdown')
-@click.argument('content', type=click.Choice(MarkdownModel.registry.keys()), nargs=-1)
+@click.argument(
+ 'content', type=click.Choice(list(MarkdownModel.registry.keys())), nargs=-1
+)
@click.option(
'-a',
'--all',
@@ -99,7 +105,7 @@ def reparse(self, config: Optional[str] = None, obj=None):
@click.option(
'-c',
'--config',
- type=click.Choice(MarkdownModel.config_registry.keys()),
+ type=click.Choice(list(MarkdownModel.config_registry.keys())),
help="Reparse Markdown content using a specific configuration.",
)
@click.option(
@@ -108,7 +114,7 @@ def reparse(self, config: Optional[str] = None, obj=None):
help="Reparse content at this URL",
)
def markdown(
- content: List[str], config: Optional[str], allcontent: bool, url: Optional[str]
+ content: list[str], config: str | None, allcontent: bool, url: str | None
) -> None:
"""Reparse Markdown content."""
if allcontent:
diff --git a/funnel/devtest.py b/funnel/devtest.py
index 4867ce8b2..21cdb251f 100644
--- a/funnel/devtest.py
+++ b/funnel/devtest.py
@@ -2,33 +2,36 @@
from __future__ import annotations
-from typing import Any, Callable, Dict, Iterable, NamedTuple, Optional, Tuple
import atexit
+import gc
+import inspect
import multiprocessing
import os
-import platform
import signal
import socket
import time
-
-from sqlalchemy.engine import Engine
+import weakref
+from collections.abc import Callable, Iterable
+from secrets import token_urlsafe
+from typing import Any, NamedTuple
+from typing_extensions import Protocol
from flask import Flask
-from . import app as main_app
-from . import shortlinkapp
+from . import app as main_app, shortlinkapp, transports, unsubscribeapp
from .models import db
from .typing import ReturnView
__all__ = ['AppByHostWsgi', 'BackgroundWorker', 'devtest_app']
-# Force 'fork' on macOS. The default mode of 'spawn' (from py38) causes a pickling
-# error in py39, as reported in pytest-flask:
-# https://github.com/pytest-dev/pytest-flask/pull/138
-# https://github.com/pytest-dev/pytest-flask/issues/139
-if platform.system() == 'Darwin':
- os.environ['OBJC_DISABLE_INITIALIZE_FORK_SAFETY'] = 'YES'
- multiprocessing = multiprocessing.get_context('fork') # type: ignore[assignment]
+# Devtest requires `fork`. The default `spawn` method on macOS and Windows will
+# cause pickling errors all over. `fork` is unavailable on Windows, so
+# :class:`BackgroundWorker` can't be used there either, affecting `devserver.py` and the
+# Pytest `live_server` fixture used for end-to-end tests. Fork on macOS is not
+# compatible with the Objective C framework. If you have a framework Python build and
+# experience crashes, try setting the environment variable
+# OBJC_DISABLE_INITIALIZE_FORK_SAFETY=YES
+mpcontext = multiprocessing.get_context('fork')
# --- Development and testing app multiplexer ------------------------------------------
@@ -64,7 +67,7 @@ def __init__(self, *apps: Flask) -> None:
for app in apps:
if not app.config.get('SERVER_NAME'):
raise ValueError(f"App does not have SERVER_NAME set: {app!r}")
- self.apps_by_host: Dict[str, Flask] = {
+ self.apps_by_host: dict[str, Flask] = {
app.config['SERVER_NAME'].split(':', 1)[0]: app for app in apps
}
@@ -92,12 +95,12 @@ def get_app(self, host: str) -> Flask:
# If no host matched, use the info app
return info_app
- def __call__(self, environ, start_response) -> Iterable[bytes]:
+ def __call__(self, environ: Any, start_response: Any) -> Iterable[bytes]:
use_app = self.get_app(environ['HTTP_HOST'])
return use_app(environ, start_response)
-devtest_app = AppByHostWsgi(main_app, shortlinkapp)
+devtest_app = AppByHostWsgi(main_app, shortlinkapp, unsubscribeapp)
# --- Background worker ----------------------------------------------------------------
@@ -109,16 +112,122 @@ class HostPort(NamedTuple):
port: int
-def _dispose_engines_in_child_process(
- engines: Iterable[Engine],
+class CapturedSms(NamedTuple):
+ phone: str
+ message: str
+ vars: dict[str, str] # noqa: A003
+
+
+class CapturedEmail(NamedTuple):
+ subject: str
+ to: list[str]
+ content: str
+ from_email: str | None
+
+
+class CapturedCalls(Protocol):
+ """Protocol class for captured calls."""
+
+ email: list[CapturedEmail]
+ sms: list[CapturedSms]
+
+
+def _signature_without_annotations(func) -> inspect.Signature:
+ """Generate a function signature without parameter type annotations."""
+ sig = inspect.signature(func)
+ return sig.replace(
+ parameters=[
+ p.replace(annotation=inspect.Parameter.empty)
+ for p in sig.parameters.values()
+ ]
+ )
+
+
+def install_mock(func: Callable, mock: Callable) -> None:
+ """
+ Patch all existing references to :attr:`func` with :attr:`mock`.
+
+ Uses the Python garbage collector to find and replace all references.
+ """
+ # Validate function signature match before patching, ignoring type annotations
+ fsig = _signature_without_annotations(func)
+ msig = _signature_without_annotations(mock)
+ if fsig != msig:
+ raise TypeError(
+ f"Mock function’s signature does not match original’s:\n"
+ f"{mock.__name__}{msig} !=\n"
+ f"{func.__name__}{fsig}"
+ )
+ # Use weakref to dereference func from local namespace
+ func = weakref.ref(func)
+ gc.collect()
+ refs = gc.get_referrers(func()) # type: ignore[misc]
+ # Recover func from the weakref so we can do an `is` match in referrers
+ func = func() # type: ignore[misc]
+ for ref in refs:
+ if isinstance(ref, dict):
+ # We have a namespace dict. Iterate through contents to find the reference
+ # and replace it
+ for key, value in ref.items():
+ if value is func:
+ ref[key] = mock
+
+
+def _prepare_subprocess(
+ mock_transports: bool,
+ calls: CapturedCalls,
worker: Callable,
- args: Tuple[Any],
- kwargs: Dict[str, Any],
+ args: tuple[Any],
+ kwargs: dict[str, Any],
) -> Any:
- """Dispose SQLAlchemy engine connections in a forked process."""
- # https://docs.sqlalchemy.org/en/14/core/pooling.html#pooling-multiprocessing
- for e in engines:
- e.dispose(close=False) # type: ignore[call-arg]
+ """
+ Prepare a subprocess for hosting a worker.
+
+ 1. Dispose all SQLAlchemy engine connections so they're not shared with the parent
+ 2. Mock transports if requested, redirecting all calls to a log
+ 3. Launch the worker
+ """
+ # https://docs.sqlalchemy.org/en/20/core/pooling.html#pooling-multiprocessing
+ with main_app.app_context():
+ for engine in db.engines.values():
+ engine.dispose(close=False)
+
+ if mock_transports:
+
+ def mock_email(
+ subject: str,
+ to: list[Any],
+ content: str,
+ attachments=None,
+ from_email: Any | None = None,
+ headers: dict | None = None,
+ base_url: str | None = None,
+ ) -> str:
+ capture = CapturedEmail(
+ subject,
+ [str(each) for each in to],
+ content,
+ str(from_email) if from_email else None,
+ )
+ calls.email.append(capture)
+ main_app.logger.info(capture)
+ return token_urlsafe()
+
+ def mock_sms(
+ phone: Any,
+ message: transports.sms.SmsTemplate,
+ callback: bool = True,
+ ) -> str:
+ capture = CapturedSms(str(phone), str(message), message.vars())
+ calls.sms.append(capture)
+ main_app.logger.info(capture)
+ return token_urlsafe()
+
+ # Patch email
+ install_mock(transports.email.send.send_email, mock_email)
+ # Patch SMS
+ install_mock(transports.sms.send.send_sms, mock_sms)
+
return worker(*args, **kwargs)
@@ -130,21 +239,23 @@ class BackgroundWorker:
:param worker: The worker to run
:param args: Args for worker
:param kwargs: Kwargs for worker
- :param probe: Optional host and port to probe for ready state
+ :param probe_at: Optional tuple of (host, port) to probe for ready state
:param timeout: Timeout after which launch is considered to have failed
:param clean_stop: Ask for graceful shutdown (default yes)
:param daemon: Run process in daemon mode (linked to parent, automatic shutdown)
+ :param mock_transports: Patch transports with mock functions that write to a log
"""
- def __init__( # pylint: disable=too-many-arguments
+ def __init__(
self,
worker: Callable,
- args: Optional[Iterable] = None,
- kwargs: Optional[dict] = None,
- probe_at: Optional[Tuple[str, int]] = None,
+ args: Iterable | None = None,
+ kwargs: dict | None = None,
+ probe_at: tuple[str, int] | None = None,
timeout: int = 10,
- clean_stop=True,
- daemon=True,
+ clean_stop: bool = True,
+ daemon: bool = True,
+ mock_transports: bool = False,
) -> None:
self.worker = worker
self.worker_args = args or ()
@@ -153,22 +264,28 @@ def __init__( # pylint: disable=too-many-arguments
self.timeout = timeout
self.clean_stop = clean_stop
self.daemon = daemon
- self._process: Optional[multiprocessing.Process] = None
+ self._process: multiprocessing.context.ForkProcess | None = None
+ self.mock_transports = mock_transports
+
+ manager = mpcontext.Manager()
+ self.calls: CapturedCalls = manager.Namespace()
+ self.calls.email = manager.list()
+ self.calls.sms = manager.list()
def start(self) -> None:
"""Start worker in a separate process."""
if self._process is not None:
return
- engines = set()
- for app in main_app, shortlinkapp: # TODO: Add hasjobapp here
- with app.app_context():
- engines.add(db.engines[None])
- for bind in app.config.get('SQLALCHEMY_BINDS') or ():
- engines.add(db.engines[bind])
- self._process = multiprocessing.Process(
- target=_dispose_engines_in_child_process,
- args=(engines, self.worker, self.worker_args, self.worker_kwargs),
+ self._process = mpcontext.Process(
+ target=_prepare_subprocess,
+ args=(
+ self.mock_transports,
+ self.calls,
+ self.worker,
+ self.worker_args,
+ self.worker_kwargs,
+ ),
)
self._process.daemon = self.daemon
self._process.start()
@@ -206,7 +323,7 @@ def _is_ready(self) -> bool:
return ret
@property
- def pid(self) -> Optional[int]:
+ def pid(self) -> int | None:
"""PID of background worker."""
return self._process.pid if self._process else None
@@ -226,7 +343,7 @@ def _stop_cleanly(self) -> bool:
"""
Attempt to stop the server cleanly.
- Sends a SIGINT signal and waits for ``timeout`` seconds.
+ Sends a SIGINT signal and waits for :attr:`timeout` seconds.
:return: True if the server was cleanly stopped, False otherwise.
"""
@@ -249,3 +366,12 @@ def __repr__(self) -> str:
f" {self.probe_at.host}:{self.probe_at.port}>"
)
return f""
+
+ def __enter__(self) -> BackgroundWorker:
+ """Start server in a context manager."""
+ self.start()
+ return self
+
+ def __exit__(self, exc_type: Any, exc_value: Any, traceback: Any) -> None:
+ """Finalise a context manager."""
+ self.stop()
diff --git a/funnel/extapi/boxoffice.py b/funnel/extapi/boxoffice.py
index 1f3300e55..7906b966a 100644
--- a/funnel/extapi/boxoffice.py
+++ b/funnel/extapi/boxoffice.py
@@ -4,9 +4,8 @@
from urllib.parse import urljoin
-from flask import current_app
-
import requests
+from flask import current_app
from ..utils import extract_twitter_handle
diff --git a/funnel/forms/account.py b/funnel/forms/account.py
index d7b495b8c..027368c5d 100644
--- a/funnel/forms/account.py
+++ b/funnel/forms/account.py
@@ -1,13 +1,14 @@
-"""Forms for user account settings."""
+"""Forms for account settings."""
from __future__ import annotations
+from collections.abc import Iterable
from hashlib import sha1
-from typing import Dict, Iterable, Optional
-
-from flask_babel import ngettext
import requests
+from flask import url_for
+from flask_babel import ngettext
+from markupsafe import Markup
from baseframe import _, __, forms
from coaster.utils import sorted_timezones
@@ -16,10 +17,8 @@
MODERATOR_REPORT_TYPE,
PASSWORD_MAX_LENGTH,
PASSWORD_MIN_LENGTH,
+ Account,
Anchor,
- Profile,
- User,
- UserEmailClaim,
check_password_strength,
getuser,
)
@@ -83,13 +82,13 @@ def __call__(self, form, field) -> None:
if form.edit_user.fullname:
user_inputs.append(form.edit_user.fullname)
- for useremail in form.edit_user.emails:
- user_inputs.append(str(useremail))
+ for accountemail in form.edit_user.emails:
+ user_inputs.append(str(accountemail))
for emailclaim in form.edit_user.emailclaims:
user_inputs.append(str(emailclaim))
- for userphone in form.edit_user.phones:
- user_inputs.append(str(userphone))
+ for accountphone in form.edit_user.phones:
+ user_inputs.append(str(accountphone))
tested_password = check_password_strength(
field.data, user_inputs=user_inputs if user_inputs else None
@@ -112,8 +111,7 @@ def __call__(self, form, field) -> None:
def pwned_password_validator(_form, field) -> None:
"""Validate password against the pwned password API."""
- # Add usedforsecurity=False when migrating to Python 3.9+
- phash = sha1(field.data.encode()).hexdigest().upper() # nosec
+ phash = sha1(field.data.encode(), usedforsecurity=False).hexdigest().upper()
prefix, suffix = phash[:5], phash[5:]
try:
@@ -127,7 +125,7 @@ def pwned_password_validator(_form, field) -> None:
# 2. Strip text on either side of the colon
# 3. Ensure the suffix is uppercase
# 4. If count is not a number, default it to 0 (ie, this is not a match)
- matches: Dict[str, int] = {
+ matches: dict[str, int] = {
line_suffix.upper(): int(line_count) if line_count.isdigit() else 0
for line_suffix, line_count in (
(split1.strip(), split2.strip())
@@ -155,12 +153,12 @@ def pwned_password_validator(_form, field) -> None:
)
-@User.forms('password')
+@Account.forms('password')
class PasswordForm(forms.Form):
"""Form to validate a user's password, for password-gated sudo actions."""
__expects__ = ('edit_user',)
- edit_user: User
+ edit_user: Account
password = forms.PasswordField(
__("Password"),
@@ -171,22 +169,22 @@ class PasswordForm(forms.Form):
render_kw={'autocomplete': 'current-password'},
)
- def validate_password(self, field) -> None:
+ def validate_password(self, field: forms.Field) -> None:
"""Check for password match."""
if not self.edit_user.password_is(field.data):
raise forms.validators.ValidationError(_("Incorrect password"))
-@User.forms('password_policy')
+@Account.forms('password_policy')
class PasswordPolicyForm(forms.Form):
"""Form to validate any candidate password against policy."""
__expects__ = ('edit_user',)
__returns__ = ('password_strength', 'is_weak', 'warning', 'suggestions')
- edit_user: User
- password_strength: Optional[int] = None
- is_weak: Optional[bool] = None
- warning: Optional[str] = None
+ edit_user: Account
+ password_strength: int | None = None
+ is_weak: bool | None = None
+ warning: str | None = None
suggestions: Iterable[str] = ()
password = forms.PasswordField(
@@ -197,7 +195,7 @@ class PasswordPolicyForm(forms.Form):
],
)
- def validate_password(self, field) -> None:
+ def validate_password(self, field: forms.Field) -> None:
"""Test password strength and save resuls (no errors raised)."""
user_inputs = []
@@ -205,13 +203,13 @@ def validate_password(self, field) -> None:
if self.edit_user.fullname:
user_inputs.append(self.edit_user.fullname)
- for useremail in self.edit_user.emails:
- user_inputs.append(str(useremail))
+ for accountemail in self.edit_user.emails:
+ user_inputs.append(str(accountemail))
for emailclaim in self.edit_user.emailclaims:
user_inputs.append(str(emailclaim))
- for userphone in self.edit_user.phones:
- user_inputs.append(str(userphone))
+ for accountphone in self.edit_user.phones:
+ user_inputs.append(str(accountphone))
tested_password = check_password_strength(
field.data, user_inputs=user_inputs if user_inputs else None
@@ -222,13 +220,13 @@ def validate_password(self, field) -> None:
self.suggestions = tested_password.suggestions
-@User.forms('password_reset_request')
+@Account.forms('password_reset_request')
class PasswordResetRequestForm(forms.Form):
"""Form to request a password reset."""
__returns__ = ('user', 'anchor')
- user: Optional[User] = None
- anchor: Optional[Anchor] = None
+ user: Account | None = None
+ anchor: Anchor | None = None
username = forms.StringField(
__("Phone number or email address"),
@@ -239,7 +237,7 @@ class PasswordResetRequestForm(forms.Form):
},
)
- def validate_username(self, field) -> None:
+ def validate_username(self, field: forms.Field) -> None:
"""Process username to retrieve user."""
self.user, self.anchor = getuser(field.data, True)
if self.user is None:
@@ -248,14 +246,14 @@ def validate_username(self, field) -> None:
)
-@User.forms('password_create')
+@Account.forms('password_create')
class PasswordCreateForm(forms.Form):
"""Form to accept a new password for a given user, without existing password."""
__returns__ = ('password_strength',)
__expects__ = ('edit_user',)
- edit_user: User
- password_strength: Optional[int] = None
+ edit_user: Account
+ password_strength: int | None = None
password = forms.PasswordField(
__("New password"),
@@ -278,12 +276,12 @@ class PasswordCreateForm(forms.Form):
)
-@User.forms('password_reset')
+@Account.forms('password_reset')
class PasswordResetForm(forms.Form):
"""Form to reset a password for a user, requiring the user id as a failsafe."""
__returns__ = ('password_strength',)
- password_strength: Optional[int] = None
+ password_strength: int | None = None
# TODO: This form has been deprecated with OTP-based reset as that doesn't need
# username and now uses :class:`PasswordCreateForm`. This form is retained in the
@@ -321,7 +319,7 @@ class PasswordResetForm(forms.Form):
render_kw={'autocomplete': 'new-password'},
)
- def validate_username(self, field) -> None:
+ def validate_username(self, field: forms.Field) -> None:
"""Confirm the user provided by the client is who this form is meant for."""
user = getuser(field.data)
if user is None or user != self.edit_user:
@@ -330,14 +328,14 @@ def validate_username(self, field) -> None:
)
-@User.forms('password_change')
+@Account.forms('password_change')
class PasswordChangeForm(forms.Form):
"""Form to change a user's password after confirming the old password."""
__returns__ = ('password_strength',)
__expects__ = ('edit_user',)
- edit_user: User
- password_strength: Optional[int] = None
+ edit_user: Account
+ password_strength: int | None = None
old_password = forms.PasswordField(
__("Current password"),
@@ -367,7 +365,7 @@ class PasswordChangeForm(forms.Form):
render_kw={'autocomplete': 'new-password'},
)
- def validate_old_password(self, field) -> None:
+ def validate_old_password(self, field: forms.Field) -> None:
"""Validate the old password to be correct."""
if self.edit_user is None:
raise forms.validators.ValidationError(_("Not logged in"))
@@ -383,10 +381,7 @@ def raise_username_error(reason: str) -> str:
raise forms.validators.ValidationError(_("This is too long"))
if reason == 'invalid':
raise forms.validators.ValidationError(
- _(
- "Usernames can only have alphabets, numbers and dashes (except at the"
- " ends)"
- )
+ _("Usernames can only have alphabets, numbers and underscores")
)
if reason == 'reserved':
raise forms.validators.ValidationError(_("This username is reserved"))
@@ -395,18 +390,18 @@ def raise_username_error(reason: str) -> str:
raise forms.validators.ValidationError(_("This username is not available"))
-@User.forms('main')
+@Account.forms('main')
class AccountForm(forms.Form):
"""Form to edit basic account details."""
- edit_obj: User
+ edit_obj: Account
fullname = forms.StringField(
__("Full name"),
description=__("This is your name, not of your organization"),
validators=[
forms.validators.DataRequired(),
- forms.validators.Length(max=User.__title_length__),
+ forms.validators.Length(max=Account.__title_length__),
],
filters=[forms.filters.strip()],
render_kw={'autocomplete': 'name'},
@@ -414,12 +409,11 @@ class AccountForm(forms.Form):
username = forms.AnnotatedTextField(
__("Username"),
description=__(
- "Single word that can contain letters, numbers and dashes."
- " You need a username to have a public account page"
+ "A single word that is uniquely yours, for your account page and @mentions"
),
validators=[
forms.validators.DataRequired(),
- forms.validators.Length(max=Profile.__name_length__),
+ forms.validators.Length(max=Account.__name_length__),
],
filters=nullable_strip_filters,
prefix="https://hasgeek.com/",
@@ -446,17 +440,17 @@ class AccountForm(forms.Form):
)
auto_locale = forms.BooleanField(__("Use your device’s language"))
- def validate_username(self, field) -> None:
+ def validate_username(self, field: forms.Field) -> None:
"""Validate if username is appropriately formatted and available to use."""
- reason = self.edit_obj.validate_name_candidate(field.data)
+ reason = self.edit_obj.validate_new_name(field.data)
if not reason:
return # Username is available
raise_username_error(reason)
-@User.forms('delete')
+@Account.forms('delete')
class AccountDeleteForm(forms.Form):
- """Delete user account."""
+ """Delete account."""
confirm1 = forms.BooleanField(
__(
@@ -479,7 +473,7 @@ class UsernameAvailableForm(forms.Form):
"""Form to check for whether a username is available to use."""
__expects__ = ('edit_user',)
- edit_user: User
+ edit_user: Account
username = forms.StringField(
__("Username"),
@@ -491,38 +485,44 @@ class UsernameAvailableForm(forms.Form):
},
)
- def validate_username(self, field) -> None:
+ def validate_username(self, field: forms.Field) -> None:
"""Validate for username being valid and available (with optionally user)."""
if self.edit_user: # User is setting a username
- reason = self.edit_user.validate_name_candidate(field.data)
+ reason = self.edit_user.validate_new_name(field.data)
else: # New user is creating an account, so no user object yet
- reason = Profile.validate_name_candidate(field.data)
+ reason = Account.validate_name_candidate(field.data)
if not reason:
return # Username is available
raise_username_error(reason)
-def validate_emailclaim(form, field):
- """Validate if an email address is already pending verification."""
- existing = UserEmailClaim.get_for(user=form.edit_user, email=field.data)
- if existing is not None:
- raise forms.validators.StopValidation(
- _("This email address is pending verification")
- )
+class EnableNotificationsDescriptionMixin:
+ """Mixin to add a link in the description for enabling notifications."""
+
+ enable_notifications: forms.Field
+
+ def set_queries(self) -> None:
+ """Change the description to include a link."""
+ self.enable_notifications.description = Markup(
+ _(
+ "Unsubscribe anytime, and control what notifications are sent from the"
+ ' Notifications tab under account'
+ ' settings'
+ )
+ ).format(url=url_for('notification_preferences'))
-@User.forms('email_add')
-class NewEmailAddressForm(forms.RecaptchaForm):
- """Form to add a new email address to a user account."""
+@Account.forms('email_add')
+class NewEmailAddressForm(EnableNotificationsDescriptionMixin, forms.RecaptchaForm):
+ """Form to add a new email address to an account."""
__expects__ = ('edit_user',)
- edit_user: User
+ edit_user: Account
email = forms.EmailField(
__("Email address"),
validators=[
forms.validators.DataRequired(),
- validate_emailclaim,
EmailAddressAvailable(purpose='claim'),
],
filters=strip_filters,
@@ -532,19 +532,18 @@ class NewEmailAddressForm(forms.RecaptchaForm):
'autocomplete': 'email',
},
)
- type = forms.RadioField( # noqa: A003
- __("Type"),
- validators=[forms.validators.Optional()],
- filters=[forms.filters.strip()],
- choices=[
- (__("Home"), __("Home")),
- (__("Work"), __("Work")),
- (__("Other"), __("Other")),
- ],
+
+ enable_notifications = forms.BooleanField(
+ __("Send notifications by email"),
+ description=__(
+ "Unsubscribe anytime, and control what notifications are sent from the"
+ " Notifications tab under account settings"
+ ),
+ default=True,
)
-@User.forms('email_primary')
+@Account.forms('email_primary')
class EmailPrimaryForm(forms.Form):
"""Form to mark an email address as a user's primary."""
@@ -560,12 +559,12 @@ class EmailPrimaryForm(forms.Form):
)
-@User.forms('phone_add')
-class NewPhoneForm(forms.RecaptchaForm):
- """Form to add a new mobile number (SMS-capable) to a user account."""
+@Account.forms('phone_add')
+class NewPhoneForm(EnableNotificationsDescriptionMixin, forms.RecaptchaForm):
+ """Form to add a new mobile number (SMS-capable) to an account."""
__expects__ = ('edit_user',)
- edit_user: User
+ edit_user: Account
phone = forms.TelField(
__("Phone number"),
@@ -578,8 +577,10 @@ class NewPhoneForm(forms.RecaptchaForm):
render_kw={'autocomplete': 'tel'},
)
+ # TODO: Consider option "prefer WhatsApp" or "prefer secure messengers (WhatsApp)"
+
enable_notifications = forms.BooleanField(
- __("Send notifications by SMS"),
+ __("Send notifications by SMS"), # TODO: Add "or WhatsApp"
description=__(
"Unsubscribe anytime, and control what notifications are sent from the"
" Notifications tab under account settings"
@@ -588,7 +589,7 @@ class NewPhoneForm(forms.RecaptchaForm):
)
-@User.forms('phone_primary')
+@Account.forms('phone_primary')
class PhonePrimaryForm(forms.Form):
"""Form to mark a phone number as a user's primary."""
diff --git a/funnel/forms/auth_client.py b/funnel/forms/auth_client.py
index 549052c5f..bc2b5db87 100644
--- a/funnel/forms/auth_client.py
+++ b/funnel/forms/auth_client.py
@@ -2,20 +2,16 @@
from __future__ import annotations
-from typing import Optional
from urllib.parse import urlparse
from baseframe import _, __, forms
from coaster.utils import getbool
from ..models import (
+ Account,
AuthClient,
AuthClientCredential,
- AuthClientTeamPermissions,
- AuthClientUserPermissions,
- Organization,
- Team,
- User,
+ AuthClientPermissions,
valid_name,
)
from .helpers import strip_filters
@@ -24,7 +20,6 @@
'AuthClientForm',
'AuthClientCredentialForm',
'AuthClientPermissionEditForm',
- 'TeamPermissionAssignForm',
'UserPermissionAssignForm',
]
@@ -33,9 +28,8 @@
class AuthClientForm(forms.Form):
"""Register a new OAuth client application."""
- __returns__ = ('user', 'organization')
- user: Optional[User] = None
- organization: Optional[Organization] = None
+ __returns__ = ('account',)
+ account: Account | None = None
title = forms.StringField(
__("Application title"),
@@ -52,8 +46,8 @@ class AuthClientForm(forms.Form):
__("Owner"),
validators=[forms.validators.DataRequired()],
description=__(
- "User or organization that owns this application. Changing the owner"
- " will revoke all currently assigned permissions for this app"
+ "Account that owns this application. Changing the owner will revoke all"
+ " currently assigned permissions for this app"
),
)
confidential = forms.RadioField(
@@ -105,11 +99,10 @@ class AuthClientForm(forms.Form):
),
)
- def validate_client_owner(self, field) -> None:
+ def validate_client_owner(self, field: forms.Field) -> None:
"""Validate client's owner to be the current user or an org owned by them."""
if field.data == self.edit_user.buid:
- self.user = self.edit_user
- self.organization = None
+ self.account = self.edit_user
else:
orgs = [
org
@@ -118,8 +111,7 @@ def validate_client_owner(self, field) -> None:
]
if len(orgs) != 1:
raise forms.validators.ValidationError(_("Invalid owner"))
- self.user = None
- self.organization = orgs[0]
+ self.account = orgs[0]
def _urls_match(self, url1: str, url2: str) -> bool:
"""Validate two URLs have the same base component (minus path)."""
@@ -132,7 +124,7 @@ def _urls_match(self, url1: str, url2: str) -> bool:
and (p1.password == p2.password)
)
- def validate_redirect_uri(self, field) -> None:
+ def validate_redirect_uri(self, field: forms.Field) -> None:
"""Validate redirect URI points to the website for confidential clients."""
if self.confidential.data and not self._urls_match(
self.website.data, field.data
@@ -156,7 +148,7 @@ class AuthClientCredentialForm(forms.Form):
)
-def permission_validator(form, field) -> None:
+def permission_validator(form: forms.Form, field: forms.Field) -> None:
"""Validate permission strings to be appropriately named."""
permlist = field.data.split()
for perm in permlist:
@@ -169,7 +161,7 @@ def permission_validator(form, field) -> None:
@AuthClient.forms('permissions_user')
-@AuthClientUserPermissions.forms('assign')
+@AuthClientPermissions.forms('assign')
class UserPermissionAssignForm(forms.Form):
"""Assign permissions to a user."""
@@ -184,35 +176,7 @@ class UserPermissionAssignForm(forms.Form):
)
-@AuthClient.forms('permissions_team')
-@AuthClientTeamPermissions.forms('assign')
-class TeamPermissionAssignForm(forms.Form):
- """Assign permissions to a team."""
-
- __returns__ = ('team',)
- team: Optional[Team] = None
-
- team_id = forms.RadioField(
- __("Team"),
- validators=[forms.validators.DataRequired()],
- description=__("Select a team to assign permissions to"),
- )
- perms = forms.StringField(
- __("Permissions"),
- validators=[forms.validators.DataRequired(), permission_validator],
- )
-
- def validate_team_id(self, field) -> None:
- """Validate selected team to belong to this organization."""
- # FIXME: Replace with QuerySelectField using RadioWidget.
- teams = [team for team in self.organization.teams if team.buid == field.data]
- if len(teams) != 1:
- raise forms.validators.ValidationError(_("Unknown team"))
- self.team = teams[0]
-
-
-@AuthClientUserPermissions.forms('edit')
-@AuthClientTeamPermissions.forms('edit')
+@AuthClientPermissions.forms('edit')
class AuthClientPermissionEditForm(forms.Form):
"""Edit a user or team's permissions."""
diff --git a/funnel/forms/comment.py b/funnel/forms/comment.py
index 3745f2acc..8fcc0f3b2 100644
--- a/funnel/forms/comment.py
+++ b/funnel/forms/comment.py
@@ -15,7 +15,7 @@ class CommentForm(forms.Form):
message = forms.MarkdownField(
"",
- id="comment_message",
+ id='comment_message',
validators=[forms.validators.DataRequired()],
)
diff --git a/funnel/forms/helpers.py b/funnel/forms/helpers.py
index 56fac24b8..1a696c4f2 100644
--- a/funnel/forms/helpers.py
+++ b/funnel/forms/helpers.py
@@ -2,49 +2,63 @@
from __future__ import annotations
-from typing import Optional
+import json
+from collections.abc import Sequence
+from typing import Literal
from flask import flash
-from typing_extensions import Literal
-
from baseframe import _, __, forms
from coaster.auth import current_auth
from .. import app
from ..models import (
+ Account,
+ AccountEmailClaim,
EmailAddress,
PhoneNumber,
- Profile,
- UserEmailClaim,
+ User,
canonical_phone_number,
parse_phone_number,
parse_video_url,
)
+# --- Error messages -------------------------------------------------------------------
+
+MSG_EMAIL_INVALID = _("This does not appear to be a valid email address")
+MSG_EMAIL_BLOCKED = __("This email address has been blocked from use")
+MSG_INCORRECT_PASSWORD = __("Incorrect password")
+MSG_NO_ACCOUNT = __(
+ "This account could not be identified. Try with a phone number or email address"
+)
+MSG_INCORRECT_OTP = __("OTP is incorrect")
+MSG_NO_LOGIN_SESSION = __("That does not appear to be a valid login session")
+MSG_PHONE_NO_SMS = __("This phone number cannot receive SMS messages")
+MSG_PHONE_BLOCKED = __("This phone number has been blocked from use")
+
-class ProfileSelectField(forms.AutocompleteField):
+class AccountSelectField(forms.AutocompleteField):
"""Render an autocomplete field for selecting an account."""
- data: Optional[Profile]
+ data: Account | None # type: ignore[assignment]
widget = forms.Select2Widget()
multiple = False
widget_autocomplete = True
- def _value(self):
+ def _value(self) -> str:
"""Return value for HTML rendering."""
- if self.data:
+ if self.data is not None:
return self.data.name
return ''
- def process_formdata(self, valuelist) -> None:
+ def process_formdata(self, valuelist: Sequence[str]) -> None:
"""Process incoming form data."""
if valuelist:
- self.data = Profile.query.filter(
+ self.data = Account.query.filter(
# Limit to non-suspended (active) accounts. Do not require account to
# be public as well
- Profile.name == valuelist[0],
- Profile.is_active,
+ Account.name_is(valuelist[0]),
+ Account.state.ACTIVE,
).one_or_none()
else:
self.data = None
@@ -67,24 +81,26 @@ def __init__(self, purpose: Literal['use', 'claim', 'register']) -> None:
raise ValueError("Invalid purpose")
self.purpose = purpose
- def __call__(self, form, field) -> None:
- # Get actor (from existing obj, or current_auth.actor)
- actor = None
- if hasattr(form, 'edit_obj'):
- obj = form.edit_obj
- if obj and hasattr(obj, '__email_for__'):
- actor = getattr(obj, obj.__email_for__)
+ def __call__(self, form: forms.Form, field: forms.Field) -> None:
+ # Get actor (from form, or current_auth.actor)
+ actor: User | None = None
+ if hasattr(form, 'edit_user'):
+ actor = form.edit_user
if actor is None:
actor = current_auth.actor
# Call validator
- is_valid = EmailAddress.validate_for(
+ has_error = EmailAddress.validate_for(
actor, field.data, check_dns=True, new=self.purpose != 'use'
)
# Interpret code
- if not is_valid:
+ if has_error == 'taken':
if actor is not None:
+ if self.purpose == 'claim':
+ # Allow a claim on an existing ownership -- if verified, it will
+ # lead to account merger
+ return
raise forms.validators.StopValidation(
_("This email address is linked to another account")
)
@@ -94,11 +110,9 @@ def __call__(self, form, field) -> None:
" logging in or resetting your password"
)
)
- if is_valid in ('invalid', 'nullmx'):
- raise forms.validators.StopValidation(
- _("This does not appear to be a valid email address")
- )
- if is_valid == 'nomx':
+ if has_error in ('invalid', 'nullmx'):
+ raise forms.validators.StopValidation(MSG_EMAIL_INVALID)
+ if has_error == 'nomx':
raise forms.validators.StopValidation(
_(
"The domain name of this email address is missing a DNS MX record."
@@ -106,11 +120,11 @@ def __call__(self, form, field) -> None:
" spam. Please ask your tech person to add MX to DNS"
)
)
- if is_valid == 'not_new':
+ if has_error == 'not_new':
raise forms.validators.StopValidation(
_("You have already registered this email address")
)
- if is_valid == 'soft_fail':
+ if has_error == 'soft_fail':
# XXX: In the absence of support for warnings in WTForms, we can only use
# flash messages to communicate
flash(
@@ -121,26 +135,22 @@ def __call__(self, form, field) -> None:
'warning',
)
return
- if is_valid == 'hard_fail':
+ if has_error == 'hard_fail':
raise forms.validators.StopValidation(
_(
"This email address is no longer valid. If you believe this to be"
" incorrect, email {support} asking for the address to be activated"
).format(support=app.config['SITE_SUPPORT_EMAIL'])
)
- if is_valid == 'blocked':
- raise forms.validators.StopValidation(
- _("This email address has been blocked from use")
- )
- if is_valid is not True:
- app.logger.error( # type: ignore[unreachable]
- "Unknown email address validation code: %r", is_valid
- )
+ if has_error == 'blocked':
+ raise forms.validators.StopValidation(MSG_EMAIL_BLOCKED)
+ if has_error is not None:
+ app.logger.error("Unknown email address validation code: %r", has_error)
- if is_valid and self.purpose == 'register':
+ if has_error is None and self.purpose == 'register':
# One last check: is there an existing claim? If so, stop the user from
# making a dupe account
- if UserEmailClaim.all(email=field.data).notempty():
+ if AccountEmailClaim.all(email=field.data).notempty():
raise forms.validators.StopValidation(
_(
"You or someone else has made an account with this email"
@@ -162,13 +172,11 @@ def __init__(self, purpose: Literal['use', 'claim', 'register']) -> None:
raise ValueError("Invalid purpose")
self.purpose = purpose
- def __call__(self, form, field) -> None:
+ def __call__(self, form: forms.Form, field: forms.Field) -> None:
# Get actor (from existing obj, or current_auth.actor)
- actor = None
- if hasattr(form, 'edit_obj'):
- obj = form.edit_obj
- if obj and hasattr(obj, '__phone_for__'):
- actor = getattr(obj, obj.__phone_for__)
+ actor: User | None = None
+ if hasattr(form, 'edit_user'):
+ actor = form.edit_user
if actor is None:
actor = current_auth.actor
@@ -181,14 +189,21 @@ def __call__(self, form, field) -> None:
raise forms.validators.StopValidation(
_("This does not appear to be a valid phone number")
)
+
+ # Save the parsed number back to the form field
+ field.data = canonical_phone_number(parsed_number)
# Call validator
- is_valid = PhoneNumber.validate_for(
+ has_error = PhoneNumber.validate_for(
actor, parsed_number, new=self.purpose != 'use'
)
# Interpret code
- if not is_valid:
+ if has_error == 'taken':
if actor is not None:
+ if self.purpose == 'claim':
+ # Allow a claim on an existing ownership -- if verified, it will
+ # lead to account merger.
+ return
raise forms.validators.StopValidation(
_("This phone number is linked to another account")
)
@@ -198,41 +213,55 @@ def __call__(self, form, field) -> None:
" logging in or resetting your password"
)
)
- if is_valid == 'invalid':
+ if has_error == 'invalid':
raise forms.validators.StopValidation(
_("This does not appear to be a valid phone number")
)
- if is_valid == 'not_new':
+ if has_error == 'not_new':
raise forms.validators.StopValidation(
_("You have already registered this phone number")
)
- if is_valid == 'blocked':
+ if has_error == 'blocked':
raise forms.validators.StopValidation(
_("This phone number has been blocked from use")
)
- if is_valid is not True:
+ if has_error is not None:
app.logger.error( # type: ignore[unreachable]
- "Unknown phone number validation code: %r", is_valid
+ "Unknown phone number validation code: %r", has_error
)
- field.data = canonical_phone_number(parsed_number)
-def image_url_validator():
+def image_url_validator() -> forms.validators.ValidUrl:
"""Customise ValidUrl for hosted image URL validation."""
return forms.validators.ValidUrl(
allowed_schemes=lambda: app.config.get('IMAGE_URL_SCHEMES', ('https',)),
- allowed_domains=lambda: app.config.get('IMAGE_URL_DOMAINS'),
+ allowed_domains=lambda: app.config.get( # type: ignore[arg-type, return-value]
+ 'IMAGE_URL_DOMAINS'
+ ),
message_schemes=__("A https:// URL is required"),
message_domains=__("Images must be hosted at images.hasgeek.com"),
)
-def video_url_validator(form, field):
+def video_url_list_validator(form: forms.Form, field: forms.Field) -> None:
+ """Validate all video URLs to be acceptable."""
+ for url in field.data:
+ try:
+ parse_video_url(url)
+ except ValueError:
+ raise forms.validators.StopValidation(
+ _("This video URL is not supported")
+ ) from None
+
+
+def video_url_validator(form: forms.Form, field: forms.Field) -> None:
"""Validate the video URL to be acceptable."""
try:
parse_video_url(field.data)
- except ValueError as exc:
- raise forms.validators.StopValidation(str(exc))
+ except ValueError:
+ raise forms.validators.StopValidation(
+ _("This video URL is not supported")
+ ) from None
def tostr(value: object) -> str:
@@ -242,5 +271,27 @@ def tostr(value: object) -> str:
return ''
+def format_json(data: dict | str | None) -> str:
+ """Return a dict as a formatted JSON string, and return a string unchanged."""
+ if data:
+ if isinstance(data, str):
+ return data
+ return json.dumps(data, indent=2, sort_keys=True)
+ return ''
+
+
+def validate_and_convert_json(form: forms.Form, field: forms.Field) -> None:
+ """Confirm form data is valid JSON, and store it back as a parsed dict."""
+ try:
+ field.data = json.loads(field.data)
+ except ValueError:
+ raise forms.validators.StopValidation(_("Invalid JSON")) from None
+
+
strip_filters = [tostr, forms.filters.strip()]
nullable_strip_filters = [tostr, forms.filters.strip(), forms.filters.none_if_empty()]
+nullable_json_filters = [
+ format_json,
+ forms.filters.strip(),
+ forms.filters.none_if_empty(),
+]
diff --git a/funnel/forms/login.py b/funnel/forms/login.py
index c518df1de..a4111157d 100644
--- a/funnel/forms/login.py
+++ b/funnel/forms/login.py
@@ -2,25 +2,36 @@
from __future__ import annotations
-from typing import TYPE_CHECKING, Optional, Union
+from typing import TYPE_CHECKING
-from baseframe import __, forms
+from baseframe import _, __, forms
from ..models import (
PASSWORD_MAX_LENGTH,
+ Account,
+ AccountEmail,
+ AccountEmailClaim,
+ AccountPhone,
EmailAddress,
EmailAddressBlockedError,
+ LoginSession,
PhoneNumber,
PhoneNumberBlockedError,
User,
- UserEmail,
- UserEmailClaim,
- UserPhone,
- UserSession,
check_password_strength,
getuser,
parse_phone_number,
)
+from .helpers import (
+ MSG_EMAIL_BLOCKED,
+ MSG_EMAIL_INVALID,
+ MSG_INCORRECT_OTP,
+ MSG_INCORRECT_PASSWORD,
+ MSG_NO_ACCOUNT,
+ MSG_NO_LOGIN_SESSION,
+ MSG_PHONE_BLOCKED,
+ MSG_PHONE_NO_SMS,
+)
__all__ = [
'LoginPasswordResetException',
@@ -30,20 +41,10 @@
'LogoutForm',
'RegisterWithOtp',
'OtpForm',
+ 'EmailOtpForm',
'RegisterOtpForm',
]
-# --- Error messages -------------------------------------------------------------------
-
-MSG_EMAIL_BLOCKED = __("This email address has been blocked from use")
-MSG_INCORRECT_PASSWORD = __("Incorrect password")
-MSG_NO_ACCOUNT = __(
- "This account could not be identified. Try with a phone number or email address"
-)
-MSG_INCORRECT_OTP = __("OTP is incorrect")
-MSG_NO_LOGIN_SESSION = __("That does not appear to be a valid login session")
-MSG_PHONE_NO_SMS = __("This phone number cannot receive SMS messages")
-MSG_PHONE_BLOCKED = __("This phone number has been blocked from use")
# --- Exceptions -----------------------------------------------------------------------
@@ -61,11 +62,12 @@ class LoginWithOtp(Exception): # noqa: N818
class RegisterWithOtp(Exception): # noqa: N818
- """Exception to signal for new user account registration after OTP validation."""
+ """Exception to signal for new account registration after OTP validation."""
# --- Validators -----------------------------------------------------------------------
+
# Validator specifically for LoginForm
class PasswordlessLoginIntercept:
"""Allow password to be optional if an anchor (phone, email) is available."""
@@ -93,7 +95,7 @@ def __call__(self, form, field) -> None:
# --- Forms ----------------------------------------------------------------------------
-@User.forms('login')
+@Account.forms('login')
class LoginForm(forms.RecaptchaForm):
"""
Form for login and registration.
@@ -120,11 +122,11 @@ class LoginForm(forms.RecaptchaForm):
"""
__returns__ = ('user', 'anchor', 'weak_password', 'new_email', 'new_phone')
- user: Optional[User] = None
- anchor: Optional[Union[UserEmail, UserEmailClaim, UserPhone]] = None
- weak_password: Optional[bool] = None
- new_email: Optional[str] = None
- new_phone: Optional[str] = None
+ user: Account | None = None
+ anchor: AccountEmail | AccountEmailClaim | AccountPhone | None = None
+ weak_password: bool | None = None
+ new_email: str | None = None
+ new_phone: str | None = None
username = forms.StringField(
__("Phone number or email address"),
@@ -154,7 +156,7 @@ class LoginForm(forms.RecaptchaForm):
)
# These two validators depend on being called in sequence
- def validate_username(self, field) -> None:
+ def validate_username(self, field: forms.Field) -> None:
"""Process username field and load user and anchor."""
self.user, self.anchor = getuser(field.data, True) # skipcq: PYL-W0201
self.new_email = self.new_phone = None
@@ -171,6 +173,8 @@ def validate_username(self, field) -> None:
self.new_email = str(email_address)
except EmailAddressBlockedError as exc:
raise forms.validators.ValidationError(MSG_EMAIL_BLOCKED) from exc
+ except ValueError as exc:
+ raise forms.validators.StopValidation(MSG_EMAIL_INVALID) from exc
return
phone = parse_phone_number(field.data, sms=True)
if phone is False:
@@ -187,7 +191,7 @@ def validate_username(self, field) -> None:
# Not a known user and not a valid email address or phone number -> error
raise forms.validators.ValidationError(MSG_NO_ACCOUNT)
- def validate_password(self, field) -> None:
+ def validate_password(self, field: forms.Field) -> None:
"""Validate password if provided."""
# If there is already an error in the password field, don't bother validating.
# This will be a `Length` validation error, but that one unfortunately does not
@@ -243,14 +247,14 @@ def validate_password(self, field) -> None:
self.weak_password: bool = check_password_strength(field.data).is_weak
-@User.forms('logout')
+@Account.forms('logout')
class LogoutForm(forms.Form):
"""Process a logout request."""
__expects__ = ('user',)
- __returns__ = ('user_session',)
- user: User
- user_session: Optional[UserSession] = None
+ __returns__ = ('login_session',)
+ user: Account
+ login_session: LoginSession | None = None
# We use `StringField`` even though the field is not visible. This does not use
# `HiddenField`, because that gets rendered with `hidden_tag`, and not `SubmitField`
@@ -259,12 +263,12 @@ class LogoutForm(forms.Form):
__("Session id"), validators=[forms.validators.Optional()]
)
- def validate_sessionid(self, field) -> None:
+ def validate_sessionid(self, field: forms.Field) -> None:
"""Validate login session belongs to the user who invoked this form."""
- user_session = UserSession.get(buid=field.data)
- if not user_session or user_session.user != self.user:
+ login_session = LoginSession.get(buid=field.data)
+ if not login_session or login_session.account != self.user:
raise forms.validators.ValidationError(MSG_NO_LOGIN_SESSION)
- self.user_session = user_session
+ self.login_session = login_session
class OtpForm(forms.Form):
@@ -286,12 +290,20 @@ class OtpForm(forms.Form):
},
)
- def validate_otp(self, field) -> None:
+ def validate_otp(self, field: forms.Field) -> None:
"""Confirm OTP is as expected."""
if field.data != self.valid_otp:
raise forms.validators.StopValidation(MSG_INCORRECT_OTP)
+class EmailOtpForm(OtpForm):
+ """Verify an OTP sent to email."""
+
+ def set_queries(self) -> None:
+ super().set_queries()
+ self.otp.description = _("One-time password sent to your email address")
+
+
class RegisterOtpForm(forms.Form):
"""Verify an OTP and register an account."""
@@ -322,7 +334,7 @@ class RegisterOtpForm(forms.Form):
},
)
- def validate_otp(self, field) -> None:
+ def validate_otp(self, field: forms.Field) -> None:
"""Confirm OTP is as expected."""
if field.data != self.valid_otp:
raise forms.validators.StopValidation(MSG_INCORRECT_OTP)
diff --git a/funnel/forms/membership.py b/funnel/forms/membership.py
index a6c8af94f..7acd78465 100644
--- a/funnel/forms/membership.py
+++ b/funnel/forms/membership.py
@@ -5,7 +5,8 @@
from baseframe import _, __, forms
from coaster.utils import getbool
-from ..models import OrganizationMembership, ProjectCrewMembership
+from ..models import AccountMembership, ProjectMembership
+from .helpers import nullable_strip_filters
__all__ = [
'OrganizationMembershipForm',
@@ -14,7 +15,7 @@
]
-@OrganizationMembership.forms('main')
+@AccountMembership.forms('main')
class OrganizationMembershipForm(forms.Form):
"""Form to add a member to an organization (admin or owner)."""
@@ -37,7 +38,7 @@ class OrganizationMembershipForm(forms.Form):
)
-@ProjectCrewMembership.forms('main')
+@ProjectMembership.forms('main')
class ProjectCrewMembershipForm(forms.Form):
"""Form to add a project crew member."""
@@ -65,17 +66,22 @@ class ProjectCrewMembershipForm(forms.Form):
"Can check-in a participant using their badge at a physical event"
),
)
+ label = forms.StringField(
+ __("Role"),
+ description=__("Optional – Name this person’s role"),
+ filters=nullable_strip_filters,
+ )
- def validate(self, *args, **kwargs):
+ def validate(self, *args, **kwargs) -> bool:
"""Validate form."""
is_valid = super().validate(*args, **kwargs)
if not any([self.is_editor.data, self.is_promoter.data, self.is_usher.data]):
- self.is_usher.errors.append("Please select one or more roles")
+ self.is_usher.errors.append(_("Select one or more roles"))
is_valid = False
return is_valid
-@ProjectCrewMembership.forms('invite')
+@ProjectMembership.forms('invite')
class ProjectCrewMembershipInviteForm(forms.Form):
"""Form to invite a user to be a project crew member."""
diff --git a/funnel/forms/notification.py b/funnel/forms/notification.py
index bd68e6ece..bc8342fde 100644
--- a/funnel/forms/notification.py
+++ b/funnel/forms/notification.py
@@ -2,14 +2,15 @@
from __future__ import annotations
+from collections.abc import Callable
from dataclasses import dataclass
-from typing import Callable, List, Optional
-from flask import Markup, url_for
+from flask import url_for
+from markupsafe import Markup
from baseframe import __, forms
-from ..models import User, notification_type_registry
+from ..models import Account, notification_type_registry
from ..transports import platform_transports
__all__ = [
@@ -25,7 +26,7 @@ class TransportLabels:
title: str
requirement: str
- requirement_action: Callable[[], Optional[str]]
+ requirement_action: Callable[[], str | None]
unsubscribe_form: str
unsubscribe_description: str
switch: str
@@ -115,12 +116,12 @@ class TransportLabels:
}
-@User.forms('unsubscribe')
+@Account.forms('unsubscribe')
class UnsubscribeForm(forms.Form):
"""Form to unsubscribe from notifications."""
__expects__ = ('transport', 'notification_type')
- edit_obj: User
+ edit_obj: Account
transport: str
notification_type: str
@@ -180,7 +181,7 @@ def get_main(self, obj) -> bool:
"""Get main preferences switch (global enable/disable)."""
return obj.main_notification_preferences.by_transport(self.transport)
- def get_types(self, obj) -> List[str]:
+ def get_types(self, obj) -> list[str]:
"""Get status for each notification type for the selected transport."""
# Populate data with all notification types for which the user has the
# current transport enabled
@@ -206,7 +207,7 @@ def set_types(self, obj) -> None:
)
-@User.forms('set_notification_preference')
+@Account.forms('set_notification_preference')
class SetNotificationPreferenceForm(forms.Form):
"""Set one notification preference."""
diff --git a/funnel/forms/organization.py b/funnel/forms/organization.py
index 01a74b5f5..077b96454 100644
--- a/funnel/forms/organization.py
+++ b/funnel/forms/organization.py
@@ -2,24 +2,25 @@
from __future__ import annotations
-from typing import Iterable, Optional
+from collections.abc import Iterable
-from flask import Markup, url_for
+from flask import url_for
+from markupsafe import Markup
from baseframe import _, __, forms
-from ..models import Organization, Profile, Team, User
+from ..models import Account, Team
__all__ = ['OrganizationForm', 'TeamForm']
-@Organization.forms('main')
+@Account.forms('org')
class OrganizationForm(forms.Form):
"""Form for an organization's name and title."""
- __expects__: Iterable[str] = ('user',)
- user: User
- edit_obj: Optional[Organization]
+ __expects__: Iterable[str] = ('edit_user',)
+ edit_user: Account
+ edit_obj: Account | None
title = forms.StringField(
__("Organization name"),
@@ -28,7 +29,7 @@ class OrganizationForm(forms.Form):
),
validators=[
forms.validators.DataRequired(),
- forms.validators.Length(max=Organization.__title_length__),
+ forms.validators.Length(max=Account.__title_length__),
],
filters=[forms.filters.strip()],
render_kw={'autocomplete': 'organization'},
@@ -36,40 +37,42 @@ class OrganizationForm(forms.Form):
name = forms.AnnotatedTextField(
__("Username"),
description=__(
- "A short name for your organization’s account page."
- " Single word containing letters, numbers and dashes only."
- " Pick something permanent: changing it will break existing links from"
- " around the web"
+ "A unique word for your organization’s account page. Alphabets, numbers and"
+ " underscores are okay. Pick something permanent: changing it will break"
+ " links"
),
validators=[
forms.validators.DataRequired(),
- forms.validators.Length(max=Profile.__name_length__),
+ forms.validators.Length(max=Account.__name_length__),
],
filters=[forms.filters.strip()],
prefix="https://hasgeek.com/",
render_kw={'autocorrect': 'off', 'autocapitalize': 'off'},
)
- def validate_name(self, field) -> None:
+ def validate_name(self, field: forms.Field) -> None:
"""Validate name is valid and available for this organization."""
- reason = Profile.validate_name_candidate(field.data)
+ reason = Account.validate_name_candidate(field.data)
if not reason:
return # name is available
if reason == 'invalid':
raise forms.validators.ValidationError(
- _(
- "Names can only have letters, numbers and dashes (except at the"
- " ends)"
- )
+ _("Names can only have alphabets, numbers and underscores")
)
if reason == 'reserved':
raise forms.validators.ValidationError(_("This name is reserved"))
- if self.edit_obj and field.data.lower() == self.edit_obj.name.lower():
- # Name is not reserved or invalid under current rules. It's also not changed
- # from existing name, or has only changed case. This is a validation pass.
+ if (
+ self.edit_obj
+ and self.edit_obj.name
+ and field.data.lower() == self.edit_obj.name.lower()
+ ):
+ # Name has only changed case from previous name. This is a validation pass
return
if reason == 'user':
- if self.user.username and field.data.lower() == self.user.username.lower():
+ if (
+ self.edit_user.username
+ and field.data.lower() == self.edit_user.username.lower()
+ ):
raise forms.validators.ValidationError(
Markup(
_(
diff --git a/funnel/forms/profile.py b/funnel/forms/profile.py
index b49e0f055..8236caf2a 100644
--- a/funnel/forms/profile.py
+++ b/funnel/forms/profile.py
@@ -4,7 +4,7 @@
from baseframe import __, forms
-from ..models import Profile, User
+from ..models import Account
from .helpers import image_url_validator, nullable_strip_filters
from .organization import OrganizationForm
@@ -16,17 +16,16 @@
]
-@Profile.forms('main')
+@Account.forms('profile')
class ProfileForm(OrganizationForm):
"""
Edit a profile.
- A `profile` keyword argument is necessary for the ImgeeField.
+ An `account` keyword argument is necessary for the ImgeeField.
"""
- __expects__ = ('profile', 'user')
- profile: Profile
- user: User
+ __expects__ = ('account', 'edit_user')
+ account: Account
tagline = forms.StringField(
__("Bio"),
@@ -61,9 +60,9 @@ class ProfileForm(OrganizationForm):
def set_queries(self) -> None:
"""Prepare form for use."""
- self.logo_url.profile = self.profile.name
+ self.logo_url.profile = self.account.name or self.account.buid
- def make_for_user(self):
+ def make_for_user(self) -> None:
"""Customise form for a user account."""
self.title.label.text = __("Your name")
self.title.description = __(
@@ -71,10 +70,8 @@ def make_for_user(self):
)
self.tagline.description = __("A brief statement about yourself")
self.name.description = __(
- "A short name for mentioning you with @username, and the URL to your"
- " account’s page. Single word containing letters, numbers and dashes only."
- " Pick something permanent: changing it will break existing links from"
- " around the web"
+ "A single word that is uniquely yours, for your account page and @mentions."
+ " Pick something permanent: changing it will break existing links"
)
self.description.label.text = __("More about you")
self.description.description = __(
@@ -82,11 +79,11 @@ def make_for_user(self):
)
-@Profile.forms('transition')
+@Account.forms('transition')
class ProfileTransitionForm(forms.Form):
"""Form to transition an account between public and private state."""
- edit_obj: Profile
+ edit_obj: Account
transition = forms.SelectField(
__("Account visibility"), validators=[forms.validators.DataRequired()]
@@ -97,16 +94,16 @@ def set_queries(self) -> None:
self.transition.choices = list(self.edit_obj.state.transitions().items())
-@Profile.forms('logo')
+@Account.forms('logo')
class ProfileLogoForm(forms.Form):
"""
Form for profile logo.
- A `profile` keyword argument is necessary for the ImgeeField.
+ An `account` keyword argument is necessary for the ImgeeField.
"""
- __expects__ = ('profile',)
- profile: Profile
+ __expects__ = ('account',)
+ account: Account
logo_url = forms.ImgeeField(
__("Account image"),
@@ -121,19 +118,19 @@ class ProfileLogoForm(forms.Form):
def set_queries(self) -> None:
"""Prepare form for use."""
self.logo_url.widget_type = 'modal'
- self.logo_url.profile = self.profile.name
+ self.logo_url.profile = self.account.name or self.account.buid
-@Profile.forms('banner_image')
+@Account.forms('banner_image')
class ProfileBannerForm(forms.Form):
"""
Form for profile banner.
- A `profile` keyword argument is necessary for the ImgeeField.
+ An `account` keyword argument is necessary for the ImgeeField.
"""
- __expects__ = ('profile',)
- profile: Profile
+ __expects__ = ('account',)
+ account: Account
banner_image_url = forms.ImgeeField(
__("Banner image"),
@@ -148,4 +145,4 @@ class ProfileBannerForm(forms.Form):
def set_queries(self) -> None:
"""Prepare form for use."""
self.banner_image_url.widget_type = 'modal'
- self.banner_image_url.profile = self.profile.name
+ self.banner_image_url.profile = self.account.name or self.account.buid
diff --git a/funnel/forms/project.py b/funnel/forms/project.py
index 298ee6414..546bd969a 100644
--- a/funnel/forms/project.py
+++ b/funnel/forms/project.py
@@ -2,15 +2,21 @@
from __future__ import annotations
-from typing import Optional
import re
from baseframe import _, __, forms
from baseframe.forms.sqlalchemy import AvailableName
from coaster.utils import sorted_timezones, utcnow
-from ..models import Profile, Project, Rsvp, SavedProject
-from .helpers import ProfileSelectField, image_url_validator, nullable_strip_filters
+from ..models import Account, Project, Rsvp, SavedProject
+from .helpers import (
+ AccountSelectField,
+ image_url_validator,
+ nullable_json_filters,
+ nullable_strip_filters,
+ validate_and_convert_json,
+ video_url_list_validator,
+)
__all__ = [
'CfpForm',
@@ -24,6 +30,7 @@
'ProjectSponsorForm',
'RsvpTransitionForm',
'SavedProjectForm',
+ 'ProjectRegisterForm',
]
double_quote_re = re.compile(r'["“”]')
@@ -34,12 +41,12 @@ class ProjectForm(forms.Form):
"""
Form to create or edit a project.
- A `profile` keyword argument is necessary for the ImgeeField.
+ An `account` keyword argument is necessary for the ImgeeField.
"""
- __expects__ = ('profile',)
- profile: Profile
- edit_obj: Optional[Project]
+ __expects__ = ('account',)
+ account: Account
+ edit_obj: Project | None
title = forms.StringField(
__("Title"),
@@ -111,7 +118,7 @@ class ProjectForm(forms.Form):
description=__("Landing page contents"),
)
- def validate_location(self, field) -> None:
+ def validate_location(self, field: forms.Field) -> None:
"""Validate location field to not have quotes (from copy paste of hint)."""
if re.search(double_quote_re, field.data) is not None:
raise forms.validators.ValidationError(
@@ -119,7 +126,7 @@ def validate_location(self, field) -> None:
)
def set_queries(self) -> None:
- self.bg_image.profile = self.profile.name
+ self.bg_image.profile = self.account.name or self.account.buid
if self.edit_obj is not None and self.edit_obj.schedule_start_at:
# Don't allow user to directly manipulate timestamps when it's done via
# Session objects
@@ -165,14 +172,19 @@ class ProjectLivestreamForm(forms.Form):
),
]
),
+ video_url_list_validator,
],
)
+ is_restricted_video = forms.BooleanField(
+ __("Restrict livestream to participants only")
+ )
+
class ProjectNameForm(forms.Form):
"""Form to change the URL name of a project."""
- # TODO: Add validators for `profile` and unique name here instead of delegating to
+ # TODO: Add validators for `account` and unique name here instead of delegating to
# the view. Also add `set_queries` method to change ``name.prefix``
name = forms.AnnotatedTextField(
@@ -203,11 +215,11 @@ class ProjectBannerForm(forms.Form):
"""
Form for project banner.
- A `profile` keyword argument is necessary for the ImgeeField.
+ An `account` keyword argument is necessary for the ImgeeField.
"""
- __expects__ = ('profile',)
- profile: Profile
+ __expects__ = ('account',)
+ account: Account
bg_image = forms.ImgeeField(
__("Banner image"),
@@ -222,7 +234,7 @@ class ProjectBannerForm(forms.Form):
def set_queries(self) -> None:
"""Prepare form for use."""
self.bg_image.widget_type = 'modal'
- self.bg_image.profile = self.profile.name
+ self.bg_image.profile = self.account.name or self.account.buid
@Project.forms('cfp')
@@ -245,7 +257,7 @@ class CfpForm(forms.Form):
naive=False,
)
- def validate_cfp_end_at(self, field) -> None:
+ def validate_cfp_end_at(self, field: forms.Field) -> None:
"""Validate closing date to be in the future."""
if field.data <= utcnow():
raise forms.validators.StopValidation(
@@ -295,7 +307,7 @@ def set_open(self, obj: Project) -> None:
class ProjectSponsorForm(forms.Form):
"""Form to add or edit a sponsor on a project."""
- profile = ProfileSelectField(
+ member = AccountSelectField(
__("Account"),
autocomplete_endpoint='/api/1/profile/autocomplete',
results_key='profile',
@@ -343,3 +355,33 @@ def set_queries(self) -> None:
(transition_name, getattr(Rsvp, transition_name))
for transition_name in Rsvp.state.statemanager.transitions
]
+
+
+@Project.forms('rsvp')
+class ProjectRegisterForm(forms.Form):
+ """Register for a project with an optional custom JSON form."""
+
+ __expects__ = ('schema',)
+ schema: dict | None
+
+ form = forms.TextAreaField(
+ __("Form"),
+ filters=nullable_json_filters,
+ validators=[validate_and_convert_json],
+ )
+
+ def validate_form(self, field: forms.Field) -> None:
+ if self.form.data and not self.schema:
+ raise forms.validators.StopValidation(
+ _("This registration is not expecting any form fields")
+ )
+ if self.schema:
+ form_keys = set(self.form.data.keys())
+ schema_keys = {i['name'] for i in self.schema['fields']}
+ if not form_keys.issubset(schema_keys):
+ invalid_keys = form_keys.difference(schema_keys)
+ raise forms.validators.StopValidation(
+ _("The form is not expecting these fields: {fields}").format(
+ fields=', '.join(invalid_keys)
+ )
+ )
diff --git a/funnel/forms/proposal.py b/funnel/forms/proposal.py
index b1ec67a28..a7e677ff5 100644
--- a/funnel/forms/proposal.py
+++ b/funnel/forms/proposal.py
@@ -2,12 +2,10 @@
from __future__ import annotations
-from typing import Optional
-
from baseframe import _, __, forms
from baseframe.forms.sqlalchemy import QuerySelectField
-from ..models import Project, Proposal, User
+from ..models import Account, Project, Proposal
from .helpers import nullable_strip_filters, video_url_validator
__all__ = [
@@ -29,8 +27,8 @@
def proposal_label_form(
- project: Project, proposal: Optional[Proposal]
-) -> Optional[forms.Form]:
+ project: Project, proposal: Proposal | None
+) -> forms.Form | None:
"""Return a label form for the given project and proposal."""
if not project.labels:
return None
@@ -68,9 +66,10 @@ class ProposalLabelForm(forms.Form):
def proposal_label_admin_form(
- project: Project, proposal: Optional[Proposal]
-) -> Optional[forms.Form]:
+ project: Project, proposal: Proposal | None
+) -> forms.Form | None:
"""Return a label form to use in admin panel for given project and proposal."""
+
# FIXME: See above
class ProposalLabelAdminForm(forms.Form):
"""Forms for editor-selectable labels on a proposal."""
@@ -159,7 +158,9 @@ class ProposalForm(forms.Form):
filters=[forms.filters.strip()],
)
body = forms.MarkdownField(
- __("Content"), validators=[forms.validators.DataRequired()]
+ __("Content"),
+ validators=[forms.validators.DataRequired()],
+ render_kw={'class': 'no-codemirror'},
)
video_url = forms.URLField(
__("Video"),
@@ -203,14 +204,14 @@ class ProposalMemberForm(forms.Form):
description=__(
"Optional – A specific role in this submission (like Author or Editor)"
),
- filters=[forms.filters.strip()],
+ filters=nullable_strip_filters,
)
is_uncredited = forms.BooleanField(__("Hide collaborator on submission"))
- def validate_user(self, field) -> None:
+ def validate_user(self, field: forms.Field) -> None:
"""Validate user field to confirm user is not an existing collaborator."""
for membership in self.proposal.memberships:
- if membership.user == field.data:
+ if membership.member == field.data:
raise forms.validators.StopValidation(
_("{user} is already a collaborator").format(
user=field.data.pickername
@@ -241,7 +242,7 @@ class ProposalMoveForm(forms.Form):
"""Form to move a proposal to another project."""
__expects__ = ('user',)
- user: User
+ user: Account
target = QuerySelectField(
__("Move proposal to"),
diff --git a/funnel/forms/session.py b/funnel/forms/session.py
index 0b537dd11..2bec70d1e 100644
--- a/funnel/forms/session.py
+++ b/funnel/forms/session.py
@@ -54,7 +54,7 @@ class SessionForm(forms.Form):
)
video_url = forms.URLField(
__("Video URL"),
- description=__("URL of the uploaded video after the session is over"),
+ description=__("URL of the session’s video (YouTube or Vimeo)"),
validators=[
forms.validators.Optional(),
forms.validators.URL(),
@@ -63,6 +63,9 @@ class SessionForm(forms.Form):
],
filters=nullable_strip_filters,
)
+ is_restricted_video = forms.BooleanField(
+ __("Restrict video to participants"), default=False
+ )
@SavedSession.forms('main')
diff --git a/funnel/forms/sync_ticket.py b/funnel/forms/sync_ticket.py
index f006dacde..1682820a5 100644
--- a/funnel/forms/sync_ticket.py
+++ b/funnel/forms/sync_ticket.py
@@ -2,21 +2,25 @@
from __future__ import annotations
-from typing import Optional
+import json
+
+from markupsafe import Markup
from baseframe import __, forms
from ..models import (
+ Account,
+ AccountEmail,
Project,
TicketClient,
TicketEvent,
TicketParticipant,
- User,
- UserEmail,
db,
)
+from .helpers import nullable_json_filters, validate_and_convert_json
__all__ = [
+ 'FORM_SCHEMA_PLACEHOLDER',
'ProjectBoxofficeForm',
'TicketClientForm',
'TicketEventForm',
@@ -25,8 +29,31 @@
'TicketTypeForm',
]
+
BOXOFFICE_DETAILS_PLACEHOLDER = {'org': 'hasgeek', 'item_collection_id': ''}
+FORM_SCHEMA_PLACEHOLDER = {
+ 'fields': [
+ {
+ 'name': 'field_name',
+ 'title': "Field label shown to user",
+ 'description': "An explanation for this field",
+ 'type': "string",
+ },
+ {
+ 'name': 'has_checked',
+ 'title': "I accept the terms",
+ 'type': 'boolean',
+ },
+ {
+ 'name': 'choice',
+ 'title': "Choose one",
+ 'type': 'select',
+ 'choices': ["First choice", "Second choice", "Third choice"],
+ },
+ ]
+}
+
@Project.forms('boxoffice')
class ProjectBoxofficeForm(forms.Form):
@@ -42,11 +69,38 @@ class ProjectBoxofficeForm(forms.Form):
filters=[forms.filters.strip()],
)
allow_rsvp = forms.BooleanField(
- __("Allow rsvp"),
+ __("Allow free registrations"),
+ default=False,
+ )
+ is_subscription = forms.BooleanField(
+ __("Paid tickets are for a subscription"),
+ default=True,
+ )
+ has_membership = forms.BooleanField(
+ __("Tickets on this project represent memberships to the account"),
default=False,
- description=__("If checked, both free and buy tickets will shown on project"),
+ )
+ register_button_txt = forms.StringField(
+ __("Register button text"),
+ filters=[forms.filters.strip()],
+ description=__("Optional – Use with care to replace the button text"),
+ )
+ register_form_schema = forms.StylesheetField(
+ __("Registration form"),
+ description=__("Optional – Specify fields as JSON (limited support)"),
+ filters=nullable_json_filters,
+ validators=[forms.validators.Optional(), validate_and_convert_json],
)
+ def set_queries(self):
+ """Set form schema description."""
+ self.register_form_schema.description = Markup(
+ '()``.
+
+ ..note::
+ Because this method does not accept a context, it may return True for a
+ transport that has been muted in that context. This may cause an empty
+ background job to be queued for a notification. Revisit this method when
+ preference contexts are supported.
+ """
+ return getattr(self, 'has_transport_' + transport)()
+
+ @with_roles(call={'owner'})
+ def transport_for(
+ self, transport: str, context: Model | None = None
+ ) -> AccountEmail | AccountPhone | None:
+ """
+ Get transport address for a given transport and context.
+
+ Helper method to call ``self.transport_for_(context)``.
+ """
+ return getattr(self, 'transport_for_' + transport)(context)
+
+ def default_email(
+ self, context: Model | None = None
+ ) -> AccountEmail | AccountEmailClaim | None:
+ """
+ Return default email address (verified if present, else unverified).
+
+ ..note::
+ This is a temporary helper method, pending merger of
+ :class:`AccountEmailClaim` into :class:`AccountEmail` with
+ :attr:`~AccountEmail.verified` ``== False``. The appropriate replacement is
+ :meth:`Account.transport_for_email` with a context.
+ """
+ email = self.transport_for_email(context=context)
+ if email:
+ return email
+ # Fallback when ``transport_for_email`` returns None
+ if self.email:
+ return self.email
+ if self.emailclaims:
+ return self.emailclaims[0]
+ # This user has no email addresses
+ return None
+
+ @property
+ def _self_is_owner_and_admin_of_self(self) -> Account:
+ """
+ Return self.
+
+ Helper method for :meth:`roles_for` and :meth:`actors_with` to assert that the
+ user is owner and admin of their own account.
+ """
+ return self
+
+ with_roles(_self_is_owner_and_admin_of_self, grants={'owner', 'admin'})
+
+ def organizations_as_owner_ids(self) -> list[int]:
+ """
+ Return the database ids of the organizations this user is an owner of.
+
+ This is used for database queries.
+ """
+ return [
+ membership.account_id
+ for membership in self.active_organization_owner_memberships
+ ]
+
+ @state.transition(state.ACTIVE, state.MERGED)
+ def mark_merged_into(self, other_account):
+ """Mark account as merged into another account."""
+ db.session.add(AccountOldId(id=self.uuid, account=other_account))
+
+ @state.transition(state.ACTIVE, state.SUSPENDED)
+ def mark_suspended(self):
+ """Mark account as suspended on support or moderator request."""
+
+ @state.transition(state.SUSPENDED, state.ACTIVE)
+ def mark_active(self):
+ """Restore a suspended account to active state."""
+
+ @state.transition(state.ACTIVE, state.DELETED)
+ def do_delete(self):
+ """Delete account."""
+ # 0: Safety check
+ if not self.is_safe_to_delete():
+ raise ValueError("Account cannot be deleted")
+
+ # 1. Delete contact information
+ for contact_source in (
+ self.emails,
+ self.emailclaims,
+ self.phones,
+ self.externalids,
+ ):
+ for contact in contact_source:
+ db.session.delete(contact)
+
+ # 2. Revoke all active memberships
+ for membership in self.active_memberships():
+ membership = membership.freeze_member_attribution(self)
+ if membership.revoke_on_member_delete:
+ membership.revoke(actor=self)
+ # TODO: freeze fullname in unrevoked memberships (pending title column there)
+ if (
+ self.active_site_membership
+ and self.active_site_membership.revoke_on_member_delete
+ ):
+ self.active_site_membership.revoke(actor=self)
+
+ # 3. Drop all team memberships
+ self.member_teams.clear()
+
+ # 4. Revoke auth tokens
+ self.revoke_all_auth_tokens() # Defined in auth_client.py
+ self.revoke_all_auth_client_permissions() # Same place
+
+ # 5. Revoke all active login sessions
+ for login_session in self.active_login_sessions:
+ login_session.revoke()
+
+ # 6. Clear name (username), title (fullname) and stored password hash
+ self.name = None
+ self.title = ''
+ self.password = None
+
+ # 7. Unassign tickets assigned to the user
+ self.ticket_participants = [] # pylint: disable=attribute-defined-outside-init
+
+ @with_roles(call={'owner'})
+ @profile_state.transition(
+ profile_state.NOT_PUBLIC,
+ profile_state.PUBLIC,
+ title=__("Make public"),
+ )
+ @state.requires(state.ACTIVE)
+ def make_profile_public(self) -> None:
+ """Make an account public if it is eligible."""
+
+ @with_roles(call={'owner'})
+ @profile_state.transition(
+ profile_state.NOT_PRIVATE, profile_state.PRIVATE, title=__("Make private")
+ )
+ def make_profile_private(self) -> None:
+ """Make an account private."""
+
+ def is_safe_to_delete(self) -> bool:
+ """Test if account is not protected and has no projects."""
+ return self.is_protected is False and self.projects.count() == 0
+
+ def is_safe_to_purge(self) -> bool:
+ """Test if account is safe to delete and has no memberships (active or not)."""
+ return self.is_safe_to_delete() and not self.has_any_memberships()
+
+ @property
+ def urlname(self) -> str:
+ """Return :attr:`name` or ``~``-prefixed :attr:`uuid_zbase32`."""
+ if self.name is not None:
+ return self.name
+ return f'~{self.uuid_zbase32}'
+
+ @hybrid_property
+ def uuid_zbase32(self) -> str:
+ """Account UUID rendered in z-Base-32."""
+ return zbase32_encode(self.uuid.bytes)
+
+ @uuid_zbase32.inplace.comparator
+ @classmethod
+ def _uuid_zbase32_comparator(cls) -> ZBase32Comparator:
+ """Return SQL comparator for :prop:`uuid_zbase32`."""
+ return ZBase32Comparator(cls.uuid)
+
+ @classmethod
+ def name_is(cls, name: str) -> ColumnElement:
+ """Generate query filter to check if name is matching (case insensitive)."""
+ if name.startswith('~'):
+ return cls.uuid_zbase32 == name[1:]
+ return sa.func.lower(cls.name) == sa.func.lower(sa.func.replace(name, '-', '_'))
+
+ @classmethod
+ def name_in(cls, names: Iterable[str]) -> ColumnElement:
+ """Generate query flter to check if name is among candidates."""
+ return sa.func.lower(cls.name).in_(
+ [name.lower().replace('-', '_') for name in names]
+ )
+
+ @classmethod
+ def name_like(cls, like_query: str) -> ColumnElement:
+ """Generate query filter for a LIKE query on name."""
+ return sa.func.lower(cls.name).like(
+ sa.func.lower(sa.func.replace(like_query, '-', r'\_'))
+ )
+
+ @overload
+ @classmethod
+ def get(
+ cls,
+ *,
+ name: str,
+ defercols: bool = False,
+ ) -> Account | None:
+ ...
+
+ @overload
+ @classmethod
+ def get(
+ cls,
+ *,
+ buid: str,
+ defercols: bool = False,
+ ) -> Account | None:
+ ...
+
+ @overload
+ @classmethod
+ def get(
+ cls,
+ *,
+ userid: str,
+ defercols: bool = False,
+ ) -> Account | None:
+ ...
+
+ @classmethod
+ def get(
+ cls,
+ *,
+ name: str | None = None,
+ buid: str | None = None,
+ userid: str | None = None,
+ defercols: bool = False,
+ ) -> Account | None:
+ """
+ Return an Account with the given name or buid.
+
+ :param str name: Username to lookup
+ :param str buid: Buid to lookup
+ :param bool defercols: Defer loading non-critical columns
+ """
+ require_one_of(name=name, buid=buid, userid=userid)
+
+ # userid parameter is temporary for Flask-Lastuser compatibility
+ if userid:
+ buid = userid
+
+ if name is not None:
+ query = cls.query.filter(cls.name_is(name))
+ else:
+ query = cls.query.filter_by(buid=buid)
+ if cls is not Account:
+ query = query.filter(cls.type_filter())
+ if defercols:
+ query = query.options(*cls._defercols())
+ account = query.one_or_none()
+ if account and account.state.MERGED:
+ account = account.merged_account()
+ if account and account.state.ACTIVE:
+ return account
+ return None
+
+ @classmethod
+ def all( # noqa: A003
+ cls,
+ buids: Iterable[str] | None = None,
+ names: Iterable[str] | None = None,
+ defercols: bool = False,
+ ) -> list[Account]:
+ """
+ Return all matching accounts.
+
+ :param list buids: Buids to look up
+ :param list names: Names (usernames) to look up
+ :param bool defercols: Defer loading non-critical columns
+ """
+ accounts = set()
+ if buids and names:
+ query = cls.query.filter(sa.or_(cls.buid.in_(buids), cls.name_in(names)))
+ elif buids:
+ query = cls.query.filter(cls.buid.in_(buids))
+ elif names:
+ query = cls.query.filter(cls.name_in(names))
+ else:
+ return []
+ if cls is not Account:
+ query = query.filter(cls.type_filter())
+
+ if defercols:
+ query = query.options(*cls._defercols())
+ for account in query.all():
+ account = account.merged_account()
+ if account.state.ACTIVE:
+ accounts.add(account)
+ return list(accounts)
+
+ @classmethod
+ def all_public(cls) -> Query:
+ """Construct a query filtered by public profile state."""
+ query = cls.query.filter(cls.profile_state.PUBLIC)
+ if cls is not Account:
+ query = query.filter(cls.type_filter())
+ return query
+
+ @classmethod
+ def autocomplete(cls, prefix: str) -> list[Account]:
+ """
+ Return accounts whose names begin with the prefix, for autocomplete UI.
+
+ Looks up accounts by title, name, external ids and email addresses.
+
+ :param prefix: Letters to start matching with
+ """
+ like_query = quote_autocomplete_like(prefix)
+ if not like_query or like_query == '@%':
+ return []
+ tsquery = quote_autocomplete_tsquery(prefix)
+
+ # base_users is used in two of the three possible queries below
+ base_users = cls.query.filter(
+ cls.state.ACTIVE,
+ cls.name_vector.bool_op('@@')(tsquery),
+ )
+
+ if cls is not Account:
+ base_users = base_users.filter(cls.type_filter())
+ base_users = (
+ base_users.options(*cls._defercols()).order_by(Account.title).limit(20)
+ )
+
+ if (
+ prefix != '@'
+ and prefix.startswith('@')
+ and AccountExternalId.__at_username_services__
+ ):
+ # @-prefixed, so look for usernames, including other @username-using
+ # services like Twitter and GitHub. Make a union of three queries.
+ users = (
+ # Query 1: @query -> Account.name
+ cls.query.filter(
+ cls.state.ACTIVE,
+ cls.name_like(like_query[1:]),
+ )
+ .options(*cls._defercols())
+ .limit(20)
+ # FIXME: Still broken as of SQLAlchemy 1.4.23 (also see next block)
+ # .union(
+ # # Query 2: @query -> UserExternalId.username
+ # cls.query.join(UserExternalId)
+ # .filter(
+ # cls.state.ACTIVE,
+ # UserExternalId.service.in_(
+ # UserExternalId.__at_username_services__
+ # ),
+ # sa.func.lower(UserExternalId.username).like(
+ # sa.func.lower(like_query[1:])
+ # ),
+ # )
+ # .options(*cls._defercols())
+ # .limit(20),
+ # # Query 3: like_query -> Account.title
+ # cls.query.filter(
+ # cls.state.ACTIVE,
+ # sa.func.lower(cls.title).like(sa.func.lower(like_query)),
+ # )
+ # .options(*cls._defercols())
+ # .limit(20),
+ # )
+ .all()
+ )
+ elif '@' in prefix and not prefix.startswith('@'):
+ # Query has an @ in the middle. Match email address (exact match only).
+ # Use param `prefix` instead of `like_query` because it's not a LIKE query.
+ # Combine results with regular user search
+ email_filter = EmailAddress.get_filter(email=prefix)
+ if email_filter is not None:
+ users = (
+ cls.query.join(AccountEmail)
+ .join(EmailAddress)
+ .filter(email_filter, cls.state.ACTIVE)
+ .options(*cls._defercols())
+ .limit(20)
+ # .union(base_users) # FIXME: Broken in SQLAlchemy 1.4.17
+ .all()
+ )
+ else:
+ users = []
+ else:
+ # No '@' in the query, so do a regular autocomplete
+ try:
+ users = base_users.all()
+ except sa.exc.ProgrammingError:
+ # This can happen because the tsquery from prefix turned out to be ':*'
+ users = []
+ return users
+
+ @classmethod
+ def validate_name_candidate(cls, name: str) -> str | None:
+ """
+ Validate an account name candidate.
+
+ Returns one of several error codes, or `None` if all is okay:
+
+ * ``blank``: No name supplied
+ * ``reserved``: Name is reserved
+ * ``invalid``: Invalid characters in name
+ * ``long``: Name is longer than allowed size
+ * ``user``: Name is assigned to a user
+ * ``org``: Name is assigned to an organization
+ """
+ if not name:
+ return 'blank'
+ if name.lower() in cls.reserved_names:
+ return 'reserved'
+ if not valid_account_name(name):
+ return 'invalid'
+ if len(name) > cls.__name_length__:
+ return 'long'
+ # Look for existing on the base Account model, not the subclass, as SQLAlchemy
+ # will add a filter condition on subclasses to restrict the query to that type.
+ existing = (
+ Account.query.filter(sa.func.lower(Account.name) == sa.func.lower(name))
+ .options(sa.orm.load_only(cls.id, cls.uuid, cls.type_))
+ .one_or_none()
+ )
+ if existing is not None:
+ if isinstance(existing, Placeholder):
+ return 'reserved'
+ if isinstance(existing, User):
+ return 'user'
+ if isinstance(existing, Organization):
+ return 'org'
+ return None
+
+ def validate_new_name(self, name: str) -> str | None:
+ """Validate a new name for this account, returning an error code or None."""
+ if self.name and name.lower() == self.name.lower():
+ return None
+ return self.validate_name_candidate(name)
+
+ @classmethod
+ def is_available_name(cls, name: str) -> bool:
+ """Test if the candidate name is available for use as an Account name."""
+ return cls.validate_name_candidate(name) is None
+
+ @sa.orm.validates('name')
+ def _validate_name(self, key: str, value: str | None) -> str | None:
+ """Validate the value of Account.name."""
+ if value is None:
+ return value
+
+ if not isinstance(value, str):
+ raise ValueError(f"Account name must be a string: {value}")
+
+ if not value.strip():
+ raise ValueError("Account name cannot be blank")
+
+ if value.lower() in self.reserved_names or not valid_account_name(value):
+ raise ValueError("Invalid account name: " + value)
+
+ # We don't check for existence in the db since this validator only
+ # checks for valid syntax. To confirm the name is actually available,
+ # the caller must call :meth:`is_available_name` or attempt to commit
+ # to the db and catch IntegrityError.
+ return value
+
+ @sa.orm.validates('logo_url', 'banner_image_url')
+ def _validate_nullable(self, key: str, value: str | None):
+ """Convert blank values into None."""
+ return value if value else None
+
+ @classmethod
+ def active_count(cls) -> int:
+ """Count of all active accounts."""
+ return cls.query.filter(cls.state.ACTIVE).count()
+
+ #: FIXME: Temporary values for Baseframe compatibility
+ def organization_links(self) -> list:
+ """Return list of organizations affiliated with this user (deprecated)."""
+ return []
+
+ # Make :attr:`type_` available under the name `type`, but declare this at the very
+ # end of the class to avoid conflicts with the Python `type` global that is
+ # used for type-hinting
+ type: Mapped[str] = sa.orm.synonym('type_') # noqa: A003
+
+
+auto_init_default(Account._state) # pylint: disable=protected-access
+auto_init_default(Account._profile_state) # pylint: disable=protected-access
+add_search_trigger(Account, 'search_vector')
+add_search_trigger(Account, 'name_vector')
+
+
+class AccountOldId(UuidMixin, BaseMixin, Model):
+ """Record of an older UUID for an account, after account merger."""
+
+ __tablename__ = 'account_oldid'
+ __uuid_primary_key__ = True
+
+ #: Old account, if still present
+ old_account: Mapped[Account] = relationship(
+ Account,
+ primaryjoin='foreign(AccountOldId.id) == remote(Account.uuid)',
+ backref=backref('oldid', uselist=False),
+ )
+ #: User id of new user
+ account_id: Mapped[int] = sa.orm.mapped_column(
+ sa.ForeignKey('account.id'), nullable=False
+ )
+ #: New account
+ account: Mapped[Account] = relationship(
+ Account,
+ foreign_keys=[account_id],
+ backref=backref('oldids', cascade='all'),
+ )
+
+ def __repr__(self) -> str:
+ """Represent :class:`AccountOldId` as a string."""
+ return f''
+
+ @classmethod
+ def get(cls, uuid: UUID) -> AccountOldId | None:
+ """Get an old user record given a UUID."""
+ return cls.query.filter_by(id=uuid).one_or_none()
+
+
+class User(Account):
+ """User account."""
+
+ __mapper_args__ = {'polymorphic_identity': 'U'}
+ is_user_profile = True
+
+ def __init__(self, **kwargs) -> None:
+ super().__init__(**kwargs)
+ if self.joined_at is None:
+ self.joined_at = sa.func.utcnow()
+
+
+# XXX: Deprecated, still here for Baseframe compatibility
+Account.userid = Account.uuid_b64
+
+
+class DuckTypeAccount(RoleMixin):
+ """User singleton constructor. Ducktypes a regular user object."""
+
+ id: None = None # noqa: A003
+ created_at: None = None
+ updated_at: None = None
+ uuid: None = None
+ userid: None = None
+ buid: None = None
+ uuid_b58: None = None
+ username: None = None
+ name: None = None
+ profile_url: None = None
+ email: None = None
+ phone: None = None
+
+ is_user_profile = True
+ is_organization_profile = False
+ is_placeholder_profile = False
+
+ # Copy registries from Account model
+ views = Account.views
+ features = Account.features
+ forms = Account.forms
+
+ __roles__ = {
+ 'all': {
+ 'read': {
+ 'id',
+ 'uuid',
+ 'username',
+ 'fullname',
+ 'pickername',
+ 'profile_url',
+ },
+ 'call': {'views', 'forms', 'features', 'url_for'},
+ }
+ }
+
+ __datasets__ = {
+ 'related': {
+ 'username',
+ 'fullname',
+ 'pickername',
+ 'profile_url',
+ }
+ }
+
+ #: Make obj.user/obj.posted_by from a referring object falsy
+ def __bool__(self) -> bool:
+ """Represent boolean state."""
+ return False
+
+ def __init__(self, representation: str) -> None:
+ self.fullname = self.title = self.pickername = representation
+
+ def __str__(self) -> str:
+ return self.pickername
+
+ def __format__(self, format_spec: str) -> str:
+ if not format_spec:
+ return self.pickername
+ return self.pickername.__format__(format_spec)
+
+ def url_for(self, *args, **kwargs) -> Literal['']:
+ """Return blank URL for anything to do with this user."""
+ return ''
+
+
+deleted_account = DuckTypeAccount(__("[deleted]"))
+removed_account = DuckTypeAccount(__("[removed]"))
+unknown_account = DuckTypeAccount(__("[unknown]"))
+
+
+# --- Organizations and teams -------------------------------------------------
+
+team_membership = sa.Table(
+ 'team_membership',
+ Model.metadata,
+ sa.Column(
+ 'account_id',
+ sa.Integer,
+ sa.ForeignKey('account.id'),
+ nullable=False,
+ primary_key=True,
+ ),
+ sa.Column(
+ 'team_id',
+ sa.Integer,
+ sa.ForeignKey('team.id'),
+ nullable=False,
+ primary_key=True,
+ ),
+ sa.Column(
+ 'created_at',
+ sa.TIMESTAMP(timezone=True),
+ nullable=False,
+ default=sa.func.utcnow(),
+ ),
+)
+
+
+class Organization(Account):
+ """An organization of one or more users with distinct roles."""
+
+ __mapper_args__ = {'polymorphic_identity': 'O'}
+ is_organization_profile = True
+
+ def __init__(self, owner: User, **kwargs) -> None:
+ super().__init__(**kwargs)
+ if self.joined_at is None:
+ self.joined_at = sa.func.utcnow()
+ db.session.add(
+ AccountMembership(
+ account=self, member=owner, granted_by=owner, is_owner=True
+ )
+ )
+
+ def people(self) -> Query[Account]:
+ """Return a list of users from across the public teams they are in."""
+ return (
+ Account.query.join(team_membership)
+ .join(Team)
+ .filter(Team.account == self, Team.is_public.is_(True))
+ .options(sa.orm.joinedload(Account.member_teams))
+ .order_by(sa.func.lower(Account.title))
+ )
+
+
+class Placeholder(Account):
+ """A placeholder account."""
+
+ __mapper_args__ = {'polymorphic_identity': 'P'}
+ is_placeholder_profile = True
+
+
+class Team(UuidMixin, BaseMixin, Model):
+ """A team of users within an organization."""
+
+ __tablename__ = 'team'
+ __title_length__ = 250
+ #: Displayed name
+ title: Mapped[str] = sa.orm.mapped_column(
+ sa.Unicode(__title_length__), nullable=False
+ )
+ #: Organization
+ account_id: Mapped[int] = sa.orm.mapped_column(
+ sa.ForeignKey('account.id'), nullable=False, index=True
+ )
+ account = with_roles(
+ relationship(
+ Account,
+ foreign_keys=[account_id],
+ backref=backref('teams', order_by=sa.func.lower(title), cascade='all'),
+ ),
+ grants_via={None: {'owner': 'owner', 'admin': 'admin'}},
+ )
+ users: DynamicMapped[Account] = with_roles(
+ relationship(
+ Account, secondary=team_membership, lazy='dynamic', backref='member_teams'
+ ),
+ grants={'member'},
+ )
+
+ is_public: Mapped[bool] = sa.orm.mapped_column(
+ sa.Boolean, nullable=False, default=False
+ )
+
+ def __repr__(self) -> str:
+ """Represent :class:`Team` as a string."""
+ return f''
+
+ @property
+ def pickername(self) -> str:
+ """Return team's title in a format suitable for identification."""
+ return self.title
+
+ @classmethod
+ def migrate_account(
+ cls, old_account: Account, new_account: Account
+ ) -> OptionalMigratedTables:
+ """Migrate one account's data to another when merging accounts."""
+ for team in list(old_account.teams):
+ team.account = new_account
+ for team in list(old_account.member_teams):
+ if team not in new_account.member_teams:
+ # FIXME: This creates new memberships, updating `created_at`.
+ # Unfortunately, we can't work with model instances as in the other
+ # `migrate_account` methods as team_membership is an unmapped table.
+ new_account.member_teams.append(team)
+ old_account.member_teams.remove(team)
+ return [cls.__table__.name, team_membership.name]
+
+ @classmethod
+ def get(cls, buid: str, with_parent: bool = False) -> Team | None:
+ """
+ Return a Team with matching buid.
+
+ :param str buid: Buid of the team
+ """
+ if with_parent:
+ query = cls.query.options(sa.orm.joinedload(cls.account))
+ else:
+ query = cls.query
+ return query.filter_by(buid=buid).one_or_none()
+
+
+# --- Account email/phone and misc
+
+
+class AccountEmail(EmailAddressMixin, BaseMixin, Model):
+ """An email address linked to an account."""
+
+ __tablename__ = 'account_email'
+ __email_optional__ = False
+ __email_unique__ = True
+ __email_is_exclusive__ = True
+ __email_for__ = 'account'
+
+ # Tell mypy that these are not optional
+ email_address: Mapped[EmailAddress] # type: ignore[assignment]
+
+ account_id: Mapped[int] = sa.orm.mapped_column(
+ sa.ForeignKey('account.id'), nullable=False
+ )
+ account: Mapped[Account] = relationship(
+ Account, backref=backref('emails', cascade='all')
+ )
+ user: Mapped[Account] = sa.orm.synonym('account')
+
+ private: Mapped[bool] = sa.orm.mapped_column(
+ sa.Boolean, nullable=False, default=False
+ )
+
+ __datasets__ = {
+ 'primary': {'member', 'email', 'private', 'type'},
+ 'without_parent': {'email', 'private', 'type'},
+ 'related': {'email', 'private', 'type'},
+ }
+
+ def __init__(self, account: Account, **kwargs) -> None:
+ email = kwargs.pop('email', None)
+ if email:
+ kwargs['email_address'] = EmailAddress.add_for(account, email)
+ super().__init__(account=account, **kwargs)
+
+ def __repr__(self) -> str:
+ """Represent this class as a string."""
+ return f''
+
+ def __str__(self) -> str: # pylint: disable=invalid-str-returned
+ """Email address as a string."""
+ return self.email or ''
+
+ @property
+ def primary(self) -> bool:
+ """Check whether this email address is the user's primary."""
+ return self.account.primary_email == self
+
+ @primary.setter
+ def primary(self, value: bool) -> None:
+ """Set or unset this email address as primary."""
+ if value:
+ self.account.primary_email = self
+ else:
+ if self.account.primary_email == self:
+ self.account.primary_email = None
+
+ @overload
+ @classmethod
+ def get(
+ cls,
+ email: str,
+ ) -> AccountEmail | None:
+ ...
+
+ @overload
+ @classmethod
+ def get(
+ cls,
+ *,
+ blake2b160: bytes,
+ ) -> AccountEmail | None:
+ ...
+
+ @overload
+ @classmethod
+ def get(
+ cls,
+ *,
+ email_hash: str,
+ ) -> AccountEmail | None:
+ ...
+
+ @classmethod
+ def get(
+ cls,
+ email: str | None = None,
+ *,
+ blake2b160: bytes | None = None,
+ email_hash: str | None = None,
+ ) -> AccountEmail | None:
+ """
+ Return an AccountEmail with matching email or blake2b160 hash.
+
+ :param email: Email address to look up
+ :param blake2b160: 160-bit blake2b of email address to look up
+ :param email_hash: blake2b hash rendered in Base58
+ """
+ email_filter = EmailAddress.get_filter(
+ email=email, blake2b160=blake2b160, email_hash=email_hash
+ )
+ if email_filter is None:
+ return None
+ return cls.query.join(EmailAddress).filter(email_filter).one_or_none()
+
+ @overload
+ @classmethod
+ def get_for(
+ cls,
+ account: Account,
+ *,
+ email: str,
+ ) -> AccountEmail | None:
+ ...
+
+ @overload
+ @classmethod
+ def get_for(
+ cls,
+ account: Account,
+ *,
+ blake2b160: bytes,
+ ) -> AccountEmail | None:
+ ...
+
+ @overload
+ @classmethod
+ def get_for(
+ cls,
+ account: Account,
+ *,
+ email_hash: str,
+ ) -> AccountEmail | None:
+ ...
+
+ @classmethod
+ def get_for(
+ cls,
+ account: Account,
+ *,
+ email: str | None = None,
+ blake2b160: bytes | None = None,
+ email_hash: str | None = None,
+ ) -> AccountEmail | None:
+ """
+ Return instance with matching email or hash if it belongs to the given user.
+
+ :param user: Account to look up for
+ :param email: Email address to look up
+ :param blake2b160: 160-bit blake2b of email address
+ :param email_hash: blake2b hash rendered in Base58
+ """
+ email_filter = EmailAddress.get_filter(
+ email=email, blake2b160=blake2b160, email_hash=email_hash
+ )
+ if email_filter is None:
+ return None
+ return (
+ cls.query.join(EmailAddress)
+ .filter(
+ cls.account == account,
+ email_filter,
+ )
+ .one_or_none()
+ )
+
+ @classmethod
+ def migrate_account(
+ cls, old_account: Account, new_account: Account
+ ) -> OptionalMigratedTables:
+ """Migrate one account's data to another when merging accounts."""
+ primary_email = old_account.primary_email
+ for accountemail in list(old_account.emails):
+ accountemail.account = new_account
+ if new_account.primary_email is None:
+ new_account.primary_email = primary_email
+ old_account.primary_email = None
+ return [cls.__table__.name, user_email_primary_table.name]
+
+
+class AccountEmailClaim(EmailAddressMixin, BaseMixin, Model):
+ """Claimed but unverified email address for a user."""
+
+ __tablename__ = 'account_email_claim'
+ __email_optional__ = False
+ __email_unique__ = False
+ __email_for__ = 'account'
+ __email_is_exclusive__ = False
+
+ # Tell mypy that these are not optional
+ email_address: Mapped[EmailAddress] # type: ignore[assignment]
+
+ account_id: Mapped[int] = sa.orm.mapped_column(
+ sa.ForeignKey('account.id'), nullable=False
+ )
+ account: Mapped[Account] = relationship(
+ Account, backref=backref('emailclaims', cascade='all')
+ )
+ user: Mapped[Account] = sa.orm.synonym('account')
+ verification_code: Mapped[str] = sa.orm.mapped_column(
+ sa.String(44), nullable=False, default=newsecret
+ )
+
+ private: Mapped[bool] = sa.orm.mapped_column(
+ sa.Boolean, nullable=False, default=False
+ )
+
+ __table_args__ = (sa.UniqueConstraint('account_id', 'email_address_id'),)
+
+ __datasets__ = {
+ 'primary': {'member', 'email', 'private', 'type'},
+ 'without_parent': {'email', 'private', 'type'},
+ 'related': {'email', 'private', 'type'},
+ }
+
+ def __init__(self, account: Account, **kwargs) -> None:
+ email = kwargs.pop('email', None)
+ if email:
+ kwargs['email_address'] = EmailAddress.add_for(account, email)
+ super().__init__(account=account, **kwargs)
+ self.blake2b = hashlib.blake2b(
+ self.email.lower().encode(), digest_size=16
+ ).digest()
+
+ def __repr__(self) -> str:
+ """Represent this class as a string."""
+ return f''
+
+ def __str__(self) -> str:
+ """Return email as a string."""
+ return str(self.email)
+
+ @classmethod
+ def migrate_account(cls, old_account: Account, new_account: Account) -> None:
+ """Migrate one account's data to another when merging accounts."""
+ emails = {claim.email for claim in new_account.emailclaims}
+ for claim in list(old_account.emailclaims):
+ if claim.email not in emails:
+ claim.account = new_account
+ else:
+ # New user also made the same claim. Delete old user's claim
+ db.session.delete(claim)
+
+ @overload
+ @classmethod
+ def get_for(
+ cls,
+ account: Account,
+ *,
+ email: str,
+ ) -> AccountEmailClaim | None:
+ ...
+
+ @overload
+ @classmethod
+ def get_for(
+ cls,
+ account: Account,
+ *,
+ blake2b160: bytes,
+ ) -> AccountEmailClaim | None:
+ ...
+
+ @overload
+ @classmethod
+ def get_for(
+ cls,
+ account: Account,
+ *,
+ email_hash: str,
+ ) -> AccountEmailClaim | None:
+ ...
+
+ @classmethod
+ def get_for(
+ cls,
+ account: Account,
+ *,
+ email: str | None = None,
+ blake2b160: bytes | None = None,
+ email_hash: str | None = None,
+ ) -> AccountEmailClaim | None:
+ """
+ Return an AccountEmailClaim with matching email address for the given user.
+
+ :param account: Account that claimed this email address
+ :param email: Email address to look up
+ :param blake2b160: 160-bit blake2b of email address to look up
+ :param email_hash: Base58 rendering of 160-bit blake2b hash
+ """
+ email_filter = EmailAddress.get_filter(
+ email=email, blake2b160=blake2b160, email_hash=email_hash
+ )
+ if email_filter is None:
+ return None
+ return (
+ cls.query.join(EmailAddress)
+ .filter(
+ cls.account == account,
+ email_filter,
+ )
+ .one_or_none()
+ )
+
+ @overload
+ @classmethod
+ def get_by(
+ cls,
+ verification_code: str,
+ *,
+ email: str,
+ ) -> AccountEmailClaim | None:
+ ...
+
+ @overload
+ @classmethod
+ def get_by(
+ cls,
+ verification_code: str,
+ *,
+ blake2b160: bytes,
+ ) -> AccountEmailClaim | None:
+ ...
+
+ @overload
+ @classmethod
+ def get_by(
+ cls,
+ verification_code: str,
+ *,
+ email_hash: str,
+ ) -> AccountEmailClaim | None:
+ ...
+
+ @classmethod
+ def get_by(
+ cls,
+ verification_code: str,
+ *,
+ email: str | None = None,
+ blake2b160: bytes | None = None,
+ email_hash: str | None = None,
+ ) -> AccountEmailClaim | None:
+ """Return an instance given verification code and email or hash."""
+ email_filter = EmailAddress.get_filter(
+ email=email, blake2b160=blake2b160, email_hash=email_hash
+ )
+ if email_filter is None:
+ return None
+ return (
+ cls.query.join(EmailAddress)
+ .filter(
+ cls.verification_code == verification_code,
+ email_filter,
+ )
+ .one_or_none()
+ )
+
+ @classmethod
+ def all(cls, email: str) -> Query[AccountEmailClaim]: # noqa: A003
+ """
+ Return all instances with the matching email address.
+
+ :param str email: Email address to lookup
+ """
+ email_filter = EmailAddress.get_filter(email=email)
+ if email_filter is None:
+ raise ValueError(email)
+ return cls.query.join(EmailAddress).filter(email_filter)
+
+
+auto_init_default(AccountEmailClaim.verification_code)
+
+
+class AccountPhone(PhoneNumberMixin, BaseMixin, Model):
+ """A phone number linked to an account."""
+
+ __tablename__ = 'account_phone'
+ __phone_optional__ = False
+ __phone_unique__ = True
+ __phone_is_exclusive__ = True
+ __phone_for__ = 'account'
+
+ account_id: Mapped[int] = sa.orm.mapped_column(
+ sa.ForeignKey('account.id'), nullable=False
+ )
+ account: Mapped[Account] = relationship(
+ Account, backref=backref('phones', cascade='all')
+ )
+ user: Mapped[Account] = sa.orm.synonym('account')
+
+ private: Mapped[bool] = sa.orm.mapped_column(
+ sa.Boolean, nullable=False, default=False
+ )
+
+ __datasets__ = {
+ 'primary': {'member', 'phone', 'private', 'type'},
+ 'without_parent': {'phone', 'private', 'type'},
+ 'related': {'phone', 'private', 'type'},
+ }
+
+ def __init__(self, account, **kwargs) -> None:
+ phone = kwargs.pop('phone', None)
+ if phone:
+ kwargs['phone_number'] = PhoneNumber.add_for(account, phone)
+ super().__init__(account=account, **kwargs)
+
+ def __repr__(self) -> str:
+ """Represent this class as a string."""
+ return f'AccountPhone(phone={self.phone!r}, account={self.account!r})'
+
+ def __str__(self) -> str:
+ """Return phone number as a string."""
+ return self.phone or ''
+
+ @cached_property
+ def parsed(self) -> phonenumbers.PhoneNumber:
+ """Return parsed phone number using libphonenumbers."""
+ return self.phone_number.parsed
+
+ @cached_property
+ def formatted(self) -> str:
+ """Return a phone number formatted for user display."""
+ return self.phone_number.formatted
+
+ @property
+ def number(self) -> str | None:
+ return self.phone_number.number
+
+ @property
+ def primary(self) -> bool:
+ """Check if this is the user's primary phone number."""
+ return self.account.primary_phone == self
+
+ @primary.setter
+ def primary(self, value: bool) -> None:
+ if value:
+ self.account.primary_phone = self
+ else:
+ if self.account.primary_phone == self:
+ self.account.primary_phone = None
+
+ @overload
+ @classmethod
+ def get(
+ cls,
+ phone: str,
+ ) -> AccountPhone | None:
+ ...
+
+ @overload
+ @classmethod
+ def get(
+ cls,
+ *,
+ blake2b160: bytes,
+ ) -> AccountPhone | None:
+ ...
+
+ @overload
+ @classmethod
+ def get(
+ cls,
+ *,
+ phone_hash: str,
+ ) -> AccountPhone | None:
+ ...
+
+ @classmethod
+ def get(
+ cls,
+ phone: str | None = None,
+ *,
+ blake2b160: bytes | None = None,
+ phone_hash: str | None = None,
+ ) -> AccountPhone | None:
+ """
+ Return an AccountPhone with matching phone number.
+
+ :param phone: Phone number to lookup
+ :param blake2b160: 160-bit blake2b of phone number to look up
+ :param phone_hash: blake2b hash rendered in Base58
+ """
+ return (
+ cls.query.join(PhoneNumber)
+ .filter(
+ PhoneNumber.get_filter(
+ phone=phone, blake2b160=blake2b160, phone_hash=phone_hash
+ )
+ )
+ .one_or_none()
+ )
+
+ @overload
+ @classmethod
+ def get_for(
+ cls,
+ account: Account,
+ *,
+ phone: str,
+ ) -> AccountPhone | None:
+ ...
+
+ @overload
+ @classmethod
+ def get_for(
+ cls,
+ account: Account,
+ *,
+ blake2b160: bytes,
+ ) -> AccountPhone | None:
+ ...
+
+ @overload
+ @classmethod
+ def get_for(
+ cls,
+ account: Account,
+ *,
+ phone_hash: str,
+ ) -> AccountPhone | None:
+ ...
+
+ @classmethod
+ def get_for(
+ cls,
+ account: Account,
+ *,
+ phone: str | None = None,
+ blake2b160: bytes | None = None,
+ phone_hash: str | None = None,
+ ) -> AccountPhone | None:
+ """
+ Return an instance with matching phone or hash if it belongs to the given user.
+
+ :param account: Account to look up for
+ :param phone: Email address to look up
+ :param blake2b160: 160-bit blake2b of phone number
+ :param phone_hash: blake2b hash rendered in Base58
+ """
+ return (
+ cls.query.join(PhoneNumber)
+ .filter(
+ cls.account == account,
+ PhoneNumber.get_filter(
+ phone=phone, blake2b160=blake2b160, phone_hash=phone_hash
+ ),
+ )
+ .one_or_none()
+ )
+
+ @classmethod
+ def migrate_account(
+ cls, old_account: Account, new_account: Account
+ ) -> OptionalMigratedTables:
+ """Migrate one account's data to another when merging accounts."""
+ primary_phone = old_account.primary_phone
+ for accountphone in list(old_account.phones):
+ accountphone.account = new_account
+ if new_account.primary_phone is None:
+ new_account.primary_phone = primary_phone
+ old_account.primary_phone = None
+ return [cls.__table__.name, user_phone_primary_table.name]
+
+
+class AccountExternalId(BaseMixin, Model):
+ """An external connected account for a user."""
+
+ __tablename__ = 'account_externalid'
+ __at_username_services__: ClassVar[list[str]] = []
+ #: Foreign key to user table
+ account_id: Mapped[int] = sa.orm.mapped_column(
+ sa.ForeignKey('account.id'), nullable=False
+ )
+ #: User that this connected account belongs to
+ account: Mapped[Account] = relationship(
+ Account, backref=backref('externalids', cascade='all')
+ )
+ user: Mapped[Account] = sa.orm.synonym('account')
+ #: Identity of the external service (in app's login provider registry)
+ # FIXME: change to sa.Unicode
+ service: Mapped[str] = sa.orm.mapped_column(sa.UnicodeText, nullable=False)
+ #: Unique user id as per external service, used for identifying related accounts
+ # FIXME: change to sa.Unicode
+ userid: Mapped[str] = sa.orm.mapped_column(
+ sa.UnicodeText, nullable=False
+ ) # Unique id (or obsolete OpenID)
+ #: Optional public-facing username on the external service
+ # FIXME: change to sa.Unicode
+ username: Mapped[str | None] = sa.orm.mapped_column(
+ sa.UnicodeText, nullable=True
+ ) # LinkedIn once used full URLs
+ #: OAuth or OAuth2 access token
+ # FIXME: change to sa.Unicode
+ oauth_token: Mapped[str | None] = sa.orm.mapped_column(
+ sa.UnicodeText, nullable=True
+ )
+ #: Optional token secret (not used in OAuth2, used by Twitter with OAuth1a)
+ # FIXME: change to sa.Unicode
+ oauth_token_secret: Mapped[str | None] = sa.orm.mapped_column(
+ sa.UnicodeText, nullable=True
+ )
+ #: OAuth token type (typically 'bearer')
+ # FIXME: change to sa.Unicode
+ oauth_token_type: Mapped[str | None] = sa.orm.mapped_column(
+ sa.UnicodeText, nullable=True
+ )
+ #: OAuth2 refresh token
+ # FIXME: change to sa.Unicode
+ oauth_refresh_token: Mapped[str | None] = sa.orm.mapped_column(
+ sa.UnicodeText, nullable=True
+ )
+ #: OAuth2 token expiry in seconds, as sent by service provider
+ oauth_expires_in: Mapped[int | None] = sa.orm.mapped_column(
+ sa.Integer, nullable=True
+ )
+ #: OAuth2 token expiry timestamp, estimate from created_at + oauth_expires_in
+ oauth_expires_at: Mapped[datetime | None] = sa.orm.mapped_column(
+ sa.TIMESTAMP(timezone=True), nullable=True, index=True
+ )
+
+ #: Timestamp of when this connected account was last (re-)authorised by the user
+ last_used_at: Mapped[datetime] = sa.orm.mapped_column(
+ sa.TIMESTAMP(timezone=True), default=sa.func.utcnow(), nullable=False
+ )
+
+ __table_args__ = (
+ sa.UniqueConstraint('service', 'userid'),
+ sa.Index(
+ 'ix_account_externalid_username_lower',
+ sa.func.lower(username).label('username_lower'),
+ postgresql_ops={'username_lower': 'varchar_pattern_ops'},
+ ),
+ )
+
+ def __repr__(self) -> str:
+ """Represent :class:`UserExternalId` as a string."""
+ return f''
+
+ @overload
+ @classmethod
+ def get(
+ cls,
+ service: str,
+ *,
+ userid: str,
+ ) -> AccountExternalId | None:
+ ...
+
+ @overload
+ @classmethod
+ def get(
+ cls,
+ service: str,
+ *,
+ username: str,
+ ) -> AccountExternalId | None:
+ ...
+
+ @classmethod
+ def get(
+ cls,
+ service: str,
+ *,
+ userid: str | None = None,
+ username: str | None = None,
+ ) -> AccountExternalId | None:
+ """
+ Return a UserExternalId with the given service and userid or username.
+
+ :param str service: Service to lookup
+ :param str userid: Userid to lookup
+ :param str username: Username to lookup (may be non-unique)
+
+ Usernames are not guaranteed to be unique within a service. An example is with
+ Google, where the userid is a directed OpenID URL, unique but subject to change
+ if the Lastuser site URL changes. The username is the email address, which will
+ be the same despite different userids.
+ """
+ param, value = require_one_of(True, userid=userid, username=username)
+ return cls.query.filter_by(**{param: value, 'service': service}).one_or_none()
+
+
+user_email_primary_table = add_primary_relationship(
+ Account, 'primary_email', AccountEmail, 'account', 'account_id'
+)
+user_phone_primary_table = add_primary_relationship(
+ Account, 'primary_phone', AccountPhone, 'account', 'account_id'
+)
+
+#: Anchor type
+Anchor = Union[AccountEmail, AccountEmailClaim, AccountPhone, EmailAddress, PhoneNumber]
+
+# Tail imports
+# pylint: disable=wrong-import-position
+from .membership_mixin import ImmutableMembershipMixin # isort: skip
+from .account_membership import AccountMembership # isort:skip
diff --git a/funnel/models/account_membership.py b/funnel/models/account_membership.py
new file mode 100644
index 000000000..80c4b97b7
--- /dev/null
+++ b/funnel/models/account_membership.py
@@ -0,0 +1,234 @@
+"""Membership model for admins of an organization."""
+
+from __future__ import annotations
+
+from werkzeug.utils import cached_property
+
+from coaster.sqlalchemy import DynamicAssociationProxy, immutable, with_roles
+
+from . import DynamicMapped, Mapped, Model, backref, relationship, sa
+from .account import Account
+from .helpers import reopen
+from .membership_mixin import ImmutableUserMembershipMixin
+
+__all__ = ['AccountMembership']
+
+
+class AccountMembership(ImmutableUserMembershipMixin, Model):
+ """
+ An account can be a member of another account as an owner, admin or follower.
+
+ Owners can manage other administrators.
+
+ TODO: This model may introduce non-admin memberships in a future iteration by
+ replacing :attr:`is_owner` with :attr:`member_level` or distinct role flags as in
+ :class:`ProjectMembership`.
+ """
+
+ __tablename__ = 'account_membership'
+
+ # Legacy data has no granted_by
+ __null_granted_by__ = True
+
+ #: List of role columns in this model
+ __data_columns__ = ('is_owner',)
+
+ __roles__ = {
+ 'all': {
+ 'read': {
+ 'urls',
+ 'member',
+ 'is_owner',
+ 'account',
+ 'granted_by',
+ 'revoked_by',
+ 'granted_at',
+ 'revoked_at',
+ 'is_self_granted',
+ 'is_self_revoked',
+ }
+ },
+ 'account_admin': {
+ 'read': {
+ 'record_type',
+ 'record_type_label',
+ 'granted_at',
+ 'granted_by',
+ 'revoked_at',
+ 'revoked_by',
+ 'member',
+ 'is_active',
+ 'is_invite',
+ 'is_self_granted',
+ 'is_self_revoked',
+ }
+ },
+ }
+ __datasets__ = {
+ 'primary': {
+ 'urls',
+ 'uuid_b58',
+ 'offered_roles',
+ 'is_owner',
+ 'member',
+ 'account',
+ },
+ 'without_parent': {'urls', 'uuid_b58', 'offered_roles', 'is_owner', 'member'},
+ 'related': {'urls', 'uuid_b58', 'offered_roles', 'is_owner'},
+ }
+
+ #: Organization that this membership is being granted on
+ account_id: Mapped[int] = sa.orm.mapped_column(
+ sa.Integer,
+ sa.ForeignKey('account.id', ondelete='CASCADE'),
+ nullable=False,
+ )
+ account: Mapped[Account] = with_roles(
+ relationship(
+ Account,
+ foreign_keys=[account_id],
+ backref=backref(
+ 'memberships', lazy='dynamic', cascade='all', passive_deletes=True
+ ),
+ ),
+ grants_via={None: {'admin': 'account_admin', 'owner': 'account_owner'}},
+ )
+ parent_id: Mapped[int] = sa.orm.synonym('account_id')
+ parent_id_column = 'account_id'
+ parent: Mapped[Account] = sa.orm.synonym('account')
+
+ # Organization roles:
+ is_owner: Mapped[bool] = immutable(
+ sa.orm.mapped_column(sa.Boolean, nullable=False, default=False)
+ )
+
+ @cached_property
+ def offered_roles(self) -> set[str]:
+ """Roles offered by this membership record."""
+ roles = {'admin'}
+ if self.is_owner:
+ roles.add('owner')
+ return roles
+
+
+# Add active membership relationships to Account
+@reopen(Account)
+class __Account:
+ active_admin_memberships: DynamicMapped[AccountMembership] = with_roles(
+ relationship(
+ AccountMembership,
+ lazy='dynamic',
+ primaryjoin=sa.and_(
+ sa.orm.remote(AccountMembership.account_id) == Account.id,
+ AccountMembership.is_active,
+ ),
+ order_by=AccountMembership.granted_at.asc(),
+ viewonly=True,
+ ),
+ grants_via={'member': {'admin', 'owner'}},
+ )
+
+ active_owner_memberships: DynamicMapped[AccountMembership] = relationship(
+ AccountMembership,
+ lazy='dynamic',
+ primaryjoin=sa.and_(
+ sa.orm.remote(AccountMembership.account_id) == Account.id,
+ AccountMembership.is_active,
+ AccountMembership.is_owner.is_(True),
+ ),
+ viewonly=True,
+ )
+
+ active_invitations: DynamicMapped[AccountMembership] = relationship(
+ AccountMembership,
+ lazy='dynamic',
+ primaryjoin=sa.and_(
+ sa.orm.remote(AccountMembership.account_id) == Account.id,
+ AccountMembership.is_invite,
+ AccountMembership.revoked_at.is_(None),
+ ),
+ viewonly=True,
+ )
+
+ owner_users = with_roles(
+ DynamicAssociationProxy('active_owner_memberships', 'member'), read={'all'}
+ )
+ admin_users = with_roles(
+ DynamicAssociationProxy('active_admin_memberships', 'member'), read={'all'}
+ )
+
+ # pylint: disable=invalid-unary-operand-type
+ organization_admin_memberships: DynamicMapped[AccountMembership] = relationship(
+ AccountMembership,
+ lazy='dynamic',
+ foreign_keys=[AccountMembership.member_id], # type: ignore[has-type]
+ viewonly=True,
+ )
+
+ noninvite_organization_admin_memberships: DynamicMapped[
+ AccountMembership
+ ] = relationship(
+ AccountMembership,
+ lazy='dynamic',
+ foreign_keys=[AccountMembership.member_id],
+ primaryjoin=sa.and_(
+ sa.orm.remote(AccountMembership.member_id) # type: ignore[has-type]
+ == Account.id,
+ ~AccountMembership.is_invite,
+ ),
+ viewonly=True,
+ )
+
+ active_organization_admin_memberships: DynamicMapped[
+ AccountMembership
+ ] = relationship(
+ AccountMembership,
+ lazy='dynamic',
+ foreign_keys=[AccountMembership.member_id],
+ primaryjoin=sa.and_(
+ sa.orm.remote(AccountMembership.member_id) # type: ignore[has-type]
+ == Account.id,
+ AccountMembership.is_active,
+ ),
+ viewonly=True,
+ )
+
+ active_organization_owner_memberships: DynamicMapped[
+ AccountMembership
+ ] = relationship(
+ AccountMembership,
+ lazy='dynamic',
+ foreign_keys=[AccountMembership.member_id],
+ primaryjoin=sa.and_(
+ sa.orm.remote(AccountMembership.member_id) # type: ignore[has-type]
+ == Account.id,
+ AccountMembership.is_active,
+ AccountMembership.is_owner.is_(True),
+ ),
+ viewonly=True,
+ )
+
+ active_organization_invitations: DynamicMapped[AccountMembership] = relationship(
+ AccountMembership,
+ lazy='dynamic',
+ foreign_keys=[AccountMembership.member_id],
+ primaryjoin=sa.and_(
+ sa.orm.remote(AccountMembership.member_id) # type: ignore[has-type]
+ == Account.id,
+ AccountMembership.is_invite,
+ AccountMembership.revoked_at.is_(None),
+ ),
+ viewonly=True,
+ )
+
+ organizations_as_owner = DynamicAssociationProxy(
+ 'active_organization_owner_memberships', 'account'
+ )
+
+ organizations_as_admin = DynamicAssociationProxy(
+ 'active_organization_admin_memberships', 'account'
+ )
+
+
+Account.__active_membership_attrs__.add('active_organization_admin_memberships')
+Account.__noninvite_membership_attrs__.add('noninvite_organization_admin_memberships')
diff --git a/funnel/models/auth_client.py b/funnel/models/auth_client.py
index d3da5b49b..cf8281010 100644
--- a/funnel/models/auth_client.py
+++ b/funnel/models/auth_client.py
@@ -2,37 +2,37 @@
from __future__ import annotations
+import urllib.parse
+from collections.abc import Iterable, Sequence
from datetime import datetime, timedelta
from hashlib import blake2b, sha256
-from typing import (
- Dict,
- Iterable,
- List,
- Optional,
- Sequence,
- Tuple,
- Union,
- cast,
- overload,
-)
-import urllib.parse
+from typing import cast, overload
-from sqlalchemy.orm import load_only
-from sqlalchemy.orm.collections import attribute_mapped_collection
+from sqlalchemy.orm import attribute_keyed_dict, load_only
from sqlalchemy.orm.query import Query as QueryBaseClass
-
from werkzeug.utils import cached_property
from baseframe import _
from coaster.sqlalchemy import with_roles
-from coaster.utils import buid as make_buid
-from coaster.utils import newsecret, require_one_of, utcnow
+from coaster.utils import buid as make_buid, newsecret, require_one_of, utcnow
-from ..typing import OptionalMigratedTables
-from . import BaseMixin, Mapped, UuidMixin, db, declarative_mixin, declared_attr, sa
+from . import (
+ BaseMixin,
+ DynamicMapped,
+ Mapped,
+ Model,
+ Query,
+ UuidMixin,
+ backref,
+ db,
+ declarative_mixin,
+ declared_attr,
+ relationship,
+ sa,
+)
+from .account import Account, Team
from .helpers import reopen
-from .user import Organization, Team, User
-from .user_session import UserSession, auth_client_user_session
+from .login_session import LoginSession, auth_client_login_session
__all__ = [
'AuthCode',
@@ -40,7 +40,7 @@
'AuthClient',
'AuthClientCredential',
'AuthClientTeamPermissions',
- 'AuthClientUserPermissions',
+ 'AuthClientPermissions',
]
@@ -51,115 +51,96 @@ class ScopeMixin:
__scope_null_allowed__ = False
@declared_attr
- def _scope(cls) -> sa.Column[sa.UnicodeText]: # pylint: disable=no-self-argument
+ @classmethod
+ def _scope(cls) -> Mapped[str]:
"""Database column for storing scopes as a space-separated string."""
- return sa.Column(
- 'scope',
- sa.UnicodeText, # type: ignore[arg-type]
- nullable=cls.__scope_null_allowed__,
+ return sa.orm.mapped_column(
+ 'scope', sa.UnicodeText, nullable=cls.__scope_null_allowed__
)
- @declared_attr
- def scope( # pylint: disable=no-self-argument
- cls,
- ) -> Mapped[Tuple[str, ...]]:
+ @property
+ def scope(self) -> Iterable[str]:
"""Represent scope column as a container of strings."""
- # pylint: disable=protected-access
- def scope_get(self) -> Tuple[str, ...]:
- if not self._scope:
- return ()
- return tuple(sorted(self._scope.split()))
-
- def scope_set(self, value: Optional[Union[str, Iterable]]) -> None:
- if value is None:
- if self.__scope_null_allowed__:
- self._scope = None
- return
- raise ValueError("Scope cannot be None")
- if isinstance(value, str):
- value = value.split()
- self._scope = ' '.join(sorted(t.strip() for t in value if t))
- if not self._scope and self.__scope_null_allowed__:
- self._scope = None
-
- # pylint: enable=protected-access
- return sa.orm.synonym('_scope', descriptor=property(scope_get, scope_set))
+ if not self._scope:
+ return ()
+ return tuple(sorted(self._scope.split()))
- def add_scope(self, additional: Union[str, Iterable]) -> None:
+ @scope.setter
+ def scope(self, value: str | Iterable | None) -> None:
+ if value is None:
+ if self.__scope_null_allowed__:
+ self._scope = None
+ return
+ raise ValueError("Scope cannot be None")
+ if isinstance(value, str):
+ value = value.split()
+ self._scope = ' '.join(sorted(t.strip() for t in value if t))
+ if not self._scope and self.__scope_null_allowed__:
+ self._scope = None
+
+ def add_scope(self, additional: str | Iterable) -> None:
"""Add additional items to the scope."""
if isinstance(additional, str):
additional = [additional]
self.scope = set(self.scope).union(set(additional))
-class AuthClient(
- ScopeMixin,
- UuidMixin,
- BaseMixin,
- db.Model, # type: ignore[name-defined]
-):
+class AuthClient(ScopeMixin, UuidMixin, BaseMixin, Model):
"""OAuth client application."""
__tablename__ = 'auth_client'
__scope_null_allowed__ = True
- # TODO: merge columns into a profile_id column
- #: User who owns this client
- user_id = sa.Column(sa.Integer, sa.ForeignKey('user.id'), nullable=True)
- user: Mapped[Optional[User]] = with_roles(
- sa.orm.relationship(
- User,
- primaryjoin=user_id == User.id,
- backref=sa.orm.backref('clients', cascade='all'),
+ #: Account that owns this client
+ account_id: Mapped[int] = sa.orm.mapped_column(
+ sa.ForeignKey('account.id'), nullable=True
+ )
+ account: Mapped[Account | None] = with_roles(
+ relationship(
+ Account,
+ foreign_keys=[account_id],
+ backref=backref('clients', cascade='all'),
),
read={'all'},
write={'owner'},
- grants={'owner'},
- )
- #: Organization that owns this client. Only one of this or user must be set
- organization_id = sa.Column(
- sa.Integer, sa.ForeignKey('organization.id'), nullable=True
- )
- organization: Mapped[Optional[User]] = with_roles(
- sa.orm.relationship(
- Organization,
- primaryjoin=organization_id == Organization.id,
- backref=sa.orm.backref('clients', cascade='all'),
- ),
- read={'all'},
- write={'owner'},
- grants_via={None: {'owner': 'owner', 'admin': 'owner'}},
+ grants_via={None: {'owner': 'owner', 'admin': 'admin'}},
)
#: Human-readable title
title = with_roles(
- sa.Column(sa.Unicode(250), nullable=False), read={'all'}, write={'owner'}
+ sa.orm.mapped_column(sa.Unicode(250), nullable=False),
+ read={'all'},
+ write={'owner'},
)
#: Long description
description = with_roles(
- sa.Column(sa.UnicodeText, nullable=False, default=''),
+ sa.orm.mapped_column(sa.UnicodeText, nullable=False, default=''),
read={'all'},
write={'owner'},
)
#: Confidential or public client? Public has no secret key
confidential = with_roles(
- sa.Column(sa.Boolean, nullable=False), read={'all'}, write={'owner'}
+ sa.orm.mapped_column(sa.Boolean, nullable=False), read={'all'}, write={'owner'}
)
#: Website
website = with_roles(
- sa.Column(sa.UnicodeText, nullable=False), read={'all'}, write={'owner'}
+ sa.orm.mapped_column(sa.UnicodeText, nullable=False),
+ read={'all'},
+ write={'owner'},
)
#: Redirect URIs (one or more)
- _redirect_uris = sa.Column(
+ _redirect_uris: Mapped[str | None] = sa.orm.mapped_column(
'redirect_uri', sa.UnicodeText, nullable=True, default=''
)
#: Back-end notification URI (TODO: deprecated, needs better architecture)
- notification_uri: sa.Column[Optional[str]] = with_roles(
- sa.Column(sa.UnicodeText, nullable=True, default=''), rw={'owner'}
+ notification_uri = with_roles(
+ sa.orm.mapped_column(sa.UnicodeText, nullable=True, default=''), rw={'owner'}
)
#: Active flag
- active = sa.Column(sa.Boolean, nullable=False, default=True)
+ active: Mapped[bool] = sa.orm.mapped_column(
+ sa.Boolean, nullable=False, default=True
+ )
#: Allow anyone to login to this app?
allow_any_login = with_roles(
- sa.Column(sa.Boolean, nullable=False, default=True),
+ sa.orm.mapped_column(sa.Boolean, nullable=False, default=True),
read={'all'},
write={'owner'},
)
@@ -170,23 +151,14 @@ class AuthClient(
#: However, resources in the scope column (via ScopeMixin) are granted for
#: any arbitrary user without explicit user authorization.
trusted = with_roles(
- sa.Column(sa.Boolean, nullable=False, default=False), read={'all'}
+ sa.orm.mapped_column(sa.Boolean, nullable=False, default=False), read={'all'}
)
- user_sessions = sa.orm.relationship(
- UserSession,
+ login_sessions: DynamicMapped[LoginSession] = relationship(
+ LoginSession,
lazy='dynamic',
- secondary=auth_client_user_session,
- backref=sa.orm.backref('auth_clients', lazy='dynamic'),
- )
-
- __table_args__ = (
- sa.CheckConstraint(
- sa.case([(user_id.isnot(None), 1)], else_=0)
- + sa.case([(organization_id.isnot(None), 1)], else_=0)
- == 1,
- name='auth_client_owner_check',
- ),
+ secondary=auth_client_login_session,
+ backref=backref('auth_clients', lazy='dynamic'),
)
__roles__ = {
@@ -206,7 +178,7 @@ def secret_is(self, candidate: str, name: str) -> bool:
return credential.secret_is(candidate)
@property
- def redirect_uris(self) -> Tuple:
+ def redirect_uris(self) -> Iterable[str]:
"""Return redirect URIs as a sequence."""
return tuple(self._redirect_uris.split()) if self._redirect_uris else ()
@@ -218,7 +190,7 @@ def redirect_uris(self, value: Iterable) -> None:
with_roles(redirect_uris, rw={'owner'})
@property
- def redirect_uri(self) -> Optional[str]:
+ def redirect_uri(self) -> str | None:
"""Return the first redirect URI, if present."""
uris = self.redirect_uris # Assign to local var to avoid splitting twice
if uris:
@@ -235,48 +207,41 @@ def host_matches(self, url: str) -> bool:
)
return False
- @property
- def owner(self):
- """Return user or organization that owns this client app."""
- return self.user or self.organization
-
- with_roles(owner, read={'all'})
-
- def owner_is(self, user: User) -> bool:
- """Test if the provided user is an owner of this client."""
+ def owner_is(self, account: Account | None) -> bool:
+ """Test if the provided account is an owner of this client."""
# Legacy method for ownership test
- return 'owner' in self.roles_for(user)
+ return account is not None and 'owner' in self.roles_for(account)
def authtoken_for(
- self, user: Optional[User], user_session: Optional[UserSession] = None
- ) -> Optional[AuthToken]:
+ self, account: Account | None, login_session: LoginSession | None = None
+ ) -> AuthToken | None:
"""
- Return the authtoken for this user and client.
+ Return the authtoken for this account and client.
Only works for confidential clients.
"""
if self.confidential:
- if user is None:
- raise ValueError("User not provided")
- return AuthToken.get_for(auth_client=self, user=user)
- if user_session and user_session.user == user:
- return AuthToken.get_for(auth_client=self, user_session=user_session)
+ if account is None:
+ raise ValueError("Account not provided")
+ return AuthToken.get_for(auth_client=self, account=account)
+ if login_session and login_session.account == account:
+ return AuthToken.get_for(auth_client=self, login_session=login_session)
return None
- def allow_access_for(self, actor: User) -> bool:
+ def allow_access_for(self, actor: Account) -> bool:
"""Test if access is allowed for this user as per the auth client settings."""
if self.allow_any_login:
return True
- if self.user:
- if AuthClientUserPermissions.get(self, actor):
+ if self.account:
+ if AuthClientPermissions.get(self, actor):
return True
else:
- if AuthClientTeamPermissions.all_for(self, actor).first():
+ if AuthClientTeamPermissions.all_for(self, actor).notempty():
return True
return False
@classmethod
- def get(cls, buid: str) -> Optional[AuthClient]:
+ def get(cls, buid: str) -> AuthClient | None:
"""
Return a AuthClient identified by its client buid or namespace.
@@ -284,30 +249,30 @@ def get(cls, buid: str) -> Optional[AuthClient]:
:param str buid: AuthClient buid to lookup
"""
- return cls.query.filter_by(buid=buid, active=True).one_or_none()
+ return cls.query.filter(cls.buid == buid, cls.active.is_(True)).one_or_none()
@classmethod
- def all_for(cls, user: Optional[User]) -> QueryBaseClass:
- """Return all clients, optionally all clients owned by the specified user."""
- if user is None:
+ def all_for(cls, account: Account | None) -> Query[AuthClient]:
+ """Return all clients, optionally all clients owned by the specified account."""
+ if account is None:
return cls.query.order_by(cls.title)
return cls.query.filter(
sa.or_(
- cls.user == user,
- cls.organization_id.in_(user.organizations_as_owner_ids()),
+ cls.account == account,
+ cls.account_id.in_(account.organizations_as_owner_ids()),
)
).order_by(cls.title)
-class AuthClientCredential(BaseMixin, db.Model): # type: ignore[name-defined]
+class AuthClientCredential(BaseMixin, Model):
"""
AuthClient key and secret hash.
This uses unsalted Blake2 (64-bit) instead of a salted hash or a more secure hash
like bcrypt because:
- 1. Secrets are UUID-based and unique before hashing. Salting is only beneficial when
- the source values may be reused.
+ 1. Secrets are random and unique before hashing. Salting is only beneficial when
+ the secrets may be reused.
2. Unlike user passwords, client secrets are used often, up to many times per
minute. The hash needs to be fast (MD5 or SHA) and reasonably safe from collision
attacks (eliminating MD5, SHA0 and SHA1). Blake2 is the fastest available
@@ -319,33 +284,43 @@ class AuthClientCredential(BaseMixin, db.Model): # type: ignore[name-defined]
"""
__tablename__ = 'auth_client_credential'
- auth_client_id = sa.Column(
+ auth_client_id: Mapped[int] = sa.orm.mapped_column(
sa.Integer, sa.ForeignKey('auth_client.id'), nullable=False
)
- auth_client: AuthClient = with_roles(
- sa.orm.relationship(
+ auth_client: Mapped[AuthClient] = with_roles(
+ relationship(
AuthClient,
- primaryjoin=auth_client_id == AuthClient.id,
- backref=sa.orm.backref(
+ backref=backref(
'credentials',
- cascade='all',
- collection_class=attribute_mapped_collection('name'),
+ cascade='all, delete-orphan',
+ collection_class=attribute_keyed_dict('name'),
),
),
grants_via={None: {'owner'}},
)
#: OAuth client key
- name = sa.Column(sa.String(22), nullable=False, unique=True, default=make_buid)
+ name: Mapped[str] = sa.orm.mapped_column(
+ sa.String(22), nullable=False, unique=True, default=make_buid
+ )
#: User description for this credential
- title = sa.Column(sa.Unicode(250), nullable=False, default='')
+ title: Mapped[str] = sa.orm.mapped_column(
+ sa.Unicode(250), nullable=False, default=''
+ )
#: OAuth client secret, hashed
- secret_hash = sa.Column(sa.Unicode, nullable=False)
+ secret_hash: Mapped[str] = sa.orm.mapped_column(sa.Unicode, nullable=False)
#: When was this credential last used for an API call?
- accessed_at = sa.Column(sa.TIMESTAMP(timezone=True), nullable=True)
+ accessed_at: Mapped[datetime | None] = sa.orm.mapped_column(
+ sa.TIMESTAMP(timezone=True), nullable=True
+ )
+
+ def __repr__(self) -> str:
+ return f''
- def secret_is(self, candidate: str, upgrade_hash: bool = False):
+ def secret_is(self, candidate: str | None, upgrade_hash: bool = False) -> bool:
"""Test if the candidate secret matches."""
+ if not candidate:
+ return False
if self.secret_hash.startswith('blake2b$32$'):
return (
self.secret_hash
@@ -366,12 +341,12 @@ def secret_is(self, candidate: str, upgrade_hash: bool = False):
return False
@classmethod
- def get(cls, name: str):
+ def get(cls, name: str) -> AuthClientCredential | None:
"""Get a client credential by its key name."""
- return cls.query.filter_by(name=name).one_or_none()
+ return cls.query.filter(cls.name == name).one_or_none()
@classmethod
- def new(cls, auth_client: AuthClient):
+ def new(cls, auth_client: AuthClient) -> tuple[AuthClientCredential, str]:
"""
Create a new client credential and return (cred, secret).
@@ -380,35 +355,43 @@ def new(cls, auth_client: AuthClient):
:param auth_client: The client for which a name/secret pair is being generated
"""
- cred = cls(auth_client=auth_client, name=make_buid())
secret = newsecret()
- cred.secret_hash = (
- 'blake2b$32$' + blake2b(secret.encode(), digest_size=32).hexdigest()
+ cred = cls(
+ name=make_buid(),
+ secret_hash=(
+ 'blake2b$32$' + blake2b(secret.encode(), digest_size=32).hexdigest()
+ ),
+ auth_client=auth_client,
)
+ db.session.add(cred)
return cred, secret
-class AuthCode(ScopeMixin, BaseMixin, db.Model): # type: ignore[name-defined]
+class AuthCode(ScopeMixin, BaseMixin, Model):
"""Short-lived authorization tokens."""
__tablename__ = 'auth_code'
- user_id = sa.Column(sa.Integer, sa.ForeignKey('user.id'), nullable=False)
- user = sa.orm.relationship(User, primaryjoin=user_id == User.id)
- auth_client_id = sa.Column(
+ account_id: Mapped[int] = sa.orm.mapped_column(
+ sa.ForeignKey('account.id'), nullable=False
+ )
+ account: Mapped[Account] = relationship(Account, foreign_keys=[account_id])
+ auth_client_id: Mapped[int] = sa.orm.mapped_column(
sa.Integer, sa.ForeignKey('auth_client.id'), nullable=False
)
- auth_client = sa.orm.relationship(
+ auth_client: Mapped[AuthClient] = relationship(
AuthClient,
- primaryjoin=auth_client_id == AuthClient.id,
- backref=sa.orm.backref('authcodes', cascade='all'),
+ foreign_keys=[auth_client_id],
+ backref=backref('authcodes', cascade='all'),
+ )
+ login_session_id: Mapped[int | None] = sa.orm.mapped_column(
+ sa.Integer, sa.ForeignKey('login_session.id'), nullable=True
)
- user_session_id = sa.Column(
- sa.Integer, sa.ForeignKey('user_session.id'), nullable=True
+ login_session: Mapped[LoginSession | None] = relationship(LoginSession)
+ code: Mapped[str] = sa.orm.mapped_column(
+ sa.String(44), default=newsecret, nullable=False
)
- user_session: Mapped[Optional[UserSession]] = sa.orm.relationship(UserSession)
- code = sa.Column(sa.String(44), default=newsecret, nullable=False)
- redirect_uri = sa.Column(sa.UnicodeText, nullable=False)
- used = sa.Column(sa.Boolean, default=False, nullable=False)
+ redirect_uri: Mapped[str] = sa.orm.mapped_column(sa.UnicodeText, nullable=False)
+ used: Mapped[bool] = sa.orm.mapped_column(sa.Boolean, default=False, nullable=False)
def is_valid(self) -> bool:
"""Test if this auth code is still valid."""
@@ -417,108 +400,98 @@ def is_valid(self) -> bool:
return not self.used and self.created_at >= utcnow() - timedelta(minutes=3)
@classmethod
- def all_for(cls, user: User) -> QueryBaseClass:
- """Return all auth codes for the specified user."""
- return cls.query.filter_by(user=user)
+ def all_for(cls, account: Account) -> Query[AuthCode]:
+ """Return all auth codes for the specified account."""
+ return cls.query.filter(cls.account == account)
@classmethod
- def get_for_client(cls, auth_client: AuthClient, code: str) -> Optional[AuthCode]:
+ def get_for_client(cls, auth_client: AuthClient, code: str) -> AuthCode | None:
"""Return a matching auth code for the specified auth client."""
- return cls.query.filter_by(auth_client=auth_client, code=code).one_or_none()
+ return cls.query.filter(
+ cls.auth_client == auth_client, cls.code == code
+ ).one_or_none()
-class AuthToken(ScopeMixin, BaseMixin, db.Model): # type: ignore[name-defined]
+class AuthToken(ScopeMixin, BaseMixin, Model):
"""Access tokens for access to data."""
__tablename__ = 'auth_token'
- # User id is null for client-only tokens and public clients as the user is
- # identified via user_session.user there
- user_id = sa.Column(sa.Integer, sa.ForeignKey('user.id'), nullable=True)
- _user: Mapped[Optional[User]] = sa.orm.relationship(
- User,
- primaryjoin=user_id == User.id,
- backref=sa.orm.backref('authtokens', lazy='dynamic', cascade='all'),
+ # Account id is null for client-only tokens and public clients as the account is
+ # identified via login_session.account there
+ account_id: Mapped[int | None] = sa.orm.mapped_column(
+ sa.ForeignKey('account.id'), nullable=True
+ )
+ account: Mapped[Account | None] = relationship(
+ Account,
+ backref=backref('authtokens', lazy='dynamic', cascade='all'),
)
#: The session in which this token was issued, null for confidential clients
- user_session_id = sa.Column(
- sa.Integer, sa.ForeignKey('user_session.id'), nullable=True
+ login_session_id = sa.orm.mapped_column(
+ sa.Integer, sa.ForeignKey('login_session.id'), nullable=True
)
- user_session: Mapped[Optional[UserSession]] = with_roles(
- sa.orm.relationship(
- UserSession, backref=sa.orm.backref('authtokens', lazy='dynamic')
- ),
+ login_session: Mapped[LoginSession | None] = with_roles(
+ relationship(LoginSession, backref=backref('authtokens', lazy='dynamic')),
read={'owner'},
)
#: The client this authtoken is for
- auth_client_id = sa.Column(
+ auth_client_id = sa.orm.mapped_column(
sa.Integer, sa.ForeignKey('auth_client.id'), nullable=False, index=True
)
- auth_client: sa.orm.relationship[AuthClient] = with_roles(
- sa.orm.relationship(
+ auth_client: Mapped[AuthClient] = with_roles(
+ relationship(
AuthClient,
- primaryjoin=auth_client_id == AuthClient.id,
- backref=sa.orm.backref('authtokens', lazy='dynamic', cascade='all'),
+ backref=backref('authtokens', lazy='dynamic', cascade='all'),
),
read={'owner'},
)
#: The token
- token = sa.Column(sa.String(22), default=make_buid, nullable=False, unique=True)
- #: The token's type
- token_type = sa.Column(
- sa.String(250), default='bearer', nullable=False
- ) # 'bearer', 'mac' or a URL
+ token = sa.orm.mapped_column(
+ sa.String(22), default=make_buid, nullable=False, unique=True
+ )
+ #: The token's type, 'bearer', 'mac' or a URL
+ token_type = sa.orm.mapped_column(sa.String(250), default='bearer', nullable=False)
#: Token secret for 'mac' type
- secret = sa.Column(sa.String(44), nullable=True)
+ secret = sa.orm.mapped_column(sa.String(44), nullable=True)
#: Secret's algorithm (for 'mac' type)
- _algorithm = sa.Column('algorithm', sa.String(20), nullable=True)
- #: Token's validity, 0 = unlimited
- validity = sa.Column(
- sa.Integer, nullable=False, default=0
- ) # Validity period in seconds
+ algorithm = sa.orm.mapped_column(sa.String(20), nullable=True)
+ #: Token's validity period in seconds, 0 = unlimited
+ validity = sa.orm.mapped_column(sa.Integer, nullable=False, default=0)
#: Refresh token, to obtain a new token
- refresh_token = sa.Column(sa.String(22), nullable=True, unique=True)
+ refresh_token = sa.orm.mapped_column(sa.String(22), nullable=True, unique=True)
# Only one authtoken per user and client. Add to scope as needed
__table_args__ = (
- sa.UniqueConstraint('user_id', 'auth_client_id'),
- sa.UniqueConstraint('user_session_id', 'auth_client_id'),
+ sa.UniqueConstraint('account_id', 'auth_client_id'),
+ sa.UniqueConstraint('login_session_id', 'auth_client_id'),
)
__roles__ = {
'owner': {
- 'read': {'created_at', 'user'},
- 'granted_by': ['user'],
+ 'read': {'created_at', 'account'},
+ 'granted_by': ['account'],
}
}
@property
- def user(self) -> User:
+ def effective_user(self) -> Account:
"""Return subject user of this auth token."""
- if self.user_session:
- return self.user_session.user
- return self._user
-
- @user.setter
- def user(self, value: User):
- self._user = value
-
- user: Mapped[User] = sa.orm.synonym( # type: ignore[no-redef]
- '_user', descriptor=user
- )
+ if self.login_session:
+ return self.login_session.account
+ return self.account
def __init__(self, **kwargs) -> None:
super().__init__(**kwargs)
self.token = make_buid()
- if self._user:
+ if self.effective_user:
self.refresh_token = make_buid()
self.secret = newsecret()
def __repr__(self) -> str:
"""Represent :class:`AuthToken` as a string."""
- return f''
+ return f''
@property
- def effective_scope(self) -> List:
+ def effective_scope(self) -> list:
"""Return effective scope of this token, combining granted and client scopes."""
return sorted(set(self.scope) | set(self.auth_client.scope))
@@ -527,12 +500,12 @@ def effective_scope(self) -> List:
def last_used(self) -> datetime:
"""Return last used timestamp for this auth token."""
return (
- db.session.query(sa.func.max(auth_client_user_session.c.accessed_at))
- .select_from(auth_client_user_session, UserSession)
+ db.session.query(sa.func.max(auth_client_login_session.c.accessed_at))
+ .select_from(auth_client_login_session, LoginSession)
.filter(
- auth_client_user_session.c.user_session_id == UserSession.id,
- auth_client_user_session.c.auth_client_id == self.auth_client_id,
- UserSession.user == self.user,
+ auth_client_login_session.c.login_session_id == LoginSession.id,
+ auth_client_login_session.c.auth_client_id == self.auth_client_id,
+ LoginSession.account == self.account,
)
.scalar()
)
@@ -543,25 +516,15 @@ def refresh(self) -> None:
self.token = make_buid()
self.secret = newsecret()
- @property
- def algorithm(self):
- """Return algorithm used for mac token secrets (non-bearer tokens)."""
- return self._algorithm
-
- @algorithm.setter
- def algorithm(self, value: Optional[str]):
+ @sa.orm.validates('algorithm')
+ def _validate_algorithm(self, _key: str, value: str | None) -> str | None:
"""Set mac token algorithm to one of supported values."""
if value is None:
- self._algorithm = None
self.secret = None
- elif value in ['hmac-sha-1', 'hmac-sha-256']:
- self._algorithm = value
- else:
+ return value
+ if value not in ['hmac-sha-1', 'hmac-sha-256']:
raise ValueError(_("Unrecognized algorithm ‘{value}’").format(value=value))
-
- algorithm: Mapped[str] = sa.orm.synonym( # type: ignore[no-redef]
- '_algorithm', descriptor=algorithm
- )
+ return value
def is_valid(self) -> bool:
"""Test if auth token is currently valid."""
@@ -573,51 +536,46 @@ def is_valid(self) -> bool:
return True
@classmethod
- def migrate_user( # type: ignore[return]
- cls, old_user: User, new_user: User
- ) -> OptionalMigratedTables:
- """Migrate one user account to another when merging user accounts."""
- oldtokens = cls.query.filter_by(user=old_user).all()
- newtokens: Dict[int, List[AuthToken]] = {} # AuthClient: token mapping
- for token in cls.query.filter_by(user=new_user).all():
+ def migrate_account(cls, old_account: Account, new_account: Account) -> None:
+ """Migrate one account's data to another when merging accounts."""
+ oldtokens = cls.query.filter(cls.account == old_account).all()
+ newtokens: dict[int, list[AuthToken]] = {} # AuthClient: token mapping
+ for token in cls.query.filter(cls.account == new_account).all():
newtokens.setdefault(token.auth_client_id, []).append(token)
for token in oldtokens:
merge_performed = False
if token.auth_client_id in newtokens:
for newtoken in newtokens[token.auth_client_id]:
- if newtoken.user == new_user:
- # There's another token for newuser with the same client.
+ if newtoken.account == new_account:
+ # There's another token for new_account with the same client.
# Just extend the scope there
newtoken.scope = set(newtoken.scope) | set(token.scope)
db.session.delete(token)
merge_performed = True
break
if merge_performed is False:
- token.user = new_user # Reassign this token to newuser
+ token.account = new_account # Reassign this token to new_account
@classmethod
- def get(cls, token: str) -> Optional[AuthToken]:
+ def get(cls, token: str) -> AuthToken | None:
"""
Return an AuthToken with the matching token.
:param str token: Token to lookup
"""
- query = cls.query.filter_by(token=token).options(
- sa.orm.joinedload(cls.auth_client).load_only('id', '_scope')
- )
- return query.one_or_none()
+ return cls.query.filter(cls.token == token).join(AuthClient).one_or_none()
@overload
@classmethod
- def get_for(cls, auth_client: AuthClient, *, user: User) -> Optional[AuthToken]:
+ def get_for(cls, auth_client: AuthClient, *, account: Account) -> AuthToken | None:
...
@overload
@classmethod
def get_for(
- cls, auth_client: AuthClient, *, user_session: UserSession
- ) -> Optional[AuthToken]:
+ cls, auth_client: AuthClient, *, login_session: LoginSession
+ ) -> AuthToken | None:
...
@classmethod
@@ -625,98 +583,99 @@ def get_for(
cls,
auth_client: AuthClient,
*,
- user: Optional[User] = None,
- user_session: Optional[UserSession] = None,
- ) -> Optional[AuthToken]:
- """Get an auth token for an auth client and a user or user session."""
- require_one_of(user=user, user_session=user_session)
- if user is not None:
- return cls.query.filter_by(auth_client=auth_client, user=user).one_or_none()
- return cls.query.filter_by(
- auth_client=auth_client, user_session=user_session
+ account: Account | None = None,
+ login_session: LoginSession | None = None,
+ ) -> AuthToken | None:
+ """Get an auth token for an auth client and an account or login session."""
+ require_one_of(account=account, login_session=login_session)
+ if account is not None:
+ return cls.query.filter(
+ cls.auth_client == auth_client, cls.account == account
+ ).one_or_none()
+ return cls.query.filter(
+ cls.auth_client == auth_client, cls.login_session == login_session
).one_or_none()
@classmethod
- def all( # noqa: A003
- cls, users: Union[QueryBaseClass, Sequence[User]]
- ) -> List[AuthToken]:
- """Return all AuthToken for the specified users."""
- query = cls.query.options(
- sa.orm.joinedload(cls.auth_client).load_only('id', '_scope')
- )
- if isinstance(users, QueryBaseClass):
- count = users.count()
+ def all(cls, accounts: Query | Sequence[Account]) -> list[AuthToken]: # noqa: A003
+ """Return all AuthToken for the specified accounts."""
+ query = cls.query.join(AuthClient)
+ if isinstance(accounts, QueryBaseClass):
+ count = accounts.count()
if count == 1:
- return query.filter_by(user=users.first()).all()
+ return query.filter(AuthToken.account == accounts.first()).all()
if count > 1:
return query.filter(
- AuthToken.user_id.in_(users.options(load_only('id')))
+ AuthToken.account_id.in_(accounts.options(load_only(Account.id)))
).all()
else:
- count = len(users)
+ count = len(accounts)
if count == 1:
# Cast users into a list/tuple before accessing [0], as the source
# may not be an actual list with indexed access. For example,
# Organization.owner_users is a DynamicAssociationProxy.
- return query.filter_by(user=tuple(users)[0]).all()
+ return query.filter(AuthToken.account == tuple(accounts)[0]).all()
if count > 1:
- return query.filter(AuthToken.user_id.in_([u.id for u in users])).all()
+ return query.filter(
+ AuthToken.account_id.in_([u.id for u in accounts])
+ ).all()
return []
@classmethod
- def all_for(cls, user: User) -> QueryBaseClass:
- """Get all AuthTokens for a specified user (direct only)."""
- return cls.query.filter_by(user=user)
+ def all_for(cls, account: Account) -> Query[AuthToken]:
+ """Get all AuthTokens for a specified account (direct only)."""
+ return cls.query.filter(cls.account == account)
# This model's name is in plural because it defines multiple permissions within each
# instance
-class AuthClientUserPermissions(BaseMixin, db.Model): # type: ignore[name-defined]
- """Permissions assigned to a user on a client app."""
+class AuthClientPermissions(BaseMixin, Model):
+ """Permissions assigned to an account on a client app."""
- __tablename__ = 'auth_client_user_permissions'
- #: User who has these permissions
- user_id = sa.Column(sa.Integer, sa.ForeignKey('user.id'), nullable=False)
- user = sa.orm.relationship(
- User,
- primaryjoin=user_id == User.id,
- backref=sa.orm.backref('client_permissions', cascade='all'),
+ __tablename__ = 'auth_client_permissions'
+ __tablename__ = 'auth_client_permissions'
+ #: User account that has these permissions
+ account_id: Mapped[int] = sa.orm.mapped_column(
+ sa.ForeignKey('account.id'), nullable=False
+ )
+ account: Mapped[Account] = relationship(
+ Account,
+ foreign_keys=[account_id],
+ backref=backref('client_permissions', cascade='all'),
)
#: AuthClient app they are assigned on
- auth_client_id = sa.Column(
+ auth_client_id = sa.orm.mapped_column(
sa.Integer, sa.ForeignKey('auth_client.id'), nullable=False, index=True
)
- auth_client: AuthClient = with_roles(
- sa.orm.relationship(
+ auth_client: Mapped[AuthClient] = with_roles(
+ relationship(
AuthClient,
- primaryjoin=auth_client_id == AuthClient.id,
- backref=sa.orm.backref('user_permissions', cascade='all'),
+ foreign_keys=[auth_client_id],
+ backref=backref('account_permissions', cascade='all'),
),
grants_via={None: {'owner'}},
)
#: The permissions as a string of tokens
- access_permissions = sa.Column(
+ access_permissions = sa.orm.mapped_column(
'permissions', sa.UnicodeText, default='', nullable=False
)
- # Only one assignment per user and client
- __table_args__ = (sa.UniqueConstraint('user_id', 'auth_client_id'),)
+ # Only one assignment per account and client
+ __table_args__ = (sa.UniqueConstraint('account_id', 'auth_client_id'),)
# Used by auth_client_info.html
@property
def pickername(self) -> str:
- """Return label string for identification of the subject user."""
- return self.user.pickername
+ """Return label string for identification of the subject account."""
+ return self.account.pickername
@classmethod
- def migrate_user( # type: ignore[return]
- cls, old_user: User, new_user: User
- ) -> OptionalMigratedTables:
- """Migrate one user account to another when merging user accounts."""
- for operm in old_user.client_permissions:
+ def migrate_account(cls, old_account: Account, new_account: Account) -> None:
+ """Migrate one account's data to another when merging accounts."""
+ for operm in old_account.client_permissions:
merge_performed = False
- for nperm in new_user.client_permissions:
+ for nperm in new_account.client_permissions:
if nperm.auth_client == operm.auth_client:
# Merge permission strings
tokens = set(operm.access_permissions.split(' '))
@@ -727,53 +686,55 @@ def migrate_user( # type: ignore[return]
db.session.delete(operm)
merge_performed = True
if not merge_performed:
- operm.user = new_user
+ operm.account = new_account
@classmethod
def get(
- cls, auth_client: AuthClient, user: User
- ) -> Optional[AuthClientUserPermissions]:
- """Get permissions for the specified auth client and user."""
- return cls.query.filter_by(auth_client=auth_client, user=user).one_or_none()
+ cls, auth_client: AuthClient, account: Account
+ ) -> AuthClientPermissions | None:
+ """Get permissions for the specified auth client and account."""
+ return cls.query.filter(
+ cls.auth_client == auth_client, cls.account == account
+ ).one_or_none()
@classmethod
- def all_for(cls, user: User) -> QueryBaseClass:
- """Get all permissions assigned to user for various clients."""
- return cls.query.filter_by(user=user)
+ def all_for(cls, account: Account) -> Query[AuthClientPermissions]:
+ """Get all permissions assigned to account for various clients."""
+ return cls.query.filter(cls.account == account)
@classmethod
- def all_forclient(cls, auth_client: AuthClient) -> QueryBaseClass:
+ def all_forclient(cls, auth_client: AuthClient) -> Query[AuthClientPermissions]:
"""Get all permissions assigned on the specified auth client."""
- return cls.query.filter_by(auth_client=auth_client)
+ return cls.query.filter(cls.auth_client == auth_client)
# This model's name is in plural because it defines multiple permissions within each
# instance
-class AuthClientTeamPermissions(BaseMixin, db.Model): # type: ignore[name-defined]
+class AuthClientTeamPermissions(BaseMixin, Model):
"""Permissions assigned to a team on a client app."""
__tablename__ = 'auth_client_team_permissions'
#: Team which has these permissions
- team_id = sa.Column(sa.Integer, sa.ForeignKey('team.id'), nullable=False)
- team = sa.orm.relationship(
+ team_id = sa.orm.mapped_column(sa.Integer, sa.ForeignKey('team.id'), nullable=False)
+ team = relationship(
Team,
- primaryjoin=team_id == Team.id,
- backref=sa.orm.backref('client_permissions', cascade='all'),
+ foreign_keys=[team_id],
+ backref=backref('client_permissions', cascade='all'),
)
#: AuthClient app they are assigned on
- auth_client_id = sa.Column(
+ auth_client_id = sa.orm.mapped_column(
sa.Integer, sa.ForeignKey('auth_client.id'), nullable=False, index=True
)
- auth_client: AuthClient = with_roles(
- sa.orm.relationship(
+ auth_client: Mapped[AuthClient] = with_roles(
+ relationship(
AuthClient,
- primaryjoin=auth_client_id == AuthClient.id,
- backref=sa.orm.backref('team_permissions', cascade='all'),
+ foreign_keys=[auth_client_id],
+ backref=backref('team_permissions', cascade='all'),
),
grants_via={None: {'owner'}},
)
#: The permissions as a string of tokens
- access_permissions = sa.Column(
+ access_permissions = sa.orm.mapped_column(
'permissions', sa.UnicodeText, default='', nullable=False
)
@@ -789,31 +750,36 @@ def pickername(self) -> str:
@classmethod
def get(
cls, auth_client: AuthClient, team: Team
- ) -> Optional[AuthClientTeamPermissions]:
+ ) -> AuthClientTeamPermissions | None:
"""Get permissions for the specified auth client and team."""
- return cls.query.filter_by(auth_client=auth_client, team=team).one_or_none()
+ return cls.query.filter(
+ cls.auth_client == auth_client, cls.team == team
+ ).one_or_none()
@classmethod
- def all_for(cls, auth_client: AuthClient, user: User) -> QueryBaseClass:
- """Get all permissions for the specified user via their teams."""
- return cls.query.filter_by(auth_client=auth_client).filter(
- cls.team_id.in_([team.id for team in user.teams])
+ def all_for(
+ cls, auth_client: AuthClient, account: Account
+ ) -> Query[AuthClientPermissions]:
+ """Get all permissions for the specified account via their teams."""
+ return cls.query.filter(
+ cls.auth_client == auth_client,
+ cls.team_id.in_([team.id for team in account.member_teams]),
)
@classmethod
- def all_forclient(cls, auth_client: AuthClient) -> QueryBaseClass:
+ def all_forclient(cls, auth_client: AuthClient) -> Query[AuthClientTeamPermissions]:
"""Get all permissions assigned on the specified auth client."""
- return cls.query.filter_by(auth_client=auth_client)
+ return cls.query.filter(cls.auth_client == auth_client)
-@reopen(User)
-class __User:
+@reopen(Account)
+class __Account:
def revoke_all_auth_tokens(self) -> None:
- """Revoke all auth tokens directly linked to the user."""
- AuthToken.all_for(cast(User, self)).delete(synchronize_session=False)
+ """Revoke all auth tokens directly linked to the account."""
+ AuthToken.all_for(cast(Account, self)).delete(synchronize_session=False)
def revoke_all_auth_client_permissions(self) -> None:
- """Revoke all permissions on client apps assigned to user."""
- AuthClientUserPermissions.all_for(cast(User, self)).delete(
+ """Revoke all permissions on client apps assigned to account."""
+ AuthClientPermissions.all_for(cast(Account, self)).delete(
synchronize_session=False
)
diff --git a/funnel/models/comment.py b/funnel/models/comment.py
index 595a1f736..b10eb07c9 100644
--- a/funnel/models/comment.py
+++ b/funnel/models/comment.py
@@ -2,10 +2,9 @@
from __future__ import annotations
+from collections.abc import Sequence
from datetime import datetime
-from typing import Iterable, List, Optional, Set, Union
-
-from sqlalchemy.orm import CompositeProperty
+from typing import Any
from werkzeug.utils import cached_property
@@ -15,16 +14,30 @@
from . import (
BaseMixin,
+ DynamicMapped,
Mapped,
- MarkdownCompositeBasic,
+ Model,
TSVectorType,
UuidMixin,
+ backref,
db,
hybrid_property,
+ relationship,
sa,
)
-from .helpers import MessageComposite, add_search_trigger, reopen
-from .user import DuckTypeUser, User, deleted_user, removed_user
+from .account import (
+ Account,
+ DuckTypeAccount,
+ deleted_account,
+ removed_account,
+ unknown_account,
+)
+from .helpers import (
+ MarkdownCompositeBasic,
+ MessageComposite,
+ add_search_trigger,
+ reopen,
+)
__all__ = ['Comment', 'Commentset']
@@ -73,10 +86,10 @@ class SET_TYPE: # noqa: N801
# --- Models ---------------------------------------------------------------------------
-class Commentset(UuidMixin, BaseMixin, db.Model): # type: ignore[name-defined]
+class Commentset(UuidMixin, BaseMixin, Model):
__tablename__ = 'commentset'
#: Commentset state code
- _state = sa.Column(
+ _state = sa.orm.mapped_column(
'state',
sa.SmallInteger,
StateManager.check_constraint('state', COMMENTSET_STATE),
@@ -86,18 +99,20 @@ class Commentset(UuidMixin, BaseMixin, db.Model): # type: ignore[name-defined]
#: Commentset state manager
state = StateManager('_state', COMMENTSET_STATE, doc="Commentset state")
#: Type of parent object
- settype: sa.Column[Optional[int]] = with_roles(
- sa.Column('type', sa.Integer, nullable=True), read={'all'}, datasets={'primary'}
+ settype: Mapped[int | None] = with_roles(
+ sa.orm.mapped_column('type', sa.Integer, nullable=True),
+ read={'all'},
+ datasets={'primary'},
)
#: Count of comments, stored to avoid count(*) queries
count = with_roles(
- sa.Column(sa.Integer, default=0, nullable=False),
+ sa.orm.mapped_column(sa.Integer, default=0, nullable=False),
read={'all'},
datasets={'primary'},
)
#: Timestamp of last comment, for ordering.
- last_comment_at: sa.Column[Optional[datetime]] = with_roles(
- sa.Column(sa.TIMESTAMP(timezone=True), nullable=True),
+ last_comment_at: Mapped[datetime | None] = with_roles(
+ sa.orm.mapped_column(sa.TIMESTAMP(timezone=True), nullable=True),
read={'all'},
datasets={'primary'},
)
@@ -132,7 +147,7 @@ def parent(self) -> BaseMixin:
with_roles(parent, read={'all'}, datasets={'primary'})
@cached_property
- def parent_type(self) -> Optional[str]:
+ def parent_type(self) -> str | None:
parent = self.parent
if parent is not None:
return parent.__tablename__
@@ -151,7 +166,7 @@ def last_comment(self):
with_roles(last_comment, read={'all'}, datasets={'primary'})
def roles_for(
- self, actor: Optional[User] = None, anchors: Iterable = ()
+ self, actor: Account | None = None, anchors: Sequence = ()
) -> LazyRoleSet:
roles = super().roles_for(actor, anchors)
parent_roles = self.parent.roles_for(actor, anchors)
@@ -162,7 +177,7 @@ def roles_for(
@with_roles(call={'all'})
@state.requires(state.NOT_DISABLED)
def post_comment(
- self, actor: User, message: str, in_reply_to: Optional[Comment] = None
+ self, actor: Account, message: str, in_reply_to: Comment | None = None
) -> Comment:
"""Post a comment."""
# TODO: Add role check for non-OPEN states. Either:
@@ -170,7 +185,7 @@ def post_comment(
# 2. Make a CommentMixin (like EmailAddressMixin) and insert logic into the
# parent, which can override methods and add custom restrictions
comment = Comment(
- user=actor,
+ posted_by=actor,
commentset=self,
message=message,
in_reply_to=in_reply_to,
@@ -190,35 +205,41 @@ def enable_comments(self):
# Transitions for the other two states are pending on the TODO notes in post_comment
-class Comment(UuidMixin, BaseMixin, db.Model): # type: ignore[name-defined]
+class Comment(UuidMixin, BaseMixin, Model):
__tablename__ = 'comment'
- user_id = sa.Column(sa.Integer, sa.ForeignKey('user.id'), nullable=True)
- _user: Mapped[Optional[User]] = with_roles(
- sa.orm.relationship(
- User, backref=sa.orm.backref('comments', lazy='dynamic', cascade='all')
+ posted_by_id: Mapped[int | None] = sa.orm.mapped_column(
+ sa.ForeignKey('account.id'), nullable=True
+ )
+ _posted_by: Mapped[Account | None] = with_roles(
+ relationship(
+ Account, backref=backref('comments', lazy='dynamic', cascade='all')
),
grants={'author'},
)
- commentset_id = sa.Column(
+ commentset_id = sa.orm.mapped_column(
sa.Integer, sa.ForeignKey('commentset.id'), nullable=False
)
- commentset = with_roles(
- sa.orm.relationship(
+ commentset: Mapped[Commentset] = with_roles(
+ relationship(
Commentset,
- backref=sa.orm.backref('comments', lazy='dynamic', cascade='all'),
+ backref=backref('comments', lazy='dynamic', cascade='all'),
),
grants_via={None: {'document_subscriber'}},
)
- in_reply_to_id = sa.Column(sa.Integer, sa.ForeignKey('comment.id'), nullable=True)
- replies = sa.orm.relationship(
- 'Comment', backref=sa.orm.backref('in_reply_to', remote_side='Comment.id')
+ in_reply_to_id = sa.orm.mapped_column(
+ sa.Integer, sa.ForeignKey('comment.id'), nullable=True
+ )
+ replies: Mapped[list[Comment]] = relationship(
+ 'Comment', backref=backref('in_reply_to', remote_side='Comment.id')
)
- _message = MarkdownCompositeBasic.create('message', nullable=False)
+ _message, message_text, message_html = MarkdownCompositeBasic.create(
+ 'message', nullable=False
+ )
- _state = sa.Column(
+ _state = sa.orm.mapped_column(
'state',
sa.Integer,
StateManager.check_constraint('state', COMMENT_STATE),
@@ -228,24 +249,25 @@ class Comment(UuidMixin, BaseMixin, db.Model): # type: ignore[name-defined]
state = StateManager('_state', COMMENT_STATE, doc="Current state of the comment")
edited_at = with_roles(
- sa.Column(sa.TIMESTAMP(timezone=True), nullable=True),
+ sa.orm.mapped_column(sa.TIMESTAMP(timezone=True), nullable=True),
read={'all'},
datasets={'primary', 'related', 'json'},
)
#: Revision number maintained by SQLAlchemy, starting at 1
- revisionid = with_roles(sa.Column(sa.Integer, nullable=False), read={'all'})
-
- search_vector = sa.orm.deferred(
- sa.Column(
- TSVectorType(
- 'message_text',
- weights={'message_text': 'A'},
- regconfig='english',
- hltext=lambda: Comment.message_html,
- ),
- nullable=False,
- )
+ revisionid = with_roles(
+ sa.orm.mapped_column(sa.Integer, nullable=False), read={'all'}
+ )
+
+ search_vector: Mapped[TSVectorType] = sa.orm.mapped_column(
+ TSVectorType(
+ 'message_text',
+ weights={'message_text': 'A'},
+ regconfig='english',
+ hltext=lambda: Comment.message_html,
+ ),
+ nullable=False,
+ deferred=True,
)
__table_args__ = (
@@ -259,7 +281,7 @@ class Comment(UuidMixin, BaseMixin, db.Model): # type: ignore[name-defined]
'read': {'created_at', 'urls', 'uuid_b58', 'has_replies'},
'call': {'state', 'commentset', 'view_for', 'url_for'},
},
- 'replied_to_commenter': {'granted_via': {'in_reply_to': '_user'}},
+ 'replied_to_commenter': {'granted_via': {'in_reply_to': '_posted_by'}},
}
__datasets__ = {
@@ -274,11 +296,11 @@ def __init__(self, **kwargs) -> None:
self.commentset.last_comment_at = sa.func.utcnow()
@cached_property
- def has_replies(self):
+ def has_replies(self) -> bool:
return bool(self.replies)
@property
- def current_access_replies(self) -> List[RoleAccessProxy]:
+ def current_access_replies(self) -> list[RoleAccessProxy]:
return [
reply.current_access(datasets=('json', 'related'))
for reply in self.replies
@@ -288,29 +310,33 @@ def current_access_replies(self) -> List[RoleAccessProxy]:
with_roles(current_access_replies, read={'all'}, datasets={'related', 'json'})
@hybrid_property
- def user(self) -> Union[User, DuckTypeUser]:
+ def posted_by(self) -> Account | DuckTypeAccount:
return (
- deleted_user
+ deleted_account
if self.state.DELETED
- else removed_user
+ else removed_account
if self.state.SPAM
- else self._user
+ else unknown_account
+ if self._posted_by is None
+ else self._posted_by
)
- @user.setter
- def user(self, value: Optional[User]) -> None:
- self._user = value
+ @posted_by.inplace.setter # type: ignore[arg-type]
+ def _posted_by_setter(self, value: Account | None) -> None:
+ self._posted_by = value
- @user.expression
- def user(cls): # noqa: N805 # pylint: disable=no-self-argument
- return cls._user
+ @posted_by.inplace.expression
+ @classmethod
+ def _posted_by_expression(cls) -> sa.orm.InstrumentedAttribute[Account | None]:
+ """Return SQL Expression."""
+ return cls._posted_by
- with_roles(user, read={'all'}, datasets={'primary', 'related', 'json', 'minimal'})
+ with_roles(
+ posted_by, read={'all'}, datasets={'primary', 'related', 'json', 'minimal'}
+ )
- # XXX: We're returning MarkownComposite, not CompositeProperty, but mypy doesn't
- # know. This is pending a fix to SQLAlchemy's type system, hopefully in 2.0
@hybrid_property
- def message(self) -> Union[CompositeProperty, MessageComposite]:
+ def message(self) -> MessageComposite | MarkdownCompositeBasic:
"""Return the message of the comment if not deleted or removed."""
return (
message_deleted
@@ -320,13 +346,14 @@ def message(self) -> Union[CompositeProperty, MessageComposite]:
else self._message
)
- @message.setter
- def message(self, value: str) -> None:
+ @message.inplace.setter
+ def _message_setter(self, value: Any) -> None:
"""Edit the message of a comment."""
self._message = value # type: ignore[assignment]
- @message.expression
- def message(cls): # noqa: N805 # pylint: disable=no-self-argument
+ @message.inplace.expression
+ @classmethod
+ def _message_expression(cls):
"""Return SQL expression for comment message column."""
return cls._message
@@ -345,21 +372,21 @@ def title(self) -> str:
obj = self.commentset.parent
if obj is not None:
return _("{user} commented on {obj}").format(
- user=self.user.pickername, obj=obj.title
+ user=self.posted_by.pickername, obj=obj.title
)
- return _("{user} commented").format(user=self.user.pickername)
+ return _("{account} commented").format(account=self.posted_by.pickername)
with_roles(title, read={'all'}, datasets={'primary', 'related', 'json'})
@property
- def badges(self) -> Set[str]:
+ def badges(self) -> set[str]:
badges = set()
roles = set()
if self.commentset.project is not None:
- roles = self.commentset.project.roles_for(self._user)
+ roles = self.commentset.project.roles_for(self._posted_by)
elif self.commentset.proposal is not None:
- roles = self.commentset.proposal.project.roles_for(self._user)
- if 'submitter' in self.commentset.proposal.roles_for(self._user):
+ roles = self.commentset.proposal.project.roles_for(self._posted_by)
+ if 'submitter' in self.commentset.proposal.roles_for(self._posted_by):
badges.add(_("Submitter"))
if 'editor' in roles:
if 'promoter' in roles:
@@ -376,8 +403,8 @@ def badges(self) -> Set[str]:
def delete(self) -> None:
"""Delete this comment."""
if len(self.replies) > 0:
- self.user = None # type: ignore[assignment]
- self.message = '' # type: ignore[assignment]
+ self.posted_by = None
+ self.message = ''
else:
if self.in_reply_to and self.in_reply_to.state.DELETED:
# If the comment this is replying to is deleted, ask it to reconsider
@@ -398,7 +425,7 @@ def mark_not_spam(self) -> None:
"""Mark this comment as not spam."""
def roles_for(
- self, actor: Optional[User] = None, anchors: Iterable = ()
+ self, actor: Account | None = None, anchors: Sequence = ()
) -> LazyRoleSet:
roles = super().roles_for(actor, anchors)
roles.add('reader')
@@ -410,7 +437,7 @@ def roles_for(
@reopen(Commentset)
class __Commentset:
- toplevel_comments = sa.orm.relationship(
+ toplevel_comments: DynamicMapped[Comment] = relationship(
Comment,
lazy='dynamic',
primaryjoin=sa.and_(
diff --git a/funnel/models/commentset_membership.py b/funnel/models/commentset_membership.py
index fafbb00e3..4becbd934 100644
--- a/funnel/models/commentset_membership.py
+++ b/funnel/models/commentset_membership.py
@@ -2,13 +2,12 @@
from __future__ import annotations
-from typing import Set
-
from werkzeug.utils import cached_property
-from coaster.sqlalchemy import DynamicAssociationProxy, Query, immutable, with_roles
+from coaster.sqlalchemy import DynamicAssociationProxy, with_roles
-from . import User, db, sa
+from . import DynamicMapped, Mapped, Model, Query, backref, db, relationship, sa
+from .account import Account
from .comment import Comment, Commentset
from .helpers import reopen
from .membership_mixin import ImmutableUserMembershipMixin
@@ -19,10 +18,7 @@
__all__ = ['CommentsetMembership']
-class CommentsetMembership(
- ImmutableUserMembershipMixin,
- db.Model, # type: ignore[name-defined]
-):
+class CommentsetMembership(ImmutableUserMembershipMixin, Model):
"""Membership roles for users who are commentset users and subscribers."""
__tablename__ = 'commentset_membership'
@@ -30,10 +26,10 @@ class CommentsetMembership(
__data_columns__ = ('last_seen_at', 'is_muted')
__roles__ = {
- 'subject': {
+ 'member': {
'read': {
'urls',
- 'user',
+ 'member',
'commentset',
'is_muted',
'last_seen_at',
@@ -42,46 +38,43 @@ class CommentsetMembership(
}
}
- commentset_id: sa.Column[sa.Integer] = immutable(
- sa.Column(
- sa.Integer,
- sa.ForeignKey('commentset.id', ondelete='CASCADE'),
- nullable=False,
- )
+ commentset_id: Mapped[int] = sa.orm.mapped_column(
+ sa.Integer,
+ sa.ForeignKey('commentset.id', ondelete='CASCADE'),
+ nullable=False,
)
- commentset: sa.orm.relationship[Commentset] = immutable(
- sa.orm.relationship(
- Commentset,
- backref=sa.orm.backref(
- 'subscriber_memberships',
- lazy='dynamic',
- cascade='all',
- passive_deletes=True,
- ),
- )
+ commentset: Mapped[Commentset] = relationship(
+ Commentset,
+ backref=backref(
+ 'subscriber_memberships',
+ lazy='dynamic',
+ cascade='all',
+ passive_deletes=True,
+ ),
)
- parent = sa.orm.synonym('commentset')
- parent_id = sa.orm.synonym('commentset_id')
+ parent_id: Mapped[int] = sa.orm.synonym('commentset_id')
+ parent_id_column = 'commentset_id'
+ parent: Mapped[Commentset] = sa.orm.synonym('commentset')
#: Flag to indicate notifications are muted
- is_muted = sa.Column(sa.Boolean, nullable=False, default=False)
+ is_muted = sa.orm.mapped_column(sa.Boolean, nullable=False, default=False)
#: When the user visited this commentset last
- last_seen_at = sa.Column(
+ last_seen_at = sa.orm.mapped_column(
sa.TIMESTAMP(timezone=True), nullable=False, default=sa.func.utcnow()
)
- new_comment_count = sa.orm.column_property(
- sa.select(sa.func.count(Comment.id)) # type: ignore[attr-defined]
+ new_comment_count: Mapped[int] = sa.orm.column_property(
+ sa.select(sa.func.count(Comment.id))
.where(Comment.commentset_id == commentset_id) # type: ignore[has-type]
.where(Comment.state.PUBLIC) # type: ignore[has-type]
.where(Comment.created_at > last_seen_at)
- .correlate_except(Comment) # type: ignore[arg-type]
- .scalar_subquery() # sqlalchemy-stubs doesn't know of this
+ .correlate_except(Comment)
+ .scalar_subquery()
)
@cached_property
- def offered_roles(self) -> Set[str]:
+ def offered_roles(self) -> set[str]:
"""
Roles offered by this membership record.
@@ -90,23 +83,23 @@ def offered_roles(self) -> Set[str]:
return {'document_subscriber'}
def update_last_seen_at(self) -> None:
- """Mark the subject user as having last seen this commentset just now."""
+ """Mark the member as having seen this commentset just now."""
self.last_seen_at = sa.func.utcnow()
@classmethod
- def for_user(cls, user: User) -> Query:
+ def for_user(cls, account: Account) -> Query[CommentsetMembership]:
"""
Return a query representing all active commentset memberships for a user.
This classmethod mirrors the functionality in
- :attr:`User.active_commentset_memberships` with the difference that since it's
- a query on the class, it returns an instance of the query subclass from
+ :attr:`Account.active_commentset_memberships` with the difference that since
+ it's a query on the class, it returns an instance of the query subclass from
Flask-SQLAlchemy and Coaster. Relationships use the main class from SQLAlchemy
which is missing pagination and the empty/notempty methods.
"""
return (
cls.query.filter(
- cls.user == user,
+ cls.member == account,
CommentsetMembership.is_active,
)
.join(Commentset)
@@ -121,14 +114,14 @@ def for_user(cls, user: User) -> Query:
)
-@reopen(User)
-class __User:
- active_commentset_memberships = sa.orm.relationship(
+@reopen(Account)
+class __Account:
+ active_commentset_memberships: DynamicMapped[CommentsetMembership] = relationship(
CommentsetMembership,
lazy='dynamic',
primaryjoin=sa.and_(
- CommentsetMembership.user_id == User.id, # type: ignore[has-type]
- CommentsetMembership.is_active, # type: ignore[arg-type]
+ CommentsetMembership.member_id == Account.id,
+ CommentsetMembership.is_active,
),
viewonly=True,
)
@@ -140,48 +133,48 @@ class __User:
@reopen(Commentset)
class __Commentset:
- active_memberships = sa.orm.relationship(
+ active_memberships: DynamicMapped[CommentsetMembership] = relationship(
CommentsetMembership,
lazy='dynamic',
primaryjoin=sa.and_(
CommentsetMembership.commentset_id == Commentset.id,
- CommentsetMembership.is_active, # type: ignore[arg-type]
+ CommentsetMembership.is_active,
),
viewonly=True,
)
# Send notifications only to subscribers who haven't muted
- active_memberships_unmuted = with_roles(
- sa.orm.relationship(
+ active_memberships_unmuted: DynamicMapped[CommentsetMembership] = with_roles(
+ relationship(
CommentsetMembership,
lazy='dynamic',
primaryjoin=sa.and_(
CommentsetMembership.commentset_id == Commentset.id,
- CommentsetMembership.is_active, # type: ignore[arg-type]
+ CommentsetMembership.is_active,
CommentsetMembership.is_muted.is_(False),
),
viewonly=True,
),
- grants_via={'user': {'document_subscriber'}},
+ grants_via={'member': {'document_subscriber'}},
)
- def update_last_seen_at(self, user: User) -> None:
+ def update_last_seen_at(self, member: Account) -> None:
subscription = CommentsetMembership.query.filter_by(
- commentset=self, user=user, is_active=True
+ commentset=self, member=member, is_active=True
).one_or_none()
if subscription is not None:
subscription.update_last_seen_at()
- def add_subscriber(self, actor: User, user: User) -> bool:
+ def add_subscriber(self, actor: Account, member: Account) -> bool:
"""Return True is subscriber is added or unmuted, False if already exists."""
changed = False
subscription = CommentsetMembership.query.filter_by(
- commentset=self, user=user, is_active=True
+ commentset=self, member=member, is_active=True
).one_or_none()
if subscription is None:
subscription = CommentsetMembership(
commentset=self,
- user=user,
+ member=member,
granted_by=actor,
)
db.session.add(subscription)
@@ -192,30 +185,30 @@ def add_subscriber(self, actor: User, user: User) -> bool:
subscription.update_last_seen_at()
return changed
- def mute_subscriber(self, actor: User, user: User) -> bool:
+ def mute_subscriber(self, actor: Account, member: Account) -> bool:
"""Return True if subscriber was muted, False if already muted or missing."""
subscription = CommentsetMembership.query.filter_by(
- commentset=self, user=user, is_active=True
+ commentset=self, member=member, is_active=True
).one_or_none()
if not subscription.is_muted:
subscription.replace(actor=actor, is_muted=True)
return True
return False
- def unmute_subscriber(self, actor: User, user: User) -> bool:
+ def unmute_subscriber(self, actor: Account, member: Account) -> bool:
"""Return True if subscriber was unmuted, False if not muted or missing."""
subscription = CommentsetMembership.query.filter_by(
- commentset=self, user=user, is_active=True
+ commentset=self, member=member, is_active=True
).one_or_none()
if subscription.is_muted:
subscription.replace(actor=actor, is_muted=False)
return True
return False
- def remove_subscriber(self, actor: User, user: User) -> bool:
+ def remove_subscriber(self, actor: Account, member: Account) -> bool:
"""Return True is subscriber is removed, False if already removed."""
subscription = CommentsetMembership.query.filter_by(
- commentset=self, user=user, is_active=True
+ commentset=self, member=member, is_active=True
).one_or_none()
if subscription is not None:
subscription.revoke(actor=actor)
diff --git a/funnel/models/contact_exchange.py b/funnel/models/contact_exchange.py
index db771cc0a..c9e18974b 100644
--- a/funnel/models/contact_exchange.py
+++ b/funnel/models/contact_exchange.py
@@ -2,23 +2,32 @@
from __future__ import annotations
+from collections.abc import Collection, Sequence
from dataclasses import dataclass
-from datetime import date as date_type
-from datetime import datetime
+from datetime import date as date_type, datetime
from itertools import groupby
-from typing import Collection, Iterable, Optional
from uuid import UUID
+from pytz import timezone
from sqlalchemy.ext.associationproxy import association_proxy
from coaster.sqlalchemy import LazyRoleSet
from coaster.utils import uuid_to_base58
-from ..typing import OptionalMigratedTables
-from . import RoleMixin, TimestampMixin, db, sa
+from . import (
+ Mapped,
+ Model,
+ Query,
+ RoleMixin,
+ TimestampMixin,
+ backref,
+ db,
+ relationship,
+ sa,
+)
+from .account import Account
from .project import Project
from .sync_ticket import TicketParticipant
-from .user import User
__all__ = ['ContactExchange']
@@ -44,21 +53,17 @@ class DateCountContacts:
contacts: Collection[ContactExchange]
-class ContactExchange(
- TimestampMixin,
- RoleMixin,
- db.Model, # type: ignore[name-defined]
-):
+class ContactExchange(TimestampMixin, RoleMixin, Model):
"""Model to track who scanned whose badge, in which project."""
__tablename__ = 'contact_exchange'
#: User who scanned this contact
- user_id = sa.Column(
- sa.Integer, sa.ForeignKey('user.id', ondelete='CASCADE'), primary_key=True
+ account_id: Mapped[int] = sa.orm.mapped_column(
+ sa.ForeignKey('account.id', ondelete='CASCADE'), primary_key=True
)
- user = sa.orm.relationship(
- User,
- backref=sa.orm.backref(
+ account: Mapped[Account] = relationship(
+ Account,
+ backref=backref(
'scanned_contacts',
lazy='dynamic',
order_by='ContactExchange.scanned_at.desc()',
@@ -66,29 +71,29 @@ class ContactExchange(
),
)
#: Participant whose contact was scanned
- ticket_participant_id = sa.Column(
+ ticket_participant_id = sa.orm.mapped_column(
sa.Integer,
sa.ForeignKey('ticket_participant.id', ondelete='CASCADE'),
primary_key=True,
index=True,
)
- ticket_participant = sa.orm.relationship(
+ ticket_participant: Mapped[TicketParticipant] = relationship(
TicketParticipant,
- backref=sa.orm.backref('scanned_contacts', passive_deletes=True),
+ backref=backref('scanned_contacts', passive_deletes=True),
)
#: Datetime at which the scan happened
- scanned_at = sa.Column(
+ scanned_at = sa.orm.mapped_column(
sa.TIMESTAMP(timezone=True), nullable=False, default=sa.func.utcnow()
)
#: Note recorded by the user (plain text)
- description = sa.Column(sa.UnicodeText, nullable=False, default='')
+ description = sa.orm.mapped_column(sa.UnicodeText, nullable=False, default='')
#: Archived flag
- archived = sa.Column(sa.Boolean, nullable=False, default=False)
+ archived = sa.orm.mapped_column(sa.Boolean, nullable=False, default=False)
__roles__ = {
'owner': {
'read': {
- 'user',
+ 'account',
'ticket_participant',
'scanned_at',
'description',
@@ -96,110 +101,115 @@ class ContactExchange(
},
'write': {'description', 'archived'},
},
- 'subject': {'read': {'user', 'ticket_participant', 'scanned_at'}},
+ 'subject': {'read': {'account', 'ticket_participant', 'scanned_at'}},
}
def roles_for(
- self, actor: Optional[User] = None, anchors: Iterable = ()
+ self, actor: Account | None = None, anchors: Sequence = ()
) -> LazyRoleSet:
roles = super().roles_for(actor, anchors)
if actor is not None:
- if actor == self.user:
+ if actor == self.account:
roles.add('owner')
- if actor == self.ticket_participant.user:
+ if actor == self.ticket_participant.participant:
roles.add('subject')
return roles
@classmethod
- def migrate_user( # type: ignore[return]
- cls, old_user: User, new_user: User
- ) -> OptionalMigratedTables:
- """Migrate one user account to another when merging user accounts."""
+ def migrate_account(cls, old_account: Account, new_account: Account) -> None:
+ """Migrate one account's data to another when merging accounts."""
ticket_participant_ids = {
- ce.ticket_participant_id for ce in new_user.scanned_contacts
+ ce.ticket_participant_id for ce in new_account.scanned_contacts
}
- for ce in old_user.scanned_contacts:
+ for ce in old_account.scanned_contacts:
if ce.ticket_participant_id not in ticket_participant_ids:
- ce.user = new_user
+ ce.account = new_account
else:
# Discard duplicate contact exchange
db.session.delete(ce)
@classmethod
- def grouped_counts_for(cls, user, archived=False):
+ def grouped_counts_for(
+ cls, account: Account, archived: bool = False
+ ) -> list[tuple[ProjectId, list[DateCountContacts]]]:
"""Return count of contacts grouped by project and date."""
- query = db.session.query(
- cls.scanned_at, Project.id, Project.uuid, Project.timezone, Project.title
+ subq = sa.select(
+ cls.scanned_at.label('scanned_at'),
+ Project.id.label('project_id'),
+ Project.uuid.label('project_uuid'),
+ Project.timezone.label('project_timezone'),
+ Project.title.label('project_title'),
).filter(
cls.ticket_participant_id == TicketParticipant.id,
TicketParticipant.project_id == Project.id,
- cls.user == user,
+ cls.account == account,
)
if not archived:
# If archived: return everything (contacts including archived contacts)
# If not archived: return only unarchived contacts
- query = query.filter(cls.archived.is_(False))
+ subq = subq.filter(cls.archived.is_(False))
- # from_self turns `SELECT columns` into `SELECT new_columns FROM (SELECT
- # columns)`
query = (
- query.from_self(
- Project.id.label('id'),
- Project.uuid.label('uuid'),
- Project.title.label('title'),
- Project.timezone.label('timezone'),
+ db.session.query(
+ sa.column('project_id'),
+ sa.column('project_uuid'),
+ sa.column('project_title'),
+ sa.column('project_timezone'),
sa.cast(
sa.func.date_trunc(
- 'day', sa.func.timezone(Project.timezone, cls.scanned_at)
+ 'day',
+ sa.func.timezone(
+ sa.column('project_timezone'), sa.column('scanned_at')
+ ),
),
sa.Date,
- ).label('date'),
+ ).label('scan_date'),
sa.func.count().label('count'),
)
+ .select_from(subq.subquery())
.group_by(
- sa.text('id'),
- sa.text('uuid'),
- sa.text('title'),
- sa.text('timezone'),
- sa.text('date'),
+ sa.column('project_id'),
+ sa.column('project_uuid'),
+ sa.column('project_title'),
+ sa.column('project_timezone'),
+ sa.column('scan_date'),
)
- .order_by(sa.text('date DESC'))
+ .order_by(sa.text('scan_date DESC'))
)
# Issued SQL:
#
# SELECT
- # project_id AS id,
- # project_uuid AS uuid,
- # project_title AS title,
- # project_timezone AS "timezone",
- # date_trunc(
- # 'day',
- # timezone("timezone", contact_exchange_scanned_at)
- # )::date AS date,
+ # project_id,
+ # project_uuid,
+ # project_title,
+ # project_timezone,
+ # CAST(
+ # date_trunc('day', timezone(project_timezone, scanned_at))
+ # AS DATE
+ # ) AS scan_date,
# count(*) AS count
# FROM (
# SELECT
- # contact_exchange.scanned_at AS contact_exchange_scanned_at,
+ # contact_exchange.scanned_at AS scanned_at,
# project.id AS project_id,
# project.uuid AS project_uuid,
- # project.title AS project_title,
- # project.timezone AS project_timezone
- # FROM contact_exchange, ticket_participant, project
+ # project.timezone AS project_timezone,
+ # project.title AS project_title
+ # FROM contact_exchange, project, ticket_participant
# WHERE
# contact_exchange.ticket_participant_id = ticket_participant.id
# AND ticket_participant.project_id = project.id
- # AND contact_exchange.user_id = :user_id
+ # AND :account_id = contact_exchange.account_id
+ # AND contact_exchange.archived IS false
# ) AS anon_1
- # GROUP BY id, uuid, title, timezone, date
- # ORDER BY date DESC;
+ # GROUP BY project_id, project_uuid, project_title, project_timezone, scan_date
+ # ORDER BY scan_date DESC
- # Our query result looks like this:
- # [(id, uuid, title, timezone, date, count), ...]
- # where (id, uuid, title, timezone) repeat for each date
- #
- # Transform it into this:
+ # The query result has rows of:
+ # (project_id, project_uuid, project_title, project_timezone, scan_date, count)
+ # with one row per date. It is then transformed into:
# [
# (ProjectId(id, uuid, uuid_b58, title, timezone), [
# DateCountContacts(date, count, contacts),
@@ -210,18 +220,18 @@ def grouped_counts_for(cls, user, archived=False):
# ]
# We don't do it here, but this can easily be converted into a dictionary of
- # {project: dates}:
- # >>> OrderedDict(result) # Preserve order with most recent projects first
- # >>> dict(result) # Don't preserve order
+ # `{project: dates}` using `dict(result)`
groups = [
(
k,
[
DateCountContacts(
- r.date,
+ r.scan_date,
r.count,
- cls.contacts_for_project_and_date(user, k, r.date, archived),
+ cls.contacts_for_project_and_date(
+ account, k, r.scan_date, archived
+ ),
)
for r in g
],
@@ -229,7 +239,11 @@ def grouped_counts_for(cls, user, archived=False):
for k, g in groupby(
query,
lambda r: ProjectId(
- r.id, r.uuid, uuid_to_base58(r.uuid), r.title, r.timezone
+ id=r.project_id,
+ uuid=r.project_uuid,
+ uuid_b58=uuid_to_base58(r.project_uuid),
+ title=r.project_title,
+ timezone=timezone(r.project_timezone),
),
)
]
@@ -238,11 +252,11 @@ def grouped_counts_for(cls, user, archived=False):
@classmethod
def contacts_for_project_and_date(
- cls, user: User, project: Project, date: date_type, archived=False
- ):
+ cls, account: Account, project: Project, date: date_type, archived: bool = False
+ ) -> Query[ContactExchange]:
"""Return contacts for a given user, project and date."""
query = cls.query.join(TicketParticipant).filter(
- cls.user == user,
+ cls.account == account,
# For safety always use objects instead of column values. The following
# expression should have been `Participant.project == project`. However, we
# are using `id` here because `project` may be an instance of ProjectId
@@ -264,10 +278,12 @@ def contacts_for_project_and_date(
return query
@classmethod
- def contacts_for_project(cls, user, project, archived=False):
+ def contacts_for_project(
+ cls, account: Account, project: Project, archived: bool = False
+ ) -> Query[ContactExchange]:
"""Return contacts for a given user and project."""
query = cls.query.join(TicketParticipant).filter(
- cls.user == user,
+ cls.account == account,
# See explanation for the following expression in
# `contacts_for_project_and_date`
TicketParticipant.project_id == project.id,
@@ -279,4 +295,4 @@ def contacts_for_project(cls, user, project, archived=False):
return query
-TicketParticipant.scanning_users = association_proxy('scanned_contacts', 'user')
+TicketParticipant.scanning_users = association_proxy('scanned_contacts', 'account')
diff --git a/funnel/models/draft.py b/funnel/models/draft.py
index bc11297dc..d51f79b92 100644
--- a/funnel/models/draft.py
+++ b/funnel/models/draft.py
@@ -2,29 +2,31 @@
from __future__ import annotations
+from uuid import UUID
+
from werkzeug.datastructures import MultiDict
-from . import NoIdMixin, UUIDType, db, json_type, sa
+from . import Mapped, Model, NoIdMixin, sa, types
__all__ = ['Draft']
-class Draft(NoIdMixin, db.Model): # type: ignore[name-defined]
+class Draft(NoIdMixin, Model):
"""Store for autosaved, unvalidated drafts on behalf of other models."""
__tablename__ = 'draft'
- table = sa.Column(sa.UnicodeText, primary_key=True)
- table_row_id = sa.Column(UUIDType(binary=False), primary_key=True)
- body = sa.Column(json_type, nullable=False, server_default='{}')
- revision = sa.Column(UUIDType(binary=False))
+ table: Mapped[types.text] = sa.orm.mapped_column(primary_key=True)
+ table_row_id: Mapped[UUID] = sa.orm.mapped_column(primary_key=True)
+ body: Mapped[types.jsonb_dict | None] # Optional only when instance is new
+ revision: Mapped[UUID | None]
@property
- def formdata(self):
- return MultiDict(self.body.get('form', {}))
+ def formdata(self) -> MultiDict:
+ return MultiDict(self.body.get('form', {}) if self.body is not None else {})
@formdata.setter
- def formdata(self, value):
+ def formdata(self, value: MultiDict | dict) -> None:
if self.body is not None:
self.body['form'] = value
else:
diff --git a/funnel/models/email_address.py b/funnel/models/email_address.py
index 51396cba8..986f41be2 100644
--- a/funnel/models/email_address.py
+++ b/funnel/models/email_address.py
@@ -2,35 +2,35 @@
from __future__ import annotations
-from typing import Any, List, Optional, Set, Union, cast, overload
import hashlib
import unicodedata
+from typing import TYPE_CHECKING, Any, ClassVar, Literal, cast, overload
+import base58
+import idna
+from pyisemail import is_email
+from pyisemail.diagnosis import BaseDiagnosis
from sqlalchemy import event, inspect
-from sqlalchemy.orm import mapper
+from sqlalchemy.orm import Mapper
from sqlalchemy.orm.attributes import NO_VALUE
-from sqlalchemy.sql.expression import ColumnElement
-
from werkzeug.utils import cached_property
-from pyisemail import is_email
-from pyisemail.diagnosis import BaseDiagnosis
-from typing_extensions import Literal
-import base58
-import idna
-
-from coaster.sqlalchemy import (
- Query,
- StateManager,
- auto_init_default,
- immutable,
- with_roles,
-)
+from coaster.sqlalchemy import StateManager, auto_init_default, immutable, with_roles
from coaster.utils import LabeledEnum, require_one_of
from ..signals import emailaddress_refcount_dropping
-from ..typing import Mapped
-from . import BaseMixin, db, declarative_mixin, declared_attr, hybrid_property, sa
+from . import (
+ BaseMixin,
+ Mapped,
+ Model,
+ Query,
+ db,
+ declarative_mixin,
+ declared_attr,
+ hybrid_property,
+ relationship,
+ sa,
+)
__all__ = [
'EMAIL_DELIVERY_STATE',
@@ -63,7 +63,7 @@ class EMAIL_DELIVERY_STATE(LabeledEnum): # noqa: N801
HARD_FAIL = (5, 'hard_fail') # Hard fail reported
-def canonical_email_representation(email: str) -> List[str]:
+def canonical_email_representation(email: str) -> list[str]:
"""
Construct canonical representations of the email address, for deduplication.
@@ -148,16 +148,17 @@ class EmailAddressInUseError(EmailAddressError):
"""Email address is in use by another owner."""
-class EmailAddress(BaseMixin, db.Model): # type: ignore[name-defined]
+class EmailAddress(BaseMixin, Model):
"""
Represents an email address as a standalone entity, with associated metadata.
Prior to this model, email addresses were regarded as properties of other models.
- Specifically: Proposal.email, Participant.email, User.emails and User.emailclaims,
- the latter two lists populated using the UserEmail and UserEmailClaim join models.
- This subordination made it difficult to track ownership of an email address or its
- reachability (active, bouncing, etc). Having EmailAddress as a standalone model
- (with incoming foreign keys) provides some sanity:
+ Specifically: Proposal.email, Participant.email, Account.emails and
+ Account.emailclaims, the latter two lists populated using the AccountEmail and
+ AccountEmailClaim join models. This subordination made it difficult to track
+ ownership of an email address or its reachability (active, bouncing, etc). Having
+ EmailAddress as a standalone model (with incoming foreign keys) provides some
+ sanity:
1. Email addresses are stored with a hash, and always looked up using the hash. This
allows the address to be forgotten while preserving the record for metadata.
@@ -168,7 +169,7 @@ class EmailAddress(BaseMixin, db.Model): # type: ignore[name-defined]
4. If there is abuse, an email address can be comprehensively blocked using its
canonical representation, which prevents the address from being used even via
its ``+sub-address`` variations.
- 5. Via :class:`EmailAddressMixin`, the UserEmail model can establish ownership of
+ 5. Via :class:`EmailAddressMixin`, the AccountEmail model can establish ownership of
an email address on behalf of a user, placing an automatic block on its use by
other users. This mechanism is not limited to users. A future OrgEmail link can
establish ownership on behalf of an organization.
@@ -182,17 +183,17 @@ class EmailAddress(BaseMixin, db.Model): # type: ignore[name-defined]
#: Backrefs to this model from other models, populated by :class:`EmailAddressMixin`
#: Contains the name of the relationship in the :class:`EmailAddress` model
- __backrefs__: Set[str] = set()
+ __backrefs__: ClassVar[set[str]] = set()
#: These backrefs claim exclusive use of the email address for their linked owner.
#: See :class:`EmailAddressMixin` for implementation detail
- __exclusive_backrefs__: Set[str] = set()
+ __exclusive_backrefs__: ClassVar[set[str]] = set()
#: The email address, centrepiece of this model. Case preserving.
#: Validated by the :func:`_validate_email` event handler
- email = sa.Column(sa.Unicode, nullable=True)
+ email = sa.orm.mapped_column(sa.Unicode, nullable=True)
#: The domain of the email, stored for quick lookup of related addresses
#: Read-only, accessible via the :property:`domain` property
- _domain = sa.Column('domain', sa.Unicode, nullable=True, index=True)
+ _domain = sa.orm.mapped_column('domain', sa.Unicode, nullable=True, index=True)
# email_normalized is defined below
@@ -200,10 +201,10 @@ class EmailAddress(BaseMixin, db.Model): # type: ignore[name-defined]
#: email is removed. SQLAlchemy type LargeBinary maps to PostgreSQL BYTEA. Despite
#: the name, we're only storing 20 bytes
blake2b160 = immutable(
- sa.Column(
+ sa.orm.mapped_column(
sa.LargeBinary,
sa.CheckConstraint(
- sa.func.length(sa.sql.column('blake2b160')) == 20,
+ 'LENGTH(blake2b160) = 20',
name='email_address_blake2b160_check',
),
nullable=False,
@@ -215,11 +216,11 @@ class EmailAddress(BaseMixin, db.Model): # type: ignore[name-defined]
#: email detection. Indexed but does not use a unique constraint because a+b@tld and
#: a+c@tld are both a@tld canonically but can exist in records separately.
blake2b160_canonical = immutable(
- sa.Column(sa.LargeBinary, nullable=False, index=True)
+ sa.orm.mapped_column(sa.LargeBinary, nullable=False, index=True)
)
#: Does this email address work? Records last known delivery state
- _delivery_state = sa.Column(
+ _delivery_state = sa.orm.mapped_column(
'delivery_state',
sa.Integer,
StateManager.check_constraint(
@@ -236,18 +237,20 @@ class EmailAddress(BaseMixin, db.Model): # type: ignore[name-defined]
doc="Last known delivery state of this email address",
)
#: Timestamp of last known delivery state
- delivery_state_at = sa.Column(
+ delivery_state_at = sa.orm.mapped_column(
sa.TIMESTAMP(timezone=True), nullable=False, default=sa.func.utcnow()
)
#: Timestamp of last known recipient activity resulting from sent mail
- active_at = sa.Column(sa.TIMESTAMP(timezone=True), nullable=True)
+ active_at = sa.orm.mapped_column(sa.TIMESTAMP(timezone=True), nullable=True)
#: Is this email address blocked from being used? If so, :attr:`email` should be
#: null. Blocks apply to the canonical address (without the +sub-address variation),
#: so a test for whether an address is blocked should use blake2b160_canonical to
#: load the record. Other records with the same canonical hash _may_ exist without
#: setting the flag due to a lack of database-side enforcement
- _is_blocked = sa.Column('is_blocked', sa.Boolean, nullable=False, default=False)
+ _is_blocked = sa.orm.mapped_column(
+ 'is_blocked', sa.Boolean, nullable=False, default=False
+ )
__table_args__ = (
# `domain` must be lowercase always. Note that Python `.lower()` is not
@@ -258,8 +261,8 @@ class EmailAddress(BaseMixin, db.Model): # type: ignore[name-defined]
),
# If `is_blocked` is True, `email` and `domain` must be None
sa.CheckConstraint(
- sa.or_( # type: ignore[arg-type]
- _is_blocked.isnot(True),
+ sa.or_(
+ _is_blocked.is_not(True),
sa.and_(_is_blocked.is_(True), email.is_(None), _domain.is_(None)),
),
'email_address_email_is_blocked_check',
@@ -269,7 +272,7 @@ class EmailAddress(BaseMixin, db.Model): # type: ignore[name-defined]
# easy way to do an IDN match in Postgres without an extension.
# `_` and `%` must be escaped as they are wildcards to the LIKE/ILIKE operator
sa.CheckConstraint(
- sa.or_( # type: ignore[arg-type]
+ sa.or_(
# email and domain must both be non-null, or
sa.and_(email.is_(None), _domain.is_(None)),
# domain must be an IDN, or
@@ -296,19 +299,19 @@ def is_blocked(self) -> bool:
return self._is_blocked
@hybrid_property
- def domain(self) -> Optional[str]:
+ def domain(self) -> str | None:
"""Domain of the email, stored for quick lookup of related addresses."""
return self._domain
# This should not use `cached_property` as email is partially mutable
@property
- def email_normalized(self) -> Optional[str]:
+ def email_normalized(self) -> str | None:
"""Return normalized representation of the email address, for hashing."""
return email_normalized(self.email) if self.email else None
# This should not use `cached_property` as email is partially mutable
@property
- def email_canonical(self) -> Optional[str]:
+ def email_canonical(self) -> str | None:
"""
Email address with the ``+sub-address`` portion of the mailbox removed.
@@ -331,12 +334,11 @@ def email_hash(self) -> str:
transport_hash = email_hash
@with_roles(call={'all'})
- def md5(self) -> Optional[str]:
+ def md5(self) -> str | None:
"""MD5 hash of :property:`email_normalized`, for legacy use only."""
- # TODO: After upgrading to Python 3.9, use usedforsecurity=False
return (
- hashlib.md5( # nosec # skipcq: PTC-W1003
- self.email_normalized.encode('utf-8')
+ hashlib.md5(
+ self.email_normalized.encode('utf-8'), usedforsecurity=False
).hexdigest()
if self.email_normalized
else None
@@ -346,11 +348,18 @@ def __str__(self) -> str:
"""Cast email address into a string."""
return self.email or ''
+ def __format__(self, format_spec: str) -> str:
+ """Format the email address."""
+ if not format_spec:
+ return self.__str__()
+ return self.__str__().__format__(format_spec)
+
def __repr__(self) -> str:
"""Debugging representation of the email address."""
return f'EmailAddress({self.email!r})'
def __init__(self, email: str) -> None:
+ super().__init__()
if not isinstance(email, str):
raise ValueError("A string email address is required")
# Set the hash first so the email column validator passes. Both hash columns
@@ -372,8 +381,8 @@ def is_exclusive(self) -> bool:
for related_obj in getattr(self, backref_name)
)
- def is_available_for(self, owner: object) -> bool:
- """Return True if this EmailAddress is available for the given owner."""
+ def is_available_for(self, owner: Account | None) -> bool:
+ """Return True if this EmailAddress is available for the proposed owner."""
for backref_name in self.__exclusive_backrefs__:
for related_obj in getattr(self, backref_name):
curr_owner = getattr(related_obj, related_obj.__email_for__)
@@ -426,17 +435,17 @@ def mark_blocked(cls, email: str) -> None:
@overload
@classmethod
- def get_filter(cls, *, email: str) -> Optional[ColumnElement]:
+ def get_filter(cls, *, email: str) -> sa.ColumnElement[bool] | None:
...
@overload
@classmethod
- def get_filter(cls, *, blake2b160: bytes) -> ColumnElement:
+ def get_filter(cls, *, blake2b160: bytes) -> sa.ColumnElement[bool]:
...
@overload
@classmethod
- def get_filter(cls, *, email_hash: str) -> ColumnElement:
+ def get_filter(cls, *, email_hash: str) -> sa.ColumnElement[bool]:
...
@overload
@@ -444,20 +453,20 @@ def get_filter(cls, *, email_hash: str) -> ColumnElement:
def get_filter(
cls,
*,
- email: Optional[str],
- blake2b160: Optional[bytes],
- email_hash: Optional[str],
- ) -> Optional[ColumnElement]:
+ email: str | None,
+ blake2b160: bytes | None,
+ email_hash: str | None,
+ ) -> sa.ColumnElement[bool] | None:
...
@classmethod
def get_filter(
cls,
*,
- email: Optional[str] = None,
- blake2b160: Optional[bytes] = None,
- email_hash: Optional[str] = None,
- ) -> Optional[ColumnElement]:
+ email: str | None = None,
+ blake2b160: bytes | None = None,
+ email_hash: str | None = None,
+ ) -> sa.ColumnElement[bool] | None:
"""
Get an filter condition for retriving an :class:`EmailAddress`.
@@ -480,7 +489,7 @@ def get_filter(
def get(
cls,
email: str,
- ) -> Optional[EmailAddress]:
+ ) -> EmailAddress | None:
...
@overload
@@ -489,7 +498,7 @@ def get(
cls,
*,
blake2b160: bytes,
- ) -> Optional[EmailAddress]:
+ ) -> EmailAddress | None:
...
@overload
@@ -498,17 +507,17 @@ def get(
cls,
*,
email_hash: str,
- ) -> Optional[EmailAddress]:
+ ) -> EmailAddress | None:
...
@classmethod
def get(
cls,
- email: Optional[str] = None,
+ email: str | None = None,
*,
- blake2b160: Optional[bytes] = None,
- email_hash: Optional[str] = None,
- ) -> Optional[EmailAddress]:
+ blake2b160: bytes | None = None,
+ email_hash: str | None = None,
+ ) -> EmailAddress | None:
"""
Get an :class:`EmailAddress` instance by email address or its hash.
@@ -519,7 +528,9 @@ def get(
).one_or_none()
@classmethod
- def get_canonical(cls, email: str, is_blocked: Optional[bool] = None) -> Query:
+ def get_canonical(
+ cls, email: str, is_blocked: bool | None = None
+ ) -> Query[EmailAddress]:
"""
Get :class:`EmailAddress` instances matching the canonical representation.
@@ -535,7 +546,7 @@ def get_canonical(cls, email: str, is_blocked: Optional[bool] = None) -> Query:
return query
@classmethod
- def _get_existing(cls, email: str) -> Optional[EmailAddress]:
+ def _get_existing(cls, email: str) -> EmailAddress | None:
"""
Get an existing :class:`EmailAddress` instance.
@@ -569,7 +580,7 @@ def add(cls, email: str) -> EmailAddress:
return new_email
@classmethod
- def add_for(cls, owner: Optional[object], email: str) -> EmailAddress:
+ def add_for(cls, owner: Account | None, email: str) -> EmailAddress:
"""
Create a new :class:`EmailAddress` after validation.
@@ -590,29 +601,37 @@ def add_for(cls, owner: Optional[object], email: str) -> EmailAddress:
@classmethod
def validate_for(
cls,
- owner: Optional[object],
+ owner: Account | None,
email: str,
check_dns: bool = False,
new: bool = False,
- ) -> Union[
- bool,
+ ) -> (
Literal[
- 'nomx', 'not_new', 'soft_fail', 'hard_fail', 'invalid', 'nullmx', 'blocked'
- ],
- ]:
+ 'taken',
+ 'nomx',
+ 'not_new',
+ 'soft_fail',
+ 'hard_fail',
+ 'invalid',
+ 'nullmx',
+ 'blocked',
+ ]
+ | None
+ ):
"""
- Validate whether the email address is available to the given owner.
+ Validate whether the email address is available to the proposed owner.
- Returns False if the address is blocked or in use by another owner, True if
- available without issues, or a string value indicating the concern:
+ Returns None if available without issues, or a string value indicating the
+ concern:
- 1. 'nomx': Email address is available, but has no MX records
- 2. 'not_new': Email address is already attached to owner (if `new` is True)
- 3. 'soft_fail': Known to be soft bouncing, requiring a warning message
- 4. 'hard_fail': Known to be hard bouncing, usually a validation failure
- 5. 'invalid': Available, but failed syntax validation
- 6. 'nullmx': Available, but host explicitly says they will not accept email
- 7. 'blocked': Email address is blocked from use
+ 1. 'taken': Email address has another owner
+ 2. 'nomx': Email address is available, but has no MX records
+ 3. 'not_new': Email address is already attached to owner (if `new` is True)
+ 4. 'soft_fail': Known to be soft bouncing, requiring a warning message
+ 5. 'hard_fail': Known to be hard bouncing, usually a validation failure
+ 6. 'invalid': Available, but failed syntax validation
+ 7. 'nullmx': Available, but host explicitly says they will not accept email
+ 8. 'blocked': Email address is blocked from use
:param owner: Proposed owner of this email address (may be None)
:param email: Email address to validate
@@ -628,8 +647,8 @@ def validate_for(
email, check_dns=check_dns, diagnose=True
)
if diagnosis is True:
- # No problems
- return True
+ # There is no existing record, and the email address has no problems
+ return None
# get_canonical won't return False when diagnose=True. Tell mypy:
if cast(BaseDiagnosis, diagnosis).diagnosis_type == 'NO_MX_RECORD':
return 'nomx'
@@ -638,10 +657,10 @@ def validate_for(
return 'invalid'
# There's an existing? Is it available for this owner?
if not existing.is_available_for(owner):
- # Not available, so return False
- return False
+ # Already taken by another owner
+ return 'taken'
- # Available. Any other concerns?
+ # There is an existing but it's available for this owner. Any other concerns?
if new:
# Caller is asking to confirm this is not already belonging to this owner
if existing.is_exclusive():
@@ -652,12 +671,12 @@ def validate_for(
return 'soft_fail'
if existing.delivery_state.HARD_FAIL:
return 'hard_fail'
- return True
+ return None
@staticmethod
def is_valid_email_address(
email: str, check_dns: bool = False, diagnose: bool = False
- ) -> Union[bool, BaseDiagnosis]:
+ ) -> bool | BaseDiagnosis:
"""
Return True if given email address is syntactically valid.
@@ -689,21 +708,20 @@ class EmailAddressMixin:
__tablename__: str
#: This class has an optional dependency on EmailAddress
- __email_optional__: bool = True
+ __email_optional__: ClassVar[bool] = True
#: This class has a unique constraint on the fkey to EmailAddress
- __email_unique__: bool = False
+ __email_unique__: ClassVar[bool] = False
#: A relationship from this model is for the (single) owner at this attr
- __email_for__: Optional[str] = None
+ __email_for__: ClassVar[str | None] = None
#: If `__email_for__` is specified and this flag is True, the email address is
#: considered exclusive to this owner and may not be used by any other owner
- __email_is_exclusive__: bool = False
+ __email_is_exclusive__: ClassVar[bool] = False
@declared_attr
- def email_address_id( # pylint: disable=no-self-argument
- cls,
- ) -> sa.Column[int]:
+ @classmethod
+ def email_address_id(cls) -> Mapped[int | None]:
"""Foreign key to email_address table."""
- return sa.Column(
+ return sa.orm.mapped_column(
sa.Integer,
sa.ForeignKey('email_address.id', ondelete='SET NULL'),
nullable=cls.__email_optional__,
@@ -712,55 +730,48 @@ def email_address_id( # pylint: disable=no-self-argument
)
@declared_attr
- def email_address( # pylint: disable=no-self-argument
- cls,
- ) -> sa.orm.relationship[EmailAddress]:
+ @classmethod
+ def email_address(cls) -> Mapped[EmailAddress]:
"""Instance of :class:`EmailAddress` as a relationship."""
backref_name = 'used_in_' + cls.__tablename__
EmailAddress.__backrefs__.add(backref_name)
if cls.__email_for__ and cls.__email_is_exclusive__:
EmailAddress.__exclusive_backrefs__.add(backref_name)
- return sa.orm.relationship(EmailAddress, backref=backref_name)
-
- @declared_attr
- def email(cls) -> Mapped[Optional[str]]: # pylint: disable=no-self-argument
- """Shorthand for ``self.email_address.email``."""
-
- def email_get(self) -> Optional[str]:
- """
- Shorthand for ``self.email_address.email``.
-
- Setting a value does the equivalent of one of these, depending on whether
- the object requires the email address to be available to its owner::
+ return relationship(EmailAddress, backref=backref_name)
- self.email_address = EmailAddress.add(email)
- self.email_address = EmailAddress.add_for(owner, email)
+ @property
+ def email(self) -> str | None:
+ """
+ Shorthand for ``self.email_address.email``.
- Where the owner is found from the attribute named in `cls.__email_for__`.
- """
- if self.email_address:
- return self.email_address.email
- return None
+ Setting a value does the equivalent of one of these, depending on whether
+ the object requires the email address to be available to its owner::
- if cls.__email_for__:
+ self.email_address = EmailAddress.add(email)
+ self.email_address = EmailAddress.add_for(owner, email)
- def email_set(self, value):
- if value is not None:
- self.email_address = EmailAddress.add_for(
- getattr(self, cls.__email_for__), value
- )
- else:
- self.email_address = None
+ Where the owner is found from the attribute named in `cls.__email_for__`.
+ """
+ if self.email_address:
+ return self.email_address.email
+ return None
+
+ @email.setter
+ def email(self, value: str | None) -> None:
+ """Set an email address."""
+ if self.__email_for__:
+ if value is not None:
+ self.email_address = EmailAddress.add_for(
+ getattr(self, self.__email_for__), value
+ )
+ else:
+ self.email_address = None
else:
-
- def email_set(self, value):
- if value is not None:
- self.email_address = EmailAddress.add(value)
- else:
- self.email_address = None
-
- return property(fget=email_get, fset=email_set)
+ if value is not None:
+ self.email_address = EmailAddress.add(value)
+ else:
+ self.email_address = None
@property
def email_address_reference_is_active(self) -> bool:
@@ -773,7 +784,7 @@ def email_address_reference_is_active(self) -> bool:
return True
@property
- def transport_hash(self) -> Optional[str]:
+ def transport_hash(self) -> str | None:
"""Email hash using the compatibility name for notifications framework."""
return (
self.email_address.email_hash
@@ -788,7 +799,9 @@ def transport_hash(self) -> Optional[str]:
@event.listens_for(EmailAddress.email, 'set')
-def _validate_email(target, value: Any, old_value: Any, initiator) -> None:
+def _validate_email(
+ target: EmailAddress, value: Any, old_value: Any, _initiator: Any
+) -> None:
# First: check if value is acceptable and email attribute can be set
if not value and value is not None:
# Only `None` is an acceptable falsy value
@@ -836,16 +849,20 @@ def _validate_email(target, value: Any, old_value: Any, initiator) -> None:
# We don't have to set target.email because SQLAlchemy will do that for us.
-def _send_refcount_event_remove(target, value, initiator):
+def _send_refcount_event_remove(
+ target: EmailAddress, _value: Any, _initiator: Any
+) -> None:
emailaddress_refcount_dropping.send(target)
-def _send_refcount_event_before_delete(mapper_, connection, target):
+def _send_refcount_event_before_delete(
+ _mapper: Any, _connection: Any, target: EmailAddressMixin
+) -> None:
if target.email_address:
emailaddress_refcount_dropping.send(target.email_address)
-@event.listens_for(mapper, 'after_configured')
+@event.listens_for(Mapper, 'after_configured')
def _setup_refcount_events() -> None:
for backref_name in EmailAddress.__backrefs__:
attr = getattr(EmailAddress, backref_name)
@@ -853,7 +870,10 @@ def _setup_refcount_events() -> None:
def _email_address_mixin_set_validator(
- target, value: Optional[EmailAddress], old_value, initiator
+ target: EmailAddressMixin,
+ value: EmailAddress | None,
+ old_value: EmailAddress | None,
+ _initiator: Any,
) -> None:
if value != old_value and target.__email_for__:
if value is not None:
@@ -865,8 +885,11 @@ def _email_address_mixin_set_validator(
@event.listens_for(EmailAddressMixin, 'mapper_configured', propagate=True)
def _email_address_mixin_configure_events(
- mapper_,
- cls: db.Model, # type: ignore[name-defined]
-):
+ _mapper: Any, cls: type[EmailAddressMixin]
+) -> None:
event.listen(cls.email_address, 'set', _email_address_mixin_set_validator)
event.listen(cls, 'before_delete', _send_refcount_event_before_delete)
+
+
+if TYPE_CHECKING:
+ from .account import Account
diff --git a/funnel/models/geoname.py b/funnel/models/geoname.py
index 93a7fedde..b4726675f 100644
--- a/funnel/models/geoname.py
+++ b/funnel/models/geoname.py
@@ -2,16 +2,27 @@
from __future__ import annotations
-from typing import Collection, Dict, List, Optional, Union, cast
import re
+from collections.abc import Collection
+from decimal import Decimal
+from typing import cast
from sqlalchemy.dialects.postgresql import ARRAY
-from sqlalchemy.orm import joinedload
-from coaster.sqlalchemy import Query
from coaster.utils import make_name
-from . import BaseMixin, BaseNameMixin, Mapped, db, sa
+from . import (
+ BaseMixin,
+ BaseNameMixin,
+ GeonameModel,
+ Mapped,
+ Query,
+ backref,
+ db,
+ relationship,
+ sa,
+ types,
+)
from .helpers import quote_autocomplete_like
__all__ = ['GeoName', 'GeoCountryInfo', 'GeoAdmin1Code', 'GeoAdmin2Code', 'GeoAltName']
@@ -31,36 +42,41 @@
}
-class GeoCountryInfo(BaseNameMixin, db.Model): # type: ignore[name-defined]
+class GeoCountryInfo(BaseNameMixin, GeonameModel):
"""Geoname record for a country."""
__tablename__ = 'geo_country_info'
- __bind_key__ = 'geoname'
- geonameid = sa.orm.synonym('id')
- geoname = sa.orm.relationship(
+ geonameid: Mapped[int] = sa.orm.synonym('id')
+ geoname: Mapped[GeoName | None] = relationship(
'GeoName',
uselist=False,
primaryjoin='GeoCountryInfo.id == foreign(GeoName.id)',
backref='has_country',
)
- iso_alpha2 = sa.Column(sa.CHAR(2), unique=True)
- iso_alpha3 = sa.Column(sa.CHAR(3), unique=True)
- iso_numeric = sa.Column(sa.Integer)
- fips_code = sa.Column(sa.Unicode(3))
- capital = sa.Column(sa.Unicode)
- area_in_sqkm = sa.Column(sa.Numeric)
- population = sa.Column(sa.BigInteger)
- continent = sa.Column(sa.CHAR(2))
- tld = sa.Column(sa.Unicode(3))
- currency_code = sa.Column(sa.CHAR(3))
- currency_name = sa.Column(sa.Unicode)
- phone = sa.Column(sa.Unicode(16))
- postal_code_format = sa.Column(sa.Unicode)
- postal_code_regex = sa.Column(sa.Unicode)
- languages = sa.Column(ARRAY(sa.Unicode, dimensions=1))
- neighbours = sa.Column(ARRAY(sa.CHAR(2), dimensions=1))
- equivalent_fips_code = sa.Column(sa.Unicode(3))
+ iso_alpha2: Mapped[types.char2 | None] = sa.orm.mapped_column(
+ sa.CHAR(2), unique=True
+ )
+ iso_alpha3: Mapped[types.char3 | None] = sa.orm.mapped_column(unique=True)
+ iso_numeric: Mapped[int | None]
+ fips_code: Mapped[types.str3 | None]
+ capital: Mapped[str | None]
+ area_in_sqkm: Mapped[Decimal | None]
+ population: Mapped[types.bigint | None]
+ continent: Mapped[types.char2 | None]
+ tld: Mapped[types.str3 | None]
+ currency_code: Mapped[types.char3 | None]
+ currency_name: Mapped[str | None]
+ phone: Mapped[types.str16 | None]
+ postal_code_format: Mapped[types.unicode | None]
+ postal_code_regex: Mapped[types.unicode | None]
+ languages: Mapped[list[str] | None] = sa.orm.mapped_column(
+ ARRAY(sa.Unicode, dimensions=1)
+ )
+ neighbours: Mapped[list[str] | None] = sa.orm.mapped_column(
+ ARRAY(sa.CHAR(2), dimensions=1)
+ )
+ equivalent_fips_code: Mapped[types.str3]
__table_args__ = (
sa.Index(
@@ -75,95 +91,92 @@ def __repr__(self) -> str:
return f''
-class GeoAdmin1Code(BaseMixin, db.Model): # type: ignore[name-defined]
+class GeoAdmin1Code(BaseMixin, GeonameModel):
"""Geoname record for 1st level administrative division (state, province)."""
__tablename__ = 'geo_admin1_code'
- __bind_key__ = 'geoname'
- geonameid = sa.orm.synonym('id')
- geoname = sa.orm.relationship(
+ geonameid: Mapped[int] = sa.orm.synonym('id')
+ geoname: Mapped[GeoName] = relationship(
'GeoName',
uselist=False,
primaryjoin='GeoAdmin1Code.id == foreign(GeoName.id)',
backref='has_admin1code',
viewonly=True,
)
- title = sa.Column(sa.Unicode)
- ascii_title = sa.Column(sa.Unicode)
- country_id = sa.Column(
+ title = sa.orm.mapped_column(sa.Unicode)
+ ascii_title = sa.orm.mapped_column(sa.Unicode)
+ country_id = sa.orm.mapped_column(
'country', sa.CHAR(2), sa.ForeignKey('geo_country_info.iso_alpha2')
)
- country = sa.orm.relationship('GeoCountryInfo')
- admin1_code = sa.Column(sa.Unicode)
+ country: Mapped[GeoCountryInfo | None] = relationship('GeoCountryInfo')
+ admin1_code = sa.orm.mapped_column(sa.Unicode)
def __repr__(self) -> str:
"""Return representation."""
return f''
-class GeoAdmin2Code(BaseMixin, db.Model): # type: ignore[name-defined]
+class GeoAdmin2Code(BaseMixin, GeonameModel):
"""Geoname record for 2nd level administrative division (district, county)."""
__tablename__ = 'geo_admin2_code'
- __bind_key__ = 'geoname'
- geonameid = sa.orm.synonym('id')
- geoname = sa.orm.relationship(
+ geonameid: Mapped[int] = sa.orm.synonym('id')
+ geoname: Mapped[GeoName] = relationship(
'GeoName',
uselist=False,
primaryjoin='GeoAdmin2Code.id == foreign(GeoName.id)',
backref='has_admin2code',
viewonly=True,
)
- title = sa.Column(sa.Unicode)
- ascii_title = sa.Column(sa.Unicode)
- country_id = sa.Column(
+ title = sa.orm.mapped_column(sa.Unicode)
+ ascii_title = sa.orm.mapped_column(sa.Unicode)
+ country_id = sa.orm.mapped_column(
'country', sa.CHAR(2), sa.ForeignKey('geo_country_info.iso_alpha2')
)
- country = sa.orm.relationship('GeoCountryInfo')
- admin1_code = sa.Column(sa.Unicode)
- admin2_code = sa.Column(sa.Unicode)
+ country: Mapped[GeoCountryInfo | None] = relationship('GeoCountryInfo')
+ admin1_code = sa.orm.mapped_column(sa.Unicode)
+ admin2_code = sa.orm.mapped_column(sa.Unicode)
def __repr__(self) -> str:
"""Return representation."""
return f''
-class GeoName(BaseNameMixin, db.Model): # type: ignore[name-defined]
+class GeoName(BaseNameMixin, GeonameModel):
"""Geographical name record."""
__tablename__ = 'geo_name'
- __bind_key__ = 'geoname'
-
- geonameid = sa.orm.synonym('id')
- ascii_title = sa.Column(sa.Unicode)
- latitude = sa.Column(sa.Numeric)
- longitude = sa.Column(sa.Numeric)
- fclass = sa.Column(sa.CHAR(1))
- fcode = sa.Column(sa.Unicode)
- country_id = sa.Column(
+
+ geonameid: Mapped[int] = sa.orm.synonym('id')
+ ascii_title = sa.orm.mapped_column(sa.Unicode)
+ latitude = sa.orm.mapped_column(sa.Numeric)
+ longitude = sa.orm.mapped_column(sa.Numeric)
+ fclass = sa.orm.mapped_column(sa.CHAR(1))
+ fcode = sa.orm.mapped_column(sa.Unicode)
+ country_id = sa.orm.mapped_column(
'country', sa.CHAR(2), sa.ForeignKey('geo_country_info.iso_alpha2')
)
- country = sa.orm.relationship('GeoCountryInfo')
- cc2 = sa.Column(sa.Unicode)
- admin1 = sa.Column(sa.Unicode)
- admin1_ref = sa.orm.relationship(
+ country: Mapped[GeoCountryInfo | None] = relationship('GeoCountryInfo')
+ cc2 = sa.orm.mapped_column(sa.Unicode)
+ admin1 = sa.orm.mapped_column(sa.Unicode)
+ admin1_ref: Mapped[GeoAdmin1Code | None] = relationship(
'GeoAdmin1Code',
uselist=False,
primaryjoin='and_(GeoName.country_id == foreign(GeoAdmin1Code.country_id), '
'GeoName.admin1 == foreign(GeoAdmin1Code.admin1_code))',
viewonly=True,
)
- admin1_id = sa.Column(
+ admin1_id = sa.orm.mapped_column(
sa.Integer, sa.ForeignKey('geo_admin1_code.id'), nullable=True
)
- admin1code: Mapped[Optional[GeoAdmin1Code]] = sa.orm.relationship(
+ admin1code: Mapped[GeoAdmin1Code | None] = relationship(
'GeoAdmin1Code', uselist=False, foreign_keys=[admin1_id]
)
- admin2 = sa.Column(sa.Unicode)
- admin2_ref = sa.orm.relationship(
+ admin2 = sa.orm.mapped_column(sa.Unicode)
+ admin2_ref: Mapped[GeoAdmin2Code | None] = relationship(
'GeoAdmin2Code',
uselist=False,
primaryjoin='and_(GeoName.country_id == foreign(GeoAdmin2Code.country_id), '
@@ -171,20 +184,20 @@ class GeoName(BaseNameMixin, db.Model): # type: ignore[name-defined]
'GeoName.admin2 == foreign(GeoAdmin2Code.admin2_code))',
viewonly=True,
)
- admin2_id = sa.Column(
+ admin2_id = sa.orm.mapped_column(
sa.Integer, sa.ForeignKey('geo_admin2_code.id'), nullable=True
)
- admin2code: Mapped[Optional[GeoAdmin2Code]] = sa.orm.relationship(
+ admin2code: Mapped[GeoAdmin2Code | None] = relationship(
'GeoAdmin2Code', uselist=False, foreign_keys=[admin2_id]
)
- admin4 = sa.Column(sa.Unicode)
- admin3 = sa.Column(sa.Unicode)
- population = sa.Column(sa.BigInteger)
- elevation = sa.Column(sa.Integer)
- dem = sa.Column(sa.Integer) # Digital Elevation Model
- timezone = sa.Column(sa.Unicode)
- moddate = sa.Column(sa.Date)
+ admin4 = sa.orm.mapped_column(sa.Unicode)
+ admin3 = sa.orm.mapped_column(sa.Unicode)
+ population = sa.orm.mapped_column(sa.BigInteger)
+ elevation = sa.orm.mapped_column(sa.Integer)
+ dem = sa.orm.mapped_column(sa.Integer) # Digital Elevation Model
+ timezone = sa.orm.mapped_column(sa.Unicode)
+ moddate = sa.orm.mapped_column(sa.Date)
__table_args__ = (
sa.Index(
@@ -283,9 +296,9 @@ def make_name(self, reserved: Collection[str] = ()) -> None:
"""Create a unique name for this geoname record."""
if self.ascii_title:
usetitle = self.use_title
- if self.id:
+ if self.id: # pylint: disable=using-constant-test
- def checkused(c):
+ def checkused(c: str) -> bool:
return bool(
c in reserved
or GeoName.query.filter(GeoName.id != self.id)
@@ -295,7 +308,7 @@ def checkused(c):
else:
- def checkused(c):
+ def checkused(c: str) -> bool:
return bool(
c in reserved or GeoName.query.filter_by(name=c).notempty()
)
@@ -311,7 +324,7 @@ def __repr__(self) -> str:
f' "{self.ascii_title}">'
)
- def related_geonames(self) -> Dict[str, GeoName]:
+ def related_geonames(self) -> dict[str, GeoName]:
"""Return related geonames based on superior hierarchy (country, state, etc)."""
related = {}
if self.admin2code and self.admin2code.geonameid != self.geonameid:
@@ -371,14 +384,14 @@ def as_dict(self, related=True, alternate_titles=True) -> dict:
}
@classmethod
- def get(cls, name) -> Optional[GeoName]:
+ def get(cls, name) -> GeoName | None:
"""Get geoname record matching given URL stub name."""
return cls.query.filter_by(name=name).one_or_none()
@classmethod
def get_by_title(
- cls, titles: Union[str, List[str]], lang: Optional[str] = None
- ) -> List[GeoName]:
+ cls, titles: str | list[str], lang: str | None = None
+ ) -> list[GeoName]:
"""
Get geoname records matching the given titles.
@@ -419,9 +432,9 @@ def get_by_title(
def parse_locations(
cls,
q: str,
- special: Optional[List[str]] = None,
- lang: Optional[str] = None,
- bias: Optional[List[str]] = None,
+ special: list[str] | None = None,
+ lang: str | None = None,
+ bias: list[str] | None = None,
):
"""
Parse a string and return annotations marking all identified locations.
@@ -438,7 +451,7 @@ def parse_locations(
while '' in tokens:
tokens.remove('') # Remove blank tokens from beginning and end
ltokens = [t.lower() for t in tokens]
- results: List[Dict[str, object]] = []
+ results: list[dict[str, object]] = []
counter = 0
limit = len(tokens)
while counter < limit:
@@ -458,9 +471,15 @@ def parse_locations(
sa.or_(GeoAltName.lang == lang, GeoAltName.lang.is_(None))
)
.options(
- joinedload('geoname').joinedload('country'),
- joinedload('geoname').joinedload('admin1code'),
- joinedload('geoname').joinedload('admin2code'),
+ sa.orm.joinedload(GeoAltName.geoname).joinedload(
+ GeoName.country
+ ),
+ sa.orm.joinedload(GeoAltName.geoname).joinedload(
+ GeoName.admin1code
+ ),
+ sa.orm.joinedload(GeoAltName.geoname).joinedload(
+ GeoName.admin2code
+ ),
)
.all()
)
@@ -472,9 +491,15 @@ def parse_locations(
)
)
.options(
- joinedload('geoname').joinedload('country'),
- joinedload('geoname').joinedload('admin1code'),
- joinedload('geoname').joinedload('admin2code'),
+ sa.orm.joinedload(GeoAltName.geoname).joinedload(
+ GeoName.country
+ ),
+ sa.orm.joinedload(GeoAltName.geoname).joinedload(
+ GeoName.admin1code
+ ),
+ sa.orm.joinedload(GeoAltName.geoname).joinedload(
+ GeoName.admin2code
+ ),
)
.all()
)
@@ -501,7 +526,7 @@ def parse_locations(
{
v: k
for k, v in enumerate(
- reversed(cast(List[str], bias))
+ reversed(cast(list[str], bias))
)
}.get(a.geoname.country_id, -1),
{lang: 0}.get(a.lang, 1),
@@ -528,7 +553,7 @@ def parse_locations(
return results
@classmethod
- def autocomplete(cls, q: str, lang: Optional[str] = None) -> Query:
+ def autocomplete(cls, prefix: str, lang: str | None = None) -> Query[GeoName]:
"""
Autocomplete a geoname record.
@@ -538,7 +563,9 @@ def autocomplete(cls, q: str, lang: Optional[str] = None) -> Query:
query = (
cls.query.join(cls.alternate_titles)
.filter(
- sa.func.lower(GeoAltName.title).like(quote_autocomplete_like(q.lower()))
+ sa.func.lower(GeoAltName.title).like(
+ quote_autocomplete_like(prefix.lower())
+ )
)
.order_by(sa.desc(cls.population))
)
@@ -549,23 +576,24 @@ def autocomplete(cls, q: str, lang: Optional[str] = None) -> Query:
return query
-class GeoAltName(BaseMixin, db.Model): # type: ignore[name-defined]
+class GeoAltName(BaseMixin, GeonameModel):
"""Additional names for any :class:`GeoName`."""
__tablename__ = 'geo_alt_name'
- __bind_key__ = 'geoname'
- geonameid = sa.Column(sa.Integer, sa.ForeignKey('geo_name.id'), nullable=False)
- geoname = sa.orm.relationship(
+ geonameid = sa.orm.mapped_column(
+ sa.Integer, sa.ForeignKey('geo_name.id'), nullable=False
+ )
+ geoname: Mapped[GeoName] = relationship(
GeoName,
- backref=sa.orm.backref('alternate_titles', cascade='all, delete-orphan'),
+ backref=backref('alternate_titles', cascade='all, delete-orphan'),
)
- lang = sa.Column(sa.Unicode, nullable=True, index=True)
- title = sa.Column(sa.Unicode, nullable=False)
- is_preferred_name = sa.Column(sa.Boolean, nullable=False)
- is_short_name = sa.Column(sa.Boolean, nullable=False)
- is_colloquial = sa.Column(sa.Boolean, nullable=False)
- is_historic = sa.Column(sa.Boolean, nullable=False)
+ lang = sa.orm.mapped_column(sa.Unicode, nullable=True, index=True)
+ title = sa.orm.mapped_column(sa.Unicode, nullable=False)
+ is_preferred_name = sa.orm.mapped_column(sa.Boolean, nullable=False)
+ is_short_name = sa.orm.mapped_column(sa.Boolean, nullable=False)
+ is_colloquial = sa.orm.mapped_column(sa.Boolean, nullable=False)
+ is_historic = sa.orm.mapped_column(sa.Boolean, nullable=False)
__table_args__ = (
sa.Index(
diff --git a/funnel/models/helpers.py b/funnel/models/helpers.py
index 512d7ef5a..3fb9d038e 100644
--- a/funnel/models/helpers.py
+++ b/funnel/models/helpers.py
@@ -2,41 +2,28 @@
from __future__ import annotations
-from dataclasses import dataclass
-from textwrap import dedent
-from typing import (
- Any,
- Callable,
- ClassVar,
- Dict,
- Iterable,
- List,
- Optional,
- Set,
- Type,
- TypeVar,
-)
import os.path
import re
+from collections.abc import Callable, Iterable
+from dataclasses import dataclass
+from textwrap import dedent
+from typing import Any, ClassVar, TypeVar, cast
-from sqlalchemy import DDL, Text, event
+from better_profanity import profanity
+from furl import furl
+from markupsafe import Markup, escape as html_escape
+from sqlalchemy.dialects.postgresql import TSQUERY
from sqlalchemy.dialects.postgresql.base import (
RESERVED_WORDS as POSTGRESQL_RESERVED_WORDS,
)
from sqlalchemy.ext.mutable import MutableComposite
-from sqlalchemy.orm import composite
-
-from flask import Markup
-from flask import escape as html_escape
-
-from better_profanity import profanity
-from furl import furl
+from sqlalchemy.orm import Mapped, composite
from zxcvbn import zxcvbn
from .. import app
from ..typing import T
-from ..utils import MarkdownConfig, markdown_escape
-from . import UrlType, db, sa
+from ..utils import MarkdownConfig, MarkdownString, markdown_escape
+from . import Model, UrlType, sa
__all__ = [
'RESERVED_NAMES',
@@ -48,8 +35,9 @@
'add_search_trigger',
'visual_field_delimiter',
'valid_name',
- 'valid_username',
+ 'valid_account_name',
'quote_autocomplete_like',
+ 'quote_autocomplete_tsquery',
'ImgeeFurl',
'ImgeeType',
'MarkdownCompositeBase',
@@ -58,7 +46,7 @@
'MarkdownCompositeInline',
]
-RESERVED_NAMES: Set[str] = {
+RESERVED_NAMES: set[str] = {
'_baseframe',
'about',
'account',
@@ -164,7 +152,7 @@ class PasswordCheckType:
is_weak: bool
score: int # One of 0, 1, 2, 3, 4
warning: str
- suggestions: List[str]
+ suggestions: list[str]
#: Minimum length for a password
@@ -177,7 +165,7 @@ class PasswordCheckType:
def check_password_strength(
- password: str, user_inputs: Optional[Iterable[str]] = None
+ password: str, user_inputs: Iterable[str] | None = None
) -> PasswordCheckType:
"""Check the strength of a password using zxcvbn."""
result = zxcvbn(password, user_inputs)
@@ -195,7 +183,7 @@ def check_password_strength(
# re.IGNORECASE needs re.ASCII because of a quirk in the characters it matches.
# https://docs.python.org/3/library/re.html#re.I
-_username_valid_re = re.compile('^[a-z0-9]([a-z0-9-]*[a-z0-9])?$', re.I | re.A)
+_account_name_valid_re = re.compile('^[a-z0-9][a-z0-9_]*$', re.I | re.A)
_name_valid_re = re.compile('^[a-z0-9]([a-z0-9-]*[a-z0-9])?$', re.A)
@@ -212,7 +200,7 @@ def check_password_strength(
visual_field_delimiter = ' ¦ '
-def add_to_class(cls: Type, name: Optional[str] = None) -> Callable[[T], T]:
+def add_to_class(cls: type, name: str | None = None) -> Callable[[T], T]:
"""
Add a new method to a class via a decorator. Takes an optional attribute name.
@@ -229,7 +217,7 @@ def existing_class_new_property(self):
"""
def decorator(attr: T) -> T:
- use_name: Optional[str] = name or getattr(attr, '__name__', None)
+ use_name: str | None = name or getattr(attr, '__name__', None)
if not use_name: # pragma: no cover
# None or '' not allowed
raise ValueError(f"Could not determine name for {attr!r}")
@@ -249,6 +237,10 @@ def reopen(cls: ReopenedType) -> Callable[[TempType], ReopenedType]:
"""
Move the contents of the decorated class into an existing class and return it.
+ .. deprecated::
+ This function is deprecated and should not be used as it is incompatible with
+ PEP 484 type hinting.
+
Usage::
@reopen(ExistingClass)
@@ -313,13 +305,13 @@ def decorator(temp_cls: TempType) -> ReopenedType:
return decorator
-def valid_username(candidate: str) -> bool:
+def valid_account_name(candidate: str) -> bool:
"""
Check if a username is valid.
- Letters, numbers and non-terminal hyphens only.
+ Letters, numbers and underscores only.
"""
- return not _username_valid_re.search(candidate) is None
+ return _account_name_valid_re.search(candidate) is not None
def valid_name(candidate: str) -> bool:
@@ -328,7 +320,7 @@ def valid_name(candidate: str) -> bool:
Lowercase letters, numbers and non-terminal hyphens only.
"""
- return not _name_valid_re.search(candidate) is None
+ return _name_valid_re.search(candidate) is not None
def pgquote(identifier: str) -> str:
@@ -336,53 +328,78 @@ def pgquote(identifier: str) -> str:
return f'"{identifier}"' if identifier in POSTGRESQL_RESERVED_WORDS else identifier
-def quote_autocomplete_like(query):
+def quote_autocomplete_like(prefix: str, midway: bool = False) -> str:
"""
Construct a LIKE query string for prefix-based matching (autocomplete).
+ :param midway: Search midway using the ``%letters%`` syntax. This requires a
+ trigram index to be efficient
+
Usage::
- column.like(quote_autocomplete_like(query))
+ column.like(quote_autocomplete_like(prefix))
For case-insensitive queries, add an index on LOWER(column) and use::
- sa.func.lower(column).like(sa.func.lower(quote_autocomplete_like(query)))
+ sa.func.lower(column).like(sa.func.lower(quote_autocomplete_like(prefix)))
+
+ This function will return an empty string if the prefix has no content after
+ stripping whitespace and special characters. It is prudent to test before usage::
+
+ like_query = quote_autocomplete_like(prefix)
+ if like_query:
+ # Proceed with query
+ query = Model.query.filter(
+ sa.func.lower(Model.column).like(sa.func.lower(like_query))
+ )
"""
# Escape the '%' and '_' wildcards in SQL LIKE clauses.
# Some SQL dialects respond to '[' and ']', so remove them.
# Suffix a '%' to make a prefix-match query.
- return (
- query.replace('%', r'\%').replace('_', r'\_').replace('[', '').replace(']', '')
+ like_query = (
+ prefix.replace('\\', r'\\')
+ .replace('%', r'\%')
+ .replace('_', r'\_')
+ .replace('[', '')
+ .replace(']', '')
+ '%'
)
+ lstrip_like_query = like_query.lstrip()
+ if lstrip_like_query == '%':
+ return ''
+ if midway:
+ return '%' + like_query
+ return lstrip_like_query
-def quote_autocomplete_tsquery(query: str) -> str:
+def quote_autocomplete_tsquery(prefix: str) -> TSQUERY:
"""Return a PostgreSQL tsquery suitable for autocomplete-type matches."""
- with db.session.no_autoflush:
- return db.session.query(
- sa.func.cast(sa.func.phraseto_tsquery(query or ''), Text) + ':*'
- ).scalar()
+ return cast(
+ TSQUERY,
+ sa.func.cast(
+ sa.func.concat(sa.func.phraseto_tsquery('simple', prefix or ''), ':*'),
+ TSQUERY,
+ ),
+ )
-def add_search_trigger(
- model: db.Model, column_name: str # type: ignore[name-defined]
-) -> Dict[str, str]:
+def add_search_trigger(model: type[Model], column_name: str) -> dict[str, str]:
"""
Add a search trigger and returns SQL for use in migrations.
Typical use::
- class MyModel(db.Model): # type: ignore[name-defined]
+ class MyModel(Model):
...
- search_vector = sa.orm.deferred(sa.Column(
+ search_vector: Mapped[TSVectorType] = sa.orm.mapped_column(
TSVectorType(
'name', 'title', *indexed_columns,
weights={'name': 'A', 'title': 'B'},
regconfig='english'
),
nullable=False,
- ))
+ deferred=True,
+ )
__table_args__ = (
sa.Index(
@@ -441,19 +458,20 @@ class MyModel(db.Model): # type: ignore[name-defined]
END
$$ LANGUAGE plpgsql;
- CREATE TRIGGER {trigger_name} BEFORE INSERT OR UPDATE ON {table_name}
- FOR EACH ROW EXECUTE PROCEDURE {function_name}();
+ CREATE TRIGGER {trigger_name} BEFORE INSERT OR UPDATE OF {source_columns}
+ ON {table_name} FOR EACH ROW EXECUTE PROCEDURE {function_name}();
'''.format( # nosec
function_name=pgquote(function_name),
column_name=pgquote(column_name),
trigger_expr=trigger_expr,
trigger_name=pgquote(trigger_name),
+ source_columns=', '.join(pgquote(col) for col in column.type.columns),
table_name=pgquote(model.__tablename__),
)
)
update_statement = (
- f'UPDATE {pgquote(model.__tablename__)}'
+ f'UPDATE {pgquote(model.__tablename__)}' # nosec
f' SET {pgquote(column_name)} = {update_expr};'
)
@@ -464,22 +482,16 @@ class MyModel(db.Model): # type: ignore[name-defined]
'''
)
- # FIXME: `DDL().execute_if` accepts a string dialect, but sqlalchemy-stubs
- # incorrectly declares the type as `Optional[Dialect]`
- # https://github.com/dropbox/sqlalchemy-stubs/issues/181
-
- event.listen(
+ sa.event.listen(
model.__table__,
'after_create',
- DDL(trigger_function).execute_if(
- dialect='postgresql' # type: ignore[arg-type]
- ),
+ sa.DDL(trigger_function).execute_if(dialect='postgresql'),
)
- event.listen(
+ sa.event.listen(
model.__table__,
'before_drop',
- DDL(drop_statement).execute_if(dialect='postgresql'), # type: ignore[arg-type]
+ sa.DDL(drop_statement).execute_if(dialect='postgresql'),
)
return {
@@ -497,27 +509,35 @@ class MessageComposite:
:param tag: Optional wrapper tag for HTML rendering
"""
- def __init__(self, text: str, tag: Optional[str] = None):
+ def __init__(self, text: str, tag: str | None = None) -> None:
self.text = text
self.tag = tag
- def __markdown__(self) -> str:
+ def __markdown__(self) -> MarkdownString:
"""Return Markdown source (for escaper)."""
return markdown_escape(self.text)
- def __html__(self) -> str:
+ def __markdown_format__(self, format_spec: str) -> str:
+ """Implement format_spec support as required by MarkdownString."""
+ return self.__markdown__().__markdown_format__(format_spec)
+
+ def __html__(self) -> Markup:
"""Return HTML version of string."""
# Localize lazy string on demand
tag = self.tag
if tag:
- return f'
{description}
{schema}<{tag}>{html_escape(self.text)}
' - return f'{html_escape(self.text)}
' + return Markup(f'<{tag}>{html_escape(self.text)}
') + return Markup(f'{html_escape(self.text)}
') + + def __html_format__(self, format_spec: str) -> str: + """Implement format_spec support as required by Markup.""" + return self.__html__().__html_format__(format_spec) @property def html(self) -> Markup: return Markup(self.__html__()) - def __json__(self) -> Dict[str, Any]: + def __json__(self) -> dict[str, Any]: """Return JSON-compatible rendering of contents.""" return {'text': self.text, 'html': self.__html__()} @@ -525,7 +545,7 @@ def __json__(self) -> Dict[str, Any]: class ImgeeFurl(furl): """Furl with a resize method specifically for Imgee URLs.""" - def resize(self, width: int, height: Optional[int] = None) -> furl: + def resize(self, width: int, height: int | None = None) -> furl: """ Return image url with `?size=WxH` suffixed to it. @@ -545,7 +565,7 @@ class ImgeeType(UrlType): # pylint: disable=abstract-method url_parser = ImgeeFurl cache_ok = True - def process_bind_param(self, value, dialect): + def process_bind_param(self, value: Any, dialect: Any) -> furl: value = super().process_bind_param(value, dialect) if value: allowed_domains = app.config.get('IMAGE_URL_DOMAINS', []) @@ -560,68 +580,82 @@ def process_bind_param(self, value, dialect): return value +_MC = TypeVar('_MC', bound='MarkdownCompositeBase') + + class MarkdownCompositeBase(MutableComposite): """Represents Markdown text and rendered HTML as a composite column.""" config: ClassVar[MarkdownConfig] - def __init__(self, text, html=None): + def __init__(self, text: str | None, html: str | None = None) -> None: """Create a composite.""" if html is None: self.text = text # This will regenerate HTML else: self._text = text - self._html = html + self._html: str | None = html - # Return column values for SQLAlchemy to insert into the database - def __composite_values__(self): - """Return composite values.""" + def __composite_values__(self) -> tuple[str | None, str | None]: + """Return composite values for SQLAlchemy.""" return (self._text, self._html) # Return a string representation of the text (see class decorator) - def __str__(self): + def __str__(self) -> str: """Return string representation.""" return self._text or '' - def __markdown__(self): + def __markdown__(self) -> str: """Return source Markdown (for escaper).""" return self._text or '' - # Return a HTML representation of the text - def __html__(self): + def __markdown_format__(self, format_spec: str) -> str: + """Implement format_spec support as required by MarkdownString.""" + # This call's MarkdownString's __format__ instead of __markdown_format__ as the + # content has not been manipulated from the source string + return self.__markdown__().__format__(format_spec) + + def __html__(self) -> str: """Return HTML representation.""" return self._html or '' + def __html_format__(self, format_spec: str) -> str: + """Implement format_spec support as required by Markup.""" + # This call's Markup's __format__ instead of __html_format__ as the + # content has not been manipulated from the source string + return self.__html__().__format__(format_spec) + # Return a Markup string of the HTML @property - def html(self): + def html(self) -> Markup | None: """Return HTML as a read-only property.""" return Markup(self._html) if self._html is not None else None @property - def text(self): + def text(self) -> str | None: """Return text as a property.""" return self._text @text.setter - def text(self, value): + def text(self, value: str | None) -> None: """Set the text value.""" self._text = None if value is None else str(value) self._html = self.config.render(self._text) self.changed() - def __json__(self) -> Dict[str, Optional[str]]: + def __json__(self) -> dict[str, str | None]: """Return JSON-compatible rendering of composite.""" return {'text': self._text, 'html': self._html} - # Compare text value - def __eq__(self, other): + def __eq__(self, other: Any) -> bool: """Compare for equality.""" - return isinstance(other, self.__class__) and ( - self.__composite_values__() == other.__composite_values__() + return ( + isinstance(other, self.__class__) + and (self.__composite_values__() == other.__composite_values__()) + or self._text == other ) - def __ne__(self, other): + def __ne__(self, other: Any) -> bool: """Compare for inequality.""" return not self.__eq__(other) @@ -629,37 +663,62 @@ def __ne__(self, other): # tested here as we don't use them. # https://docs.sqlalchemy.org/en/13/orm/extensions/mutable.html#id1 - def __getstate__(self): + def __getstate__(self) -> tuple[str | None, str | None]: """Get state for pickling.""" # Return state for pickling return (self._text, self._html) - def __setstate__(self, state): + def __setstate__(self, state: tuple[str | None, str | None]) -> None: """Set state from pickle.""" # Set state from pickle self._text, self._html = state self.changed() - def __bool__(self): + def __bool__(self) -> bool: """Return boolean value.""" return bool(self._text) @classmethod - def coerce(cls, key, value): + def coerce(cls: type[_MC], key: str, value: Any) -> _MC: """Allow a composite column to be assigned a string value.""" return cls(value) + # TODO: Add `nullable` as a keyword parameter and add overloads for returning + # Mapped[str] or Mapped[str | None] based on nullable + @classmethod def create( - cls, name: str, deferred: bool = False, group: Optional[str] = None, **kwargs - ) -> composite: + cls: type[_MC], + name: str, + deferred: bool = False, + deferred_group: str | None = None, + **kwargs, + ) -> tuple[sa.orm.Composite[_MC], Mapped[str], Mapped[str]]: """Create a composite column and backing individual columns.""" - return composite( - cls, - sa.Column(name + '_text', sa.UnicodeText, **kwargs), - sa.Column(name + '_html', sa.UnicodeText, **kwargs), + col_text = sa.orm.mapped_column( + name + '_text', + sa.UnicodeText, + deferred=deferred, + deferred_group=deferred_group, + **kwargs, + ) + col_html = sa.orm.mapped_column( + name + '_html', + sa.UnicodeText, deferred=deferred, - group=group or name, + deferred_group=deferred_group, + **kwargs, + ) + return ( + composite( + cls, + col_text, + col_html, + deferred=deferred, + group=deferred_group, + ), + col_text, + col_html, ) diff --git a/funnel/models/label.py b/funnel/models/label.py index a4013d09a..cb586b160 100644 --- a/funnel/models/label.py +++ b/funnel/models/label.py @@ -2,14 +2,19 @@ from __future__ import annotations -from typing import Union - -from sqlalchemy.ext.orderinglist import ordering_list -from sqlalchemy.sql import case, exists +from sqlalchemy.ext.orderinglist import OrderingList, ordering_list from coaster.sqlalchemy import with_roles -from . import BaseScopedNameMixin, TSVectorType, db, hybrid_property, sa +from . import ( + BaseScopedNameMixin, + Mapped, + Model, + TSVectorType, + hybrid_property, + relationship, + sa, +) from .helpers import add_search_trigger, reopen, visual_field_delimiter from .project import Project from .project_membership import project_child_role_map @@ -17,7 +22,7 @@ proposal_label = sa.Table( 'proposal_label', - db.Model.metadata, # type: ignore[has-type] + Model.metadata, sa.Column( 'proposal_id', sa.Integer, @@ -37,36 +42,35 @@ ) -class Label( - BaseScopedNameMixin, - db.Model, # type: ignore[name-defined] -): +class Label(BaseScopedNameMixin, Model): __tablename__ = 'label' - project_id = sa.Column( + project_id = sa.orm.mapped_column( sa.Integer, sa.ForeignKey('project.id', ondelete='CASCADE'), nullable=False ) # Backref from project is defined in the Project model with an ordering list - project: sa.orm.relationship[Project] = with_roles( - sa.orm.relationship(Project), grants_via={None: project_child_role_map} + project: Mapped[Project] = with_roles( + relationship(Project), grants_via={None: project_child_role_map} ) # `parent` is required for # :meth:`~coaster.sqlalchemy.mixins.BaseScopedNameMixin.make_name()` - parent = sa.orm.synonym('project') + parent: Mapped[Project] = sa.orm.synonym('project') #: Parent label's id. Do not write to this column directly, as we don't have the #: ability to : validate the value within the app. Always use the :attr:`main_label` #: relationship. - main_label_id = sa.Column( + main_label_id = sa.orm.mapped_column( sa.Integer, sa.ForeignKey('label.id', ondelete='CASCADE'), index=True, nullable=True, ) + main_label: Mapped[Label] = relationship( + remote_side='Label.id', back_populates='options' + ) # See https://docs.sqlalchemy.org/en/13/orm/self_referential.html - options = sa.orm.relationship( - 'Label', - backref=sa.orm.backref('main_label', remote_side='Label.id'), + options: Mapped[OrderingList[Label]] = relationship( + back_populates='main_label', order_by='Label.seq', passive_deletes=True, collection_class=ordering_list('seq', count_from=1), @@ -77,48 +81,53 @@ class Label( # add_primary_relationship) #: Sequence number for this label, used in UI for ordering - seq = sa.Column(sa.Integer, nullable=False) + seq = sa.orm.mapped_column(sa.Integer, nullable=False) # A single-line description of this label, shown when picking labels (optional) - description = sa.Column(sa.UnicodeText, nullable=False, default="") + description = sa.orm.mapped_column(sa.UnicodeText, nullable=False, default='') #: Icon for displaying in space-constrained UI. Contains one emoji symbol. #: Since emoji can be composed from multiple symbols, there is no length #: limit imposed here - icon_emoji = sa.Column(sa.UnicodeText, nullable=True) + icon_emoji = sa.orm.mapped_column(sa.UnicodeText, nullable=True) #: Restricted mode specifies that this label may only be applied by someone with #: an editorial role (TODO: name the role). If this label is a parent, it applies #: to all its children - _restricted = sa.Column('restricted', sa.Boolean, nullable=False, default=False) + _restricted = sa.orm.mapped_column( + 'restricted', sa.Boolean, nullable=False, default=False + ) #: Required mode signals to UI that if this label is a parent, one of its #: children must be mandatorily applied to the proposal. The value of this #: field must be ignored if the label is not a parent - _required = sa.Column('required', sa.Boolean, nullable=False, default=False) + _required = sa.orm.mapped_column( + 'required', sa.Boolean, nullable=False, default=False + ) #: Archived mode specifies that the label is no longer available for use #: although all the previous records will stay in database. - _archived = sa.Column('archived', sa.Boolean, nullable=False, default=False) + _archived = sa.orm.mapped_column( + 'archived', sa.Boolean, nullable=False, default=False + ) - search_vector = sa.orm.deferred( - sa.Column( - TSVectorType( - 'name', - 'title', - 'description', - weights={'name': 'A', 'title': 'A', 'description': 'B'}, - regconfig='english', - hltext=lambda: sa.func.concat_ws( - visual_field_delimiter, Label.title, Label.description - ), + search_vector: Mapped[TSVectorType] = sa.orm.mapped_column( + TSVectorType( + 'name', + 'title', + 'description', + weights={'name': 'A', 'title': 'A', 'description': 'B'}, + regconfig='english', + hltext=lambda: sa.func.concat_ws( + visual_field_delimiter, Label.title, Label.description ), - nullable=False, - ) + ), + nullable=False, + deferred=True, ) #: Proposals that this label is attached to - proposals = sa.orm.relationship( + proposals: Mapped[list[Proposal]] = relationship( Proposal, secondary=proposal_label, back_populates='labels' ) @@ -157,13 +166,13 @@ class Label( } @property - def title_for_name(self): + def title_for_name(self) -> str: if self.main_label: return f"{self.main_label.title}/{self.title}" return self.title @property - def form_label_text(self): + def form_label_text(self) -> str: return ( self.icon_emoji + " " + self.title if self.icon_emoji is not None @@ -171,88 +180,92 @@ def form_label_text(self): ) @property - def has_proposals(self): + def has_proposals(self) -> bool: if not self.has_options: return bool(self.proposals) return any(bool(option.proposals) for option in self.options) @hybrid_property - def restricted(self): - return ( # pylint: disable=protected-access - self.main_label._restricted if self.main_label else self._restricted - ) + def restricted(self) -> bool: + # pylint: disable=protected-access + return self.main_label._restricted if self.main_label else self._restricted - @restricted.setter - def restricted(self, value): + @restricted.inplace.setter + def _restricted_setter(self, value: bool) -> None: if self.main_label: raise ValueError("This flag must be set on the parent") self._restricted = value - @restricted.expression - def restricted(cls): # noqa: N805 # pylint: disable=no-self-argument - return case( - [ - ( - cls.main_label_id.isnot(None), - sa.select([Label._restricted]) - .where(Label.id == cls.main_label_id) - .as_scalar(), - ) - ], + @restricted.inplace.expression + @classmethod + def _restricted_expression(cls) -> sa.Case: + """Return SQL Expression.""" + return sa.case( + ( + cls.main_label_id.is_not(None), + sa.select(Label._restricted) + .where(Label.id == cls.main_label_id) + .scalar_subquery(), + ), else_=cls._restricted, ) @hybrid_property - def archived(self): + def archived(self) -> bool: + """Test if this label or parent label is archived.""" return self._archived or ( self.main_label._archived # pylint: disable=protected-access if self.main_label else False ) - @archived.setter - def archived(self, value): + @archived.inplace.setter + def _archived_setter(self, value: bool) -> None: + """Archive this label.""" self._archived = value - @archived.expression - def archived(cls): # noqa: N805 # pylint: disable=no-self-argument - return case( - [ - (cls._archived.is_(True), cls._archived), - ( - cls.main_label_id.isnot(None), - sa.select([Label._archived]) - .where(Label.id == cls.main_label_id) - .as_scalar(), - ), - ], + @archived.inplace.expression + @classmethod + def _archived_expression(cls) -> sa.Case: + """Return SQL Expression.""" + return sa.case( + (cls._archived.is_(True), cls._archived), + ( + cls.main_label_id.is_not(None), + sa.select(Label._archived) + .where(Label.id == cls.main_label_id) + .scalar_subquery(), + ), else_=cls._archived, ) @hybrid_property - def has_options(self): + def has_options(self) -> bool: return bool(self.options) - @has_options.expression - def has_options(cls): # noqa: N805 # pylint: disable=no-self-argument - return exists().where(Label.main_label_id == cls.id) + @has_options.inplace.expression + @classmethod + def _has_options_expression(cls) -> sa.Exists: + """Return SQL Expression.""" + return sa.exists().where(Label.main_label_id == cls.id) @property - def is_main_label(self): + def is_main_label(self) -> bool: return not self.main_label @hybrid_property - def required(self): + def required(self) -> bool: + # pylint: disable=using-constant-test return self._required if self.has_options else False - @required.setter - def required(self, value): + @required.inplace.setter + def _required_setter(self, value: bool) -> None: if value and not self.has_options: raise ValueError("Labels without options cannot be mandatory") self._required = value @property - def icon(self): + def icon(self) -> str: """ Return an icon for displaying the label in space-constrained UI. @@ -273,7 +286,8 @@ def __repr__(self) -> str: return f'
-
Info
+{% trans %}Info{% endtrans %}
- {{ faicon(icon='user', css_class="icon-img--smaller")}} + {{ faicon(icon='user', css_class="icon-img--smaller") }} {{ current_auth.user.fullname }}
@@ -109,17 +110,20 @@
-
{% trans %}Connected accounts{% endtrans %}
+{% trans %}Connected accounts{% endtrans %}
-
{% for extid in current_auth.user.externalids %}
- {{ faicon(icon=extid.service, icon_size='body2', baseline=false, css_class="mui--text-light icon-img icon-img--smaller") }} - {{ extid.username or (extid.service in login_registry and login_registry[extid.service]['title']) or extid.service }} {% trans last_used_at=extid.last_used_at|age %}Last used {{ last_used_at }}{% endtrans %} + + {{ extid.username or (extid.service in login_registry and login_registry[extid.service]['title']) or extid.service }} + {% trans last_used_at=extid.last_used_at|age %}Last used {{ last_used_at }}{% endtrans %} + {{ faicon(icon='trash-alt', icon_size='subhead', baseline=false, css_class="mui--align-middle") }} + aria-label="{% trans %}Remove{% endtrans %}">{{ faicon(icon='trash-alt', icon_size='subhead', baseline=false, css_class="mui--align-middle") }} {% endfor %}
 }})
+ aria-hidden="true"/>
{% endfor %}
-
{% trans %}Email addresses{% endtrans %}
+{% trans %}Email addresses{% endtrans %}
-
{% trans %}Mobile numbers{% endtrans %}
+{% trans %}Mobile numbers{% endtrans %}
-
+
@@ -273,6 +278,7 @@
rel="nofollow"
{% if auth_token.auth_client.trusted -%}
title="{% trans %}Made by Hasgeek{% endtrans %}"
+ aria-label="{% trans %}Made by Hasgeek{% endtrans %}"
{%- endif -%}>{{ auth_token.auth_client.title }}
{%- if auth_token.auth_client.trusted %}
{{ faicon('badge-check-solid') }}
@@ -290,7 +296,10 @@
+
{% trans %}Connected apps{% endtrans %}
{%- if not auth_token.auth_client.trusted %}
- {{ faicon(icon='trash-alt', icon_size='subhead', baseline=false, css_class="mui--align-middle mui--text-hyperlink") }}
+ {{ faicon(icon='trash-alt', icon_size='subhead', baseline=false, css_class="mui--align-middle mui--text-hyperlink") }}
{%- endif %}
@@ -303,7 +312,7 @@
-
+
@@ -313,8 +322,14 @@
{{ logout_form.hidden_tag() }}
+
{% trans %}Login sessions{% endtrans %}
-
- {%- for user_session in current_auth.user.active_user_sessions %}
- {%- with ua=user_session.views.user_agent_details(), login_service=user_session.views.login_service(), location=user_session.views.location(), user_agent=user_session.user_agent, since=user_session.created_at|age, last_active=user_session.accessed_at|age %}
+ {%- for login_session in current_auth.user.active_login_sessions %}
+ {%- with
+ ua=login_session.views.user_agent_details(),
+ login_service=login_session.views.login_service(),
+ location=login_session.views.location(),
+ user_agent=login_session.user_agent,
+ since=login_session.created_at|age,
+ last_active=login_session.accessed_at|age %}
-
- {% trans ipaddr=user_session.ipaddr %}{{ location }} – estimated from {{ ipaddr }}{% endtrans %} + {% trans ipaddr=login_session.ipaddr %}{{ location }} – estimated from {{ ipaddr }}{% endtrans %}
- {%- if user_session == current_auth.session %} + {%- if login_session == current_auth.session %} {{ faicon(icon='check-circle-solid', icon_size='subhead', baseline=true, css_class="mui--text-success input-align-icon") }} {%- else -%} @@ -359,23 +375,28 @@
-
-#}
+
-
{% trans %}Delete{% endtrans %}
+
+
{% trans %}Delete account{% endtrans %}
+ {{ faicon(icon='exclamation-triangle', icon_size='subhead', baseline=true, css_class="mui--text-danger input-align-icon") }}
-
+
+
{%- trans %}{% endtrans %}
- {% trans %}Delete my account{% endtrans %} +{% trans -%} + If you no longer need this account, you can delete it. If you have a duplicate account, you can merge it by adding the same phone number or email address here. No deletion necessary. + {%- endtrans %}
+
@@ -44,18 +44,18 @@
{%- for orgmem in orgmemlist.recent %}
-
- {%- if orgmem.organization.profile.logo_url.url %}
- 
+ {%- if orgmem.account.logo_url.url %}
+  }})
{% else %}
 }})
+ alt="{{ orgmem.account.title }}"/>
{% endif %}
- {{ orgmem.organization.profile.title }}
+ {{ orgmem.account.title }}
{%- endfor %}
@@ -65,16 +65,16 @@
class="header__dropdown__item header__dropdown__item--flex header__dropdown__item--morepadding mui--text-dark nounderline">
{%- for orgmem in orgmemlist.overflow %}
- {%- if orgmem.organization.profile.logo_url.url %}
-
+ {%- if orgmem.account.logo_url.url %}
+
{% else %}
+ alt="{{ orgmem.account.title }}"/>
{% endif %}
{%- endfor %}
- {%- if orgmemlist.extra_count -%}{%- endif %}
+ {%- if orgmemlist.extra_count -%}{%- endif %}
{%- endif %}
diff --git a/funnel/templates/account_merge.html.jinja2 b/funnel/templates/account_merge.html.jinja2
index 3cd2053eb..15605b16e 100644
--- a/funnel/templates/account_merge.html.jinja2
+++ b/funnel/templates/account_merge.html.jinja2
@@ -4,26 +4,34 @@
{% macro accountinfo(user) %}
{% endif %}
-
+ alt="{{ orgmem.account.title }}"/>
{% endif %}
- {{ orgmem.organization.profile.title }}
+ {{ orgmem.account.title }}
+ alt="{{ orgmem.account.title }}"/>
{% endif %}
{%- endfor %}
- {%- if orgmemlist.extra_count -%}{%- endif %}
+ {%- if orgmemlist.extra_count -%}{%- endif %}
{%- endif %}
diff --git a/funnel/templates/account_merge.html.jinja2 b/funnel/templates/account_merge.html.jinja2
index 3cd2053eb..15605b16e 100644
--- a/funnel/templates/account_merge.html.jinja2
+++ b/funnel/templates/account_merge.html.jinja2
@@ -4,26 +4,34 @@
{% macro accountinfo(user) %}
-
-
- {% trans %}Name:{% endtrans %} {{ user.fullname }} -
- {% trans %}Username:{% endtrans %} {% if user.username %}{{ user.username }}{% else %}{% trans %}(none){% endtrans %}{% endif %} -
-
-
-
- {%- for useremail in user.emails %}
-
- {% trans %}Email addresses:{% endtrans %} {{ useremail.email }} - {%- else %} -
- {% trans %}Email addresses:{% endtrans %} {% trans %}(none){% endtrans %} - {%- endfor %} -
- - {% trans %}Connected accounts:{% endtrans %}
-
-
- {%- for extid in user.externalids %}
-
- {{ login_registry[extid.service].title }}: {{ extid.username }} - {%- else %} -
- (none) - {%- endfor %} -
+ - {% trans %}Name:{% endtrans %} {{ user.pickername }} + {%- if user.emails %} +
- {% trans %}Email addresses:{% endtrans %}
+
-
+ {%- for accemail in user.emails %}
+
- {{ accemail.email }} + {%- endfor %} +
+ {%- endif %}
+ {%- if user.phones %}
+ - {% trans %}Phone numbers:{% endtrans %}
+
-
+ {%- for userphone in user.phones %}
+
- {{ userphone.formatted }} + {%- endfor %} +
+ {%- endif %}
+ {%- if user.externalids %}
+ - {% trans %}Connected accounts:{% endtrans %}
+
-
+ {%- for extid in user.externalids %}
+
- {% if extid.service in login_registry %}{{ login_registry[extid.service].title }}{% else %}{{ extid.service|capitalize }}{% endif %}: {{ extid.username }} + {%- endfor %} +
+ {%- endif %}
-
{% trans %}Delete{% endtrans %}
{% trans %}New access key{% endtrans %}
- {%- if auth_client.user -%}
- {% trans %}Assign permissions to a user{% endtrans %}
- {%- else -%}
- {% trans %}Assign permissions to a team{% endtrans %}
- {%- endif -%}
+ {% trans %}Assign permissions to a user{% endtrans %}
@@ -30,7 +26,7 @@
- {{ orgmem.organization.profile.title }} - {% if not orgmem.organization.profile.state.PUBLIC %} + {{ orgmem.account.title }} + {% if not orgmem.account.profile_state.PUBLIC %} {{ faicon(icon='lock-alt', icon_size='caption', baseline=false, css_class="margin-left") }} {% endif %}
@@ -61,7 +61,7 @@- {%- for user in orgmem.organization.admin_users %} + {%- for user in orgmem.account.admin_users %} {{ user.pickername }} {%- if not loop.last %},{% endif %} {%- endfor %}
diff --git a/funnel/templates/account_saved.html.jinja2 b/funnel/templates/account_saved.html.jinja2 index 633fd3654..8a14ddf83 100644 --- a/funnel/templates/account_saved.html.jinja2 +++ b/funnel/templates/account_saved.html.jinja2 @@ -28,5 +28,5 @@ {% endblock basecontent %} {% block footerscripts %} - + {% endblock footerscripts %} diff --git a/funnel/templates/ajaxform.html.jinja2 b/funnel/templates/ajaxform.html.jinja2 index 65de82bce..ae84b8fe7 100644 --- a/funnel/templates/ajaxform.html.jinja2 +++ b/funnel/templates/ajaxform.html.jinja2 @@ -1,5 +1,5 @@
-
+
{% from "forms.html.jinja2" import renderform, ajaxform, widget_ext_scripts, widgetscripts %}
{%- from "macros.html.jinja2" import alertbox -%}
{% block pageheaders %}
@@ -20,27 +20,19 @@
{% block form %}
{{ renderform(form=form, formid=formid, ref_id=ref_id, submit=submit, message=message, action=action, cancel_url=cancel_url, multipart=multipart, autosave=autosave, draft_revision=draft_revision) }}
{% endblock form %}
- {%- if with_chrome -%}
- {{ ajaxform(ref_id=ref_id, request=request, force=true) }}
- {%- endif -%}
{{ widget_ext_scripts(form) }}
{% block innerscripts %}
-
+
-
+ {%- if with_chrome -%}
+ {{ ajaxform(ref_id=ref_id, request=request, force=true) }}
+ {%- endif -%}
+ {%- if form and 'recaptcha' in form %}
+ {% block recaptcha %}{% endblock recaptcha %}
+ {%- endif %}
{% endblock innerscripts %}
diff --git a/funnel/templates/auth_client.html.jinja2 b/funnel/templates/auth_client.html.jinja2
index 5e3a67a67..9e39e1079 100644
--- a/funnel/templates/auth_client.html.jinja2
+++ b/funnel/templates/auth_client.html.jinja2
@@ -17,11 +17,7 @@
+
-
@@ -39,7 +35,7 @@
- {% trans %}Description{% endtrans %}
- {{ auth_client.description }}
- {% trans %}Owner{% endtrans %} -
- {{ auth_client.owner.pickername }} +
- {{ auth_client.account.pickername }}
- {% trans %}OAuth2 Type{% endtrans %}
- {% if auth_client.confidential %}{% trans %}Confidential{% endtrans %}{% else %}{% trans %}Public{% endtrans %}{% endif %}
- {% trans %}Website{% endtrans %} @@ -148,11 +144,7 @@ {% if auth_client.owner_is(current_auth.user) %}
{% trans %}Permissions{% endtrans %}
- {% if auth_client.user %} -{% trans %}The following users have permissions to this app{% endtrans %}
- {% else %} -{% trans %}The following teams have permissions to this app{% endtrans %}
- {% endif %} +{% trans %}The following users have permissions to this app{% endtrans %}
{%- for pa in permassignments %}
diff --git a/funnel/templates/auth_client_index.html.jinja2 b/funnel/templates/auth_client_index.html.jinja2
index 34947f764..d64ebcc8e 100644
--- a/funnel/templates/auth_client_index.html.jinja2
+++ b/funnel/templates/auth_client_index.html.jinja2
@@ -23,7 +23,7 @@
{{ loop.index }}
{{ auth_client.title }}
- {{ auth_client.owner.pickername }}
+ {{ auth_client.account.pickername }}
{{ auth_client.website }}
{% else %}
diff --git a/funnel/templates/auth_dashboard.html.jinja2 b/funnel/templates/auth_dashboard.html.jinja2
index c89c0e02a..bdc2b7179 100644
--- a/funnel/templates/auth_dashboard.html.jinja2
+++ b/funnel/templates/auth_dashboard.html.jinja2
@@ -7,9 +7,9 @@
{% endblock pageheaders %}
{% block content %}
- Badge
-
+ {% trans %}Badge{% endtrans %}
+
+
+
+ {# Outlook / @font-face : END #}
+
{% block stylesheet -%}
-
+ {# CSS Reset : BEGIN #}
+
+ {# CSS Reset : END #}
+
+ {# Progressive Enhancements : BEGIN #}
+
+ {# Progressive Enhancements : END #}
{%- endblock stylesheet %}
-
-
+
+ {# Element styles : BEGIN #}
+
+
+
+
+ {#
+ The email background color (#f0f0f0) is defined in three places:
+ 1. body tag: for most email clients
+ 2. center tag: for Gmail and Inbox mobile apps and web versions of Gmail, GSuite, Inbox, Yahoo, AOL, Libero, Comcast, freenet, Mail.ru, Orange.fr
+ 3. mso conditional: For Windows 10 Mail
+ #}
+
{%- block jsonld %}{%- if jsonld %}
-
+
{%- endif %}{%- endblock jsonld %}
-
+
+
+ {#
+ Set the email width. Defined in two places:
+ 1. max-width for all clients except Desktop Windows Outlook, allowing the email to squish on narrow but never go wider than 600px.
+ 2. MSO tags for Desktop Windows Outlook enforce a 600px width.
+ #}
+ {% block footer %}
+
+ {# Email Footer : END #}
+
+
+
{% trans active=mau %}{{ active }} monthly active users{% endtrans %}
+{% trans active=mau|numberformat %}{{ active }} monthly active users{% endtrans %}
-{% trans count=user_count %}{{ count }} total users{% endtrans %}
+{% trans count=user_count|numberformat %}{{ count }} total users{% endtrans %}
{% endblock content %} diff --git a/funnel/templates/badge.html.jinja2 b/funnel/templates/badge.html.jinja2 index 7a435c684..102ff0a14 100644 --- a/funnel/templates/badge.html.jinja2 +++ b/funnel/templates/badge.html.jinja2 @@ -1,8 +1,8 @@ -{% block content %}{% endblock content %}
- {% block footer %}
- {%- if view %}
-
-
-
+
+ -
- {{ view.reason_email }} - • - {% trans %}Unsubscribe or manage preferences{% endtrans %} -
- {%- endif %} - {% endblock footer %}
+
+
+ {# Email Header : BEGIN #}
+
+
+ {# Email Header : END #}
+
+ {# Email Header : BODY #}
+
+
+
+
+
+
+ {# Email Footer : BEGIN #}
+
+  }}){kind=logo}
+ |
+
| + | + + ++ | + + + + ++ | + +|
| + + |
+ {#
+ Set the email width. Defined in two places:
+ 1. max-width for all clients except Desktop Windows Outlook, allowing the email to squish on narrow but never go wider than 600px.
+ 2. MSO tags for Desktop Windows Outlook enforce a 600px width.
+ #}
+
+
+
+
+ {# Email content : BEGIN #}
+
+
|
+
+ + | |
| + | + + ++ | + + + ++ | + +
|
+ {% trans %}Hasgeek Learning Private Limited{% endtrans %} + {% trans %}Need help?{% endtrans %} {{ config['SITE_SUPPORT_EMAIL'] }} • {{ config['SITE_SUPPORT_PHONE_FORMATTED'] }} + {%- if view %}{# Notification view #} + + {% if view.reason_email %} {{ view.reason_email }} • {% endif %}{% trans %}Unsubscribe or manage preferences{% endtrans %} + {%- endif %} + |
+