Router.php

<?php

namespace App;

/**
 * @author Marien Fressinaud <dev@marienfressinaud.fr>
 * @license http://www.gnu.org/licenses/agpl-3.0.en.html AGPL
 */
class Router
{
    /**
     * Return the application router (doesn't contain CLI routes)
     */
    public static function load(): \Minz\Router
    {
        $router = new \Minz\Router();

        $router->addRoute('GET', '/', 'Pages#home', 'home');
        $router->addRoute('GET', '/terms', 'Pages#terms', 'terms');
        $router->addRoute('GET', '/about', 'Pages#about', 'about');
        $router->addRoute('GET', '/about/new', 'Feeds#whatIsNew', 'what is new');
        $router->addRoute('GET', '/addons', 'Pages#addons', 'addons');
        $router->addRoute('GET', '/robots.txt', 'Pages#robots', 'robots.txt');
        $router->addRoute('GET', '/app.webmanifest', 'Pages#webmanifest', 'webmanifest');
        $router->addRoute('GET', '/.well-known/change-password', 'WellKnown#changePassword');
        $router->addRoute('GET', '/share', 'Shares#new', 'share');

        $router->addRoute('GET', '/support', 'Support#show', 'support');
        $router->addRoute('POST', '/support', 'Support#create', 'call support');

        $router->addRoute('GET', '/showcases/:id', 'Showcases#show', 'showcase');

        $router->addRoute('GET', '/altcha', 'Altcha#show', 'altcha');

        // Registration
        $router->addRoute('GET', '/registration', 'Registrations#new', 'registration');
        $router->addRoute('POST', '/registration', 'Registrations#create', 'create user');

        // Sessions
        $router->addRoute('GET', '/login', 'Sessions#new', 'login');
        $router->addRoute('POST', '/login', 'Sessions#create', 'create session');
        $router->addRoute('POST', '/logout', 'Sessions#delete', 'logout');
        $router->addRoute('POST', '/sessions/locale', 'Sessions#changeLocale', 'change locale');

        // Reset password
        $router->addRoute('GET', '/password/forgot', 'Passwords#forgot', 'forgot password');
        $router->addRoute('POST', '/password/forgot', 'Passwords#reset', 'reset password');
        $router->addRoute('GET', '/password/edit', 'Passwords#edit', 'edit password');
        $router->addRoute('POST', '/password/edit', 'Passwords#update', 'update password');

        // Onboarding
        $router->addRoute('GET', '/onboarding', 'Onboarding#show', 'onboarding');
        $router->addRoute('POST', '/onboarding/locale', 'Onboarding#updateLocale', 'onboarding update locale');

        // Profile
        $router->addRoute('GET', '/p/:id', 'profiles/Links#index', 'profile');
        $router->addRoute('GET', '/p/:id/links', 'profiles/Links#index', 'profile links');
        $router->addRoute('GET', '/p/:id/collections', 'profiles/Collections#index', 'profile collections');
        $router->addRoute('GET', '/p/:id/streams', 'profiles/Streams#index', 'profile streams');
        $router->addRoute('GET', '/p/:id/feed.atom.xml', 'profiles/Feeds#show', 'profile feed');
        $router->addRoute('GET', '/p/:id/feed', 'profiles/Feeds#alias');
        $router->addRoute('GET', '/p/:id/opml.xml', 'profiles/Opml#show', 'profile opml');
        $router->addRoute('GET', '/p/:id/opml', 'profiles/Opml#alias');
        $router->addRoute('GET', '/my/profile', 'my/Profile#edit', 'edit profile');
        $router->addRoute('POST', '/my/profile', 'my/Profile#update', 'update profile');
        $router->addRoute('GET', '/my/profile/avatar', 'my/Avatar#edit', 'edit avatar');
        $router->addRoute('POST', '/my/profile/avatar', 'my/Avatar#update', 'update avatar');

        // "My" section
        $router->addRoute('GET', '/my/security', 'my/Security#show', 'security');
        $router->addRoute('POST', '/my/security', 'my/Security#update', 'update security');
        $router->addRoute('GET', '/my/security/confirmation', 'my/Security#confirmation', 'password confirmation');
        $router->addRoute('POST', '/my/security/confirmation', 'my/Security#confirm', 'confirm password');

        $router->addRoute('GET', '/my/account', 'my/Account#show', 'account');

        $router->addRoute('GET', '/my/account/validation', 'my/Validation#show', 'account validation');
        $router->addRoute('GET', '/my/account/validation/new', 'my/Validation#new', 'new account validation');
        $router->addRoute('POST', '/my/account/validation/new', 'my/Validation#create', 'create account validation');
        $router->addRoute(
            'POST',
            '/my/account/validation/email',
            'my/Validation#resendEmail',
            'resend validation email'
        );

        $router->addRoute('GET', '/my/account/deletion', 'my/Account#deletion', 'account deletion');
        $router->addRoute('POST', '/my/account/deletion', 'my/Account#delete', 'delete account');

        $router->addRoute('GET', '/my/account/subscription', 'my/Subscription#redirect', 'subscription');
        $router->addRoute('POST', '/my/account/subscription', 'my/Subscription#create', 'create subscription account');

        $router->addRoute('GET', '/my/preferences', 'my/Preferences#edit', 'preferences');
        $router->addRoute('POST', '/my/preferences', 'my/Preferences#update', 'update preferences');

        $router->addRoute('GET', '/my/sessions', 'my/Sessions#index', 'sessions');
        $router->addRoute('POST', '/my/sessions/:id/deletion', 'my/Sessions#delete', 'delete session');

        // Mastodon configuration
        $router->addRoute('GET', '/mastodon', 'Mastodon#show', 'mastodon');
        $router->addRoute('POST', '/mastodon', 'Mastodon#update', 'update mastodon account');
        $router->addRoute('POST', '/mastodon/request', 'Mastodon#requestAccess', 'request mastodon access');
        $router->addRoute('GET', '/mastodon/auth', 'Mastodon#authorization', 'mastodon auth');
        $router->addRoute('POST', '/mastodon/auth', 'Mastodon#authorize', 'authorize mastodon');
        $router->addRoute('POST', '/mastodon/reconnect', 'Mastodon#reconnect', 'reconnect mastodon');
        $router->addRoute('POST', '/mastodon/disconnect', 'Mastodon#disconnect', 'disconnect mastodon');

        // Importations
        $router->addRoute('GET', '/importations/:id', 'Importations#show', 'importation');
        $router->addRoute('POST', '/importations/:id/delete', 'Importations#delete', 'delete importation');

        // Exportations
        $router->addRoute('GET', '/exportations', 'Exportations#show', 'exportation');
        $router->addRoute('POST', '/exportations', 'Exportations#create', 'create exportation');
        $router->addRoute('GET', '/exportations/download', 'Exportations#download', 'download exportation');

        // Journal page
        $router->addRoute('GET', '/journal', 'Journal#index', 'journal');
        $router->addRoute('POST', '/journal', 'Journal#create', 'fill journal');
        $router->addRoute('GET', '/journal/candidates.json', 'Journal#hasCandidates', 'journal candidates');
        $router->addRoute('GET', '/news', 'Journal#news', 'news');

        // Collections
        $router->addRoute('GET', '/collections', 'Collections#index', 'collections');
        $router->addRoute('GET', '/collections/new', 'Collections#new', 'new collection');
        $router->addRoute('POST', '/collections/new', 'Collections#create', 'create collection');
        $router->addRoute('GET', '/collections/discover', 'collections/Discovery#show', 'discover collections');
        $router->addRoute('GET', '/collections/:id', 'Collections#show', 'collection');
        $router->addRoute('GET', '/collections/:id/links/new', 'collections/Links#new', 'new collection link');
        $router->addRoute('POST', '/collections/:id/links/new', 'collections/Links#create', 'create collection link');
        $router->addRoute('GET', '/collections/:id/feed.atom.xml', 'collections/Feeds#show', 'collection feed');
        $router->addRoute('GET', '/collections/:id/feed', 'collections/Feeds#alias');
        $router->addRoute('GET', '/collections/:id/edit', 'Collections#edit', 'edit collection');
        $router->addRoute('POST', '/collections/:id/edit', 'Collections#update', 'update collection');
        $router->addRoute('POST', '/collections/:id/delete', 'Collections#delete', 'delete collection');
        $router->addRoute('POST', '/collections/:id/follow', 'collections/Followers#create', 'follow collection');
        $router->addRoute('POST', '/collections/:id/unfollow', 'collections/Followers#delete', 'unfollow collection');
        $router->addRoute(
            'GET',
            '/collections/:id/follow/edit',
            'collections/Followers#edit',
            'edit collection follow'
        );
        $router->addRoute(
            'POST',
            '/collections/:id/follow/edit',
            'collections/Followers#update',
            'update collection follow'
        );
        $router->addRoute(
            'GET',
            '/collections/:id/follow/image',
            'collections/followers/Images#edit',
            'edit collection follow image'
        );
        $router->addRoute(
            'POST',
            '/collections/:id/follow/image',
            'collections/followers/Images#update',
            'update collection follow image'
        );
        $router->addRoute('GET', '/collections/:id/group', 'collections/Groups#edit', 'edit group collection');
        $router->addRoute('POST', '/collections/:id/group', 'collections/Groups#update', 'update group collection');
        $router->addRoute('GET', '/collections/:id/image', 'collections/Images#edit', 'edit image collection');
        $router->addRoute('POST', '/collections/:id/image', 'collections/Images#update', 'update image collection');
        $router->addRoute('POST', '/collections/:id/read', 'collections/Read#create', 'mark collection as read');
        $router->addRoute('POST', '/collections/:id/read/later', 'collections/Read#later', 'read collection later');
        $router->addRoute('POST', '/collections/:id/dismiss', 'collections/Read#dismiss', 'dismiss collection');
        $router->addRoute('GET', '/collections/:id/share', 'collections/Shares#index', 'collection shares');
        $router->addRoute('POST', '/collections/:id/share', 'collections/Shares#create', 'share collection');
        $router->addRoute('POST', '/collections/:id/unshare', 'collections/Shares#delete', 'unshare collection');

        $router->addRoute('GET', '/read', 'Read#index', 'read list');
        $router->addRoute('GET', '/read/later', 'ReadLater#index', 'read later');
        $router->addRoute('GET', '/read/later/new', 'ReadLater#new', 'new read later');
        $router->addRoute('POST', '/read/later/new', 'ReadLater#create', 'create read later');
        $router->addRoute('GET', '/bookmarks', 'ReadLater#bookmarks', 'bookmarks');

        // Links
        $router->addRoute('GET', '/links', 'Links#index', 'links');
        $router->addRoute('GET', '/links/new', 'Links#new', 'new link');
        $router->addRoute('POST', '/links/new', 'Links#create', 'create link');
        $router->addRoute('GET', '/links/search', 'links/Searches#show', 'show search link');
        $router->addRoute('POST', '/links/search', 'links/Searches#create', 'search link');
        $router->addRoute('GET', '/links/:id', 'Links#show', 'link');
        $router->addRoute('GET', '/links/:id/feed.atom.xml', 'links/Feeds#show', 'link feed');
        $router->addRoute('GET', '/links/:id/feed', 'links/Feeds#alias');
        $router->addRoute('GET', '/links/:id/edit', 'Links#edit', 'edit link');
        $router->addRoute('POST', '/links/:id/edit', 'Links#update', 'update link');
        $router->addRoute('GET', '/links/:id/image', 'links/Images#edit', 'edit image link');
        $router->addRoute('POST', '/links/:id/image', 'links/Images#update', 'update image link');
        $router->addRoute('GET', '/links/:id/repair', 'links/Repairing#new', 'repairing link');
        $router->addRoute('POST', '/links/:id/repair', 'links/Repairing#create', 'repair link');
        $router->addRoute('POST', '/links/:id/delete', 'Links#delete', 'delete link');
        $router->addRoute('POST', '/links/:id/read', 'links/Read#create', 'mark link as read');
        $router->addRoute('POST', '/links/:id/read/later', 'links/Read#later', 'read link later');
        $router->addRoute('POST', '/links/:id/dismiss', 'links/Read#dismiss', 'dismiss link');
        $router->addRoute('POST', '/links/:id/read/delete', 'links/Read#delete', 'mark link as unread');
        $router->addRoute(
            'GET',
            '/links/:id/shares/mastodon',
            'links/MastodonThreads#new',
            'new link mastodon thread',
        );
        $router->addRoute(
            'POST',
            '/links/:id/shares/mastodon',
            'links/MastodonThreads#create',
            'create link mastodon thread',
        );
        $router->addRoute(
            'GET',
            '/links/:id/shares/mastodon/created',
            'links/MastodonThreads#created',
            'link mastodon thread created',
        );

        // Link collections
        $router->addRoute('GET', '/links/:id/collections', 'links/Collections#index', 'link collections');
        $router->addRoute('POST', '/links/:id/collections', 'links/Collections#update', 'update link collections');

        // Notes
        $router->addRoute('GET', '/links/:link_id/notes', 'links/Notes#index', 'links/notes');
        $router->addRoute('POST', '/links/:link_id/notes', 'links/Notes#create', 'links/create note');
        $router->addRoute('GET', '/notes/:id/edit', 'Notes#edit', 'edit note');
        $router->addRoute('POST', '/notes/:id/edit', 'Notes#update', 'update note');
        $router->addRoute('POST', '/notes/:id/delete', 'Notes#delete', 'delete note');

        // Groups
        $router->addRoute('GET', '/groups/:id/edit', 'Groups#edit', 'edit group');
        $router->addRoute('POST', '/groups/:id/edit', 'Groups#update', 'update group');
        $router->addRoute('POST', '/groups/:id/delete', 'Groups#delete', 'delete group');

        // Feeds
        $router->addRoute('GET', '/feeds', 'Feeds#index', 'feeds');
        $router->addRoute('GET', '/feeds/new', 'Feeds#new', 'new feed');
        $router->addRoute('POST', '/feeds/new', 'Feeds#create', 'create feed');

        $router->addRoute('GET', '/feeds.xsl', 'Feeds#xsl', 'feeds xsl');

        // Sources
        $router->addRoute('GET', '/sources', 'Sources#index', 'sources');
        $router->addRoute('GET', '/sources/opml.xml', 'sources/Opml#show', 'sources opml');
        $router->addRoute('POST', '/sources/opml', 'sources/Opml#import', 'import sources opml');
        $router->addRoute('GET', '/opml', 'sources/Opml#alias');
        $router->addRoute('POST', '/sources/unfollow', 'sources/Follows#delete', 'unfollow sources');
        $router->addRoute(
            'POST',
            '/sources/time-filter',
            'sources/Follows#updateTimeFilter',
            'update sources time filter',
        );

        // Streams
        $router->addRoute('GET', '/streams/new', 'Streams#new', 'new stream');
        $router->addRoute('POST', '/streams/new', 'Streams#create', 'create stream');
        $router->addRoute('GET', '/streams/:id', 'Streams#show', 'stream');
        $router->addRoute('GET', '/streams/:id/feed.atom.xml', 'streams/Feeds#show', 'stream feed');
        $router->addRoute('GET', '/streams/:id/feed', 'streams/Feeds#alias');
        $router->addRoute('GET', '/streams/:id/opml.xml', 'streams/Opml#show', 'stream opml');
        $router->addRoute('GET', '/streams/:id/opml', 'streams/Opml#alias');
        $router->addRoute('GET', '/streams/:id/edit', 'Streams#edit', 'edit stream');
        $router->addRoute('POST', '/streams/:id/edit', 'Streams#update', 'update stream');
        $router->addRoute('POST', '/streams/:id/delete', 'Streams#delete', 'delete stream');
        $router->addRoute('GET', '/streams/:id/image', 'streams/Images#edit', 'edit image stream');
        $router->addRoute('POST', '/streams/:id/image', 'streams/Images#update', 'update image stream');
        $router->addRoute('POST', '/streams/:id/read', 'streams/Read#create', 'mark stream as read');
        $router->addRoute('POST', '/streams/:id/read/later', 'streams/Read#later', 'read stream later');
        $router->addRoute('POST', '/streams/:id/dismiss', 'streams/Read#dismiss', 'dismiss stream');
        $router->addRoute('GET', '/streams/:id/views/new', 'streams/Views#new', 'new stream view');
        $router->addRoute('POST', '/streams/:id/views/new', 'streams/Views#create', 'create stream view');
        $router->addRoute('POST', '/streams/:id/views/:view_id/save', 'streams/Views#save', 'save stream view');
        $router->addRoute('GET', '/streams/:id/views/:view_id/edit', 'streams/Views#edit', 'edit stream view');
        $router->addRoute('POST', '/streams/:id/views/:view_id/edit', 'streams/Views#update', 'update stream view');
        $router->addRoute('POST', '/streams/:id/views/:view_id/delete', 'streams/Views#delete', 'delete stream view');
        $router->addRoute('GET', '/streams/:id/sources', 'streams/Sources#index', 'stream sources');
        $router->addRoute('GET', '/streams/:id/sources/edit', 'streams/Sources#edit', 'edit stream sources');
        $router->addRoute(
            'GET',
            '/streams/:id/sources/feeds/new',
            'streams/Sources#newFeed',
            'new stream source feed',
        );
        $router->addRoute(
            'POST',
            '/streams/:id/sources/feeds/new',
            'streams/Sources#createFeed',
            'create stream source feed',
        );
        $router->addRoute(
            'POST',
            '/streams/:id/sources/add',
            'streams/Sources#addAll',
            'add stream sources',
        );
        $router->addRoute(
            'POST',
            '/streams/:id/sources/remove',
            'streams/Sources#removeAll',
            'remove stream sources',
        );
        $router->addRoute(
            'POST',
            '/streams/:id/sources/:source_id/add',
            'streams/Sources#add',
            'add stream source',
        );
        $router->addRoute(
            'POST',
            '/streams/:id/sources/:source_id/remove',
            'streams/Sources#remove',
            'remove stream source',
        );
        $router->addRoute('GET', '/streams/:id/share', 'streams/Shares#index', 'stream shares');
        $router->addRoute('POST', '/streams/:id/share', 'streams/Shares#create', 'share stream');
        $router->addRoute('POST', '/streams/:id/unshare', 'streams/Shares#delete', 'unshare stream');

        // Explore
        $router->addRoute('GET', '/explore', 'Explore#show', 'explore');
        $router->addRoute('GET', '/discovery', 'Explore#discovery', 'discovery');
        $router->addRoute('GET', '/topics/:id', 'Explore#topic', 'topic');

        // API v1
        $router->addRoute('POST', '/api/v1/sessions', 'api/v1/Sessions#create');
        $router->addRoute('DELETE', '/api/v1/session', 'api/v1/Sessions#delete');

        $router->addRoute('GET', '/api/v1/collections', 'api/v1/Collections#index');
        $router->addRoute('POST', '/api/v1/collections', 'api/v1/Collections#create');
        $router->addRoute('GET', '/api/v1/collections/:id', 'api/v1/Collections#show');
        $router->addRoute('PATCH', '/api/v1/collections/:id', 'api/v1/Collections#update');
        $router->addRoute('DELETE', '/api/v1/collections/:id', 'api/v1/Collections#delete');
        $router->addRoute('POST', '/api/v1/collections/:id/follow', 'api/v1/collections/Follow#create');
        $router->addRoute('DELETE', '/api/v1/collections/:id/follow', 'api/v1/collections/Follow#delete');
        $router->addRoute('POST', '/api/v1/search', 'api/v1/Searches#create');
        $router->addRoute('GET', '/api/v1/journal', 'api/v1/Journal#show');
        $router->addRoute('POST', '/api/v1/journal', 'api/v1/Journal#create');
        $router->addRoute('POST', '/api/v1/journal/read', 'api/v1/journal/Read#create');
        $router->addRoute('POST', '/api/v1/journal/later', 'api/v1/journal/Later#create');
        $router->addRoute('DELETE', '/api/v1/journal/links', 'api/v1/journal/Links#deleteAll');
        $router->addRoute('DELETE', '/api/v1/journal/links/:id', 'api/v1/journal/Links#delete');
        $router->addRoute('GET', '/api/v1/links', 'api/v1/Links#index');
        $router->addRoute('GET', '/api/v1/links/:id', 'api/v1/Links#show');
        $router->addRoute('PATCH', '/api/v1/links/:id', 'api/v1/Links#update');
        $router->addRoute('DELETE', '/api/v1/links/:id', 'api/v1/Links#delete');
        $router->addRoute('POST', '/api/v1/links/:id/read', 'api/v1/links/Read#create');
        $router->addRoute('DELETE', '/api/v1/links/:id/read', 'api/v1/links/Read#delete');
        $router->addRoute('POST', '/api/v1/links/:id/later', 'api/v1/links/Later#create');
        $router->addRoute(
            'PUT',
            '/api/v1/links/:link_id/collections/:collection_id',
            'api/v1/links/Collections#create'
        );
        $router->addRoute(
            'DELETE',
            '/api/v1/links/:link_id/collections/:collection_id',
            'api/v1/links/Collections#delete'
        );
        $router->addRoute('GET', '/api/v1/links/:link_id/notes', 'api/v1/links/Notes#index');
        $router->addRoute('POST', '/api/v1/links/:link_id/notes', 'api/v1/links/Notes#create');
        $router->addRoute('PATCH', '/api/v1/notes/:id', 'api/v1/Notes#update');
        $router->addRoute('DELETE', '/api/v1/notes/:id', 'api/v1/Notes#delete');
        $router->addRoute('OPTIONS', '/api/*', 'api/v1/BaseController#options');

        return $router;
    }

    /**
     * Return the CLI router (containing app routes)
     */
    public static function loadCli(): \Minz\Router
    {
        $router = self::load();

        $router->addRoute('CLI', '/', 'Help#show');
        $router->addRoute('CLI', '/help', 'Help#show');

        $router->addRoute('CLI', '/system', 'System#show');
        $router->addRoute('CLI', '/system/stats', 'System#stats');
        $router->addRoute('CLI', '/system/secret', 'System#secret');
        $router->addRoute('CLI', '/database/status', 'Database#status');

        $router->addRoute('CLI', '/migrations', 'Migrations#index');
        $router->addRoute('CLI', '/migrations/setup', 'Migrations#setup');
        $router->addRoute('CLI', '/migrations/rollback', 'Migrations#rollback');
        $router->addRoute('CLI', '/migrations/create', 'Migrations#create');
        $router->addRoute('CLI', '/migrations/reset', 'Migrations#reset');

        $router->addRoute('CLI', '/media/clean', 'Media#clean');

        $router->addRoute('CLI', '/urls/show', 'Urls#show');
        $router->addRoute('CLI', '/urls/uncache', 'Urls#uncache');

        $router->addRoute('CLI', '/users', 'Users#index');
        $router->addRoute('CLI', '/users/create', 'Users#create');
        $router->addRoute('CLI', '/users/export', 'Users#export');
        $router->addRoute('CLI', '/users/validate', 'Users#validate');

        $router->addRoute('CLI', '/features', 'FeatureFlags#index');
        $router->addRoute('CLI', '/features/flags', 'FeatureFlags#flags');
        $router->addRoute('CLI', '/features/enable', 'FeatureFlags#enable');
        $router->addRoute('CLI', '/features/disable', 'FeatureFlags#disable');

        $router->addRoute('CLI', '/feeds', 'Feeds#index');
        $router->addRoute('CLI', '/feeds/add', 'Feeds#add');
        $router->addRoute('CLI', '/feeds/sync', 'Feeds#sync');
        $router->addRoute('CLI', '/feeds/reset-hashes', 'Feeds#resetHashes');

        $router->addRoute('CLI', '/topics', 'Topics#index');
        $router->addRoute('CLI', '/topics/create', 'Topics#create');
        $router->addRoute('CLI', '/topics/update', 'Topics#update');
        $router->addRoute('CLI', '/topics/delete', 'Topics#delete');

        $router->addRoute('CLI', '/jobs', 'Jobs#index');
        $router->addRoute('CLI', '/jobs/install', 'Jobs#install');
        $router->addRoute('CLI', '/jobs/watch', 'Jobs#watch');
        $router->addRoute('CLI', '/jobs/run', 'Jobs#run');
        $router->addRoute('CLI', '/jobs/show', 'Jobs#show');
        $router->addRoute('CLI', '/jobs/unfail', 'Jobs#unfail');
        $router->addRoute('CLI', '/jobs/unlock', 'Jobs#unlock');

        $router->addRoute('CLI', '/pocket/import', 'Pocket#import');
        $router->addRoute('CLI', '/wallabag/import', 'Wallabag#import');

        return $router;
    }
}