danielebarchiesi@0: <?php
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * @file
danielebarchiesi@0:  * Ctools access plugin to provide access/visiblity if two user contexts are equal.
danielebarchiesi@0:  */
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Plugins are described by creating a $plugin array which will be used
danielebarchiesi@0:  * by the system that includes this file.
danielebarchiesi@0:  */
danielebarchiesi@0: $plugin = array(
danielebarchiesi@0:   'title' => t("User: compare"),
danielebarchiesi@0:   'description' => t('Compare two users (logged-in user and user being viewed, for example)'),
danielebarchiesi@0:   'callback' => 'ctools_compare_users_access_check',
danielebarchiesi@0:   'default' => array(
danielebarchiesi@0:     'equality' => 1,
danielebarchiesi@0:   ),
danielebarchiesi@0:   'settings form' => 'ctools_compare_users_settings',
danielebarchiesi@0:   'summary' => 'ctools_compare_users_ctools_access_summary',
danielebarchiesi@0:   'required context' => array(
danielebarchiesi@0:     new ctools_context_required(t('First User'), 'user'),
danielebarchiesi@0:     new ctools_context_required(t("Second User"), 'user')
danielebarchiesi@0:   ),
danielebarchiesi@0: );
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Settings form for the 'by perm' access plugin
danielebarchiesi@0:  */
danielebarchiesi@0: function ctools_compare_users_settings($form, &$form_state, $conf) {
danielebarchiesi@0: 
danielebarchiesi@0:   $form['settings']['helptext'] = array(
danielebarchiesi@0:     '#type' => 'markup',
danielebarchiesi@0:     '#value' => '<div>' . t('Grant access based on comparison of the two user contexts. For example, to grant access to a user to view their own profile, choose "logged in user" and "user being viewed" and say "grant access if equal". When they\'re the same, access will be granted.') . '</div>',
danielebarchiesi@0:   );
danielebarchiesi@0: 
danielebarchiesi@0:   $form['settings']['equality'] = array(
danielebarchiesi@0:     '#type' => 'radios',
danielebarchiesi@0:     '#title' => t('Grant access if user contexts are'),
danielebarchiesi@0:     '#options' => array(1 => t('Equal'), 0 => t('Not equal')),
danielebarchiesi@0:     '#default_value' => $conf['equality'],
danielebarchiesi@0:   );
danielebarchiesi@0:   return $form;
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Check for access.
danielebarchiesi@0:  */
danielebarchiesi@0: function ctools_compare_users_access_check($conf, $context) {
danielebarchiesi@0: 
danielebarchiesi@0:   if (empty($context) || count($context) != 2 || empty($context[0]->data) || empty($context[1]->data)) {
danielebarchiesi@0:     return FALSE;
danielebarchiesi@0:   }
danielebarchiesi@0:   $account1 = $context[0]->data;
danielebarchiesi@0:   $account2 = $context[1]->data;
danielebarchiesi@0: 
danielebarchiesi@0:   // xor returns false if the two bools are the same, and true if they are not.
danielebarchiesi@0:   // i.e, if we asked for equality and they are equal, return true.
danielebarchiesi@0:   // If we asked for inequality and they are equal, return false.
danielebarchiesi@0:   return ($account1->uid == $account2->uid) xor empty($conf['equality']);
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Describe an instance of this plugin.
danielebarchiesi@0:  */
danielebarchiesi@0: function ctools_compare_users_ctools_access_summary($conf, $context) {
danielebarchiesi@0:   $comparison = !empty($conf['equality']) ? "is" : 'is not';
danielebarchiesi@0: 
danielebarchiesi@0:   return t('@id1 @comp @id2', array('@comp' => $comparison, '@id1' => $context[0]->identifier, '@id2' => $context[1]->identifier));
danielebarchiesi@0: }