danielebarchiesi@0: <?php
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * @file
danielebarchiesi@0:  * Plugin to provide access control/visibility based on specified context string matching user-specified string
danielebarchiesi@0:  */
danielebarchiesi@0: 
danielebarchiesi@0: $plugin = array(
danielebarchiesi@0:   'title' => t("String: comparison"),
danielebarchiesi@0:   'description' => t('Control access by string match.'),
danielebarchiesi@0:   'callback' => 'ctools_string_equal_ctools_access_check',
danielebarchiesi@0:   'settings form' => 'ctools_string_equal_ctools_access_settings',
danielebarchiesi@0:   'summary' => 'ctools_string_equal_ctools_access_summary',
danielebarchiesi@0:   'required context' => new ctools_context_required(t('String'), 'string'),
danielebarchiesi@0:   'defaults' => array('operator' => '=', 'value' => '', 'case' => FALSE),
danielebarchiesi@0: );
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Settings form
danielebarchiesi@0:  */
danielebarchiesi@0: function ctools_string_equal_ctools_access_settings($form, &$form_state, $conf) {
danielebarchiesi@0:   $form['settings']['operator'] = array(
danielebarchiesi@0:     '#type' => 'radios',
danielebarchiesi@0:     '#title' => t('Operator'),
danielebarchiesi@0:     '#options' => array(
danielebarchiesi@0:       '=' => t('Equal'),
danielebarchiesi@0:       '!=' => t('Not equal'),
danielebarchiesi@0:       'regex' => t('Regular expression'),
danielebarchiesi@0:       '!regex' => t('Not equal to regular expression'),
danielebarchiesi@0:     ),
danielebarchiesi@0:     '#default_value' => $conf['operator'],
danielebarchiesi@0:     '#description' => t('If using a regular expression, you should enclose the pattern in slashes like so: <em>/foo/</em>. If you need to compare against slashes you can use another character to enclose the pattern, such as @. See <a href="http://www.php.net/manual/en/reference.pcre.pattern.syntax.php">PHP regex documentation</a> for more.'),
danielebarchiesi@0:   );
danielebarchiesi@0: 
danielebarchiesi@0:   $form['settings']['value'] = array(
danielebarchiesi@0:     '#type' => 'textfield',
danielebarchiesi@0:     '#title' => t('String'),
danielebarchiesi@0:     '#default_value' => $conf['value'],
danielebarchiesi@0:   );
danielebarchiesi@0: 
danielebarchiesi@0:   $form['settings']['case'] = array(
danielebarchiesi@0:     '#type' => 'checkbox',
danielebarchiesi@0:     '#title' => t('Case sensitive'),
danielebarchiesi@0:     '#default_value' => $conf['case'],
danielebarchiesi@0:   );
danielebarchiesi@0:   return $form;
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Check for access
danielebarchiesi@0:  */
danielebarchiesi@0: function ctools_string_equal_ctools_access_check($conf, $context) {
danielebarchiesi@0:   if (empty($context) || empty($context->data)) {
danielebarchiesi@0:     $string = '';
danielebarchiesi@0:   }
danielebarchiesi@0:   else {
danielebarchiesi@0:     $string = $context->data;
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   $value = $conf['value'];
danielebarchiesi@0:   if (empty($conf['case'])) {
danielebarchiesi@0:     $string = drupal_strtolower($string);
danielebarchiesi@0:     $value = drupal_strtolower($value);
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   switch ($conf['operator']) {
danielebarchiesi@0:     case '=':
danielebarchiesi@0:       return $string === $value;
danielebarchiesi@0:     case '!=':
danielebarchiesi@0:       return $string !== $value;
danielebarchiesi@0:     case 'regex':
danielebarchiesi@0:       return preg_match($value, $string);
danielebarchiesi@0:     case '!regex':
danielebarchiesi@0:       return !preg_match($value, $string);
danielebarchiesi@0:   }
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Provide a summary description based upon the specified context
danielebarchiesi@0:  */
danielebarchiesi@0: function ctools_string_equal_ctools_access_summary($conf, $context) {
danielebarchiesi@0:   $values = array('@identifier' => $context->identifier, '@value' => $conf['value']);
danielebarchiesi@0:   switch ($conf['operator']) {
danielebarchiesi@0:     case '=':
danielebarchiesi@0:       return t('@identifier is "@value"', $values);
danielebarchiesi@0:     case '!=':
danielebarchiesi@0:       return t('@identifier is not "@value"', $values);
danielebarchiesi@0:     case 'regex':
danielebarchiesi@0:       return t('@identifier matches "@value"', $values);
danielebarchiesi@0:     case '!regex':
danielebarchiesi@0:       return t('@identifier does not match "@value"', $values);
danielebarchiesi@0:   }
danielebarchiesi@0: }
danielebarchiesi@0: