API for privatemsg related user level settings

Ok, here is a first patch, i implemented the fancy version...

API functions:

function privatemsg_get_setting($setting, $ids = NULL) {}
function privatemsg_set_setting($type, $id, $setting, $value) {}
function privatemsg_del_setting($type, $id, $setting) {}

$ids = function privatemsg_get_default_setting_ids($account = NULL) {}

The first three should be obvious, the last extracts the default ids off a user object (defaults to the current user and privatemsg_get_setting() does too).

Here is an extract from the tests to see how it can be used.

    // Create some global and role default settings.
    privatemsg_set_setting('global', 0, 'test', 1);
    privatemsg_set_setting('role', array_pop(array_keys($user->roles)), 'test', 2);

    // Add some user specific setting.
    privatemsg_set_setting('user', $admin->uid, 'test', 3);
    privatemsg_set_setting('user', $user->uid, 'test2', 4);
    privatemsg_set_setting('user', $user2->uid, 'test2', -1);

    // Get the ids for each user.
    $admin_ids = privatemsg_get_default_setting_ids($admin);
    $user_ids = privatemsg_get_default_setting_ids($user);
    $user2_ids = privatemsg_get_default_setting_ids($user2);

    $this->assertEqual(privatemsg_get_setting('test', $admin_ids), 3, t('The admin has a user level setting.'));
    $this->assertEqual(privatemsg_get_setting('test', $user_ids), 2, t('The first user has role-level default.'));
    $this->assertEqual(privatemsg_get_setting('test', $user2_ids), 1, t('The second user defaults to the global.'));

What is implemented:
- The API :)
- A rather intelligent (I hope) and well tested (I think) static cache mechanism that works like this: 1. Look in cache for most specific type (first in array), 2. try to load not-yet-loaded settings for all types/ids, 3. go through all types/ids and return the first match. This means that the order of types in the $ids array indicates their weight/importance.
- Schema including update functions
- Disabled is ported to this API (There is still privatemsg_is_disabled() because that one does the user_load() and permission check). Existing disabled settings are not being ported yet.
- There are rather good tests for it.

TODO/Questions:
- Api docs
- Would it be useful to make the implementation configurable? (think cache.inc)
- Currently, only integers are supported, should we switch to serialized string instead? (Might make it possible to port more configurations like the role-based blocking rules to it but would slow it down)
- I forgot all other questions I had, too tired.

Please test and review!

Because this is Drupal 6 :)

You are right, but...

- 7.x-1.x is stable. To add new features to 7.x, I first need to start a 7.x-2.x branch. Therefore, I'm currently using 6.x-2.x as the development branch.

- This feature is a dependency for #967164: E-mails not sent if message was sent to role members, which is currently targeted against 6.x-2.x too

I will start a 7.x-2.x branch sooner or later, not sure about the process yet (not the technical part...)

There is an update function with the number 6205(). It is possible that an update with this name was already run when you tested another issue (most likely the pm_thread one, which adds update functions too).

So to be able to test this patch, you need to directly set back the schema_version information in {system} to 6204 for privatemsg. The following query should work:

UPDATE system SET schema_version = 6204 WHERE name = 'privatemsg'

Ok, can you retry the update with this patch?

Remember that you probably will have to re-run the update query from above.

Forgot the update the schema definition in the update function.

Ok, commited!

I'm not sure if I will do a straight port of this to D7 or instead make this a separate module.

Updated patch for 6.x-2.x.

Contains support for a default argument and variable_get() fallback. Also contains the update function to migrate existing settings, which I forgot above.

Bugfix for the above patch, this should work.

Commited, ack to 7.x-2.x!

Commited to 7.x-2.x.