| // +----------------------------------------------------------------------+ /** * Base class for all modules. Implements routine methods required by all modules. * * @category Visualizer * @package Module * * @since 1.0.0 */ class Visualizer_Module { /** * The instance of wpdb class. * * @since 1.0.0 * * @access protected * @var wpdb */ protected $_wpdb = null; /** * The plugin instance. * * @since 1.0.0 * * @access protected * @var Visualizer_Plugin */ protected $_plugin = null; /** * Constructor. * * @since 1.0.0 * @global wpdb $wpdb Current database connection. * * @access public * @param Visualizer_Plugin $plugin The instance of the plugin. */ public function __construct( Visualizer_Plugin $plugin ) { global $wpdb; $this->_wpdb = $wpdb; $this->_plugin = $plugin; $this->_addFilter( Visualizer_Plugin::FILTER_UNDO_REVISIONS, 'undoRevisions', 10, 2 ); $this->_addFilter( Visualizer_Plugin::FILTER_HANDLE_REVISIONS, 'handleExistingRevisions', 10, 2 ); $this->_addFilter( Visualizer_Plugin::FILTER_GET_CHART_DATA_AS, 'getDataAs', 10, 3 ); $this->_addAction( 'pre_get_posts', 'PreGetPosts' ); register_shutdown_function( array( $this, 'onShutdown' ) ); } /** * Register a shutdown hook to catch fatal errors. * * @since ? * * @access public */ public function onShutdown() { $error = error_get_last(); if ( $error && $error['type'] === E_ERROR && false !== strpos( $error['file'], 'Visualizer/' ) ) { do_action( 'themeisle_log_event', Visualizer_Plugin::NAME, sprintf( 'Critical error %s', print_r( $error, true ) ), 'error', __FILE__, __LINE__ ); } } /** * Registers an action hook. * * @since 1.0.0 * @uses add_action() To register action hook. * * @access protected * @param string $tag The name of the action to which the $method is hooked. * @param string $method The name of the method to be called. * @param bool $methodClass The root of the method. * @param int $priority optional. Used to specify the order in which the functions associated with a particular action are executed (default: 10). Lower numbers correspond with earlier execution, and functions with the same priority are executed in the order in which they were added to the action. * @param int $accepted_args optional. The number of arguments the function accept (default 1). * @return Visualizer_Module */ protected function _addAction( $tag, $method, $methodClass = null, $priority = 10, $accepted_args = 1 ) { add_action( $tag, array( $methodClass ? $methodClass : $this, $method ), $priority, $accepted_args ); return $this; } /** * Registers AJAX action hook. * * @since 1.0.0 * * @access public * @param string $tag The name of the AJAX action to which the $method is hooked. * @param string $method Optional. The name of the method to be called. If the name of the method is not provided, tag name will be used as method name. * @param bool $methodClass The root of the method. * @param boolean $logged_in Optional. Determines if we should register hook for logged in users. * @param boolean $logged_out Optional. Determines if we should register hook for not logged in users. * @return Visualizer_Module */ protected function _addAjaxAction( $tag, $method = '', $methodClass = null, $logged_in = true, $logged_out = false ) { if ( $logged_in ) { $this->_addAction( 'wp_ajax_' . $tag, $method, $methodClass ); } if ( $logged_out ) { $this->_addAction( 'wp_ajax_nopriv_' . $tag, $method, $methodClass ); } return $this; } /** * Registers a filter hook. * * @since 1.0.0 * @uses add_filter() To register filter hook. * * @access protected * @param string $tag The name of the filter to hook the $method to. * @param string $method The name of the method to be called when the filter is applied. * @param int $priority optional. Used to specify the order in which the functions associated with a particular action are executed (default: 10). Lower numbers correspond with earlier execution, and functions with the same priority are executed in the order in which they were added to the action. * @param int $accepted_args optional. The number of arguments the function accept (default 1). * @return Visualizer_Module */ protected function _addFilter( $tag, $method, $priority = 10, $accepted_args = 1 ) { add_filter( $tag, array( $this, $method ), $priority, $accepted_args ); return $this; } /** * Registers a hook for shortcode tag. * * @since 1.0.0 * @uses add_shortcode() To register shortcode hook. * * @access protected * @param string $tag Shortcode tag to be searched in post content. * @param string $method Hook to run when shortcode is found. * @return Visualizer_Module */ protected function _addShortcode( $tag, $method ) { add_shortcode( $tag, array( $this, $method ) ); return $this; } /** * A wrapper around the actual function _getDataAs. This function is invoked as a filter. * * @since 3.2.0 */ public function getDataAs( $data, $chart_id, $type ) { return $this->_getDataAs( $chart_id, $type ); } /** * Extracts the data for a chart and prepares it for the given type. * * @access public * @param int $chart_id The chart id. * @param string $type The exported type. */ public function _getDataAs( $chart_id, $type ) { $final = null; $success = false; if ( $chart_id ) { $chart = get_post( $chart_id ); $success = $chart && $chart->post_type === Visualizer_Plugin::CPT_VISUALIZER; } if ( $success ) { $settings = get_post_meta( $chart_id, Visualizer_Plugin::CF_SETTINGS, true ); $rows = array(); $series = get_post_meta( $chart_id, Visualizer_Plugin::CF_SERIES, true ); $data = self::get_chart_data( $chart, $type, false ); if ( ! empty( $series ) ) { $row = array(); foreach ( $series as $array ) { $row[] = $array['label']; } $rows[] = $row; $row = array(); foreach ( $series as $array ) { $row[] = $array['type']; } $rows[] = $row; } if ( ! empty( $data ) ) { foreach ( $data as $array ) { // ignore strings if ( ! is_array( $array ) ) { continue; } // if this is an array of arrays... if ( is_array( $array[0] ) ) { foreach ( $array as $arr ) { $rows[] = $arr; } } else { // just an array $rows[] = $array; } } } $title = 'visualizer#' . $chart_id; if ( ! empty( $settings['title'] ) ) { $title = $settings['title']; } // for ChartJS, title is an array. if ( is_array( $title ) && isset( $title['text'] ) ) { $title = $title['text']; } if ( empty( $title ) ) { $title = 'visualizer#' . $chart_id; } $filename = $title; switch ( $type ) { case 'csv': $final = $this->_getCSV( $rows, $filename, false ); break; case 'csv-display': $final = $this->_getCSV( $rows, $filename, true ); break; case 'xls': $final = $this->_getExcel( $rows, $filename ); break; case 'print': $final = $this->_getHTML( $rows ); break; case 'image': $final = $this->_getImage( $chart ); break; } } return $final; } /** * Prepares a CSV. * * @access private * @param array $rows The array of data. * @param string $filename The name of the file to use. * @param bool $enclose Enclose strings that have commas in them in double quotes. */ private function _getCSV( $rows, $filename, $enclose ) { $filename .= '.csv'; $bom = chr( 0xEF ) . chr( 0xBB ) . chr( 0xBF ); // phpcs:ignore WordPress.PHP.NoSilencedErrors.Discouraged $fp = function_exists( 'tmpfile' ) ? @tmpfile() : null; if ( ! $fp ) { if ( ! function_exists( 'wp_tempnam' ) ) { require_once ABSPATH . 'wp-admin/includes/file.php'; } $fp = fopen( wp_tempnam(), 'w+' ); } if ( ! $fp ) { return array( 'csv' => '', 'name' => $filename, 'string' => '' ); } if ( ! apply_filters( 'vizualizer_export_include_series_type', true ) ) { unset( $rows[1] ); $rows = array_values( $rows ); } // support for MS Excel fprintf( $fp, $bom ); foreach ( $rows as $row ) { fputcsv( $fp, $row ); } rewind( $fp ); $csv = ''; $array = fgetcsv( $fp ); while ( $array !== false ) { if ( strlen( $csv ) > 0 ) { $csv .= PHP_EOL; } // if enclosure is required, check every item of this line // if a comma exists in the item, add enclosure. if ( $enclose ) { $temp_array = array(); foreach ( $array as $item ) { if ( strpos( $item, ',' ) !== false ) { $item = VISUALIZER_CSV_ENCLOSURE . $item . VISUALIZER_CSV_ENCLOSURE; } $temp_array[] = $item; } $array = $temp_array; } $csv .= implode( ',', $array ); $array = fgetcsv( $fp ); } fclose( $fp ); return array( 'csv' => $csv, 'name' => $filename, 'string' => str_replace( $bom, '', $csv ), ); } /** * Prepares an Excel file. * * @access private * @param array $rows The array of data. * @param string $filename The name of the file to use. */ private function _getExcel( $rows, $filename ) { // OpenSpout allows for long sheet names, but let's keep the same limit for compatibility. $chart = substr( $filename, 0, 30 ); $filename .= '.xlsx'; if ( ! apply_filters( 'vizualizer_export_include_series_type', true ) ) { unset( $rows[1] ); $rows = array_values( $rows ); $rows = array_map( function ( $r ) { return array_map( 'strval', $r ); }, $rows ); } $vendor_file = VISUALIZER_ABSPATH . '/vendor/autoload.php'; if ( is_readable( $vendor_file ) ) { include_once $vendor_file; } $xlsData = ''; if ( class_exists( 'OpenSpout\Writer\Common\Creator\WriterEntityFactory' ) ) { try { // Use OpenSpout to create the XLSX file in memory. $writer = \OpenSpout\Writer\Common\Creator\WriterEntityFactory::createXLSXWriter(); $writer->openToFile( 'php://output' ); // Open to output instead of a file. $writer->getCurrentSheet()->setName( sanitize_title( $chart ) ); // Write rows. foreach ( $rows as $row ) { $rowFromValues = \OpenSpout\Writer\Common\Creator\WriterEntityFactory::createRowFromArray( $row ); $writer->addRow( $rowFromValues ); } ob_start(); $writer->close(); // Saves and closes the file in the output buffer. $xlsData = ob_get_clean(); } catch ( Exception $e ) { do_action( 'themeisle_log_event', Visualizer_Plugin::NAME, 'OpenSpout writer error: ' . $e->getMessage(), 'error', __FILE__, __LINE__ ); error_log( 'OpenSpout writer error: ' . $e->getMessage() ); } } else { do_action( 'themeisle_log_event', Visualizer_Plugin::NAME, 'Class OpenSpout\Writer\Common\Creator\WriterEntityFactory does not exist!', 'error', __FILE__, __LINE__ ); error_log( 'Class OpenSpout\Writer\Common\Creator\WriterEntityFactory does not exist!' ); } return array( 'csv' => 'data:application/vnd.ms-excel;base64,' . base64_encode( $xlsData ), 'name' => $filename, 'raw' => base64_encode( $xlsData ), ); } /** * Prepares an HTML table. * * @access private * @param array $rows The array of data. */ private function _getHTML( $rows ) { $css = ' table.visualizer-print { border-collapse: collapse; } table.visualizer-print, table.visualizer-print th, table.visualizer-print td { border: 1px solid #000; } '; $html = ''; $html .= ' '; $table = ''; $index = 0; foreach ( $rows as $row ) { // skip the data type row. if ( 1 === $index ) { ++$index; continue; } $table .= ''; foreach ( $row as $col ) { if ( $index === 0 ) { $table .= ''; } else { $table .= ''; } } $table .= ''; ++$index; } $table .= '
' . $col . '' . $col . '
'; $html .= apply_filters( 'visualizer_print_table', $table ) . ' '; return array( 'csv' => $html, ); } /** * Disable revisions temporarily for visualizer post type. */ final protected function disableRevisionsTemporarily() { add_filter( 'wp_revisions_to_keep', function ( $num, $post ) { if ( $post->post_type === Visualizer_Plugin::CPT_VISUALIZER ) { return 0; } return $num; }, 10, 2 ); } /** * Undo revisions for the chart, and if necessary, restore the earliest version. * * @return bool If any revisions were found. */ final public function undoRevisions( $chart_id, $restore = false ) { do_action( 'themeisle_log_event', Visualizer_Plugin::NAME, sprintf( 'undoRevisions for %d with%s restore', $chart_id, ( $restore ? '' : 'out' ) ), 'debug', __FILE__, __LINE__ ); if ( get_post_type( $chart_id ) !== Visualizer_Plugin::CPT_VISUALIZER ) { return false; } $revisions = wp_get_post_revisions( $chart_id, array( 'order' => 'ASC' ) ); if ( count( $revisions ) > 1 ) { $revision_ids = array_keys( $revisions ); do_action( 'themeisle_log_event', Visualizer_Plugin::NAME, sprintf( 'found %d revisions = %s', count( $revisions ), print_r( $revision_ids, true ) ), 'debug', __FILE__, __LINE__ ); // when we restore, a new revision is likely to be created. so, let's disable revisions for the time being. $this->disableRevisionsTemporarily(); if ( $restore ) { // restore to the oldest one i.e. the first one. wp_restore_post_revision( array_shift( $revision_ids ) ); } // delete all revisions. foreach ( $revision_ids as $id ) { wp_delete_post_revision( $id ); } return true; } return false; } /** * If existing revisions exist for the chart, restore the earliest version and then create a new revision to initiate editing. */ final public function handleExistingRevisions( $chart_id, $chart ) { do_action( 'themeisle_log_event', Visualizer_Plugin::NAME, sprintf( 'handleExistingRevisions for %d', $chart_id ), 'debug', __FILE__, __LINE__ ); if ( get_post_type( $chart_id ) !== Visualizer_Plugin::CPT_VISUALIZER ) { return $chart_id; } // AI Builder (D3) charts use their own publish flow — skip the classic revision-restore // mechanism, which would otherwise overwrite the saved title and settings. if ( 'd3' === get_post_meta( $chart_id, Visualizer_Plugin::CF_CHART_LIBRARY, true ) ) { return $chart; } // undo revisions. $revisions_found = $this->undoRevisions( $chart_id, true ); // create revision for the edit action. wp_save_post_revision( $chart_id ); if ( $revisions_found ) { // fetch chart data again in case it was updated by an earlier revision. $chart = get_post( $chart_id ); } return $chart; } /** * Returns the language of the locale. * * @access protected */ protected function get_language() { $locale = get_locale(); if ( empty( $locale ) ) { return ''; } $array = explode( '_', $locale ); if ( count( $array ) < 2 ) { return ''; } return reset( $array ); } /** * Gets/creates the JS where user-specific customizations can be/have been added. */ protected function get_user_customization_js() { // use this as the JS file in case we are not able to create the file in uploads. $default = VISUALIZER_ABSURL . 'js/customization.js'; $uploads = wp_get_upload_dir(); $specific = $uploads['baseurl'] . '/visualizer/customization.js'; // for testing on user sites (before we send them the correctly customized file). if ( VISUALIZER_TEST_JS_CUSTOMIZATION ) { return $default; } try { require_once ABSPATH . 'wp-admin/includes/file.php'; WP_Filesystem(); global $wp_filesystem; if ( ! is_a( $wp_filesystem, 'WP_Filesystem_Base' ) ) { return $default; } $multisite_arg = '/'; if ( is_multisite() && ! is_main_site() ) { $multisite_arg = '/sites/' . get_current_blog_id() . '/'; } $dir = $wp_filesystem->wp_content_dir() . 'uploads' . $multisite_arg . 'visualizer'; $file = $wp_filesystem->wp_content_dir() . 'uploads' . $multisite_arg . 'visualizer/customization.js'; if ( $wp_filesystem->is_readable( $file ) ) { return $specific; } if ( $wp_filesystem->exists( $file ) && ! $wp_filesystem->is_readable( $file ) ) { do_action( 'themeisle_log_event', Visualizer_Plugin::NAME, sprintf( 'Unable to read file %s', $file ), 'error', __FILE__, __LINE__ ); return $default; } if ( ! $wp_filesystem->exists( $dir ) ) { $done = $wp_filesystem->mkdir( $dir ); if ( $done === false ) { do_action( 'themeisle_log_event', Visualizer_Plugin::NAME, sprintf( 'Unable to create directory %s', $dir ), 'error', __FILE__, __LINE__ ); return $default; } } // if file does not exist, copy. if ( ! $wp_filesystem->exists( $file ) ) { $src = str_replace( ABSPATH, $wp_filesystem->abspath(), VISUALIZER_ABSPATH . '/js/customization.js' ); $done = $wp_filesystem->copy( $src, $file ); if ( $done === false ) { do_action( 'themeisle_log_event', Visualizer_Plugin::NAME, sprintf( 'Unable to copy file %s to %s', $src, $file ), 'error', __FILE__, __LINE__ ); return $default; } } return $specific; } catch ( \Throwable $e ) { return $default; } } /** * Load the class for the given chart's chart type so that its assets can be loaded. */ protected function load_chart_type( $chart_id ) { // D3/AI charts have no traditional type class — return the library string directly. $lib = get_post_meta( $chart_id, Visualizer_Plugin::CF_CHART_LIBRARY, true ); if ( 'd3' === $lib ) { return 'd3'; } $name = $this->load_chart_class_name( $chart_id ); $class = null; if ( class_exists( $name ) || true === apply_filters( 'visualizer_load_chart', false, $name ) ) { $class = new $name(); } if ( is_null( $class ) && Visualizer_Module::is_pro() ) { // lets see if this type exists in pro. New Lite(3.1.0+) & old Pro(1.8.0-). $type = get_post_meta( $chart_id, Visualizer_Plugin::CF_CHART_TYPE, true ); $class = apply_filters( 'visualizer_pro_chart_type_sidebar', null, array( 'id' => $chart_id, 'type' => $type, 'settings' => get_post_meta( $chart_id, Visualizer_Plugin::CF_SETTINGS, true ) ) ); } return is_null( $class ) ? null : $class->getLibrary(); } /** * Returns the class name for the given chart's chart type. */ protected function load_chart_class_name( $chart_id ) { $type = get_post_meta( $chart_id, Visualizer_Plugin::CF_CHART_TYPE, true ); $lib = get_post_meta( $chart_id, Visualizer_Plugin::CF_CHART_LIBRARY, true ); // backward compatibility. if ( empty( $lib ) ) { $lib = 'GoogleCharts'; if ( 'dataTable' === $type ) { $lib = 'DataTable'; } } $name = 'Visualizer_Render_Sidebar_Type_' . $lib . '_' . ucwords( $type ); return $name; } /** * Generates the inline CSS to apply to the chart and adds these classes to the settings. * * @access public * @param int $id The id of the chart. * @param array $settings The settings of the chart. */ protected function get_inline_custom_css( $id, $settings ) { $css = ''; $classes = array(); $css = ''; $arguments = array( $css, $settings ); apply_filters_ref_array( 'visualizer_inline_css', array( &$arguments ) ); return $arguments; } /** * Handles CSS properties that might need special syntax. * * @access private * @param string $property The name of the css property. * @param string $value The value of the css property. */ private function handle_css_property( $property, $value ) { if ( empty( $property ) || empty( $value ) ) { return ''; } switch ( $property ) { case 'transform': $value = 'rotate(' . $value . 'deg)'; break; } return $property . ': ' . $value; } /** * Determines if charts have been created of the particular chart type. */ protected static function hasChartType( $type ) { $args = array( 'post_type' => Visualizer_Plugin::CPT_VISUALIZER, 'fields' => 'ids', 'post_status' => 'publish', 'meta_query' => array( array( 'key' => Visualizer_Plugin::CF_CHART_TYPE, 'value' => $type, ), ), ); $q = new WP_Query( $args ); return $q->found_posts > 0; } /** * Determines how many charts have been created. */ protected static function numberOfCharts() { $args = array( 'post_type' => Visualizer_Plugin::CPT_VISUALIZER, 'fields' => 'ids', 'post_status' => 'publish', 'posts_per_page' => 300, ); $q = new WP_Query( $args ); return $q->found_posts; } /** * Checks if the PRO version is active. * * @since 3.3.0 */ public static function is_pro() { // versions of pro before 1.9.0 will use the constant VISUALIZER_PRO // versions of pro 1.9.0 onwards will use the filter return apply_filters( 'visualizer_is_pro', VISUALIZER_PRO ); } /** * Checks if the PRO version is older than a particular version. * * @since 3.3.0 */ public static function is_pro_older_than( $version ) { return version_compare( VISUALIZER_PRO_VERSION, $version, '<' ); } /** * Should we show some specific feature on the basis of the version? * * @since 3.4.0 */ public static function can_show_feature( $feature ) { switch ( $feature ) { case 'simple-editor': // if user has pro but an older version, then don't load the simple editor functionality // as the select box will not behave as expected because the pro editor's functionality will supercede. return ! Visualizer_Module::is_pro() || ! Visualizer_Module::is_pro_older_than( '1.9.2' ); } return false; } /** * Gets the features for the provided license type. */ final public static function get_features_for_license( $plan ) { $is_new_personal = apply_filters( 'visualizer_is_new_personal', false ); switch ( $plan ) { case 1: $features = array( 'import-wp', 'import-wc-report', 'import-file', 'import-url' ); if ( ! $is_new_personal ) { $features[] = 'db-query'; } return $features; case 2: $features = array( 'schedule-chart', 'chart-permissions', 'import-chart', 'data-filter-configuration', 'frontend-actions' ); if ( $is_new_personal ) { $features[] = 'db-query'; } return $features; } } /** * Gets the chart content after common manipulations. */ public static function get_chart_data( $chart, $type, $run_filter = true ) { // change HTML entities $post_content = html_entity_decode( htmlentities( $chart->post_content ) ); $post_content = preg_replace_callback( '!s:(\d+):"(.*?)";!s', function ( $matches ) { if ( isset( $matches[2] ) ) { return 's:' . strlen( $matches[2] ) . ':"' . $matches[2] . '";'; } }, $post_content ); $data = unserialize( $post_content ); $altered = array(); if ( ! empty( $data ) ) { foreach ( $data as $index => $array ) { if ( ! is_array( $index ) && is_array( $array ) ) { foreach ( $array as &$datum ) { if ( is_string( $datum ) ) { $datum = stripslashes( $datum ); } } $altered[ $index ] = $array; } } } // if something goes wrong and the end result is empty, be safe and use the original data if ( empty( $altered ) ) { $altered = $data; } if ( $run_filter ) { return apply_filters( Visualizer_Plugin::FILTER_GET_CHART_DATA, $altered, $chart->ID, $type ); } return $altered; } /** * Get chart image. * * @param object $chart Chart data. * @return string */ public function _getImage( $chart = null ) { $image = ''; if ( $chart ) { $chart_image = get_post_meta( $chart->ID, Visualizer_Plugin::CF_CHART_IMAGE, true ); if ( ! empty( $chart_image ) ) { $image = wp_get_attachment_image( $chart_image, 'full' ); } } return array( 'csv' => $image, ); } /** * Filter chart title if visualizer post type. * * @param object $query WP Query object. * @return void */ public function PreGetPosts( $query ) { if ( ! $query->is_main_query() ) { $post_type = $query->get( 'post_type' ); if ( 'visualizer' === $post_type ) { $this->_addFilter( Visualizer_Plugin::FILTER_CHART_TITLE, 'filterChartTitle', 10, 2 ); } } } /** * Filter chart title. * * @access public * @param string $post_title Post title. * @param int $post_id Post ID. * @return string */ public function filterChartTitle( $post_title, $post_id ) { $post_type = get_post_type( $post_id ); $post_title = trim( $post_title ); if ( 'visualizer' === $post_type && 'Visualization' === $post_title ) { return sprintf( '%s #%d', $post_title, $post_id ); } return $post_title; } }