Discourse と MemberMouse の統合

Discourse と MemberMouse を 2 つのサイトで運用しています。このガイドが皆様のお役に立てれば幸いです。あなたの具体的な要件は、私の目的とは異なる場合があります。このガイドでは、MemberMouse の フックフィルター、および MemberMouse の PHP インターフェース に精通していることを前提としています。また、functions.php または独自のカスタムプラグインを通じて WordPress にカスタムコードを追加できることも前提としています。

以下のガイドは、以下の目的のために追加したものです:

  • MemberMouse の会員ステータスに応じて、Discourse でのユーザーのアクティブ化/非アクティブ化
  • MemberMouse の会員レベルを表す Discourse グループの設定
  • ユーザー名とメールアドレスの変更を瞬時に同期
  • その他、便利な小規模な調整

ステップ 1: Discourse、WordPress、および wp-discourse WordPress プラグインのインストール

WordPress と Discourse、そして wp-discourse WordPress プラグインをセットアップし、WordPress を SSO プロバイダーとして正しく設定してください。これについては、多くのスレッドがここにあります。

ステップ 2: wp-discourse プラグインが WordPress でユーザーが作成された際に Discourse で新しいユーザーを作成できるようにチェックボックスをオンにする

WordPress でユーザーが作成された際に wp-discourse が実際に Discourse でユーザーを作成するためには、プラグイン内でコードの変更を行う必要があることがわかりました。これは、プラグインが「wp_login」アクションに依存していますが、MemberMouse における動作は通常の WordPress の動作とは異なるためです。そのため、public function __construct( $wordpress_email_verifier ) 内の /lib/discourse-sso.php ファイルに以下の行を追加する必要があります:

add_action( 'my_mm_account_added', array( $this, 'create_discourse_user' ), 10, 2 );

そして、functions.php または独自プラグインに以下を追加します:

function add_user_to_discourse($data) {
    do_action( 'my_mm_account_added', $data["username"], get_user_by('ID',$data["member_id"]) );
}
add_action('mm_member_add', 'add_user_to_discourse');

ステップ 3: (任意)新しいユーザーが Discourse のメールアクティベーションリンクをクリックする必要がないようにする

デフォルトでは、Discourse は新しいユーザーにアクティベーションメールを送信しますが、ユーザーは WordPress で参加するためにすでに十分な手順を踏んでいるため、これをオフにすることを選びました。あなたの WordPress サイトの参加障壁が低い場合は、アクティベーションメールをスキップしたくないかもしれません。私たちの場合、参加するには支払いが必要です。これを functions.php または作成した専用プラグインに追加してください。

add_filter( 'wpdc_auto_create_user_require_activation', 'my_wpdc_auto_create_user_require_activation' );
function my_wpdc_auto_create_user_require_activation( $require_activation ) {
    return false;
}

ステップ 4: MemberMouse ユーザーのアカウント変更が発生するたびに:

  • MemberMouse の会員レベルを Discourse グループにマッピング
  • メールアドレス/ユーザー名の同期
  • 状況に応じて Discourse でのユーザーのアクティブ化/非アクティブ化

これを functions.php または独自プラグインに追加できます。

add_action('mm_member_membership_change', 'run_discourse_sync_based_on_mm_acct_change');
add_action('mm_member_status_change', 'run_discourse_sync_based_on_mm_acct_change');
add_action('mm_member_account_update', 'run_discourse_sync_based_on_mm_acct_change');

run_discourse_sync_based_on_mm_acct_change 関数では、以下を行います:

(1) Discourse API を使用して、このユーザーの Discourse ユーザー名(Discourse 独自のユーザー名規則により WordPress のものとはわずかに異なる場合があります)と Discourse ID 番号を取得します。(ドキュメント

(2) MemberMouse の会員レベル ID を同等の Discourse グループ ID にマッピングし、Discourse でそのグループを設定します。まず、古いグループ ID を削除する必要があります。(ドキュメント)その後、新しいグループを設定できます。(ドキュメント

(3) WordPress で変更された場合、ユーザー名とメールアドレスを同期します。これらは WordPress でのみ変更できるようにしています。この部分については、こちらでサポートを受けました。

(4) MemberMouse でのステータスに応じて、Discourse でのユーザーをアクティブ化/非アクティブ化します。アクティブ化:ドキュメント。非アクティブ化は API ドキュメントから欠落しているようです。$url = $url_base.'admin/users/'.$discourse_userid.'/deactivate.json?'.$api_auth;

ステップ 5: 適切な場合に Discourse へ自動的にリダイレクトする

(この部分は、WordPress と Discourse がどのように連携するかを十分に理解するまで、実行しないことを強くお勧めします。)

ユーザーが Discourse にも WordPress にもログインしていない状態で、Discourse の URL にアクセスし、青い「ログイン」ボタンをクリックすると、WordPress に移動してログインしますが、その後 MemberMouse が設定されたリダイレクト先にユーザーを誘導します。残念ながら、ユーザーは Discourse へ戻りません。これを解決する方法を以下に示します。これを functions.php または独自プラグインに追加できます。(詳細はこちらのスレッド

// ユーザーが Discourse フォーラムから来た場合、ログイン後に正確に元の場所へ誘導する
function my_mm_login_redirect( $infoObj ) {
    if ( @$_COOKIE['detected_forum_referal'] != '' ) { // ユーザーが Discourse を経由して到着した場合、この一時クッキーを設定する必要があります
        $current_user       = $infoObj->user;
        $user_id            = $current_user->ID;
        // ペイロードと署名
        $payload = @$_COOKIE['mm_cookie_sso'];
        $sig     = @$_COOKIE['mm_cookie_sig'];
        // %0B を %0A に戻す
        $payload = rawurldecode( str_replace( '%0B', '%0A', rawurlencode( $payload ) ) );
        // 署名を検証
        $sso_secret = 'YOUR-SSO-SECRET';
        $sso        = new \WPDiscourse\SSO\SSO( $sso_secret );
        if ( ! ( $sso->validate( $payload, $sig ) ) ) {
            return '';
        }
        $nonce  = $sso->get_nonce( $payload );
        $params = array(
            'nonce'               => $nonce,
            'username'            => $current_user->user_login,
            'email'               => $current_user->user_email,
            'external_id'         => $user_id,
        );
        $params = apply_filters( 'wpdc_sso_params', $params, $current_user );
        $q = $sso->build_login_string( $params );
        do_action( 'wpdc_sso_provider_before_sso_redirect', $user_id, $current_user );
        // Discourse へリダイレクト
        return('YOUR-FORUM-BASE-URL' . '/session/sso_login?' . $q);
    }
    return('');
}
add_filter( 'mm_login_redirect', 'my_mm_login_redirect', 10, 1 );
「いいね!」 17

if i May ask do you need to install the Discourse on its own or … you just need the discourse plugin in your wordpress

You need to install Discourse on it’s own. The plugin just helps WordPress and Discourse talk to each other.

「いいね!」 4

thank you m new here and i like this community so im in a process on launching it on my Google cloude…

「いいね!」 1

@lkramer - how does this workflow need to change to use MemberMouse Bundles instead of the MM membership status?

(For us MM memberships are too limited, as a customer can only be in one at a time (free or paid). We have many products, so we use Bundles which allows us infinite flexibility.)

Our use case is as follows:

We sell multiple courses. We control course access using Bundles. “Product 1 Bundle” and “Product 2 Bundle,” etc. Any one customer can have access to one or many (or all) of course courses.

Within Discourse we have a separate course forum (category/group) for each product…

We want customers of “Product 1 Bundle” to only be able to see the Discourse category/group for that course, and so on.

Any idea how your workflow would need to change to allow for our use case?

Thx a ton in advance, Leah!

「いいね!」 3

In order to rely on bundles rather than membership levels – anywhere I mentioned membership status/level, you’d just check the person’s bundle status via a MemberMouse php function. So check whether they have bundle X and whether it’s currently ‘active’ and if so, put them in Discourse group X or else remove them from group X. I believe the MemberMouse php function you want is something like this:

if ( mm_member_decision(array("hasBundle"=>"1")) )

Now, regarding only making certain Discourse categories accessible to certain Discourse groups, I’ve never tried it but according to this thread here you can restrict categories to certain groups:

So as long as you can successfully set/unset a person’s Discourse group based on their bundle (which should be do-able), then you can achieve your goal of only having access to certain categories.

「いいね!」 4

Another tidbit of potentially helpful info – To learn to use the Discourse API, write some small isolated scripts to get small pieces working as a proof of concept and to know exactly what code works. There are often several ways to interact with an API even within one language. So, e.g, write a little script that just tests the concept of setting and unsetting someone’s Discourse group. This is what I did and then I knew it was safe/reliable to add them into the MemberMouse eco-system where approprirate. :slight_smile:

「いいね!」 6

The best way to sync group membership is, of course, the sync_sso and during SSO login (which should go through the same function!! you don’t want to add someone from a group and take them back out when they log in) — because this is way more efficient, only 1 API call to change as many groups as you want.

「いいね!」 5

Thx @lkramer! (and @riking)

Thx @riking. So are you saying you can set/unset multiple groups in sync_sso. That’s good to know.

「いいね!」 1

This wasn’t working for me, and I just upgraded, and now there is no create_discourse_user, it seems.

@simon, have you got a suggestion here?

It seems that having to edit the plugin to make membermouse work is something of a bummer. I think that I can imagine code that would solve that if I first could get WordPress to trigger creating the account.

「いいね!」 1

It’s still there: https://github.com/discourse/wp-discourse/blob/master/lib/utilities.php#L306

You need to call it with the namespace WPDiscourse\Utilities\Utilities::create_discourse_user( $user )

There is also a sync_sso_record function that would be better to use if you are able to. It takes an array of sso parameters as an argument. You can get them from the get_sso_params function.

I’m in the process of cleaning up this file. I won’t remove any functions that I’ve posted about on meta. If I break anything, let me know.

Edit: I read the OP more closely. I hadn’t realized it was editing the plugin’s code. That part will be broken by the most recent update. It would be better to call either the create_discourse_user or the sync_sso_record function from WPDiscourse\Utilities, and add the my_mm_account_added hook to your functions.php file or a separate plugin.

「いいね!」 4

Thanks, @simon!

Here’s what I’m doing now:

function add_user_to_discourse($data) {
	do_action( 'my_mm_account_added', $data["username"], get_user_by('ID',$data["member_id"]) );
    error_log ("Doing add_user");
}

add_action('mm_member_add', 'add_user_to_discourse');

Also, I have a handful of actions like


add_action('mm_member_membership_change', 'run_discourse_sync_based_on_mm_acct_change');
add_action('mm_member_status_change', 'run_discourse_sync_based_on_mm_acct_change');
add_action('mm_member_account_update', 'run_discourse_sync_based_on_mm_acct_change');

Should all of these call sync_sso_record? And what should go in $user when I call WPDiscourse\Utilities\Utilities::create_discourse_user( $user )? (I’m going to RTFC now, but perhaps your 2 minutes can save me an hour. :slight_smile:)

Edit: OK, should something like this work? I see that it’s getting called, but the user’s not getting created.

function add_user_to_discourse($data) {
    $user['name'] = $data['first_name'] . " " . $data['last_name'];
    $user['user_email'] = $data['email'];
    error_log ("Calling create_discourse_user");
    WPDiscourse\Utilities\Utilities::create_discourse_user( $user );
}

Assuming you are also adding the user to a group, I think you could just call WPDiscourse\Utilities\Utilities::add_user_to_discourse_group( $user_id, 'group,names' ). That gets the sso params for then calls sync_sso_record with the params. The remove_user_from_discourse_group function works in a similar way, except it removes users from a group or groups.

If you just want to create or update a user without dealing with groups, you can do something like this:

$user = get_user_by( 'id', 1 ); // Supply user_id here.
$sso_params = WPDiscourse\Utilities\Utilities::get_sso_params( $user );
WPDiscourse\Utilities\Utilities::sync_sso_record( $sso_params );

If SSO is enabled, I don’t think there would be a reason to prefer the create_discourse_user function over the sync_sso_record function. If you do need to use it, it takes a WordPress user object as the argument: $user = get_user_by( 'id', 1 );

「いいね!」 4

Yeah. Sadly, I started with code that was written before add_user_to_discourse_group existed. I was just wondering whether I should change my working API calls to use that instead.

It’s not obvious to me that add_user_to_discourse_group will create the user. Is that happening somewhere that I don’t see?

Yes, it creates a user by sending the SSO parameters to the Discourse /admin/users/sync_sso route. It actually takes a comma separated list of group names as its argument (no spaces between names), so it should be renamed. You can also call it with an empty string as the group_names argument. You have to at least supply an empty string for the group names, or it will throw an error.

「いいね!」 4

So, this is a zillion times easier than it used to be!

add_user_to_discourse_group( $user_id, $group_names ) wants the WP userid? and the Discourse group name (no fussing in the json to figure out the group_id?!?!)?

Now I just need to find the $user_id and I’ll be golden.

Edit: $user = get_user_by('ID',$data["member_id"])

Edit: I’m all set! The version of the MemberMouse bundle-to-group function that I was working on yesterday was over 200 lines. The working version today is about 40.

Thanks again, @simon!

「いいね!」 2

Great! I’ll document the changes to the functions soon. They take the same arguments as before, but behave a little differently. One thing to note is that Discourse will still consider the add_user_to_discourse_group and remove_user_from_discourse_group functions to be API calls - they are just making fewer API calls than the previous version did.

The functions return the status code that is returned from the Discourse request. You want to be getting a 200 response. If you’re adding a lot of users at the same time, you need to look out for 429 status codes and find some way of dealing with them. (When adding one user at a time it shouldn’t be an issue.)

「いいね!」 4

Well, I’m pretty sure that last summer when I did this before there was a lot more that I had to do with my own darn API calls. This is pretty great. Hooray that this is now your day job!

「いいね!」 1

Maybe you can write a new and improved MemberMouse guide, Jay, when this is all said and done. :slight_smile: Come to think of it, just a general, “hook Discourse up to your membership plugin” guide would be great for ANY membership plugin. I’m guessing they all have similar “hooks” as MemberMouse.

「いいね!」 4