| Current File : //var/www/html/blog/wp-content/plugins/pirate-forms/vendor/codeinwp/themeisle-sdk/src/Product.php |
<?php
/**
* The product model class for ThemeIsle SDK
*
* @package ThemeIsleSDK
* @subpackage Product
* @copyright Copyright (c) 2017, Marius Cristea
* @license http://opensource.org/licenses/gpl-3.0.php GNU Public License
* @since 1.0.0
*/
namespace ThemeisleSDK;
// Exit if accessed directly.
if ( ! defined( 'ABSPATH' ) ) {
exit;
}
/**
* Product model for ThemeIsle SDK.
*/
class Product {
/**
* Define plugin type string.
*/
const PLUGIN_TYPE = 'plugin';
/**
* Define theme type string.
*/
const THEME_TYPE = 'theme';
/**
* If the product has a pro version, contains the pro slug.
*
* @var string $pro_slug Pro slug, if available.
*/
public $pro_slug;
/**
* Current product slug.
*
* @var string $slug THe product slug.
*/
private $slug;
/**
* Product basefile, with the proper metadata.
*
* @var string $basefile The file with headers.
*/
private $basefile;
/**
* Type of the product.
*
* @var string $type The product type ( plugin | theme ).
*/
private $type;
/**
* The file name.
*
* @var string $file The file name.
*/
private $file;
/**
* Product name, fetched from the file headers.
*
* @var string $name The product name.
*/
private $name;
/**
* Product normalized key.
*
* @var string $key The product ready key.
*/
private $key;
/**
* Author URL
*
* @var string $author_url The author url.
*/
private $author_url;
/**
* Product store url.
*
* @var string $store_url The store url.
*/
private $store_url;
/**
* Product install timestamp.
*
* @var int $install The date of install.
*/
private $install;
/**
* Product store/author name.
*
* @var string $store_name The store name.
*/
private $store_name;
/**
* Does the product requires license.
*
* @var bool $requires_license Either user needs to activate it with license.
*/
private $requires_license;
/**
* Is the product available on wordpress.org
*
* @var bool $wordpress_available Either is available on WordPress or not.
*/
private $wordpress_available;
/**
* Current version of the product.
*
* @var string $version The product version.
*/
private $version;
/**
* Holds a map of loaded products objects.
*
* @var array Array of loaded products.
*/
private static $cached_products = [];
/**
* Root api endpoint.
*/
const API_URL = 'https://api.themeisle.com/';
/**
* ThemeIsle_SDK_Product constructor.
*
* @param string $basefile Product basefile.
*/
public function __construct( $basefile ) {
if ( ! empty( $basefile ) ) {
if ( is_file( $basefile ) ) {
$this->basefile = $basefile;
$this->setup_from_path();
$this->setup_from_fileheaders();
}
}
$install = get_option( $this->get_key() . '_install', 0 );
if ( 0 === $install ) {
$install = time();
update_option( $this->get_key() . '_install', time() );
}
$this->install = $install;
self::$cached_products[ crc32( $basefile ) ] = $this;
}
/**
* Return a product.
*
* @param string $basefile Product basefile.
*
* @return Product Product Object.
*/
public static function get( $basefile ) {
$key = crc32( $basefile );
if ( isset( self::$cached_products[ $key ] ) ) {
return self::$cached_products[ $key ];
}
self::$cached_products[ $key ] = new Product( $basefile );
return self::$cached_products[ $key ];
}
/**
* Setup props from path.
*/
public function setup_from_path() {
$this->file = basename( $this->basefile );
$dir = dirname( $this->basefile );
$this->slug = basename( $dir );
$exts = explode( '.', $this->basefile );
$ext = $exts[ count( $exts ) - 1 ];
if ( 'css' === $ext ) {
$this->type = 'theme';
}
if ( 'php' === $ext ) {
$this->type = 'plugin';
}
$this->key = self::key_ready_name( $this->slug );
}
/**
* Normalize string.
*
* @param string $string the String to be normalized for cron handler.
*
* @return string $name The normalized string.
*/
public static function key_ready_name( $string ) {
return str_replace( '-', '_', strtolower( trim( $string ) ) );
}
/**
* Setup props from fileheaders.
*/
public function setup_from_fileheaders() {
$file_headers = array(
'Requires License' => 'Requires License',
'WordPress Available' => 'WordPress Available',
'Pro Slug' => 'Pro Slug',
'Version' => 'Version',
);
if ( 'plugin' === $this->type ) {
$file_headers['Name'] = 'Plugin Name';
$file_headers['AuthorName'] = 'Author';
$file_headers['AuthorURI'] = 'Author URI';
}
if ( 'theme' === $this->type ) {
$file_headers['Name'] = 'Theme Name';
$file_headers['AuthorName'] = 'Author';
$file_headers['AuthorURI'] = 'Author URI';
}
$file_headers = get_file_data( $this->basefile, $file_headers );
$this->name = $file_headers['Name'];
$this->store_name = $file_headers['AuthorName'];
$this->author_url = $file_headers['AuthorURI'];
$this->store_url = $file_headers['AuthorURI'];
$this->requires_license = ( 'yes' === $file_headers['Requires License'] ) ? true : false;
$this->wordpress_available = ( 'yes' === $file_headers['WordPress Available'] ) ? true : false;
$this->pro_slug = ! empty( $file_headers['Pro Slug'] ) ? $file_headers['Pro Slug'] : '';
$this->version = $file_headers['Version'];
}
/**
* Return the product key.
*
* @return string The product key.
*/
public function get_key() {
return $this->key;
}
/**
* Check if the product is either theme or plugin.
*
* @return string Product type.
*/
public function get_type() {
return $this->type;
}
/**
* Return if the product is used as a plugin.
*
* @return bool Is plugin?
*/
public function is_plugin() {
return self::PLUGIN_TYPE === $this->type;
}
/**
* Return if the product is used as a theme.
*
* @return bool Is theme ?
*/
public function is_theme() {
return self::THEME_TYPE === $this->type;
}
/**
* Returns the product slug.
*
* @return string The product slug.
*/
public function get_slug() {
return $this->slug;
}
/**
* The magic var_dump info method.
*
* @return array Debug info.
*/
public function __debugInfo() {
return array(
'name' => $this->name,
'slug' => $this->slug,
'version' => $this->version,
'basefile' => $this->basefile,
'key' => $this->key,
'type' => $this->type,
'store_name' => $this->store_name,
'store_url' => $this->store_url,
'wordpress_available' => $this->wordpress_available,
'requires_license' => $this->requires_license,
);
}
/**
* Getter for product version.
*
* @return string The product version.
*/
public function get_version() {
return $this->version;
}
/**
* Returns current product license, if available.
*
* @return string Return license key, if available.
*/
public function get_license() {
if ( ! $this->requires_license() && ! $this->is_wordpress_available() ) {
return 'free';
}
$license_data = get_option( $this->get_key() . '_license_data', '' );
if ( empty( $license_data ) ) {
return get_option( $this->get_key() . '_license', '' );
}
if ( ! isset( $license_data->key ) ) {
return get_option( $this->get_key() . '_license', '' );
}
return $license_data->key;
}
/**
* Either the product requires license or not.
*
* @return bool Either requires license or not.
*/
public function requires_license() {
return $this->requires_license;
}
/**
* If product is available on wordpress.org or not.
*
* @return bool Either is wp available or not.
*/
public function is_wordpress_available() {
return $this->wordpress_available;
}
/**
* Return friendly name.
*
* @return string Friendly name.
*/
public function get_friendly_name() {
$name = trim( str_replace( 'Lite', '', $this->get_name() ) );
if ( defined( 'OTTER_BLOCKS_BASEFILE' ) && OTTER_BLOCKS_BASEFILE === $this->basefile ) {
$name = 'Otter Blocks';
}
if ( defined( 'OPTML_BASEFILE' ) && OPTML_BASEFILE === $this->basefile ) {
$name = 'Optimole';
}
if ( defined( 'WPMM_FILE' ) && WPMM_FILE === $this->basefile ) {
$name = 'LightStart';
}
$name = apply_filters( $this->get_key() . '_friendly_name', $name );
$name = rtrim( $name, '- ()' );
return $name;
}
/**
* Return the product version cache key.
*
* @return string The product version cache key.
*/
public function get_cache_key() {
return $this->get_key() . '_' . preg_replace( '/[^0-9a-zA-Z ]/m', '', $this->get_version() ) . 'versions';
}
/**
* Getter for product name.
*
* @return string The product name.
*/
public function get_name() {
return $this->name;
}
/**
* Returns the Store name.
*
* @return string Store name.
*/
public function get_store_name() {
return $this->store_name;
}
/**
* Returns the store url.
*
* @return string The store url.
*/
public function get_store_url() {
if ( strpos( $this->store_url, '/themeisle.com' ) !== false ) {
return 'https://store.themeisle.com/';
}
return $this->store_url;
}
/**
* Returns product basefile, which holds the metaheaders.
*
* @return string The product basefile.
*/
public function get_basefile() {
return $this->basefile;
}
/**
* Get changelog url.
*
* @return string Changelog url.
*/
public function get_changelog() {
return add_query_arg(
[
'name' => rawurlencode( $this->get_name() ),
'edd_action' => 'view_changelog',
'locale' => get_user_locale(),
],
$this->get_store_url()
);
}
/**
* Returns product filename.
*
* @return string The product filename.
*/
public function get_file() {
return $this->file;
}
/**
* Returns the pro slug, if available.
*
* @return string The pro slug.
*/
public function get_pro_slug() {
return $this->pro_slug;
}
/**
* Return the install timestamp.
*
* @return int The install timestamp.
*/
public function get_install_time() {
return $this->install;
}
/**
* Returns the URL of the product base file.
*
* @param string $path The path to the file.
*
* @return string The URL of the product base file.
*/
public function get_base_url( $path = '/' ) {
if ( $this->type ) {
return plugins_url( $path, $this->basefile );
}
}
}