Code Coverage
 
Lines
Functions and Methods
Classes and Traits
Total
98.47%
129 / 131
83.33%
10 / 12
 CRAP
0.00%
0 / 1
Odyssey_Config_Data
98.47%
129 / 131
83.33%
10 / 12
 23
0.00%
0 / 1
 get_js_config_data
100.00%
4 / 4
100.00%
1 / 1
 2
 get_data
100.00%
5 / 5
100.00%
1 / 1
 2
 get_connected_blog_id
100.00%
4 / 4
100.00%
1 / 1
 2
 get_site_agnostic_data
100.00%
27 / 27
100.00%
1 / 1
 2
 get_initial_state
100.00%
43 / 43
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
87.50%
7 / 8
0.00%
0 / 1
 4.03
 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        $blog_id = $this->get_connected_blog_id();
41        $data    = $this->get_site_agnostic_data( $blog_id );
42
43        /*
44         * A site the app cannot reach has no record to seed its store with. Emitting one anyway
45         * would key every entry on a blog ID of 0 and make each lookup miss, so leave it out and
46         * let the app fall back to the screens it shows without a site.
47         */
48        if ( $blog_id ) {
49            $data['intial_state'] = $this->get_initial_state( $blog_id );
50        }
51
52        return $data;
53    }
54
55    /**
56     * The WordPress.com blog ID the app can talk to, or 0 when there is none.
57     *
58     * A site keeps its blog ID when it disconnects, but every request the app would make with it
59     * has to be signed with a token the site no longer holds. Such a site has no more to offer
60     * the app than one that was never connected.
61     *
62     * @return int
63     */
64    protected function get_connected_blog_id() {
65        $blog_id = (int) Jetpack_Options::get_option( 'id' );
66
67        if ( ! Main::is_site_connected() ) {
68            return 0;
69        }
70
71        // Keep registered sites in the dashboard even when their token is malformed.
72        // The traffic request reports the connection error; an ID of 0 routes to plan selection.
73        return $blog_id;
74    }
75
76    /**
77     * Config the app can rely on with or without a WordPress.com connection.
78     *
79     * @param int $blog_id The WordPress.com blog ID, 0 when the site is not connected.
80     * @return array
81     */
82    protected function get_site_agnostic_data( $blog_id ) {
83        global $wp_version;
84
85        return array(
86            'admin_page_base'                => $this->get_admin_path(),
87            'api_root'                       => esc_url_raw( rest_url() ),
88            'blog_id'                        => $blog_id,
89            'enable_all_sections'            => false,
90            'env_id'                         => 'production',
91            'google_analytics_key'           => 'UA-10673494-15',
92            'google_maps_and_places_api_key' => '',
93            'hostname'                       => wp_parse_url( get_site_url(), PHP_URL_HOST ),
94            'i18n_default_locale_slug'       => 'en',
95            'i18n_locale_slug'               => $this->get_user_locale(),
96            'mc_analytics_enabled'           => false,
97            'meta'                           => array(),
98            'nonce'                          => wp_create_nonce( 'wp_rest' ),
99            'site_name'                      => \get_bloginfo( 'name' ),
100            'sections'                       => array(),
101            // Features are inlined @see https://github.com/Automattic/wp-calypso/pull/70122
102            'features'                       => array(
103                'is_running_in_jetpack_site' => ! ( new Host() )->is_wpcom_simple(),
104            ),
105            // Intended for apps that do not use redux.
106            'gmt_offset'                     => $this->get_gmt_offset(),
107            // Empty for a site set to a fixed UTC offset; `gmt_offset` alone cannot follow daylight saving.
108            'timezone'                       => (string) get_option( 'timezone_string' ),
109            'odyssey_stats_base_url'         => admin_url( 'admin.php?page=stats' ),
110            // Repeated in the site record below, which a site without a connection never gets.
111            'admin_url'                      => admin_url(),
112            'jetpack_version'                => defined( 'JETPACK__VERSION' ) ? JETPACK__VERSION : '',
113            'stats_admin_version'            => Main::VERSION,
114            'software_version'               => $wp_version,
115        );
116    }
117
118    /**
119     * The Redux state the app boots with.
120     *
121     * @param int $blog_id The WordPress.com blog ID.
122     * @return array
123     */
124    protected function get_initial_state( $blog_id ) {
125        global $wp_version;
126
127        $host         = new Host();
128        $capabilities = $this->get_current_user_capabilities();
129        $can_blaze    = class_exists( 'Automattic\Jetpack\Blaze' ) && Blaze::should_initialize()['can_init'];
130
131        return array(
132            'currentUser' => array(
133                'id'           => 1000,
134                'user'         => array(
135                    'ID'       => 1000,
136                    'username' => 'no-user',
137                ),
138                'capabilities' => array(
139                    "$blog_id" => $capabilities,
140                ),
141            ),
142            'sites'       => array(
143                'items'    => array(
144                    "$blog_id" => array(
145                        'ID'           => $blog_id,
146                        'URL'          => site_url(),
147                        // Atomic and jetpack sites should return true.
148                        'jetpack'      => ! $host->is_wpcom_simple(),
149                        'visible'      => true,
150                        'capabilities' => $capabilities,
151                        'products'     => Jetpack_Plan::get_products(),
152                        'plan'         => $this->get_plan(),
153                        'options'      => array(
154                            'wordads'               => ( new Modules() )->is_active( 'wordads' ),
155                            'admin_url'             => admin_url(),
156                            'gmt_offset'            => $this->get_gmt_offset(),
157                            'is_automated_transfer' => $this->is_automated_transfer( $blog_id ),
158                            'is_wpcom_atomic'       => $host->is_woa_site(),
159                            'is_wpcom_simple'       => $host->is_wpcom_simple(),
160                            'is_vip'                => $host->is_vip_site(),
161                            'jetpack_version'       => defined( 'JETPACK__VERSION' ) ? JETPACK__VERSION : '',
162                            'stats_admin_version'   => Main::VERSION,
163                            'software_version'      => $wp_version,
164                            'can_blaze'             => $can_blaze,
165                            'has_stats_settings'    => ! $host->is_wpcom_simple(),
166                        ),
167                    ),
168                ),
169                'features' => array( "$blog_id" => array( 'data' => $this->get_plan_features() ) ),
170            ),
171        );
172    }
173
174    /**
175     * Defines a filter to set whether a site is an automated_transfer site or not.
176     *
177     * Default is false. On Atomic, this is set to true by `wpcomsh`.
178     *
179     * @param int $blog_id Blog ID.
180     *
181     * @return bool
182     */
183    public function is_automated_transfer( $blog_id ) {
184        /**
185         * Filter if a site is an automated-transfer site.
186         *
187         * @module json-api
188         *
189         * @since 6.4.0
190         *
191         * @param bool is_automated_transfer( $this->blog_id )
192         * @param int  $blog_id Blog identifier.
193         */
194        return apply_filters(
195            'jetpack_site_automated_transfer',
196            false,
197            $blog_id
198        );
199    }
200
201    /**
202     * Get the current site GMT Offset.
203     *
204     * @return float The current site GMT Offset by hours.
205     */
206    protected function get_gmt_offset() {
207        return (float) get_option( 'gmt_offset' );
208    }
209
210    /**
211     * Page base for the Calypso admin page.
212     */
213    protected function get_admin_path() {
214        if ( ! isset( $_SERVER['PHP_SELF'] ) || ! isset( $_SERVER['QUERY_STRING'] ) ) {
215            $parsed = wp_parse_url( admin_url( 'admin.php?page=stats' ) );
216            return $parsed['path'] . '?' . $parsed['query'];
217        }
218        // We do this because page.js requires the exactly page base to be set otherwise it will not work properly.
219        // phpcs:ignore WordPress.Security.ValidatedSanitizedInput.InputNotSanitized
220        return wp_unslash( $_SERVER['PHP_SELF'] ) . '?' . wp_unslash( $_SERVER['QUERY_STRING'] );
221    }
222
223    /**
224     * Get locale acceptable by Calypso.
225     */
226    protected function get_user_locale() {
227        /**
228         * In WP, locales are formatted as LANGUAGE_REGION, for example `en`, `en_US`, `es_AR`,
229         * but Calypso expects language-region, e.g. `en-us`, `en`,  `es-ar`. So we need to convert
230         * them to lower case and replace the underscore with a dash.
231         */
232        $locale = strtolower( get_user_locale() );
233        $locale = str_replace( '_', '-', $locale );
234
235        return $locale;
236    }
237
238    /**
239     * Get the features of the current plan.
240     *
241     * The app cannot refresh what it paywalls on, so a WordPress.com-hosted site is asked
242     * directly; a plan cached before an upgrade gates a feature the site has already paid for.
243     */
244    protected function get_plan_features() {
245        // method_exists guard: an older plans package may win the autoloader on another plugin.
246        if ( method_exists( Jetpack_Plan::class, 'get_wpcom_site_specific_features' ) ) {
247            $features = Jetpack_Plan::get_wpcom_site_specific_features();
248            if ( null !== $features ) {
249                return $features;
250            }
251        }
252
253        $plan = Jetpack_Plan::get();
254        if ( empty( $plan['features'] ) ) {
255            return array();
256        }
257        return $plan['features'];
258    }
259
260    /**
261     * Get the current plan.
262     *
263     * @return array
264     */
265    protected function get_plan() {
266        $plan = Jetpack_Plan::get();
267        unset( $plan['features'] );
268        unset( $plan['supports'] );
269        return $plan;
270    }
271
272    /**
273     * Get the capabilities of the current user.
274     *
275     * @return array An array of capabilities.
276     */
277    protected function get_current_user_capabilities() {
278        return array(
279            'edit_pages'          => current_user_can( 'edit_pages' ),
280            'edit_posts'          => current_user_can( 'edit_posts' ),
281            'edit_others_posts'   => current_user_can( 'edit_others_posts' ),
282            'edit_others_pages'   => current_user_can( 'edit_others_pages' ),
283            'delete_posts'        => current_user_can( 'delete_posts' ),
284            'delete_others_posts' => current_user_can( 'delete_others_posts' ),
285            'edit_theme_options'  => current_user_can( 'edit_theme_options' ),
286            'edit_users'          => current_user_can( 'edit_users' ),
287            'list_users'          => current_user_can( 'list_users' ),
288            'manage_categories'   => current_user_can( 'manage_categories' ),
289            'manage_options'      => current_user_can( 'manage_options' ),
290            'moderate_comments'   => current_user_can( 'moderate_comments' ),
291            'activate_wordads'    => current_user_can( 'manage_options' ),
292            'promote_users'       => current_user_can( 'promote_users' ),
293            'publish_posts'       => current_user_can( 'publish_posts' ),
294            'upload_files'        => current_user_can( 'upload_files' ),
295            'delete_users'        => current_user_can( 'delete_users' ),
296            'remove_users'        => current_user_can( 'remove_users' ),
297            'own_site'            => current_user_can( 'manage_options' ), // Administrators are considered owners on site.
298            'view_stats'          => current_user_can( 'view_stats' ),
299            'activate_plugins'    => current_user_can( 'activate_plugins' ),
300        );
301    }
302}