<?php
/**
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; under version 2
 * of the License (non-upgradable).
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 *
 * Copyright (c) 2015-2019 (original work) Open Assessment Technologies SA;
 */

/**
 * Default client diagnostic config
 */
return array(
    'diagnostic' => array(

        /**
         * Diagnostic will be run on the page load
         */
        'autoStart' => false,

        /**
         * The results of all diagnostic runs will be saved
         * (learners and students will see only their runs, teachers and administrators will see all possible runs)
         */
        'storeAllRuns' => false,

        /**
         * A custom name to be displayed as the page title
         * @type string
         */
        'pageTitle' => null,

        /**
         * Custom text for diagnostic header
         * @type string
         */
        'header' => 'This tool will run a number of tests in order to establish how well your current environment is suitable to run the TAO platform.',

        /**
         * Custom footer copyright notice
         * @type string
         */
        'footer' => '',

        /**
         * List of additional custom messages (see testers configs below)
         * @type array
         */
        'configurableText' => null,

        /**
         * When this option is activated, the diagnostic will allow exporting results to a CSV file
         * @type boolean
         */
        'export' => false,

        /**
         * When this option is activated, the diagnostic will require a school name before allowing to start the checks
         * @type boolean
         */
        'requireSchoolName' => false,

        /**
         * When this option is activated, the diagnostic will require a school id before allowing to start the checks
         * @type boolean
         */
        'requireSchoolId' => false,

        /**
         * When this option is activated, in link with `requireSchoolName`, the diagnostic will require a school number and
         * a 4 digits PIN. Then will retrieve the school name within a list.
         * @type boolean
         */
        'validateSchoolName' => false,

        /**
         * An array describing how GET parameters in use when invoking the Diagnostic Tool should be transferred
         * to the server side for storage. Keys describe the GET parameter names, and values describe the name of the
         * data to be sent to the server side.
         * @type array
         */
        'customInput' => [],

        /**
         * List of testers that can be loaded
         * @type array
         */
        'testers' => [
            /**
             * Performances check config
             * @type array
             */
            'performance' => array(
                /**
                 * Allows to disable the test on the platform
                 * @type boolean
                 */
                'enabled' => true,

                /**
                 * Defines the test level. In case of multiple tests of the same kind, this config allows to compare intensities.
                 * @type boolean
                 */
                'level' => 1,

                /**
                 * Path to the component that will test the performances
                 * @type string
                 */
                'tester' => 'taoClientDiagnostic/tools/performances/tester',

                /**
                 * The key used to get an additional custom message for the result
                 * @type string
                 */
                'customMsgKey' => 'diagPerformancesCheckResult',

                /**
                 * A list of samples to render in order to compute the rendering performances
                 * @type array
                 */
                'samples' => array(
                    'taoClientDiagnostic/tools/performances/data/sample1/',
                    'taoClientDiagnostic/tools/performances/data/sample2/',
                    'taoClientDiagnostic/tools/performances/data/sample3/'
                ),

                /**
                 * The number of renderings by samples
                 * @type int
                 */
                'occurrences' => 10,

                /**
                 * Max allowed duration for a sample rendering
                 * @type int
                 */
                'timeout' => 30,

                /**
                 * The threshold for optimal performances
                 * @type float
                 */
                'optimal' => 0.025,

                /**
                 * The threshold for minimal performances
                 * @type float
                 */
                'threshold' => 0.25,
            ),

            /**
             * Bandwidth check config
             * @type array
             */
            'bandwidth' => array(
                /**
                 * Allows to disable the test on the platform
                 * @type boolean
                 */
                'enabled' => true,

                /**
                 * Defines the test level. In case of multiple tests of the same kind, this config allows to compare intensities.
                 * @type boolean
                 */
                'level' => 1,

                /**
                 * Path to the component that will test the bandwidth
                 * @type string
                 */
                'tester' => 'taoClientDiagnostic/tools/bandwidth/tester',

                /**
                 * The key used to get an additional custom message for the result
                 * @type string
                 */
                'customMsgKey' => 'diagBandwithCheckResult',

                /**
                 * The typical bandwidth needed for a test taker (Mbps)
                 * @type float
                 */
                'unit' => 0.16,

                /**
                 * The ideal number of simultaneous test takers
                 * @type int
                 */
                'ideal' => 45,

                /**
                 * Maximum number of test takers to display on a bar
                 * @type int
                 */
                'max' => 100,

                /**
                 * Lowest value that will be used in the global score computation.
                 * This can be used to decrease the importance of the present test in the global score.
                 * For example, we can use this to make sure the global score never goes into error mode for a bandwidth issue.
                 * @type boolean|int
                 */
                'minimumGlobalPercentage' => false,

                /**
                 * Allow override of the defaults thresholds used to provide feedback
                 * @type array
                 * @example
                 * 'feedbackThresholds' => [
                        [
                            'threshold' => 0,
                            'message' => 'This will be displayed as a warning message if percentage < 66',
                            'type' => 'warning'
                        ], [
                            'threshold' => 66,
                            'message' => 'This will be displayed as a success message if percentage > 66',
                            'type' => 'success'
                        ]
                    ]
                 */
                'feedbackThresholds' => [],

                /**
                 * The ratio of the minimum and average connection speed at which the connection will be considered unstable.
                 * Calculated only for queries of the same size.
                 * Calculation formula:
                 * minimum / average < 0.2
                 * @type float
                 */
                'fallbackThreshold' => 0.2,
            ),

            /**
             * Bandwidth check config
             * @type array
             */
            'intensive_bandwidth' => array(
                /**
                 * Allows to disable the test on the platform
                 * @type boolean
                 */
                'enabled' => false,

                /**
                 * Defines the test level. In case of multiple tests of the same kind, this config allows to compare intensities.
                 * @type boolean
                 */
                'level' => 2,

                /**
                 * Path to the component that will test the bandwidth
                 * @type string
                 */
                'tester' => 'taoClientDiagnostic/tools/bandwidth/tester',

                /**
                 * The key used to get an additional custom message for the result
                 * @type string
                 */
                'customMsgKey' => 'diagBandwithCheckResult',

                /**
                 * The typical bandwidth needed for a test taker (Mbps)
                 * @type float
                 */
                'unit' => 1.2,

                /**
                 * The ideal number of simultaneous test takers
                 * @type int
                 */
                'ideal' => 45,

                /**
                 * Maximum number of test takers to display on a bar
                 * @type int
                 */
                'max' => 100,

                /**
                 * The ratio of the minimum and average connection speed at which the connection will be considered unstable.
                 * Calculated only for queries of the same size.
                 * Calculation formula:
                 * minimum / average < 0.2
                 * @type float
                 */
                'fallbackThreshold' => 0.2,
            ),

            /**
             * Upload speed test config
             * @type array
             */
            'upload' => array(
                /**
                 * Allows to disable the test on the platform
                 * @type boolean
                 */
                'enabled' => true,

                /**
                 * Defines the test level. In case of multiple tests of the same kind, this config allows to compare intensities.
                 * @type boolean
                 */
                'level' => 1,

                /**
                 * Path to the component that will test the upload speed
                 * @type string
                 */
                'tester' => 'taoClientDiagnostic/tools/upload/tester',

                /**
                 * The key used to get an additional custom message for the result
                 * @type string
                 */
                'customMsgKey' => 'diagUploadCheckResult',

                /**
                 * Size of data to sent to server during speed test in bytes
                 */
                'size' => 1 * 1024 * 1024,

                /**
                 * Optimal speed in bytes per second
                 */
                'optimal' => 1 * 1024 * 1024,
            ),

            /**
             * Browser compatibility check config
             * @type array
             */
            'browser' => [
                /**
                 * Allows to disable the test on the platform
                 * @type boolean
                 */
                'enabled' => true,

                /**
                 * Defines the test level. In case of multiple tests of the same kind, this config allows to compare intensities.
                 * @type boolean
                 */
                'level' => 1,

                /**
                 * Path to the component that will test the browser compatibility
                 * @type string
                 */
                'tester' => 'taoClientDiagnostic/tools/browser/tester',

                /**
                 * The key used to get an additional custom message for the result
                 * @type string
                 */
                'customMsgKey' => 'diagBrowserOsCheckResult',

                /**
                 * The API to call for the detailed list of default supported browsers
                 * @type string
                 */
                'browserslistUrl' => 'https://oat-sa.github.io/browserslist-app-tao/api.json',
            ],

            /**
             * Browser fingerprint config
             * @type array
             */
            'fingerprint' => [
                /**
                 * Allows to disable the test on the platform
                 * @type boolean
                 */
                'enabled' => false,

                /**
                 * Defines the test level. In case of multiple tests of the same kind, this config allows to compare intensities.
                 * @type boolean
                 */
                'level' => 1,

                /**
                 * Path to the component that will perform the fingerprint
                 * @type string
                 */
                'tester' => 'taoClientDiagnostic/tools/fingerprint/tester',

                /**
                 * The key used to get an additional custom message for the result
                 * @type string
                 */
                'customMsgKey' => 'diagFingerprintCheckResult',
            ],

            /**
             * Screen resolution check config
             * @type array
             */
            'screen' => [
                /**
                 * Allows to disable the test on the platform
                 * @type boolean
                 */
                'enabled' => false,

                /**
                 * Defines the test level. In case of multiple tests of the same kind, this config allows to compare intensities.
                 * @type boolean
                 */
                'level' => 1,

                /**
                 * Path to the component that will test the screen resolution
                 * @type string
                 */
                'tester' => 'taoClientDiagnostic/tools/screen/tester',

                /**
                 * The key used to get an additional custom message for the result
                 * @type string
                 */
                'customMsgKey' => 'diagScreenCheckResult',

                /**
                 * The threshold for minimal screen resolution
                 * @type array
                 */
                'threshold' => [
                    'width' => 1024,
                    'height' => 768
                ],
            ],
        ]
    )
);