wp-calypso/client/reader/controller.js

import page from '@automattic/calypso-router';
import { getAnyLanguageRouteParam, getLanguageRouteParam } from '@automattic/i18n-utils';
import i18n from 'i18n-calypso';
import { createElement } from 'react';
import AsyncLoad from 'calypso/components/async-load';
import { sectionify } from 'calypso/lib/route';
import wpcom from 'calypso/lib/wp';
import FeedError from 'calypso/reader/feed-error';
import StreamComponent from 'calypso/reader/following/main';
import { isAutomatticTeamMember } from 'calypso/reader/lib/teams';
import { recordTrack } from 'calypso/reader/stats';
import { isUserLoggedIn } from 'calypso/state/current-user/selectors';
import { getLastPath } from 'calypso/state/reader-ui/selectors';
import { toggleReaderSidebarFollowing } from 'calypso/state/reader-ui/sidebar/actions';
import { isFollowingOpen } from 'calypso/state/reader-ui/sidebar/selectors';
import getCurrentRoute from 'calypso/state/selectors/get-current-route';
import { getReaderTeams } from 'calypso/state/teams/selectors';
import { getSection } from 'calypso/state/ui/selectors';
import { setupRedirectRoutes } from 'calypso/utils';
import {
	trackPageLoad,
	trackUpdatesLoaded,
	trackScrollPage,
	setPageTitle,
	getStartDate,
} from './controller-helper';

const analyticsPageTitle = 'Reader';

function renderFeedError( context, next ) {
	context.primary = createElement( FeedError );
	next();
}

export function sidebar( context, next ) {
	const state = context.store.getState();
	if ( isUserLoggedIn( state ) ) {
		context.secondary = (
			<AsyncLoad require="calypso/reader/sidebar" path={ context.path } placeholder={ null } />
		);
	}

	next();
}

export function unmountSidebar( context, next ) {
	next();
}

export function following( context, next ) {
	const basePath = sectionify( context.path );
	const fullAnalyticsPageTitle = analyticsPageTitle + ' > Following';
	const mcKey = 'following';
	const startDate = getStartDate( context );

	const state = context.store.getState();
	// only for a8c for now
	if ( isAutomatticTeamMember( getReaderTeams( state ) ) ) {
		// select last reader path if available, otherwise just open following
		const currentSection = getSection( state );
		const lastPath = getLastPath( state );

		if ( lastPath && lastPath !== '/reader' && currentSection.name !== 'reader' ) {
			return page.redirect( lastPath );
		}

		// if we have no last path, default to Following/All and expand following
		const isOpen = isFollowingOpen( state );
		if ( ! isOpen ) {
			context.store.dispatch( toggleReaderSidebarFollowing() );
		}
	}

	trackPageLoad( basePath, fullAnalyticsPageTitle, mcKey );
	recordTrack(
		'calypso_reader_following_loaded',
		{},
		{ pathnameOverride: getCurrentRoute( state ) }
	);

	setPageTitle( context, i18n.translate( 'Following' ) );

	// warn: don't async load this only. we need it to keep feed-post-store in the reader bundle
	context.primary = createElement( StreamComponent, {
		key: 'following',
		listName: i18n.translate( 'Followed Sites' ),
		streamKey: 'following',
		startDate,
		recsStreamKey: 'custom_recs_posts_with_images',
		trackScrollPage: trackScrollPage.bind(
			null,
			basePath,
			fullAnalyticsPageTitle,
			analyticsPageTitle,
			mcKey
		),
		onUpdatesShown: trackUpdatesLoaded.bind( null, mcKey ),
		feedId: context.params.feed_id,
	} );
	next();
}

export function feedDiscovery( context, next ) {
	if ( ! context.params.feed_id.match( /^\d+$/ ) ) {
		const url = context.params.feed_id;
		context.queryClient
			.fetchQuery( {
				queryKey: [ 'feed-discovery', url ],
				queryFn: () =>
					wpcom.req.get( '/read/feed', { url } ).then( ( res ) => res.feeds[ 0 ].feed_ID ),
				meta: { persist: false },
			} )
			.then( ( feedId ) => {
				page.redirect( `/reader/feeds/${ feedId }` );
			} )
			.catch( () => {
				renderFeedError( context, next );
			} );
	} else {
		next();
	}
}

export function feedListing( context, next ) {
	const feedId = context.params.feed_id;
	if ( ! parseInt( feedId, 10 ) ) {
		next();
		return;
	}

	const basePath = '/reader/feeds/:feed_id';
	const fullAnalyticsPageTitle = analyticsPageTitle + ' > Feed > ' + feedId;
	const mcKey = 'blog';

	trackPageLoad( basePath, fullAnalyticsPageTitle, mcKey );
	recordTrack( 'calypso_reader_blog_preview', { feed_id: feedId } );

	context.primary = (
		<AsyncLoad
			require="calypso/reader/feed-stream"
			key={ 'feed-' + feedId }
			streamKey={ 'feed:' + feedId }
			feedId={ +feedId }
			trackScrollPage={ trackScrollPage.bind(
				null,
				basePath,
				fullAnalyticsPageTitle,
				analyticsPageTitle,
				mcKey
			) }
			onUpdatesShown={ trackUpdatesLoaded.bind( null, mcKey ) }
			suppressSiteNameLink
			placeholder={ null }
		/>
	);
	next();
}

export function blogListing( context, next ) {
	const basePath = '/reader/blogs/:blog_id';
	const blogId = context.params.blog_id;
	const fullAnalyticsPageTitle = analyticsPageTitle + ' > Site > ' + blogId;
	const streamKey = 'site:' + blogId;
	const mcKey = 'blog';

	trackPageLoad( basePath, fullAnalyticsPageTitle, mcKey );
	recordTrack( 'calypso_reader_blog_preview', {
		blog_id: context.params.blog_id,
	} );

	context.primary = (
		<AsyncLoad
			require="calypso/reader/site-stream"
			key={ 'site-' + blogId }
			streamKey={ streamKey }
			siteId={ +blogId }
			trackScrollPage={ trackScrollPage.bind(
				null,
				basePath,
				fullAnalyticsPageTitle,
				analyticsPageTitle,
				mcKey
			) }
			onUpdatesShown={ trackUpdatesLoaded.bind( null, mcKey ) }
			suppressSiteNameLink
			placeholder={ null }
		/>
	);
	next();
}

export function readA8C( context, next ) {
	const basePath = sectionify( context.path );
	const fullAnalyticsPageTitle = analyticsPageTitle + ' > A8C';
	const mcKey = 'a8c';
	const streamKey = 'a8c';
	const startDate = getStartDate( context );

	trackPageLoad( basePath, fullAnalyticsPageTitle, mcKey );

	setPageTitle( context, 'Automattic' );

	/* eslint-disable wpcalypso/jsx-classname-namespace */
	context.primary = (
		<AsyncLoad
			require="calypso/reader/a8c/main"
			key="read-a8c"
			className="is-a8c"
			listName="Automattic"
			streamKey={ streamKey }
			startDate={ startDate }
			trackScrollPage={ trackScrollPage.bind(
				null,
				basePath,
				fullAnalyticsPageTitle,
				analyticsPageTitle,
				mcKey
			) }
			onUpdatesShown={ trackUpdatesLoaded.bind( null, mcKey ) }
			placeholder={ null }
		/>
	);
	/* eslint-enable wpcalypso/jsx-classname-namespace */
	next();
}

export function readFollowingP2( context, next ) {
	const basePath = sectionify( context.path );
	const fullAnalyticsPageTitle = analyticsPageTitle + ' > P2';
	const mcKey = 'p2';
	const streamKey = 'p2';
	const startDate = getStartDate( context );

	trackPageLoad( basePath, fullAnalyticsPageTitle, mcKey );

	setPageTitle( context, 'P2' );

	/* eslint-disable wpcalypso/jsx-classname-namespace */
	context.primary = (
		<AsyncLoad
			require="calypso/reader/p2/main"
			key="read-p2"
			listName="P2"
			streamKey={ streamKey }
			startDate={ startDate }
			trackScrollPage={ trackScrollPage.bind(
				null,
				basePath,
				fullAnalyticsPageTitle,
				analyticsPageTitle,
				mcKey
			) }
			onUpdatesShown={ trackUpdatesLoaded.bind( null, mcKey ) }
			placeholder={ null }
		/>
	);
	/* eslint-enable wpcalypso/jsx-classname-namespace */
	next();
}

export async function blogDiscoveryByFeedId( context, next ) {
	const { blog, feed_id } = context.params;

	// If we have already had blog or we don't have feed_id, call `next()` immediately
	if ( blog || ! feed_id ) {
		next();
		return;
	}

	// Query the site by feed_id and inject to the context params so that calypso can get correct site
	// after redirecting the user to log-in page
	context.queryClient
		.fetchQuery( {
			queryKey: [ '/read/feed/', feed_id ],
			queryFn: () => wpcom.req.get( `/read/feed/${ feed_id }` ).then( ( res ) => res.blog_ID ),
			meta: { persist: false },
		} )
		.then( ( blog_id ) => {
			context.params.blog_id = blog_id;
			next();
		} )
		.catch( () => {
			renderFeedError( context, next );
		} );
}

export async function siteSubscriptionsManager( context, next ) {
	const basePath = sectionify( context.path );
	const fullAnalyticsPageTitle = analyticsPageTitle + ' > Subscription Management > Sites';
	const mcKey = 'subscription-sites';
	trackPageLoad( basePath, fullAnalyticsPageTitle, mcKey );

	context.primary = <AsyncLoad require="calypso/reader/site-subscriptions-manager" />;
	return next();
}

export async function siteSubscription( context, next ) {
	// It can be the 2 following:
	// - /reader/subscriptions/<subscription_id>
	// - /reader/site/subscription
	const basePath = context.params.subscription_id
		? '/reader/subscriptions/<subscription_id>'
		: sectionify( context.path );

	const fullAnalyticsPageTitle =
		analyticsPageTitle +
		' > Subscription Management > Site ' +
		( context.params.subscription_id
			? 'Subscription: ' + context.params.subscription_id
			: 'Blog: ' + context.params.blog_id );
	const mcKey = 'subscription-site';
	trackPageLoad( basePath, fullAnalyticsPageTitle, mcKey );

	context.primary = (
		<AsyncLoad
			require="calypso/reader/site-subscription"
			subscriptionId={ context.params.subscription_id }
			blogId={ context.params.blog_id }
			transition={ context.query.transition === 'true' }
		/>
	);
	return next();
}

export async function commentSubscriptionsManager( context, next ) {
	const basePath = sectionify( context.path );
	const fullAnalyticsPageTitle = analyticsPageTitle + ' > Subscription Management > Comments';
	const mcKey = 'subscription-comments';
	trackPageLoad( basePath, fullAnalyticsPageTitle, mcKey );

	context.primary = (
		<AsyncLoad require="calypso/reader/site-subscriptions-manager/comment-subscriptions-manager" />
	);
	return next();
}

export async function pendingSubscriptionsManager( context, next ) {
	const basePath = sectionify( context.path );
	const fullAnalyticsPageTitle = analyticsPageTitle + ' > Subscription Management > Comments';
	const mcKey = 'subscription-pending';
	trackPageLoad( basePath, fullAnalyticsPageTitle, mcKey );

	context.primary = (
		<AsyncLoad require="calypso/reader/site-subscriptions-manager/pending-subscriptions-manager" />
	);
	return next();
}

/**
 * Middleware to redirect logged out users to /discover.
 * Intended for reader pages that do not support logged out users such as /reader.
 * @param   {Object}   context Context object
 * @param   {Function} next    Calls next middleware
 * @returns {void}
 */
export function redirectLoggedOutToDiscover( context, next ) {
	const state = context.store.getState();
	if ( isUserLoggedIn( state ) ) {
		next();
		return;
	}
	return page.redirect( '/discover' );
}

/**
 * For backward compatibility redirect all `/read` URLs to `/reader`.
 */
export function setupReadRoutes() {
	const langParam = getLanguageRouteParam();
	const anyLangParam = getAnyLanguageRouteParam();

	const readRedirectsList = [
		{
			path: '/read',
			getRedirect: () => '/reader',
		},
		{
			path: `/${ langParam }/read`,
			getRedirect: () => '/reader',
		},
		{
			path: `/${ anyLangParam }/read`,
			getRedirect: () => '/reader',
		},
		{
			path: '/read/a8c',
			getRedirect: () => '/reader/a8c',
		},
		{
			path: '/read/blog',
			getRedirect: () => '/reader',
		},
		// Feed Stream.
		{
			path: '/read/blog/feed/:feed_id',
			regex: /^\/read\/blog\/feed\/([0-9]+)$/i,
			getRedirect: ( params ) => `/reader/feeds/${ params.feed_id }`,
		},
		// Old Blog View.
		{
			path: '/read/blog/id/:blog_id',
			regex: /^\/read\/blog\/id\/([0-9]+)$/i,
			getRedirect: ( params ) => `/reader/blogs/${ params.blog_id }`,
		},
		{
			path: '/read/blogs',
			getRedirect: () => '/reader',
		},
		{
			path: '/read/blogs/:blog_id',
			regex: /^\/read\/blogs\/([0-9]+)$/i,
			getRedirect: ( params ) => `/reader/blogs/${ params.blog_id }`,
		},
		{
			path: '/read/blogs/:blog_id/posts',
			regex: /^\/read\/blogs\/([0-9]+)\/posts$/i,
			getRedirect: ( params ) => `/reader/blogs/${ params.blog_id }`,
		},
		{
			path: '/read/blogs/:blog_id/posts/:post_id',
			regex: /^\/read\/blogs\/([0-9]+)\/posts\/([0-9]+)$/i,
			getRedirect: ( params ) => `/reader/blogs/${ params.blog_id }/posts/${ params.post_id }`,
		},
		{
			path: '/read/conversations',
			getRedirect: () => '/reader/conversations',
		},
		{
			path: '/read/conversations/a8c',
			getRedirect: () => '/reader/conversations/a8c',
		},
		{
			path: '/read/feed',
			getRedirect: () => '/reader',
		},
		{
			path: '/read/feeds',
			getRedirect: () => '/reader',
		},
		{
			path: '/read/feeds/:feed_id',
			regex: /^\/read\/feeds\/([0-9]+)$/i,
			getRedirect: ( params ) => `/reader/feeds/${ params.feed_id }`,
		},
		{
			path: '/read/feeds/:feed_id/posts',
			regex: /^\/read\/feeds\/([0-9]+)\/posts$/i,
			getRedirect: ( params ) => `/reader/feeds/${ params.feed_id }`,
		},
		{
			path: '/read/feeds/:feed_id/posts/:feed_item_id',
			regex: /^\/read\/feeds\/([0-9]+)\/posts\/([0-9]+)$/i,
			getRedirect: ( params ) => `/reader/feeds/${ params.feed_id }/posts/${ params.feed_item_id }`,
		},
		{
			path: '/read/following',
			getRedirect: () => '/reader',
		},
		{
			path: '/read/list/new',
			getRedirect: () => '/reader/list/new',
		},
		{
			path: '/read/list/:owner/:slug',
			regex: /^\/read\/list\/([^/]+)\/([^/]+)$/i,
			getRedirect: ( params ) => `/reader/list/${ params.owner }/${ params.slug }`,
		},
		{
			path: '/read/list/:owner/:slug/edit',
			regex: /^\/read\/list\/([^/]+)\/([^/]+)\/edit$/i,
			getRedirect: ( params ) => `/reader/list/${ params.owner }/${ params.slug }/edit`,
		},
		{
			path: '/read/list/:owner/:slug/edit/items',
			regex: /^\/read\/list\/([^/]+)\/([^/]+)\/edit\/items$/i,
			getRedirect: ( params ) => `/reader/list/${ params.owner }/${ params.slug }/edit/items`,
		},
		{
			path: '/read/list/:owner/:slug/export',
			regex: /^\/read\/list\/([^/]+)\/([^/]+)\/export$/i,
			getRedirect: ( params ) => `/reader/list/${ params.owner }/${ params.slug }/export`,
		},
		{
			path: '/read/list/:owner/:slug/delete',
			regex: /^\/read\/list\/([^/]+)\/([^/]+)\/delete$/i,
			getRedirect: ( params ) => `/reader/list/${ params.owner }/${ params.slug }/delete`,
		},
		{
			path: '/read/notifications',
			getRedirect: () => '/reader/notifications',
		},
		{
			path: '/read/p2',
			getRedirect: () => '/reader/p2',
		},
		{
			path: '/read/post',
			getRedirect: () => '/reader',
		},
		// Old Full Post View.
		{
			path: '/read/post/feed/:feed_id/:post_id',
			regex: /^\/read\/post\/feed\/([0-9]+)\/([0-9]+)$/i,
			getRedirect: ( params ) => `/reader/feeds/${ params.feed_id }/posts/${ params.post_id }`,
		},
		// Old Full Post View.
		{
			path: '/read/post/id/:blog_id/:post_id',
			regex: /^\/read\/post\/id\/([0-9]+)\/([0-9]+)$/i,
			getRedirect: ( params ) => `/reader/blogs/${ params.blog_id }/posts/${ params.post_id }`,
		},
		{
			path: '/read/search',
			getRedirect: () => '/reader/search',
		},
		{
			path: `/${ langParam }/read/search`,
			getRedirect: () => `/reader/search`,
		},
		{
			path: `/${ anyLangParam }/read/search`,
			getRedirect: () => `/reader/search`,
		},
		{
			path: '/read/site/subscription/:blog_id',
			regex: /^\/read\/site\/subscription\/([0-9]+)$/i,
			getRedirect: ( params ) => `/reader/site/subscription/${ params.blog_id }`,
		},
		{
			path: '/read/subscriptions',
			getRedirect: () => '/reader/subscriptions',
		},
		{
			path: '/read/subscriptions/:subscription_id',
			regex: /^\/read\/subscriptions\/([0-9]+)$/i,
			getRedirect: ( params ) => `/reader/subscriptions/${ params.subscription_id }`,
		},
		{
			path: '/read/subscriptions/comments',
			getRedirect: () => '/reader/subscriptions/comments',
		},
		{
			path: '/read/subscriptions/pending',
			getRedirect: () => '/reader/subscriptions/pending',
		},
		{
			path: '/read/tag/:tag_name',
			regex: /^\/read\/tag\/([^/]+)$/i,
			getRedirect: ( params ) => `/tag/${ params.tag_name }`,
		},
		{
			path: '/read/users/:user_login',
			regex: /^\/read\/users\/([^/]+)$/i,
			getRedirect: ( params ) => `/reader/users/${ params.user_login }`,
		},
		{
			path: '/read/users/:user_login/lists',
			regex: /^\/read\/users\/([^/]+)\/lists$/i,
			getRedirect: ( params ) => `/reader/users/${ params.user_login }/lists`,
		},
	];

	setupRedirectRoutes( readRedirectsList );
}