eventespresso / event-espresso-core

core/db_classes/EE_CSV.class.php

Indentation +660 added lines, -660 removed lines

@@ -13,664 +13,664 @@
  */
 class EE_CSV
 {
-    // instance of the EE_CSV object
-    private static $_instance = null;
-
-
-    // multidimensional array to store update & error messages
-    // var $_notices = array( 'updates' => array(), 'errors' => array() );
-
-
-    private $_primary_keys;
-
-    /**
-     * @var EE_Registry
-     */
-    private $EE;
-    /**
-     * string used for 1st cell in exports, which indicates that the following 2 rows will be metadata keys and values
-     */
-    const metadata_header = 'Event Espresso Export Meta Data';
-
-    /**
-     * private constructor to prevent direct creation
-     *
-     * @return void
-     */
-    private function __construct()
-    {
-        global $wpdb;
-
-        $this->_primary_keys = array(
-            $wpdb->prefix . 'esp_answer'                  => array('ANS_ID'),
-            $wpdb->prefix . 'esp_attendee'                => array('ATT_ID'),
-            $wpdb->prefix . 'esp_datetime'                => array('DTT_ID'),
-            $wpdb->prefix . 'esp_event_question_group'    => array('EQG_ID'),
-            $wpdb->prefix . 'esp_message_template'        => array('MTP_ID'),
-            $wpdb->prefix . 'esp_payment'                 => array('PAY_ID'),
-            $wpdb->prefix . 'esp_price'                   => array('PRC_ID'),
-            $wpdb->prefix . 'esp_price_type'              => array('PRT_ID'),
-            $wpdb->prefix . 'esp_question'                => array('QST_ID'),
-            $wpdb->prefix . 'esp_question_group'          => array('QSG_ID'),
-            $wpdb->prefix . 'esp_question_group_question' => array('QGQ_ID'),
-            $wpdb->prefix . 'esp_question_option'         => array('QSO_ID'),
-            $wpdb->prefix . 'esp_registration'            => array('REG_ID'),
-            $wpdb->prefix . 'esp_status'                  => array('STS_ID'),
-            $wpdb->prefix . 'esp_transaction'             => array('TXN_ID'),
-            $wpdb->prefix . 'esp_transaction'             => array('TXN_ID'),
-            $wpdb->prefix . 'events_detail'               => array('id'),
-            $wpdb->prefix . 'events_category_detail'      => array('id'),
-            $wpdb->prefix . 'events_category_rel'         => array('id'),
-            $wpdb->prefix . 'events_venue'                => array('id'),
-            $wpdb->prefix . 'events_venue_rel'            => array('emeta_id'),
-            $wpdb->prefix . 'events_locale'               => array('id'),
-            $wpdb->prefix . 'events_locale_rel'           => array('id'),
-            $wpdb->prefix . 'events_personnel'            => array('id'),
-            $wpdb->prefix . 'events_personnel_rel'        => array('id'),
-        );
-    }
-
-
-    /**
-     * singleton method used to instantiate class object
-     *
-     * @return EE_CSV
-     */
-    public static function instance()
-    {
-        // check if class object is instantiated
-        if (self::$_instance === null or ! is_object(self::$_instance) or ! (self::$_instance instanceof EE_CSV)) {
-            self::$_instance = new self();
-        }
-        return self::$_instance;
-    }
-
-    /**
-     * Opens a unicode or utf file (normal file_get_contents has difficulty reading ga unicode file)
-     * @see http://stackoverflow.com/questions/15092764/how-to-read-unicode-text-file-in-php
-     *
-     * @param string $file_path
-     * @return string
-     * @throws EE_Error
-     */
-    private function read_unicode_file($file_path)
-    {
-        $fc = "";
-        $fh = fopen($file_path, "rb");
-        if (! $fh) {
-            throw new EE_Error(sprintf(esc_html__("Cannot open file for read: %s<br>\n", 'event_espresso'), $file_path));
-        }
-        $flen = filesize($file_path);
-        $bc = fread($fh, $flen);
-        for ($i = 0; $i < $flen; $i++) {
-            $c = substr($bc, $i, 1);
-            if ((ord($c) != 0) && (ord($c) != 13)) {
-                $fc = $fc . $c;
-            }
-        }
-        if ((ord(substr($fc, 0, 1)) == 255) && (ord(substr($fc, 1, 1)) == 254)) {
-            $fc = substr($fc, 2);
-        }
-        return ($fc);
-    }
-
-
-    /**
-     * Generic CSV-functionality to turn an entire CSV file into a single array that's
-     * NOT in a specific format to EE. It's just a 2-level array, with top-level arrays
-     * representing each row in the CSV file, and the second-level arrays being each column in that row
-     *
-     * @param string $path_to_file
-     * @return array of arrays. Top-level array has rows, second-level array has each item
-     */
-    public function import_csv_to_multi_dimensional_array($path_to_file)
-    {
-        // needed to deal with Mac line endings
-        ini_set('auto_detect_line_endings', true);
-
-        // because fgetcsv does not correctly deal with backslashed quotes such as \"
-        // we'll read the file into a string
-        $file_contents = $this->read_unicode_file($path_to_file);
-        // replace backslashed quotes with CSV enclosures
-        $file_contents = str_replace('\\"', '"""', $file_contents);
-        // HEY YOU! PUT THAT FILE BACK!!!
-        file_put_contents($path_to_file, $file_contents);
-
-        if (($file_handle = fopen($path_to_file, "r")) !== false) {
-            # Set the parent multidimensional array key to 0.
-            $nn = 0;
-            $csvarray = array();
-
-            // in PHP 5.3 fgetcsv accepts a 5th parameter, but the pre 5.3 versions of fgetcsv choke if passed more than 4 - is that crazy or what?
-            if (version_compare(PHP_VERSION, '5.3.0') < 0) {
-                //  PHP 5.2- version
-                // loop through each row of the file
-                while (($data = fgetcsv($file_handle, 0, ',', '"')) !== false) {
-                    $csvarray[] = $data;
-                }
-            } else {
-                // loop through each row of the file
-                while (($data = fgetcsv($file_handle, 0, ',', '"', '\\')) !== false) {
-                    $csvarray[] = $data;
-                }
-            }
-            # Close the File.
-            fclose($file_handle);
-            return $csvarray;
-        } else {
-            EE_Error::add_error(
-                sprintf(esc_html__("An error occurred - the file: %s could not opened.", "event_espresso"), $path_to_file),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return false;
-        }
-    }
-
-
-    /**
-     * Import contents of csv file and store values in an array to be manipulated by other functions
-     * @param string  $path_to_file         - the csv file to be imported including the path to it's location.
-     *                                      If $model_name is provided, assumes that each row in the CSV represents a
-     *                                      model object for that model If $model_name ISN'T provided, assumes that
-     *                                      before model object data, there is a row where the first entry is simply
-     *                                      'MODEL', and next entry is the model's name, (untranslated) like Event, and
-     *                                      then maybe a row of headers, and then the model data. Eg.
-     *                                      '<br>MODEL,Event,<br>EVT_ID,EVT_name,...<br>1,Monkey
-     *                                      Party,...<br>2,Llamarama,...<br>MODEL,Venue,<br>VNU_ID,VNU_name<br>1,The
-     *                                      Forest
-     * @param string  $model_name           model name if we know what model we're importing
-     * @param boolean $first_row_is_headers - whether the first row of data is headers or not - TRUE = headers, FALSE =
-     *                                      data
-     * @return mixed - array on success - multi dimensional with headers as keys (if headers exist) OR string on fail -
-     *               error message like the following array('Event'=>array( array('EVT_ID'=>1,'EVT_name'=>'bob
-     *               party',...), array('EVT_ID'=>2,'EVT_name'=>'llamarama',...),
-     *                                      ...
-     *                                      )
-     *                                      'Venue'=>array(
-     *                                      array('VNU_ID'=>1,'VNU_name'=>'the shack',...),
-     *                                      array('VNU_ID'=>2,'VNU_name'=>'tree house',...),
-     *                                      ...
-     *                                      )
-     *                                      ...
-     *                                      )
-     */
-    public function import_csv_to_model_data_array($path_to_file, $model_name = false, $first_row_is_headers = true)
-    {
-        $multi_dimensional_array = $this->import_csv_to_multi_dimensional_array($path_to_file);
-        if (! $multi_dimensional_array) {
-            return false;
-        }
-        // gotta start somewhere
-        $row = 1;
-        // array to store csv data in
-        $ee_formatted_data = array();
-        // array to store headers (column names)
-        $headers = array();
-        foreach ($multi_dimensional_array as $data) {
-            // if first cell is MODEL, then second cell is the MODEL name
-            if ($data[0] == 'MODEL') {
-                $model_name = $data[1];
-                // don't bother looking for model data in this row. The rest of this
-                // row should be blank
-                // AND pretend this is the first row again
-                $row = 1;
-                // reset headers
-                $headers = array();
-                continue;
-            }
-            if (strpos($data[0], EE_CSV::metadata_header) !== false) {
-                $model_name = EE_CSV::metadata_header;
-                // store like model data, we just won't try importing it etc.
-                $row = 1;
-                continue;
-            }
-
-
-            // how many columns are there?
-            $columns = count($data);
-
-            $model_entry = array();
-            // loop through each column
-            for ($i = 0; $i < $columns; $i++) {
-                // replace csv_enclosures with backslashed quotes
-                $data[ $i ] = str_replace('"""', '\\"', $data[ $i ]);
-                // do we need to grab the column names?
-                if ($row === 1) {
-                    if ($first_row_is_headers) {
-                        // store the column names to use for keys
-                        $column_name = $data[ $i ];
-                        // check it's not blank... sometimes CSV editign programs adda bunch of empty columns onto the end...
-                        if (! $column_name) {
-                            continue;
-                        }
-                        $matches = array();
-                        if ($model_name == EE_CSV::metadata_header) {
-                            $headers[ $i ] = $column_name;
-                        } else {
-                            // now get the db table name from it (the part between square brackets)
-                            $success = preg_match('~(.*)\[(.*)\]~', $column_name, $matches);
-                            if (! $success) {
-                                EE_Error::add_error(
-                                    sprintf(
-                                        esc_html__(
-                                            "The column titled %s is invalid for importing. It must be be in the format of 'Nice Name[model_field_name]' in row %s",
-                                            "event_espresso"
-                                        ),
-                                        $column_name,
-                                        implode(",", $data)
-                                    ),
-                                    __FILE__,
-                                    __FUNCTION__,
-                                    __LINE__
-                                );
-                                return false;
-                            }
-                            $headers[ $i ] = $matches[2];
-                        }
-                    } else {
-                        // no column names means our final array will just use counters for keys
-                        $model_entry[ $headers[ $i ] ] = $data[ $i ];
-                        $headers[ $i ] = $i;
-                    }
-                    // and we need to store csv data
-                } else {
-                    // this column isn' ta header, store it if there is a header for it
-                    if (isset($headers[ $i ])) {
-                        $model_entry[ $headers[ $i ] ] = $data[ $i ];
-                    }
-                }
-            }
-            // save the row's data IF it's a non-header-row
-            if (! $first_row_is_headers || ($first_row_is_headers && $row > 1)) {
-                $ee_formatted_data[ $model_name ][] = $model_entry;
-            }
-            // advance to next row
-            $row++;
-        }
-
-        // delete the uploaded file
-        unlink($path_to_file);
-        // echo '<pre style="height:auto;border:2px solid lightblue;">' . print_r( $ee_formatted_data, TRUE ) . '</pre><br /><span style="font-size:10px;font-weight:normal;">' . __FILE__ . '<br />line no: ' . __LINE__ . '</span>';
-        // die();
-
-        // it's good to give back
-        return $ee_formatted_data;
-    }
-
-
-    public function save_csv_to_db($csv_data_array, $model_name = false)
-    {
-        EE_Error::doing_it_wrong(
-            'save_csv_to_db',
-            esc_html__(
-                'Function moved to EE_Import and renamed to save_csv_data_array_to_db',
-                'event_espresso'
-            ),
-            '4.6.7'
-        );
-        return EE_Import::instance()->save_csv_data_array_to_db($csv_data_array, $model_name);
-    }
-
-    /**
-     * Sends HTTP headers to indicate that the browser should download a file,
-     * and starts writing the file to PHP's output. Returns the file handle so other functions can
-     * also write to it
-     *
-     * @param string $new_filename the name of the file that the user will download
-     * @return resource, like the results of fopen(), which can be used for fwrite, fputcsv2, etc.
-     */
-    public function begin_sending_csv($filename)
-    {
-        // grab file extension
-        $ext = substr(strrchr($filename, '.'), 1);
-        if ($ext == '.csv' or $ext == '.xls') {
-            str_replace($ext, '', $filename);
-        }
-        $filename .= '.csv';
-
-        // if somebody's been naughty and already started outputting stuff, trash it
-        // and start writing our stuff.
-        if (ob_get_length()) {
-            @ob_flush();
-            @flush();
-            @ob_end_flush();
-        }
-        @ob_start();
-        header("Pragma: public");
-        header("Expires: 0");
-        header("Pragma: no-cache");
-        header("Cache-Control: no-store, no-cache, must-revalidate, post-check=0, pre-check=0");
-        // header("Content-Type: application/force-download");
-        // header("Content-Type: application/octet-stream");
-        // header("Content-Type: application/download");
-        header('Content-disposition: attachment; filename=' . $filename);
-        header("Content-Type: text/csv; charset=utf-8");
-        do_action('AHEE__EE_CSV__begin_sending_csv__headers');
-        echo apply_filters(
-            'FHEE__EE_CSV__begin_sending_csv__start_writing',
-            "\xEF\xBB\xBF"
-        ); // makes excel open it as UTF-8. UTF-8 BOM, see http://stackoverflow.com/a/4440143/2773835
-        $fh = fopen('php://output', 'w');
-        return $fh;
-    }
-
-    /**
-     * Writes some meta data to the CSV as a bunch of columns. Initially we're only
-     * mentioning the version and timezone
-     *
-     * @param resource $filehandle
-     */
-    public function write_metadata_to_csv($filehandle)
-    {
-        $data_row = array(EE_CSV::metadata_header);// do NOT translate because this exact string is used when importing
-        $this->fputcsv2($filehandle, $data_row);
-        $meta_data = array(
-            0 => array(
-                'version'        => espresso_version(),
-                'timezone'       => EEH_DTT_Helper::get_timezone(),
-                'time_of_export' => current_time('mysql'),
-                'site_url'       => is_ssl() ? str_replace('http://', 'https://', site_url()) : site_url(),
-            ),
-        );
-        $this->write_data_array_to_csv($filehandle, $meta_data);
-    }
-
-
-    /**
-     * Writes $data to the csv file open in $filehandle. uses the array indices of $data for column headers
-     *
-     * @param array   $data                 2D array, first numerically-indexed, and next-level-down preferably indexed
-     *                                      by string
-     * @param boolean $add_csv_column_names whether or not we should add the keys in the bottom-most array as a row for
-     *                                      headers in the CSV. Eg, if $data looked like
-     *                                      array(0=>array('EVT_ID'=>1,'EVT_name'=>'monkey'...), 1=>array(...),...))
-     *                                      then the first row we'd write to the CSV would be "EVT_ID,EVT_name,..."
-     * @return boolean if we successfully wrote to the CSV or not. If there's no $data, we consider that a success
-     *                 (because we wrote everything there was...nothing)
-     */
-    public function write_data_array_to_csv($filehandle, $data)
-    {
-
-
-        // determine if $data is actually a 2d array
-        if ($data && is_array($data) && is_array(EEH_Array::get_one_item_from_array($data))) {
-            // make sure top level is numerically indexed,
-
-            if (EEH_Array::is_associative_array($data)) {
-                throw new EE_Error(
-                    sprintf(
-                        esc_html__(
-                            "top-level array must be numerically indexed. Does these look like numbers to you? %s",
-                            "event_espresso"
-                        ),
-                        implode(",", array_keys($data))
-                    )
-                );
-            }
-            $item_in_top_level_array = EEH_Array::get_one_item_from_array($data);
-            // now, is the last item in the top-level array of $data an associative or numeric array?
-            if (EEH_Array::is_associative_array($item_in_top_level_array)) {
-                // its associative, so we want to output its keys as column headers
-                $keys = array_keys($item_in_top_level_array);
-                $this->fputcsv2($filehandle, $keys);
-            }
-            // start writing data
-            foreach ($data as $data_row) {
-                $this->fputcsv2($filehandle, $data_row);
-            }
-            return true;
-        } else {
-            // no data TO write... so we can assume that's a success
-            return true;
-        }
-        // //if 2nd level is indexed by strings, use those as csv column headers (ie, the first row)
-        //
-        //
-        // $no_table = TRUE;
-        //
-        // // loop through data and add each row to the file/stream as csv
-        // foreach ( $data as $model_name => $model_data ) {
-        // // test first row to see if it is data or a model name
-        // $model = EE_Registry::instance();->load_model($model_name);
-        // //if the model really exists,
-        // if ( $model ) {
-        //
-        // // we have a table name
-        // $no_table = FALSE;
-        //
-        // // put the tablename into an array cuz that's how fputcsv rolls
-        // $model_name_row = array( 'MODEL', $model_name );
-        //
-        // // add table name to csv output
-        // echo self::fputcsv2($filehandle, $model_name_row);
-        //
-        // // now get the rest of the data
-        // foreach ( $model_data as $row ) {
-        // // output the row
-        // echo self::fputcsv2($filehandle, $row);
-        // }
-        //
-        // }
-        //
-        // if ( $no_table ) {
-        // // no table so just put the data
-        // echo self::fputcsv2($filehandle, $model_data);
-        // }
-        //
-        // } // END OF foreach ( $data )
-    }
-
-    /**
-     * Should be called after begin_sending_csv(), and one or more write_data_array_to_csv()s.
-     * Calls exit to prevent polluting the CSV file with other junk
-     *
-     * @param resource $fh filehandle where we're writing the CSV to
-     */
-    public function end_sending_csv($fh)
-    {
-        fclose($fh);
-        exit(0);
-    }
-
-    /**
-     * Given an open file, writes all the model data to it in the format the importer expects.
-     * Usually preceded by begin_sending_csv($filename), and followed by end_sending_csv($filehandle).
-     *
-     * @param resource $filehandle
-     * @param array    $model_data_array is assumed to be a 3d array: 1st layer has keys of model names (eg 'Event'),
-     *                                   next layer is numerically indexed to represent each model object (eg, each
-     *                                   individual event), and the last layer has all the attributes o fthat model
-     *                                   object (eg, the event's id, name, etc)
-     * @return boolean success
-     */
-    public function write_model_data_to_csv($filehandle, $model_data_array)
-    {
-        $this->write_metadata_to_csv($filehandle);
-        foreach ($model_data_array as $model_name => $model_instance_arrays) {
-            // first: output a special row stating the model
-            $this->fputcsv2($filehandle, array('MODEL', $model_name));
-            // if we have items to put in the CSV, do it normally
-
-            if (! empty($model_instance_arrays)) {
-                $this->write_data_array_to_csv($filehandle, $model_instance_arrays);
-            } else {
-                // echo "no data to write... so just write the headers";
-                // so there's actually NO model objects for that model.
-                // probably still want to show the columns
-                $model = EE_Registry::instance()->load_model($model_name);
-                $column_names = array();
-                foreach ($model->field_settings() as $field) {
-                    $column_names[ $field->get_nicename() . "[" . $field->get_name() . "]" ] = null;
-                }
-                $this->write_data_array_to_csv($filehandle, array($column_names));
-            }
-        }
-    }
-
-    /**
-     * Writes the CSV file to the output buffer, with rows corresponding to $model_data_array,
-     * and dies (in order to avoid other plugins from messing up the csv output)
-     *
-     * @param string $filename         the filename you want to give the file
-     * @param array  $model_data_array 3d array, as described in EE_CSV::write_model_data_to_csv()
-     * @return bool | void writes CSV file to output and dies
-     */
-    public function export_multiple_model_data_to_csv($filename, $model_data_array)
-    {
-        $filehandle = $this->begin_sending_csv($filename);
-        $this->write_model_data_to_csv($filehandle, $model_data_array);
-        $this->end_sending_csv($filehandle);
-    }
-
-    /**
-     * Export contents of an array to csv file
-     * @param array  $data     - the array of data to be converted to csv and exported
-     * @param string $filename - name for newly created csv file
-     * @return TRUE on success, FALSE on fail
-     */
-    public function export_array_to_csv($data = false, $filename = false)
-    {
-
-        // no data file?? get outta here
-        if (! $data or ! is_array($data) or empty($data)) {
-            return false;
-        }
-
-        // no filename?? get outta here
-        if (! $filename) {
-            return false;
-        }
-
-
-        // somebody told me i might need this ???
-        global $wpdb;
-        $prefix = $wpdb->prefix;
-
-
-        $fh = $this->begin_sending_csv($filename);
-
-
-        $this->end_sending_csv($fh);
-    }
-
-
-    /**
-     * Determine the maximum upload file size based on php.ini settings
-     * @param int $percent_of_max - desired percentage of the max upload_mb
-     * @return int KB
-     */
-    public function get_max_upload_size($percent_of_max = false)
-    {
-
-        $max_upload = (int) (ini_get('upload_max_filesize'));
-        $max_post = (int) (ini_get('post_max_size'));
-        $memory_limit = (int) (ini_get('memory_limit'));
-
-        // determine the smallest of the three values from above
-        $upload_mb = min($max_upload, $max_post, $memory_limit);
-
-        // convert MB to KB
-        $upload_mb = $upload_mb * 1024;
-
-        // don't want the full monty? then reduce the max uplaod size
-        if ($percent_of_max) {
-            // is percent_of_max like this -> 50 or like this -> 0.50 ?
-            if ($percent_of_max > 1) {
-                // chnages 50 to 0.50
-                $percent_of_max = $percent_of_max / 100;
-            }
-            // make upload_mb a percentage of the max upload_mb
-            $upload_mb = $upload_mb * $percent_of_max;
-        }
-
-        return $upload_mb;
-    }
-
-
-    /**
-     * Drop   in replacement for PHP's fputcsv function - but this one works!!!
-     * @param resource $fh         - file handle - what we are writing to
-     * @param array    $row        - individual row of csv data
-     * @param string   $delimiter  - csv delimiter
-     * @param string   $enclosure  - csv enclosure
-     * @param string   $mysql_null - allows php NULL to be overridden with MySQl's insertable NULL value
-     * @return void
-     */
-    private function fputcsv2($fh, array $row, $delimiter = ',', $enclosure = '"', $mysql_null = false)
-    {
-        // Allow user to filter the csv delimiter and enclosure for other countries csv standards
-        $delimiter = apply_filters('FHEE__EE_CSV__fputcsv2__delimiter', $delimiter);
-        $enclosure = apply_filters('FHEE__EE_CSV__fputcsv2__enclosure', $enclosure);
-
-        $delimiter_esc = preg_quote($delimiter, '/');
-        $enclosure_esc = preg_quote($enclosure, '/');
-
-        $output = array();
-        foreach ($row as $field_value) {
-            if (is_object($field_value) || is_array($field_value)) {
-                $field_value = serialize($field_value);
-            }
-            if ($field_value === null && $mysql_null) {
-                $output[] = 'NULL';
-                continue;
-            }
-
-            $output[] = preg_match("/(?:${delimiter_esc}|${enclosure_esc}|\s)/", $field_value) ?
-                ($enclosure . str_replace($enclosure, $enclosure . $enclosure, $field_value) . $enclosure)
-                : $field_value;
-        }
-
-        fwrite($fh, join($delimiter, $output) . PHP_EOL);
-    }
-
-
-    // /**
-    //  * CSV    Import / Export messages
-    //  * @return void
-    //  */
-    // public function csv_admin_notices()
-    // {
-    //
-    //     // We play both kinds of music here! Country AND Western! - err... I mean, cycle through both types of notices
-    //     foreach (array('updates', 'errors') as $type) {
-    //
-    //         // if particular notice type is not empty, then "You've got Mail"
-    //         if (! empty($this->_notices[ $type ])) {
-    //
-    //             // is it an update or an error ?
-    //             $msg_class = $type == 'updates' ? 'updated' : 'error';
-    //             echo '<div id="message" class="' . $msg_class . '">';
-    //             // display each notice, however many that may be
-    //             foreach ($this->_notices[ $type ] as $message) {
-    //                 echo '<p>' . $message . '</p>';
-    //             }
-    //             // wrap it up
-    //             echo '</div>';
-    //         }
-    //     }
-    // }
-
-    /**
-     * Gets the date format to use in teh csv. filterable
-     *
-     * @param string $current_format
-     * @return string
-     */
-    public function get_date_format_for_csv($current_format = null)
-    {
-        return apply_filters('FHEE__EE_CSV__get_date_format_for_csv__format', 'Y-m-d', $current_format);
-    }
-
-    /**
-     * Gets the time format we want to use in CSV reports. Filterable
-     *
-     * @param string $current_format
-     * @return string
-     */
-    public function get_time_format_for_csv($current_format = null)
-    {
-        return apply_filters('FHEE__EE_CSV__get_time_format_for_csv__format', 'H:i:s', $current_format);
-    }
+	// instance of the EE_CSV object
+	private static $_instance = null;
+
+
+	// multidimensional array to store update & error messages
+	// var $_notices = array( 'updates' => array(), 'errors' => array() );
+
+
+	private $_primary_keys;
+
+	/**
+	 * @var EE_Registry
+	 */
+	private $EE;
+	/**
+	 * string used for 1st cell in exports, which indicates that the following 2 rows will be metadata keys and values
+	 */
+	const metadata_header = 'Event Espresso Export Meta Data';
+
+	/**
+	 * private constructor to prevent direct creation
+	 *
+	 * @return void
+	 */
+	private function __construct()
+	{
+		global $wpdb;
+
+		$this->_primary_keys = array(
+			$wpdb->prefix . 'esp_answer'                  => array('ANS_ID'),
+			$wpdb->prefix . 'esp_attendee'                => array('ATT_ID'),
+			$wpdb->prefix . 'esp_datetime'                => array('DTT_ID'),
+			$wpdb->prefix . 'esp_event_question_group'    => array('EQG_ID'),
+			$wpdb->prefix . 'esp_message_template'        => array('MTP_ID'),
+			$wpdb->prefix . 'esp_payment'                 => array('PAY_ID'),
+			$wpdb->prefix . 'esp_price'                   => array('PRC_ID'),
+			$wpdb->prefix . 'esp_price_type'              => array('PRT_ID'),
+			$wpdb->prefix . 'esp_question'                => array('QST_ID'),
+			$wpdb->prefix . 'esp_question_group'          => array('QSG_ID'),
+			$wpdb->prefix . 'esp_question_group_question' => array('QGQ_ID'),
+			$wpdb->prefix . 'esp_question_option'         => array('QSO_ID'),
+			$wpdb->prefix . 'esp_registration'            => array('REG_ID'),
+			$wpdb->prefix . 'esp_status'                  => array('STS_ID'),
+			$wpdb->prefix . 'esp_transaction'             => array('TXN_ID'),
+			$wpdb->prefix . 'esp_transaction'             => array('TXN_ID'),
+			$wpdb->prefix . 'events_detail'               => array('id'),
+			$wpdb->prefix . 'events_category_detail'      => array('id'),
+			$wpdb->prefix . 'events_category_rel'         => array('id'),
+			$wpdb->prefix . 'events_venue'                => array('id'),
+			$wpdb->prefix . 'events_venue_rel'            => array('emeta_id'),
+			$wpdb->prefix . 'events_locale'               => array('id'),
+			$wpdb->prefix . 'events_locale_rel'           => array('id'),
+			$wpdb->prefix . 'events_personnel'            => array('id'),
+			$wpdb->prefix . 'events_personnel_rel'        => array('id'),
+		);
+	}
+
+
+	/**
+	 * singleton method used to instantiate class object
+	 *
+	 * @return EE_CSV
+	 */
+	public static function instance()
+	{
+		// check if class object is instantiated
+		if (self::$_instance === null or ! is_object(self::$_instance) or ! (self::$_instance instanceof EE_CSV)) {
+			self::$_instance = new self();
+		}
+		return self::$_instance;
+	}
+
+	/**
+	 * Opens a unicode or utf file (normal file_get_contents has difficulty reading ga unicode file)
+	 * @see http://stackoverflow.com/questions/15092764/how-to-read-unicode-text-file-in-php
+	 *
+	 * @param string $file_path
+	 * @return string
+	 * @throws EE_Error
+	 */
+	private function read_unicode_file($file_path)
+	{
+		$fc = "";
+		$fh = fopen($file_path, "rb");
+		if (! $fh) {
+			throw new EE_Error(sprintf(esc_html__("Cannot open file for read: %s<br>\n", 'event_espresso'), $file_path));
+		}
+		$flen = filesize($file_path);
+		$bc = fread($fh, $flen);
+		for ($i = 0; $i < $flen; $i++) {
+			$c = substr($bc, $i, 1);
+			if ((ord($c) != 0) && (ord($c) != 13)) {
+				$fc = $fc . $c;
+			}
+		}
+		if ((ord(substr($fc, 0, 1)) == 255) && (ord(substr($fc, 1, 1)) == 254)) {
+			$fc = substr($fc, 2);
+		}
+		return ($fc);
+	}
+
+
+	/**
+	 * Generic CSV-functionality to turn an entire CSV file into a single array that's
+	 * NOT in a specific format to EE. It's just a 2-level array, with top-level arrays
+	 * representing each row in the CSV file, and the second-level arrays being each column in that row
+	 *
+	 * @param string $path_to_file
+	 * @return array of arrays. Top-level array has rows, second-level array has each item
+	 */
+	public function import_csv_to_multi_dimensional_array($path_to_file)
+	{
+		// needed to deal with Mac line endings
+		ini_set('auto_detect_line_endings', true);
+
+		// because fgetcsv does not correctly deal with backslashed quotes such as \"
+		// we'll read the file into a string
+		$file_contents = $this->read_unicode_file($path_to_file);
+		// replace backslashed quotes with CSV enclosures
+		$file_contents = str_replace('\\"', '"""', $file_contents);
+		// HEY YOU! PUT THAT FILE BACK!!!
+		file_put_contents($path_to_file, $file_contents);
+
+		if (($file_handle = fopen($path_to_file, "r")) !== false) {
+			# Set the parent multidimensional array key to 0.
+			$nn = 0;
+			$csvarray = array();
+
+			// in PHP 5.3 fgetcsv accepts a 5th parameter, but the pre 5.3 versions of fgetcsv choke if passed more than 4 - is that crazy or what?
+			if (version_compare(PHP_VERSION, '5.3.0') < 0) {
+				//  PHP 5.2- version
+				// loop through each row of the file
+				while (($data = fgetcsv($file_handle, 0, ',', '"')) !== false) {
+					$csvarray[] = $data;
+				}
+			} else {
+				// loop through each row of the file
+				while (($data = fgetcsv($file_handle, 0, ',', '"', '\\')) !== false) {
+					$csvarray[] = $data;
+				}
+			}
+			# Close the File.
+			fclose($file_handle);
+			return $csvarray;
+		} else {
+			EE_Error::add_error(
+				sprintf(esc_html__("An error occurred - the file: %s could not opened.", "event_espresso"), $path_to_file),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return false;
+		}
+	}
+
+
+	/**
+	 * Import contents of csv file and store values in an array to be manipulated by other functions
+	 * @param string  $path_to_file         - the csv file to be imported including the path to it's location.
+	 *                                      If $model_name is provided, assumes that each row in the CSV represents a
+	 *                                      model object for that model If $model_name ISN'T provided, assumes that
+	 *                                      before model object data, there is a row where the first entry is simply
+	 *                                      'MODEL', and next entry is the model's name, (untranslated) like Event, and
+	 *                                      then maybe a row of headers, and then the model data. Eg.
+	 *                                      '<br>MODEL,Event,<br>EVT_ID,EVT_name,...<br>1,Monkey
+	 *                                      Party,...<br>2,Llamarama,...<br>MODEL,Venue,<br>VNU_ID,VNU_name<br>1,The
+	 *                                      Forest
+	 * @param string  $model_name           model name if we know what model we're importing
+	 * @param boolean $first_row_is_headers - whether the first row of data is headers or not - TRUE = headers, FALSE =
+	 *                                      data
+	 * @return mixed - array on success - multi dimensional with headers as keys (if headers exist) OR string on fail -
+	 *               error message like the following array('Event'=>array( array('EVT_ID'=>1,'EVT_name'=>'bob
+	 *               party',...), array('EVT_ID'=>2,'EVT_name'=>'llamarama',...),
+	 *                                      ...
+	 *                                      )
+	 *                                      'Venue'=>array(
+	 *                                      array('VNU_ID'=>1,'VNU_name'=>'the shack',...),
+	 *                                      array('VNU_ID'=>2,'VNU_name'=>'tree house',...),
+	 *                                      ...
+	 *                                      )
+	 *                                      ...
+	 *                                      )
+	 */
+	public function import_csv_to_model_data_array($path_to_file, $model_name = false, $first_row_is_headers = true)
+	{
+		$multi_dimensional_array = $this->import_csv_to_multi_dimensional_array($path_to_file);
+		if (! $multi_dimensional_array) {
+			return false;
+		}
+		// gotta start somewhere
+		$row = 1;
+		// array to store csv data in
+		$ee_formatted_data = array();
+		// array to store headers (column names)
+		$headers = array();
+		foreach ($multi_dimensional_array as $data) {
+			// if first cell is MODEL, then second cell is the MODEL name
+			if ($data[0] == 'MODEL') {
+				$model_name = $data[1];
+				// don't bother looking for model data in this row. The rest of this
+				// row should be blank
+				// AND pretend this is the first row again
+				$row = 1;
+				// reset headers
+				$headers = array();
+				continue;
+			}
+			if (strpos($data[0], EE_CSV::metadata_header) !== false) {
+				$model_name = EE_CSV::metadata_header;
+				// store like model data, we just won't try importing it etc.
+				$row = 1;
+				continue;
+			}
+
+
+			// how many columns are there?
+			$columns = count($data);
+
+			$model_entry = array();
+			// loop through each column
+			for ($i = 0; $i < $columns; $i++) {
+				// replace csv_enclosures with backslashed quotes
+				$data[ $i ] = str_replace('"""', '\\"', $data[ $i ]);
+				// do we need to grab the column names?
+				if ($row === 1) {
+					if ($first_row_is_headers) {
+						// store the column names to use for keys
+						$column_name = $data[ $i ];
+						// check it's not blank... sometimes CSV editign programs adda bunch of empty columns onto the end...
+						if (! $column_name) {
+							continue;
+						}
+						$matches = array();
+						if ($model_name == EE_CSV::metadata_header) {
+							$headers[ $i ] = $column_name;
+						} else {
+							// now get the db table name from it (the part between square brackets)
+							$success = preg_match('~(.*)\[(.*)\]~', $column_name, $matches);
+							if (! $success) {
+								EE_Error::add_error(
+									sprintf(
+										esc_html__(
+											"The column titled %s is invalid for importing. It must be be in the format of 'Nice Name[model_field_name]' in row %s",
+											"event_espresso"
+										),
+										$column_name,
+										implode(",", $data)
+									),
+									__FILE__,
+									__FUNCTION__,
+									__LINE__
+								);
+								return false;
+							}
+							$headers[ $i ] = $matches[2];
+						}
+					} else {
+						// no column names means our final array will just use counters for keys
+						$model_entry[ $headers[ $i ] ] = $data[ $i ];
+						$headers[ $i ] = $i;
+					}
+					// and we need to store csv data
+				} else {
+					// this column isn' ta header, store it if there is a header for it
+					if (isset($headers[ $i ])) {
+						$model_entry[ $headers[ $i ] ] = $data[ $i ];
+					}
+				}
+			}
+			// save the row's data IF it's a non-header-row
+			if (! $first_row_is_headers || ($first_row_is_headers && $row > 1)) {
+				$ee_formatted_data[ $model_name ][] = $model_entry;
+			}
+			// advance to next row
+			$row++;
+		}
+
+		// delete the uploaded file
+		unlink($path_to_file);
+		// echo '<pre style="height:auto;border:2px solid lightblue;">' . print_r( $ee_formatted_data, TRUE ) . '</pre><br /><span style="font-size:10px;font-weight:normal;">' . __FILE__ . '<br />line no: ' . __LINE__ . '</span>';
+		// die();
+
+		// it's good to give back
+		return $ee_formatted_data;
+	}
+
+
+	public function save_csv_to_db($csv_data_array, $model_name = false)
+	{
+		EE_Error::doing_it_wrong(
+			'save_csv_to_db',
+			esc_html__(
+				'Function moved to EE_Import and renamed to save_csv_data_array_to_db',
+				'event_espresso'
+			),
+			'4.6.7'
+		);
+		return EE_Import::instance()->save_csv_data_array_to_db($csv_data_array, $model_name);
+	}
+
+	/**
+	 * Sends HTTP headers to indicate that the browser should download a file,
+	 * and starts writing the file to PHP's output. Returns the file handle so other functions can
+	 * also write to it
+	 *
+	 * @param string $new_filename the name of the file that the user will download
+	 * @return resource, like the results of fopen(), which can be used for fwrite, fputcsv2, etc.
+	 */
+	public function begin_sending_csv($filename)
+	{
+		// grab file extension
+		$ext = substr(strrchr($filename, '.'), 1);
+		if ($ext == '.csv' or $ext == '.xls') {
+			str_replace($ext, '', $filename);
+		}
+		$filename .= '.csv';
+
+		// if somebody's been naughty and already started outputting stuff, trash it
+		// and start writing our stuff.
+		if (ob_get_length()) {
+			@ob_flush();
+			@flush();
+			@ob_end_flush();
+		}
+		@ob_start();
+		header("Pragma: public");
+		header("Expires: 0");
+		header("Pragma: no-cache");
+		header("Cache-Control: no-store, no-cache, must-revalidate, post-check=0, pre-check=0");
+		// header("Content-Type: application/force-download");
+		// header("Content-Type: application/octet-stream");
+		// header("Content-Type: application/download");
+		header('Content-disposition: attachment; filename=' . $filename);
+		header("Content-Type: text/csv; charset=utf-8");
+		do_action('AHEE__EE_CSV__begin_sending_csv__headers');
+		echo apply_filters(
+			'FHEE__EE_CSV__begin_sending_csv__start_writing',
+			"\xEF\xBB\xBF"
+		); // makes excel open it as UTF-8. UTF-8 BOM, see http://stackoverflow.com/a/4440143/2773835
+		$fh = fopen('php://output', 'w');
+		return $fh;
+	}
+
+	/**
+	 * Writes some meta data to the CSV as a bunch of columns. Initially we're only
+	 * mentioning the version and timezone
+	 *
+	 * @param resource $filehandle
+	 */
+	public function write_metadata_to_csv($filehandle)
+	{
+		$data_row = array(EE_CSV::metadata_header);// do NOT translate because this exact string is used when importing
+		$this->fputcsv2($filehandle, $data_row);
+		$meta_data = array(
+			0 => array(
+				'version'        => espresso_version(),
+				'timezone'       => EEH_DTT_Helper::get_timezone(),
+				'time_of_export' => current_time('mysql'),
+				'site_url'       => is_ssl() ? str_replace('http://', 'https://', site_url()) : site_url(),
+			),
+		);
+		$this->write_data_array_to_csv($filehandle, $meta_data);
+	}
+
+
+	/**
+	 * Writes $data to the csv file open in $filehandle. uses the array indices of $data for column headers
+	 *
+	 * @param array   $data                 2D array, first numerically-indexed, and next-level-down preferably indexed
+	 *                                      by string
+	 * @param boolean $add_csv_column_names whether or not we should add the keys in the bottom-most array as a row for
+	 *                                      headers in the CSV. Eg, if $data looked like
+	 *                                      array(0=>array('EVT_ID'=>1,'EVT_name'=>'monkey'...), 1=>array(...),...))
+	 *                                      then the first row we'd write to the CSV would be "EVT_ID,EVT_name,..."
+	 * @return boolean if we successfully wrote to the CSV or not. If there's no $data, we consider that a success
+	 *                 (because we wrote everything there was...nothing)
+	 */
+	public function write_data_array_to_csv($filehandle, $data)
+	{
+
+
+		// determine if $data is actually a 2d array
+		if ($data && is_array($data) && is_array(EEH_Array::get_one_item_from_array($data))) {
+			// make sure top level is numerically indexed,
+
+			if (EEH_Array::is_associative_array($data)) {
+				throw new EE_Error(
+					sprintf(
+						esc_html__(
+							"top-level array must be numerically indexed. Does these look like numbers to you? %s",
+							"event_espresso"
+						),
+						implode(",", array_keys($data))
+					)
+				);
+			}
+			$item_in_top_level_array = EEH_Array::get_one_item_from_array($data);
+			// now, is the last item in the top-level array of $data an associative or numeric array?
+			if (EEH_Array::is_associative_array($item_in_top_level_array)) {
+				// its associative, so we want to output its keys as column headers
+				$keys = array_keys($item_in_top_level_array);
+				$this->fputcsv2($filehandle, $keys);
+			}
+			// start writing data
+			foreach ($data as $data_row) {
+				$this->fputcsv2($filehandle, $data_row);
+			}
+			return true;
+		} else {
+			// no data TO write... so we can assume that's a success
+			return true;
+		}
+		// //if 2nd level is indexed by strings, use those as csv column headers (ie, the first row)
+		//
+		//
+		// $no_table = TRUE;
+		//
+		// // loop through data and add each row to the file/stream as csv
+		// foreach ( $data as $model_name => $model_data ) {
+		// // test first row to see if it is data or a model name
+		// $model = EE_Registry::instance();->load_model($model_name);
+		// //if the model really exists,
+		// if ( $model ) {
+		//
+		// // we have a table name
+		// $no_table = FALSE;
+		//
+		// // put the tablename into an array cuz that's how fputcsv rolls
+		// $model_name_row = array( 'MODEL', $model_name );
+		//
+		// // add table name to csv output
+		// echo self::fputcsv2($filehandle, $model_name_row);
+		//
+		// // now get the rest of the data
+		// foreach ( $model_data as $row ) {
+		// // output the row
+		// echo self::fputcsv2($filehandle, $row);
+		// }
+		//
+		// }
+		//
+		// if ( $no_table ) {
+		// // no table so just put the data
+		// echo self::fputcsv2($filehandle, $model_data);
+		// }
+		//
+		// } // END OF foreach ( $data )
+	}
+
+	/**
+	 * Should be called after begin_sending_csv(), and one or more write_data_array_to_csv()s.
+	 * Calls exit to prevent polluting the CSV file with other junk
+	 *
+	 * @param resource $fh filehandle where we're writing the CSV to
+	 */
+	public function end_sending_csv($fh)
+	{
+		fclose($fh);
+		exit(0);
+	}
+
+	/**
+	 * Given an open file, writes all the model data to it in the format the importer expects.
+	 * Usually preceded by begin_sending_csv($filename), and followed by end_sending_csv($filehandle).
+	 *
+	 * @param resource $filehandle
+	 * @param array    $model_data_array is assumed to be a 3d array: 1st layer has keys of model names (eg 'Event'),
+	 *                                   next layer is numerically indexed to represent each model object (eg, each
+	 *                                   individual event), and the last layer has all the attributes o fthat model
+	 *                                   object (eg, the event's id, name, etc)
+	 * @return boolean success
+	 */
+	public function write_model_data_to_csv($filehandle, $model_data_array)
+	{
+		$this->write_metadata_to_csv($filehandle);
+		foreach ($model_data_array as $model_name => $model_instance_arrays) {
+			// first: output a special row stating the model
+			$this->fputcsv2($filehandle, array('MODEL', $model_name));
+			// if we have items to put in the CSV, do it normally
+
+			if (! empty($model_instance_arrays)) {
+				$this->write_data_array_to_csv($filehandle, $model_instance_arrays);
+			} else {
+				// echo "no data to write... so just write the headers";
+				// so there's actually NO model objects for that model.
+				// probably still want to show the columns
+				$model = EE_Registry::instance()->load_model($model_name);
+				$column_names = array();
+				foreach ($model->field_settings() as $field) {
+					$column_names[ $field->get_nicename() . "[" . $field->get_name() . "]" ] = null;
+				}
+				$this->write_data_array_to_csv($filehandle, array($column_names));
+			}
+		}
+	}
+
+	/**
+	 * Writes the CSV file to the output buffer, with rows corresponding to $model_data_array,
+	 * and dies (in order to avoid other plugins from messing up the csv output)
+	 *
+	 * @param string $filename         the filename you want to give the file
+	 * @param array  $model_data_array 3d array, as described in EE_CSV::write_model_data_to_csv()
+	 * @return bool | void writes CSV file to output and dies
+	 */
+	public function export_multiple_model_data_to_csv($filename, $model_data_array)
+	{
+		$filehandle = $this->begin_sending_csv($filename);
+		$this->write_model_data_to_csv($filehandle, $model_data_array);
+		$this->end_sending_csv($filehandle);
+	}
+
+	/**
+	 * Export contents of an array to csv file
+	 * @param array  $data     - the array of data to be converted to csv and exported
+	 * @param string $filename - name for newly created csv file
+	 * @return TRUE on success, FALSE on fail
+	 */
+	public function export_array_to_csv($data = false, $filename = false)
+	{
+
+		// no data file?? get outta here
+		if (! $data or ! is_array($data) or empty($data)) {
+			return false;
+		}
+
+		// no filename?? get outta here
+		if (! $filename) {
+			return false;
+		}
+
+
+		// somebody told me i might need this ???
+		global $wpdb;
+		$prefix = $wpdb->prefix;
+
+
+		$fh = $this->begin_sending_csv($filename);
+
+
+		$this->end_sending_csv($fh);
+	}
+
+
+	/**
+	 * Determine the maximum upload file size based on php.ini settings
+	 * @param int $percent_of_max - desired percentage of the max upload_mb
+	 * @return int KB
+	 */
+	public function get_max_upload_size($percent_of_max = false)
+	{
+
+		$max_upload = (int) (ini_get('upload_max_filesize'));
+		$max_post = (int) (ini_get('post_max_size'));
+		$memory_limit = (int) (ini_get('memory_limit'));
+
+		// determine the smallest of the three values from above
+		$upload_mb = min($max_upload, $max_post, $memory_limit);
+
+		// convert MB to KB
+		$upload_mb = $upload_mb * 1024;
+
+		// don't want the full monty? then reduce the max uplaod size
+		if ($percent_of_max) {
+			// is percent_of_max like this -> 50 or like this -> 0.50 ?
+			if ($percent_of_max > 1) {
+				// chnages 50 to 0.50
+				$percent_of_max = $percent_of_max / 100;
+			}
+			// make upload_mb a percentage of the max upload_mb
+			$upload_mb = $upload_mb * $percent_of_max;
+		}
+
+		return $upload_mb;
+	}
+
+
+	/**
+	 * Drop   in replacement for PHP's fputcsv function - but this one works!!!
+	 * @param resource $fh         - file handle - what we are writing to
+	 * @param array    $row        - individual row of csv data
+	 * @param string   $delimiter  - csv delimiter
+	 * @param string   $enclosure  - csv enclosure
+	 * @param string   $mysql_null - allows php NULL to be overridden with MySQl's insertable NULL value
+	 * @return void
+	 */
+	private function fputcsv2($fh, array $row, $delimiter = ',', $enclosure = '"', $mysql_null = false)
+	{
+		// Allow user to filter the csv delimiter and enclosure for other countries csv standards
+		$delimiter = apply_filters('FHEE__EE_CSV__fputcsv2__delimiter', $delimiter);
+		$enclosure = apply_filters('FHEE__EE_CSV__fputcsv2__enclosure', $enclosure);
+
+		$delimiter_esc = preg_quote($delimiter, '/');
+		$enclosure_esc = preg_quote($enclosure, '/');
+
+		$output = array();
+		foreach ($row as $field_value) {
+			if (is_object($field_value) || is_array($field_value)) {
+				$field_value = serialize($field_value);
+			}
+			if ($field_value === null && $mysql_null) {
+				$output[] = 'NULL';
+				continue;
+			}
+
+			$output[] = preg_match("/(?:${delimiter_esc}|${enclosure_esc}|\s)/", $field_value) ?
+				($enclosure . str_replace($enclosure, $enclosure . $enclosure, $field_value) . $enclosure)
+				: $field_value;
+		}
+
+		fwrite($fh, join($delimiter, $output) . PHP_EOL);
+	}
+
+
+	// /**
+	//  * CSV    Import / Export messages
+	//  * @return void
+	//  */
+	// public function csv_admin_notices()
+	// {
+	//
+	//     // We play both kinds of music here! Country AND Western! - err... I mean, cycle through both types of notices
+	//     foreach (array('updates', 'errors') as $type) {
+	//
+	//         // if particular notice type is not empty, then "You've got Mail"
+	//         if (! empty($this->_notices[ $type ])) {
+	//
+	//             // is it an update or an error ?
+	//             $msg_class = $type == 'updates' ? 'updated' : 'error';
+	//             echo '<div id="message" class="' . $msg_class . '">';
+	//             // display each notice, however many that may be
+	//             foreach ($this->_notices[ $type ] as $message) {
+	//                 echo '<p>' . $message . '</p>';
+	//             }
+	//             // wrap it up
+	//             echo '</div>';
+	//         }
+	//     }
+	// }
+
+	/**
+	 * Gets the date format to use in teh csv. filterable
+	 *
+	 * @param string $current_format
+	 * @return string
+	 */
+	public function get_date_format_for_csv($current_format = null)
+	{
+		return apply_filters('FHEE__EE_CSV__get_date_format_for_csv__format', 'Y-m-d', $current_format);
+	}
+
+	/**
+	 * Gets the time format we want to use in CSV reports. Filterable
+	 *
+	 * @param string $current_format
+	 * @return string
+	 */
+	public function get_time_format_for_csv($current_format = null)
+	{
+		return apply_filters('FHEE__EE_CSV__get_time_format_for_csv__format', 'H:i:s', $current_format);
+	}
 }

core/domain/entities/routing/data_nodes/EventEspressoData.php

Indentation +36 added lines, -36 removed lines

@@ -20,40 +20,40 @@
  */
 class EventEspressoData extends PrimaryJsonDataNode
 {
-    const NODE_NAME = 'eventEspressoData';
-
-    private Api $api;
-
-    private Config $config;
-
-    private JedLocaleData $jed_locale;
-
-
-    /**
-     * @param Api $api
-     * @param Config $config
-     * @param JedLocaleData         $jed_locale
-     * @param JsonDataNodeValidator $validator
-     */
-    public function __construct(Api $api, Config $config, JedLocaleData $jed_locale, JsonDataNodeValidator $validator)
-    {
-        parent::__construct($validator);
-        $this->api = $api;
-        $this->config = $config;
-        $this->jed_locale = $jed_locale;
-        $this->setNodeName(EventEspressoData::NODE_NAME);
-    }
-
-
-    /**
-     * @throws DomainException
-     * @since 5.0.0.p
-     */
-    public function initialize()
-    {
-        $this->addDataNode($this->api);
-        $this->addDataNode($this->config);
-        $this->addData('i18n', $this->jed_locale->getData());
-        $this->setInitialized(true);
-    }
+	const NODE_NAME = 'eventEspressoData';
+
+	private Api $api;
+
+	private Config $config;
+
+	private JedLocaleData $jed_locale;
+
+
+	/**
+	 * @param Api $api
+	 * @param Config $config
+	 * @param JedLocaleData         $jed_locale
+	 * @param JsonDataNodeValidator $validator
+	 */
+	public function __construct(Api $api, Config $config, JedLocaleData $jed_locale, JsonDataNodeValidator $validator)
+	{
+		parent::__construct($validator);
+		$this->api = $api;
+		$this->config = $config;
+		$this->jed_locale = $jed_locale;
+		$this->setNodeName(EventEspressoData::NODE_NAME);
+	}
+
+
+	/**
+	 * @throws DomainException
+	 * @since 5.0.0.p
+	 */
+	public function initialize()
+	{
+		$this->addDataNode($this->api);
+		$this->addDataNode($this->config);
+		$this->addData('i18n', $this->jed_locale->getData());
+		$this->setInitialized(true);
+	}
 }

core/domain/entities/routing/data_nodes/core/Capabilities.php

Indentation +25 added lines, -25 removed lines

@@ -7,33 +7,33 @@
 
 class Capabilities extends JsonDataNode
 {
-    const NODE_NAME = 'capabilities';
+	const NODE_NAME = 'capabilities';
 
 
-    /**
-     * @param JsonDataNodeValidator $validator
-     */
-    public function __construct(JsonDataNodeValidator $validator)
-    {
-        parent::__construct($validator);
-        $this->setNodeName(Capabilities::NODE_NAME);
-    }
+	/**
+	 * @param JsonDataNodeValidator $validator
+	 */
+	public function __construct(JsonDataNodeValidator $validator)
+	{
+		parent::__construct($validator);
+		$this->setNodeName(Capabilities::NODE_NAME);
+	}
 
 
-    /**
-     * @inheritDoc
-     */
-    public function initialize()
-    {
-        $current_user      = wp_get_current_user();
-        $capabilities      = [];
-        $role_capabilities = $current_user->get_role_caps();
-        foreach ($role_capabilities as $capability => $you_can_do_it) {
-            if ($you_can_do_it) {
-                $capabilities[] = $capability;
-            }
-        }
-        sort($capabilities, SORT_NATURAL);
-        $this->setDataArray($capabilities);
-    }
+	/**
+	 * @inheritDoc
+	 */
+	public function initialize()
+	{
+		$current_user      = wp_get_current_user();
+		$capabilities      = [];
+		$role_capabilities = $current_user->get_role_caps();
+		foreach ($role_capabilities as $capability => $you_can_do_it) {
+			if ($you_can_do_it) {
+				$capabilities[] = $capability;
+			}
+		}
+		sort($capabilities, SORT_NATURAL);
+		$this->setDataArray($capabilities);
+	}
 }

core/domain/entities/routing/handlers/admin/NonEspressoAdminAjax.php

Indentation +60 added lines, -60 removed lines

@@ -21,68 +21,68 @@
  */
 class NonEspressoAdminAjax extends Route
 {
-    /**
-     * returns true if the current request matches this route
-     *
-     * @return bool
-     * @since   5.0.0.p
-     */
-    public function matchesCurrentRequest(): bool
-    {
-        return $this->request->isOtherAjax();
-    }
+	/**
+	 * returns true if the current request matches this route
+	 *
+	 * @return bool
+	 * @since   5.0.0.p
+	 */
+	public function matchesCurrentRequest(): bool
+	{
+		return $this->request->isOtherAjax();
+	}
 
 
-    /**
-     * @since 5.0.0.p
-     */
-    protected function registerDependencies()
-    {
-    }
+	/**
+	 * @since 5.0.0.p
+	 */
+	protected function registerDependencies()
+	{
+	}
 
 
-    /**
-     * implements logic required to run during request
-     *
-     * @return bool
-     * @since   5.0.0.p
-     */
-    protected function requestHandler(): bool
-    {
-        /** @var Domain $domain */
-        $domain  = $this->loader->getShared(Domain::class);
-        /** @var FeatureFlags $feature */
-        $feature = $this->loader->getShared(FeatureFlags::class);
-        if ($domain->isCaffeinated() && $feature->allowed(FeatureFlag::USE_ADVANCED_EVENT_EDITOR)) {
-            // Add duplicate button
-            add_filter(
-                'get_sample_permalink_html',
-                [DuplicateEventButton::class, 'addButton'],
-                8,
-                4
-            );
-        }
-        // Add shortlink button
-        add_filter(
-            'get_sample_permalink_html',
-            [EventShortlinkButton::class, 'addButton'],
-            10,
-            2
-        );
-        // Add ticket selector shortcode button
-        add_filter(
-            'get_sample_permalink_html',
-            [TicketSelectorShortcodeButton::class, 'addButton'],
-            12,
-            4
-        );
-        // Add preview button
-        add_filter(
-            'get_sample_permalink_html',
-            [PreviewButton::class, 'addButton'],
-            5,
-            2
-        );
-        return true;
-    }
+	/**
+	 * implements logic required to run during request
+	 *
+	 * @return bool
+	 * @since   5.0.0.p
+	 */
+	protected function requestHandler(): bool
+	{
+		/** @var Domain $domain */
+		$domain  = $this->loader->getShared(Domain::class);
+		/** @var FeatureFlags $feature */
+		$feature = $this->loader->getShared(FeatureFlags::class);
+		if ($domain->isCaffeinated() && $feature->allowed(FeatureFlag::USE_ADVANCED_EVENT_EDITOR)) {
+			// Add duplicate button
+			add_filter(
+				'get_sample_permalink_html',
+				[DuplicateEventButton::class, 'addButton'],
+				8,
+				4
+			);
+		}
+		// Add shortlink button
+		add_filter(
+			'get_sample_permalink_html',
+			[EventShortlinkButton::class, 'addButton'],
+			10,
+			2
+		);
+		// Add ticket selector shortcode button
+		add_filter(
+			'get_sample_permalink_html',
+			[TicketSelectorShortcodeButton::class, 'addButton'],
+			12,
+			4
+		);
+		// Add preview button
+		add_filter(
+			'get_sample_permalink_html',
+			[PreviewButton::class, 'addButton'],
+			5,
+			2
+		);
+		return true;
+	}
 }

core/domain/services/capabilities/FeatureFlagsConfig.php

Indentation +185 added lines, -185 removed lines

@@ -17,189 +17,189 @@
  */
 class FeatureFlagsConfig extends JsonDataWordpressOption
 {
-    /**
-     * WP option name for saving the Feature Flags configuration
-     */
-    private const OPTION_NAME = 'ee_feature_flags';
-
-    /**
-     * use FeatureFlag::USE_EVENT_EDITOR_BULK_EDIT instead
-     * this hasn't been deleted because it's used in the REM add-on
-     *
-     * @deprecated 5.0.18.p
-     */
-    public const  USE_EVENT_EDITOR_BULK_EDIT = FeatureFlag::USE_EVENT_EDITOR_BULK_EDIT;
-
-
-    private array $cap_checks;
-
-    protected Domain $domain;
-
-    private ?stdClass $feature_flags = null;
-
-    private array $removed;
-
-
-    public function __construct(Domain $domain, JsonDataHandler $json_data_handler)
-    {
-        $this->domain     = $domain;
-        $this->cap_checks = apply_filters(
-            'FHEE__EventEspresso_core_domain_services_capabilities_FeatureFlagsConfig_cap_checks',
-            []
-        );
-        $this->removed    = apply_filters(
-            'FHEE__EventEspresso_core_domain_services_capabilities_FeatureFlagsConfig_removed',
-            []
-        );
-        parent::__construct($json_data_handler, FeatureFlagsConfig::OPTION_NAME, $this->getDefaultFeatureFlagOptions());
-    }
-
-
-    /**
-     * see the FeatureFlag::USE_* constants for descriptions of each feature flag and their default values
-     *
-     * @return stdClass
-     */
-    public function getDefaultFeatureFlagOptions(): stdClass
-    {
-        return (object) [
-            FeatureFlag::USE_ADVANCED_EVENT_EDITOR     => true,
-            FeatureFlag::USE_DATETIME_STATUS_CONTROLS  => false,
-            FeatureFlag::USE_DEFAULT_TICKET_MANAGER    => true,
-            FeatureFlag::USE_EDD_PLUGIN_LICENSING      => true,
-            FeatureFlag::USE_EVENT_DESCRIPTION_RTE     => false,
-            FeatureFlag::USE_EVENT_EDITOR_BULK_EDIT    => $this->domain->isCaffeinated()
-                                                            && ! $this->domain->isMultiSite(),
-            FeatureFlag::USE_EXPERIMENTAL_RTE          => false,
-            FeatureFlag::USE_PAYMENT_PROCESSOR_FEES    => true,
-            FeatureFlag::USE_REG_FORM_BUILDER          => false,
-            FeatureFlag::USE_REG_FORM_TICKET_QUESTIONS => false,
-            FeatureFlag::USE_REG_OPTIONS_META_BOX      => false,
-            FeatureFlag::USE_SPCO_FORM_REFACTOR        => false,
-        ];
-    }
-
-
-    /**
-     * feature flags that absolutely must be enabled/disabled based on hard-coded conditions
-     *
-     * @return stdClass
-     * @since 5.0.20.p
-     */
-    public function getOverrides(): stdClass
-    {
-        // allow EDD to be disabled for testing.
-        $overrides[ FeatureFlag::USE_EDD_PLUGIN_LICENSING ] =
-            ! defined('EE_USE_EDD_PLUGIN_LICENSING') || EE_USE_EDD_PLUGIN_LICENSING;
-
-        return (object) $overrides;
-    }
-
-
-    /**
-     * @return stdClass
-     */
-    public function getFeatureFlags(): stdClass
-    {
-        if ($this->feature_flags) {
-            return $this->feature_flags;
-        }
-        $default_options     = $this->getDefaultFeatureFlagOptions();
-        $this->feature_flags = $this->getAll();
-        $overrides           = $this->getOverrides();
-        // ensure that all feature flags are set
-        foreach ($default_options as $key => $value) {
-            // unset any feature flags that have been removed
-            if (in_array($key, $this->removed, true)) {
-                unset($this->feature_flags->{$key});
-                continue;
-            }
-            // if the feature flag is not set, use the default value
-            if (! isset($this->feature_flags->$key)) {
-                $this->feature_flags->$key = $value;
-            }
-            // ensure that all overrides are set
-            if (isset($overrides->$key)) {
-                $this->feature_flags->$key = $overrides->$key;
-            }
-            // convert any feature flags that are CapChecks
-            if (in_array($key, $this->cap_checks, true)) {
-                if (! $this->feature_flags->{$key} instanceof CapCheck) {
-                    $this->feature_flags->{$key} = new CapCheck($key, "feature_flag_$key");
-                }
-            }
-        }
-        return $this->feature_flags;
-    }
-
-
-    public function saveFeatureFlagsConfig(?stdClass $feature_flags = null): int
-    {
-        $feature_flags = $feature_flags ?? $this->feature_flags;
-        foreach ($this->removed as $feature_flag) {
-            unset($feature_flags->{$feature_flag});
-        }
-        $this->feature_flags = $feature_flags;
-        return $this->updateOption($feature_flags);
-    }
-
-
-    /**
-     * enables a feature flag, ex:
-     * $this->enableFeatureFlag(FeatureFlag::USE_ADVANCED_EVENT_EDITOR);
-     *
-     * @param string $feature_flag the feature flag to enable. One of the FeatureFlag::USE_* constants
-     * @param bool   $add_if_missing
-     * @param bool   $save
-     * @return int
-     */
-    public function enableFeatureFlag(string $feature_flag, bool $add_if_missing = false, bool $save = true): int
-    {
-        if (! $this->feature_flags) {
-            $this->getFeatureFlags();
-        }
-        if (! property_exists($this->feature_flags, $feature_flag) && ! $add_if_missing) {
-            return WordPressOption::UPDATE_ERROR;
-        }
-        $this->feature_flags->{$feature_flag} = true;
-        // if feature flag is the advanced event editor bulk edit options
-        // then only enabled if the site is Caffeinated and not MultiSite
-        if ($feature_flag === FeatureFlag::USE_EVENT_EDITOR_BULK_EDIT) {
-            $this->feature_flags->{$feature_flag} = $this->domain->isCaffeinated() && ! $this->domain->isMultiSite();
-        }
-        if ($save) {
-            return $this->saveFeatureFlagsConfig($this->feature_flags);
-        }
-        return WordPressOption::UPDATE_NONE;
-    }
-
-
-    /**
-     * disables a feature flag, ex:
-     * $this->disableFeatureFlag(FeatureFlag::USE_ADVANCED_EVENT_EDITOR);
-     *
-     * @param string $feature_flag the feature flag to disable. One of the FeatureFlag::USE_* constants
-     * @param bool   $save
-     * @return int
-     */
-    public function disableFeatureFlag(string $feature_flag, bool $save = true): int
-    {
-        if (! $this->feature_flags) {
-            $this->getFeatureFlags();
-        }
-        if (! property_exists($this->feature_flags, $feature_flag)) {
-            return WordPressOption::UPDATE_ERROR;
-        }
-        $this->feature_flags->{$feature_flag} = false;
-        if ($save) {
-            return $this->saveFeatureFlagsConfig($this->feature_flags);
-        }
-        return WordPressOption::UPDATE_NONE;
-    }
-
-
-    public function getFeatureFlagsFormOptions(): ?array
-    {
-        return FeatureFlag::getFormOptions();
-    }
+	/**
+	 * WP option name for saving the Feature Flags configuration
+	 */
+	private const OPTION_NAME = 'ee_feature_flags';
+
+	/**
+	 * use FeatureFlag::USE_EVENT_EDITOR_BULK_EDIT instead
+	 * this hasn't been deleted because it's used in the REM add-on
+	 *
+	 * @deprecated 5.0.18.p
+	 */
+	public const  USE_EVENT_EDITOR_BULK_EDIT = FeatureFlag::USE_EVENT_EDITOR_BULK_EDIT;
+
+
+	private array $cap_checks;
+
+	protected Domain $domain;
+
+	private ?stdClass $feature_flags = null;
+
+	private array $removed;
+
+
+	public function __construct(Domain $domain, JsonDataHandler $json_data_handler)
+	{
+		$this->domain     = $domain;
+		$this->cap_checks = apply_filters(
+			'FHEE__EventEspresso_core_domain_services_capabilities_FeatureFlagsConfig_cap_checks',
+			[]
+		);
+		$this->removed    = apply_filters(
+			'FHEE__EventEspresso_core_domain_services_capabilities_FeatureFlagsConfig_removed',
+			[]
+		);
+		parent::__construct($json_data_handler, FeatureFlagsConfig::OPTION_NAME, $this->getDefaultFeatureFlagOptions());
+	}
+
+
+	/**
+	 * see the FeatureFlag::USE_* constants for descriptions of each feature flag and their default values
+	 *
+	 * @return stdClass
+	 */
+	public function getDefaultFeatureFlagOptions(): stdClass
+	{
+		return (object) [
+			FeatureFlag::USE_ADVANCED_EVENT_EDITOR     => true,
+			FeatureFlag::USE_DATETIME_STATUS_CONTROLS  => false,
+			FeatureFlag::USE_DEFAULT_TICKET_MANAGER    => true,
+			FeatureFlag::USE_EDD_PLUGIN_LICENSING      => true,
+			FeatureFlag::USE_EVENT_DESCRIPTION_RTE     => false,
+			FeatureFlag::USE_EVENT_EDITOR_BULK_EDIT    => $this->domain->isCaffeinated()
+															&& ! $this->domain->isMultiSite(),
+			FeatureFlag::USE_EXPERIMENTAL_RTE          => false,
+			FeatureFlag::USE_PAYMENT_PROCESSOR_FEES    => true,
+			FeatureFlag::USE_REG_FORM_BUILDER          => false,
+			FeatureFlag::USE_REG_FORM_TICKET_QUESTIONS => false,
+			FeatureFlag::USE_REG_OPTIONS_META_BOX      => false,
+			FeatureFlag::USE_SPCO_FORM_REFACTOR        => false,
+		];
+	}
+
+
+	/**
+	 * feature flags that absolutely must be enabled/disabled based on hard-coded conditions
+	 *
+	 * @return stdClass
+	 * @since 5.0.20.p
+	 */
+	public function getOverrides(): stdClass
+	{
+		// allow EDD to be disabled for testing.
+		$overrides[ FeatureFlag::USE_EDD_PLUGIN_LICENSING ] =
+			! defined('EE_USE_EDD_PLUGIN_LICENSING') || EE_USE_EDD_PLUGIN_LICENSING;
+
+		return (object) $overrides;
+	}
+
+
+	/**
+	 * @return stdClass
+	 */
+	public function getFeatureFlags(): stdClass
+	{
+		if ($this->feature_flags) {
+			return $this->feature_flags;
+		}
+		$default_options     = $this->getDefaultFeatureFlagOptions();
+		$this->feature_flags = $this->getAll();
+		$overrides           = $this->getOverrides();
+		// ensure that all feature flags are set
+		foreach ($default_options as $key => $value) {
+			// unset any feature flags that have been removed
+			if (in_array($key, $this->removed, true)) {
+				unset($this->feature_flags->{$key});
+				continue;
+			}
+			// if the feature flag is not set, use the default value
+			if (! isset($this->feature_flags->$key)) {
+				$this->feature_flags->$key = $value;
+			}
+			// ensure that all overrides are set
+			if (isset($overrides->$key)) {
+				$this->feature_flags->$key = $overrides->$key;
+			}
+			// convert any feature flags that are CapChecks
+			if (in_array($key, $this->cap_checks, true)) {
+				if (! $this->feature_flags->{$key} instanceof CapCheck) {
+					$this->feature_flags->{$key} = new CapCheck($key, "feature_flag_$key");
+				}
+			}
+		}
+		return $this->feature_flags;
+	}
+
+
+	public function saveFeatureFlagsConfig(?stdClass $feature_flags = null): int
+	{
+		$feature_flags = $feature_flags ?? $this->feature_flags;
+		foreach ($this->removed as $feature_flag) {
+			unset($feature_flags->{$feature_flag});
+		}
+		$this->feature_flags = $feature_flags;
+		return $this->updateOption($feature_flags);
+	}
+
+
+	/**
+	 * enables a feature flag, ex:
+	 * $this->enableFeatureFlag(FeatureFlag::USE_ADVANCED_EVENT_EDITOR);
+	 *
+	 * @param string $feature_flag the feature flag to enable. One of the FeatureFlag::USE_* constants
+	 * @param bool   $add_if_missing
+	 * @param bool   $save
+	 * @return int
+	 */
+	public function enableFeatureFlag(string $feature_flag, bool $add_if_missing = false, bool $save = true): int
+	{
+		if (! $this->feature_flags) {
+			$this->getFeatureFlags();
+		}
+		if (! property_exists($this->feature_flags, $feature_flag) && ! $add_if_missing) {
+			return WordPressOption::UPDATE_ERROR;
+		}
+		$this->feature_flags->{$feature_flag} = true;
+		// if feature flag is the advanced event editor bulk edit options
+		// then only enabled if the site is Caffeinated and not MultiSite
+		if ($feature_flag === FeatureFlag::USE_EVENT_EDITOR_BULK_EDIT) {
+			$this->feature_flags->{$feature_flag} = $this->domain->isCaffeinated() && ! $this->domain->isMultiSite();
+		}
+		if ($save) {
+			return $this->saveFeatureFlagsConfig($this->feature_flags);
+		}
+		return WordPressOption::UPDATE_NONE;
+	}
+
+
+	/**
+	 * disables a feature flag, ex:
+	 * $this->disableFeatureFlag(FeatureFlag::USE_ADVANCED_EVENT_EDITOR);
+	 *
+	 * @param string $feature_flag the feature flag to disable. One of the FeatureFlag::USE_* constants
+	 * @param bool   $save
+	 * @return int
+	 */
+	public function disableFeatureFlag(string $feature_flag, bool $save = true): int
+	{
+		if (! $this->feature_flags) {
+			$this->getFeatureFlags();
+		}
+		if (! property_exists($this->feature_flags, $feature_flag)) {
+			return WordPressOption::UPDATE_ERROR;
+		}
+		$this->feature_flags->{$feature_flag} = false;
+		if ($save) {
+			return $this->saveFeatureFlagsConfig($this->feature_flags);
+		}
+		return WordPressOption::UPDATE_NONE;
+	}
+
+
+	public function getFeatureFlagsFormOptions(): ?array
+	{
+		return FeatureFlag::getFormOptions();
+	}
 }

Spacing +8 added lines, -8 removed lines

@@ -47,7 +47,7 @@ 
             'FHEE__EventEspresso_core_domain_services_capabilities_FeatureFlagsConfig_cap_checks',
             []
         );
-        $this->removed    = apply_filters(
+        $this->removed = apply_filters(
             'FHEE__EventEspresso_core_domain_services_capabilities_FeatureFlagsConfig_removed',
             []
         );
@@ -89,7 +89,7 @@ 
     public function getOverrides(): stdClass
     {
         // allow EDD to be disabled for testing.
-        $overrides[ FeatureFlag::USE_EDD_PLUGIN_LICENSING ] =
+        $overrides[FeatureFlag::USE_EDD_PLUGIN_LICENSING] =
             ! defined('EE_USE_EDD_PLUGIN_LICENSING') || EE_USE_EDD_PLUGIN_LICENSING;
 
         return (object) $overrides;
@@ -115,7 +115,7 @@ 
                 continue;
             }
             // if the feature flag is not set, use the default value
-            if (! isset($this->feature_flags->$key)) {
+            if ( ! isset($this->feature_flags->$key)) {
                 $this->feature_flags->$key = $value;
             }
             // ensure that all overrides are set
@@ -124,7 +124,7 @@ 
             }
             // convert any feature flags that are CapChecks
             if (in_array($key, $this->cap_checks, true)) {
-                if (! $this->feature_flags->{$key} instanceof CapCheck) {
+                if ( ! $this->feature_flags->{$key} instanceof CapCheck) {
                     $this->feature_flags->{$key} = new CapCheck($key, "feature_flag_$key");
                 }
             }
@@ -155,10 +155,10 @@ 
      */
     public function enableFeatureFlag(string $feature_flag, bool $add_if_missing = false, bool $save = true): int
     {
-        if (! $this->feature_flags) {
+        if ( ! $this->feature_flags) {
             $this->getFeatureFlags();
         }
-        if (! property_exists($this->feature_flags, $feature_flag) && ! $add_if_missing) {
+        if ( ! property_exists($this->feature_flags, $feature_flag) && ! $add_if_missing) {
             return WordPressOption::UPDATE_ERROR;
         }
         $this->feature_flags->{$feature_flag} = true;
@@ -184,10 +184,10 @@ 
      */
     public function disableFeatureFlag(string $feature_flag, bool $save = true): int
     {
-        if (! $this->feature_flags) {
+        if ( ! $this->feature_flags) {
             $this->getFeatureFlags();
         }
-        if (! property_exists($this->feature_flags, $feature_flag)) {
+        if ( ! property_exists($this->feature_flags, $feature_flag)) {
             return WordPressOption::UPDATE_ERROR;
         }
         $this->feature_flags->{$feature_flag} = false;

core/domain/services/capabilities/FeatureFlags.php

Indentation +58 added lines, -58 removed lines

@@ -13,70 +13,70 @@
  */
 class FeatureFlags
 {
-    private CapabilitiesChecker $capabilities_checker;
+	private CapabilitiesChecker $capabilities_checker;
 
-    protected FeatureFlagsConfig $option;
+	protected FeatureFlagsConfig $option;
 
-    /**
-     * array of key value pairs where the key is the feature flag in question
-     * and the value is either a boolean or a CapCheck object defining the required permissions
-     * example:
-     *       [
-     *          'use_bulk_edit' => true,
-     *          'use_death_ray' => new CapCheck( 'ee-death-ray-cap', 'context-desc' )
-     *      ]
-     * array is filterable via FHEE__EventEspresso_core_domain_services_capabilities_FeatureFlags
-     *
-     * @var boolean[]|CapCheck[]
-     */
-    private $feature_flags;
+	/**
+	 * array of key value pairs where the key is the feature flag in question
+	 * and the value is either a boolean or a CapCheck object defining the required permissions
+	 * example:
+	 *       [
+	 *          'use_bulk_edit' => true,
+	 *          'use_death_ray' => new CapCheck( 'ee-death-ray-cap', 'context-desc' )
+	 *      ]
+	 * array is filterable via FHEE__EventEspresso_core_domain_services_capabilities_FeatureFlags
+	 *
+	 * @var boolean[]|CapCheck[]
+	 */
+	private $feature_flags;
 
 
-    /**
-     * FeatureFlags constructor.
-     *
-     * @param CapabilitiesChecker $capabilities_checker
-     * @param FeatureFlagsConfig  $option
-     */
-    public function __construct(CapabilitiesChecker $capabilities_checker, FeatureFlagsConfig $option)
-    {
-        $this->capabilities_checker = $capabilities_checker;
-        $this->option = $option;
-        $this->feature_flags = apply_filters(
-            'FHEE__EventEspresso_core_domain_services_capabilities_FeatureFlags',
-            $this->option->getFeatureFlags()
-        );
-    }
+	/**
+	 * FeatureFlags constructor.
+	 *
+	 * @param CapabilitiesChecker $capabilities_checker
+	 * @param FeatureFlagsConfig  $option
+	 */
+	public function __construct(CapabilitiesChecker $capabilities_checker, FeatureFlagsConfig $option)
+	{
+		$this->capabilities_checker = $capabilities_checker;
+		$this->option = $option;
+		$this->feature_flags = apply_filters(
+			'FHEE__EventEspresso_core_domain_services_capabilities_FeatureFlags',
+			$this->option->getFeatureFlags()
+		);
+	}
 
 
-    /**
-     * @param string $feature
-     * @return bool
-     */
-    public function allowed(string $feature): bool
-    {
-        $flag = apply_filters(
-            'FHEE__EventEspresso_core_domain_services_capabilities_FeatureFlags__allowed__feature',
-            $this->feature_flags->{$feature} ?? false,
-            $feature
-        );
-        try {
-            return $flag instanceof CapCheck
-                ? $this->capabilities_checker->processCapCheck($flag)
-                : filter_var($flag, FILTER_VALIDATE_BOOLEAN);
-        } catch (InsufficientPermissionsException $e) {
-            // eat the exception
-        }
-        return false;
-    }
+	/**
+	 * @param string $feature
+	 * @return bool
+	 */
+	public function allowed(string $feature): bool
+	{
+		$flag = apply_filters(
+			'FHEE__EventEspresso_core_domain_services_capabilities_FeatureFlags__allowed__feature',
+			$this->feature_flags->{$feature} ?? false,
+			$feature
+		);
+		try {
+			return $flag instanceof CapCheck
+				? $this->capabilities_checker->processCapCheck($flag)
+				: filter_var($flag, FILTER_VALIDATE_BOOLEAN);
+		} catch (InsufficientPermissionsException $e) {
+			// eat the exception
+		}
+		return false;
+	}
 
 
-    /**
-     * @return array
-     */
-    public function getAllowedFeatures(): array
-    {
-        $allowed = array_filter((array) $this->feature_flags, [$this, 'allowed'], ARRAY_FILTER_USE_KEY);
-        return array_keys($allowed);
-    }
+	/**
+	 * @return array
+	 */
+	public function getAllowedFeatures(): array
+	{
+		$allowed = array_filter((array) $this->feature_flags, [$this, 'allowed'], ARRAY_FILTER_USE_KEY);
+		return array_keys($allowed);
+	}
 }

core/services/json/JsonDataWordpressOption.php

Indentation +91 added lines, -91 removed lines

@@ -15,95 +15,95 @@
  */
 abstract class JsonDataWordpressOption extends WordPressOption
 {
-    private JsonDataHandler $json_data_handler;
-
-    /**
-     * @var array|mixed|stdClass
-     */
-    private $options = [];
-
-
-    /**
-     * JsonDataWordpressOption constructor.
-     *
-     * @param JsonDataHandler $json_data_handler
-     * @param string          $option_name
-     * @param                 $default_value
-     * @param bool            $autoload
-     */
-    public function __construct(
-        JsonDataHandler $json_data_handler,
-        string $option_name,
-        $default_value,
-        bool $autoload = false
-    ) {
-        $this->json_data_handler = $json_data_handler;
-        if (! $this->json_data_handler->dataType()) {
-            $this->json_data_handler->configure(JsonDataHandler::DATA_TYPE_OBJECT);
-        }
-        parent::__construct($option_name, $default_value, $autoload);
-    }
-
-
-    /**
-     * @param      $value
-     * @param bool $force_update
-     * @return int
-     */
-    public function updateOption($value, bool $force_update = false): int
-    {
-        $update = parent::updateOption($this->json_data_handler->encodeData($value), $force_update);
-        if ($update === WordPressOption::UPDATE_SUCCESS) {
-            $this->options = $value;
-        }
-        return $update;
-    }
-
-
-    /**
-     * @param string $property
-     * @param mixed  $value
-     * @return void
-     */
-    public function addProperty(string $property, $value)
-    {
-        $options              = $this->getAll();
-        $options->{$property} = $value;
-        $this->updateOption($options);
-    }
-
-
-    /**
-     * @param string $property
-     * @return mixed
-     */
-    public function getProperty(string $property)
-    {
-        $options = $this->getAll();
-        return property_exists($options, $property) ? $options->{$property} : null;
-    }
-
-
-    /**
-     * @return array|mixed|stdClass
-     */
-    public function getAll()
-    {
-        if (empty($this->options)) {
-            $this->options = $this->json_data_handler->decodeJson($this->loadOption());
-        }
-        return $this->options;
-    }
-
-
-    /**
-     * @param string $property
-     * @return void
-     */
-    public function removeProperty(string $property)
-    {
-        $options = $this->getAll();
-        unset($options->{$property});
-        $this->updateOption($options);
-    }
+	private JsonDataHandler $json_data_handler;
+
+	/**
+	 * @var array|mixed|stdClass
+	 */
+	private $options = [];
+
+
+	/**
+	 * JsonDataWordpressOption constructor.
+	 *
+	 * @param JsonDataHandler $json_data_handler
+	 * @param string          $option_name
+	 * @param                 $default_value
+	 * @param bool            $autoload
+	 */
+	public function __construct(
+		JsonDataHandler $json_data_handler,
+		string $option_name,
+		$default_value,
+		bool $autoload = false
+	) {
+		$this->json_data_handler = $json_data_handler;
+		if (! $this->json_data_handler->dataType()) {
+			$this->json_data_handler->configure(JsonDataHandler::DATA_TYPE_OBJECT);
+		}
+		parent::__construct($option_name, $default_value, $autoload);
+	}
+
+
+	/**
+	 * @param      $value
+	 * @param bool $force_update
+	 * @return int
+	 */
+	public function updateOption($value, bool $force_update = false): int
+	{
+		$update = parent::updateOption($this->json_data_handler->encodeData($value), $force_update);
+		if ($update === WordPressOption::UPDATE_SUCCESS) {
+			$this->options = $value;
+		}
+		return $update;
+	}
+
+
+	/**
+	 * @param string $property
+	 * @param mixed  $value
+	 * @return void
+	 */
+	public function addProperty(string $property, $value)
+	{
+		$options              = $this->getAll();
+		$options->{$property} = $value;
+		$this->updateOption($options);
+	}
+
+
+	/**
+	 * @param string $property
+	 * @return mixed
+	 */
+	public function getProperty(string $property)
+	{
+		$options = $this->getAll();
+		return property_exists($options, $property) ? $options->{$property} : null;
+	}
+
+
+	/**
+	 * @return array|mixed|stdClass
+	 */
+	public function getAll()
+	{
+		if (empty($this->options)) {
+			$this->options = $this->json_data_handler->decodeJson($this->loadOption());
+		}
+		return $this->options;
+	}
+
+
+	/**
+	 * @param string $property
+	 * @return void
+	 */
+	public function removeProperty(string $property)
+	{
+		$options = $this->getAll();
+		unset($options->{$property});
+		$this->updateOption($options);
+	}
 }

core/services/session/SessionStartHandler.php

Indentation +533 added lines, -533 removed lines

@@ -29,537 +29,537 @@
  */
 class SessionStartHandler
 {
-    const OPTION_NAME_SESSION_SAVE_HANDLER_STATUS = 'ee_session_save_handler_status';
-
-    const REQUEST_PARAM_RETRY_SESSION             = 'ee_retry_session';
-
-    const SESSION_SAVE_HANDLER_STATUS_FAILED      = 'session_save_handler_failed';
-
-    const SESSION_SAVE_HANDLER_STATUS_SUCCESS     = 'session_save_handler_success';
-
-    const SESSION_SAVE_HANDLER_STATUS_UNKNOWN     = 'session_save_handler_untested';
-
-
-    protected RequestInterface $request;
-
-    /**
-     * @var string
-     * @since 5.0.47
-     */
-    private string $open_basedir = '';
-
-    /**
-     * @var string
-     * @since 5.0.47
-     */
-    private string $save_handler = '';
-
-    /**
-     * @var string
-     * @since 5.0.47
-     */
-    private string $save_path = '';
-
-    /**
-     * When true, verification of session save path filesystem checks was skipped
-     * because open_basedir prevented validation.
-     *
-     * @var bool
-     * @since 5.0.48
-     */
-    private bool $skip_save_path_checks = false;
-
-    /**
-     * @var bool
-     * @since 5.0.48
-     */
-    private bool $logging_enabled;
-
-
-    /**
-     * StartSession constructor.
-     *
-     * @param RequestInterface $request
-     */
-    public function __construct(RequestInterface $request)
-    {
-        $this->request = $request;
-        // only log session details in staging and production environments
-        $environment           = wp_get_environment_type();
-        $this->logging_enabled = WP_DEBUG && ($environment === 'staging' || $environment === 'production');
-    }
-
-
-    /**
-     * Check if a custom session save handler is in play
-     * and attempt to start the PHP session
-     *
-     * @since 4.9.68.p
-     */
-    public function startSession(): int
-    {
-        // check that session has started
-        if (session_id() === '') {
-            // clear any previous error
-            error_clear_last();
-
-            // convert warnings to ErrorException so we can catch them
-            $previous_handler = set_error_handler([$this, 'customErrorHandler'], E_WARNING);
-
-            try {
-                $this->initializeSessionVars();
-                // starts a new session if one doesn't already exist, or re-initiates an existing one
-                if ($this->hasCustomSessionSaveHandler()) {
-                    $this->checkCustomSessionSaveHandler();
-                } else {
-                    $this->verifySessionSavePath();
-                    $this->sessionStart();
-                }
-            } catch (Throwable $error) {
-                if ($this->logging_enabled) {
-                    error_log(
-                        sprintf(
-                            '[SessionStartHandler] session_start() warning: %s in %s:%s',
-                            $error->getMessage(),
-                            $error->getFile(),
-                            $error->getLine()
-                        )
-                    );
-                }
-                $this->displaySessionErrorNotice(
-                    $error->getMessage(),
-                    $error->getFile(),
-                    __FUNCTION__,
-                    $error->getLine()
-                );
-            } finally {
-                $this->restorePreviousErrorHandler($previous_handler);
-            }
-        }
-        return session_status();
-    }
-
-
-    /**
-     * @return void
-     * @since 5.0.47
-     */
-    private function initializeSessionVars(): void
-    {
-        $this->open_basedir = ini_get('open_basedir') ?: '';
-        $this->save_handler = strtolower((string) ini_get('session.save_handler'));
-        $this->save_path    = session_save_path() ?: '';
-    }
-
-
-    /**
-     * @return void
-     * @throws Throwable
-     * @since 5.0.46
-     */
-    private function sessionStart(): void
-    {
-        session_start();
-        session_write_close();
-    }
-
-
-    /**
-     * @return void
-     * @throws ErrorException
-     * @since 5.0.46
-     */
-    private function verifySessionSavePath(): void
-    {
-        if ($this->logging_enabled) {
-            error_log(
-                sprintf(
-                    "[SessionStartHandler] diagnostic: save_handler=%s save_path=%s open_basedir=%s",
-                    $this->save_handler,
-                    $this->save_path,
-                    $this->open_basedir ?: '(none)'
-                )
-            );
-        }
-        // Only validate the session save path as a filesystem directory when PHP is
-        // configured to use the 'files' session save handler. Other handlers
-        // (memcache, memcached, redis, user, etc.) use different transport
-        // formats (hosts, sockets, URIs) and are not filesystem directories.
-        if ($this->save_handler !== 'files') {
-            // assume the configured handler knows how to interpret the save path
-            // (e.g. "unix:///run/memcached/memcached.sock", "127.0.0.1:11211", etc.)
-            return;
-        }
-        $this->save_path = $this->normalizeSessionSavePath($this->save_path);
-        // If we were unable to safely validate the session save path because it
-        // appears to live outside PHP's open_basedir, skip filesystem checks to
-        // avoid emitting warnings or throwing exceptions on some hosts.
-        if ($this->skip_save_path_checks === true) {
-            if ($this->logging_enabled) {
-                error_log(
-                    sprintf(
-                        '[SessionStartHandler] skipped session_save_path filesystem validation due to open_basedir: %s',
-                        $this->save_path
-                    )
-                );
-            }
-            return;
-        }
-        // Use @-suppressed checks to avoid PHP warnings while validating.
-        if (! @is_dir($this->save_path) || ! @is_writable($this->save_path)) {
-            throw new ErrorException(
-                sprintf(
-                    esc_html__('Invalid or missing session save path: %s', 'event_espresso'),
-                    $this->save_path
-                ),
-                0,
-                E_WARNING,
-                __FILE__,
-                __LINE__
-            );
-        }
-    }
-
-
-    /**
-     * @param string $session_save_path
-     * @return string
-     * @since 5.0.47
-     */
-    private function normalizeSessionSavePath(string $session_save_path): string
-    {
-        // Normalize "N;/path" style values
-        if (strpos($session_save_path, ';') !== false) {
-            $parts             = explode(';', $session_save_path);
-            $session_save_path = end($parts);
-        }
-        $session_save_path = trim((string) $session_save_path);
-        if ($session_save_path === '') {
-            // fall back to a sane temp dir if PHP reports no explicit session_save_path
-            $session_save_path = sys_get_temp_dir();
-        }
-        // normalize trailing separators
-        $session_save_path = rtrim($session_save_path, DIRECTORY_SEPARATOR) . DIRECTORY_SEPARATOR;
-        // For 'files' handler we expect a writable filesystem directory.
-        // However, calling realpath() or is_dir() on paths outside of PHP's
-        // configured open_basedir can trigger warnings.
-        // Handle that case explicitly by checking open_basedir first
-        // and avoiding functions that would emit warnings.
-        if ($this->open_basedir !== '') {
-            $session_save_path = $this->checkPathsOutsideBaseDir($session_save_path);
-        } else {
-            // No open_basedir restriction; realpath() is safe to use and gives
-            // us a canonical path for the directory checks.
-            $session_save_path = @realpath($session_save_path) ?: $session_save_path;
-        }
-        return $session_save_path;
-    }
-
-
-    /**
-     * @param string $session_save_path
-     * @return string
-     * @since 5.0.47
-     */
-    private function checkPathsOutsideBaseDir(string $session_save_path): string
-    {
-        // open_basedir is set; check whether the configured session path
-        // appears to be within one of the allowed paths.
-        $allowed_paths = array_filter(array_map('trim', explode(PATH_SEPARATOR, $this->open_basedir)));
-        $allowed       = false;
-        foreach ($allowed_paths as $allowed_path) {
-            if ($allowed_path === '') {
-                continue;
-            }
-            // normalize trailing separators for comparison
-            $allowed_path_norm = rtrim($allowed_path, DIRECTORY_SEPARATOR) . DIRECTORY_SEPARATOR;
-            // compare start of paths for a match
-            if (strncmp($session_save_path, $allowed_path_norm, strlen($allowed_path_norm)) === 0) {
-                $allowed = true;
-                break;
-            }
-        }
-        if ($allowed) {
-            return $session_save_path;
-        }
-        // open_basedir is set and the session save path is outside it.
-        // Log for diagnostics and skip strict filesystem checks rather than
-        // throwing an exception which causes fatal behavior on some hosts.
-        if ($this->logging_enabled) {
-            error_log(
-                sprintf(
-                    "[SessionStartHandler] session_save_path outside open_basedir: save_path=%s open_basedir=%s - skipping validation",
-                    $session_save_path,
-                    $this->open_basedir
-                )
-            );
-        }
-        $this->skip_save_path_checks = true;
-        return $session_save_path;
-    }
-
-
-    /**
-     * Returns `true` if the 'session.save_handler' ini setting matches a known custom handler
-     *
-     * @return bool
-     * @since 4.9.68.p
-     */
-    private function hasCustomSessionSaveHandler(): bool
-    {
-        return $this->save_handler === 'user';
-    }
-
-
-    /**
-     * Attempt to start the PHP session when a custom Session Save Handler is known to be set.
-     *
-     * @throws ErrorException
-     * @throws Throwable
-     * @since 4.9.68.p
-     */
-    private function checkCustomSessionSaveHandler(): void
-    {
-        // If we've already successfully tested the session save handler
-        // on a previous request then just start the session
-        if ($this->sessionSaveHandlerIsValid()) {
-            $this->sessionStart();
-            return;
-        }
-        // If not, then attempt to deal with any errors,
-        // otherwise, try to hobble along without the session
-        if (! $this->handleSessionSaveHandlerErrors()) {
-            return;
-        }
-        // there is no record of a fatal error while trying to start the session
-        // so let's see if there's a custom session save handler. Proceed with caution
-        if ($this->initializeSessionSaveHandlerStatus() === false) {
-            throw new ErrorException(
-                esc_html__('Failed to initialize session save handler status', 'event_espresso'),
-                0,
-                E_WARNING,
-                __FILE__,
-                __LINE__
-            );
-        }
-        // hold your breath, the custom session save handler might cause a fatal here...
-        $this->sessionStart();
-        // phew! we made it! the custom session handler is a-ok
-        if ($this->setSessionSaveHandlerStatusToValid() === false) {
-            throw new ErrorException(
-                esc_html__('Failed to set session save handler status to valid', 'event_espresso'),
-                0,
-                E_WARNING,
-                __FILE__,
-                __LINE__
-            );
-        }
-    }
-
-
-    /**
-     * retrieves the value for the 'ee_session_save_handler_status' WP option.
-     * default value = 'session_save_handler_untested'
-     *
-     * @return string
-     * @since 4.9.68.p
-     */
-    private function getSessionSaveHandlerStatus(): string
-    {
-        return get_option(
-            SessionStartHandler::OPTION_NAME_SESSION_SAVE_HANDLER_STATUS,
-            SessionStartHandler::SESSION_SAVE_HANDLER_STATUS_UNKNOWN
-        );
-    }
-
-
-    /**
-     * Sets the 'ee_session_save_handler_status' WP option value to 'session_save_handler_failed'
-     * which can then be upgraded is everything works correctly
-     *
-     * @return bool
-     * @since 4.9.68.p
-     */
-    private function initializeSessionSaveHandlerStatus(): bool
-    {
-        return update_option(
-            SessionStartHandler::OPTION_NAME_SESSION_SAVE_HANDLER_STATUS,
-            SessionStartHandler::SESSION_SAVE_HANDLER_STATUS_FAILED
-        );
-    }
-
-
-    /**
-     * Sets the 'ee_session_save_handler_status' WP option value to 'session_save_handler_success'
-     *
-     * @return bool
-     * @since 4.9.68.p
-     */
-    private function setSessionSaveHandlerStatusToValid(): bool
-    {
-        return update_option(
-            SessionStartHandler::OPTION_NAME_SESSION_SAVE_HANDLER_STATUS,
-            SessionStartHandler::SESSION_SAVE_HANDLER_STATUS_SUCCESS
-        );
-    }
-
-
-    /**
-     * Sets the 'ee_session_save_handler_status' WP option value to 'session_save_handler_untested'
-     *
-     * @return bool
-     * @since 4.9.68.p
-     */
-    private function resetSessionSaveHandlerStatus(): bool
-    {
-        return update_option(
-            SessionStartHandler::OPTION_NAME_SESSION_SAVE_HANDLER_STATUS,
-            SessionStartHandler::SESSION_SAVE_HANDLER_STATUS_UNKNOWN
-        );
-    }
-
-
-    /**
-     * Returns `true` if the 'ee_session_save_handler_status' WP option value
-     * is equal to 'session_save_handler_success'
-     *
-     * @return bool
-     * @since 4.9.68.p
-     */
-    private function sessionSaveHandlerIsValid(): bool
-    {
-        return $this->getSessionSaveHandlerStatus() === SessionStartHandler::SESSION_SAVE_HANDLER_STATUS_SUCCESS;
-    }
-
-
-    /**
-     * Returns `true` if the 'ee_session_save_handler_status' WP option value
-     * is equal to 'session_save_handler_failed'
-     *
-     * @return bool
-     * @since 4.9.68.p
-     */
-    private function sessionSaveHandlerFailed(): bool
-    {
-        return $this->getSessionSaveHandlerStatus() === SessionStartHandler::SESSION_SAVE_HANDLER_STATUS_FAILED;
-    }
-
-
-    /**
-     * @param int    $severity
-     * @param string $message
-     * @param string $file
-     * @param int    $line
-     * @return bool
-     * @throws ErrorException
-     * @since 5.0.46
-     */
-    public function customErrorHandler(int $severity, string $message, string $file, int $line): bool
-    {
-        // Only convert warnings we care about
-        if (($severity & E_WARNING) === E_WARNING) {
-            throw new ErrorException($message, 0, $severity, $file, $line);
-        }
-        // fallback to PHP's normal handler for other severities
-        return false;
-    }
-
-
-    /**
-     * @param callable|null $previous_handler
-     * @return void
-     * @since 5.0.46
-     */
-    private function restorePreviousErrorHandler(?callable $previous_handler): void
-    {
-        if ($previous_handler !== null) {
-            set_error_handler($previous_handler);
-        } else {
-            restore_error_handler();
-        }
-    }
-
-
-    /**
-     * Returns `true` if no errors were detected with the session save handler,
-     * otherwise attempts to work notify the appropriate authorities
-     * with a suggestion for how to fix the issue, and returns `false`.
-     *
-     * @return bool
-     * @throws ErrorException
-     * @throws Throwable
-     * @since 4.9.68.p
-     */
-    private function handleSessionSaveHandlerErrors(): bool
-    {
-        // Check if we had a fatal error last time while trying to start the session
-        if ($this->sessionSaveHandlerFailed()) {
-            // apparently, last time we tried using the custom session save handler there was a fatal
-            if ($this->request->requestParamIsSet(SessionStartHandler::REQUEST_PARAM_RETRY_SESSION)) {
-                if ($this->resetSessionSaveHandlerStatus() === false) {
-                    throw new ErrorException(
-                        esc_html__('Failed to reset session save handler status', 'event_espresso'),
-                        0,
-                        E_WARNING,
-                        __FILE__,
-                        __LINE__
-                    );
-                }
-                // remove "ee_retry_session", otherwise if the problem still isn't fixed,
-                // we'll just keep getting the fatal error over and over.
-                // Better to remove it and redirect, and try on the next request
-                EEH_URL::safeRedirectAndExit(
-                    remove_query_arg(
-                        [SessionStartHandler::REQUEST_PARAM_RETRY_SESSION],
-                        EEH_URL::current_url()
-                    )
-                );
-            }
-            // so the session is broken, don't try it again,
-            // just show a message to users that can fix it
-            $this->displaySessionSaveHandlerErrorNotice();
-            return false;
-        }
-        return true;
-    }
-
-
-    /**
-     * @since 4.9.68.p
-     */
-    private function displaySessionSaveHandlerErrorNotice(): void
-    {
-        $retry_session_url = add_query_arg(
-            [SessionStartHandler::REQUEST_PARAM_RETRY_SESSION => true],
-            EEH_URL::current_url()
-        );
-        $this->displaySessionErrorNotice(
-            sprintf(
-                esc_html__(
-                    'It appears there was a fatal error while starting the session, so Event Espresso is not able to process registrations normally. Some hosting companies, like Pantheon, require an extra plugin for Event Espresso to work. Please install the %1$sWordPress Native PHP Sessions plugin%2$s, then %3$sclick here to check if the problem is resolved.%2$s',
-                    'event_espresso'
-                ),
-                '<a href="https://wordpress.org/plugins/wp-native-php-sessions/">',
-                '</a>',
-                '<a href="' . $retry_session_url . '">'
-            ),
-            __FILE__,
-            __FUNCTION__,
-            __LINE__
-        );
-    }
-
-
-    /**
-     * Generates an EE_Error notice regarding the current session woes
-     * but only if the current user is an admin with permission to 'install_plugins'.
-     *
-     * @since 5.0.46
-     */
-    private function displaySessionErrorNotice(string $message, string $file, string $function, int $line): void
-    {
-        if (current_user_can('install_plugins')) {
-            EE_Error::add_error($message, $file, $function, $line);
-        }
-    }
+	const OPTION_NAME_SESSION_SAVE_HANDLER_STATUS = 'ee_session_save_handler_status';
+
+	const REQUEST_PARAM_RETRY_SESSION             = 'ee_retry_session';
+
+	const SESSION_SAVE_HANDLER_STATUS_FAILED      = 'session_save_handler_failed';
+
+	const SESSION_SAVE_HANDLER_STATUS_SUCCESS     = 'session_save_handler_success';
+
+	const SESSION_SAVE_HANDLER_STATUS_UNKNOWN     = 'session_save_handler_untested';
+
+
+	protected RequestInterface $request;
+
+	/**
+	 * @var string
+	 * @since 5.0.47
+	 */
+	private string $open_basedir = '';
+
+	/**
+	 * @var string
+	 * @since 5.0.47
+	 */
+	private string $save_handler = '';
+
+	/**
+	 * @var string
+	 * @since 5.0.47
+	 */
+	private string $save_path = '';
+
+	/**
+	 * When true, verification of session save path filesystem checks was skipped
+	 * because open_basedir prevented validation.
+	 *
+	 * @var bool
+	 * @since 5.0.48
+	 */
+	private bool $skip_save_path_checks = false;
+
+	/**
+	 * @var bool
+	 * @since 5.0.48
+	 */
+	private bool $logging_enabled;
+
+
+	/**
+	 * StartSession constructor.
+	 *
+	 * @param RequestInterface $request
+	 */
+	public function __construct(RequestInterface $request)
+	{
+		$this->request = $request;
+		// only log session details in staging and production environments
+		$environment           = wp_get_environment_type();
+		$this->logging_enabled = WP_DEBUG && ($environment === 'staging' || $environment === 'production');
+	}
+
+
+	/**
+	 * Check if a custom session save handler is in play
+	 * and attempt to start the PHP session
+	 *
+	 * @since 4.9.68.p
+	 */
+	public function startSession(): int
+	{
+		// check that session has started
+		if (session_id() === '') {
+			// clear any previous error
+			error_clear_last();
+
+			// convert warnings to ErrorException so we can catch them
+			$previous_handler = set_error_handler([$this, 'customErrorHandler'], E_WARNING);
+
+			try {
+				$this->initializeSessionVars();
+				// starts a new session if one doesn't already exist, or re-initiates an existing one
+				if ($this->hasCustomSessionSaveHandler()) {
+					$this->checkCustomSessionSaveHandler();
+				} else {
+					$this->verifySessionSavePath();
+					$this->sessionStart();
+				}
+			} catch (Throwable $error) {
+				if ($this->logging_enabled) {
+					error_log(
+						sprintf(
+							'[SessionStartHandler] session_start() warning: %s in %s:%s',
+							$error->getMessage(),
+							$error->getFile(),
+							$error->getLine()
+						)
+					);
+				}
+				$this->displaySessionErrorNotice(
+					$error->getMessage(),
+					$error->getFile(),
+					__FUNCTION__,
+					$error->getLine()
+				);
+			} finally {
+				$this->restorePreviousErrorHandler($previous_handler);
+			}
+		}
+		return session_status();
+	}
+
+
+	/**
+	 * @return void
+	 * @since 5.0.47
+	 */
+	private function initializeSessionVars(): void
+	{
+		$this->open_basedir = ini_get('open_basedir') ?: '';
+		$this->save_handler = strtolower((string) ini_get('session.save_handler'));
+		$this->save_path    = session_save_path() ?: '';
+	}
+
+
+	/**
+	 * @return void
+	 * @throws Throwable
+	 * @since 5.0.46
+	 */
+	private function sessionStart(): void
+	{
+		session_start();
+		session_write_close();
+	}
+
+
+	/**
+	 * @return void
+	 * @throws ErrorException
+	 * @since 5.0.46
+	 */
+	private function verifySessionSavePath(): void
+	{
+		if ($this->logging_enabled) {
+			error_log(
+				sprintf(
+					"[SessionStartHandler] diagnostic: save_handler=%s save_path=%s open_basedir=%s",
+					$this->save_handler,
+					$this->save_path,
+					$this->open_basedir ?: '(none)'
+				)
+			);
+		}
+		// Only validate the session save path as a filesystem directory when PHP is
+		// configured to use the 'files' session save handler. Other handlers
+		// (memcache, memcached, redis, user, etc.) use different transport
+		// formats (hosts, sockets, URIs) and are not filesystem directories.
+		if ($this->save_handler !== 'files') {
+			// assume the configured handler knows how to interpret the save path
+			// (e.g. "unix:///run/memcached/memcached.sock", "127.0.0.1:11211", etc.)
+			return;
+		}
+		$this->save_path = $this->normalizeSessionSavePath($this->save_path);
+		// If we were unable to safely validate the session save path because it
+		// appears to live outside PHP's open_basedir, skip filesystem checks to
+		// avoid emitting warnings or throwing exceptions on some hosts.
+		if ($this->skip_save_path_checks === true) {
+			if ($this->logging_enabled) {
+				error_log(
+					sprintf(
+						'[SessionStartHandler] skipped session_save_path filesystem validation due to open_basedir: %s',
+						$this->save_path
+					)
+				);
+			}
+			return;
+		}
+		// Use @-suppressed checks to avoid PHP warnings while validating.
+		if (! @is_dir($this->save_path) || ! @is_writable($this->save_path)) {
+			throw new ErrorException(
+				sprintf(
+					esc_html__('Invalid or missing session save path: %s', 'event_espresso'),
+					$this->save_path
+				),
+				0,
+				E_WARNING,
+				__FILE__,
+				__LINE__
+			);
+		}
+	}
+
+
+	/**
+	 * @param string $session_save_path
+	 * @return string
+	 * @since 5.0.47
+	 */
+	private function normalizeSessionSavePath(string $session_save_path): string
+	{
+		// Normalize "N;/path" style values
+		if (strpos($session_save_path, ';') !== false) {
+			$parts             = explode(';', $session_save_path);
+			$session_save_path = end($parts);
+		}
+		$session_save_path = trim((string) $session_save_path);
+		if ($session_save_path === '') {
+			// fall back to a sane temp dir if PHP reports no explicit session_save_path
+			$session_save_path = sys_get_temp_dir();
+		}
+		// normalize trailing separators
+		$session_save_path = rtrim($session_save_path, DIRECTORY_SEPARATOR) . DIRECTORY_SEPARATOR;
+		// For 'files' handler we expect a writable filesystem directory.
+		// However, calling realpath() or is_dir() on paths outside of PHP's
+		// configured open_basedir can trigger warnings.
+		// Handle that case explicitly by checking open_basedir first
+		// and avoiding functions that would emit warnings.
+		if ($this->open_basedir !== '') {
+			$session_save_path = $this->checkPathsOutsideBaseDir($session_save_path);
+		} else {
+			// No open_basedir restriction; realpath() is safe to use and gives
+			// us a canonical path for the directory checks.
+			$session_save_path = @realpath($session_save_path) ?: $session_save_path;
+		}
+		return $session_save_path;
+	}
+
+
+	/**
+	 * @param string $session_save_path
+	 * @return string
+	 * @since 5.0.47
+	 */
+	private function checkPathsOutsideBaseDir(string $session_save_path): string
+	{
+		// open_basedir is set; check whether the configured session path
+		// appears to be within one of the allowed paths.
+		$allowed_paths = array_filter(array_map('trim', explode(PATH_SEPARATOR, $this->open_basedir)));
+		$allowed       = false;
+		foreach ($allowed_paths as $allowed_path) {
+			if ($allowed_path === '') {
+				continue;
+			}
+			// normalize trailing separators for comparison
+			$allowed_path_norm = rtrim($allowed_path, DIRECTORY_SEPARATOR) . DIRECTORY_SEPARATOR;
+			// compare start of paths for a match
+			if (strncmp($session_save_path, $allowed_path_norm, strlen($allowed_path_norm)) === 0) {
+				$allowed = true;
+				break;
+			}
+		}
+		if ($allowed) {
+			return $session_save_path;
+		}
+		// open_basedir is set and the session save path is outside it.
+		// Log for diagnostics and skip strict filesystem checks rather than
+		// throwing an exception which causes fatal behavior on some hosts.
+		if ($this->logging_enabled) {
+			error_log(
+				sprintf(
+					"[SessionStartHandler] session_save_path outside open_basedir: save_path=%s open_basedir=%s - skipping validation",
+					$session_save_path,
+					$this->open_basedir
+				)
+			);
+		}
+		$this->skip_save_path_checks = true;
+		return $session_save_path;
+	}
+
+
+	/**
+	 * Returns `true` if the 'session.save_handler' ini setting matches a known custom handler
+	 *
+	 * @return bool
+	 * @since 4.9.68.p
+	 */
+	private function hasCustomSessionSaveHandler(): bool
+	{
+		return $this->save_handler === 'user';
+	}
+
+
+	/**
+	 * Attempt to start the PHP session when a custom Session Save Handler is known to be set.
+	 *
+	 * @throws ErrorException
+	 * @throws Throwable
+	 * @since 4.9.68.p
+	 */
+	private function checkCustomSessionSaveHandler(): void
+	{
+		// If we've already successfully tested the session save handler
+		// on a previous request then just start the session
+		if ($this->sessionSaveHandlerIsValid()) {
+			$this->sessionStart();
+			return;
+		}
+		// If not, then attempt to deal with any errors,
+		// otherwise, try to hobble along without the session
+		if (! $this->handleSessionSaveHandlerErrors()) {
+			return;
+		}
+		// there is no record of a fatal error while trying to start the session
+		// so let's see if there's a custom session save handler. Proceed with caution
+		if ($this->initializeSessionSaveHandlerStatus() === false) {
+			throw new ErrorException(
+				esc_html__('Failed to initialize session save handler status', 'event_espresso'),
+				0,
+				E_WARNING,
+				__FILE__,
+				__LINE__
+			);
+		}
+		// hold your breath, the custom session save handler might cause a fatal here...
+		$this->sessionStart();
+		// phew! we made it! the custom session handler is a-ok
+		if ($this->setSessionSaveHandlerStatusToValid() === false) {
+			throw new ErrorException(
+				esc_html__('Failed to set session save handler status to valid', 'event_espresso'),
+				0,
+				E_WARNING,
+				__FILE__,
+				__LINE__
+			);
+		}
+	}
+
+
+	/**
+	 * retrieves the value for the 'ee_session_save_handler_status' WP option.
+	 * default value = 'session_save_handler_untested'
+	 *
+	 * @return string
+	 * @since 4.9.68.p
+	 */
+	private function getSessionSaveHandlerStatus(): string
+	{
+		return get_option(
+			SessionStartHandler::OPTION_NAME_SESSION_SAVE_HANDLER_STATUS,
+			SessionStartHandler::SESSION_SAVE_HANDLER_STATUS_UNKNOWN
+		);
+	}
+
+
+	/**
+	 * Sets the 'ee_session_save_handler_status' WP option value to 'session_save_handler_failed'
+	 * which can then be upgraded is everything works correctly
+	 *
+	 * @return bool
+	 * @since 4.9.68.p
+	 */
+	private function initializeSessionSaveHandlerStatus(): bool
+	{
+		return update_option(
+			SessionStartHandler::OPTION_NAME_SESSION_SAVE_HANDLER_STATUS,
+			SessionStartHandler::SESSION_SAVE_HANDLER_STATUS_FAILED
+		);
+	}
+
+
+	/**
+	 * Sets the 'ee_session_save_handler_status' WP option value to 'session_save_handler_success'
+	 *
+	 * @return bool
+	 * @since 4.9.68.p
+	 */
+	private function setSessionSaveHandlerStatusToValid(): bool
+	{
+		return update_option(
+			SessionStartHandler::OPTION_NAME_SESSION_SAVE_HANDLER_STATUS,
+			SessionStartHandler::SESSION_SAVE_HANDLER_STATUS_SUCCESS
+		);
+	}
+
+
+	/**
+	 * Sets the 'ee_session_save_handler_status' WP option value to 'session_save_handler_untested'
+	 *
+	 * @return bool
+	 * @since 4.9.68.p
+	 */
+	private function resetSessionSaveHandlerStatus(): bool
+	{
+		return update_option(
+			SessionStartHandler::OPTION_NAME_SESSION_SAVE_HANDLER_STATUS,
+			SessionStartHandler::SESSION_SAVE_HANDLER_STATUS_UNKNOWN
+		);
+	}
+
+
+	/**
+	 * Returns `true` if the 'ee_session_save_handler_status' WP option value
+	 * is equal to 'session_save_handler_success'
+	 *
+	 * @return bool
+	 * @since 4.9.68.p
+	 */
+	private function sessionSaveHandlerIsValid(): bool
+	{
+		return $this->getSessionSaveHandlerStatus() === SessionStartHandler::SESSION_SAVE_HANDLER_STATUS_SUCCESS;
+	}
+
+
+	/**
+	 * Returns `true` if the 'ee_session_save_handler_status' WP option value
+	 * is equal to 'session_save_handler_failed'
+	 *
+	 * @return bool
+	 * @since 4.9.68.p
+	 */
+	private function sessionSaveHandlerFailed(): bool
+	{
+		return $this->getSessionSaveHandlerStatus() === SessionStartHandler::SESSION_SAVE_HANDLER_STATUS_FAILED;
+	}
+
+
+	/**
+	 * @param int    $severity
+	 * @param string $message
+	 * @param string $file
+	 * @param int    $line
+	 * @return bool
+	 * @throws ErrorException
+	 * @since 5.0.46
+	 */
+	public function customErrorHandler(int $severity, string $message, string $file, int $line): bool
+	{
+		// Only convert warnings we care about
+		if (($severity & E_WARNING) === E_WARNING) {
+			throw new ErrorException($message, 0, $severity, $file, $line);
+		}
+		// fallback to PHP's normal handler for other severities
+		return false;
+	}
+
+
+	/**
+	 * @param callable|null $previous_handler
+	 * @return void
+	 * @since 5.0.46
+	 */
+	private function restorePreviousErrorHandler(?callable $previous_handler): void
+	{
+		if ($previous_handler !== null) {
+			set_error_handler($previous_handler);
+		} else {
+			restore_error_handler();
+		}
+	}
+
+
+	/**
+	 * Returns `true` if no errors were detected with the session save handler,
+	 * otherwise attempts to work notify the appropriate authorities
+	 * with a suggestion for how to fix the issue, and returns `false`.
+	 *
+	 * @return bool
+	 * @throws ErrorException
+	 * @throws Throwable
+	 * @since 4.9.68.p
+	 */
+	private function handleSessionSaveHandlerErrors(): bool
+	{
+		// Check if we had a fatal error last time while trying to start the session
+		if ($this->sessionSaveHandlerFailed()) {
+			// apparently, last time we tried using the custom session save handler there was a fatal
+			if ($this->request->requestParamIsSet(SessionStartHandler::REQUEST_PARAM_RETRY_SESSION)) {
+				if ($this->resetSessionSaveHandlerStatus() === false) {
+					throw new ErrorException(
+						esc_html__('Failed to reset session save handler status', 'event_espresso'),
+						0,
+						E_WARNING,
+						__FILE__,
+						__LINE__
+					);
+				}
+				// remove "ee_retry_session", otherwise if the problem still isn't fixed,
+				// we'll just keep getting the fatal error over and over.
+				// Better to remove it and redirect, and try on the next request
+				EEH_URL::safeRedirectAndExit(
+					remove_query_arg(
+						[SessionStartHandler::REQUEST_PARAM_RETRY_SESSION],
+						EEH_URL::current_url()
+					)
+				);
+			}
+			// so the session is broken, don't try it again,
+			// just show a message to users that can fix it
+			$this->displaySessionSaveHandlerErrorNotice();
+			return false;
+		}
+		return true;
+	}
+
+
+	/**
+	 * @since 4.9.68.p
+	 */
+	private function displaySessionSaveHandlerErrorNotice(): void
+	{
+		$retry_session_url = add_query_arg(
+			[SessionStartHandler::REQUEST_PARAM_RETRY_SESSION => true],
+			EEH_URL::current_url()
+		);
+		$this->displaySessionErrorNotice(
+			sprintf(
+				esc_html__(
+					'It appears there was a fatal error while starting the session, so Event Espresso is not able to process registrations normally. Some hosting companies, like Pantheon, require an extra plugin for Event Espresso to work. Please install the %1$sWordPress Native PHP Sessions plugin%2$s, then %3$sclick here to check if the problem is resolved.%2$s',
+					'event_espresso'
+				),
+				'<a href="https://wordpress.org/plugins/wp-native-php-sessions/">',
+				'</a>',
+				'<a href="' . $retry_session_url . '">'
+			),
+			__FILE__,
+			__FUNCTION__,
+			__LINE__
+		);
+	}
+
+
+	/**
+	 * Generates an EE_Error notice regarding the current session woes
+	 * but only if the current user is an admin with permission to 'install_plugins'.
+	 *
+	 * @since 5.0.46
+	 */
+	private function displaySessionErrorNotice(string $message, string $file, string $function, int $line): void
+	{
+		if (current_user_can('install_plugins')) {
+			EE_Error::add_error($message, $file, $function, $line);
+		}
+	}
 }

Spacing +5 added lines, -5 removed lines

@@ -206,7 +206,7 @@ 
             return;
         }
         // Use @-suppressed checks to avoid PHP warnings while validating.
-        if (! @is_dir($this->save_path) || ! @is_writable($this->save_path)) {
+        if ( ! @is_dir($this->save_path) || ! @is_writable($this->save_path)) {
             throw new ErrorException(
                 sprintf(
                     esc_html__('Invalid or missing session save path: %s', 'event_espresso'),
@@ -239,7 +239,7 @@ 
             $session_save_path = sys_get_temp_dir();
         }
         // normalize trailing separators
-        $session_save_path = rtrim($session_save_path, DIRECTORY_SEPARATOR) . DIRECTORY_SEPARATOR;
+        $session_save_path = rtrim($session_save_path, DIRECTORY_SEPARATOR).DIRECTORY_SEPARATOR;
         // For 'files' handler we expect a writable filesystem directory.
         // However, calling realpath() or is_dir() on paths outside of PHP's
         // configured open_basedir can trigger warnings.
@@ -272,7 +272,7 @@ 
                 continue;
             }
             // normalize trailing separators for comparison
-            $allowed_path_norm = rtrim($allowed_path, DIRECTORY_SEPARATOR) . DIRECTORY_SEPARATOR;
+            $allowed_path_norm = rtrim($allowed_path, DIRECTORY_SEPARATOR).DIRECTORY_SEPARATOR;
             // compare start of paths for a match
             if (strncmp($session_save_path, $allowed_path_norm, strlen($allowed_path_norm)) === 0) {
                 $allowed = true;
@@ -328,7 +328,7 @@ 
         }
         // If not, then attempt to deal with any errors,
         // otherwise, try to hobble along without the session
-        if (! $this->handleSessionSaveHandlerErrors()) {
+        if ( ! $this->handleSessionSaveHandlerErrors()) {
             return;
         }
         // there is no record of a fatal error while trying to start the session
@@ -541,7 +541,7 @@ 
                 ),
                 '<a href="https://wordpress.org/plugins/wp-native-php-sessions/">',
                 '</a>',
-                '<a href="' . $retry_session_url . '">'
+                '<a href="'.$retry_session_url.'">'
             ),
             __FILE__,
             __FUNCTION__,

core/services/payments/PaymentProcessorFees.php

Indentation +207 added lines, -207 removed lines

@@ -30,211 +30,211 @@
  */
 class PaymentProcessorFees
 {
-    public const  GATEWAY_PAYPAL  = 'PayPal Commerce';
-
-    public const  GATEWAY_SQUARE  = 'Square';
-
-    public const  GATEWAY_STRIPE  = 'Stripe';
-
-    private GracePeriod $grace_period;
-
-    private LicenseData $license_data;
-
-    /**
-     * @var float[][] $gateway_fees
-     */
-    private array $gateway_fees = [
-        LicenseStatus::ACTIVE  => [
-            PaymentProcessorFees::GATEWAY_PAYPAL => 0.00,
-            PaymentProcessorFees::GATEWAY_SQUARE => 0.00,
-            PaymentProcessorFees::GATEWAY_STRIPE => 0.00,
-        ],
-        LicenseStatus::EXPIRED => [
-            PaymentProcessorFees::GATEWAY_PAYPAL => 3.00,
-            PaymentProcessorFees::GATEWAY_SQUARE => 3.00,
-            PaymentProcessorFees::GATEWAY_STRIPE => 3.00,
-        ],
-        LicenseStatus::DECAF   => [
-            PaymentProcessorFees::GATEWAY_PAYPAL => 3.00,
-            PaymentProcessorFees::GATEWAY_SQUARE => 3.00,
-            PaymentProcessorFees::GATEWAY_STRIPE => 3.00,
-        ],
-    ];
-
-    private array $partner_gateways = [
-        PaymentProcessorFees::GATEWAY_PAYPAL,
-        PaymentProcessorFees::GATEWAY_SQUARE,
-        PaymentProcessorFees::GATEWAY_STRIPE,
-    ];
-
-
-    /**
-     * @param GracePeriod $grace_period
-     * @param LicenseData $license_data
-     */
-    public function __construct(GracePeriod $grace_period, LicenseData $license_data)
-    {
-        $this->grace_period = $grace_period;
-        $this->license_data = $license_data;
-    }
-
-
-    /**
-     * @param EE_Transaction $transaction
-     * @param string         $payment_method_name
-     * @param float          $amount
-     * @return float
-     * @throws EE_Error|ReflectionException|RuntimeException
-     * @throws Exception
-     */
-    public function applyGatewayPartnerFees(
-        EE_Transaction $transaction,
-        string $payment_method_name,
-        float $amount = 0.00
-    ): float {
-        $processing_fee = $this->forPaymentMethod($payment_method_name);
-        if ($processing_fee <= 0.00) {
-            return $amount;
-        }
-        $grand_total = $transaction->total_line_item(false);
-        if (
-            ! $grand_total instanceof EE_Line_Item
-            || ! $grand_total->is_total()
-            || $grand_total->TXN_ID() !== $transaction->ID()
-        ) {
-            // throw RuntimeException if total_line_item is not a total line item
-            throw new RuntimeException(
-                sprintf(
-                    esc_html__(
-                        'Invalid or missing grand total line item for transaction %1$d.',
-                        'event_espresso'
-                    ),
-                    $transaction->ID()
-                )
-            );
-        }
-        $line_item = EEH_Line_Item::add_percentage_based_item(
-            EEH_Line_Item::get_pre_tax_subtotal($grand_total),
-            esc_html__('Payment Processing Fee', 'event_espresso'),
-            $processing_fee,
-            '',
-            false,
-            sanitize_key(
-                sprintf(
-                    '%1$s-fee-%2$d',
-                    $payment_method_name,
-                    $transaction->ID()
-                )
-            ),
-            true
-        );
-        $line_item->save();
-        return $grand_total->recalculate_total_including_taxes();
-    }
-
-
-    /**
-     * Returns the fee for a specific payment method based on the license status.
-     *
-     * @param string $payment_method_name
-     * @return float
-     * @throws Exception|OutOfBoundsException|RuntimeException
-     */
-    public function forPaymentMethod(string $payment_method_name): float
-    {
-        if (! $this->isPartnerGateway($payment_method_name)) {
-            return 0.0;
-        }
-        $license_status = $this->license_data->licenseStatus();
-        $license_expires = $this->license_data->licenseExpiry();
-        // decaf, new activations, or expired licenses are allowed a grace period
-        if ($this->grace_period->withinGracePeriod($license_status, $license_expires)) {
-            return 0.0;
-        }
-        return $this->getGatewayFee($payment_method_name, $license_status);
-    }
-
-
-    /**
-     * Checks if a gateway is a partner gateway.
-     *
-     * @param string $payment_method_name
-     * @return bool
-     */
-    public function isPartnerGateway(string $payment_method_name): bool
-    {
-        return in_array($payment_method_name, $this->partner_gateways, true);
-    }
-
-
-    /**
-     * Returns the fee for a specific payment method based on the license status.
-     *
-     * @param string $payment_method_name
-     * @param string $license_status
-     * @return float
-     * @throws OutOfBoundsException
-     */
-    private function getGatewayFee(string $payment_method_name, string $license_status): float
-    {
-        if (isset($this->gateway_fees[ $license_status ][ $payment_method_name ])) {
-            return $this->gateway_fees[ $license_status ][ $payment_method_name ];
-        }
-        throw new OutOfBoundsException(
-            sprintf(
-                esc_html__('A partner fee for %1$s with %2$s license is not defined.', 'event_espresso'),
-                $payment_method_name,
-                $license_status
-            )
-        );
-    }
-
-
-    /**
-     * Get fees notice.
-     *
-     * @param $pm_name
-     * @return EE_Form_Section_HTML
-     */
-    public function getFeesNotice($pm_name): EE_Form_Section_HTML
-    {
-        $active  = $this->gateway_fees[ LicenseStatus::ACTIVE ][ $pm_name ] ?? 0;
-        $expired = $this->gateway_fees[ LicenseStatus::EXPIRED ][ $pm_name ] ?? 3;
-        return new EE_Form_Section_HTML(
-            EEH_HTML::tr(
-                EEH_HTML::th()
-                . EEH_HTML::thx()
-                . EEH_HTML::td(
-                    EEH_HTML::div(
-                        EEH_HTML::strong(
-                            esc_html__(
-                                "$pm_name Application Fees are based upon the status of your Support License:",
-                                'event_espresso'
-                            )
-                        )
-                        . EEH_HTML::ul()
-                        . EEH_HTML::li(
-                            sprintf(
-                                esc_html__('- Active licenses commission fees: %1$s', 'event_espresso'),
-                                "$active%"
-                            )
-                        )
-                        . EEH_HTML::li(
-                            sprintf(
-                                esc_html__('- Expired license commission fees: %1$s', 'event_espresso'),
-                                "$expired%"
-                            )
-                        )
-                        . EEH_HTML::ulx()
-                        . esc_html__(
-                            'Keep your support license active for: lower fees, up-to-date software and have access to our support team. By connecting and processing payments you agree to these terms.',
-                            'event_espresso'
-                        ),
-                        '',
-                        'ee-status-outline ee-status-bg--info'
-                    )
-                )
-            )
-        );
-    }
+	public const  GATEWAY_PAYPAL  = 'PayPal Commerce';
+
+	public const  GATEWAY_SQUARE  = 'Square';
+
+	public const  GATEWAY_STRIPE  = 'Stripe';
+
+	private GracePeriod $grace_period;
+
+	private LicenseData $license_data;
+
+	/**
+	 * @var float[][] $gateway_fees
+	 */
+	private array $gateway_fees = [
+		LicenseStatus::ACTIVE  => [
+			PaymentProcessorFees::GATEWAY_PAYPAL => 0.00,
+			PaymentProcessorFees::GATEWAY_SQUARE => 0.00,
+			PaymentProcessorFees::GATEWAY_STRIPE => 0.00,
+		],
+		LicenseStatus::EXPIRED => [
+			PaymentProcessorFees::GATEWAY_PAYPAL => 3.00,
+			PaymentProcessorFees::GATEWAY_SQUARE => 3.00,
+			PaymentProcessorFees::GATEWAY_STRIPE => 3.00,
+		],
+		LicenseStatus::DECAF   => [
+			PaymentProcessorFees::GATEWAY_PAYPAL => 3.00,
+			PaymentProcessorFees::GATEWAY_SQUARE => 3.00,
+			PaymentProcessorFees::GATEWAY_STRIPE => 3.00,
+		],
+	];
+
+	private array $partner_gateways = [
+		PaymentProcessorFees::GATEWAY_PAYPAL,
+		PaymentProcessorFees::GATEWAY_SQUARE,
+		PaymentProcessorFees::GATEWAY_STRIPE,
+	];
+
+
+	/**
+	 * @param GracePeriod $grace_period
+	 * @param LicenseData $license_data
+	 */
+	public function __construct(GracePeriod $grace_period, LicenseData $license_data)
+	{
+		$this->grace_period = $grace_period;
+		$this->license_data = $license_data;
+	}
+
+
+	/**
+	 * @param EE_Transaction $transaction
+	 * @param string         $payment_method_name
+	 * @param float          $amount
+	 * @return float
+	 * @throws EE_Error|ReflectionException|RuntimeException
+	 * @throws Exception
+	 */
+	public function applyGatewayPartnerFees(
+		EE_Transaction $transaction,
+		string $payment_method_name,
+		float $amount = 0.00
+	): float {
+		$processing_fee = $this->forPaymentMethod($payment_method_name);
+		if ($processing_fee <= 0.00) {
+			return $amount;
+		}
+		$grand_total = $transaction->total_line_item(false);
+		if (
+			! $grand_total instanceof EE_Line_Item
+			|| ! $grand_total->is_total()
+			|| $grand_total->TXN_ID() !== $transaction->ID()
+		) {
+			// throw RuntimeException if total_line_item is not a total line item
+			throw new RuntimeException(
+				sprintf(
+					esc_html__(
+						'Invalid or missing grand total line item for transaction %1$d.',
+						'event_espresso'
+					),
+					$transaction->ID()
+				)
+			);
+		}
+		$line_item = EEH_Line_Item::add_percentage_based_item(
+			EEH_Line_Item::get_pre_tax_subtotal($grand_total),
+			esc_html__('Payment Processing Fee', 'event_espresso'),
+			$processing_fee,
+			'',
+			false,
+			sanitize_key(
+				sprintf(
+					'%1$s-fee-%2$d',
+					$payment_method_name,
+					$transaction->ID()
+				)
+			),
+			true
+		);
+		$line_item->save();
+		return $grand_total->recalculate_total_including_taxes();
+	}
+
+
+	/**
+	 * Returns the fee for a specific payment method based on the license status.
+	 *
+	 * @param string $payment_method_name
+	 * @return float
+	 * @throws Exception|OutOfBoundsException|RuntimeException
+	 */
+	public function forPaymentMethod(string $payment_method_name): float
+	{
+		if (! $this->isPartnerGateway($payment_method_name)) {
+			return 0.0;
+		}
+		$license_status = $this->license_data->licenseStatus();
+		$license_expires = $this->license_data->licenseExpiry();
+		// decaf, new activations, or expired licenses are allowed a grace period
+		if ($this->grace_period->withinGracePeriod($license_status, $license_expires)) {
+			return 0.0;
+		}
+		return $this->getGatewayFee($payment_method_name, $license_status);
+	}
+
+
+	/**
+	 * Checks if a gateway is a partner gateway.
+	 *
+	 * @param string $payment_method_name
+	 * @return bool
+	 */
+	public function isPartnerGateway(string $payment_method_name): bool
+	{
+		return in_array($payment_method_name, $this->partner_gateways, true);
+	}
+
+
+	/**
+	 * Returns the fee for a specific payment method based on the license status.
+	 *
+	 * @param string $payment_method_name
+	 * @param string $license_status
+	 * @return float
+	 * @throws OutOfBoundsException
+	 */
+	private function getGatewayFee(string $payment_method_name, string $license_status): float
+	{
+		if (isset($this->gateway_fees[ $license_status ][ $payment_method_name ])) {
+			return $this->gateway_fees[ $license_status ][ $payment_method_name ];
+		}
+		throw new OutOfBoundsException(
+			sprintf(
+				esc_html__('A partner fee for %1$s with %2$s license is not defined.', 'event_espresso'),
+				$payment_method_name,
+				$license_status
+			)
+		);
+	}
+
+
+	/**
+	 * Get fees notice.
+	 *
+	 * @param $pm_name
+	 * @return EE_Form_Section_HTML
+	 */
+	public function getFeesNotice($pm_name): EE_Form_Section_HTML
+	{
+		$active  = $this->gateway_fees[ LicenseStatus::ACTIVE ][ $pm_name ] ?? 0;
+		$expired = $this->gateway_fees[ LicenseStatus::EXPIRED ][ $pm_name ] ?? 3;
+		return new EE_Form_Section_HTML(
+			EEH_HTML::tr(
+				EEH_HTML::th()
+				. EEH_HTML::thx()
+				. EEH_HTML::td(
+					EEH_HTML::div(
+						EEH_HTML::strong(
+							esc_html__(
+								"$pm_name Application Fees are based upon the status of your Support License:",
+								'event_espresso'
+							)
+						)
+						. EEH_HTML::ul()
+						. EEH_HTML::li(
+							sprintf(
+								esc_html__('- Active licenses commission fees: %1$s', 'event_espresso'),
+								"$active%"
+							)
+						)
+						. EEH_HTML::li(
+							sprintf(
+								esc_html__('- Expired license commission fees: %1$s', 'event_espresso'),
+								"$expired%"
+							)
+						)
+						. EEH_HTML::ulx()
+						. esc_html__(
+							'Keep your support license active for: lower fees, up-to-date software and have access to our support team. By connecting and processing payments you agree to these terms.',
+							'event_espresso'
+						),
+						'',
+						'ee-status-outline ee-status-bg--info'
+					)
+				)
+			)
+		);
+	}
 }

Spacing +5 added lines, -5 removed lines

@@ -142,7 +142,7 @@ 
      */
     public function forPaymentMethod(string $payment_method_name): float
     {
-        if (! $this->isPartnerGateway($payment_method_name)) {
+        if ( ! $this->isPartnerGateway($payment_method_name)) {
             return 0.0;
         }
         $license_status = $this->license_data->licenseStatus();
@@ -177,8 +177,8 @@ 
      */
     private function getGatewayFee(string $payment_method_name, string $license_status): float
     {
-        if (isset($this->gateway_fees[ $license_status ][ $payment_method_name ])) {
-            return $this->gateway_fees[ $license_status ][ $payment_method_name ];
+        if (isset($this->gateway_fees[$license_status][$payment_method_name])) {
+            return $this->gateway_fees[$license_status][$payment_method_name];
         }
         throw new OutOfBoundsException(
             sprintf(
@@ -198,8 +198,8 @@ 
      */
     public function getFeesNotice($pm_name): EE_Form_Section_HTML
     {
-        $active  = $this->gateway_fees[ LicenseStatus::ACTIVE ][ $pm_name ] ?? 0;
-        $expired = $this->gateway_fees[ LicenseStatus::EXPIRED ][ $pm_name ] ?? 3;
+        $active  = $this->gateway_fees[LicenseStatus::ACTIVE][$pm_name] ?? 0;
+        $expired = $this->gateway_fees[LicenseStatus::EXPIRED][$pm_name] ?? 3;
         return new EE_Form_Section_HTML(
             EEH_HTML::tr(
                 EEH_HTML::th()