Commit c63a0776 authored by Yassine Doghri's avatar Yassine Doghri
Browse files

feat(users): add myth-auth to handle users crud + add admin gateway only accessible by login 

- overwrite myth/auth config with castopod app needs
- create custom views for users authentication
- add admin area bootstrapped by admin controller
- shift podcast and episodes crud to admin area
- reorganize view layouts
- update docs for database migration
- add myth-auth to DEPENDENCIES.md

closes #11
parent da0f0472

DEPENDENCIES.md

+1 −0
Original line number Diff line number Diff line
@@ -13,3 +13,4 @@ Castopod uses the following components: 
- [GeoIP2 PHP API](https://github.com/maxmind/GeoIP2-php) ([Apache License 2.0](https://github.com/maxmind/GeoIP2-php/blob/master/LICENSE))

- [Quill Rich Text Editor](https://github.com/quilljs/quill) ([BSD 3-Clause "New" or "Revised" License](https://github.com/quilljs/quill/blob/develop/LICENSE))

- [getID3](https://github.com/JamesHeinrich/getID3) ([GNU General Public License v3](https://github.com/JamesHeinrich/getID3/blob/2.0/licenses/license.gpl-30.txt))

- [myth-auth](https://github.com/lonnieezell/myth-auth) ([MIT license](https://github.com/lonnieezell/myth-auth/blob/develop/LICENSE.md))

app/Config/App.php

+16 −0
Original line number Diff line number Diff line
@@ -274,4 +274,20 @@ class App extends BaseConfig 
	| Defines the root folder for media files storage

	*/

    public $mediaRoot = 'media';



    /*

	|--------------------------------------------------------------------------

	| Admin gateway

	|--------------------------------------------------------------------------

	| Defines a base route for all admin pages

	*/

    public $adminGateway = 'admin';



    /*

	|--------------------------------------------------------------------------

	| Auth gateway

	|--------------------------------------------------------------------------

	| Defines a base route for all authentication related pages

	*/

    public $authGateway = 'auth';

}

app/Config/Auth.php

0 → 100644
+42 −0
Original line number Diff line number Diff line 
<?php



namespace Config;



class Auth extends \Myth\Auth\Config\Auth

{

    //--------------------------------------------------------------------

    // Views used by Auth Controllers

    //--------------------------------------------------------------------



    public $views = [

        'login' => 'auth/login',

        'register' => 'auth/register',

        'forgot' => 'auth/forgot',

        'reset' => 'auth/reset',

        'emailForgot' => 'auth/emails/forgot',

        'emailActivation' => 'auth/emails/activation',

    ];



    //--------------------------------------------------------------------

    // Layout for the views to extend

    //--------------------------------------------------------------------



    public $viewLayout = 'auth/_layout';



    //--------------------------------------------------------------------

    // Allow User Registration

    //--------------------------------------------------------------------

    // When enabled (default) any unregistered user may apply for a new

    // account. If you disable registration you may need to ensure your

    // controllers and views know not to offer registration.

    //

    public $allowRegistration = false;



    //--------------------------------------------------------------------

    // Require confirmation registration via email

    //--------------------------------------------------------------------

    // When enabled, every registered user will receive an email message

    // with a special link he have to confirm to activate his account.

    //

    public $requireActivation = false;

}

app/Config/Filters.php

+12 −0
Original line number Diff line number Diff line
@@ -10,6 +10,9 @@ class Filters extends BaseConfig 
        'csrf' => \CodeIgniter\Filters\CSRF::class,

        'toolbar' => \CodeIgniter\Filters\DebugToolbar::class,

        'honeypot' => \CodeIgniter\Filters\Honeypot::class,

        'login' => \Myth\Auth\Filters\LoginFilter::class,

        'role' => \Myth\Auth\Filters\RoleFilter::class,

        'permission' => \Myth\Auth\Filters\PermissionFilter::class,

    ];



    // Always applied before every request
@@ -33,4 +36,13 @@ class Filters extends BaseConfig 
    // that they should run on, like:

    //    'isLoggedIn' => ['before' => ['account/*', 'profiles/*']],

    public $filters = [];



    public function __construct()

    {

        parent::__construct();



        $this->filters = [

            'login' => ['before' => [config('App')->adminGateway . '*']],

        ];

    }

}

app/Config/Routes.php

+131 −19
Original line number Diff line number Diff line
@@ -24,6 +24,7 @@ $routes->set404Override(); 
$routes->setAutoRoute(false);

$routes->addPlaceholder('podcastName', '[a-zA-Z0-9\_]{1,191}');

$routes->addPlaceholder('episodeSlug', '[a-zA-Z0-9\-]{1,191}');

$routes->addPlaceholder('username', '[a-zA-Z0-9 ]{3,}');



/**

 * --------------------------------------------------------------------
@@ -34,39 +35,150 @@ $routes->addPlaceholder('episodeSlug', '[a-zA-Z0-9\-]{1,191}'); 
// We get a performance increase by specifying the default

// route since we don't have to scan directories.

$routes->get('/', 'Home::index', ['as' => 'home']);

$routes->add('new-podcast', 'Podcast::create', ['as' => 'podcast_create']);



$routes->group('@(:podcastName)', function ($routes) {

    $routes->add('/', 'Podcast::view/$1', ['as' => 'podcast_view']);

    $routes->add('/', 'Podcast/$1', ['as' => 'podcast']);



    $routes->add('feed.xml', 'Feed/$1', ['as' => 'podcast_feed']);

    $routes->add('episodes/(:episodeSlug)', 'Episode/$1/$2', [

        'as' => 'episode',

    ]);

});



// Route for podcast audio file analytics (/stats/podcast_id/episode_id/podcast_folder/filename.mp3)

$routes->add('stats/(:num)/(:num)/(:any)', 'Analytics::hit/$1/$2/$3', [

    'as' => 'analytics_hit',

]);



// Show the Unknown UserAgents

$routes->add('.well-known/unknown-useragents', 'UnknownUserAgents');

$routes->add('.well-known/unknown-useragents/(:num)', 'UnknownUserAgents/$1');



// Admin area

$routes->group(

    config('App')->adminGateway,

    ['namespace' => 'App\Controllers\Admin'],

    function ($routes) {

        $routes->add('/', 'Home', [

            'as' => 'admin',

        ]);



        $routes->add('new-podcast', 'Podcast::create', [

            'as' => 'podcast_create',

        ]);

        $routes->add('podcasts', 'Podcast::list', ['as' => 'podcast_list']);



        $routes->group('podcasts/@(:podcastName)', function ($routes) {

            $routes->add('edit', 'Podcast::edit/$1', [

                'as' => 'podcast_edit',

            ]);

            $routes->add('delete', 'Podcast::delete/$1', [

                'as' => 'podcast_delete',

            ]);

    $routes->add('feed.xml', 'Feed/$1', ['as' => 'podcast_feed']);



            $routes->add('new-episode', 'Episode::create/$1', [

                'as' => 'episode_create',

            ]);

    $routes->add('episodes/(:episodeSlug)', 'Episode::view/$1/$2', [

        'as' => 'episode_view',

            $routes->add('episodes', 'Episode::list/$1', [

                'as' => 'episode_list',

            ]);

    $routes->add('episodes/(:episodeSlug)/edit', 'Episode::edit/$1/$2', [



            $routes->add(

                'episodes/(:episodeSlug)/edit',

                'Episode::edit/$1/$2',

                [

                    'as' => 'episode_edit',

    ]);

    $routes->add('episodes/(:episodeSlug)/delete', 'Episode::delete/$1/$2', [

                ]

            );

            $routes->add(

                'episodes/(:episodeSlug)/delete',

                'Episode::delete/$1/$2',

                [

                    'as' => 'episode_delete',

    ]);

                ]

            );

        });



// Route for podcast audio file analytics (/stats/podcast_id/episode_id/podcast_folder/filename.mp3)

$routes->add('stats/(:num)/(:num)/(:any)', 'Analytics::hit/$1/$2/$3', [

    'as' => 'analytics_hit',

        // Users

        $routes->add('users', 'User::list', ['as' => 'user_list']);

        $routes->add('new-user', 'User::create', ['as' => 'user_create']);



        $routes->add('users/@(:any)/ban', 'User::ban/$1', [

            'as' => 'user_ban',

        ]);

        $routes->add('users/@(:any)/unban', 'User::unBan/$1', [

            'as' => 'user_unban',

        ]);

        $routes->add(

            'users/@(:any)/force-pass-reset',

            'User::forcePassReset/$1',

            [

                'as' => 'user_force_pass_reset',

            ]

        );



// Show the Unknown UserAgents

$routes->add('.well-known/unknown-useragents', 'UnknownUserAgents');

$routes->add('.well-known/unknown-useragents/(:num)', 'UnknownUserAgents/$1');

        $routes->add('users/@(:any)/delete', 'User::delete/$1', [

            'as' => 'user_delete',

        ]);



        // My account

        $routes->get('my-account', 'Myaccount', [

            'as' => 'myAccount',

        ]);

        $routes->get(

            'my-account/change-password',

            'Myaccount::changePassword/$1',

            [

                'as' => 'myAccount_change-password',

            ]

        );

        $routes->post(

            'my-account/change-password',

            'Myaccount::attemptChange/$1',

            [

                'as' => 'myAccount_change-password',

            ]

        );

    }

);



/**

 * Overwriting Myth:auth routes file

 */

$routes->group(config('App')->authGateway, function ($routes) {

    // Login/out

    $routes->get('login', 'Auth::login', ['as' => 'login']);

    $routes->post('login', 'Auth::attemptLogin');

    $routes->get('logout', 'Auth::logout', ['as' => 'logout']);



    // Registration

    $routes->get('register', 'Auth::register', [

        'as' => 'register',

    ]);

    $routes->post('register', 'Auth::attemptRegister');



    // Activation

    $routes->get('activate-account', 'Auth::activateAccount', [

        'as' => 'activate-account',

    ]);

    $routes->get('resend-activate-account', 'Auth::resendActivateAccount', [

        'as' => 'resend-activate-account',

    ]);



    // Forgot/Resets

    $routes->get('forgot', 'Auth::forgotPassword', [

        'as' => 'forgot',

    ]);

    $routes->post('forgot', 'Auth::attemptForgot');

    $routes->get('reset-password', 'Auth::resetPassword', [

        'as' => 'reset-password',

    ]);

    $routes->post('reset-password', 'Auth::attemptReset');

    $routes->get('change-password', 'Auth::changePassword', [

        'as' => 'change_pass',

    ]);

    $routes->post('change-password', 'Auth::attemptChange');

});



/**

 * --------------------------------------------------------------------