wp-graphql-wpml.php

<?php

use WPGraphQL\Data\Connection\AbstractConnectionResolver;

/**
 * Plugin Name: WPGraphQL WPML
 * Plugin URI: https://github.com/rburgst/wp-graphql-wpml
 * Description: Adds WPML functionality to WPGraphQL schema.
 * Version: 1.0.8
 * Author: rburgst
 * Author URI: https://github.com/rburgst/
 * License: GPL-3
 * License URI: https://www.gnu.org/licenses/gpl-3.0.html
 * WC requires at least: 3.0.0
 * WC tested up to: 4.0.0
 * WPGraphQL requires at least: 0.8.0+
 *
 * @package     WPGraphQL\WPML
 * @author      rburgst
 * @license     GPL-3
 */


function wpgraphqlwpml_is_graphql_request()
{
    // Detect WPGraphQL activation by checking if the main class is defined
    if (!class_exists('WPGraphQL')) {
        return false;
    }

    return is_graphql_http_request();
}


function wpgraphqlwpml_disable_wpml($query_args, $source, $args, $context, $info)
{
    $query_args['suppress_wpml_where_and_join_filter'] = true;
    return $query_args;
}

add_filter('graphql_post_object_connection_query_args', 'wpgraphqlwpml_disable_wpml', 100, 5);

function wpgraphqlwpml_add_post_type_fields(\WP_Post_Type $post_type_object)
{
    $type = ucfirst($post_type_object->graphql_single_name);
    register_graphql_field(
        $post_type_object->graphql_single_name,
        'locale',
        [
            'type' => 'Locale',
            'description' => __('WPML translation link', 'wp-graphql-wpml'),
            'resolve' => function (
                \WPGraphQL\Model\Post $post,
                $args,
                $context,
                $info
            ) {
                $fields = $info->getFieldSelection();
                $language = [
                    'id' => null,
                    'locale' => null,
                ];

                $langInfo = wpml_get_language_information($post->ID);
                $locale = $langInfo['locale'];

                if (!$locale) {
                    return null;
                }

                $language['id'] = $locale;

                if (isset($fields['locale'])) {
                    $language['locale'] = $locale;
                }

                return $language;
            },
        ]
    );
    register_graphql_field(
        $post_type_object->graphql_single_name,
        'localizedWpmlUrl',
        [
            'type' => 'String',
            'description' => __('WPML localized url of the page/post', 'wp-graphql-wpml'),
            'resolve' => function (
                \WPGraphQL\Model\Post $post,
                $args,
                $context,
                $info
            ) {
                global $sitepress;

                $post_id = $post->ID;
                $langInfo = wpml_get_language_information($post_id);
                $languages = $sitepress->get_active_languages();
                $post_language = [];
                foreach ($languages as $language) {
                    if ($language['code'] === $langInfo['language_code']) {
                        $post_language = $language;
                        break;
                    }
                }

                list($thisPost, $translationUrl) = graphql_wpml_get_translation_url($post_id, $post_language);

                return $translationUrl;
            },
        ]
    );
    register_graphql_field(
        $post_type_object->graphql_single_name,
        'translations',
        [
            'type' => ['list_of' => 'Translation'],
            'description' => __('WPML translations', 'wpnext'),
            'resolve' => function (
                \WPGraphQL\Model\Post $post,
                $args,
                $context,
                $info
            ) {
                global $sitepress;
                $translations = [];

                $languages = $sitepress->get_active_languages();
                $orig_post_id = $post->ID;

                foreach ($languages as $language) {
                    $lang_code = array_key_exists('language_code', $languages) ? $language['language_code'] : $language['code'];
                    $post_id = wpml_object_id_filter($orig_post_id, 'post', false, $lang_code);
                    if ($post_id === null || $post_id == $orig_post_id) continue;

                    list($thisPost, $translationUrl) = graphql_wpml_get_translation_url($post_id, $language);

                    $translations[] = array('locale' => $language['default_locale'], 'id' => $post_id, 'post_title' => $thisPost->post_title, 'href' => $translationUrl);
                }

                return $translations;
            },
        ]
    );
    register_graphql_field(
        $post_type_object->graphql_single_name,
        'translated',
        [
            'type' => ['list_of' => $type],
            'description' => __('WPML translated versions of the same post', 'wpnext'),
            'resolve' => function (
                \WPGraphQL\Model\Post $post,
                $args,
                $context,
                $info
            ) {
                global $sitepress;
                global $wpdb;

                $fields = $info->getFieldSelection();
                $translations = [];

                $languages = $sitepress->get_active_languages();
                $settings = $wpdb->get_row(
                    "SELECT option_value from {$wpdb->prefix}options where option_name = 'page_on_front'",
                    ARRAY_A
                );

                // Get the default language code
                $default_lang = apply_filters('wpml_default_language', NULL );

                // Front page ID of the default language
                $default_front_page_ID = $settings['option_value'];

                foreach ($languages as $language) {
                    $orig_post_id = $post->ID;
                    $lang_code = array_key_exists('language_code', $languages) ? $language['language_code'] : $language['code'];
                    $post_id = wpml_object_id_filter($orig_post_id, 'post', false, $lang_code);

                    if ($post_id === null || $post_id == $orig_post_id) continue;

                    $translation = new \WPGraphQL\Model\Post(
                        \WP_Post::get_instance($post_id)
                    );

                    // Check if the homepage option is configured
                    if($default_front_page_ID) {

                        // Get the ID of the translated home page
                        $translated_front_pageID = apply_filters( 'wpml_object_id', $default_front_page_ID, 'page', FALSE, $lang_code );

                        if($post_id == $translated_front_pageID) {
                            $new_uri = $lang_code == $default_lang ? '/' : '/' . $lang_code;
                            $translation->uri = $new_uri;
                        }
                    }

                    array_push($translations, $translation);
                }

                return $translations;
            },
        ]
    );
}

/**
 * @param int $post_id
 * @param $language
 * @return array
 */
function graphql_wpml_get_translation_url(int $post_id, $language): array
{
    $thisPost = get_post($post_id);
    if (array_key_exists('url', $language)) {
        $baseUrl = apply_filters('WPML_filter_link', $language['url'], $language);
    }
    // for posts it can be that the $language['url'] already contains the translated url of the post
    if (isset($baseUrl) && strpos($baseUrl, $thisPost->post_name) > 0) {
        $translationUrl = $baseUrl;
    } else {
        // note that this requires wpml 4.5.3 to work
        $href = get_permalink($thisPost->ID);
        return array($thisPost, $href);
    }
    return array($thisPost, $translationUrl);
}

function wpgraphqlwpml_action_graphql_register_types()
{
    register_graphql_object_type('LanguageInfo', [
        'description' => __('Locale Info (WPML)', 'wp-graphql-wpml'),
        'fields' => [
            'id' => [
                'type' => [
                    'non_null' => 'ID',
                ],
                'description' => __(
                    'Language ID (WPML)',
                    'wp-graphql-wpml'
                ),
            ],
            'code' => [
                'type' => 'String',
                'description' => __(
                    'Language code (WPML)',
                    'wp-graphql-wpml'
                ),
            ],
            'native_name' => [
                'type' => 'String',
                'description' => __(
                    'Language native name (WPML)',
                    'wp-graphql-wpml'
                ),
            ],
            'translated_name' => [
                'type' => 'String',
                'description' => __(
                    'Language translated name (WPML)',
                    'wp-graphql-wpml'
                ),
            ],
            'default_locale' => [
                'type' => 'String',
                'description' => __(
                    'Language locale (WPML)',
                    'wp-graphql-wpml'
                ),
            ],
            'is_hidden' => [
                'type' => 'Boolean',
                'description' => __(
                    'Is the language hidden?',
                    'wp-graphql-wpml'
                ),
            ],
        ],
    ]);
    register_graphql_object_type('Locale', [
        'description' => __('Locale (WPML)', 'wp-graphql-wpml'),
        'fields' => [
            'id' => [
                'type' => [
                    'non_null' => 'ID',
                ],
                'description' => __(
                    'Language ID (WPML)',
                    'wp-graphql-wpml'
                ),
            ],
            'locale' => [
                'type' => 'String',
                'description' => __(
                    'Language locale (WPML)',
                    'wp-graphql-wpml'
                ),
            ],
        ],
    ]);
    register_graphql_object_type('Translation', [
        'description' => __('Translation (WPML)', 'wp-graphql-wpml'),
        'fields' => [
            'id' => [
                'type' => [
                    'non_null' => 'ID',
                ],
                'description' => __(
                    'the id of the referenced translation (WPML)',
                    'wp-graphql-wpml'
                ),
            ],
            'href' => [
                'type' => 'String',
                'description' => __(
                    'the relative link to the translated content (WPML)',
                    'wp-graphql-wpml'
                ),
            ],
            'locale' => [
                'type' => 'String',
                'description' => __(
                    'Language code (WPML)',
                    'wp-graphql-wpml'
                ),
            ],
            'post_title' => [
                'type' => 'String',
                'description' => __(
                    'the title of the translated page (WPML)',
                    'wp-graphql-wpml'
                ),
            ],
        ],
    ]);

    register_graphql_fields('RootQueryToMenuItemConnectionWhereArgs', [
        'language' => [
            'type' => 'String',
            'description' => 'filters the menu items by language',
        ],
    ]);
    register_graphql_fields('RootQueryToMenuConnectionWhereArgs', [
        'language' => [
            'type' => 'String',
            'description' => 'filters the menus by language',
        ],
    ]);

    register_graphql_field('RootQuery', 'languages', [
            'type' => ['list_of' => 'LanguageInfo'],
            'description' => __(
                'List available languages',
                'wp-graphql-wpml'
            ),
            'resolve' => function ($source, $args, $context, $info) {
                $args = array('skip_missing' => 1);
                $language_infos = apply_filters('wpml_active_languages', null, $args);

                // Add visibility of language
                foreach( $language_infos as $language_code => $data ) {
                    $language_infos[$language_code]['is_hidden'] = ( in_array( $language_code, apply_filters( 'wpml_setting', [], 'hidden_languages' ) ) === true ? true : false );
                }

                return $language_infos;
            }]
    );
    register_graphql_field('RootQuery', 'locales', [
            'type' => ['list_of' => 'String'],
            'description' => __(
                'List available locales',
                'wp-graphql-wpml'
            ),
            'resolve' => function ($source, $args, $context, $info) {
                $args = array('skip_missing' => 1);
                $language_infos = apply_filters('wpml_active_languages', null, $args);
                $locales = array_map(function ($lang) {
                    return $lang['default_locale'];
                }, $language_infos);
                return $locales;
            }]
    );
    register_graphql_fields('Menu', [
        'language' => [
            'type' => 'String',
            'description' => 'the language of the menu',
            'resolve' => function (
                \WPGraphQL\Model\Menu $menu,
                $args,
                $context,
                $info
            ) {
                $menuId = $menu->fields['databaseId'];
                // note that sometimes the fields are closures which have to be resolved before
                // we can access the values
                if (gettype($menuId) === 'object') {
                    $menuId = $menuId();
                }
                $args = array('element_id' => $menuId, 'element_type' => 'nav_menu');
                $lang_details = apply_filters('wpml_element_language_details', $menu, $args);
                if (!isset($lang_details) || !$lang_details) {
                    // we have to do it the hard way, reload the term and find out the term taxonomy id
                    global $icl_adjust_id_url_filter_off;
                    $icl_adjust_id_url_filter_off = true;
                    $term = get_term($menuId);
                    $term_taxonomy_id = $term->term_taxonomy_id;
                    $args['element_id'] = $term_taxonomy_id;
                    $lang_details = apply_filters('wpml_element_language_details', null, $args);
                }
                if (isset($lang_details)) {
                    return $lang_details->language_code;
                }
                return null;
            }
        ],
    ]);
    foreach (\WPGraphQL::get_allowed_post_types() as $post_type) {
        wpgraphqlwpml_add_post_type_fields(get_post_type_object($post_type));
    }
}

function wpgraphqlwpml__theme_mod_nav_menu_locations(array $args)
{
    foreach ($args as $menu_name => $menu_term_id) {
        $translated = get_term($menu_term_id);
        $args[$menu_name] = $translated->term_id;
    }
    return $args;
}

function resolve_menu_location_filter($location_filter, $language_filter)
{
    global $sitepress;

    // we have the list of location ids in our `include` list, now we somehow need to figure out
    // all location ids for the various languages
    global $icl_adjust_id_url_filter_off;
    $old_url_filter = $icl_adjust_id_url_filter_off;
    $icl_adjust_id_url_filter_off = false;

    // in case we have a language filter as well, only use the location ids from the specified
    // language
    if ($language_filter) {
        $languages = [$language_filter];
    } else {
        $languages = $sitepress->get_active_languages();
    }

    $locations = [];
    if (!is_array($location_filter)) {
        $locations[] = $location_filter;
    } else {
        $locations = $location_filter;
    }
    $location_ids = [];

    foreach ($locations as $cur_location) {
        foreach ($languages as $language) {
            $lang_code = $language;
            if (is_array($language)) {
                $lang_code = $language['code'];
            }
            $local_id = apply_filters('wpml_object_id', $cur_location, 'nav_menu', false, $lang_code);
            if ($local_id) {
                $location_ids[] = $local_id;
            }
        }

    }
    $icl_adjust_id_url_filter_off = $old_url_filter;
    return $location_ids;
}

$wpgraphqlwpml_url_filter_off = false;

function wpgraphqlwpml__filter_graphql_connection_query_args(array $args = null)
{
    global $sitepress;

    if (!$args) {
        return $args;
    }
    if (array_key_exists("post_type", $args) && $args['post_type'] === ['nav_menu_item'] && $args['fields'] === 'ids' && isset($args['tax_query'])) {
        // this is a query for menu items which currently is limited only to the locations
        // in the current language, in order to show all language menu items we need to
        // clear the 'tax_query' portion within args
        $tax_query = $args['tax_query'];
        $need_unset = true;
        $query_lang = null;
        if (isset($args['language'])) {
            $query_lang = $args['language'];
        }
        if (count($tax_query) === 1) {
            $first_tax_query = $tax_query[0];
            if ($first_tax_query['taxonomy'] === 'nav_menu' && $first_tax_query['field'] === 'term_id') {
                $old_terms = $first_tax_query['terms'];
                $resolved_terms = resolve_menu_location_filter($old_terms, $query_lang);
                $first_tax_query['terms'] = $resolved_terms;
                $need_unset = false;

                global $icl_adjust_id_url_filter_off;
                // turn the terms filtering off for now
                global $wpgraphqlwpml_url_filter_off;
                $wpgraphqlwpml_url_filter_off = $icl_adjust_id_url_filter_off;
                $icl_adjust_id_url_filter_off = true;

            }
            $args['tax_query'] = [$first_tax_query];
        }
        if ($need_unset) {
            unset($args['tax_query']);
        }
    }
    if (!isset($args['taxonomy'])) {
        return $args;
    }
    if ($args['taxonomy'] !== 'nav_menu') {
        return $args;
    }

    $graphql_args = $args['graphql_args'];

    $cur_lang = $sitepress->get_current_language();

    $have_id_query = isset($graphql_args) && isset($graphql_args['where']) && isset($graphql_args['where']['id']);
    $have_location_query = isset($graphql_args) && isset($graphql_args['where']) && isset($graphql_args['where']['location']);

    if ($have_location_query && $args['include']) {
        $location_ids = resolve_menu_location_filter($args['include'], $args['language'] ?? null);
        $args['include'] = $location_ids;
    } else if ($args['include'] && !$have_id_query) {
        // we have a taxonomy query, remove the includes filter to avoid restricting to localized
        // menu locations (however, only in case the user did not query for a specific id)
        unset($args['include']);
    }

    if (!isset($args['language'])) {
        return $args;
    }
    $target_lang = $args['language'];


    // Required only when using other than the default language because the
    // menu location for the default language is the original location
    if ($cur_lang !== $target_lang) {
        $sitepress->switch_lang($target_lang);

        if (!has_filter('theme_mod_nav_menu_locations', 'wpgraphqlwpml__theme_mod_nav_menu_locations')) {
            add_filter('theme_mod_nav_menu_locations', 'wpgraphqlwpml__theme_mod_nav_menu_locations');
        }
//        $args['where']['location'] = wpgraphqlwpml__translate_menu_location(
//            $args['where']['location'],
//            $target_lang
//        );
    }

    unset($target_lang);

    return $args;
}

$wpgraphqlwpml_prev_language = null;

function wpgraphqlwpml__filter_graphql_connection_should_execute(bool $should_execute, AbstractConnectionResolver $resolver)
{
    global $sitepress;
    global $wpgraphqlwpml_prev_language;


    $fieldName = $resolver->getInfo()->fieldName;
    if ($fieldName === 'menuItems') {
        $args = $resolver->getArgs();
        if (!isset($args['where']) || !isset($args['where']['language'])) {
            return $should_execute;
        }
        $new_lang = $args['where']['language'];
        $current_language = $sitepress->get_current_language();
        if ($new_lang !== $current_language) {
            $sitepress->switch_lang($new_lang);
            $wpgraphqlwpml_prev_language = $current_language;
        }
        unset($args['where']['language']);
    } else if ($fieldName === 'menus') {
        $args = $resolver->getArgs();
        if (!isset($args['where']) || !isset($args['where']['language'])) {
            return $should_execute;
        }
        $new_lang = $args['where']['language'];
        $current_language = $sitepress->get_current_language();
        if ($new_lang !== $current_language) {
            $sitepress->switch_lang($new_lang);
            $wpgraphqlwpml_prev_language = $current_language;
        }
        unset($args['where']['language']);
    }
    return $should_execute;
}

function wpgraphqlpwml__filter_graphql_return_field_from_model(
    $field, $key, $model_name, $data, $visibility, $owner, $current_user
)
{
    global $sitepress;

    if ($model_name === 'MenuObject' && $key === 'locations' && $field === null) {
        // this is a case where we have a menu item in a different language and no location
        // matches since locations point to the default menu id, therefore, we need to re-load
        // the same menu (term) with the default translation to figure out to which
        // locations this menu maps to
        global $icl_adjust_id_url_filter_off;
        // turn translation of terms / menus back on
        $icl_adjust_id_url_filter_off = false;

        $term_in_current_language = get_term($data->term_id);
        $cur_language_locations = get_nav_menu_locations();
        $target_locations = null;
        foreach ($cur_language_locations as $location => $id) {
            $loc = get_term($id);
            if (isset($loc) && !is_wp_error($loc) && absint($loc->term_id) === ($term_in_current_language->term_id)) {
                    $target_locations[] = $location;
                }
            }
        $icl_adjust_id_url_filter_off = true;
        return $target_locations;
    }
    return $field;
}

function wpgraphqlwpml__filter_graphql_connection_query(mixed $query, AbstractConnectionResolver $resolver)
{
    return $query;
}

function wpgraphqlwpml__filter_graphql_pre_model_data_is_private($unused, $model_name, $data, $visibility, $owner, $current_user)
{
    // we need to avoid not being able to see menu items, depending on your settings and auth
    // it often is the case that the graphql user does not seem to have permissions to read
    // menus (not sure why this is not the case for pages, etc.)
    if ($model_name === 'MenuObject' || $model_name === 'MenuItemObject') {
        return false;
    }
    return null;
}

function wpgraphqlwpml__filter_graphql_connection_ids(array $ids, AbstractConnectionResolver $resolver)
{
    global $wpgraphqlwpml_prev_language;
    global $wpgraphqlwpml_url_filter_off;

    $field_name = $resolver->getInfo()->fieldName;
    if ($field_name === 'menus') {
        global $icl_adjust_id_url_filter_off;
        $icl_adjust_id_url_filter_off = true;
        $args = $resolver->getArgs();
        if (!isset($args['where']) && !isset($wpgraphqlwpml_prev_language)) {
            return $ids;
        }
        if (true) {
            return $ids;
        }
//        $result = array();
//        foreach ($ids as $orig_id) {
//            $translated = get_term($orig_id);
//            array_push($result, $translated->term_id);
//        }
//        $sitepress->switch_lang($wpgraphqlwpml_prev_language);
//        unset($wpgraphqlwpml_prev_language);
        return $result;
    } elseif ($field_name === 'menuItems') {
        // turn the icl url filter back on
        global $icl_adjust_id_url_filter_off;
        $icl_adjust_id_url_filter_off = $wpgraphqlwpml_url_filter_off;
        unset($wpgraphqlwpml_url_filter_off);
    }

    return $ids;
}

/**
 * WPGraphQL filter hook function to allow querying in all languages.
 * This function is used to determine when the underlying WPGraphQL
 * query requires that the language be set to 'all'.
 *
 * Hooks into the WPGraphQL filter: `graphql_connection_query_args`
 *
 * Notes:
 *
 * WPML does not provide a hook or other convenient method to access
 * the logic applied when retrieving taxonomies - most of that logic
 * relies on the current language.
 *
 * WPML _does_ have a method to temporarily switch a language. The
 * `switch_lang` method allows for setting toe current language to
 * 'all' - once set this way, taxonomies are not filtered by language.
 */
function wpgraphqlwpml__switch_language_to_all_for_query(array $args)
{
    global $sitepress;

    // Set lang to 'all' when querying for built-in taxonomies
    if (
        isset($args['taxonomy']) &&
        ($args['taxonomy'] == 'post_tag' || $args['taxonomy'] == 'category')
    ) {
        $sitepress->switch_lang('all');
    }

    return $args;
}

function wpgraphqlwpml_action_init()
{
    if (!wpgraphqlwpml_is_graphql_request()) {
        return;
    }

    // prevent wpml to interfere (redirect to translated pages) on every graphql query
    add_filter('wpml_is_redirected', '__return_false');
    // prevent wpml to filter out translated pages/posts etc
    define('REST_REQUEST', true);


    add_action(
        'graphql_register_types',
        'wpgraphqlwpml_action_graphql_register_types',
        10,
        0
    );

    add_filter(
        'graphql_connection_should_execute',
        'wpgraphqlwpml__filter_graphql_connection_should_execute',
        10,
        2
    );

    add_filter(
        'graphql_connection_ids',
        'wpgraphqlwpml__filter_graphql_connection_ids',
        10,
        2
    );

    add_filter(
        'graphql_pre_model_data_is_private',
        'wpgraphqlwpml__filter_graphql_pre_model_data_is_private',
        10,
        6
    );
    add_filter(
        'graphql_return_field_from_model',
        'wpgraphqlpwml__filter_graphql_return_field_from_model',
        10,
        7
    );

    add_filter(
        'graphql_connection_query_args',
        'wpgraphqlwpml__filter_graphql_connection_query_args',
        10,
        2
    );

    // Add filter to adjust WPML language for certain queries
    add_filter(
        'graphql_connection_query_args',
        'wpgraphqlwpml__switch_language_to_all_for_query',
        10,
        2
    );
}


add_action('graphql_init', 'wpgraphqlwpml_action_init');