is_gravityforms_supported()) {
require_once('google-sheet-api.php');
}
}
public function init() {
parent::init();
$this->add_delayed_payment_support(
array(
'option_label' => esc_html__('Add data to Google Sheet only when payment is received.', 'alpha-addons-for-gravity-forms'),
)
);
add_filter("gform_field_map_choices", [$this, 'custom_field_map_choices'], 10, 4);
add_action('wp_ajax_alphagf_gs_revoke_token', [$this, 'revoke_google_sheet_token']);
add_action('wp_ajax_alphagf_gs_insert_header', [$this, 'insert_google_sheet_header']);
add_action('wp_ajax_alphagf_gs_clear_cache', [$this, 'clear_google_sheet_cache']);
}
public function styles() {
$styles = array(
array(
'handle' => 'alphagf_settings_style',
'src' => ALPHAGF_ASSETS . '/css/alphagf_addons_admin.css',
'version' => $this->_version,
'enqueue' => array(
array(
'admin_page' => array('form_settings'),
'tab' => 'alphagf_google_sheet'
)
)
)
);
return array_merge(parent::styles(), $styles);
}
public function scripts() {
$scripts = array(
array(
'handle' => 'alphagf_google_sheet_admin_script',
'src' => trailingslashit($this->get_base_url()) . 'js/alphagf-google-sheet.js',
'version' => $this->_version,
'deps' => array('jquery'),
'in_footer' => true,
'callback' => array($this, 'localize_admin_scripts'),
'enqueue' => array(
array(
'admin_page' => array('plugin_settings', 'form_settings'),
'tab' => 'alphagf_google_sheet'
)
)
),
);
return array_merge(parent::scripts(), $scripts);
}
public function localize_admin_scripts() {
wp_localize_script('alphagf_google_sheet_admin_script', 'alphagf_gs_vars', array(
'ajax_url' => admin_url('admin-ajax.php'),
'nonce' => wp_create_nonce('alphagf_gs_nonce'),
'form_id' => absint(rgget('id')),
'settings_url' => admin_url('admin.php?page=gf_settings&subview=alphagf_google_sheet'),
));
}
public function feed_settings_fields() {
$form = $this->get_current_form();
return array(
array(
'title' => esc_html__('Google Sheet Settings', 'alpha-addons-for-gravity-forms'),
'fields' => array(
array(
'label' => esc_html__('Enable', 'alpha-addons-for-gravity-forms'),
'name' => 'is_enable',
'type' => 'toggle',
'default_value' => false,
'tooltip' => sprintf(
'
%s
%s',
esc_html__('Enable Google Sheet', 'alpha-addons-for-gravity-forms'),
esc_html__('Enable Google Sheet to add form data to Google Sheet.', 'alpha-addons-for-gravity-forms')
)
),
array(
'label' => esc_html__('Feed name', 'alpha-addons-for-gravity-forms'),
'type' => 'text',
'name' => 'feedName',
'class' => 'medium',
'tooltip' => sprintf(
'%s
%s',
esc_html__('Feed Name', 'alpha-addons-for-gravity-forms'),
esc_html__('Select the Spreadsheet to which you would like to add your form data.', 'alpha-addons-for-gravity-forms')
)
),
array(
'name' => 'spreadsheet_id',
'label' => esc_html__('Select Spreadsheet', 'alpha-addons-for-gravity-forms'),
'type' => 'select',
'choices' => $this->get_spreadsheet_list(),
'tooltip' => sprintf(
'%s
%s',
esc_html__('Spreadsheet', 'alpha-addons-for-gravity-forms'),
esc_html__('Select the Spreadsheet to which you would like to add your form data.', 'alpha-addons-for-gravity-forms')
),
'onchange' => 'jQuery(this).parents("form").submit();',
),
array(
'name' => 'sheet_name',
'label' => esc_html__('Select Sheet', 'alpha-addons-for-gravity-forms'),
'type' => 'sheet_name',
'tooltip' => sprintf(
'%s
%s',
esc_html__('Sheet', 'alpha-addons-for-gravity-forms'),
esc_html__('Select the Sheet to which you would like to add your form data.', 'alpha-addons-for-gravity-forms')
),
'onchange' => 'jQuery(this).parents("form").submit();',
'dependency' => 'spreadsheet_id'
),
array(
'name' => 'import_headers',
'label' => esc_html__('Set Headers', 'alpha-addons-for-gravity-forms'),
'type' => 'import_headers',
'tooltip' => sprintf(
'%s
%s',
esc_html__('Set Headers', 'alpha-addons-for-gravity-forms'),
esc_html__('Clicking the “Add Headers” button adds the entry ID and all form fields to the spreadsheet', 'alpha-addons-for-gravity-forms')
),
'dependency' => [$this, 'sheet_headers_callback'],
),
array(
'name' => 'btn_desc',
'type' => 'html',
'html' => wp_kses_post(
sprintf(
/* translators: %s: Button label */
__('Clicking the %s button adds the entry ID and all form fields to the spreadsheet', 'alpha-addons-for-gravity-forms'),
'' . esc_html__('Add Headers', 'alpha-addons-for-gravity-forms') . ''
)
),
'dependency' => [$this, 'sheet_headers_callback'],
)
)
),
array(
'title' => esc_html__('Map Fields', 'alpha-addons-for-gravity-forms'),
'description' => esc_html__('Map the fields from your form to the headers in your Google Sheet.', 'alpha-addons-for-gravity-forms'),
'dependency' => array($this, 'sheet_headers_callback2'),
'fields' => array(
array(
'name' => 'mapped_fields',
'label' => '',
'type' => 'field_map',
'field_map' => $this->headers_map(),
),
array(
'name' => 'sheet_buttons',
'label' => esc_html__('View & Download Spreadsheet', 'alpha-addons-for-gravity-forms'),
'type' => 'view_sheet_buttons',
),
),
)
);
}
public function sheet_headers_callback2() {
$is_sheet_added = $this->get_setting('sheet_name');
return (! empty($is_sheet_added) && ! $this->sheet_headers_callback());
}
public function headers_map() {
$spreadsheet_id = $this->get_setting('spreadsheet_id');
$sheet_name = $this->get_setting('sheet_name');
$headers = ALPHAGF_Google_Sheet_API::get_spreadsheet_headers($spreadsheet_id, $sheet_name);
$field_map = array();
if (! empty($headers)) {
foreach ($headers as $header) {
$field_map[$header['id']] = array(
'name' => 'name_' . $header['id'],
'label' => $header['label'],
);
}
}
return $field_map;
}
public function process_feed($feed, $entry, $form) {
if (! rgars($feed, 'meta/is_enable')) {
return $entry;
}
$headers = array();
$field_map = $this->get_field_map_fields($feed, 'mapped_fields');
foreach ($field_map as $name => $field_id) {
$name = trim(str_replace('name_', '', $name));
if (empty($field_id)) {
$headers[$name] = '';
continue;
}
$field = RGFormsModel::get_field($form, $field_id);
if (! empty($field) && $field->type == 'number') {
$value = RGFormsModel::get_lead_field_value($entry, $field);
$headers[$name] = GFCommon::get_lead_field_display($field, $value, rgar($entry, 'currency'));
} elseif ($field_id == 'date_created') {
$date_format = apply_filters('alphagf_google_sheet_date_format', 'Y-m-d H:i:s');
// send entry date in correct timezone
$headers[$name] = GFCommon::format_date($entry['date_created'], false, $date_format, false);
} else {
$value = $this->get_field_value($form, $entry, $field_id);
$headers[$name] = $this->escape_cell_value($value);
}
}
$spreadsheet_id = rgars($feed, 'meta/spreadsheet_id');
$sheet_name = rgars($feed, 'meta/sheet_name');
if (empty($spreadsheet_id) || empty($sheet_name)) {
$this->add_feed_error(esc_html__('No spreadsheet or sheet is selected for this feed.', 'alpha-addons-for-gravity-forms'), $feed, $entry, $form);
return $entry;
}
$row = array();
$defaultheaders = ALPHAGF_Google_Sheet_API::get_spreadsheet_headers($spreadsheet_id, $sheet_name);
if (empty($defaultheaders)) {
$this->add_feed_error(esc_html__('Unable to read the sheet headers, so the row was not added.', 'alpha-addons-for-gravity-forms'), $feed, $entry, $form);
return $entry;
}
foreach ($defaultheaders as $key => $name) {
$row[$key] = isset($headers[$key]) ? $headers[$key] : '';
}
$result = ALPHAGF_Google_Sheet_API::add_new_row($spreadsheet_id, $sheet_name, array(array_values($row)));
if (is_wp_error($result)) {
$this->add_feed_error(
sprintf(
/* translators: %s: Error message returned by Google. */
esc_html__('Unable to add the entry to Google Sheet: %s', 'alpha-addons-for-gravity-forms'),
$result->get_error_message()
),
$feed,
$entry,
$form
);
} else {
$this->add_note($entry['id'], esc_html__('Entry added to Google Sheet.', 'alpha-addons-for-gravity-forms'), 'success');
}
return $entry;
}
/**
* Rows are sent with USER_ENTERED so numbers and dates are parsed, which would also run any submitted
* value starting with "=" as a formula. Prefix those with an apostrophe so they are stored as text.
*/
private function escape_cell_value($value) {
if (! is_string($value) || '' === $value) {
return $value;
}
$first = $value[0];
if (in_array($first, array('=', '+', '@'), true) || ('-' === $first && ! is_numeric($value))) {
$value = "'" . $value;
}
return apply_filters('alphagf_google_sheet_cell_value', $value);
}
private function get_spreadsheet_list() {
$spreadsheet_list = get_option('alphagf_gs_sheet_list', []);
if (empty($spreadsheet_list)) {
$spreadsheet_list = ALPHAGF_Google_Sheet_API::get_spreadsheet_list();
}
$choices = [
[
'label' => esc_html__('Select a spreadsheet', 'alpha-addons-for-gravity-forms'),
'value' => '',
],
];
foreach ((array) $spreadsheet_list as $spreadsheet) {
if (empty($spreadsheet['id'])) {
continue;
}
$choices[] = array(
'value' => $spreadsheet['id'],
'label' => $spreadsheet['name'],
);
}
return $choices;
}
public function settings_sheet_name($field, $echo = true) {
$html = '';
// Get current list ID.
$spreadsheet_id = $this->get_setting('spreadsheet_id');
$sheet_names = ALPHAGF_Google_Sheet_API::get_individual_sheet_names($spreadsheet_id);
$choices = [
[
'label' => esc_html__('Select a sheet', 'alpha-addons-for-gravity-forms'),
'value' => '',
],
];
foreach ((array) $sheet_names as $sheet_name) {
$choices[] = array(
'value' => $sheet_name['id'],
'label' => $sheet_name['label'],
);
}
$field['type'] = 'select';
$field['choices'] = $choices;
$html = $this->settings_select($field, false);
$html .= '' . esc_html__('Clear Cache', 'alpha-addons-for-gravity-forms') . '';
if ($echo) {
echo esc_html($html);
}
return $html;
}
public function settings_import_headers($field, $echo = true) {
$html = sprintf(
'
',
esc_html__('Add Headers', 'alpha-addons-for-gravity-forms')
);
if ($echo) {
$allowed_html = wp_kses_allowed_html('post');
echo wp_kses($html, $allowed_html);
}
return $html;
}
public function settings_view_sheet_buttons($field, $echo = true) {
$view_sheet = 'https://docs.google.com/spreadsheets/d/' . rawurlencode((string) $this->get_setting('spreadsheet_id'));
$download_sheet = $view_sheet . '/export';
$html = sprintf(
'%1$s',
esc_html__('View Spreadsheet', 'alpha-addons-for-gravity-forms'),
esc_url($view_sheet)
);
$html .= sprintf(
'%1$s',
esc_html__('Download Spreadsheet', 'alpha-addons-for-gravity-forms'),
esc_url($download_sheet)
);
if ($echo) {
$allowed_html = wp_kses_allowed_html('post');
echo wp_kses($html, $allowed_html);
}
return $html;
}
/**
* Whether the selected sheet still needs headers. Called several times per render, so the remote check is cached.
*/
public function sheet_headers_callback() {
static $cache = array();
$spreadsheet_id = (string) $this->get_setting('spreadsheet_id');
$sheet_name = (string) $this->get_setting('sheet_name');
$key = $spreadsheet_id . '|' . $sheet_name;
if (! isset($cache[$key])) {
$cache[$key] = ALPHAGF_Google_Sheet_API::is_spreadsheet_header_exists($spreadsheet_id, $sheet_name);
}
return $cache[$key];
}
public function can_create_feed() {
return get_option('alphagf_gs_auth_verified', 0);
}
public function plugin_settings_fields() {
return array(
array(
'title' => esc_html__('Google Sheet Settings', 'alpha-addons-for-gravity-forms'),
// translators: %1 is an opening tag, and %2 is a closing tag.
'description' => sprintf(esc_html__('Create a Google Console app to integrate your Google Sheet with Gravity Forms. %1$sClick here%2$s to create your app.', 'alpha-addons-for-gravity-forms'), '', ''),
'fields' => array(
array(
'name' => 'client_id',
'label' => esc_html__('Client ID', 'alpha-addons-for-gravity-forms'),
'type' => 'text',
'class' => 'medium',
),
array(
'name' => 'client_secret',
'label' => esc_html__('Client Secret', 'alpha-addons-for-gravity-forms'),
'type' => 'text',
'class' => 'medium',
),
array(
'name' => 'redirect_uri',
'label' => esc_html__('Redirect URI', 'alpha-addons-for-gravity-forms'),
'type' => 'text',
'class' => 'medium',
'default_value' => admin_url('admin.php?page=gf_settings&subview=alphagf_google_sheet'),
),
array(
'name' => 'client_token',
'label' => esc_html__('Client Token Code', 'alpha-addons-for-gravity-forms'),
'type' => 'text',
'class' => 'medium',
'feedback_callback' => [$this, 'token_validation_callback'],
),
array(
'name' => 'authorize_btn',
'type' => 'authorize_account',
'class' => 'medium',
),
),
),
);
}
public function settings_authorize_account($field) {
$settings = $this->get_plugin_settings();
$is_auth_verified = get_option('alphagf_gs_auth_verified', 0);
if (! rgar($field, 'value')) {
$field['value'] = esc_html__('Generate Token', 'alpha-addons-for-gravity-forms');
}
$client_id = (string) rgar($settings, 'client_id');
$redirect_uri = (string) rgar($settings, 'redirect_uri');
if (empty($redirect_uri)) {
$redirect_uri = admin_url('admin.php?page=gf_settings&subview=alphagf_google_sheet');
}
$auth_url = self::ALPHAGF_GS_OAUTH2_AUTH_URL . '?scope=' . rawurlencode(self::ALPHAGF_GS_AUTH_SCOPE) . '&redirect_uri=' . rawurlencode($redirect_uri) . '&response_type=code&prompt=consent&client_id=' . rawurlencode($client_id) . '&access_type=offline';
if ($is_auth_verified) {
$html = $this->authorized_account();
$html .= '' . esc_html__('Revoke Token', 'alpha-addons-for-gravity-forms') . '';
} else {
$html = '' . esc_html__('Generate Token', 'alpha-addons-for-gravity-forms') . '';
}
return $html;
}
public function token_validation_callback() {
$code = rgpost('_gform_setting_client_token');
if (get_option('alphagf_gs_auth_verified', 0)) {
return true;
}
if (empty($code)) {
return '';
}
$result = ALPHAGF_Google_Sheet_API::authenticate($code);
if (! $result) {
return false;
}
return true;
}
private function authorized_account() {
$verified = get_option('alphagf_gs_auth_verified', 0);
$auth_account = get_option('alphagf_gs_auth_account', []);
if ($verified && !empty($auth_account)) {
$html = '';
return $html;
}
return '';
}
public function revoke_google_sheet_token() {
$this->verify_ajax_request('gravityforms_edit_settings');
$settings = get_option('alphagf_gs_token_data', []);
// Revoking the refresh token also invalidates every access token issued from it.
$token = rgar($settings, 'refresh_token') ? $settings['refresh_token'] : rgar($settings, 'access_token');
$result = ALPHAGF_Google_Sheet_API::revoke_token($token);
if (! $result) {
wp_send_json_error();
}
wp_send_json_success($result);
}
public function insert_google_sheet_header() {
$this->verify_ajax_request('gravityforms_edit_forms');
$sheet_id = sanitize_text_field((string) rgpost('spreadsheet_id'));
$sheet_name = sanitize_text_field((string) rgpost('sheet_name'));
$form_id = absint(rgpost('form_id'));
$headers = $this->get_form_fields_label($form_id);
if (empty($sheet_id) || empty($sheet_name) || is_wp_error($headers) || empty($headers)) {
wp_send_json_error([
'message' => __('Please select a spreadsheet and sheet first.', 'alpha-addons-for-gravity-forms')
]);
}
$result = ALPHAGF_Google_Sheet_API::set_spreadsheet_headers($sheet_id, $sheet_name, $headers);
if ($result) {
wp_send_json_success([
'message' => __('Headers inserted successfully', 'alpha-addons-for-gravity-forms')
]);
}
wp_send_json_error([
'message' => __('Failed to insert headers', 'alpha-addons-for-gravity-forms')
]);
}
private function verify_ajax_request($capability) {
check_ajax_referer('alphagf_gs_nonce', 'nonce');
if (! GFCommon::current_user_can_any($capability)) {
wp_send_json_error(array('message' => esc_html__('Sorry, you are not allowed to do that.', 'alpha-addons-for-gravity-forms')), 403);
}
}
public function get_form_fields_label($form_id) {
$form = GFAPI::get_form($form_id);
// Check if the form exists / is valid
if (is_wp_error($form)) {
return $form;
}
// Make sure we have fields
if (empty($form['fields']) || !is_array($form['fields'])) {
return array();
}
$labels = array('Entry ID');
foreach ($form['fields'] as $field) {
if (empty($field->type)) {
continue;
}
if (in_array($field->type, $this->_unsupported_field_types, true)) {
continue;
}
if (!empty($field->label)) {
$labels[] = $field->label;
}
}
return $labels;
}
public function clear_google_sheet_cache() {
$this->verify_ajax_request('gravityforms_edit_forms');
delete_transient('alphagf_gs_sheet_headers');
delete_option('alphagf_gs_sheet_names');
delete_option('alphagf_gs_sheet_list');
wp_send_json_success();
}
public function custom_field_map_choices($choices, $form_id, $required_types, $exclude_field_types) {
if (rgget('subview') !== $this->_slug) {
return $choices;
}
$types_to_exclude = $this->_unsupported_field_types;
if (isset($choices['fields']) && isset($choices['fields']['choices'])) {
$choices['fields']['choices'] = array_filter($choices['fields']['choices'], function ($field_choice) use ($types_to_exclude) {
$current_type = rgar($field_choice, 'type');
return ! in_array($current_type, $types_to_exclude);
});
$choices['fields']['choices'] = array_values($choices['fields']['choices']);
}
return $choices;
}
}