Code Coverage
 
Lines
Functions and Methods
Classes and Traits
Total
98.21%
110 / 112
77.78%
7 / 9
 CRAP
0.00%
0 / 1
Odyssey_Config_Data
98.21%
110 / 112
77.78%
7 / 9
 15
0.00%
0 / 1
 get_js_config_data
100.00%
4 / 4
100.00%
1 / 1
 2
 get_data
100.00%
64 / 64
100.00%
1 / 1
 3
 is_automated_transfer
100.00%
5 / 5
100.00%
1 / 1
 1
 get_gmt_offset
100.00%
1 / 1
100.00%
1 / 1
 1
 get_admin_path
75.00%
3 / 4
0.00%
0 / 1
 3.14
 get_user_locale
100.00%
3 / 3
100.00%
1 / 1
 1
 get_plan_features
75.00%
3 / 4
0.00%
0 / 1
 2.06
 get_plan
100.00%
4 / 4
100.00%
1 / 1
 1
 get_current_user_capabilities
100.00%
23 / 23
100.00%
1 / 1
 1
1<?php
2/**
3 * Stats Initial State
4 *
5 * @package automattic/jetpack-stats-admin
6 */
7
8namespace Automattic\Jetpack\Stats_Admin;
9
10use Automattic\Jetpack\Blaze;
11use Automattic\Jetpack\Current_Plan as Jetpack_Plan;
12use Automattic\Jetpack\Modules;
13use Automattic\Jetpack\Status\Host;
14use Jetpack_Options;
15
16/**
17 * Class Odyssey_Config_Data
18 *
19 * @package automattic/jetpack-stats-admin
20 */
21class Odyssey_Config_Data {
22
23    /**
24     * Set configData to window.configData.
25     *
26     * @param string $config_variable_name The config variable name.
27     * @param array  $config_data The config data.
28     */
29    public function get_js_config_data( $config_variable_name = 'configData', $config_data = null ) {
30        return "window.{$config_variable_name} = " . wp_json_encode(
31            $config_data === null ? $this->get_data() : $config_data,
32            JSON_UNESCAPED_SLASHES | JSON_HEX_TAG | JSON_HEX_AMP
33        ) . ';';
34    }
35
36    /**
37     * Return the config for the app.
38     */
39    public function get_data() {
40        global $wp_version;
41
42        $blog_id = Jetpack_Options::get_option( 'id' );
43        $host    = new Host();
44
45        $can_blaze = class_exists( 'Automattic\Jetpack\Blaze' ) && Blaze::should_initialize()['can_init'];
46
47        return array(
48            'admin_page_base'                => $this->get_admin_path(),
49            'api_root'                       => esc_url_raw( rest_url() ),
50            'blog_id'                        => Jetpack_Options::get_option( 'id' ),
51            'enable_all_sections'            => false,
52            'env_id'                         => 'production',
53            'google_analytics_key'           => 'UA-10673494-15',
54            'google_maps_and_places_api_key' => '',
55            'hostname'                       => wp_parse_url( get_site_url(), PHP_URL_HOST ),
56            'i18n_default_locale_slug'       => 'en',
57            'i18n_locale_slug'               => $this->get_user_locale(),
58            'mc_analytics_enabled'           => false,
59            'meta'                           => array(),
60            'nonce'                          => wp_create_nonce( 'wp_rest' ),
61            'site_name'                      => \get_bloginfo( 'name' ),
62            'sections'                       => array(),
63            // Features are inlined @see https://github.com/Automattic/wp-calypso/pull/70122
64            'features'                       => array(
65                'is_running_in_jetpack_site' => ! $host->is_wpcom_simple(),
66            ),
67            // Intended for apps that do not use redux.
68            'gmt_offset'                     => $this->get_gmt_offset(),
69            'odyssey_stats_base_url'         => admin_url( 'admin.php?page=stats' ),
70            'intial_state'                   => array(
71                'currentUser' => array(
72                    'id'           => 1000,
73                    'user'         => array(
74                        'ID'       => 1000,
75                        'username' => 'no-user',
76                    ),
77                    'capabilities' => array(
78                        "$blog_id" => $this->get_current_user_capabilities(),
79                    ),
80                ),
81                'sites'       => array(
82                    'items'    => array(
83                        "$blog_id" => array(
84                            'ID'           => $blog_id,
85                            'URL'          => site_url(),
86                            // Atomic and jetpack sites should return true.
87                            'jetpack'      => ! $host->is_wpcom_simple(),
88                            'visible'      => true,
89                            'capabilities' => $this->get_current_user_capabilities(),
90                            'products'     => Jetpack_Plan::get_products(),
91                            'plan'         => $this->get_plan(),
92                            'options'      => array(
93                                'wordads'               => ( new Modules() )->is_active( 'wordads' ),
94                                'admin_url'             => admin_url(),
95                                'gmt_offset'            => $this->get_gmt_offset(),
96                                'is_automated_transfer' => $this->is_automated_transfer( $blog_id ),
97                                'is_wpcom_atomic'       => $host->is_woa_site(),
98                                'is_wpcom_simple'       => $host->is_wpcom_simple(),
99                                'is_vip'                => $host->is_vip_site(),
100                                'jetpack_version'       => defined( 'JETPACK__VERSION' ) ? JETPACK__VERSION : '',
101                                'stats_admin_version'   => Main::VERSION,
102                                'software_version'      => $wp_version,
103                                'can_blaze'             => $can_blaze,
104                            ),
105                        ),
106                    ),
107                    'features' => array( "$blog_id" => array( 'data' => $this->get_plan_features() ) ),
108                ),
109            ),
110        );
111    }
112
113    /**
114     * Defines a filter to set whether a site is an automated_transfer site or not.
115     *
116     * Default is false. On Atomic, this is set to true by `wpcomsh`.
117     *
118     * @param int $blog_id Blog ID.
119     *
120     * @return bool
121     */
122    public function is_automated_transfer( $blog_id ) {
123        /**
124         * Filter if a site is an automated-transfer site.
125         *
126         * @module json-api
127         *
128         * @since 6.4.0
129         *
130         * @param bool is_automated_transfer( $this->blog_id )
131         * @param int  $blog_id Blog identifier.
132         */
133        return apply_filters(
134            'jetpack_site_automated_transfer',
135            false,
136            $blog_id
137        );
138    }
139
140    /**
141     * Get the current site GMT Offset.
142     *
143     * @return float The current site GMT Offset by hours.
144     */
145    protected function get_gmt_offset() {
146        return (float) get_option( 'gmt_offset' );
147    }
148
149    /**
150     * Page base for the Calypso admin page.
151     */
152    protected function get_admin_path() {
153        if ( ! isset( $_SERVER['PHP_SELF'] ) || ! isset( $_SERVER['QUERY_STRING'] ) ) {
154            $parsed = wp_parse_url( admin_url( 'admin.php?page=stats' ) );
155            return $parsed['path'] . '?' . $parsed['query'];
156        }
157        // We do this because page.js requires the exactly page base to be set otherwise it will not work properly.
158        // phpcs:ignore WordPress.Security.ValidatedSanitizedInput.InputNotSanitized
159        return wp_unslash( $_SERVER['PHP_SELF'] ) . '?' . wp_unslash( $_SERVER['QUERY_STRING'] );
160    }
161
162    /**
163     * Get locale acceptable by Calypso.
164     */
165    protected function get_user_locale() {
166        /**
167         * In WP, locales are formatted as LANGUAGE_REGION, for example `en`, `en_US`, `es_AR`,
168         * but Calypso expects language-region, e.g. `en-us`, `en`,  `es-ar`. So we need to convert
169         * them to lower case and replace the underscore with a dash.
170         */
171        $locale = strtolower( get_user_locale() );
172        $locale = str_replace( '_', '-', $locale );
173
174        return $locale;
175    }
176
177    /**
178     * Get the features of the current plan.
179     */
180    protected function get_plan_features() {
181        $plan = Jetpack_Plan::get();
182        if ( empty( $plan['features'] ) ) {
183            return array();
184        }
185        return $plan['features'];
186    }
187
188    /**
189     * Get the current plan.
190     *
191     * @return array
192     */
193    protected function get_plan() {
194        $plan = Jetpack_Plan::get();
195        unset( $plan['features'] );
196        unset( $plan['supports'] );
197        return $plan;
198    }
199
200    /**
201     * Get the capabilities of the current user.
202     *
203     * @return array An array of capabilities.
204     */
205    protected function get_current_user_capabilities() {
206        return array(
207            'edit_pages'          => current_user_can( 'edit_pages' ),
208            'edit_posts'          => current_user_can( 'edit_posts' ),
209            'edit_others_posts'   => current_user_can( 'edit_others_posts' ),
210            'edit_others_pages'   => current_user_can( 'edit_others_pages' ),
211            'delete_posts'        => current_user_can( 'delete_posts' ),
212            'delete_others_posts' => current_user_can( 'delete_others_posts' ),
213            'edit_theme_options'  => current_user_can( 'edit_theme_options' ),
214            'edit_users'          => current_user_can( 'edit_users' ),
215            'list_users'          => current_user_can( 'list_users' ),
216            'manage_categories'   => current_user_can( 'manage_categories' ),
217            'manage_options'      => current_user_can( 'manage_options' ),
218            'moderate_comments'   => current_user_can( 'moderate_comments' ),
219            'activate_wordads'    => current_user_can( 'manage_options' ),
220            'promote_users'       => current_user_can( 'promote_users' ),
221            'publish_posts'       => current_user_can( 'publish_posts' ),
222            'upload_files'        => current_user_can( 'upload_files' ),
223            'delete_users'        => current_user_can( 'delete_users' ),
224            'remove_users'        => current_user_can( 'remove_users' ),
225            'own_site'            => current_user_can( 'manage_options' ), // Administrators are considered owners on site.
226            'view_stats'          => current_user_can( 'view_stats' ),
227            'activate_plugins'    => current_user_can( 'activate_plugins' ),
228        );
229    }
230}