I just had cause to take an old client site that was built on CakePHP 1.0.x and move it over to a new platform with some upgrades in functionality.  Since we are most likely going to be developing a bunch of new features on the site I felt it was important to go ahead and upgrade the cake core libraries to the recently-released 1.2 — a task I was dreading from the moment I thought it.

But, surprise surprise, the whole ordeal wasn’t an ordeal at all.  In fact was incredibly easy because the Cake devs made it a point to include backwards compatibility. As a result a lot of my legacy code could remain in place to be upgraded gradually.

Take for instance the following gem.  I was a rough and tumble Cake developer back when I first wrote this and this format was actually never really acceptable in the first place, but it worked in 1.0.x:

$this->Order_frame->findAll();
// correct way to access the order_frames table: $this->OrderFrame->findAll();

// in view
echo $orderFrames['Order_frame']['type'];
// correct way to access the data: $orderFrames['OrderFrame']['type'];

Now, having used Cake for a couple of years I know the error of my ways. But, to my surprise, when I ran this legacy code locally on a fresh 1.2 core it worked. Huh? There was no way they would still support this ancient syntax! Heck, I dont think they ever supported it, really.

Anyways, this is a long way of showing my appreciation to the CakePHP devs for building the framework with all the legacy code out there in mind.

1. Integrating bbPress in a sub-folder (not a subdomain) of your cake install (part 1 here)
   
2. Integrating user registration – when a user registers through your cake application they are automatically registered in bbPress.
3. Integrating the login – when a user is logged in via the cake application they are automatically logged in in bbPress.

Part 2 – Integrating User Registration

This part is a little more tricky, but not unmanageable.   The challenge here is that your Cake application probably uses the Auth component, or a custom user setup.  So you probably have a prebuilt users table and chances are it does not conform to what bbPress is looking for in it’s users table.  Also, the encryption scheme between the two is probably different.

With that in mind, I’ve made the following design decisions

1. My Cake users schema will remain intact AND the bbPress users schema will remain intact.
2. Users must register through my Cake application only
3. CakePHP is using the built-in Auth component.
4. When a user registers through my Cake application – I run the necessary logic from the Cake User model to update the bbPress users table.
5. The bbPress tables are in the same database as my CakePHP tables
6. I change the encryption scheme of bbPress to conform to my Cake app.

Step 1: changing the bbPress password encryption.

If you’ve followed Part 1 of this tutorial, you’ve successfully installed and ran bbPress in a subfolder of your cakephp install.  Navigate to that subfolder, then open following file: bb-includes/backpress/code.wp-pass.php

Notice two functions, hash_password(...) and check_password(...).  We will overwrite these two functions to match the hashing that takes place in our CakePHP install.  If, as I denoted above, you are using the built-in CakePHP Auth component, this is very simple – just comment out the existing functions and replace them with the following:

	function hash_password($string) {
		$string = 'YOUR CONFIGURE::SALT VALUE'.$string;
		return sha1($string);
	}

	function check_password($password, $hash, $user_id = '') {
		$string = 'YOUR CONFIGURE::SALT VALUE'.$password;
		if(sha1($string) != $hash) {
			return false;
		} else {
			return true;
		}
	}

Replace the YOUR CONFIGURE::SALT VALUE with the appropriate value from your CakePHP application. This can be found in app/config/core.php.

With these two functions in place, your bbPress user system should be hashing and checking the passwords the same way.

Step 2: Saving a bbPress user from the CakePHP install.

Fortunately, CakePHP provides an easy hook into the ORM saving process with the afterSave() model callback.

To get your User model to save a new bbPress user when a new Cake user is created, add the following functions to your User model script:

	function afterSave($created)
	{
		if($created)
		{
			$sql = "INSERT INTO `bb_users`
			(`user_login`, `user_pass`, `user_nicename`,
			`user_email`, `user_url`, `user_registered`,
			`user_status`, `display_name`)
			VALUES(
			'".$this->data['User']['username']."',
			'".$this->data['User']['password']."',
			'".$this->data['User']['username']."',
			'".$this->data['User']['email']."',
			'',
			NOW(),
			0, '".$user['User']['username']."')";
			$this->query($sql);
		}
	}

Notice that we are just creating an SQL statement with all the necessary fields required to successfully insert the user into the bbPress system, and then executing that SQL. Also, if you are using the default functionality of the Auth component, $this->data['User']['password']; should automatically be hashed with the same scheme as Step 1.

Step 3 – Preventing registration from bbPress

This is the easy part. Simply add the following line to the top of your register.php script in you bbPress install and replace the path with the correct path to your cake registration page.

die(header('Location: /path/to/your/cake/registration/page'));

So, that’s it! Now, when you register a user through your Cake application, they should also appear in the bbPress users table, and you should be able to successfully log into both with the exact same credentials.

But, the plot thickens – we don’t want our users to have to log in to both the cake app and bbpress. We want them to be logged into both automatigically. Stay tuned for part 3 of this tutorial and I’ll attempt to tackle this very conundrum.

This is the first of a 3 part tutorial on how to integrate bbPress with CakePHP 1.2.x.  When complete, these 3 tutorials will accomplish:

1. Integrating bbPress in a sub-folder (not a subdomain) of your cake install
2. Integrating user registration – when a user registers through your cake application they are automatically registered in bbPress. (UPDATE: part 2 here)
3. Integrating the login – when a user is logged in via the cake application they are automatically logged in in bbPress.

Part 1 – Integrating bbPress in a sub-folder (not a subdomain)

It may be personal preference, but I’m not a big fan of subdomaining parts of an application.  There are definitely legitamite technical reasons to do so, but when I can get away with it, I try to use subfolders, i.e. http://statforge.com and http://statforge.com/forum/.

There’s a small hurdle here since CakePHP wants to ReWrite all your paths (if you’ve installed it in your domain root), but it’s easy to overcome.  Find the .htaccess file in the root of your cake install.  It should look like this:

   RewriteEngine on
   RewriteRule    ^$ app/webroot/    [L]
   RewriteRule    (.*) app/webroot/$1 [L]

This is rewriting all of your requests to the webroot folder. Assuming you want to install bbPress into a subfolder called forum (i.e. http://statforge.com/forum/) the change this .htaccess file to the following:

   RewriteEngine on

   RewriteCond %{REQUEST_URI} ^/forum/(.*)$
   RewriteRule ^.*$ - [L]

   RewriteRule    ^$ app/webroot/    [L]
   RewriteRule    (.*) app/webroot/$1 [L]

This simply reads – if the Request starts with /forum/ pass it through normally. If not, let Cake handle it. The only limitation here is that you cannot have a controller named ‘forum’ in your cake application.

That’s it – you should be able to drop a fresh bbPress install into the /forum subfolder and access it normally without Cake interfering.

I’ve already integrated the user registration between my CakePHP install and my bbPress install, but I’ve gotta run for the time being. Hopefully tomorrow I’ll throw up part 2 – it’s a bit more complicated. (UPDATE: part 2 here)

This component allows you to manage content (primarily text blocks) on a site if you’re logged in.  The editor pops up in a thickbox.

Some requirements off the top of my head:

• CakePHP, duh.
• jquery
• thickbox
• Auth Component

Again, sorry for the drive-by but hopefully someone will get use out of this.

controller =& $controller;
			App::import('Model', 'Setting');
			$this->Setting = new Setting();
		}

		function read($field = null) {
			return $this->render($field);
		}

		function render($field = null)
		{
			$content = $this->Setting->findByField($field);

			if(!empty($content)) {
				return $this->output($field, $content['Setting']['value']);
			} else {
				return $this->output($field, '');
			}
		}

		function output($field, $str)
		{
			$output = $str;
			if($this->controller->u['User']['role'] == 'admin') {
				$output .= $this->editButton($field);
			}
			return nl2br($output);
		}

		function editButton($field) {
			return '';
		}
	}
?>

And my Settings Controller looks like:

Setting->findByField($field);

			if(!empty($content)) {
				$this->Setting->id = $content['Setting']['id'];
			}

			if(!empty($this->data))
			{
				$content['Setting'] = array(
					'field' => $field,
					'value' => $this->data['Setting']['value'],
				);

				$this->Setting->save($content);
				die($this->redirect($_REQUEST['r']));
			}

			$this->set(compact('field', 'content'));
		}
	}
?>

No, not Captain Planet… something much more powerful – the ability to use the Google Data API PHP library! This is useful if you want to use Google Calendar or any of the other services supported by the data API.

Loading the Zend Framework isn’t as straightforward as App::Import(…), since Zend’s libraries assume that the Zend Framework folder is in your include path. To get around this simply:

1. Drop the Zend Framework Library folder into your vendors folder
2. Create a script in your Vendors folder called something like zend_include_path.php with the following statement:

   ini_set('include_path', ini_get('include_path').dirname(__FILE__));
   

3. In your action, just do the following, replacing Gdata.php with whatever library you wish to load (i.e. Loader.php):

   function myAction() {
        App::import('Vendor', 'zend_include_path');
        App::import('Vendor', 'Zend_Gdata', true, false, 'Zend/Gdata.php');
   
        ...
   }
   

Voila! You should now be able to instantiate your loaded Zend Library Class and work with it normally.