Fix for #140, changing the logic to remove or add roles only if neede…

[sadashivdalvi]

…d and always use google api instead of delete

[civicrm-builder]

Can one of the admins verify this patch?

[civibot]

(Standard links)

• If this is your first pull-request for CiviCRM, please browse CONTRIBUTING.md for information about the development and testing processes.
• If you are reviewing this pull-request, you may wish to consult the test sites and the Review Standards (long template, short template).

[petednz]

@jitendrapurohit can you look over this?

[aydun]

@sadashivdalvi What is the problem you are addressing? You mention '#140' but in which system? The PR that is automatically linked does not look relevant. I don't understand the comment 'always use google api instead of delete' ... the code makes no use of google api's.

[sadashivdalvi]

I have a system which performs certain operation whenever a role is added or removed, this operation is to sync some external system.

What currently happens is, system removes all roles (using db delete which doesn't invoke any hooks, etc) and then adds roles which actually invokes the external system unnecessarily, Instead of that civicrm code should identify whether we need a change in role and use api to save roles.

I am using this patch on production since I submitted the PR and it's working fine.

"google" was a typing mistake, I meant use api to save role changes.

Thanks,
Sadashiv

[aydun]

Ok, that makes sense. The changes are smaller than the diff suggests at first sight. I have not tested it, but the code changes look good to me.
Let's see what Jitendra says.

[jitendrapurohit]

is this no longer happening now? I just replicated the following problem which wasn't happening with the previous code.

• Create 2 member sync rule. Eg role1 => memtype1 & role2 => memtype2.
• Create a contact (with drupal user) and add a membership of type = memtype1.
• Sync the rule. role1 is added to the user (Correct).
• Delete the membership memtype1 from the contact and add the membership of type = memtype2.
• Sync the rule again. role2 is added (Correct). But role1 is not removed from the contact (Incorrect).

As memtype1 is not associated with the civi contact, role1 should have been removed after the sync. It was working as per the above condition.

@sadashivdalvi

[sadashivdalvi]

@jitendrapurohit can you please recheck, I missed that case, which I fixed by adding additional check now.

foreach ($memberroles as $membership_type_id => $rolerule) {
  if (user_has_role($rolerule['rid'], $account) && !in_array($rolerule['rid'], $addRoles)) {
    // This will only happen if the membership is deleted.
    $expRoles[] = $rolerule['rid'];
  }
}

Simple check that if the user has a role in the rule and doesn't have it addRoles then remove that role.

Have also improved the saving logic by moving the save out of loops, something I missed last time.

Thanks,
Sadashiv

[sadashivdalvi]

I did find on my site that we do need a fix from https://issues.civicrm.org/jira/browse/CRM-16000 i.e. #316 Should I include that patch here so that the code becomes complete and functional.

I have this deployed on my production site.

Thanks,
Sadashiv

[sadashivdalvi]

@jitendrapurohit can you please recheck, I missed that case, which I fixed by adding additional check now.

foreach ($memberroles as $membership_type_id => $rolerule) {
  if (user_has_role($rolerule['rid'], $account) && !in_array($rolerule['rid'], $addRoles)) {
    // This will only happen if the membership is deleted.
    $expRoles[] = $rolerule['rid'];
  }
}

Simple check that if the user has a role in the rule and doesn't have it addRoles then remove that role.

Have also improved the saving logic by moving the save out of loops, something I missed last time.

Thanks,
Sadashiv