Programming – Antinormal

I set up a forum using phpBB 3.2 this week and I wanted the URLs to be user readable and SEO-friendly (although this doesn’t really matter to search engines anymore, still figured it’d be a nice-to-have feature). I decided to make some changes to the phpBB core files. Now, my approach isn’t exactly ideal, because there will definitely be problems that arise from merging if any of the files modified for this are updated in newer versions of phpBB, but it gets the job done. If you would like to achieve this, you can proceed with the steps below after the friendly warning.

Disclaimer: Proceed with these steps at your own risk. I am not liable for any damage or harm that may occur to your forum, database, server, computer, or even pets from making use of the modified files in order to achieve the desired functionality. Always remember to make multiple backups of your files before making any changes.

First things first. Here are the fancy URL formats that we want to achieve.

/memberlist.php becomes /members
/memberlist.php?mode=viewprofile&u=2 becomes /members/u2-admin
/viewforum.php?f=1 becomes /f1-awesome-forum-url
/viewtopic.php?t=1&f=2 becomes /f2-another-awesome-forum/t1-just-do-it

This can be achieved by adding the following Apache rewrite rules to your .htaccess file (or your httpd configuration). Please note that mod_rewrite needs to be enabled for this to work.

RewriteRule ^members(|/)$ /memberlist.php [QSA,L]
RewriteRule ^members/u(\d+)([a-zA-Z0-9\-_]+)$ /memberlist.php?mode=viewprofile&u=$1 [QSA,L]
RewriteRule ^f(\d+)([a-zA-Z0-9\-]+)/t(\d+)([a-zA-Z0-9\-]+)(.*)$ /viewtopic.php?f=$1&t=$3 [QSA,L]
RewriteRule ^f(\d+)([a-zA-Z0-9\-]+)(.*)$ /viewforum.php?f=$1 [QSA,L]

RewriteRule ^members(|/)$ /memberlist.php [QSA,L]

RewriteRule ^members/u(\d+)([a-zA-Z0-9\-_]+)$ /memberlist.php?mode=viewprofile&u=$1 [QSA,L]

RewriteRule ^f(\d+)([a-zA-Z0-9\-]+)/t(\d+)([a-zA-Z0-9\-]+)(.*)$ /viewtopic.php?f=$1&t=$3 [QSA,L]

RewriteRule ^f(\d+)([a-zA-Z0-9\-]+)(.*)$ /viewforum.php?f=$1 [QSA,L]

If you’re running on nginx, you can add the following lines to your configuration.

location /members {
    rewrite ^/members(|/)$ /memberlist.php last;
    rewrite ^/members/u(\d+)([a-zA-Z0-9\-_]+)$ /memberlist.php?mode=viewprofile&u=$1$is_args$args last;
}
location /f {
    rewrite ^/f(\d+)([a-zA-Z0-9\-]+)/t(\d+)([a-zA-Z0-9\-]+)(.*)$ /viewtopic.php?f=$1&t=$3$is_args$args last;
    rewrite ^/f(\d+)([a-zA-Z0-9\-]+)(.*)$ /viewforum.php?f=$1$is_args$args last;
}

location /members {

rewrite ^/members(|/)$ /memberlist.php last;

rewrite ^/members/u(\d+)([a-zA-Z0-9\-_]+)$ /memberlist.php?mode=viewprofile&u=$1$is_args$args last;

}

location /f {

rewrite ^/f(\d+)([a-zA-Z0-9\-]+)/t(\d+)([a-zA-Z0-9\-]+)(.*)$ /viewtopic.php?f=$1&t=$3$is_args$args last;

rewrite ^/f(\d+)([a-zA-Z0-9\-]+)(.*)$ /viewforum.php?f=$1$is_args$args last;

}

Once you’ve updated your configuration files, unpack the ZIP archive into the top-level folder of your phpBB installation. Remember to make a backup of all your files before doing this. For reference, here are the files that will be overwritten after extracting the files in the archive.

.htaccess
index.php
memberlist.php
posting.php
search.php
viewforum.php
viewonline.php
viewtopic.php
includes/functions.php
includes/functions_content.php
includes/functions_display.php
includes/functions_posting.php
phpbb/feed/helper.php

You can view the modifications in action at https://www.eresidency.co. To reiterate, this is not an ideal solution, and you have to watch out for conflicts if you’re trying to upgrade to newer versions of phpBB, but it gets the basic job done. If there are any improvements you’d like to see, post a comment below.

The archive can be downloaded from https://drive.google.com/open?id=0B27L6m8VLspCSjExREJweHBUS1U.

I worked on a project recently where I had to allow XMLHttpRequests from a different domain. I initially thought about adding the necessary Access-Control headers at the controller level, but after doing some reading, it turned out it was a better idea to make use of a dispatcher filter. However, dispatcher filters would only apply prior to CakePHP 3.3 since they are now deprecated.

Enter middleware, which I found to be quite familiar since I have made use of a similar concept in Express during my Node.js development. Think of middleware as reusable components which you can use to handle your web requests and modify responses.

The CakePHP middleware classes should be placed in the src/Middleware folder. You can create the folder if it doesn’t already exist in your project.

We’ll create a class in the Middleware folder called CorsMiddleware.php.

<?php

namespace App\Middleware;

class CorsMiddleware {
    public function __invoke($request, $response, $next) {
        $response = $next($request, $response);
        
        $response = $response->withHeader('Access-Control-Allow-Origin', '*')->
            withHeader('Access-Control-Allow-Methods', 'DELETE, GET, OPTIONS, PATCH, POST, PUT')->
            withHeader('Access-Control-Allow-Headers',
                       'Accept, Authorization, Cache-Control, Content-Type, X-Requested-With, x-csrf-token')->
            withHeader('Access-Control-Allow-Credentials', 'true')->
            withHeader('Access-Control-Max-Age', '3600');
        
        return $response;
    }
}

?>

<?php

namespace App\Middleware;

class CorsMiddleware {

public function __invoke($request, $response, $next) {

$response = $next($request, $response);

$response = $response->withHeader('Access-Control-Allow-Origin', '*')->

withHeader('Access-Control-Allow-Methods', 'DELETE, GET, OPTIONS, PATCH, POST, PUT')->

withHeader('Access-Control-Allow-Headers',

'Accept, Authorization, Cache-Control, Content-Type, X-Requested-With, x-csrf-token')->

withHeader('Access-Control-Allow-Credentials', 'true')->

withHeader('Access-Control-Max-Age', '3600');

return $response;

}

The code listing is pretty straightforward. The response is modified with the necessary headers to enable the cross origin requests to be successfully handled by the browser.

You can modify the header values as you see fit, like limiting the Access-Control-Allow-Origin header to specific domains – the wildcard (*) allows requests to be accepted from all domains – or the the request methods to just GET and POST, or the allowed request headers.

To make use of the cors middleware, modify src\Application.php and add the middleware using:
$middleware->add(new CorsMiddleware())

And that’s all there is to it. There are more details about what you can do with middleware in the CakePHP documentation, so be sure to check it out.

Category: Programming

SEO-friendly, user-readable URLs with phpBB 3.2

Implementing cross-origin resource sharing (CORS) using middleware in CakePHP 3.3