* @git Joomla Component Builder * @copyright Copyright (C) 2015 Vast Development Method. All rights reserved. * @license GNU General Public License version 2 or later; see LICENSE.txt */ // No direct access to this file defined('_JEXEC') or die('Restricted access'); // add the autoloader for the composer classes $composer_autoloader = JPATH_LIBRARIES . '/phpseclib3/vendor/autoload.php'; if (file_exists($composer_autoloader)) { require_once $composer_autoloader; } // register additional namespace \spl_autoload_register(function ($class) { // project-specific base directories and namespace prefix $search = [ 'libraries/jcb_powers/VDM.Joomla.Openai' => 'VDM\\Joomla\\Openai', 'libraries/jcb_powers/VDM.Joomla.Gitea' => 'VDM\\Joomla\\Gitea', 'libraries/jcb_powers/VDM.Joomla.FOF' => 'VDM\\Joomla\\FOF', 'libraries/jcb_powers/VDM.Joomla' => 'VDM\\Joomla', 'libraries/jcb_powers/VDM.Minify' => 'VDM\\Minify', 'libraries/jcb_powers/VDM.Psr' => 'VDM\\Psr' ]; // Start the search and load if found $found = false; $found_base_dir = ""; $found_len = 0; foreach ($search as $base_dir => $prefix) { // does the class use the namespace prefix? $len = strlen($prefix); if (strncmp($prefix, $class, $len) === 0) { // we have a match so load the values $found = true; $found_base_dir = $base_dir; $found_len = $len; // done here break; } } // check if we found a match if (!$found) { // not found so move to the next registered autoloader return; } // get the relative class name $relative_class = substr($class, $found_len); // replace the namespace prefix with the base directory, replace namespace // separators with directory separators in the relative class name, append // with .php $file = JPATH_ROOT . '/' . $found_base_dir . '/src' . str_replace('\\', '/', $relative_class) . '.php'; // if the file exists, require it if (file_exists($file)) { require $file; } }); use Joomla\CMS\Factory; use Joomla\CMS\Language\Text; use Joomla\CMS\Access\Access; use Joomla\CMS\Access\Rules as AccessRules; use Joomla\CMS\Component\ComponentHelper; use Joomla\CMS\Filesystem\File; use Joomla\CMS\Language\Language; use Joomla\CMS\MVC\Model\BaseDatabaseModel; use Joomla\CMS\Object\CMSObject; use Joomla\CMS\Table\Table; use Joomla\CMS\Uri\Uri; use Joomla\CMS\Version; use Joomla\Registry\Registry; use Joomla\String\StringHelper; use Joomla\Utilities\ArrayHelper; use PhpOffice\PhpSpreadsheet\IOFactory; use PhpOffice\PhpSpreadsheet\Spreadsheet; use PhpOffice\PhpSpreadsheet\Writer\Xlsx; use Joomla\Archive\Archive; use Joomla\CMS\Filesystem\Folder; use Joomla\CMS\Filesystem\Path; use Joomla\CMS\Session\Session; use VDM\Joomla\Openai\Factory as OpenaiFactory; use VDM\Joomla\Utilities\StringHelper as UtilitiesStringHelper; use VDM\Joomla\Utilities\GetHelper; use VDM\Joomla\Utilities\ArrayHelper as UtilitiesArrayHelper; use VDM\Joomla\Utilities\JsonHelper; use VDM\Joomla\Utilities\FileHelper; use VDM\Joomla\Utilities\ObjectHelper; use VDM\Joomla\Componentbuilder\Compiler\Utilities\FieldHelper; use VDM\Joomla\Componentbuilder\Compiler\Factory as CompilerFactory; use VDM\Joomla\Utilities\Base64Helper; use VDM\Joomla\FOF\Encrypt\AES; use VDM\Joomla\Utilities\String\ClassfunctionHelper; use VDM\Joomla\Utilities\String\FieldHelper as StringFieldHelper; use VDM\Joomla\Utilities\String\TypeHelper; use VDM\Joomla\Utilities\String\NamespaceHelper; use VDM\Joomla\Utilities\MathHelper; use VDM\Joomla\Utilities\String\PluginHelper; use VDM\Joomla\Utilities\GuidHelper; use VDM\Joomla\Utilities\Component\Helper; use VDM\Joomla\Utilities\FormHelper; /** * Componentbuilder component helper. */ abstract class ComponentbuilderHelper { /** * Composer Switch * * @var array */ protected static $composer = []; /** * The Main Active Language * * @var string */ public static $langTag; /** * The Global Admin Event Method. **/ public static function globalEvent($document) { // the Session keeps track of all data related to the current session of this user self::loadSession(); } /** * Just to Add the OPEN AI api to JCB (soon) * OpenaiFactory **/ /** * Locked Libraries (we can not have these change) **/ public static $libraryNames = array(1 => 'No Library', 2 => 'Bootstrap v4', 3 => 'Uikit v3', 4 => 'Uikit v2', 5 => 'FooTable v2', 6 => 'FooTable v3'); /** * Array of php fields Allowed (16) **/ public static $phpFieldArray = array('', 'a', 'b', 'c', 'd', 'e', 'f', 'g', 'h', 'i', 'j', 'k', 'l', 'm', 'n', 'x', 'HEADER'); /** * The global params **/ protected static $params = false; /** * The global updater **/ protected static $globalUpdater = array(); /** * The local company details **/ protected static $localCompany = array(); /** * The excluded powers **/ protected static $exPowers= array(); /** * The snippet paths **/ public static $snippetPath = 'https://raw.githubusercontent.com/vdm-io/Joomla-Component-Builder-Snippets/master/'; public static $snippetsPath = 'https://api.github.com/repos/vdm-io/Joomla-Component-Builder-Snippets/git/trees/master'; /** * The VDM packages paths **/ public static $vdmGithubPackageUrl = "https://github.com/vdm-io/JCB-Packages/raw/master/"; public static $vdmGithubPackagesUrl = "https://api.github.com/repos/vdm-io/JCB-Packages/git/trees/master"; /** * The JCB packages paths **/ public static $jcbGithubPackageUrl = "https://github.com/vdm-io/JCB-Community-Packages/raw/master/"; public static $jcbGithubPackagesUrl = "https://api.github.com/repos/vdm-io/JCB-Community-Packages/git/trees/master"; /** * The bolerplate paths **/ public static $bolerplatePath = 'https://raw.githubusercontent.com/vdm-io/boilerplate/jcb/'; public static $bolerplateAPI = 'https://api.github.com/repos/vdm-io/boilerplate/git/trees/jcb'; /** * The array of constant paths * * JPATH_SITE is meant to represent the root path of the JSite application, * just as JPATH_ADMINISTRATOR is mean to represent the root path of the JAdministrator application. * * JPATH_BASE is the root path for the current requested application.... so if you are in the administrator application: * * JPATH_BASE == JPATH_ADMINISTRATOR * * If you are in the site application: * * JPATH_BASE == JPATH_SITE * * If you are in the installation application: * * JPATH_BASE == JPATH_INSTALLATION. * * JPATH_ROOT is the root path for the Joomla install and does not depend upon any application. * * @var array */ public static $constantPaths = array( // The path to the administrator folder. 'JPATH_ADMINISTRATOR' => JPATH_ADMINISTRATOR, // The path to the installed Joomla! site, or JPATH_ROOT/administrator if executed from the backend. 'JPATH_BASE' => JPATH_BASE, // The path to the cache folder. 'JPATH_CACHE' => JPATH_CACHE, // The path to the administration folder of the current component being executed. 'JPATH_COMPONENT_ADMINISTRATOR' => JPATH_COMPONENT_ADMINISTRATOR, // The path to the site folder of the current component being executed. 'JPATH_COMPONENT_SITE' => JPATH_COMPONENT_SITE, // The path to the current component being executed. 'JPATH_COMPONENT' => JPATH_COMPONENT, // The path to folder containing the configuration.php file. 'JPATH_CONFIGURATION' => JPATH_CONFIGURATION, // The path to the installation folder. 'JPATH_INSTALLATION' => JPATH_INSTALLATION, // The path to the libraries folder. 'JPATH_LIBRARIES' => JPATH_LIBRARIES, // The path to the plugins folder. 'JPATH_PLUGINS' => JPATH_PLUGINS, // The path to the installed Joomla! site. 'JPATH_ROOT' => JPATH_ROOT, // The path to the installed Joomla! site. 'JPATH_SITE' => JPATH_SITE, // The path to the templates folder. 'JPATH_THEMES' => JPATH_THEMES ); /** * get the class method or property * * @input int The method/property ID * @input string The target type * * @returns string on success **/ public static function getClassCode($id, $type) { if ('property' === $type || 'method' === $type) { // Get a db connection. $db = Factory::getDbo(); // Get user object $user = Factory::getUser(); // Create a new query object. $query = $db->getQuery(true); // get method if ('method' === $type) { $query->select($db->quoteName(array('a.comment','a.name','a.visibility','a.arguments','a.code'))); } // get property elseif ('property' === $type) { $query->select($db->quoteName(array('a.comment','a.name','a.visibility','a.default'))); } $query->from($db->quoteName('#__componentbuilder_class_' . $type,'a')); $query->where($db->quoteName('a.id') . ' = ' . (int) $id); // Implement View Level Access if (!$user->authorise('core.options', 'com_componentbuilder')) { $columns = $db->getTableColumns('#__componentbuilder_class_' . $type); if(isset($columns['access'])) { $groups = implode(',', $user->getAuthorisedViewLevels()); $query->where('a.access IN (' . $groups . ')'); } } $db->setQuery($query); $db->execute(); if ($db->getNumRows()) { // get the code $code = $db->loadObject(); // combine method values $combinded = array(); // add comment if set if (UtilitiesStringHelper::check($code->comment)) { $comment = array_map('trim', (array) explode(PHP_EOL, base64_decode($code->comment))); $combinded[] = "\t" . implode(PHP_EOL . "\t ", $comment); } // build method if ('method' === $type) { // set the method signature if (UtilitiesStringHelper::check($code->arguments)) { $combinded[] = "\t" . $code->visibility . ' function ' . $code->name . '(' . base64_decode($code->arguments) . ')'; } else { $combinded[] = "\t" . $code->visibility . ' function ' . $code->name . '()'; } // set the method code $combinded[] = "\t" . "{"; // add code if set if (UtilitiesStringHelper::check(trim($code->code))) { $combinded[] = base64_decode($code->code); } else { $combinded[] = "\t\t// add your code here"; } $combinded[] = "\t" . "}"; } else { if (UtilitiesStringHelper::check($code->default)) { $code->default = base64_decode($code->default); if (is_int($code->default)) { // set the class property $combinded[] = "\t" . $code->visibility . ' $' . $code->name . ' = ' . (int) $code->default . ';'; } elseif (is_float($code->default)) { // set the class property $combinded[] = "\t" . $code->visibility . ' $' . $code->name . ' = ' . (float) $code->default . ';'; } elseif (('false' === $code->default || 'true' === $code->default) || (UtilitiesStringHelper::check($code->default) && (strpos($code->default, 'array(') !== false || strpos($code->default, '"') !== false))) { // set the class property $combinded[] = "\t" . $code->visibility . ' $' . $code->name . ' = ' . $code->default . ';'; } elseif (UtilitiesStringHelper::check($code->default) && strpos($code->default, '"') === false) { // set the class property $combinded[] = "\t" . $code->visibility . ' $' . $code->name . ' = "' . $code->default . '";'; } else { // set the class property $combinded[] = "\t" . $code->visibility . ' $' . $code->name . ';'; } } else { // set the class property $combinded[] = "\t" . $code->visibility . ' $' . $code->name . ';'; } } // return the code return implode(PHP_EOL, $combinded); } } return false; } /** * extract Boilerplate Class Extends * * @input string The class as a string * @input string The type of class/extension * * @returns string on success **/ public static function extractBoilerplateClassExtends(&$class, $type) { if (($strings = GetHelper::allBetween($class, 'class ', '}')) !== false && UtilitiesArrayHelper::check($strings)) { foreach ($strings as $string) { if (($extends = GetHelper::between($string, 'extends ', '{')) !== false && UtilitiesStringHelper::check($extends)) { return trim($extends); } } } return false; } /** * extract Boilerplate Class Header * * @input string The class as a string * @input string The class being extended * @input string The type of class/extension * * @returns string on success **/ public static function extractBoilerplateClassHeader(&$class, $extends, $type) { if (($string = GetHelper::between($class, "defined('_JEXEC')", 'extends ' . $extends)) !== false && UtilitiesStringHelper::check($string)) { $headArray = explode(PHP_EOL, $string); if (UtilitiesArrayHelper::check($headArray) && count($headArray) > 3) { // remove first since it still has the [or die;] string in it array_shift($headArray); // remove the last since it has the class declaration array_pop($headArray); // at this point we have the class comment still in as part of the header, lets remove that $last = count($headArray); while ($last > 0) { $last--; if (isset($headArray[$last]) && strpos($headArray[$last], '*') !== false) { unset($headArray[$last]); } else { // moment the comment stops, we break out $last = 0; } } // make sure we only return if we have values if (UtilitiesArrayHelper::check($headArray)) { return implode(PHP_EOL, $headArray); } } } return false; } /** * extract Boilerplate Class Comment * * @input string The class as a string * @input string The class being extended * @input string The type of class/extension * * @returns string on success **/ public static function extractBoilerplateClassComment(&$class, $extends, $type) { if (($string = GetHelper::between($class, "defined('_JEXEC')", 'extends ' . $extends)) !== false && UtilitiesStringHelper::check($string)) { $headArray = explode(PHP_EOL, $string); if (UtilitiesArrayHelper::check($headArray) && count($headArray) > 3) { $comment = array(); // remove the last since it has the class declaration array_pop($headArray); // at this point we have the class comment still in as part of the header, lets remove that $last = count($headArray); while ($last > 0) { $last--; if (isset($headArray[$last]) && strpos($headArray[$last], '*') !== false) { $comment[$last] = $headArray[$last]; } else { // moment the comment stops, we break out $last = 0; } } // make sure we only return if we have values if (UtilitiesArrayHelper::check($comment)) { // set the correct order ksort($comment); $replace = array('Foo' => '[[[Plugin_name]]]', '[PACKAGE_NAME]' => '[[[Plugin]]]', '1.0.0' => '[[[plugin.version]]]', '1.0' => '[[[plugin.version]]]'); // now update with JCB placeholders return str_replace(array_keys($replace), array_values($replace), implode(PHP_EOL, $comment)); } } } return false; } /** * extract Boilerplate Class Properties & Methods * * @input string The class as a string * @input string The class being extended * @input string The type of class/extension * @input int The plugin groups * * @returns string on success **/ public static function extractBoilerplateClassPropertiesMethods(&$class, $extends, $type, $plugin_group = null) { $bucket = array('property' => array(), 'method' => array()); // get the class code, and remove the head $codeArrayTmp = explode('extends ' . $extends, $class); // make sure we have the correct result if (UtilitiesArrayHelper::check($codeArrayTmp) && count($codeArrayTmp) == 2) { // the triggers $triggers = array('public' => 1, 'protected' => 2, 'private' => 3); $codeArray = explode(PHP_EOL, $codeArrayTmp[1]); unset($codeArrayTmp); // clean the code self::cleanBoilerplateCode($codeArray); // temp bucket $name = null; $arg = null; $target = null; $visibility = null; $tmp = array(); $comment = array(); // load method $loadCode = function (&$bucket, &$target, &$name, &$arg, &$visibility, &$tmp, &$comment) use($type, $plugin_group){ $_tmp = array( 'name' => $name, 'visibility' => $visibility, 'extension_type' => $type ); // build filter $filters = array('extension_type' => $type); // add more data based on target if ('method' === $target && UtilitiesArrayHelper::check($tmp)) { // clean the code self::cleanBoilerplateCode($tmp); // only load if there are values if (UtilitiesArrayHelper::check($tmp, true)) { $_tmp['code'] = implode(PHP_EOL, $tmp); } else { $_tmp['code'] = ''; } // load arguments only if set if (UtilitiesStringHelper::check($arg)) { $_tmp['arguments'] = $arg; } } elseif ('property' === $target) { // load default only if set if (UtilitiesStringHelper::check($arg)) { $_tmp['default'] = $arg; } } // load comment only if set if (UtilitiesArrayHelper::check($comment, true)) { $_tmp['comment'] = implode(PHP_EOL, $comment); } // load the group target if ($plugin_group) { $_tmp['joomla_plugin_group'] = $plugin_group; $filters['joomla_plugin_group'] = $plugin_group; } // load the local values if (($locals = self::getLocalBoilerplate($name, $target, $type, $filters)) !== false) { foreach ($locals as $key => $value) { $_tmp[$key] = $value; } } else { $_tmp['id'] = 0; $_tmp['published'] = 1; $_tmp['version'] = 1; } // store the data based on target $bucket[$target][] = $_tmp; }; // now we start loading foreach($codeArray as $line) { if ($visibility && $target && $name && strpos($line, '/**') !== false) { $loadCode($bucket, $target, $name, $arg, $visibility, $tmp, $comment); // reset loop buckets $name = null; $arg = null; $target = null; $visibility = null; $tmp = array(); $comment = array(); } // load the comment before method/property if (!$visibility && !$target && !$name && strpos($line, '*') !== false) { $comment[] = rtrim($line); } else { if (!$visibility && !$target && !$name) { // get the line values $lineArray = array_values(array_map('trim', preg_split('/\s+/', trim($line)))); // check if we are at the main line if (isset($lineArray[0]) && isset($triggers[$lineArray[0]])) { $visibility = $lineArray[0]; if (strpos($line, 'function') !== false) { $target = 'method'; // get the name $name = trim(GetHelper::between($line, 'function ', '(')); // get the arguments $arg = trim(GetHelper::between($line, ' ' . $name . '(', ')')); } else { $target = 'property'; if (strpos($line, '=') !== false) { // get the name $name = trim(GetHelper::between($line, '$', '=')); // get the default $arg = trim(GetHelper::between($line, '=', ';')); } else { // get the name $name = trim(GetHelper::between($line, '$', ';')); } } } } else { $tmp[] = rtrim($line); } } } // check if a last method is still around if ($visibility && $target && $name) { $loadCode($bucket, $target, $name, $arg, $visibility, $tmp, $comment); // reset loop buckets $name = null; $arg = null; $target = null; $visibility = null; $tmp = array(); $comment = array(); } return $bucket; } return false; } protected static function getLocalBoilerplate($name, $table, $extension_type, $filters = array()) { if ('property' === $table || 'method' === $table) { // Get a db connection. $db = Factory::getDbo(); // Create a new query object. $query = $db->getQuery(true); // get method $query->select($db->quoteName(array('a.id','a.published','a.version'))); $query->from($db->quoteName('#__componentbuilder_class_' . $table,'a')); $query->where($db->quoteName('a.name') . ' = ' . $db->quote($name)); $query->where($db->quoteName('a.extension_type') . ' = ' . $db->quote($extension_type)); // add more filters if (UtilitiesArrayHelper::check($filters)) { foreach($filters as $where => $value) { if (is_numeric($value)) { $query->where($db->quoteName('a.' . $where) . ' = ' . $value); } else { $query->where($db->quoteName('a.' . $where) . ' = ' . $db->quote($value)); } } } $db->setQuery($query); $db->execute(); if ($db->getNumRows()) { // get the code return $db->loadAssoc(); } } return false; } protected static function cleanBoilerplateCode(&$code) { // remove the first lines until a { is found $key = 0; $found = false; while (!$found) { if (isset($code[$key])) { if (strpos($code[$key], '{') !== false) { unset($code[$key]); // only remove the first } found $found = true; } // remove empty lines elseif (!UtilitiesStringHelper::check(trim($code[$key]))) { unset($code[$key]); } } // check next line $key++; // stop loop at line 30 (really this should never happen) if ($key > 30) { $found = true; } } // reset all keys $code = array_values($code); // remove last lines until } $last = count($code); while ($last > 0) { $last--; if (isset($code[$last])) { if (strpos($code[$last], '}') !== false) { unset($code[$last]); // only remove the first } found $last = 0; } // remove empty lines elseif (!UtilitiesStringHelper::check(trim($code[$last]))) { unset($code[$last]); } } } } /* * Get the Array of Existing Validation Rule Names * * @return array */ public static function getExistingValidationRuleNames($lowercase = false) { // get the items $items = self::get('_existing_validation_rules_VDM', null); if (!$items) { // load the file class jimport('joomla.filesystem.file'); jimport('joomla.filesystem.folder'); // set the path to the form validation rules $path = JPATH_LIBRARIES . '/src/Form/Rule'; // check if the path exist if (!Folder::exists($path)) { return false; } // we must first store the current working directory $joomla = getcwd(); // go to that folder chdir($path); // load all the files in this path $items = Folder::files('.', '\.php', true, true); // change back to Joomla working directory chdir($joomla); // make sure we have an array if (!UtilitiesArrayHelper::check($items)) { return false; } // remove the Rule.php from the name $items = array_map( function ($name) { return str_replace(array('./','Rule.php'), '', $name); }, $items); // store the names for next run self::set('_existing_validation_rules_VDM', json_encode($items)); } // make sure it is no longer json if (JsonHelper::check($items)) { $items = json_decode($items, true); } // check if the names should be all lowercase if ($lowercase) { $items = array_map( function($item) { return strtolower($item); }, $items); } return $items; } /** * Get the snippet contributor details * * @param string $filename The file name * @param string $type The type of file * * @return array On success the contributor details * */ public static function getContributorDetails($filename, $type = 'snippet') { // start loading the contributor details $contributor = array(); // get the path & content switch ($type) { case 'snippet': $path = self::$snippetPath.$filename; // get the file if available $content = FileHelper::getContent($path); if (JsonHelper::check($content)) { $content = json_decode($content, true); } break; default: // only allow types that are being targeted return false; break; } // see if we have content and all needed details if (isset($content) && UtilitiesArrayHelper::check($content) && isset($content['contributor_company']) && isset($content['contributor_name']) && isset($content['contributor_email']) && isset($content['contributor_website'])) { // got the details from file return array('contributor_company' => $content['contributor_company'] ,'contributor_name' => $content['contributor_name'], 'contributor_email' => $content['contributor_email'], 'contributor_website' => $content['contributor_website'], 'origin' => 'file'); } // get the global settings if (!ObjectHelper::check(self::$params)) { self::$params = ComponentHelper::getParams('com_componentbuilder'); } // get the global company details if (!UtilitiesArrayHelper::check(self::$localCompany)) { // Set the person sharing information (default VDM ;) self::$localCompany['company'] = self::$params->get('export_company', 'Vast Development Method'); self::$localCompany['owner'] = self::$params->get('export_owner', 'Llewellyn van der Merwe'); self::$localCompany['email'] = self::$params->get('export_email', 'joomla@vdm.io'); self::$localCompany['website'] = self::$params->get('export_website', 'https://www.vdm.io/'); } // default global return array('contributor_company' => self::$localCompany['company'] ,'contributor_name' => self::$localCompany['owner'], 'contributor_email' => self::$localCompany['email'], 'contributor_website' => self::$localCompany['website'], 'origin' => 'global'); } /** * Get the library files * * @param int $id The library id to target * * @return array On success the array of files that belong to this library * */ public static function getLibraryFiles($id) { // get the library files, folders, and urls $files = array(); // Get a db connection. $db = Factory::getDbo(); // Create a new query object. $query = $db->getQuery(true); $query->select($db->quoteName(array('b.name','a.addurls','a.addfolders','a.addfiles'))); $query->from($db->quoteName('#__componentbuilder_library_files_folders_urls','a')); $query->join('LEFT', $db->quoteName('#__componentbuilder_library', 'b') . ' ON (' . $db->quoteName('a.library') . ' = ' . $db->quoteName('b.id') . ')'); $query->where($db->quoteName('a.library') . ' = ' . (int) $id); $db->setQuery($query); $db->execute(); if ($db->getNumRows()) { // prepare the files $result = $db->loadObject(); // first we load the URLs if (JsonHelper::check($result->addurls)) { // convert to array $result->addurls = json_decode($result->addurls, true); // set urls if (UtilitiesArrayHelper::check($result->addurls)) { // build media folder path $mediaPath = '/media/' . strtolower( preg_replace('/\s+/', '-', UtilitiesStringHelper::safe($result->name, 'filename', ' ', false))); // load the urls foreach($result->addurls as $url) { if (isset($url['url']) && UtilitiesStringHelper::check($url['url'])) { // set the path if needed if (isset($url['type']) && $url['type'] > 1) { $fileName = basename($url['url']); // build sub path if (strpos($fileName, '.js') !== false) { $path = '/js'; } elseif (strpos($fileName, '.css') !== false) { $path = '/css'; } else { $path = ''; } // set the path to library file $url['path'] = $mediaPath . $path . '/' . $fileName; // we need this for later } // if local path is set, then use it first if (isset($url['path'])) { // load document script $files[md5($url['path'])] = '(' . Text::_('URL') . ') ' . basename($url['url']) . ' - ' . Text::_('COM_COMPONENTBUILDER_LOCAL'); } // check if link must be added if (isset($url['url']) && ((isset($url['type']) && $url['type'] == 1) || (isset($url['type']) && $url['type'] == 3) || !isset($url['type']))) { // load url also if not building document $files[md5($url['url'])] = '(' . Text::_('URL') . ') ' . basename($url['url']) . ' - ' . Text::_('COM_COMPONENTBUILDER_LINK'); } } } } } // load the local files if (JsonHelper::check($result->addfiles)) { // convert to array $result->addfiles = json_decode($result->addfiles, true); // set files if (UtilitiesArrayHelper::check($result->addfiles)) { foreach($result->addfiles as $file) { if (isset($file['file']) && isset($file['path'])) { $path = '/'.trim($file['path'], '/'); // check if path has new file name (has extetion) $pathInfo = pathinfo($path); if (isset($pathInfo['extension']) && $pathInfo['extension']) { // load document script $files[md5($path)] = '(' . Text::_('COM_COMPONENTBUILDER_FILE') . ') ' . $file['file']; } else { // load document script $files[md5($path.'/'.trim($file['file'],'/'))] = '(' . Text::_('COM_COMPONENTBUILDER_FILE') . ') ' . $file['file']; } } } } } // load the files in the folder if (JsonHelper::check($result->addfolders)) { // convert to array $result->addfolders = json_decode($result->addfolders, true); // set folder if (UtilitiesArrayHelper::check($result->addfolders)) { // get the global settings if (!ObjectHelper::check(self::$params)) { self::$params = ComponentHelper::getParams('com_componentbuilder'); } // reset bucket $bucket = array(); // get custom folder path $customPath = '/'.trim(self::$params->get('custom_folder_path', JPATH_COMPONENT_ADMINISTRATOR.'/custom'), '/'); // get all the file paths foreach ($result->addfolders as $folder) { if (isset($folder['path']) && isset($folder['folder'])) { $_path = '/'.trim($folder['path'], '/'); $customFolder = '/'.trim($folder['folder'], '/'); if (isset($folder['rename']) && 1 == $folder['rename']) { if ($_paths = FileHelper::getPaths($customPath.$customFolder)) { $bucket[$_path] = $_paths; } } else { $path = $_path.$customFolder; if ($_paths = FileHelper::getPaths($customPath.$customFolder)) { $bucket[$path] = $_paths; } } } } // now load the script if (UtilitiesArrayHelper::check($bucket)) { foreach ($bucket as $root => $paths) { // load per path foreach($paths as $path) { $files[md5($root.'/'.trim($path, '/'))] = '(' . Text::_('COM_COMPONENTBUILDER_FOLDER') . ') ' . basename($path) . ' - ' . basename($root); } } } } } // return files if found if (UtilitiesArrayHelper::check($files)) { return $files; } } return false; } /** * Fix the path to work in the JCB script <-- (main issue here) * Since we need / slash in all paths, for the JCB script even if it is Windows * and since MS works with both forward and back slashes * we just convert all slashes to forward slashes * * THIS is just my hack (fix) if you know a better way! speak-up! * * @param mix $values the array of paths or the path as a string * @param array $targets paths to target * * @return string * */ public static function fixPath(&$values, $targets = array()) { // if multiple to gets searched and fixed if (UtilitiesArrayHelper::check($values) && UtilitiesArrayHelper::check($targets)) { foreach ($targets as $target) { if (isset($values[$target]) && strpos($values[$target], '\\') !== false) { $values[$target] = str_replace('\\', '/', $values[$target]); } } } // if just a string elseif (UtilitiesStringHelper::check($values) && strpos($values, '\\') !== false) { $values = str_replace('\\', '/', $values); } } /** * get all component IDs */ public static function getComponentIDs() { // Get a db connection. $db = Factory::getDbo(); // Create a new query object. $query = $db->getQuery(true); $query->select($db->quoteName(array('id'))); $query->from($db->quoteName('#__componentbuilder_joomla_component')); $query->where($db->quoteName('published') . ' >= 1'); // do not backup trash $db->setQuery($query); $db->execute(); if ($db->getNumRows()) { return $db->loadColumn(); } return false; } /** * Autoloader */ public static function autoLoader($type = 'compiler') { // load the type classes if ('smart' !== $type) { foreach (glob(JPATH_ADMINISTRATOR."/components/com_componentbuilder/helpers/".$type."/*.php") as $autoFile) { require_once $autoFile; } } // load only if compiler if ('compiler' === $type) { // import the Joomla librarys jimport('joomla.application.component.modellist'); } // load only if smart if ('smart' === $type) { // import the Joomla libraries jimport('joomla.application.component.modellist'); } // load this for all jimport('joomla.application'); } /** * The dynamic builder of views, tables and fields **/ public static function dynamicBuilder(&$data, $type) { self::autoLoader('extrusion'); $extruder = new Extrusion($data); } /* * Convert repeatable field to subform * * @param array $item The array to convert * @param string $name The main field name * * @return array */ public static function convertRepeatable($item, $name) { // continue only if we have an array if (UtilitiesArrayHelper::check($item)) { $bucket = array(); foreach ($item as $key => $values) { foreach ($values as $nr => $value) { if (!isset($bucket[$name . $nr]) || !UtilitiesArrayHelper::check($bucket[$name . $nr])) { $bucket[$name . $nr] = array(); } $bucket[$name . $nr][$key] = $value; } } return $bucket; } return $item; } /* * Convert repeatable field to subform * * @param object $item The item to update * @param array $searcher The fields to check and update * @param array $updater To update the local table * * @return void */ public static function convertRepeatableFields($object, $searcher, $updater = array()) { // update the repeatable fields foreach ($searcher as $key => $sleutel) { if (isset($object->{$key})) { $isJson = false; if (JsonHelper::check($object->{$key})) { $object->{$key} = json_decode($object->{$key}, true); $isJson = true; } // check if this is old values for repeatable fields if (UtilitiesArrayHelper::check($object->{$key}) && isset($object->{$key}[$sleutel])) { // load it back $object->{$key} = self::convertRepeatable($object->{$key}, $key); // add to global updater if ( UtilitiesArrayHelper::check($object->{$key}) && UtilitiesArrayHelper::check($updater) && ( ( isset($updater['table']) && isset($updater['val']) && isset($updater['key']) ) || ( isset($updater['unique']) && isset($updater['unique'][$key]) && isset($updater['unique'][$key]['table']) && isset($updater['unique'][$key]['val']) && isset($updater['unique'][$key]['key']) ) ) ) { $_key = null; $_value = null; $_table = null; // check if we have unique id table for this repeatable/subform field if ( isset($updater['unique']) && isset($updater['unique'][$key]) && isset($updater['unique'][$key]['table']) && isset($updater['unique'][$key]['val']) && isset($updater['unique'][$key]['key']) ) { $_key = $updater['unique'][$key]['key']; $_value = $updater['unique'][$key]['val']; $_table = $updater['unique'][$key]['table']; } elseif ( isset($updater['table']) && isset($updater['val']) && isset($updater['key']) ) { $_key = $updater['key']; $_value = $updater['val']; $_table = $updater['table']; } // continue only if values are valid if (UtilitiesStringHelper::check($_table) && UtilitiesStringHelper::check($_key) && $_value > 0) { // set target table & item $target = trim($_table) . '.' . trim($_key) . '.' . trim($_value); if (!isset(self::$globalUpdater[$target])) { self::$globalUpdater[$target] = new \stdClass; self::$globalUpdater[$target]->{$_key} = (int) $_value; } // load the new subform values to global updater self::$globalUpdater[$target]->{$key} = json_encode($object->{$key}); } } } // no set back to json if came in as json if ($isJson && UtilitiesArrayHelper::check($object->{$key})) { $object->{$key} = json_encode($object->{$key}); } // remove if not json or array elseif (!UtilitiesArrayHelper::check($object->{$key}) && !JsonHelper::check($object->{$key})) { unset($object->{$key}); } } } return $object; } /** * Run Global Updater if any are set * * @return void * */ public static function runGlobalUpdater() { // check if any updates are set to run if (UtilitiesArrayHelper::check(self::$globalUpdater)) { // get the database object $db = Factory::getDbo(); foreach (self::$globalUpdater as $tableKeyID => $object) { // get the table $table = explode('.', $tableKeyID); // update the item $db->updateObject('#__componentbuilder_' . (string) $table[0] , $object, (string) $table[1]); } // rest updater self::$globalUpdater = array(); } } /** * Copy Any Item (only use for direct database copying) * * @param int $id The item to copy * @param string $table The table and model to copy from and with * @param array $config The values that should change * * @return boolean True if success * */ public static function copyItem($id, $type, $config = array()) { // only continue if we have an id if ((int) $id > 0) { // get the model $model = self::getModel($type); $app = Factory::getApplication(); // get item if ($item = $model->getItem($id)) { // update values that should change if (UtilitiesArrayHelper::check($config)) { foreach($config as $key => $value) { if (isset($item->{$key})) { $item->{$key} = $value; } } } // clone the object $data = array(); foreach ($item as $key => $value) { $data[$key] = $value; } // reset some values $data['id'] = 0; $data['version'] = 1; if (isset($data['tags'])) { $data['tags'] = null; } if (isset($data['associations'])) { $data['associations'] = array(); } // remove some unneeded values unset($data['params']); unset($data['asset_id']); unset($data['checked_out']); unset($data['checked_out_time']); // Attempt to save the data. if ($model->save($data)) { return true; } } } return false; } /** * the basic localkey **/ protected static $localkey = false; /** * get the localkey **/ public static function getLocalKey() { if (!self::$localkey) { // get the basic key self::$localkey = md5(self::getCryptKey('basic', 'localKey34fdWEkl')); } return self::$localkey; } /** * indent HTML */ public static function indent($html) { // load the class require_once JPATH_ADMINISTRATOR.'/components/com_componentbuilder/helpers/indenter.php'; // set new indenter $indenter = new Indenter(); // return indented html return $indenter->indent($html); } public static function checkFileType($file, $sufix) { // now check if the file ends with the sufix return $sufix === "" || ($sufix == substr(strrchr($file, "."), -strlen($sufix))); } public static function imageInfo($path, $request = 'type') { // set image $image = JPATH_SITE.'/'.$path; // check if exists if (file_exists($image) && $result = @getimagesize($image)) { // return type request switch ($request) { case 'width': return $result[0]; break; case 'height': return $result[1]; break; case 'type': $extensions = array( IMAGETYPE_GIF => "gif", IMAGETYPE_JPEG => "jpg", IMAGETYPE_PNG => "png", IMAGETYPE_SWF => "swf", IMAGETYPE_PSD => "psd", IMAGETYPE_BMP => "bmp", IMAGETYPE_TIFF_II => "tiff", IMAGETYPE_TIFF_MM => "tiff", IMAGETYPE_JPC => "jpc", IMAGETYPE_JP2 => "jp2", IMAGETYPE_JPX => "jpx", IMAGETYPE_JB2 => "jb2", IMAGETYPE_SWC => "swc", IMAGETYPE_IFF => "iff", IMAGETYPE_WBMP => "wbmp", IMAGETYPE_XBM => "xbm", IMAGETYPE_ICO => "ico" ); return $extensions[$result[2]]; break; case 'attr': return $result[3]; break; case 'all': default: return $result; break; } } return false; } /** * set the session defaults if not set **/ protected static function setSessionDefaults() { // noting for now return true; } /** * check if it is a new hash **/ public static function newHash($hash, $name = 'backup', $type = 'hash', $key = '', $fileType = 'txt') { // make sure we have a hash if (UtilitiesStringHelper::check($hash)) { // first get the file path $path_filename = FileHelper::getPath('path', $name.$type, $fileType, $key, JPATH_COMPONENT_ADMINISTRATOR); // set as read if not already set if ($content = FileHelper::getContent($path_filename, false)) { if ($hash == $content) { return false; } } // set the hash return FileHelper::write($path_filename, $hash); } return false; } protected static $pkOwnerSearch = array( 'company' => 'COM_COMPONENTBUILDER_DTCOMPANYDTDDSDD', 'owner' => 'COM_COMPONENTBUILDER_DTOWNERDTDDSDD', 'email' => 'COM_COMPONENTBUILDER_DTEMAILDTDDSDD', 'website' => 'COM_COMPONENTBUILDER_DTWEBSITEDTDDSDD', 'license' => 'COM_COMPONENTBUILDER_DTLICENSEDTDDSDD', 'copyright' => 'COM_COMPONENTBUILDER_DTCOPYRIGHTDTDDSDD' ); /** * get the JCB package owner details display **/ public static function getPackageOwnerDetailsDisplay(&$info, $trust = false) { $hasOwner = false; $ownerDetails = ''; $ownerDetails .= '
'; // load the list items foreach (self::$pkOwnerSearch as $key => $dd) { if ($value = self::getPackageOwnerValue($key, $info)) { $ownerDetails .= Text::sprintf($dd, $value); // check if we have a owner/source name if (('owner' === $key || 'company' === $key) && !$hasOwner) { $hasOwner = true; $owner = $value; } } } $ownerDetails .= '
'; // provide some details to how the user can get a key if ($hasOwner && isset($info['getKeyFrom']['buy_link']) && UtilitiesStringHelper::check($info['getKeyFrom']['buy_link'])) { $ownerDetails .= '
'; $ownerDetails .= Text::sprintf('COM_COMPONENTBUILDER_BGET_THE_KEY_FROMB_A_SSA', 'class="btn btn-primary" href="'.$info['getKeyFrom']['buy_link'].'" target="_blank" title="get a key from '.$owner.'"', $owner); } // add more custom links elseif ($hasOwner && isset($info['getKeyFrom']['buy_links']) && UtilitiesArrayHelper::check($info['getKeyFrom']['buy_links'])) { $buttons = array(); foreach ($info['getKeyFrom']['buy_links'] as $keyName => $link) { $buttons[] = Text::sprintf('COM_COMPONENTBUILDER_BGET_THE_KEY_FROM_SB_FOR_A_SSA', $owner, 'class="btn btn-primary" href="'.$link.'" target="_blank" title="get a key from '.$owner.'"', $keyName); } $ownerDetails .= '
'; $ownerDetails .= implode('
', $buttons); } // return the owner details if (!$hasOwner) { $ownerDetails = '

' . Text::_('COM_COMPONENTBUILDER_PACKAGE_OWNER_DETAILS_NOT_FOUND') . '

'; if (!$trust) { $ownerDetails .= '

' . Text::_('COM_COMPONENTBUILDER_BE_CAUTIOUS_DO_NOT_CONTINUE_UNLESS_YOU_TRUST_THE_ORIGIN_OF_THIS_PACKAGE') . '

'; } } return '
'.$ownerDetails.'
'; } public static function getPackageOwnerValue($key, &$info) { $source = (isset($info['source']) && isset($info['source'][$key])) ? 'source' : ((isset($info['getKeyFrom']) && isset($info['getKeyFrom'][$key])) ? 'getKeyFrom' : false); if ($source && UtilitiesStringHelper::check($info[$source][$key])) { return $info[$source][$key]; } return false; } /** * get the JCB package component key status **/ public static function getPackageComponentsKeyStatus(&$info) { // check the package key status if (!isset($info['key'])) { if (isset($info['getKeyFrom']) && isset($info['getKeyFrom']['owner'])) { // this just confirms it for older packages $info['key'] = true; } else { // this just confirms it for older packages $info['key'] = false; } } return $info['key']; } protected static $compOwnerSearch = array( 'ul' => array ( 'companyname' => 'COM_COMPONENTBUILDER_ICOMPANYI_BSB', 'author' => 'COM_COMPONENTBUILDER_IAUTHORI_BSB', 'email' => 'COM_COMPONENTBUILDER_IEMAILI_BSB', 'website' => 'COM_COMPONENTBUILDER_IWEBSITEI_BSB', ), 'other' => array( 'license' => 'COM_COMPONENTBUILDER_HFOUR_CLASSNAVHEADERLICENSEHFOURPSP', 'copyright' => 'COM_COMPONENTBUILDER_HFOUR_CLASSNAVHEADERCOPYRIGHTHFOURPSP' ) ); /** * get the JCB package component details display **/ public static function getPackageComponentsDetailsDisplay(&$info) { // check if these components need a key $needKey = self::getPackageComponentsKeyStatus($info); if (isset($info['name']) && UtilitiesArrayHelper::check($info['name'])) { $cAmount = count((array) $info['name']); $class2 = ($cAmount == 1) ? 'span12' : 'span6'; $counter = 1; $display = array(); foreach ($info['name'] as $key => $value) { // set the name $name= $value . ' v' . $info['component_version'][$key]; if ($cAmount > 1 && $counter == 3) { $display[] = ''; $counter = 1; } if ($cAmount > 1 && $counter == 1) { $display[] = '
'; } $display[] = '
'; $display[] = '

'; $display[] = $name; if ($needKey) { $display[] = ' - ' . Text::sprintf('COM_COMPONENTBUILDER_PAIDLOCKED') . ''; } else { $display[] = ' - ' . Text::sprintf('COM_COMPONENTBUILDER_FREEOPEN') . ''; } $display[] = '

'; $display[] = $info['short_description'][$key]; $display[] = '

'; $display[] = '
    '; // load the list items foreach (self::$compOwnerSearch['ul'] as $li => $value) { if (isset($info[$li]) && isset($info[$li][$key])) { $display[] = '
  • '.Text::sprintf($value, $info[$li][$key]).'
  • '; } } $display[] = '
'; // if we have a source link we add it if (isset($info['joomla_source_link']) && UtilitiesArrayHelper::check($info['joomla_source_link']) && isset($info['joomla_source_link'][$key]) && UtilitiesStringHelper::check($info['joomla_source_link'][$key])) { $display[] = 'source code'; } // load other foreach (self::$compOwnerSearch['other'] as $other => $value) { if (isset($info[$other]) && isset($info[$other][$key])) { $display[] = Text::sprintf($value, $info[$other][$key]); } } $display[] = '
'; $counter++; } // close the div if needed if ($cAmount > 1) { $display[] = '
'; } return implode("\n",$display); } return '
'.Text::_('COM_COMPONENTBUILDER_NO_COMPONENT_DETAILS_FOUND_SO_IT_IS_NOT_SAFE_TO_CONTINUE').'
'; } /** * get the database table columns **/ public static function getDbTableColumns($tableName, $as, $type) { // Get a db connection. $db = Factory::getDbo(); // get the columns $columns = $db->getTableColumns("#__" . $tableName); // set the type (multi or single) $unique = ''; if (1 == $type) { $unique = UtilitiesStringHelper::safe($tableName) . '_'; } if (UtilitiesArrayHelper::check($columns)) { // build the return string $tableColumns = array(); foreach ($columns as $column => $typeCast) { $tableColumns[] = $as . "." . $column . ' AS ' . $unique . $column; } return implode("\n", $tableColumns); } return false; } /** * get the view table columns **/ public static function getViewTableColumns($admin_view, $as, $type) { // Get a db connection. $db = Factory::getDbo(); // Create a new query object. $query = $db->getQuery(true); $query->select($db->quoteName(array('a.addfields', 'b.name_single'))); $query->from($db->quoteName('#__componentbuilder_admin_fields', 'a')); $query->join('LEFT', $db->quoteName('#__componentbuilder_admin_view', 'b') . ' ON (' . $db->quoteName('a.admin_view') . ' = ' . $db->quoteName('b.id') . ')'); $query->where($db->quoteName('b.published') . ' = 1'); $query->where($db->quoteName('a.admin_view') . ' = ' . (int) $admin_view); // Reset the query using our newly populated query object. $db->setQuery($query); $db->execute(); if ($db->getNumRows()) { $result = $db->loadObject(); $tableName = ''; if (1 == $type) { $tableName = UtilitiesStringHelper::safe($result->name_single) . '_'; } $addfields = json_decode($result->addfields, true); if (UtilitiesArrayHelper::check($addfields)) { // reset all buckets $field = array(); $fields = array(); // get data foreach ($addfields as $nr => $value) { $tmp = self::getFieldNameAndType((int) $value['field']); if (UtilitiesArrayHelper::check($tmp)) { $field[$nr] = $tmp; } // insure it is set to alias if needed if (isset($value['alias']) && $value['alias'] == 1) { $field[$nr]['name'] = 'alias'; } // remove a field that is not being stored in the database if (!isset($value['list']) || $value['list'] == 2) { unset($field[$nr]); } } // add the basic defaults $fields[] = $as . ".id AS " . $tableName . "id"; $fields[] = $as . ".asset_id AS " . $tableName . "asset_id"; // load data foreach ($field as $n => $f) { if (UtilitiesArrayHelper::check($f)) { $fields[] = $as . "." . $f['name'] . " AS " . $tableName . $f['name']; } } // add the basic defaults $fields[] = $as . ".published AS " . $tableName . "published"; $fields[] = $as . ".created_by AS " . $tableName . "created_by"; $fields[] = $as . ".modified_by AS " . $tableName . "modified_by"; $fields[] = $as . ".created AS " . $tableName . "created"; $fields[] = $as . ".modified AS " . $tableName . "modified"; $fields[] = $as . ".version AS " . $tableName . "version"; $fields[] = $as . ".hits AS " . $tableName . "hits"; if (0) // TODO access is not set here but per/view in the form linking this admin view to which these field belong to the components (boooo I know but that is the case and so we can't ever really know at this point if this view has access set) { $fields[] = $as . ".access AS " . $tableName . "access"; } $fields[] = $as . ".ordering AS " . $tableName . "ordering"; // return the field of this view return implode("\n", $fields); } } return false; } public static function getFieldNameAndType($id, $spacers = false) { // Get a db connection. $db = Factory::getDbo(); // Create a new query object. $query = $db->getQuery(true); // Order it by the ordering field. $query->select($db->quoteName(array('a.name', 'a.xml'))); $query->select($db->quoteName(array('c.name'), array('type_name'))); $query->from('#__componentbuilder_field AS a'); $query->join('LEFT', $db->quoteName('#__componentbuilder_fieldtype', 'c') . ' ON (' . $db->quoteName('a.fieldtype') . ' = ' . $db->quoteName('c.id') . ')'); $query->where($db->quoteName('a.id') . ' = '. $db->quote($id)); // Reset the query using our newly populated query object. $db->setQuery($query); $db->execute(); if ($db->getNumRows()) { // Load the results as a list of stdClass objects (see later for more options on retrieving data). $field = $db->loadObject(); // load the values form params $field->xml = json_decode($field->xml); $field->type_name = self::safeTypeName($field->type_name); $load = true; // if category then name must be catid (only one per view) if ($field->type_name === 'category') { $name = 'catid'; } // if tag is set then enable all tag options for this view (only one per view) elseif ($field->type_name === 'tag') { $name = 'tags'; } // don't add spacers or notes elseif (!$spacers && ($field->type_name == 'spacer' || $field->type_name == 'note')) { // make sure the name is unique return false; } else { $name = self::safeFieldName(GetHelper::between($field->xml,'name="','"')); } // use field core name only if not found in xml if (!UtilitiesStringHelper::check($name)) { $name = self::safeFieldName($field->name); } return array('name' => $name, 'type' => $field->type_name); } return false; } /** * validate that a placeholder is unique **/ public static function validateUniquePlaceholder($id, $name, $bool = false) { // make sure no padding is set $name = preg_replace("/[^A-Za-z0-9_]/", '', $name); // this list may grow as we find more cases that break the compiler (just open an issue on github) if (in_array($name, array('component', 'view', 'views'))) { // check if we must return boolean if (!$bool) { return array ( 'message' => Text::_('COM_COMPONENTBUILDER_SORRY_THIS_PLACEHOLDER_IS_ALREADY_IN_USE_IN_THE_COMPILER'), 'status' => 'danger'); } return false; } // add the padding (needed) $name = '[[[' . trim($name) . ']]]'; if (self::placeholderIsSet($id, $name)) { // check if we must return boolean if (!$bool) { return array ( 'message' => Text::_('COM_COMPONENTBUILDER_SORRY_THIS_PLACEHOLDER_IS_ALREADY_IN_USE'), 'status' => 'danger'); } return false; } // check if we must return boolean if (!$bool) { return array ( 'name' => $name, 'message' => Text::_('COM_COMPONENTBUILDER_GREAT_THIS_PLACEHOLDER_WILL_WORK'), 'status' => 'success'); } return true; } /** * search for placeholder in table **/ protected static function placeholderIsSet($id, $name) { // query the table for result array if (($results = self::getPlaceholderTarget($id, $name)) !== false) { // check if we must continue the search foreach ($results as $_id => $target) { if ($name === $target) { return true; } } } return false; } /** * get placeholder target **/ protected static function getPlaceholderTarget($id, $name) { // Get a db connection. $db = Factory::getDbo(); // Create a new query object. $query = $db->getQuery(true); $query->select($db->quoteName(array('id', 'target'))); $query->from($db->quoteName('#__componentbuilder_placeholder')); $query->where($db->quoteName('target') . ' = '. $db->quote($name)); // check if we have id if (is_numeric($id)) { $query->where($db->quoteName('id') . ' <> ' . (int) $id); } $db->setQuery($query); $db->execute(); if ($db->getNumRows()) { return $db->loadAssocList('id', 'target'); } return false; } /** * Powers to exclude **/ public static function excludePowers($id) { // first check if this power set is already found if (!isset(self::$exPowers[$id])) { // Get a db connection. $db = Factory::getDbo(); // Create a new query object. $query = $db->getQuery(true); $query->select($db->quoteName(array('a.id'))); $query->from($db->quoteName('#__componentbuilder_power', 'a')); $query->join('LEFT', $db->quoteName('#__componentbuilder_power', 'b') . ' ON (' . $db->quoteName('a.name') . ' = ' . $db->quoteName('b.name') . ' AND ' . $db->quoteName('a.namespace') . ' = ' . $db->quoteName('b.namespace') . ')'); $query->where($db->quoteName('b.id') . ' = ' . (int) $id); $db->setQuery($query); $db->execute(); if ($db->getNumRows()) { self::$exPowers[$id] = $db->loadColumn(); } // all ways add itself aswell self::$exPowers[$id][] = $id; } // if found return if (isset(self::$exPowers[$id])) { return self::$exPowers[$id]; } return false; } /** * The array of dynamic content * * @var array */ protected static array $dynamicContent = [ // The banners by size (width - height) 'banner' => [ '728-90' => [ [ 'url' => 'https://git.vdm.dev/joomla/jcb-external/raw/branch/master/src/images/banner/joomla-heart-wide.gif', 'hash' => 'f857e3a38facaeac9eba3cffa912b620', 'html' => 'Joomla! Volunteers Portal'], [ 'url' => 'https://git.vdm.dev/joomla/jcb-external/raw/branch/master/src/images/banner/JCM_2010_120x600.png', 'hash' => '5389cf3be8569cb3f6793e8bd4013d19', 'html' => 'Joomla! Community Magazine | Because community matters...'], [ 'url' => 'https://git.vdm.dev/joomla/jcb-external/raw/branch/master/src/images/banner/tlwebdesign_jcb_sponsor_728_90.png', 'hash' => 'd19be1f9f5b2049ff901096aafc246be', 'html' => 'tlwebdesign a JCB sponsor | Because community matters...'], [ 'url' => 'https://git.vdm.dev/joomla/jcb-external/raw/branch/master/src/images/banner/vdm_jcb_sponsor_728_90.gif', 'hash' => '84478dfa0cd880395815e0ee026812a4', 'html' => 'VDM a JCB sponsor | Because community matters...'], [ 'url' => 'https://cms-experts.org/images/banners/agerix/agerix-loves-jcb-728-90.gif', 'hash' => 'b24c0726aa809cdcc04bcffe7e1e1529', 'html' => 'Agerix a JCB sponsor | Because community matters...'] ], '160-600' => [ [ 'url' => 'https://git.vdm.dev/joomla/jcb-external/raw/branch/master/src/images/banner/joomla-heart-tall.gif', 'hash' => '9a75e4929b86c318128b53cf78251678', 'html' => 'Joomla! Volunteers Portal'], [ 'url' => 'https://git.vdm.dev/joomla/jcb-external/raw/branch/master/src/images/banner/JCM_2010_120x600.png', 'hash' => '5389cf3be8569cb3f6793e8bd4013d19', 'html' => 'Joomla! Community Magazine | Because community matters...'] ] ], // The build-gif by size (width - height) 'builder-gif' => [ // original gif ;) '480-272' => [ [ 'url' => 'https://www.joomlacomponentbuilder.com/images/builder/original.gif', 'hash' => '676e37a949add8f4573381195cd1061c', 'html' => '' ] ], // new gif artwork since 2021 '480-540' => [ [ 'url' => 'https://git.vdm.dev/joomla/jcb-external/raw/branch/master/src/images/builder/1.gif', 'hash' => 'ce6e36456fa794ba95d981547b2f54f8', 'html' => '
Animation produced with 3D Particle Explorations by Jack Rugile.
'], [ 'url' => 'https://git.vdm.dev/joomla/jcb-external/raw/branch/master/src/images/builder/2.gif', 'hash' => '0a54dbc393359747e33db90cabb1e2d7', 'html' => '
Animation produced with 3D Particle Explorations by Jack Rugile.
'], [ 'url' => 'https://git.vdm.dev/joomla/jcb-external/raw/branch/master/src/images/builder/3.gif', 'hash' => '4e5498713ff69a64a0a79dbf620372a3', 'html' => '
Animation produced with 3D Particle Explorations by Jack Rugile.
'], [ 'url' => 'https://git.vdm.dev/joomla/jcb-external/raw/branch/master/src/images/builder/4.gif', 'hash' => '3554ffab2a6df95a116fd9f0db63925c', 'html' => '
Animation produced with 3D Particle Explorations by Jack Rugile.
'], [ 'url' => 'https://git.vdm.dev/joomla/jcb-external/raw/branch/master/src/images/builder/5.gif', 'hash' => '08f0cdf188593eca65c6dafd7af27ef9', 'html' => '
Animation produced with 3D Particle Explorations by Jack Rugile.
'], [ 'url' => 'https://git.vdm.dev/joomla/jcb-external/raw/branch/master/src/images/builder/6.gif', 'hash' => '103b46a7ac3fcb974e25d06f417a4e87', 'html' => '
Animation produced with 3D Particle Explorations by Jack Rugile.
'], [ 'url' => 'https://git.vdm.dev/joomla/jcb-external/raw/branch/master/src/images/builder/7.gif', 'hash' => 'ffa8547099b7286f89ab7ff5a140dd90', 'html' => '
Animation produced with 3D Particle Explorations by Jack Rugile.
'], [ 'url' => 'https://git.vdm.dev/joomla/jcb-external/raw/branch/master/src/images/builder/8.gif', 'hash' => '316df780f9e4ce81200a65d3c4303c41', 'html' => '
Animation produced with 3D Particle Explorations by Jack Rugile.
'], [ 'url' => 'https://git.vdm.dev/joomla/jcb-external/raw/branch/master/src/images/builder/9.gif', 'hash' => '9ab6ba78b6e63a285fdef2ff5e447c93', 'html' => '
Animation produced with 3D Particle Explorations by Jack Rugile.
'], [ 'url' => 'https://git.vdm.dev/joomla/jcb-external/raw/branch/master/src/images/builder/10.gif', 'hash' => 'cd9abaa1cb95f51a70916da6b70614f2', 'html' => '
Animation produced with 3D Particle Explorations by Jack Rugile.
'], [ 'url' => 'https://git.vdm.dev/joomla/jcb-external/raw/branch/master/src/images/builder/11.gif', 'hash' => 'cfe53095b5249618e2348223b89262b9', 'html' => '
Animation produced with 3D Particle Explorations by Jack Rugile.
'], [ 'url' => 'https://git.vdm.dev/joomla/jcb-external/raw/branch/master/src/images/builder/12.gif', 'hash' => '15a6690647d5160d67c80ce4dd1f5602', 'html' => '
Animation produced with 3D Particle Explorations by Jack Rugile.
'], [ 'url' => 'https://git.vdm.dev/joomla/jcb-external/raw/branch/master/src/images/builder/13.gif', 'hash' => '2f77562e92c8a3b7c47664c98f551fe8', 'html' => '
Animation produced with 3D Particle Explorations by Jack Rugile.
'], [ 'url' => 'https://git.vdm.dev/joomla/jcb-external/raw/branch/master/src/images/builder/14.gif', 'hash' => '46db15517ef5bd063be85134e1cc575d', 'html' => '
Animation produced with 3D Particle Explorations by Jack Rugile.
'], [ 'url' => 'https://git.vdm.dev/joomla/jcb-external/raw/branch/master/src/images/builder/15.gif', 'hash' => 'e6c96eff157ea648ceb1583f2cc22544', 'html' => '
Animation produced with 3D Particle Explorations by Jack Rugile.
'], [ 'url' => 'https://git.vdm.dev/joomla/jcb-external/raw/branch/master/src/images/builder/16.gif', 'hash' => '76010b7d1f99952eb9645df660467ae8', 'html' => '
Animation produced with 3D Particle Explorations by Jack Rugile.
'], [ 'url' => 'https://git.vdm.dev/joomla/jcb-external/raw/branch/master/src/images/builder/17.gif', 'hash' => '021219ddd72d8fcfc7f80bd4a874d651', 'html' => '
Animation produced with 3D Particle Explorations by Jack Rugile.
'], [ 'url' => 'https://git.vdm.dev/joomla/jcb-external/raw/branch/master/src/images/builder/18.gif', 'hash' => '383af3179d4ae27301c1292e630d7155', 'html' => '
Animation produced with 3D Particle Explorations by Jack Rugile.
'], [ 'url' => 'https://git.vdm.dev/joomla/jcb-external/raw/branch/master/src/images/builder/19.gif', 'hash' => '8537e6d7be93447241b521f851e8a61d', 'html' => '
Animation produced with 3D Particle Explorations by Jack Rugile.
'], [ 'url' => 'https://git.vdm.dev/joomla/jcb-external/raw/branch/master/src/images/builder/20.gif', 'hash' => '10d96f70e3d43086a925b00a7dc0022e', 'html' => '
Animation produced with 3D Particle Explorations by Jack Rugile.
'], [ 'url' => 'https://git.vdm.dev/joomla/jcb-external/raw/branch/master/src/images/builder/21.gif', 'hash' => '161de9865b171b44039353b8d50491d3', 'html' => '
Animation produced with 3D Particle Explorations by Jack Rugile.
'], [ 'url' => 'https://git.vdm.dev/joomla/jcb-external/raw/branch/master/src/images/builder/22.gif', 'hash' => '6a2354e43eb97d278d74bb2c12890988', 'html' => '
Animation produced with 3D Particle Explorations by Jack Rugile.
'], [ 'url' => 'https://git.vdm.dev/joomla/jcb-external/raw/branch/master/src/images/builder/23.gif', 'hash' => '2cb6e2f9562a8dc8eef6d5d8d1a84f5e', 'html' => '
Animation produced with 3D Particle Explorations by Jack Rugile.
'], [ 'url' => 'https://git.vdm.dev/joomla/jcb-external/raw/branch/master/src/images/builder/24.gif', 'hash' => '745b3fb5e16515689132432bf02ab1b4', 'html' => '
Animation produced with 3D Particle Explorations by Jack Rugile.
'] ] ] ]; /** * get the dynamic content array size * * @param string $type The type of content * @param string $size The size of the content * * @return int on success number of items in array type,size * */ public static function getDynamicContentSize(string $type, string $size): int { if (isset(self::$dynamicContent[$type]) && isset(self::$dynamicContent[$type][$size]) && ($nr = UtilitiesArrayHelper::check(self::$dynamicContent[$type][$size]))) { return $nr; } return 0; } /** * get the dynamic content * * @param string $type The type of content * @param string $size The size of the content * @param mixed $default The default to return * @param int $try Retry tracker (when bigger then array size it stops) * @param mixed $getter The specific getter number (not zero based) * * @return string on success html string * */ public static function getDynamicContent(string $type, string $size, $default = '', int $try = 1, $getter = null) { if (($nr = self::getDynamicContentSize($type, $size)) !== 0) { // use specific getter if ($getter) { $get = --$getter; } // get the random getter number elseif ($nr > 1) { $get = (int) rand(0, --$nr); } else { $get = 0; } // get the current target if found if (isset(self::$dynamicContent[$type][$size][$get])) { $target = self::$dynamicContent[$type][$size][$get]; // set file name $file_name = basename($target['url']); // set the local path (in admin area so when the component uninstall these images get removed as well) $path = JPATH_ROOT . "/administrator/components/com_componentbuilder/assets/images/$type/$file_name"; // check if file exist or if it changed if (($image_data = FileHelper::getContent($path, false)) === false || md5($image_data) !== $target['hash']) { // since the file does not exist or has changed (so we have a new hash) // therefore we download it to validate if (($image_data = FileHelper::getContent($target['url'], false)) !== false && md5($image_data) === $target['hash']) { // create the JCB type path if it does not exist if (!Folder::exists(JPATH_ROOT . "/administrator/components/com_componentbuilder/assets/images/$type")) { Folder::create(JPATH_ROOT . "/administrator/components/com_componentbuilder/assets/images/$type"); } // only set the image if the data match the hash FileHelper::write($path, $image_data); } // we retry array size times (unless specific getter is used) elseif ($try <= $nr && !$getter) { // the first time around failed so we try again (the size of the array times) return self::getDynamicContent($type, $size, $default, ++$try); } } // return found content return str_replace('[[[ROOT-URL]]]', JURI::root(), $target['html']); } } return $default; } /** * Tab/spacer bucket (to speed-up the build) * * @var array */ protected static $tabSpacerBucket = array(); /** * Set tab/spacer * * @var string */ protected static $tabSpacer = "\t"; /** * Set the tab/space * * @param int $nr The number of tag/space * * @return string * */ public static function _t($nr) { // check if we already have the string if (!isset(self::$tabSpacerBucket[$nr])) { // get the string self::$tabSpacerBucket[$nr] = str_repeat(self::$tabSpacer, (int) $nr); } // return stored string return self::$tabSpacerBucket[$nr]; } /** * the Butler **/ public static $session = array(); /** * the Butler Assistant **/ protected static $localSession = array(); /** * start a session if not already set, and load with data **/ public static function loadSession() { if (!isset(self::$session) || !ObjectHelper::check(self::$session)) { self::$session = Factory::getSession(); } // set the defaults self::setSessionDefaults(); } /** * give Session more to keep **/ public static function set($key, $value) { if (!isset(self::$session) || !ObjectHelper::check(self::$session)) { self::$session = Factory::getSession(); } // set to local memory to speed up program self::$localSession[$key] = $value; // load to session for later use return self::$session->set($key, self::$localSession[$key]); } /** * get info from Session **/ public static function get($key, $default = null) { if (!isset(self::$session) || !ObjectHelper::check(self::$session)) { self::$session = Factory::getSession(); } // check if in local memory if (!isset(self::$localSession[$key])) { // set to local memory to speed up program self::$localSession[$key] = self::$session->get($key, $default); } return self::$localSession[$key]; } /** * get field type properties * * @return array on success * */ public static function getFieldTypeProperties($value, $type, $settings = array(), $xml = null, $dbDefaults = false) { // Get a db connection. $db = Factory::getDbo(); // Create a new query object. $query = $db->getQuery(true); $query->select($db->quoteName(array('properties', 'short_description', 'description'))); // load database default values if ($dbDefaults) { $query->select($db->quoteName(array('datadefault', 'datadefault_other', 'datalenght', 'datalenght_other', 'datatype', 'has_defaults', 'indexes', 'null_switch', 'store'))); } $query->from($db->quoteName('#__componentbuilder_fieldtype')); $query->where($db->quoteName('published') . ' = 1'); $query->where($db->quoteName($type) . ' = '. $value); // Reset the query using our newly populated query object. $db->setQuery($query); $db->execute(); if ($db->getNumRows()) { $result = $db->loadObject(); $properties = json_decode($result->properties, true); $field = array( 'subform' => array(), 'nameListOptions' => array(), 'php' => array(), 'values' => " '', 'short_description' => $result->short_description, 'description' => $result->description); // number pointer $nr = 0; // php tracker (we must try to load alteast 17 rows $phpTracker = array(); // force load all properties $forceAll = false; if ($xml && strpos($xml, '..__FORCE_LOAD_ALL_PROPERTIES__..') !== false) { $forceAll = true; } // value to check since there are false and null values even 0 in the values returned $confirmation = '8qvZHoyuFYQqpj0YQbc6F3o5DhBlmS-_-a8pmCZfOVSfANjkmV5LG8pCdAY2JNYu6cB'; // set the headers $field['values_description'] .= ''; foreach ($properties as $property) { $example = (isset($property['example']) && UtilitiesStringHelper::check($property['example'])) ? $property['example'] : ''; $field['values_description'] .= ''; // check if we should load the value $value = FieldHelper::getValue($xml, $property['name'], $confirmation); // check if this is a php field $addPHP = false; if (strpos($property['name'], 'type_php') !== false) { $addPHP = true; // set the line number $phpLine = (int) preg_replace('/[^0-9]/', '', $property['name']); // set the key $phpKey = trim(preg_replace('/[0-9]+/', '', $property['name']), '_'); // start array if not already set if (!isset($field['php'][$phpKey])) { $field['php'][$phpKey] = array(); $field['php'][$phpKey]['value'] = array(); $field['php'][$phpKey]['desc'] = $property['description']; // start tracker $phpTracker[$phpKey] = 1; } } // was the settings for the property passed if(UtilitiesArrayHelper::check($settings) && isset($settings[$property['name']])) { // add the xml values $field['values'] .= PHP_EOL . "\t" . $property['name'] . '="'. $settings[$property['name']] . '" '; // add the json values if ($addPHP) { $field['php'][$phpKey]['value'][$phpLine] = $settings[$property['name']]; $phpTracker[$phpKey]++; } else { $field['subform']['properties'.$nr] = array('name' => $property['name'], 'value' => $settings[$property['name']], 'desc' => $property['description']); } } elseif ($forceAll || !$xml || $confirmation !== $value) { // add the xml values $field['values'] .= PHP_EOL."\t" . $property['name'] . '="' . ($confirmation !== $value) ? $value : $example .'" '; // add the json values if ($addPHP) { $field['php'][$phpKey]['value'][$phpLine] = ($confirmation !== $value) ? $value : $example; $phpTracker[$phpKey]++; } else { $field['subform']['properties' . $nr] = array('name' => $property['name'], 'value' => ($confirmation !== $value) ? $value : $example, 'desc' => $property['description']); } } // add the name List Options if (!$addPHP) { $field['nameListOptions'][$property['name']] = $property['name']; } // increment the number $nr++; } // check if all php is loaded using the tracker if (UtilitiesStringHelper::check($xml) && isset($phpTracker) && UtilitiesArrayHelper::check($phpTracker)) { foreach ($phpTracker as $phpKey => $start) { if ($start < 30) { // we must search for more code in the xml just incase foreach(range(2, 30) as $t_nr) { $get_ = $phpKey . '_' . $t_nr; if (!isset($field['php'][$phpKey]['value'][$t_nr]) && ($value = FieldHelper::getValue($xml, $get_, $confirmation)) !== $confirmation) { $field['php'][$phpKey]['value'][$t_nr] = $value; } } } } } $field['values'] .= PHP_EOL . "/>"; $field['values_description'] .= '
' . Text::_('COM_COMPONENTBUILDER_PROPERTY') . '' . Text::_('COM_COMPONENTBUILDER_EXAMPLE') . '' . Text::_('COM_COMPONENTBUILDER_DESCRIPTION') . '
' . $property['name'] . '' . $example . '' . $property['description'] . '
'; // load the database defaults if set and wanted if ($dbDefaults && isset($result->has_defaults) && $result->has_defaults == 1) { $field['database'] = array( 'datatype' => $result->datatype, 'datadefault' => $result->datadefault, 'datadefault_other' => $result->datadefault_other, 'datalenght' => $result->datalenght, 'datalenght_other' => $result->datalenght_other, 'indexes' => $result->indexes, 'null_switch' => $result->null_switch, 'store' => $result->store ); } // return found field options return $field; } return false; } /** * Get a field value from the XML stored string * * @param string $xml The xml string of the field * @param string $get The value key to get from the string * @param string $confirmation The value to confirm found value * * @return string The field value from xml * @deprecated 3.3 Use FieldHelper::getValue($xml, $get, $confirmation); */ public static function getValueFromXMLstring(&$xml, &$get, $confirmation = '') { return FieldHelper::getValue($xml, $get, $confirmation); } /** * get field types properties * * @return array on success * */ public static function getFieldTypesProperties($targets = array(), $filter = array(), $exclude = array(), $type = 'id', $operator = 'IN') { // Get a db connection. $db = Factory::getDbo(); // Create a new query object. $query = $db->getQuery(true); $query->select($db->quoteName(array('id','properties'))); $query->from($db->quoteName('#__componentbuilder_fieldtype')); $query->where($db->quoteName('published') . ' = 1'); // make sure we have ids (or get all) if ('IN_STRINGS' === $operator || 'NOT IN_STRINGS' === $operator) { $query->where($db->quoteName($type) . ' ' . str_replace('_STRINGS', '', $operator) . ' ("' . implode('","',$targets) . '")'); } else { $query->where($db->quoteName($type) . ' ' . $operator . ' (' . implode(',',$targets) . ')'); } // Reset the query using our newly populated query object. $db->setQuery($query); $db->execute(); if ($db->getNumRows()) { $_types = array(); $_properties = array(); $types = $db->loadObjectList('id'); foreach ($types as $id => $type) { $properties = json_decode($type->properties); foreach ($properties as $property) { if (!isset($_types[$id])) { $_types[$id] = array(); } // add if no objection is found $add = true; // check if we have exclude if (UtilitiesArrayHelper::check($exclude) && in_array($property->name, $exclude)) { continue; } // check if we have filter if (UtilitiesArrayHelper::check($filter)) { foreach($filter as $key => $val) { if (!isset($property->$key) || $property->$key != $val) { $add = false; } } } // now add the property if ($add) { $_types[$id][$property->name] = array('name' => ucfirst($property->name), 'example' => $property->example, 'description' => $property->description); // set mandatory if (isset($property->mandatory) && $property->mandatory == 1) { $_types[$id][$property->name]['mandatory'] = true; } else { $_types[$id][$property->name]['mandatory'] = false; } // set translatable if (isset($property->translatable) && $property->translatable == 1) { $_types[$id][$property->name]['translatable'] = true; } else { $_types[$id][$property->name]['translatable'] = false; } $_properties[$property->name] = $_types[$id][$property->name]['name']; } } } // return found types & properties return array('types' => $_types, 'properties' => $_properties); } return false; } /** * Remove folders with files * * @param string $path The path to folder to remove * @param array|null $ignore The folders and files to ignore and not remove * * @return bool True if all are removed */ public static function removeFolder(string $path, ?array $ignore = null): bool { if (!Folder::exists($path)) { return false; } $it = new \RecursiveDirectoryIterator($path, \RecursiveDirectoryIterator::SKIP_DOTS); $files = new \RecursiveIteratorIterator($it, \RecursiveIteratorIterator::CHILD_FIRST); // Prepare a base path without trailing slash for comparison $basePath = rtrim($path, '/'); foreach ($files as $fileinfo) { $filePath = $fileinfo->getRealPath(); if (self::removeFolderShouldIgnore($basePath, $filePath, $ignore)) { continue; } if ($fileinfo->isDir()) { Folder::delete($filePath); } else { File::delete($filePath); } } // Delete the root folder if ignore not set if (!UtilitiesArrayHelper::check($ignore)) { return Folder::delete($path); } return true; } /** * Check if the current path should be ignored. * * @param string $basePath The base directory path * @param string $filePath The current file or directory path * @param array|null $ignore List of items to ignore * * @return boolean True if the path should be ignored * @since 3.2.0 */ protected static function removeFolderShouldIgnore(string $basePath, string $filePath, ?array $ignore = null): bool { if (!$ignore || !UtilitiesArrayHelper::check($ignore)) { return false; } foreach ($ignore as $item) { if (strpos($filePath, $basePath . '/' . $item) !== false) { return true; } } return false; } /** * The github access token **/ protected static $gitHubAccessToken = ""; /** * The github repo get data errors **/ public static $githubRepoDataErrors = array(); /** * get the github repo file list * * @return array on success * */ public static function getGithubRepoFileList($type, $target) { // get the repo data if (($repoData = self::getGithubRepoData($type, $target, 'tree')) !== false) { return $repoData->tree; } return false; } /** * get the github repo file list * * @return array on success * */ public static function getGithubRepoData($type, $url, $target = null, $return_type = 'object') { // always reset errors per/request self::$githubRepoDataErrors = array(); // get the current Packages (public) if ('nomemory' === $type || !$repoData = self::get($type)) { // add the token if not already added $_url = self::setGithubToken($url); // check if the url exist if (self::urlExists($_url)) { // get the data from github if (($repoData = FileHelper::getContent($_url)) !== false && JsonHelper::check($repoData)) { $github_returned = json_decode($repoData); if (UtilitiesStringHelper::check($target) && ( (ObjectHelper::check($github_returned) && isset($github_returned->{$target}) && UtilitiesArrayHelper::check($github_returned->{$target})) || (UtilitiesArrayHelper::check($github_returned) && isset($github_returned[$target]) && UtilitiesArrayHelper::check($github_returned[$target])) )) { if ('nomemory' !== $type) { // remember to set it self::set($type, $repoData); } } elseif (!UtilitiesStringHelper::check($target) && (UtilitiesArrayHelper::check($github_returned) || (ObjectHelper::check($github_returned) && !isset($github_returned->message)))) { if ('nomemory' !== $type) { // remember to set it self::set($type, $repoData); } } // check if we have error message from github elseif (($errorMessage = self::githubErrorHandeler(array('error' => null), $github_returned, $type)) !== false) { if (isset($errorMessage['error']) && UtilitiesStringHelper::check($errorMessage['error'])) { // set the error in the application Factory::getApplication()->enqueueMessage($errorMessage['error'], 'Error'); // set the error also in the class encase it is and Ajax call self::$githubRepoDataErrors[] = $errorMessage['error']; } return false; } elseif (UtilitiesStringHelper::check($target)) { // setup error string $error = Text::sprintf('COM_COMPONENTBUILDER_THE_URL_S_SET_TO_RETRIEVE_THE_PACKAGES_DID_NOT_RETURN_S_DATA', $url, $target); // set the error in the application Factory::getApplication()->enqueueMessage($error, 'Error'); // set the error also in the class encase it is and Ajax call self::$githubRepoDataErrors[] = $error; // we are done here return false; } elseif ('nomemory' !== $type) { // setup error string $error = Text::sprintf('COM_COMPONENTBUILDER_THE_URL_S_SET_TO_RETRIEVE_THE_PACKAGES_DID_NOT_RETURN_S_DATA', $url, $type); // set the error in the application Factory::getApplication()->enqueueMessage($error, 'Error'); // set the error also in the class encase it is and Ajax call self::$githubRepoDataErrors[] = $error; // we are done here return false; } else { // setup error string $error = Text::sprintf('COM_COMPONENTBUILDER_THE_URL_S_SET_TO_RETRIEVE_THE_PACKAGES_DID_NOT_RETURN_VALID_DATA', $url, $type); // set the error in the application Factory::getApplication()->enqueueMessage($error, 'Error'); // set the error also in the class encase it is and Ajax call self::$githubRepoDataErrors[] = $error; // we are done here return false; } } else { // setup error string $error = Text::sprintf('COM_COMPONENTBUILDER_THE_URL_S_SET_TO_RETRIEVE_THE_PACKAGES_DOES_NOT_RETURN_ANY_DATA', $url); // set the error in the application Factory::getApplication()->enqueueMessage($error, 'Error'); // set the error also in the class encase it is and Ajax call self::$githubRepoDataErrors[] = $error; // we are done here return false; } } else { // setup error string $error = Text::sprintf('COM_COMPONENTBUILDER_THE_URL_S_SET_TO_RETRIEVE_THE_PACKAGES_DOES_NOT_EXIST', $url); // set the error in the application Factory::getApplication()->enqueueMessage($error, 'Error'); // set the error also in the class encase it is and Ajax call self::$githubRepoDataErrors[] = $error; // we are done here return false; } } // check if we could find packages if (isset($repoData) && JsonHelper::check($repoData)) { if ('object' === $return_type) { return json_decode($repoData); } elseif ('array' === $return_type) { return json_decode($repoData, true); } return $repoData; } return false; } /** * get the github error messages * * @return array of errors on success * */ protected static function githubErrorHandeler($message, &$github, $type) { if (ObjectHelper::check($github) && isset($github->message) && UtilitiesStringHelper::check($github->message)) { // set the message $errorMessage = $github->message; // add the documentation URL if (isset($github->documentation_url) && UtilitiesStringHelper::check($github->documentation_url)) { $errorMessage = $errorMessage . '
' . $github->documentation_url; } // check the message if (strpos($errorMessage, 'Authenticated') !== false) { if ('nomemory' === $type) { $type = 'data'; } // add little more help if it is an access token issue $errorMessage = Text::sprintf('COM_COMPONENTBUILDER_SBR_YOU_CAN_ADD_A_BGITHUB_ACCESS_TOKENB_TO_COMPONENTBUILDER_GLOBAL_OPTIONS_TO_MAKE_AUTHENTICATED_REQUESTS_TO_GITHUB_AN_ACCESS_TOKEN_WITH_ONLY_PUBLIC_ACCESS_WILL_DO_TO_RETRIEVE_S', $errorMessage, $type); } // set error notice $message['error'] = $errorMessage; // we have error message return $message; } return false; } /** * set the github token * * @return array of errors on success * */ protected static function setGithubToken($url) { // first check if token already set if (strpos($url, 'access_token=') !== false) { // make sure the token is loaded if (!UtilitiesStringHelper::check(self::$gitHubAccessToken)) { // get the global settings if (!ObjectHelper::check(self::$params)) { self::$params = JComponentHelper::getParams('com_componentbuilder'); } self::$gitHubAccessToken = self::$params->get('github_access_token', null); } // make sure the token is loaded at this point if (UtilitiesStringHelper::check(self::$gitHubAccessToken)) { $url .= '&access_token=' . self::$gitHubAccessToken; } } return $url; } /** * get Dynamic Scripts * * @param string $type The target type of string * @param string $fieldName The target field name of string * * @return void * */ public static function getDynamicScripts($type, $fieldName = false) { // if field name is passed the convert to type if ($fieldName) { $fieldNames = array( 'php_import_display' => 'display', 'php_import_setdata' => 'setdata', 'php_import_save' => 'save', 'html_import_view' => 'view', 'php_import' => 'import', 'php_import_ext' => 'ext', 'php_import_headers' => 'headers' ); // first check if the field name is found if (isset($fieldNames[$type])) { $type = $fieldNames[$type]; } else { return ''; } } $script = array(); if ('display' === $type) { // set the display script $script['display'][] = self::_t(1) . "protected \$headerList;"; $script['display'][] = self::_t(1) . "protected \$hasPackage = false;"; $script['display'][] = self::_t(1) . "protected \$headers;"; $script['display'][] = self::_t(1) . "protected \$hasHeader = 0;"; $script['display'][] = self::_t(1) . "protected \$dataType;"; $script['display'][] = self::_t(1) . "public function display(\$tpl = null)"; $script['display'][] = self::_t(1) . "{"; $script['display'][] = self::_t(2) . "if (\$this->getLayout() !== 'modal')"; $script['display'][] = self::_t(2) . "{"; $script['display'][] = self::_t(3) . "// Include helper submenu"; $script['display'][] = self::_t(3) . "[[[-#-#-Component]]]Helper::addSubmenu('import');"; $script['display'][] = self::_t(2) . "}"; $script['display'][] = PHP_EOL . self::_t(2) . "\$paths = new \stdClass;"; $script['display'][] = self::_t(2) . "\$paths->first = '';"; $script['display'][] = self::_t(2) . "\$state = \$this->get('state');"; $script['display'][] = PHP_EOL . self::_t(2) . "\$this->paths = &\$paths;"; $script['display'][] = self::_t(2) . "\$this->state = &\$state;"; $script['display'][] = self::_t(2) . "// get global action permissions"; $script['display'][] = self::_t(2) . "\$this->canDo = [[[-#-#-Component]]]Helper::getActions('import');"; $script['display'][] = PHP_EOL . self::_t(2) . "// We don't need toolbar in the modal window."; $script['display'][] = self::_t(2) . "if (\$this->getLayout() !== 'modal')"; $script['display'][] = self::_t(2) . "{"; $script['display'][] = self::_t(3) . "\$this->addToolbar();"; $script['display'][] = self::_t(3) . "\$this->sidebar = JHtmlSidebar::render();"; $script['display'][] = self::_t(2) . "}"; $script['display'][] = PHP_EOL . self::_t(2) . "// get the session object"; $script['display'][] = self::_t(2) . "\$session = Factory::getSession();"; $script['display'][] = self::_t(2) . "// check if it has package"; $script['display'][] = self::_t(2) . "\$this->hasPackage" . self::_t(1) . "= \$session->get('hasPackage', false);"; $script['display'][] = self::_t(2) . "\$this->dataType" . self::_t(1) . "= \$session->get('dataType', false);"; $script['display'][] = self::_t(2) . "if(\$this->hasPackage && \$this->dataType)"; $script['display'][] = self::_t(2) . "{"; $script['display'][] = self::_t(3) . "\$this->headerList" . self::_t(1) . "= json_decode(\$session->get(\$this->dataType.'_VDM_IMPORTHEADERS', false),true);"; $script['display'][] = self::_t(3) . "\$this->headers" . self::_t(2) . "= [[[-#-#-Component]]]Helper::getFileHeaders(\$this->dataType);"; $script['display'][] = self::_t(3) . "// clear the data type"; $script['display'][] = self::_t(3) . "\$session->clear('dataType');"; $script['display'][] = self::_t(2) . "}"; $script['display'][] = PHP_EOL . self::_t(2) . "// Check for errors."; $script['display'][] = self::_t(2) . "if (count(\$errors = \$this->get('Errors'))){"; $script['display'][] = self::_t(3) . "throw new Exception(implode(PHP_EOL, \$errors), 500);"; $script['display'][] = self::_t(2) . "}"; $script['display'][] = PHP_EOL . self::_t(2) . "// Display the template"; $script['display'][] = self::_t(2) . "parent::display(\$tpl);"; $script['display'][] = self::_t(1) . "}"; } elseif ('setdata' === $type) { // set the setdata script $script['setdata'] = array(); $script['setdata'][] = self::_t(1) . "/**"; $script['setdata'][] = self::_t(1) . "* Set the data from the spreadsheet to the database"; $script['setdata'][] = self::_t(1) . "*"; $script['setdata'][] = self::_t(1) . "* @param string \$package Paths to the uploaded package file"; $script['setdata'][] = self::_t(1) . "*"; $script['setdata'][] = self::_t(1) . "* @return boolean false on failure"; $script['setdata'][] = self::_t(1) . "*"; $script['setdata'][] = self::_t(1) . "**/"; $script['setdata'][] = self::_t(1) . "protected function setData(\$package,\$table,\$target_headers)"; $script['setdata'][] = self::_t(1) . "{"; $script['setdata'][] = self::_t(2) . "if (Super-#-#-___0a59c65c_9daf_4bc9_baf4_e063ff9e6a8a___Power::check(\$target_headers))"; $script['setdata'][] = self::_t(2) . "{"; $script['setdata'][] = self::_t(3) . "// make sure the file is loaded"; $script['setdata'][] = self::_t(3) . "[[[-#-#-Component]]]Helper::composerAutoload('phpspreadsheet');"; $script['setdata'][] = self::_t(3) . "\$jinput = Factory::getApplication()->input;"; $script['setdata'][] = self::_t(3) . "foreach(\$target_headers as \$header)"; $script['setdata'][] = self::_t(3) . "{"; $script['setdata'][] = self::_t(4) . "if ((\$column = \$jinput->getString(\$header, false)) !== false ||"; $script['setdata'][] = self::_t(5) . "(\$column = \$jinput->getString(strtolower(\$header), false)) !== false)"; $script['setdata'][] = self::_t(4) . "{"; $script['setdata'][] = self::_t(5) . "\$data['target_headers'][\$header] = \$column;"; $script['setdata'][] = self::_t(4) . "}"; $script['setdata'][] = self::_t(4) . "else"; $script['setdata'][] = self::_t(4) . "{"; $script['setdata'][] = self::_t(5) . "\$data['target_headers'][\$header] = null;"; $script['setdata'][] = self::_t(4) . "}"; $script['setdata'][] = self::_t(3) . "}"; $script['setdata'][] = self::_t(3) . "// set the data"; $script['setdata'][] = self::_t(3) . "if(isset(\$package['dir']))"; $script['setdata'][] = self::_t(3) . "{"; $script['setdata'][] = self::_t(4) . "\$inputFileType = IOFactory::identify(\$package['dir']);"; $script['setdata'][] = self::_t(4) . "\$excelReader = IOFactory::createReader(\$inputFileType);"; $script['setdata'][] = self::_t(4) . "\$excelReader->setReadDataOnly(true);"; $script['setdata'][] = self::_t(4) . "\$excelObj = \$excelReader->load(\$package['dir']);"; $script['setdata'][] = self::_t(4) . "\$data['array'] = \$excelObj->getActiveSheet()->toArray(null, true,true,true);"; $script['setdata'][] = self::_t(4) . "\$excelObj->disconnectWorksheets();"; $script['setdata'][] = self::_t(4) . "unset(\$excelObj);"; $script['setdata'][] = self::_t(4) . "return \$this->save(\$data, \$table);"; $script['setdata'][] = self::_t(3) . "}"; $script['setdata'][] = self::_t(2) . "}"; $script['setdata'][] = self::_t(2) . "return false;"; $script['setdata'][] = self::_t(1) . "}"; } elseif ('headers' === $type) { $script['headers'] = array(); $script['headers'][] = self::_t(1) . "/**"; $script['headers'][] = self::_t(1) . "* Method to get header."; $script['headers'][] = self::_t(1) . "*"; $script['headers'][] = self::_t(1) . "* @return mixed An array of data items on success, false on failure."; $script['headers'][] = self::_t(1) . "*/"; $script['headers'][] = self::_t(1) . "public function getExImPortHeaders()"; $script['headers'][] = self::_t(1) . "{"; $script['headers'][] = self::_t(2) . "// Get a db connection."; $script['headers'][] = self::_t(2) . "\$db = Factory::getDbo();"; $script['headers'][] = self::_t(2) . "// get the columns"; $script['headers'][] = self::_t(2) . "\$columns = \$db->getTableColumns(\"#__[[[-#-#-component]]]_[[[-#-#-view]]]\");"; $script['headers'][] = self::_t(2) . "if (Super-#-#-___0a59c65c_9daf_4bc9_baf4_e063ff9e6a8a___Power::check(\$columns))"; $script['headers'][] = self::_t(2) . "{"; $script['headers'][] = self::_t(3) . "// remove the headers you don't import/export."; $script['headers'][] = self::_t(3) . "unset(\$columns['asset_id']);"; $script['headers'][] = self::_t(3) . "unset(\$columns['checked_out']);"; $script['headers'][] = self::_t(3) . "unset(\$columns['checked_out_time']);"; $script['headers'][] = self::_t(3) . "\$headers = new \stdClass();"; $script['headers'][] = self::_t(3) . "foreach (\$columns as \$column => \$type)"; $script['headers'][] = self::_t(3) . "{"; $script['headers'][] = self::_t(4) . "\$headers->{\$column} = \$column;"; $script['headers'][] = self::_t(3) . "}"; $script['headers'][] = self::_t(3) . "return \$headers;"; $script['headers'][] = self::_t(2) . "}"; $script['headers'][] = self::_t(2) . "return false;"; $script['headers'][] = self::_t(1) . "}"; } elseif ('save' === $type) { $script['save'] = array(); $script['save'][] = self::_t(1) . "/**"; $script['save'][] = self::_t(1) . "* Save the data from the file to the database"; $script['save'][] = self::_t(1) . "*"; $script['save'][] = self::_t(1) . "* @param string \$package Paths to the uploaded package file"; $script['save'][] = self::_t(1) . "*"; $script['save'][] = self::_t(1) . "* @return boolean false on failure"; $script['save'][] = self::_t(1) . "*"; $script['save'][] = self::_t(1) . "**/"; $script['save'][] = self::_t(1) . "protected function save(\$data,\$table)"; $script['save'][] = self::_t(1) . "{"; $script['save'][] = self::_t(2) . "// import the data if there is any"; $script['save'][] = self::_t(2) . "if(Super-#-#-___0a59c65c_9daf_4bc9_baf4_e063ff9e6a8a___Power::check(\$data['array']))"; $script['save'][] = self::_t(2) . "{"; $script['save'][] = self::_t(3) . "// get user object"; $script['save'][] = self::_t(3) . "\$user" . self::_t(2) . "= Factory::getUser();"; $script['save'][] = self::_t(3) . "// remove header if it has headers"; $script['save'][] = self::_t(3) . "\$id_key" . self::_t(1) . "= \$data['target_headers']['id'];"; $script['save'][] = self::_t(3) . "\$published_key" . self::_t(1) . "= \$data['target_headers']['published'];"; $script['save'][] = self::_t(3) . "\$ordering_key" . self::_t(1) . "= \$data['target_headers']['ordering'];"; $script['save'][] = self::_t(3) . "// get the first array set"; $script['save'][] = self::_t(3) . "\$firstSet = reset(\$data['array']);"; $script['save'][] = ""; $script['save'][] = self::_t(3) . "// check if first array is a header array and remove if true"; $script['save'][] = self::_t(3) . "if(\$firstSet[\$id_key] == 'id' || \$firstSet[\$published_key] == 'published' || \$firstSet[\$ordering_key] == 'ordering')"; $script['save'][] = self::_t(3) . "{"; $script['save'][] = self::_t(4) . "array_shift(\$data['array']);"; $script['save'][] = self::_t(3) . "}"; $script['save'][] = self::_t(3) . ""; $script['save'][] = self::_t(3) . "// make sure there is still values in array and that it was not only headers"; $script['save'][] = self::_t(3) . "if(Super-#-#-___0a59c65c_9daf_4bc9_baf4_e063ff9e6a8a___Power::check(\$data['array']) && \$user->authorise(\$table.'.import', 'com_[[[-#-#-component]]]') && \$user->authorise('core.import', 'com_[[[-#-#-component]]]'))"; $script['save'][] = self::_t(3) . "{"; $script['save'][] = self::_t(4) . "// set target."; $script['save'][] = self::_t(4) . "\$target" . self::_t(1) . "= array_flip(\$data['target_headers']);"; $script['save'][] = self::_t(4) . "// Get a db connection."; $script['save'][] = self::_t(4) . "\$db = Factory::getDbo();"; $script['save'][] = self::_t(4) . "// set some defaults"; $script['save'][] = self::_t(4) . "\$todayDate" . self::_t(2) . "= Factory::getDate()->toSql();"; $script['save'][] = self::_t(4) . "// get global action permissions"; $script['save'][] = self::_t(4) . "\$canDo" . self::_t(3) . "= [[[-#-#-Component]]]Helper::getActions(\$table);"; $script['save'][] = self::_t(4) . "\$canEdit" . self::_t(2) . "= \$canDo->get('core.edit');"; $script['save'][] = self::_t(4) . "\$canState" . self::_t(2) . "= \$canDo->get('core.edit.state');"; $script['save'][] = self::_t(4) . "\$canCreate" . self::_t(2) . "= \$canDo->get('core.create');"; $script['save'][] = self::_t(4) . "\$hasAlias" . self::_t(2) . "= \$this->getAliasesUsed(\$table);"; $script['save'][] = self::_t(4) . "// prosses the data"; $script['save'][] = self::_t(4) . "foreach(\$data['array'] as \$row)"; $script['save'][] = self::_t(4) . "{"; $script['save'][] = self::_t(5) . "\$found = false;"; $script['save'][] = self::_t(5) . "if (isset(\$row[\$id_key]) && is_numeric(\$row[\$id_key]) && \$row[\$id_key] > 0)"; $script['save'][] = self::_t(5) . "{"; $script['save'][] = self::_t(6) . "// raw items import & update!"; $script['save'][] = self::_t(6) . "\$query = \$db->getQuery(true);"; $script['save'][] = self::_t(6) . "\$query"; $script['save'][] = self::_t(7) . "->select('version')"; $script['save'][] = self::_t(7) . "->from(\$db->quoteName('#__[[[-#-#-component]]]_'.\$table))"; $script['save'][] = self::_t(7) . "->where(\$db->quoteName('id') . ' = '. \$db->quote(\$row[\$id_key]));"; $script['save'][] = self::_t(6) . "// Reset the query using our newly populated query object."; $script['save'][] = self::_t(6) . "\$db->setQuery(\$query);"; $script['save'][] = self::_t(6) . "\$db->execute();"; $script['save'][] = self::_t(6) . "\$found = \$db->getNumRows();"; $script['save'][] = self::_t(5) . "}"; $script['save'][] = self::_t(5) . ""; $script['save'][] = self::_t(5) . "if(\$found && \$canEdit)"; $script['save'][] = self::_t(5) . "{"; $script['save'][] = self::_t(6) . "// update item"; $script['save'][] = self::_t(6) . "\$id" . self::_t(2) . "= \$row[\$id_key];"; $script['save'][] = self::_t(6) . "\$version" . self::_t(1) . "= \$db->loadResult();"; $script['save'][] = self::_t(6) . "// reset all buckets"; $script['save'][] = self::_t(6) . "\$query" . self::_t(2) . "= \$db->getQuery(true);"; $script['save'][] = self::_t(6) . "\$fields" . self::_t(1) . "= array();"; $script['save'][] = self::_t(6) . "// Fields to update."; $script['save'][] = self::_t(6) . "foreach(\$row as \$key => \$cell)"; $script['save'][] = self::_t(6) . "{"; $script['save'][] = self::_t(7) . "// ignore column"; $script['save'][] = self::_t(7) . "if ('IGNORE' == \$target[\$key])"; $script['save'][] = self::_t(7) . "{"; $script['save'][] = self::_t(8) . "continue;"; $script['save'][] = self::_t(7) . "}"; $script['save'][] = self::_t(7) . "// update modified"; $script['save'][] = self::_t(7) . "if ('modified_by' == \$target[\$key])"; $script['save'][] = self::_t(7) . "{"; $script['save'][] = self::_t(8) . "continue;"; $script['save'][] = self::_t(7) . "}"; $script['save'][] = self::_t(7) . "// update modified"; $script['save'][] = self::_t(7) . "if ('modified' == \$target[\$key])"; $script['save'][] = self::_t(7) . "{"; $script['save'][] = self::_t(8) . "continue;"; $script['save'][] = self::_t(7) . "}"; $script['save'][] = self::_t(7) . "// update version"; $script['save'][] = self::_t(7) . "if ('version' == \$target[\$key])"; $script['save'][] = self::_t(7) . "{"; $script['save'][] = self::_t(8) . "\$cell = (int) \$version + 1;"; $script['save'][] = self::_t(7) . "}"; $script['save'][] = self::_t(7) . "// verify publish authority"; $script['save'][] = self::_t(7) . "if ('published' == \$target[\$key] && !\$canState)"; $script['save'][] = self::_t(7) . "{"; $script['save'][] = self::_t(8) . "continue;"; $script['save'][] = self::_t(7) . "}"; $script['save'][] = self::_t(7) . "// set to update array"; $script['save'][] = self::_t(7) . "if(in_array(\$key, \$data['target_headers']) && is_numeric(\$cell))"; $script['save'][] = self::_t(7) . "{"; $script['save'][] = self::_t(8) . "\$fields[] = \$db->quoteName(\$target[\$key]) . ' = ' . \$cell;"; $script['save'][] = self::_t(7) . "}"; $script['save'][] = self::_t(7) . "elseif(in_array(\$key, \$data['target_headers']) && is_string(\$cell))"; $script['save'][] = self::_t(7) . "{"; $script['save'][] = self::_t(8) . "\$fields[] = \$db->quoteName(\$target[\$key]) . ' = ' . \$db->quote(\$cell);"; $script['save'][] = self::_t(7) . "}"; $script['save'][] = self::_t(7) . "elseif(in_array(\$key, \$data['target_headers']) && is_null(\$cell))"; $script['save'][] = self::_t(7) . "{"; $script['save'][] = self::_t(8) . "// if import data is null then set empty"; $script['save'][] = self::_t(8) . "\$fields[] = \$db->quoteName(\$target[\$key]) . \" = ''\";"; $script['save'][] = self::_t(7) . "}"; $script['save'][] = self::_t(6) . "}"; $script['save'][] = self::_t(6) . "// load the defaults"; $script['save'][] = self::_t(6) . "\$fields[]" . self::_t(1) . "= \$db->quoteName('modified_by') . ' = ' . \$db->quote(\$user->id);"; $script['save'][] = self::_t(6) . "\$fields[]" . self::_t(1) . "= \$db->quoteName('modified') . ' = ' . \$db->quote(\$todayDate);"; $script['save'][] = self::_t(6) . "// Conditions for which records should be updated."; $script['save'][] = self::_t(6) . "\$conditions = array("; $script['save'][] = self::_t(7) . "\$db->quoteName('id') . ' = ' . \$id"; $script['save'][] = self::_t(6) . ");"; $script['save'][] = self::_t(6) . ""; $script['save'][] = self::_t(6) . "\$query->update(\$db->quoteName('#__[[[-#-#-component]]]_'.\$table))->set(\$fields)->where(\$conditions);"; $script['save'][] = self::_t(6) . "\$db->setQuery(\$query);"; $script['save'][] = self::_t(6) . "\$db->execute();"; $script['save'][] = self::_t(5) . "}"; $script['save'][] = self::_t(5) . "elseif (\$canCreate)"; $script['save'][] = self::_t(5) . "{"; $script['save'][] = self::_t(6) . "// insert item"; $script['save'][] = self::_t(6) . "\$query = \$db->getQuery(true);"; $script['save'][] = self::_t(6) . "// reset all buckets"; $script['save'][] = self::_t(6) . "\$columns" . self::_t(1) . "= array();"; $script['save'][] = self::_t(6) . "\$values" . self::_t(1) . "= array();"; $script['save'][] = self::_t(6) . "\$version" . self::_t(1) . "= false;"; $script['save'][] = self::_t(6) . "// Insert columns. Insert values."; $script['save'][] = self::_t(6) . "foreach(\$row as \$key => \$cell)"; $script['save'][] = self::_t(6) . "{"; $script['save'][] = self::_t(7) . "// ignore column"; $script['save'][] = self::_t(7) . "if ('IGNORE' == \$target[\$key])"; $script['save'][] = self::_t(7) . "{"; $script['save'][] = self::_t(8) . "continue;"; $script['save'][] = self::_t(7) . "}"; $script['save'][] = self::_t(7) . "// remove id"; $script['save'][] = self::_t(7) . "if ('id' == \$target[\$key])"; $script['save'][] = self::_t(7) . "{"; $script['save'][] = self::_t(8) . "continue;"; $script['save'][] = self::_t(7) . "}"; $script['save'][] = self::_t(7) . "// update created"; $script['save'][] = self::_t(7) . "if ('created_by' == \$target[\$key])"; $script['save'][] = self::_t(7) . "{"; $script['save'][] = self::_t(8) . "continue;"; $script['save'][] = self::_t(7) . "}"; $script['save'][] = self::_t(7) . "// update created"; $script['save'][] = self::_t(7) . "if ('created' == \$target[\$key])"; $script['save'][] = self::_t(7) . "{"; $script['save'][] = self::_t(8) . "continue;"; $script['save'][] = self::_t(7) . "}"; $script['save'][] = self::_t(7) . "// Make sure the alias is incremented"; $script['save'][] = self::_t(7) . "if ('alias' == \$target[\$key])"; $script['save'][] = self::_t(7) . "{"; $script['save'][] = self::_t(8) . "\$cell = \$this->getAlias(\$cell,\$table);"; $script['save'][] = self::_t(7) . "}"; $script['save'][] = self::_t(7) . "// update version"; $script['save'][] = self::_t(7) . "if ('version' == \$target[\$key])"; $script['save'][] = self::_t(7) . "{"; $script['save'][] = self::_t(8) . "\$cell = 1;"; $script['save'][] = self::_t(8) . "\$version = true;"; $script['save'][] = self::_t(7) . "}"; $script['save'][] = self::_t(7) . "// set to insert array"; $script['save'][] = self::_t(7) . "if(in_array(\$key, \$data['target_headers']) && is_numeric(\$cell))"; $script['save'][] = self::_t(7) . "{"; $script['save'][] = self::_t(8) . "\$columns[]" . self::_t(1) . "= \$target[\$key];"; $script['save'][] = self::_t(8) . "\$values[]" . self::_t(1) . "= \$cell;"; $script['save'][] = self::_t(7) . "}"; $script['save'][] = self::_t(7) . "elseif(in_array(\$key, \$data['target_headers']) && is_string(\$cell))"; $script['save'][] = self::_t(7) . "{"; $script['save'][] = self::_t(8) . "\$columns[]" . self::_t(1) . "= \$target[\$key];"; $script['save'][] = self::_t(8) . "\$values[]" . self::_t(1) . "= \$db->quote(\$cell);"; $script['save'][] = self::_t(7) . "}"; $script['save'][] = self::_t(7) . "elseif(in_array(\$key, \$data['target_headers']) && is_null(\$cell))"; $script['save'][] = self::_t(7) . "{"; $script['save'][] = self::_t(8) . "// if import data is null then set empty"; $script['save'][] = self::_t(8) . "\$columns[]" . self::_t(1) . "= \$target[\$key];"; $script['save'][] = self::_t(8) . "\$values[]" . self::_t(1) . "= \"''\";"; $script['save'][] = self::_t(7) . "}"; $script['save'][] = self::_t(6) . "}"; $script['save'][] = self::_t(6) . "// load the defaults"; $script['save'][] = self::_t(6) . "\$columns[]" . self::_t(1) . "= 'created_by';"; $script['save'][] = self::_t(6) . "\$values[]" . self::_t(1) . "= \$db->quote(\$user->id);"; $script['save'][] = self::_t(6) . "\$columns[]" . self::_t(1) . "= 'created';"; $script['save'][] = self::_t(6) . "\$values[]" . self::_t(1) . "= \$db->quote(\$todayDate);"; $script['save'][] = self::_t(6) . "if (!\$version)"; $script['save'][] = self::_t(6) . "{"; $script['save'][] = self::_t(7) . "\$columns[]" . self::_t(1) . "= 'version';"; $script['save'][] = self::_t(7) . "\$values[]" . self::_t(1) . "= 1;"; $script['save'][] = self::_t(6) . "}"; $script['save'][] = self::_t(6) . "// Prepare the insert query."; $script['save'][] = self::_t(6) . "\$query"; $script['save'][] = self::_t(7) . "->insert(\$db->quoteName('#__[[[-#-#-component]]]_'.\$table))"; $script['save'][] = self::_t(7) . "->columns(\$db->quoteName(\$columns))"; $script['save'][] = self::_t(7) . "->values(implode(',', \$values));"; $script['save'][] = self::_t(6) . "// Set the query using our newly populated query object and execute it."; $script['save'][] = self::_t(6) . "\$db->setQuery(\$query);"; $script['save'][] = self::_t(6) . "\$done = \$db->execute();"; $script['save'][] = self::_t(6) . "if (\$done)"; $script['save'][] = self::_t(6) . "{"; $script['save'][] = self::_t(7) . "\$aId = \$db->insertid();"; $script['save'][] = self::_t(7) . "// make sure the access of asset is set"; $script['save'][] = self::_t(7) . "[[[-#-#-Component]]]Helper::setAsset(\$aId,\$table);"; $script['save'][] = self::_t(6) . "}"; $script['save'][] = self::_t(5) . "}"; $script['save'][] = self::_t(5) . "else"; $script['save'][] = self::_t(5) . "{"; $script['save'][] = self::_t(6) . "return false;"; $script['save'][] = self::_t(5) . "}"; $script['save'][] = self::_t(4) . "}"; $script['save'][] = self::_t(4) . "return true;"; $script['save'][] = self::_t(3) . "}"; $script['save'][] = self::_t(2) . "}"; $script['save'][] = self::_t(2) . "return false;"; $script['save'][] = self::_t(1) . "}"; } elseif ('view' === $type) { $script['view'] = array(); $script['view'][] = ""; $script['view'][] = ""; $script['view'][] = PHP_EOL . "
"; $script['view'][] = "
\" method=\"post\" name=\"adminForm\" id=\"adminForm\" class=\"form-horizontal form-validate\">"; $script['view'][] = ""; $script['view'][] = PHP_EOL . self::_t(1) . "sidebar)) : ?>"; $script['view'][] = self::_t(2) . "
"; $script['view'][] = self::_t(3) . "sidebar; ?>"; $script['view'][] = self::_t(2) . "
"; $script['view'][] = self::_t(2) . "
"; $script['view'][] = self::_t(1) . ""; $script['view'][] = self::_t(2) . "
"; $script['view'][] = self::_t(1) . ""; $script['view'][] = ""; $script['view'][] = PHP_EOL . self::_t(1) . "hasPackage && Super-#-#-___0a59c65c_9daf_4bc9_baf4_e063ff9e6a8a___Power::check(\$this->headerList) && Super-#-#-___0a59c65c_9daf_4bc9_baf4_e063ff9e6a8a___Power::check(\$this->headers)) : ?>"; $script['view'][] = self::_t(2) . "
"; $script['view'][] = self::_t(3) . ""; $script['view'][] = self::_t(3) . "
"; $script['view'][] = self::_t(4) . ""; $script['view'][] = self::_t(4) . "
"; $script['view'][] = self::_t(5) . ""; $script['view'][] = self::_t(4) . "
"; $script['view'][] = self::_t(3) . "
"; $script['view'][] = self::_t(3) . "headerList as \$name => \$title): ?>"; $script['view'][] = self::_t(4) . "
"; $script['view'][] = self::_t(5) . ""; $script['view'][] = self::_t(5) . "
"; $script['view'][] = self::_t(6) . ""; $script['view'][] = self::_t(5) . "
"; $script['view'][] = self::_t(4) . "
"; $script['view'][] = self::_t(3) . ""; $script['view'][] = self::_t(3) . "
"; $script['view'][] = self::_t(4) . "\" onclick=\"Joomla.continueImport()\" />"; $script['view'][] = self::_t(3) . "
"; $script['view'][] = self::_t(2) . "
"; $script['view'][] = self::_t(2) . ""; $script['view'][] = self::_t(1) . ""; $script['view'][] = self::_t(2) . " 'upload')); ?>"; $script['view'][] = self::_t(2) . ""; $script['view'][] = self::_t(2) . ""; $script['view'][] = self::_t(3) . "
"; $script['view'][] = self::_t(4) . ""; $script['view'][] = self::_t(4) . "
"; $script['view'][] = self::_t(5) . ""; $script['view'][] = self::_t(5) . "
"; $script['view'][] = self::_t(6) . ""; $script['view'][] = self::_t(5) . "
"; $script['view'][] = self::_t(4) . "
"; $script['view'][] = self::_t(4) . "
"; $script['view'][] = self::_t(5) . "\" onclick=\"Joomla.submitbutton()\" />    (.csv .xls .ods)"; $script['view'][] = self::_t(4) . "
"; $script['view'][] = self::_t(3) . "
"; $script['view'][] = self::_t(2) . ""; $script['view'][] = self::_t(2) . ""; $script['view'][] = self::_t(2) . ""; $script['view'][] = self::_t(3) . "
"; $script['view'][] = self::_t(4) . ""; $script['view'][] = self::_t(4) . "
"; $script['view'][] = self::_t(5) . ""; $script['view'][] = self::_t(5) . "
"; $script['view'][] = self::_t(6) . "state->get('import.directory'); ?>\" />"; $script['view'][] = self::_t(5) . "
"; $script['view'][] = self::_t(4) . "
"; $script['view'][] = self::_t(4) . "
"; $script['view'][] = self::_t(5) . "\" onclick=\"Joomla.submitbutton3()\" />    (.csv .xls .ods)"; $script['view'][] = self::_t(4) . "
"; $script['view'][] = self::_t(4) . "
"; $script['view'][] = self::_t(2) . ""; $script['view'][] = ""; $script['view'][] = PHP_EOL . self::_t(2) . ""; $script['view'][] = self::_t(3) . "
"; $script['view'][] = self::_t(4) . ""; $script['view'][] = self::_t(4) . "
"; $script['view'][] = self::_t(5) . ""; $script['view'][] = self::_t(5) . "
"; $script['view'][] = self::_t(6) . ""; $script['view'][] = self::_t(5) . "
"; $script['view'][] = self::_t(4) . "
"; $script['view'][] = self::_t(4) . "
"; $script['view'][] = self::_t(5) . "\" onclick=\"Joomla.submitbutton4()\" />    (.csv .xls .ods)"; $script['view'][] = self::_t(4) . "
"; $script['view'][] = self::_t(3) . "
"; $script['view'][] = self::_t(2) . ""; $script['view'][] = self::_t(2) . ""; $script['view'][] = self::_t(2) . ""; $script['view'][] = self::_t(1) . ""; $script['view'][] = self::_t(1) . ""; $script['view'][] = self::_t(1) . ""; $script['view'][] = ""; $script['view'][] = "
"; } elseif ('import' === $type) { $script['import'] = array(); $script['import'][] = self::_t(1) . "/**"; $script['import'][] = self::_t(1) . " * Import an spreadsheet from either folder, url or upload."; $script['import'][] = self::_t(1) . " *"; $script['import'][] = self::_t(1) . " * @return boolean result of import"; $script['import'][] = self::_t(1) . " *"; $script['import'][] = self::_t(1) . " */"; $script['import'][] = self::_t(1) . "public function import()"; $script['import'][] = self::_t(1) . "{"; $script['import'][] = self::_t(2) . "\$this->setState('action', 'import');"; $script['import'][] = self::_t(2) . "\$app" . self::_t(2) . "= Factory::getApplication();"; $script['import'][] = self::_t(2) . "\$session" . self::_t(1) . "= Factory::getSession();"; $script['import'][] = self::_t(2) . "\$package" . self::_t(1) . "= null;"; $script['import'][] = self::_t(2) . "\$continue" . self::_t(1) . "= false;"; $script['import'][] = self::_t(2) . "// get import type"; $script['import'][] = self::_t(2) . "\$this->getType = \$app->input->getString('gettype', NULL);"; $script['import'][] = self::_t(2) . "// get import type"; $script['import'][] = self::_t(2) . "\$this->dataType" . self::_t(1) . "= \$session->get('dataType_VDM_IMPORTINTO', NULL);"; $script['import'][] = PHP_EOL . self::_t(2) . "if (\$package === null)"; $script['import'][] = self::_t(2) . "{"; $script['import'][] = self::_t(3) . "switch (\$this->getType)"; $script['import'][] = self::_t(3) . "{"; $script['import'][] = self::_t(4) . "case 'folder':"; $script['import'][] = self::_t(5) . "// Remember the 'Import from Directory' path."; $script['import'][] = self::_t(5) . "\$app->getUserStateFromRequest(\$this->_context . '.import_directory', 'import_directory');"; $script['import'][] = self::_t(5) . "\$package = \$this->_getPackageFromFolder();"; $script['import'][] = self::_t(5) . "break;"; $script['import'][] = PHP_EOL . self::_t(4) . "case 'upload':"; $script['import'][] = self::_t(5) . "\$package = \$this->_getPackageFromUpload();"; $script['import'][] = self::_t(5) . "break;"; $script['import'][] = PHP_EOL . self::_t(4) . "case 'url':"; $script['import'][] = self::_t(5) . "\$package = \$this->_getPackageFromUrl();"; $script['import'][] = self::_t(5) . "break;"; $script['import'][] = PHP_EOL . self::_t(4) . "case 'continue':"; $script['import'][] = self::_t(5) . "\$continue" . self::_t(1) . "= true;"; $script['import'][] = self::_t(5) . "\$package" . self::_t(1) . "= \$session->get('package', null);"; $script['import'][] = self::_t(5) . "\$package" . self::_t(1) . "= json_decode(\$package, true);"; $script['import'][] = self::_t(5) . "// clear session"; $script['import'][] = self::_t(5) . "\$session->clear('package');"; $script['import'][] = self::_t(5) . "\$session->clear('dataType');"; $script['import'][] = self::_t(5) . "\$session->clear('hasPackage');"; $script['import'][] = self::_t(5) . "break;"; $script['import'][] = PHP_EOL . self::_t(4) . "default:"; $script['import'][] = self::_t(5) . "\$app->setUserState('com_[[[-#-#-component]]].message', JTe-#-#-xt::_('COM_[[[-#-#-COMPONENT]]]_IMPORT_NO_IMPORT_TYPE_FOUND'));"; $script['import'][] = PHP_EOL . self::_t(5) . "return false;"; $script['import'][] = self::_t(5) . "break;"; $script['import'][] = self::_t(3) . "}"; $script['import'][] = self::_t(2) . "}"; $script['import'][] = self::_t(2) . "// Was the package valid?"; $script['import'][] = self::_t(2) . "if (!\$package || !\$package['type'])"; $script['import'][] = self::_t(2) . "{"; $script['import'][] = self::_t(3) . "if (in_array(\$this->getType, array('upload', 'url')))"; $script['import'][] = self::_t(3) . "{"; $script['import'][] = self::_t(4) . "\$this->remove(\$package['packagename']);"; $script['import'][] = self::_t(3) . "}"; $script['import'][] = PHP_EOL . self::_t(3) . "\$app->setUserState('com_[[[-#-#-component]]].message', JTe-#-#-xt::_('COM_[[[-#-#-COMPONENT]]]_IMPORT_UNABLE_TO_FIND_IMPORT_PACKAGE'));"; $script['import'][] = self::_t(3) . "return false;"; $script['import'][] = self::_t(2) . "}"; $script['import'][] = self::_t(2) . ""; $script['import'][] = self::_t(2) . "// first link data to table headers"; $script['import'][] = self::_t(2) . "if(!\$continue){"; $script['import'][] = self::_t(3) . "\$package" . self::_t(1) . "= json_encode(\$package);"; $script['import'][] = self::_t(3) . "\$session->set('package', \$package);"; $script['import'][] = self::_t(3) . "\$session->set('dataType', \$this->dataType);"; $script['import'][] = self::_t(3) . "\$session->set('hasPackage', true);"; $script['import'][] = self::_t(3) . "return true;"; $script['import'][] = self::_t(2) . "}"; $script['import'][] = self::_t(2) . "// set the data"; $script['import'][] = self::_t(2) . "\$headerList = json_decode(\$session->get(\$this->dataType.'_VDM_IMPORTHEADERS', false), true);"; $script['import'][] = self::_t(2) . "if (!\$this->setData(\$package,\$this->dataType,\$headerList))"; $script['import'][] = self::_t(2) . "{"; $script['import'][] = self::_t(3) . "// There was an error importing the package"; $script['import'][] = self::_t(3) . "\$msg = JTe-#-#-xt::_('COM_[[[-#-#-COMPONENT]]]_IMPORT_ERROR');"; $script['import'][] = self::_t(3) . "\$back = \$session->get('backto_VDM_IMPORT', NULL);"; $script['import'][] = self::_t(3) . "if (\$back)"; $script['import'][] = self::_t(3) . "{"; $script['import'][] = self::_t(4) . "\$app->setUserState('com_[[[-#-#-component]]].redirect_url', 'index.php?option=com_[[[-#-#-component]]]&view='.\$back);"; $script['import'][] = self::_t(4) . "\$session->clear('backto_VDM_IMPORT');"; $script['import'][] = self::_t(3) . "}"; $script['import'][] = self::_t(3) . "\$result = false;"; $script['import'][] = self::_t(2) . "}"; $script['import'][] = self::_t(2) . "else"; $script['import'][] = self::_t(2) . "{"; $script['import'][] = self::_t(3) . "// Package imported sucessfully"; $script['import'][] = self::_t(3) . "\$msg = JTe-#-#-xt::sprintf('COM_[[[-#-#-COMPONENT]]]_IMPORT_SUCCESS', \$package['packagename']);"; $script['import'][] = self::_t(3) . "\$back = \$session->get('backto_VDM_IMPORT', NULL);"; $script['import'][] = self::_t(3) . "if (\$back)"; $script['import'][] = self::_t(3) . "{"; $script['import'][] = self::_t(4) . "\$app->setUserState('com_[[[-#-#-component]]].redirect_url', 'index.php?option=com_[[[-#-#-component]]]&view='.\$back);"; $script['import'][] = self::_t(4) . "\$session->clear('backto_VDM_IMPORT');"; $script['import'][] = self::_t(3) . "}"; $script['import'][] = self::_t(3) . "\$result = true;"; $script['import'][] = self::_t(2) . "}"; $script['import'][] = PHP_EOL . self::_t(2) . "// Set some model state values"; $script['import'][] = self::_t(2) . "\$app->enqueueMessage(\$msg);"; $script['import'][] = PHP_EOL . self::_t(2) . "// remove file after import"; $script['import'][] = self::_t(2) . "\$this->remove(\$package['packagename']);"; $script['import'][] = self::_t(2) . "\$session->clear(\$this->getType.'_VDM_IMPORTHEADERS');"; $script['import'][] = self::_t(2) . "return \$result;"; $script['import'][] = self::_t(1) . "}"; } elseif ('ext' === $type) { $script['ext'][] = self::_t(1) . "/**"; $script['ext'][] = self::_t(1) . " * Check the extension"; $script['ext'][] = self::_t(1) . " *"; $script['ext'][] = self::_t(1) . " * @param string \$file Name of the uploaded file"; $script['ext'][] = self::_t(1) . " *"; $script['ext'][] = self::_t(1) . " * @return boolean True on success"; $script['ext'][] = self::_t(1) . " *"; $script['ext'][] = self::_t(1) . " */"; $script['ext'][] = self::_t(1) . "protected function checkExtension(\$file)"; $script['ext'][] = self::_t(1) . "{"; $script['ext'][] = self::_t(2) . "// check the extention"; $script['ext'][] = self::_t(2) . "switch(strtolower(pathinfo(\$file, PATHINFO_EXTENSION)))"; $script['ext'][] = self::_t(2) . "{"; $script['ext'][] = self::_t(3) . "case 'xls':"; $script['ext'][] = self::_t(3) . "case 'ods':"; $script['ext'][] = self::_t(3) . "case 'csv':"; $script['ext'][] = self::_t(3) . "return true;"; $script['ext'][] = self::_t(3) . "break;"; $script['ext'][] = self::_t(2) . "}"; $script['ext'][] = self::_t(2) . "return false;"; $script['ext'][] = self::_t(1) . "}"; } elseif ('routerparse' === $type) { $script['routerparse'][] = self::_t(4) . "// default script in switch for this view"; $script['routerparse'][] = self::_t(4) . "\$vars['view'] = '[[[-#-#-sview]]]';"; $script['routerparse'][] = self::_t(4) . "if (is_numeric(\$segments[\$count-1]))"; $script['routerparse'][] = self::_t(4) . "{"; $script['routerparse'][] = self::_t(5) . "\$vars['id'] = (int) \$segments[\$count-1];"; $script['routerparse'][] = self::_t(4) . "}"; $script['routerparse'][] = self::_t(4) . "elseif (\$segments[\$count-1])"; $script['routerparse'][] = self::_t(4) . "{"; $script['routerparse'][] = self::_t(5) . "\$id = \$this->getVar('[[[-#-#-sview]]]', \$segments[\$count-1], 'alias', 'id');"; $script['routerparse'][] = self::_t(5) . "if(\$id)"; $script['routerparse'][] = self::_t(5) . "{"; $script['routerparse'][] = self::_t(6) . "\$vars['id'] = \$id;"; $script['routerparse'][] = self::_t(5) . "}"; $script['routerparse'][] = self::_t(4) . "}"; } // return the needed script if (isset($script[$type])) { return str_replace('-#-#-', '', implode(PHP_EOL, $script[$type])); } return false; } /** * Field Grouping https://docs.joomla.org/Form_field * @deprecated 3.3 **/ protected static $fieldGroups = array( 'default' => array( 'accesslevel', 'cachehandler', 'calendar', 'captcha', 'category', 'checkbox', 'checkboxes', 'chromestyle', 'color', 'combo', 'componentlayout', 'contentlanguage', 'contenttype', 'databaseconnection', 'components', 'editor', 'editors', 'email', 'file', 'file', 'filelist', 'folderlist', 'groupedlist', 'headertag', 'helpsite', 'hidden', 'imagelist', 'integer', 'language', 'list', 'media', 'menu', 'modal_menu', 'menuitem', 'meter', 'modulelayout', 'moduleorder', 'moduleposition', 'moduletag', 'note', 'number', 'password', 'plugins', 'predefinedlist', 'radio', 'range', 'repeatable', 'rules', 'sessionhandler', 'spacer', 'sql', 'subform', 'tag', 'tel', 'templatestyle', 'text', 'textarea', 'timezone', 'url', 'user', 'usergroup' ), 'plain' => array( 'cachehandler', 'calendar', 'checkbox', 'chromestyle', 'color', 'componentlayout', 'contenttype', 'editor', 'editors', 'captcha', 'email', 'file', 'headertag', 'helpsite', 'hidden', 'integer', 'language', 'media', 'menu', 'modal_menu', 'menuitem', 'meter', 'modulelayout', 'templatestyle', 'moduleorder', 'moduletag', 'number', 'password', 'range', 'rules', 'tag', 'tel', 'text', 'textarea', 'timezone', 'url', 'user', 'usergroup' ), 'option' => array( 'accesslevel', 'category', 'checkboxes', 'combo', 'contentlanguage', 'databaseconnection', 'components', 'filelist', 'folderlist', 'imagelist', 'list', 'plugins', 'predefinedlist', 'radio', 'sessionhandler', 'sql', 'groupedlist' ), 'text' => array( 'calendar', 'color', 'editor', 'email', 'number', 'password', 'range', 'tel', 'text', 'textarea', 'url' ), 'list' => array( 'checkbox', 'checkboxes', 'list', 'radio', 'groupedlist', 'combo' ), 'dynamic' => array( 'category', 'file', 'filelist', 'folderlist', 'headertag', 'imagelist', 'integer', 'media', 'meter', 'rules', 'tag', 'timezone', 'user' ), 'spacer' => array( 'note', 'spacer' ), 'special' => array( 'contentlanguage', 'moduleposition', 'plugin', 'repeatable', 'subform' ), 'search' => array( 'editor', 'email', 'tel', 'text', 'textarea', 'url', 'subform' ) ); /** * Field Checker * * @param string $type The field type * @param boolean $option The field grouping * * @return boolean if the field was found * @deprecated 3.3 Use CompilerFactory::_('Field.Groups')->check($type, $option); */ public static function fieldCheck($type, $option = 'default') { return CompilerFactory::_('Field.Groups')->check($type, $option); } /** * get the field types id -> name of a group or groups * * @return array ids of the spacer field types * @deprecated 3.3 Use CompilerFactory::_('Field.Groups')->types($groups); */ public static function getFieldTypesByGroup($groups = array()) { return CompilerFactory::_('Field.Groups')->types($groups); } /** * get the field types IDs of a group or groups * * @return array ids of the spacer field types * @deprecated 3.3 Use CompilerFactory::_('Field.Groups')->typesIds($groups); */ public static function getFieldTypesIdsByGroup($groups = array()) { return CompilerFactory::_('Field.Groups')->typesIds($groups); } /** * get the spacer IDs * * @return array ids of the spacer field types * @deprecated 3.3 Use CompilerFactory::_('Field.Groups')->spacerIds(); */ public static function getSpacerIds() { return CompilerFactory::_('Field.Groups')->spacerIds(); } /** * open base64 string if stored as base64 * * @param string $data The base64 string * @param string $key We store the string with that suffix :) * @param string $default The default switch * * @return string The opened string * @deprecated 3.3 Use Base64Helper::open($data, $key, $default); */ public static function openValidBase64($data, $key = '__.o0=base64=Oo.__', $default = 'string') { return Base64Helper::open($data, $key, $default); } /** * prepare base64 string for url * * @deprecate Use urlencode(); */ public static function base64_urlencode($string, $encode = false) { if ($encode) { $string = base64_encode($string); } return str_replace(array('+', '/'), array('-', '_'), $string); } /** * prepare base64 string form url * * @deprecate */ public static function base64_urldecode($string, $decode = false) { $string = str_replace(array('-', '_'), array('+', '/'), $string); if ($decode) { $string = base64_decode($string); } return $string; } /** * Get the file path or url * * @param string $type The (url/path) type to return * @param string $target The Params Target name (if set) * @param string $default The default path if not set in Params (fallback path) * @param bool $createIfNotSet The switch to create the folder if not found * * @return string On success the path or url is returned based on the type requested * */ public static function getFolderPath($type = 'path', $target = 'folderpath', $default = '', $createIfNotSet = true) { // make sure to always have a string/path if(!UtilitiesStringHelper::check($default)) { $default = JPATH_SITE . '/images/'; } // get the global settings if (!ObjectHelper::check(self::$params)) { self::$params = JComponentHelper::getParams('com_componentbuilder'); } $folderPath = self::$params->get($target, $default); // create the folder if it does not exist if ($createIfNotSet && !Folder::exists($folderPath)) { Folder::create($folderPath); } // return the url if ('url' === $type) { if (strpos($folderPath, JPATH_SITE) !== false) { $folderPath = trim( str_replace( JPATH_SITE, '', $folderPath), '/'); return Uri::root() . $folderPath . '/'; } // since the path is behind the root folder of the site, return only the root url (may be used to build the link) return Uri::root(); } // sanitize the path return '/' . trim( $folderPath, '/' ) . '/'; } /** * the Crypt objects **/ protected static $CRYPT = array(); /** * the Cipher MODE switcher (list of ciphers) **/ protected static $setCipherMode = array( 'AES' => true, 'Rijndael' => true, 'Twofish' => false, // can but not good idea 'Blowfish' => false, // can but not good idea 'RC4' => false, // nope 'RC2' => false, // can but not good idea 'TripleDES' => false, // can but not good idea 'DES' => true ); /** * get the Crypt object * * @return object on success with Crypt power **/ public static function crypt($type, $mode = null) { // set key based on mode if ($mode) { $key = $type . $mode; } else { $key = $type; } // check if it was already set if (isset(self::$CRYPT[$key]) && ObjectHelper::check(self::$CRYPT[$key])) { return self::$CRYPT[$key]; } // make sure we have the composer classes loaded self::composerAutoload('phpseclib'); // build class name $CLASS = '\phpseclib\Crypt\\' . $type; // make sure we have the phpseclib classes if (!class_exists($CLASS)) { // class not in place so send out error Factory::getApplication()->enqueueMessage(Text::sprintf('COM_COMPONENTBUILDER_THE_BSB_LIBRARYCLASS_IS_NOT_AVAILABLE_THIS_LIBRARYCLASS_SHOULD_HAVE_BEEN_ADDED_TO_YOUR_BLIBRARIESPHPSECLIBVENDORB_FOLDER_PLEASE_CONTACT_YOUR_SYSTEM_ADMINISTRATOR_FOR_MORE_INFO', $CLASS), 'Error'); return false; } // does this crypt class use mode if ($mode && isset(self::$setCipherMode[$type]) && self::$setCipherMode[$type]) { switch ($mode) { case 'CTR': self::$CRYPT[$key] = new $CLASS('ctr'); break; case 'ECB': self::$CRYPT[$key] = new $CLASS('ecb'); break; case 'CBC': self::$CRYPT[$key] = new $CLASS('cbc'); break; case 'CBC3': self::$CRYPT[$key] = new $CLASS('cbc3'); break; case 'CFB': self::$CRYPT[$key] = new $CLASS('cfb'); break; case 'CFB8': self::$CRYPT[$key] = new $CLASS('cfb8'); break; case 'OFB': self::$CRYPT[$key] = new $CLASS('ofb'); break; case 'GCM': self::$CRYPT[$key] = new $CLASS('gcm'); break; case 'STREAM': self::$CRYPT[$key] = new $CLASS('stream'); break; default: // No valid mode has been specified Factory::getApplication()->enqueueMessage(Text::_('COM_COMPONENTBUILDER_NO_VALID_MODE_HAS_BEEN_SPECIFIED'), 'Error'); return false; break; } } else { // set the default self::$CRYPT[$key] = new $CLASS(); } // return the object return self::$CRYPT[$key]; } /** * Move File to Server * * @param string $localPath The local path to the file * @param string $fileName The the actual file name * @param int $serverID The server local id to use * @param int $protocol The server protocol to use * @param string $permission The permission validation area * * @return bool true on success **/ public static function moveToServer($localPath, $fileName, $serverID, $protocol = null, $permission = 'core.export') { // get the server if ($server = self::getServer( (int) $serverID, $protocol, $permission)) { // use the FTP protocol if (1 == $server->jcb_protocol) { // now move the file if (!$server->store($localPath, $fileName)) { Factory::getApplication()->enqueueMessage(Text::sprintf('COM_COMPONENTBUILDER_THE_BSB_FILE_COULD_NOT_BE_MOVED_TO_BSB_SERVER', $fileName, $server->jcb_remote_server_name[(int) $serverID]), 'Error'); return false; } // close the connection $server->quit(); } // use the SFTP protocol elseif (2 == $server->jcb_protocol) { // get the remote path $remote_path = '/' . trim($server->jcb_remote_server_path[(int) $serverID], '/') . '/' . $fileName; // now move the file if (!$server->put($remote_path, FileHelper::getContent($localPath, null))) { Factory::getApplication()->enqueueMessage(Text::sprintf('COM_COMPONENTBUILDER_THE_BSB_FILE_COULD_NOT_BE_MOVED_TO_BSB_PATH_ON_BSB_SERVER', $fileName, $server->jcb_remote_server_path[(int) $serverID], $server->jcb_remote_server_name[(int) $serverID]), 'Error'); return false; } } return true; } return false; } /** * the SFTP objects **/ protected static $sftp = array(); /** * the FTP objects **/ protected static $ftp = array(); /** * get the server object * * @param int $serverID The server local id to use * @param int $protocol The server protocol to use * @param string $permission The permission validation area * * @return object on success server object **/ public static function getServer($serverID, $protocol = null, $permission = 'core.export') { // if not protocol is given get it (sad I know) if (!$protocol) { $protocol = self::getVar('server', (int) $serverID, 'id', 'protocol'); } // return the server object switch ($protocol) { case 1: // FTP return self::getFtp($serverID, $permission); break; case 2: // SFTP return self::getSftp($serverID, $permission); break; } return false; } /** * get the sftp object * * @param int $serverID The server local id to use * @param string $permission The permission validation area * * @return object on success with sftp power **/ public static function getSftp($serverID, $permission = 'core.export') { // check if we have a server with that id if ($server = self::getServerDetails($serverID, 2, $permission)) { // check if it was already set if (!isset(self::$sftp[$server->cache]) || !ObjectHelper::check(self::$sftp[$server->cache])) { // make sure we have the composer classes loaded self::composerAutoload('phpseclib'); // make sure we have the phpseclib classes if (!class_exists('\phpseclib\Net\SFTP')) { // class not in place so send out error Factory::getApplication()->enqueueMessage(Text::_('COM_COMPONENTBUILDER_THE_BPHPSECLIBNETSFTPB_LIBRARYCLASS_IS_NOT_AVAILABLE_THIS_LIBRARYCLASS_SHOULD_HAVE_BEEN_ADDED_TO_YOUR_BLIBRARIESVDM_IOVENDORB_FOLDER_PLEASE_CONTACT_YOUR_SYSTEM_ADMINISTRATOR_FOR_MORE_INFO'), 'Error'); return false; } // insure the port is set $server->port = (isset($server->port) && is_numeric($server->port) && $server->port > 0) ? (int) $server->port : 22; // open the connection self::$sftp[$server->cache] = new phpseclib\Net\SFTP($server->host, $server->port); // heads-up on protocol self::$sftp[$server->cache]->jcb_protocol = 2; // SFTP <-- if called not knowing what type of protocol is being used // now login based on authentication type switch($server->authentication) { case 1: // password if (!self::$sftp[$server->cache]->login($server->username, $server->password)) { Factory::getApplication()->enqueueMessage(Text::sprintf('COM_COMPONENTBUILDER_THE_LOGIN_TO_BSB_HAS_FAILED_PLEASE_CHECK_THAT_YOUR_DETAILS_ARE_CORRECT', $server->name), 'Error'); unset(self::$sftp[$server->cache]); return false; } break; case 2: // private key file if (ObjectHelper::check(self::crypt('RSA'))) { // check if we have a passprase if (UtilitiesStringHelper::check($server->secret)) { self::crypt('RSA')->setPassword($server->secret); } // now load the key file if (!self::crypt('RSA')->loadKey(FileHelper::getContent($server->private, null))) { Factory::getApplication()->enqueueMessage(Text::sprintf('COM_COMPONENTBUILDER_THE_PRIVATE_KEY_FILE_COULD_NOT_BE_LOADEDFOUND_FOR_BSB_SERVER', $server->name), 'Error'); unset(self::$sftp[$server->cache]); return false; } // now login if (!self::$sftp[$server->cache]->login($server->username, self::crypt('RSA'))) { Factory::getApplication()->enqueueMessage(Text::sprintf('COM_COMPONENTBUILDER_THE_LOGIN_TO_BSB_HAS_FAILED_PLEASE_CHECK_THAT_YOUR_DETAILS_ARE_CORRECT', $server->name), 'Error'); unset(self::$sftp[$server->cache]); return false; } } break; case 3: // both password and private key file if (ObjectHelper::check(self::crypt('RSA'))) { // check if we have a passphrase if (UtilitiesStringHelper::check($server->secret)) { self::crypt('RSA')->setPassword($server->secret); } // now load the key file if (!self::crypt('RSA')->loadKey(FileHelper::getContent($server->private, null))) { Factory::getApplication()->enqueueMessage(Text::sprintf('COM_COMPONENTBUILDER_THE_PRIVATE_KEY_FILE_COULD_NOT_BE_LOADEDFOUND_FOR_BSB_SERVER', $server->name), 'Error'); unset(self::$sftp[$server->cache]); return false; } // now login if (!self::$sftp[$server->cache]->login($server->username, $server->password, self::crypt('RSA'))) { Factory::getApplication()->enqueueMessage(Text::sprintf('COM_COMPONENTBUILDER_THE_LOGIN_TO_BSB_HAS_FAILED_PLEASE_CHECK_THAT_YOUR_DETAILS_ARE_CORRECT', $server->name), 'Error'); unset(self::$sftp[$server->cache]); return false; } } break; case 4: // private key field if (ObjectHelper::check(self::crypt('RSA'))) { // check if we have a passprase if (UtilitiesStringHelper::check($server->secret)) { self::crypt('RSA')->setPassword($server->secret); } // now load the key field if (!self::crypt('RSA')->loadKey($server->private_key)) { Factory::getApplication()->enqueueMessage(Text::sprintf('COM_COMPONENTBUILDER_THE_PRIVATE_KEY_FIELD_COULD_NOT_BE_LOADED_FOR_BSB_SERVER', $server->name), 'Error'); unset(self::$sftp[$server->cache]); return false; } // now login if (!self::$sftp[$server->cache]->login($server->username, self::crypt('RSA'))) { Factory::getApplication()->enqueueMessage(Text::sprintf('COM_COMPONENTBUILDER_THE_LOGIN_TO_BSB_HAS_FAILED_PLEASE_CHECK_THAT_YOUR_DETAILS_ARE_CORRECT', $server->name), 'Error'); unset(self::$sftp[$server->cache]); return false; } } break; case 5: // both password and private key field if (ObjectHelper::check(self::crypt('RSA'))) { // check if we have a passphrase if (UtilitiesStringHelper::check($server->secret)) { self::crypt('RSA')->setPassword($server->secret); } // now load the key file if (!self::crypt('RSA')->loadKey($server->private_key)) { Factory::getApplication()->enqueueMessage(Text::sprintf('COM_COMPONENTBUILDER_THE_PRIVATE_KEY_FIELD_COULD_NOT_BE_LOADED_FOR_BSB_SERVER', $server->name), 'Error'); unset(self::$sftp[$server->cache]); return false; } // now login if (!self::$sftp[$server->cache]->login($server->username, $server->password, self::crypt('RSA'))) { Factory::getApplication()->enqueueMessage(Text::sprintf('COM_COMPONENTBUILDER_THE_LOGIN_TO_BSB_HAS_FAILED_PLEASE_CHECK_THAT_YOUR_DETAILS_ARE_CORRECT', $server->name), 'Error'); unset(self::$sftp[$server->cache]); return false; } } break; } } // only continue if object is set if (isset(self::$sftp[$server->cache]) && ObjectHelper::check(self::$sftp[$server->cache])) { // set the unique buckets if (!isset(self::$sftp[$server->cache]->jcb_remote_server_name)) { self::$sftp[$server->cache]->jcb_remote_server_name = array(); self::$sftp[$server->cache]->jcb_remote_server_path = array(); } // always set the name and remote server path self::$sftp[$server->cache]->jcb_remote_server_name[$serverID] = $server->name; self::$sftp[$server->cache]->jcb_remote_server_path[$serverID] = (UtilitiesStringHelper::check($server->path) && $server->path !== '/') ? $server->path : ''; // return the sftp object return self::$sftp[$server->cache]; } } return false; } /** * get the JClientFtp object * * @param int $serverID The server local id to use * @param string $permission The permission validation area * * @return object on success with ftp power **/ public static function getFtp($serverID, $permission) { // check if we have a server with that id if ($server = self::getServerDetails($serverID, 1, $permission)) { // check if we already have the server instance if (isset(self::$ftp[$server->cache]) && self::$ftp[$server->cache] instanceof JClientFtp) { // always set the name and remote server path self::$ftp[$server->cache]->jcb_remote_server_name[$serverID] = $server->name; // if still connected we are ready to go if (self::$ftp[$server->cache]->isConnected()) { // return the FTP instance return self::$ftp[$server->cache]; } // check if we can reinitialise the server if (self::$ftp[$server->cache]->reinit()) { // return the FTP instance return self::$ftp[$server->cache]; } } // make sure we have a string and it is not default or empty if (UtilitiesStringHelper::check($server->signature)) { // turn into variables parse_str($server->signature); // because of this I am using strange variable naming to avoid any collisions. // set options if (isset($options) && UtilitiesArrayHelper::check($options)) { foreach ($options as $o__p0t1on => $vAln3) { if ('timeout' === $o__p0t1on) { $options[$o__p0t1on] = (int) $vAln3; } if ('type' === $o__p0t1on) { $options[$o__p0t1on] = (string) $vAln3; } } } else { $options = array(); } // get ftp object if (isset($host) && $host != 'HOSTNAME' && isset($port) && $port != 'PORT_INT' && isset($username) && $username != 'user@name.com' && isset($password) && $password != 'password') { // load for reuse self::$ftp[$server->cache] = JClientFtp::getInstance($host, $port, $options, $username, $password); } else { // load error to indicate signature was in error Factory::getApplication()->enqueueMessage(Text::sprintf('COM_COMPONENTBUILDER_THE_FTP_SIGNATURE_FOR_BSB_WAS_NOT_WELL_FORMED_PLEASE_CHECK_YOUR_SIGNATURE_DETAILS', $server->name), 'Error'); return false; } // check if we are connected if (self::$ftp[$server->cache] instanceof JClientFtp && self::$ftp[$server->cache]->isConnected()) { // heads-up on protocol self::$ftp[$server->cache]->jcb_protocol = 1; // FTP <-- if called not knowing what type of protocol is being used // set the unique buckets if (!isset(self::$ftp[$server->cache]->jcb_remote_server_name)) { self::$ftp[$server->cache]->jcb_remote_server_name = array(); } // always set the name and remote server path self::$ftp[$server->cache]->jcb_remote_server_name[$serverID] = $server->name; // return the FTP instance return self::$ftp[$server->cache]; } // reset since we have no connection unset(self::$ftp[$server->cache]); } // load error to indicate signature was in error Factory::getApplication()->enqueueMessage(Text::sprintf('COM_COMPONENTBUILDER_THE_FTP_CONNECTION_FOR_BSB_COULD_NOT_BE_MADE_PLEASE_CHECK_YOUR_SIGNATURE_DETAILS', $server->name), 'Error'); } return false; } /** * get the server details * * @param int $serverID The server local id to use * @param int $protocol The server protocol to use * @param string $permission The permission validation area * * @return object on success with server details **/ public static function getServerDetails($serverID, $protocol = 2, $permission = 'core.export') { // check if this user has permission to access items if (!Factory::getUser()->authorise($permission, 'com_componentbuilder')) { // set message to inform the user that permission was denied Factory::getApplication()->enqueueMessage(Text::sprintf('COM_COMPONENTBUILDER_YOU_DO_NOT_HAVE_PERMISSION_TO_ACCESS_THE_SERVER_DETAILS_BS_DENIEDB_PLEASE_CONTACT_YOUR_SYSTEM_ADMINISTRATOR_FOR_MORE_INFO', UtilitiesStringHelper::safe($permission, 'w')), 'Error'); return false; } // now insure we have correct values if (is_int($serverID) && is_int($protocol)) { // Get a db connection $db = Factory::getDbo(); // start the query $query = $db->getQuery(true); // select based to protocol if (2 == $protocol) { // SFTP $query->select($db->quoteName(array('name','authentication','username','host','password','path','port','private','private_key','secret'))); // cache builder $cache = array('authentication','username','host','password','port','private','private_key','secret'); } else { // FTP $query->select($db->quoteName(array('name','signature'))); // cache builder $cache = array('signature'); } $query->from($db->quoteName('#__componentbuilder_server')); $query->where($db->quoteName('id') . ' = ' . (int) $serverID); $query->where($db->quoteName('protocol') . ' = ' . (int) $protocol); $db->setQuery($query); $db->execute(); if ($db->getNumRows()) { $server = $db->loadObject(); // Get the basic encryption. $basickey = self::getCryptKey('basic', 'Th1sMnsTbL0ck@d'); // Get the encryption object. $basic = new AES($basickey, 128); // start cache keys $keys = array(); // unlock the needed fields foreach($server as $name => &$value) { // unlock the needed fields if ($name !== 'name' && !empty($value) && $basickey && !is_numeric($value) && $value === base64_encode(base64_decode($value, true))) { // basic decrypt of data $value = rtrim($basic->decryptString($value), "\0"); } // build cache (keys) for lower connection latency if (in_array($name, $cache)) { $keys[] = $value; } } // check if cache keys were found if (UtilitiesArrayHelper::check($keys)) { // now set cache $server->cache = md5(implode('', $keys)); } else { // default is ID $server->cache = $serverID; } // return the server details return $server; } } Factory::getApplication()->enqueueMessage(Text::sprintf('COM_COMPONENTBUILDER_THE_SERVER_DETAILS_FOR_BID_SB_COULD_NOT_BE_RETRIEVED', $serverID), 'Error'); return false; } /** * Load the Composer Vendor phpseclib */ protected static function composephpseclib() { // load the autoloader for phpseclib require_once JPATH_SITE . '/libraries/phpseclib/vendor/autoload.php'; // do not load again self::$composer['phpseclib'] = true; return true; } /** * the locker * * @var array * @since 3.1 */ protected static array $locker = []; /** * the dynamic replacement salt * * @var array * @since 3.1 */ protected static array $globalSalt = []; /** * the timer * * @var object * @since 3.1 */ protected static $keytimer; /** * To Lock string * * @param string $string The string/array to lock * @param string|null $key The custom key to use * @param int $salt The switch to add salt and type of salt * @param int|null $dynamic The dynamic replacement array of salt build string * @param int $urlencode The switch to control url encoding * * @return string Encrypted String * @since 3.1 */ public static function lock(string $string, ?string $key = null, int $salt = 2, ?int $dynamic = null, $urlencode = true): string { // get the global settings if (!$key || !UtilitiesStringHelper::check($key)) { // set temp timer $timer = 2; // if we have a timer use it if ($salt > 0) { $timer = $salt; } // set the default key $key = self::salt($timer, $dynamic); // try getting the system key if (method_exists(get_called_class(), "getCryptKey")) { // try getting the medium key first the fall back to basic, and then default $key = self::getCryptKey('medium', self::getCryptKey('basic', $key)); } } // check if we have a salt timer if ($salt > 0) { $key .= self::salt($salt, $dynamic); } // get the locker settings if (!isset(self::$locker[$key]) || !ObjectHelper::check(self::$locker[$key])) { self::$locker[$key] = new AES($key, 128); } // convert array or object to string if (UtilitiesArrayHelper::check($string) || ObjectHelper::check($string)) { $string = serialize($string); } // prep for url if ($urlencode && method_exists(get_called_class(), "base64_urlencode")) { return self::base64_urlencode(self::$locker[$key]->encryptString($string)); } return self::$locker[$key]->encryptString($string); } /** * To un-Lock string * * @param string $string The string to unlock * @param string $key The custom key to use * @param int $salt The switch to add salt and type of salt * @param int $dynamic The dynamic replacement array of salt build string * @param int $urlencode The switch to control url decoding * * @return string Decrypted String * @since 3.1 */ public static function unlock($string, $key = null, $salt = 2, $dynamic = null, $urlencode = true): string { // get the global settings if (!$key || !UtilitiesStringHelper::check($key)) { // set temp timer $timer = 2; // if we have a timer use it if ($salt > 0) { $timer = $salt; } // set the default key $key = self::salt($timer, $dynamic); // try getting the system key if (method_exists(get_called_class(), "getCryptKey")) { // try getting the medium key first the fall back to basic, and then default $key = self::getCryptKey('medium', self::getCryptKey('basic', $key)); } } // check if we have a salt timer if ($salt > 0) { $key .= self::salt($salt, $dynamic); } // get the locker settings if (!isset(self::$locker[$key]) || !ObjectHelper::check(self::$locker[$key])) { self::$locker[$key] = new AES($key, 128); } // make sure we have real base64 if ($urlencode && method_exists(get_called_class(), "base64_urldecode")) { $string = self::base64_urldecode($string); } // basic decrypt string. if (!empty($string) && !is_numeric($string) && $string === base64_encode(base64_decode($string, true))) { $string = rtrim(self::$locker[$key]->decryptString($string), "\0"); // convert serial string to array if (self::is_serial($string)) { $string = unserialize($string); } } return $string; } /** * The Salt * * @param int $type The type of length the salt should be valid * @param int $dynamic The dynamic replacement array of salt build string * * @return string * @since 3.1 */ public static function salt(int $type = 1, $dynamic = null): string { // get dynamic replacement salt $dynamic = self::getDynamicSalt($dynamic); // get the key timer if (!ObjectHelper::check(self::$keytimer)) { // load the date time object self::$keytimer = new DateTime; // set the correct time stamp $vdmLocalTime = new DateTimeZone('Africa/Windhoek'); self::$keytimer->setTimezone($vdmLocalTime); } // set type if ($type == 2) { // hour $format = 'Y-m-d \o\n ' . self::periodFix(self::$keytimer->format('H')); } elseif ($type == 3) { // day $format = 'Y-m-' . self::periodFix(self::$keytimer->format('d')); } elseif ($type == 4) { // month $format = 'Y-' . self::periodFix(self::$keytimer->format('m')); } else { // minute $format = 'Y-m-d \o\n H:' . self::periodFix(self::$keytimer->format('i')); } // get key if (UtilitiesArrayHelper::check($dynamic)) { return md5(str_replace(array_keys($dynamic), array_values($dynamic), self::$keytimer->format($format) . ' @ VDM.I0')); } return md5(self::$keytimer->format($format) . ' @ VDM.I0'); } /** * The function to insure the salt is valid within the given period (third try) * * @param int $main The main number * @since 3.1 */ protected static function periodFix(int $main): int { return round($main / 3) * 3; } /** * Check if a string is serialized * * @param string $string * * @return Boolean * @since 3.1 */ public static function is_serial(string $string): bool { return (@unserialize($string) !== false); } /** * Get dynamic replacement salt * @since 3.1 */ public static function getDynamicSalt($dynamic = null) { // load global if not manually set if (!UtilitiesArrayHelper::check($dynamic)) { return self::getGlobalSalt(); } // return manual values if set else { return $dynamic; } } /** * The random or dynamic secret salt * @since 3.1 */ public static function getSecretSalt($string = null, $size = 9) { // set the string if (!$string) { // get random string $string = self::randomkey($size); } // convert string to array $string = UtilitiesStringHelper::safe($string); // convert string to array $array = str_split($string); // insure only unique values are used $array = array_unique($array); // set the size $size = ($size <= count($array)) ? $size : count($array); // down size the return array_slice($array, 0, $size); } /** * Get global replacement salt * @since 3.1 */ public static function getGlobalSalt() { // load from memory if found if (!UtilitiesArrayHelper::check(self::$globalSalt)) { // get the global settings if (!ObjectHelper::check(self::$params)) { self::$params = ComponentHelper::getParams('com_componentbuilder'); } // check if we have a global dynamic replacement array available (format --> ' 1->!,3->E,4->A') $tmp = self::$params->get('dynamic_salt', null); if (UtilitiesStringHelper::check($tmp) && strpos($tmp, ',') !== false && strpos($tmp, '->') !== false) { $salt = array_map('trim', (array) explode(',', $tmp)); if (UtilitiesArrayHelper::check($salt )) { foreach($salt as $replace) { $dynamic = array_map('trim', (array) explode('->', $replace)); if (isset($dynamic[0]) && isset($dynamic[1])) { self::$globalSalt[$dynamic[0]] = $dynamic[1]; } } } } } // return global if found if (UtilitiesArrayHelper::check(self::$globalSalt)) { return self::$globalSalt; } // return default as fail safe return array('1' => '!', '3' => 'E', '4' => 'A'); } /** * Close public protocol * @since 3.1 */ public static function closePublicProtocol($id, $public) { // get secret salt $secretSalt = self::getSecretSalt(self::salt(1,array('4' => 'R','1' => 'E','2' => 'G','7' => 'J','8' => 'A'))); // get the key $key = self::salt(1, $secretSalt); // get secret salt $secret = self::getSecretSalt(); // set the secret $close['SECRET'] = self::lock($secret, $key, 1, array('1' => 's', '3' => 'R', '4' => 'D')); // get the key $key = self::salt(1, $secret); // get the public key $close['PUBLIC'] = self::lock($public, $key, 1, array('1' => '!', '3' => 'E', '4' => 'A')); // get secret salt $secretSalt = self::getSecretSalt($public); // get the key $key = self::salt(1, $secretSalt); // get the ID $close['ID'] = self::unlock($id, $key, 1, array('1' => 'i', '3' => 'e', '4' => 'B')); // return closed values return $close; } /** * Open public protocol * @since 3.1 */ public static function openPublicProtocol($SECRET, $ID, $PUBLIC) { // get secret salt $secretSalt = self::getSecretSalt(self::salt(1,array('4' => 'R','1' => 'E','2' => 'G','7' => 'J','8' => 'A'))); // get the key $key = self::salt(1, $secretSalt); // get the $SECRET $SECRET = self::unlock($SECRET, $key, 1, array('1' => 's', '3' => 'R', '4' => 'D')); // get the key $key = self::salt(1, $SECRET); // get the public key $open['public'] = self::unlock($PUBLIC, $key, 1, array('1' => '!', '3' => 'E', '4' => 'A')); // get secret salt $secretSalt = self::getSecretSalt($open['public']); // get the key $key = self::salt(1, $secretSalt); // get the ID $open['id'] = self::unlock($ID, $key, 1, array('1' => 'i', '3' => 'e', '4' => 'B')); // return opened values return $open; } /** * Workers to load tasks * * @var array * @since 3.1 */ protected static array $worker = []; /** * Set a worker dynamic URLs * * @var array * @since 3.1 */ protected static array $workerURL = []; /** * Set a worker dynamic HEADERs * * @var array * @since 3.1 */ protected static array $workerHEADER = []; /** * Curl Error Notice * * @var bool * @since 3.1 */ protected static bool $curlErrorLoaded = false; /** * check if a worker has more work * * @param string $function The function to target to perform the task * * @return bool * @since 3.1 */ public static function hasWork(string $function): bool { if (isset(self::$worker[$function]) && UtilitiesArrayHelper::check(self::$worker[$function])) { return count( (array) self::$worker[$function]); } return false; } /** * Set a worker url * * @param string $function The function to target to perform the task * @param string $url The url of where the task is to be performed * * @return void * @since 3.1 */ public static function setWorkerUrl(string $function, string $url): void { // set the URL if found if (UtilitiesStringHelper::check($url)) { // make sure task function url is up self::$workerURL[$function] = $url; } } /** * Set a worker headers * * @param string $function The function to target to perform the task * @param array|null $headers The headers needed for these workers/function * * @return void * @since 3.1 */ public static function setWorkerHeaders(string $function, ?array $headers): void { // set the Headers if found if (UtilitiesArrayHelper::check($headers)) { // make sure task function headers are set self::$workerHEADER[$function] = $headers; } } /** * Set a worker that needs to perform a task * * @param mixed $data The data to pass to the task * @param string $function The function to target to perform the task * @param string $url The url of where the task is to be performed * @param array $headers The headers needed for these workers/function * * @return void * @since 3.1 */ public static function setWorker($data, string $function, ?string $url = null, ?array $headers = null) { // make sure task function is up if (!isset(self::$worker[$function])) { self::$worker[$function] = []; } // load the task self::$worker[$function][] = self::lock($data); // set the Headers if found if ($headers && !isset(self::$workerHEADER[$function])) { self::setWorkerHeaders($function, $headers); } // set the URL if found if ($url && !isset(self::$workerURL[$function])) { self::setWorkerUrl($function, $url); } } /** * Run set Workers * * @param string $function The function to target to perform the task * @param string $perTask The amount of task per worker * @param function $callback The option to do a call back when task is completed * @param int $threadSize The size of the thread * * @return bool true On success * @since 3.1 */ public static function runWorker(string $function, $perTask = 50, $callback = null, $threadSize = 20): bool { // set task $task = self::lock($function); // build headers $headers = array('VDM-TASK: ' .$task); // build dynamic headers if (isset(self::$workerHEADER[$function]) && UtilitiesArrayHelper::check(self::$workerHEADER[$function])) { foreach (self::$workerHEADER[$function] as $header) { $headers[] = $header; } } // build worker options $options = array(); // make sure worker is up if (isset(self::$worker[$function]) && UtilitiesArrayHelper::check(self::$worker[$function])) { // this load method is for each if (1 == $perTask) { // working with a string = 1 $headers[] = 'VDM-VALUE-TYPE: ' .self::lock(1); // now load the options foreach (self::$worker[$function] as $data) { $options[] = array(CURLOPT_HTTPHEADER => $headers, CURLOPT_POST => 1, CURLOPT_POSTFIELDS => 'VDM_DATA='. $data); } } // this load method is for bundles else { // working with an array = 2 $headers[] = 'VDM-VALUE-TYPE: ' .self::lock(2); // now load the options $work = array_chunk(self::$worker[$function], $perTask); foreach ($work as $data) { $options[] = array(CURLOPT_HTTPHEADER => $headers, CURLOPT_POST => 1, CURLOPT_POSTFIELDS => 'VDM_DATA='. implode('___VDM___', $data)); } } // relieve worker of task/function self::$worker[$function] = array(); } // do the execution if (UtilitiesArrayHelper::check($options)) { if (isset(self::$workerURL[$function])) { $url = self::$workerURL[$function]; } else { $url = Uri::root() . '/index.php?option=com_componentbuilder&task=api.worker'; } return self::curlMultiExec($url, $options, $callback, $threadSize); } return false; } /** * Do a multi curl execution of tasks * * @param string $url The url of where the task is to be performed * @param array $_options The array of curl options/headers to set * @param function $callback The option to do a call back when task is completed * @param int $threadSize The size of the thread * * @return bool true On success * @since 3.1 */ public static function curlMultiExec(&$url, &$_options, $callback = null, $threadSize = 20) { // make sure we have curl available if (!function_exists('curl_version')) { if (!self::$curlErrorLoaded) { // set the notice Factory::getApplication()->enqueueMessage(Text::_('COM_COMPONENTBUILDER_HTWOCURL_NOT_FOUNDHTWOPPLEASE_SETUP_CURL_ON_YOUR_SYSTEM_OR_BCOMPONENTBUILDERB_WILL_NOT_FUNCTION_CORRECTLYP'), 'Error'); // load the notice only once self::$curlErrorLoaded = true; } return false; } // make sure we have an url if (UtilitiesStringHelper::check($url)) { // make sure the thread size isn't greater than the # of _options $threadSize = (count($_options) < $threadSize) ? count($_options) : $threadSize; // set the options $options = array(); $options[CURLOPT_URL] = $url; $options[CURLOPT_USERAGENT] = 'Mozilla/5.0 (Windows; U; Windows NT 6.1; en-US; rv:1.9.2.12) Gecko/20101026 Firefox/3.6.12'; $options[CURLOPT_RETURNTRANSFER] = TRUE; $options[CURLOPT_SSL_VERIFYPEER] = FALSE; // start multi threading :) $handle = curl_multi_init(); // start the first batch of requests for ($i = 0; $i < $threadSize; $i++) { if (isset($_options[$i])) { $ch = curl_init(); foreach ($_options[$i] as $curlopt => $string) { $options[$curlopt] = $string; } curl_setopt_array($ch, $options); curl_multi_add_handle($handle, $ch); } } // we wait for all the calls to finish (should not take long) do { while(($execrun = curl_multi_exec($handle, $working)) == CURLM_CALL_MULTI_PERFORM); if($execrun != CURLM_OK) break; // a request was just completed -- find out which one while($done = curl_multi_info_read($handle)) { if (is_callable($callback)) { // $info = curl_getinfo($done['handle']); // request successful. process output using the callback function. $output = curl_multi_getcontent($done['handle']); $callback($output); } $key = $i + 1; if(isset($_options[$key])) { // start a new request (it's important to do this before removing the old one) $ch = curl_init(); $i++; // add options foreach ($_options[$key] as $curlopt => $string) { $options[$curlopt] = $string; } curl_setopt_array($ch, $options); curl_multi_add_handle($handle, $ch); // remove options again foreach ($_options[$key] as $curlopt => $string) { unset($options[$curlopt]); } } // remove the curl handle that just completed curl_multi_remove_handle($handle, $done['handle']); } // stop wasting CPU cycles and rest for a couple ms usleep(10000); } while ($working); // close the curl multi thread curl_multi_close($handle); // okay done return true; } return false; } /** * Get an edit button * * @param int $item The item to edit * @param string $view The type of item to edit * @param string $views The list view controller name * @param string $ref The return path * @param string $component The component these views belong to * @param string $headsup The message to show on click of button * * @return string On success the full html link * */ public static function getEditButton(&$item, $view, $views, $ref = '', $component = 'com_componentbuilder', $headsup = 'COM_COMPONENTBUILDER_ALL_UNSAVED_WORK_ON_THIS_PAGE_WILL_BE_LOST_ARE_YOU_SURE_YOU_WANT_TO_CONTINUE') { // get URL $url = self::getEditURL($item, $view, $views, $ref, $component); // check if we found any if (UtilitiesStringHelper::check($url)) { // get the global settings if (!ObjectHelper::check(self::$params)) { self::$params = JComponentHelper::getParams('com_componentbuilder'); } // get UIKIT version $uikit = self::$params->get('uikit_version', 2); // check that we have the ID if (ObjectHelper::check($item) && isset($item->id)) { // check if the checked_out is available if (isset($item->checked_out)) { $checked_out = (int) $item->checked_out; } else { $checked_out = self::getVar($view, $item->id, 'id', 'checked_out', '=', str_replace('com_', '', $component)); } } elseif (UtilitiesArrayHelper::check($item) && isset($item['id'])) { // check if the checked_out is available if (isset($item['checked_out'])) { $checked_out = (int) $item['checked_out']; } else { $checked_out = self::getVar($view, $item['id'], 'id', 'checked_out', '=', str_replace('com_', '', $component)); } } elseif (is_numeric($item) && $item > 0) { $checked_out = self::getVar($view, $item, 'id', 'checked_out', '=', str_replace('com_', '', $component)); } // set the link title $title = UtilitiesStringHelper::safe(Text::_('COM_COMPONENTBUILDER_EDIT') . ' ' . $view, 'W'); // check that there is a check message if (UtilitiesStringHelper::check($headsup)) { if (3 == $uikit) { $href = 'onclick="UIkit.modal.confirm(\''.Text::_($headsup).'\').then( function(){ window.location.href = \'' . $url . '\' } )" href="javascript:void(0)"'; } else { $href = 'onclick="UIkit2.modal.confirm(\''.Text::_($headsup).'\', function(){ window.location.href = \'' . $url . '\' })" href="javascript:void(0)"'; } } else { $href = 'href="' . $url . '"'; } // return UIKIT version 3 if (3 == $uikit) { // check if it is checked out if (isset($checked_out) && $checked_out > 0) { // is this user the one who checked it out if ($checked_out == Factory::getUser()->id) { return ' '; } return ' '; } // return normal edit link return ' '; } // check if it is checked out (return UIKIT version 2) if (isset($checked_out) && $checked_out > 0) { // is this user the one who checked it out if ($checked_out == Factory::getUser()->id) { return ' '; } return ' '; } // return normal edit link return ' '; } return ''; } /** * Get an edit text button * * @param string $text The button text * @param int $item The item to edit * @param string $view The type of item to edit * @param string $views The list view controller name * @param string $ref The return path * @param string $component The component these views belong to * @param string $headsup The message to show on click of button * * @return string On success the full html link * */ public static function getEditTextButton($text, &$item, $view, $views, $ref = '', $component = 'com_componentbuilder', $jRoute = true, $class = 'uk-button', $headsup = 'COM_COMPONENTBUILDER_ALL_UNSAVED_WORK_ON_THIS_PAGE_WILL_BE_LOST_ARE_YOU_SURE_YOU_WANT_TO_CONTINUE') { // make sure we have text if (!UtilitiesStringHelper::check($text)) { return self::getEditButton($item, $view, $views, $ref, $component, $headsup); } // get URL $url = self::getEditURL($item, $view, $views, $ref, $component, $jRoute); // check if we found any if (UtilitiesStringHelper::check($url)) { // get the global settings if (!ObjectHelper::check(self::$params)) { self::$params = JComponentHelper::getParams('com_componentbuilder'); } // get UIKIT version $uikit = self::$params->get('uikit_version', 2); // check that we have the ID if (ObjectHelper::check($item) && isset($item->id)) { // check if the checked_out is available if (isset($item->checked_out)) { $checked_out = (int) $item->checked_out; } else { $checked_out = self::getVar($view, $item->id, 'id', 'checked_out', '=', str_replace('com_', '', $component)); } } elseif (UtilitiesArrayHelper::check($item) && isset($item['id'])) { // check if the checked_out is available if (isset($item['checked_out'])) { $checked_out = (int) $item['checked_out']; } else { $checked_out = self::getVar($view, $item['id'], 'id', 'checked_out', '=', str_replace('com_', '', $component)); } } elseif (is_numeric($item) && $item > 0) { $checked_out = self::getVar($view, $item, 'id', 'checked_out', '=', str_replace('com_', '', $component)); } // set the link title $title = UtilitiesStringHelper::safe(Text::_('COM_COMPONENTBUILDER_EDIT') . ' ' . $view, 'W'); // check that there is a check message if (UtilitiesStringHelper::check($headsup)) { if (3 == $uikit) { $href = 'onclick="UIkit.modal.confirm(\''.Text::_($headsup).'\').then( function(){ window.location.href = \'' . $url . '\' } )" href="javascript:void(0)"'; } else { $href = 'onclick="UIkit2.modal.confirm(\''.Text::_($headsup).'\', function(){ window.location.href = \'' . $url . '\' })" href="javascript:void(0)"'; } } else { $href = 'href="' . $url . '"'; } // return UIKIT version 3 if (3 == $uikit) { // check if it is checked out if (isset($checked_out) && $checked_out > 0) { // is this user the one who checked it out if ($checked_out == Factory::getUser()->id) { return ' ' . $text . ''; } return ' ' . $text . ''; } // return normal edit link return ' ' . $text . ''; } // check if it is checked out (return UIKIT version 2) if (isset($checked_out) && $checked_out > 0) { // is this user the one who checked it out if ($checked_out == Factory::getUser()->id) { return ' ' . $text . ''; } return ' ' . $text . ''; } // return normal edit link return ' ' . $text . ''; } return ''; } /** * Get the edit URL * * @param int $item The item to edit * @param string $view The type of item to edit * @param string $views The list view controller name * @param string $ref The return path * @param string $component The component these views belong to * @param bool $jRoute The switch to add use JRoute or not * * @return string On success the edit url * */ public static function getEditURL(&$item, $view, $views, $ref = '', $component = 'com_componentbuilder', $jRoute = true) { // build record $record = new \stdClass(); // check if user can edit if (self::canEditItem($record, $item, $view, $views, $component)) { // set the edit link if ($jRoute) { return JRoute::_("index.php?option=" . $component . "&view=" . $views . "&task=" . $view . ".edit&id=" . $record->id . $ref); } return "index.php?option=" . $component . "&view=" . $views . "&task=" . $view . ".edit&id=" . $record->id . $ref; } return false; } /** * Can Edit (either any, or own) * * @param int $item The item to edit * @param string $view The type of item to edit * @param string $views The list view controller name * @param string $component The component these views belong to * * @return bool if user can edit returns true els * */ public static function allowEdit(&$item, $view, $views, $component = 'com_componentbuilder') { // build record $record = new \stdClass(); return self::canEditItem($record, $item, $view, $views, $component); } /** * Can Edit (either any, or own) * * @param int $item The item to edit * @param string $view The type of item to edit * @param string $views The list view controller name * @param string $component The component these views belong to * * @return bool if user can edit returns true els * */ protected static function canEditItem(&$record, &$item, $view, $views, $component = 'com_componentbuilder') { // make sure the user has access to view if (!Factory::getUser()->authorise($view. '.access', $component)) { return false; } // we start with false. $can_edit = false; // check that we have the ID if (ObjectHelper::check($item) && isset($item->id)) { $record->id = (int) $item->id; // check if created_by is available if (isset($item->created_by) && $item->created_by > 0) { $record->created_by = (int) $item->created_by; } } elseif (UtilitiesArrayHelper::check($item) && isset($item['id'])) { $record->id = (int) $item['id']; // check if created_by is available if (isset($item['created_by']) && $item['created_by'] > 0) { $record->created_by = (int) $item['created_by']; } } elseif (is_numeric($item)) { $record->id = (int) $item; } // check ID if (isset($record->id) && $record->id > 0) { // get user action permission to edit $action = self::getActions($view, $record, $views, 'edit', str_replace('com_', '', $component)); // check if the view permission is set if (($can_edit = $action->get($view . '.edit', 'none-set')) === 'none-set') { // fall back on the core permission then (this can be an issue) $can_edit = ($action->get('core.edit', false) || $action->get('core.edit.own', false)); } } return $can_edit; } /** * set subform type table * * @param array $head The header names * @param array $rows The row values * @param string $idName The prefix to the table id * * @return string * */ public static function setSubformTable($head, $rows, $idName) { $table[] = "
"; $table[] = "\t
"; $table[] = "\t\t
"; $table[] = "\t\t\t"; $table[] = "\t\t\t\t"; $table[] = "\t\t\t\t\t"; $table[] = "\t\t\t\t\t\t"; $table[] = "\t\t\t\t\t"; $table[] = "\t\t\t\t"; $table[] = "\t\t\t\t"; foreach ($rows as $row) { $table[] = "\t\t\t\t\t"; $table[] = "\t\t\t\t\t\t" . $row; $table[] = "\t\t\t\t\t"; } $table[] = "\t\t\t\t"; $table[] = "\t\t\t
" . implode("", $head) . "
"; $table[] = "\t\t
"; $table[] = "\t
"; $table[] = "
"; // return the table return implode("\n", $table); } /** * Change to nice fancy date */ public static function fancyDate($date, $check_stamp = true) { if ($check_stamp && !self::isValidTimeStamp($date)) { $date = strtotime($date); } return date('jS \o\f F Y',$date); } /** * get date based in period past */ public static function fancyDynamicDate($date, $check_stamp = true) { if ($check_stamp && !self::isValidTimeStamp($date)) { $date = strtotime($date); } // older then year $lastyear = date("Y", strtotime("-1 year")); $tragetyear = date("Y", $date); if ($tragetyear <= $lastyear) { return date('m/d/y', $date); } // same day $yesterday = strtotime("-1 day"); if ($date > $yesterday) { return date('g:i A', $date); } // just month day return date('M j', $date); } /** * Change to nice fancy day time and date */ public static function fancyDayTimeDate($time, $check_stamp = true) { if ($check_stamp && !self::isValidTimeStamp($time)) { $time = strtotime($time); } return date('D ga jS \o\f F Y',$time); } /** * Change to nice fancy time and date */ public static function fancyDateTime($time, $check_stamp = true) { if ($check_stamp && !self::isValidTimeStamp($time)) { $time = strtotime($time); } return date('(G:i) jS \o\f F Y',$time); } /** * Change to nice hour:minutes time */ public static function fancyTime($time, $check_stamp = true) { if ($check_stamp && !self::isValidTimeStamp($time)) { $time = strtotime($time); } return date('G:i',$time); } /** * set the date day as Sunday through Saturday */ public static function setDayName($date, $check_stamp = true) { if ($check_stamp && !self::isValidTimeStamp($date)) { $date = strtotime($date); } return date('l', $date); } /** * set the date month as January through December */ public static function setMonthName($date, $check_stamp = true) { if ($check_stamp && !self::isValidTimeStamp($date)) { $date = strtotime($date); } return date('F', $date); } /** * set the date day as 1st */ public static function setDay($date, $check_stamp = true) { if ($check_stamp && !self::isValidTimeStamp($date)) { $date = strtotime($date); } return date('jS', $date); } /** * set the date month as 5 */ public static function setMonth($date, $check_stamp = true) { if ($check_stamp && !self::isValidTimeStamp($date)) { $date = strtotime($date); } return date('n', $date); } /** * set the date year as 2004 (for charts) */ public static function setYear($date, $check_stamp = true) { if ($check_stamp && !self::isValidTimeStamp($date)) { $date = strtotime($date); } return date('Y', $date); } /** * set the date as 2004/05 (for charts) */ public static function setYearMonth($date, $spacer = '/', $check_stamp = true) { if ($check_stamp && !self::isValidTimeStamp($date)) { $date = strtotime($date); } return date('Y' . $spacer . 'm', $date); } /** * set the date as 2004/05/03 (for charts) */ public static function setYearMonthDay($date, $spacer = '/', $check_stamp = true) { if ($check_stamp && !self::isValidTimeStamp($date)) { $date = strtotime($date); } return date('Y' . $spacer . 'm' . $spacer . 'd', $date); } /** * set the date as 03/05/2004 */ public static function setDayMonthYear($date, $spacer = '/', $check_stamp = true) { if ($check_stamp && !self::isValidTimeStamp($date)) { $date = strtotime($date); } return date('d' . $spacer . 'm' . $spacer . 'Y', $date); } /** * Check if string is a valid time stamp */ public static function isValidTimeStamp($timestamp) { return ((int) $timestamp === $timestamp) && ($timestamp <= PHP_INT_MAX) && ($timestamp >= ~PHP_INT_MAX); } /** * Check if string is a valid date * https://www.php.net/manual/en/function.checkdate.php#113205 */ public static function isValidateDate($date, $format = 'Y-m-d H:i:s') { $d = DateTime::createFromFormat($format, $date); return $d && $d->format($format) == $date; } /** * The subform layouts **/ protected static $subformLayouts = false; /** * get the subform layout * * @input string The view name * @input string The string name * * @returns string on success **/ public static function getSubformLayout($view, $field, $default = 'repeatablejcb') { // get global values if (self::$subformLayouts === false) { self::$subformLayouts = JComponentHelper::getParams('com_componentbuilder')->get('subform_layouts', false); } // check what we found (else) return default if (ObjectHelper::check(self::$subformLayouts)) { // looking for $target = $view . '.' . $field; foreach (self::$subformLayouts as $subform) { if ($target === $subform->view_field) { return $subform->layout; } elseif ('default' === $subform->view_field) { $default = $subform->layout; } } } return $default; } /** * Check if a row already exist * * @param string $table The table from which to get the variable * @param array $where The value where * @param string $main The component in which the table is found * * @return int the id, or false * */ public static function checkExist($table, $where, $what = 'id', $operator = '=', $main = 'componentbuilder') { // Get a db connection. $db = Factory::getDbo(); // Create a new query object. $query = $db->getQuery(true); $query->select($db->quoteName(array($what))); if (empty($table)) { $query->from($db->quoteName('#__'.$main)); } else { $query->from($db->quoteName('#__'.$main.'_'.$table)); } if (UtilitiesArrayHelper::check($where)) { foreach ($where as $key => $value) { if (is_numeric($value)) { if (is_float($value + 0)) { $query->where($db->quoteName($key) . ' ' . $operator . ' ' . (float) $value); } else { $query->where($db->quoteName($key) . ' ' . $operator . ' ' . (int) $value); } } elseif (is_bool($value)) { $query->where($db->quoteName($key) . ' ' . $operator . ' ' . (bool) $value); } // we do not allow arrays at this point elseif (!UtilitiesArrayHelper::check($value)) { $query->where($db->quoteName($key) . ' ' . $operator . ' ' . $db->quote( (string) $value)); } else { return false; } } } else { return false; } $db->setQuery($query); $db->execute(); if ($db->getNumRows()) { return $db->loadResult(); } return false; } /** * Making class or function name safe * * @input string The name you would like to make safe * * @returns string on success * * @since 3.0.9 * * @deprecated 4.0 - Use ClassfunctionHelper::safe($name); */ public static function safeClassFunctionName($name) { return ClassfunctionHelper::safe($name); } /** * Making field names safe * * @input string The you would like to make safe * @input boolean The switch to return an ALL UPPER CASE string * @input string The string to use in white space * * @returns string on success * * @since 3.0.9 * * @deprecated 4.0 - Use StringFieldHelper::safe($string, $allcap, $spacer); */ public static function safeFieldName($string, $allcap = false, $spacer = '_') { // set the local component option self::setComponentOption(); return StringFieldHelper::safe($string, $allcap, $spacer); } /** * Making field type name safe * * @input string The you would like to make safe * * @returns string on success * * @since 3.0.9 * * @deprecated 4.0 - Use TypeHelper::safe($string); */ public static function safeTypeName($string) { // set the local component option self::setComponentOption(); return TypeHelper::safe($string); } /** * Making namespace safe * * @input string The you would like to make safe * * @returns string on success * * @since 3.0.9 * * @deprecated 4.0 - Use NamespaceHelper::safe($string); */ public static function safeNamespace($string) { return NamespaceHelper::safe($string); } /** * get all strings between two other strings * * @param string $content The content to search * @param string $start The starting value * @param string $end The ending value * * @return array On success * * @since 3.0.9 * * @deprecated 4.0 - Use GetHelper::allBetween($content, $start, $end); */ public static function getAllBetween($content, $start, $end) { return GetHelper::allBetween($content, $start, $end); } /** * get a string between two other strings * * @param string $content The content to search * @param string $start The starting value * @param string $end The ending value * @param string $default The default value if none found * * @return string On success / empty string on failure * * @since 3.0.9 * * @deprecated 4.0 - Use GetHelper::between($content, $start, $end, $default); */ public static function getBetween($content, $start, $end, $default = '') { return GetHelper::between($content, $start, $end, $default); } /** * bc math wrapper (very basic not for accounting) * * @param string $type The type bc math * @param int $val1 The first value * @param int $val2 The second value * @param int $scale The scale value * * @return float|int * * @since 3.0.9 * * @deprecated 4.0 - Use MathHelper::bc($type, $val1, $val2, $scale); */ public static function bcmath($type, $val1, $val2, $scale = 0) { return MathHelper::bc($type, $val1, $val2, $scale); } /** * Basic sum of an array with more precision * * @param array $array The values to sum * @param int $scale The scale value * * @return float|int * * @since 3.0.9 * * @deprecated 4.0 - Use MathHelper::sum($array, $scale); */ public static function bcsum($array, $scale = 4) { return MathHelper::sum($array, $scale); } /** * create plugin class name * * @input string The group name * @input string The name * * @return string * * @since 3.0.9 * * @deprecated 4.0 - Use PluginHelper::safe($name, $group); */ public static function createPluginClassName($group, $name) { return PluginHelper::safeClassName($name, $group); } /** * Returns a GUIDv4 string * * Thanks to Dave Pearson (and other) * https://www.php.net/manual/en/function.com-create-guid.php#119168 * * Uses the best cryptographically secure method * for all supported platforms with fallback to an older, * less secure version. * * @param bool $trim * * @return string * * @since 3.0.9 * * @deprecated 4.0 - Use GuidHelper::get($trim); */ public static function GUID($trim = true) { return GuidHelper::get($trim); } /** * Validate the Globally Unique Identifier ( and check if table already has this identifier) * * @param string $guid * @param string $table * @param int $id * @param string|null $component * * @return bool * * @since 3.0.9 * * @deprecated 4.0 - Use GuidHelper::valid($guid, $table, $id, $component); */ public static function validGUID($guid, $table = null, $id = 0, $component = null) { // set the local component option self::setComponentOption(); return GuidHelper::valid($guid, $table, $id, $component); } /** * get the ITEM of a GUID by table * * @param string $guid * @param string $table * @param string/array $what * @param string|null $component * * @return mixed * * @since 3.0.9 * * @deprecated 4.0 - Use GuidHelper::valid($guid, $table, $id, $component); */ public static function getGUID($guid, $table, $what = 'a.id', $component = null) { // set the local component option self::setComponentOption(); return GuidHelper::item($guid, $table, $what, $component); } /** * Validate the Globally Unique Identifier * * Thanks to Lewie * https://stackoverflow.com/a/1515456/1429677 * * @param string $guid * * @return bool * * @deprecated 4.0 - Use GuidHelper::validate($guid); */ protected static function validateGUID($guid) { return GuidHelper::valid($guid); } /** * The zipper method * * @param string $workingDIR The directory where the items must be zipped * @param string $filepath The path to where the zip file must be placed * * @return bool true On success * * @since 3.0.9 * * @deprecated 4.0 - Use FileHelper::zip($workingDIR, $filepath); */ public static function zip($workingDIR, &$filepath) { return FileHelper::zip($workingDIR, $filepath); } /** * get the content of a file * * @param string $path The path to the file * @param mixed $none The return value if no content was found * * @return string On success * * @since 3.0.9 * * @deprecated 4.0 - Use FileHelper::getContent($path, $none); */ public static function getFileContents($path, $none = '') { return FileHelper::getContent($path, $none); } /** * Write a file to the server * * @param string $path The path and file name where to safe the data * @param string $data The data to safe * * @return bool true On success * * @since 3.0.9 * * @deprecated 4.0 - Use FileHelper::write($path, $data); */ public static function writeFile($path, $data) { return FileHelper::write($path, $data); } /** * get all the file paths in folder and sub folders * * @param string $folder The local path to parse * @param array $fileTypes The type of files to get * * @return array|null * * @since 3.0.9 * * @deprecated 4.0 - Use FileHelper::getPaths($folder, $fileTypes , $recurse, $full); */ public static function getAllFilePaths($folder, $fileTypes = array('\.php', '\.js', '\.css', '\.less'), $recurse = true, $full = true) { return FileHelper::getPaths($folder, $fileTypes , $recurse, $full); } /** * Get the file path or url * * @param string $type The (url/path) type to return * @param string $target The Params Target name (if set) * @param string $fileType The kind of filename to generate (if not set no file name is generated) * @param string $key The key to adjust the filename (if not set ignored) * @param string $default The default path if not set in Params (fallback path) * @param bool $createIfNotSet The switch to create the folder if not found * * @return string On success the path or url is returned based on the type requested * * @since 3.0.9 * * @deprecated 4.0 - Use FileHelper::getPath($type, $target, $fileType, $key, $default, $createIfNotSet); */ public static function getFilePath($type = 'path', $target = 'filepath', $fileType = null, $key = '', $default = '', $createIfNotSet = true) { // set the local component option self::setComponentOption(); return FileHelper::getPath($type, $target, $fileType, $key, $default, $createIfNotSet); } /** * Check if file exist * * @param string $path The url/path to check * * @return bool If exist true * * @since 3.0.9 * * @deprecated 4.0 - Use FileHelper::exists($path); */ public static function urlExists($path) { return FileHelper::exists($path); } /** * Set the component option * * @param String|null $option The option for the component. * * @since 3.0.11 */ public static function setComponentOption($option = null) { // set the local component option if (empty($option)) { if (empty(Helper::$option) && property_exists(__CLASS__, 'ComponentCodeName')) { Helper::$option = 'com_' . self::$ComponentCodeName; } } else { Helper::$option = $option; } } /** * Load the Composer Vendors */ public static function composerAutoload($target) { // insure we load the composer vendor only once if (!isset(self::$composer[$target])) { // get the function name $functionName = UtilitiesStringHelper::safe('compose' . $target); // check if method exist if (method_exists(__CLASS__, $functionName)) { return self::{$functionName}(); } return false; } return self::$composer[$target]; } /** * Load the Component xml manifest. */ public static function manifest() { $manifestUrl = JPATH_ADMINISTRATOR."/components/com_componentbuilder/componentbuilder.xml"; return simplexml_load_file($manifestUrl); } /** * Joomla version object */ protected static $JVersion; /** * set/get Joomla version */ public static function jVersion() { // check if set if (!ObjectHelper::check(self::$JVersion)) { self::$JVersion = new Version(); } return self::$JVersion; } /** * Load the Contributors details. */ public static function getContributors() { // get params $params = ComponentHelper::getParams('com_componentbuilder'); // start contributors array $contributors = []; // get all Contributors (max 20) $searchArray = range('0','20'); foreach($searchArray as $nr) { if ((NULL !== $params->get("showContributor".$nr)) && ($params->get("showContributor".$nr) == 1 || $params->get("showContributor".$nr) == 3)) { // set link based of selected option if($params->get("useContributor".$nr) == 1) { $link_front = ''; $link_back = ''; } elseif($params->get("useContributor".$nr) == 2) { $link_front = ''; $link_back = ''; } else { $link_front = ''; $link_back = ''; } $contributors[$nr]['title'] = UtilitiesStringHelper::html($params->get("titleContributor".$nr)); $contributors[$nr]['name'] = $link_front.UtilitiesStringHelper::html($params->get("nameContributor".$nr)).$link_back; } } return $contributors; } /** * Load the Component Help URLs. **/ public static function getHelpUrl($view) { $user = Factory::getUser(); $groups = $user->get('groups'); $db = Factory::getDbo(); $query = $db->getQuery(true); $query->select(array('a.id','a.groups','a.target','a.type','a.article','a.url')); $query->from('#__componentbuilder_help_document AS a'); $query->where('a.admin_view = '.$db->quote($view)); $query->where('a.location = 1'); $query->where('a.published = 1'); $db->setQuery($query); $db->execute(); if($db->getNumRows()) { $helps = $db->loadObjectList(); if (UtilitiesArrayHelper::check($helps)) { foreach ($helps as $nr => $help) { if ($help->target == 1) { $targetgroups = json_decode($help->groups, true); if (!array_intersect($targetgroups, $groups)) { // if user not in those target groups then remove the item unset($helps[$nr]); continue; } } // set the return type switch ($help->type) { // set joomla article case 1: return self::loadArticleLink($help->article); break; // set help text case 2: return self::loadHelpTextLink($help->id); break; // set Link case 3: return $help->url; break; } } } } return false; } /** * Get the Article Link. **/ protected static function loadArticleLink($id) { return Uri::root() . 'index.php?option=com_content&view=article&id='.$id.'&tmpl=component&layout=modal'; } /** * Get the Help Text Link. **/ protected static function loadHelpTextLink($id) { $token = Session::getFormToken(); return 'index.php?option=com_componentbuilder&task=help.getText&id=' . (int) $id . '&' . $token . '=1'; } /** * Configure the Linkbar. */ public static function addSubmenu($submenu) { // load user for access menus $user = Factory::getUser(); // load the submenus to sidebar \JHtmlSidebar::addEntry(Text::_('COM_COMPONENTBUILDER_SUBMENU_DASHBOARD'), 'index.php?option=com_componentbuilder&view=componentbuilder', $submenu === 'componentbuilder'); // Access control (compiler.submenu). if ($user->authorise('compiler.submenu', 'com_componentbuilder')) { \JHtmlSidebar::addEntry(Text::_('COM_COMPONENTBUILDER_SUBMENU_COMPILER'), 'index.php?option=com_componentbuilder&view=compiler', $submenu === 'compiler'); } if ($user->authorise('joomla_component.access', 'com_componentbuilder') && $user->authorise('joomla_component.submenu', 'com_componentbuilder')) { \JHtmlSidebar::addEntry(Text::_('COM_COMPONENTBUILDER_SUBMENU_JOOMLA_COMPONENTS'), 'index.php?option=com_componentbuilder&view=joomla_components', $submenu === 'joomla_components'); } if ($user->authorise('joomla_module.access', 'com_componentbuilder') && $user->authorise('joomla_module.submenu', 'com_componentbuilder')) { \JHtmlSidebar::addEntry(Text::_('COM_COMPONENTBUILDER_SUBMENU_JOOMLA_MODULES'), 'index.php?option=com_componentbuilder&view=joomla_modules', $submenu === 'joomla_modules'); } if ($user->authorise('joomla_plugin.access', 'com_componentbuilder') && $user->authorise('joomla_plugin.submenu', 'com_componentbuilder')) { \JHtmlSidebar::addEntry(Text::_('COM_COMPONENTBUILDER_SUBMENU_JOOMLA_PLUGINS'), 'index.php?option=com_componentbuilder&view=joomla_plugins', $submenu === 'joomla_plugins'); } if ($user->authorise('power.access', 'com_componentbuilder') && $user->authorise('power.submenu', 'com_componentbuilder')) { \JHtmlSidebar::addEntry(Text::_('COM_COMPONENTBUILDER_SUBMENU_POWERS'), 'index.php?option=com_componentbuilder&view=powers', $submenu === 'powers'); } // Access control (search.access && search.submenu). if ($user->authorise('search.access', 'com_componentbuilder') && $user->authorise('search.submenu', 'com_componentbuilder')) { \JHtmlSidebar::addEntry(Text::_('COM_COMPONENTBUILDER_SUBMENU_SEARCH'), 'index.php?option=com_componentbuilder&view=search', $submenu === 'search'); } if ($user->authorise('admin_view.access', 'com_componentbuilder') && $user->authorise('admin_view.submenu', 'com_componentbuilder')) { \JHtmlSidebar::addEntry(Text::_('COM_COMPONENTBUILDER_SUBMENU_ADMIN_VIEWS'), 'index.php?option=com_componentbuilder&view=admin_views', $submenu === 'admin_views'); } if ($user->authorise('custom_admin_view.access', 'com_componentbuilder') && $user->authorise('custom_admin_view.submenu', 'com_componentbuilder')) { \JHtmlSidebar::addEntry(Text::_('COM_COMPONENTBUILDER_SUBMENU_CUSTOM_ADMIN_VIEWS'), 'index.php?option=com_componentbuilder&view=custom_admin_views', $submenu === 'custom_admin_views'); } if ($user->authorise('site_view.access', 'com_componentbuilder') && $user->authorise('site_view.submenu', 'com_componentbuilder')) { \JHtmlSidebar::addEntry(Text::_('COM_COMPONENTBUILDER_SUBMENU_SITE_VIEWS'), 'index.php?option=com_componentbuilder&view=site_views', $submenu === 'site_views'); } if ($user->authorise('template.access', 'com_componentbuilder') && $user->authorise('template.submenu', 'com_componentbuilder')) { \JHtmlSidebar::addEntry(Text::_('COM_COMPONENTBUILDER_SUBMENU_TEMPLATES'), 'index.php?option=com_componentbuilder&view=templates', $submenu === 'templates'); } if ($user->authorise('layout.access', 'com_componentbuilder') && $user->authorise('layout.submenu', 'com_componentbuilder')) { \JHtmlSidebar::addEntry(Text::_('COM_COMPONENTBUILDER_SUBMENU_LAYOUTS'), 'index.php?option=com_componentbuilder&view=layouts', $submenu === 'layouts'); } if ($user->authorise('dynamic_get.access', 'com_componentbuilder') && $user->authorise('dynamic_get.submenu', 'com_componentbuilder')) { \JHtmlSidebar::addEntry(Text::_('COM_COMPONENTBUILDER_SUBMENU_DYNAMIC_GETS'), 'index.php?option=com_componentbuilder&view=dynamic_gets', $submenu === 'dynamic_gets'); } if ($user->authorise('custom_code.access', 'com_componentbuilder') && $user->authorise('custom_code.submenu', 'com_componentbuilder')) { \JHtmlSidebar::addEntry(Text::_('COM_COMPONENTBUILDER_SUBMENU_CUSTOM_CODES'), 'index.php?option=com_componentbuilder&view=custom_codes', $submenu === 'custom_codes'); } if ($user->authorise('placeholder.access', 'com_componentbuilder') && $user->authorise('placeholder.submenu', 'com_componentbuilder')) { \JHtmlSidebar::addEntry(Text::_('COM_COMPONENTBUILDER_SUBMENU_PLACEHOLDERS'), 'index.php?option=com_componentbuilder&view=placeholders', $submenu === 'placeholders'); } if ($user->authorise('library.access', 'com_componentbuilder') && $user->authorise('library.submenu', 'com_componentbuilder')) { \JHtmlSidebar::addEntry(Text::_('COM_COMPONENTBUILDER_SUBMENU_LIBRARIES'), 'index.php?option=com_componentbuilder&view=libraries', $submenu === 'libraries'); } if ($user->authorise('snippet.access', 'com_componentbuilder') && $user->authorise('snippet.submenu', 'com_componentbuilder')) { \JHtmlSidebar::addEntry(Text::_('COM_COMPONENTBUILDER_SUBMENU_SNIPPETS'), 'index.php?option=com_componentbuilder&view=snippets', $submenu === 'snippets'); } // Access control (get_snippets.submenu). if ($user->authorise('get_snippets.submenu', 'com_componentbuilder')) { \JHtmlSidebar::addEntry(Text::_('COM_COMPONENTBUILDER_SUBMENU_GET_SNIPPETS'), 'index.php?option=com_componentbuilder&view=get_snippets', $submenu === 'get_snippets'); } if ($user->authorise('validation_rule.access', 'com_componentbuilder') && $user->authorise('validation_rule.submenu', 'com_componentbuilder')) { \JHtmlSidebar::addEntry(Text::_('COM_COMPONENTBUILDER_SUBMENU_VALIDATION_RULES'), 'index.php?option=com_componentbuilder&view=validation_rules', $submenu === 'validation_rules'); } if ($user->authorise('field.access', 'com_componentbuilder') && $user->authorise('field.submenu', 'com_componentbuilder')) { \JHtmlSidebar::addEntry(Text::_('COM_COMPONENTBUILDER_SUBMENU_FIELDS'), 'index.php?option=com_componentbuilder&view=fields', $submenu === 'fields'); \JHtmlSidebar::addEntry(Text::_('COM_COMPONENTBUILDER_FIELD_FIELDS_CATEGORIES'), 'index.php?option=com_categories&view=categories&extension=com_componentbuilder.field', $submenu === 'categories.field'); } if ($user->authorise('fieldtype.access', 'com_componentbuilder') && $user->authorise('fieldtype.submenu', 'com_componentbuilder')) { \JHtmlSidebar::addEntry(Text::_('COM_COMPONENTBUILDER_SUBMENU_FIELDTYPES'), 'index.php?option=com_componentbuilder&view=fieldtypes', $submenu === 'fieldtypes'); \JHtmlSidebar::addEntry(Text::_('COM_COMPONENTBUILDER_FIELDTYPE_FIELDTYPES_CATEGORIES'), 'index.php?option=com_categories&view=categories&extension=com_componentbuilder.fieldtype', $submenu === 'categories.fieldtype'); } if ($user->authorise('language_translation.access', 'com_componentbuilder') && $user->authorise('language_translation.submenu', 'com_componentbuilder')) { \JHtmlSidebar::addEntry(Text::_('COM_COMPONENTBUILDER_SUBMENU_LANGUAGE_TRANSLATIONS'), 'index.php?option=com_componentbuilder&view=language_translations', $submenu === 'language_translations'); } if ($user->authorise('language.access', 'com_componentbuilder') && $user->authorise('language.submenu', 'com_componentbuilder')) { \JHtmlSidebar::addEntry(Text::_('COM_COMPONENTBUILDER_SUBMENU_LANGUAGES'), 'index.php?option=com_componentbuilder&view=languages', $submenu === 'languages'); } if ($user->authorise('server.access', 'com_componentbuilder') && $user->authorise('server.submenu', 'com_componentbuilder')) { \JHtmlSidebar::addEntry(Text::_('COM_COMPONENTBUILDER_SUBMENU_SERVERS'), 'index.php?option=com_componentbuilder&view=servers', $submenu === 'servers'); } if ($user->authorise('help_document.access', 'com_componentbuilder') && $user->authorise('help_document.submenu', 'com_componentbuilder')) { \JHtmlSidebar::addEntry(Text::_('COM_COMPONENTBUILDER_SUBMENU_HELP_DOCUMENTS'), 'index.php?option=com_componentbuilder&view=help_documents', $submenu === 'help_documents'); } } /** * UIKIT Component Classes **/ public static $uk_components = array( 'data-uk-grid' => array( 'grid' ), 'uk-accordion' => array( 'accordion' ), 'uk-autocomplete' => array( 'autocomplete' ), 'data-uk-datepicker' => array( 'datepicker' ), 'uk-form-password' => array( 'form-password' ), 'uk-form-select' => array( 'form-select' ), 'data-uk-htmleditor' => array( 'htmleditor' ), 'data-uk-lightbox' => array( 'lightbox' ), 'uk-nestable' => array( 'nestable' ), 'UIkit.notify' => array( 'notify' ), 'data-uk-parallax' => array( 'parallax' ), 'uk-search' => array( 'search' ), 'uk-slider' => array( 'slider' ), 'uk-slideset' => array( 'slideset' ), 'uk-slideshow' => array( 'slideshow', 'slideshow-fx' ), 'uk-sortable' => array( 'sortable' ), 'data-uk-sticky' => array( 'sticky' ), 'data-uk-timepicker' => array( 'timepicker' ), 'data-uk-tooltip' => array( 'tooltip' ), 'uk-placeholder' => array( 'placeholder' ), 'uk-dotnav' => array( 'dotnav' ), 'uk-slidenav' => array( 'slidenav' ), 'uk-form' => array( 'form-advanced' ), 'uk-progress' => array( 'progress' ), 'upload-drop' => array( 'upload', 'form-file' ) ); /** * Add UIKIT Components **/ public static $uikit = false; /** * Get UIKIT Components **/ public static function getUikitComp($content,$classes = array()) { if (strpos($content,'class="uk-') !== false) { // reset $temp = []; foreach (self::$uk_components as $looking => $add) { if (strpos($content,$looking) !== false) { $temp[] = $looking; } } // make sure uikit is loaded to config if (strpos($content,'class="uk-') !== false) { self::$uikit = true; } // sorter if (UtilitiesArrayHelper::check($temp)) { // merger if (UtilitiesArrayHelper::check($classes)) { $newTemp = array_merge($temp,$classes); $temp = array_unique($newTemp); } return $temp; } } if (UtilitiesArrayHelper::check($classes)) { return $classes; } return false; } /** * Prepares the xml document */ public static function xls($rows, $fileName = null, $title = null, $subjectTab = null, $creator = 'Vast Development Method', $description = null, $category = null,$keywords = null, $modified = null) { // set the user $user = Factory::getUser(); // set fileName if not set if (!$fileName) { $fileName = 'exported_'.Factory::getDate()->format('jS_F_Y'); } // set modified if not set if (!$modified) { $modified = $user->name; } // set title if not set if (!$title) { $title = 'Book1'; } // set tab name if not set if (!$subjectTab) { $subjectTab = 'Sheet1'; } // make sure we have the composer classes loaded self::composerAutoload('phpspreadsheet'); // Create new Spreadsheet object $spreadsheet = new Spreadsheet(); // Set document properties $spreadsheet->getProperties() ->setCreator($creator) ->setCompany('Vast Development Method') ->setLastModifiedBy($modified) ->setTitle($title) ->setSubject($subjectTab); // The file type $file_type = 'Xls'; // set description if ($description) { $spreadsheet->getProperties()->setDescription($description); } // set keywords if ($keywords) { $spreadsheet->getProperties()->setKeywords($keywords); } // set category if ($category) { $spreadsheet->getProperties()->setCategory($category); } // Some styles $headerStyles = array( 'font' => array( 'bold' => true, 'color' => array('rgb' => '1171A3'), 'size' => 12, 'name' => 'Verdana' )); $sideStyles = array( 'font' => array( 'bold' => true, 'color' => array('rgb' => '444444'), 'size' => 11, 'name' => 'Verdana' )); $normalStyles = array( 'font' => array( 'color' => array('rgb' => '444444'), 'size' => 11, 'name' => 'Verdana' )); // Add some data if (($size = UtilitiesArrayHelper::check($rows)) !== false) { $i = 1; // Based on data size we adapt the behaviour. $xls_mode = 1; if ($size > 3000) { $xls_mode = 3; $file_type = 'Csv'; } elseif ($size > 2000) { $xls_mode = 2; } // Set active sheet and get it. $active_sheet = $spreadsheet->setActiveSheetIndex(0); foreach ($rows as $array) { $a = 'A'; foreach ($array as $value) { $active_sheet->setCellValue($a.$i, $value); if ($xls_mode != 3) { if ($i == 1) { $active_sheet->getColumnDimension($a)->setAutoSize(true); $active_sheet->getStyle($a.$i)->applyFromArray($headerStyles); $active_sheet->getStyle($a.$i)->getAlignment()->setHorizontal(PhpOffice\PhpSpreadsheet\Style\Alignment::HORIZONTAL_CENTER); } elseif ($a === 'A') { $active_sheet->getStyle($a.$i)->applyFromArray($sideStyles); } elseif ($xls_mode == 1) { $active_sheet->getStyle($a.$i)->applyFromArray($normalStyles); } } $a++; } $i++; } } else { return false; } // Rename worksheet $spreadsheet->getActiveSheet()->setTitle($subjectTab); // Set active sheet index to the first sheet, so Excel opens this as the first sheet $spreadsheet->setActiveSheetIndex(0); // Redirect output to a client's web browser (Excel5) header('Content-Type: application/vnd.ms-excel'); header('Content-Disposition: attachment;filename="' . $fileName . '.' . strtolower($file_type) .'"'); header('Cache-Control: max-age=0'); // If you're serving to IE 9, then the following may be needed header('Cache-Control: max-age=1'); // If you're serving to IE over SSL, then the following may be needed header ('Expires: Mon, 26 Jul 1997 05:00:00 GMT'); // Date in the past header ('Last-Modified: '.gmdate('D, d M Y H:i:s').' GMT'); // always modified header ('Cache-Control: cache, must-revalidate'); // HTTP/1.1 header ('Pragma: public'); // HTTP/1.0 $writer = IOFactory::createWriter($spreadsheet, $file_type); $writer->save('php://output'); jexit(); } /** * Get CSV Headers */ public static function getFileHeaders($dataType) { // make sure we have the composer classes loaded self::composerAutoload('phpspreadsheet'); // get session object $session = Factory::getSession(); $package = $session->get('package', null); $package = json_decode($package, true); // set the headers if(isset($package['dir'])) { // only load first three rows $chunkFilter = new PhpOffice\PhpSpreadsheet\Reader\chunkReadFilter(2,1); // identify the file type $inputFileType = IOFactory::identify($package['dir']); // create the reader for this file type $excelReader = IOFactory::createReader($inputFileType); // load the limiting filter $excelReader->setReadFilter($chunkFilter); $excelReader->setReadDataOnly(true); // load the rows (only first three) $excelObj = $excelReader->load($package['dir']); $headers = []; foreach ($excelObj->getActiveSheet()->getRowIterator() as $row) { if($row->getRowIndex() == 1) { $cellIterator = $row->getCellIterator(); $cellIterator->setIterateOnlyExistingCells(false); foreach ($cellIterator as $cell) { if (!is_null($cell)) { $headers[$cell->getColumn()] = $cell->getValue(); } } $excelObj->disconnectWorksheets(); unset($excelObj); break; } } return $headers; } return false; } /** * Load the Composer Vendor phpspreadsheet */ protected static function composephpspreadsheet() { // load the autoloader for phpspreadsheet require_once JPATH_SITE . '/libraries/phpspreadsheet/vendor/autoload.php'; // do not load again self::$composer['phpspreadsheet'] = true; return true; } /** * Get a Variable * * @param string $table The table from which to get the variable * @param string $where The value where * @param string $whereString The target/field string where/name * @param string $what The return field * @param string $operator The operator between $whereString/field and $where/value * @param string $main The component in which the table is found * * @return mix string/int/float * @deprecated 3.3 Use GetHelper::var(...); */ public static function getVar($table, $where = null, $whereString = 'user', $what = 'id', $operator = '=', $main = 'componentbuilder') { return GetHelper::var( $table, $where, $whereString, $what, $operator, $main ); } /** * Get array of variables * * @param string $table The table from which to get the variables * @param string $where The value where * @param string $whereString The target/field string where/name * @param string $what The return field * @param string $operator The operator between $whereString/field and $where/value * @param string $main The component in which the table is found * @param bool $unique The switch to return a unique array * * @return array * @deprecated 3.3 Use GetHelper::vars(...); */ public static function getVars($table, $where = null, $whereString = 'user', $what = 'id', $operator = 'IN', $main = 'componentbuilder', $unique = true) { return GetHelper::vars( $table, $where, $whereString, $what, $operator, $main, $unique ); } /** * Convert a json object to a string * * @input string $value The json string to convert * * @returns a string * @deprecated 3.3 Use JsonHelper::string(...); */ public static function jsonToString($value, $sperator = ", ", $table = null, $id = 'id', $name = 'name') { return JsonHelper::string( $value, $sperator, $table, $id, $name ); } public static function isPublished($id,$type) { if ($type == 'raw') { $type = 'item'; } $db = Factory::getDbo(); $query = $db->getQuery(true); $query->select(array('a.published')); $query->from('#__componentbuilder_'.$type.' AS a'); $query->where('a.id = '. (int) $id); $query->where('a.published = 1'); $db->setQuery($query); $db->execute(); $found = $db->getNumRows(); if($found) { return true; } return false; } public static function getGroupName($id) { $db = Factory::getDBO(); $query = $db->getQuery(true); $query->select(array('a.title')); $query->from('#__usergroups AS a'); $query->where('a.id = '. (int) $id); $db->setQuery($query); $db->execute(); $found = $db->getNumRows(); if($found) { return $db->loadResult(); } return $id; } /** * Get the action permissions * * @param string $view The related view name * @param int $record The item to act upon * @param string $views The related list view name * @param mixed $target Only get this permission (like edit, create, delete) * @param string $component The target component * @param object $user The user whose permissions we are loading * * @return object The CMSObject of permission/authorised actions * */ public static function getActions($view, &$record = null, $views = null, $target = null, $component = 'componentbuilder', $user = 'null') { // load the user if not given if (!ObjectHelper::check($user)) { // get the user object $user = Factory::getUser(); } // load the CMSObject $result = new CMSObject; // make view name safe (just incase) $view = UtilitiesStringHelper::safe($view); if (UtilitiesStringHelper::check($views)) { $views = UtilitiesStringHelper::safe($views); } // get all actions from component $actions = Access::getActionsFromFile( JPATH_ADMINISTRATOR . '/components/com_' . $component . '/access.xml', "/access/section[@name='component']/" ); // if non found then return empty CMSObject if (empty($actions)) { return $result; } // get created by if not found if (ObjectHelper::check($record) && !isset($record->created_by) && isset($record->id)) { $record->created_by = GetHelper::var($view, $record->id, 'id', 'created_by', '=', $component); } // set actions only set in component settings $componentActions = array('core.admin', 'core.manage', 'core.options', 'core.export'); // check if we have a target $checkTarget = false; if ($target) { // convert to an array if (UtilitiesStringHelper::check($target)) { $target = array($target); } // check if we are good to go if (UtilitiesArrayHelper::check($target)) { $checkTarget = true; } } // loop the actions and set the permissions foreach ($actions as $action) { // check target action filter if ($checkTarget && self::filterActions($view, $action->name, $target)) { continue; } // set to use component default $fallback = true; // reset permission per/action $permission = false; $catpermission = false; // set area $area = 'comp'; // check if the record has an ID and the action is item related (not a component action) if (ObjectHelper::check($record) && isset($record->id) && $record->id > 0 && !in_array($action->name, $componentActions) && (strpos($action->name, 'core.') !== false || strpos($action->name, $view . '.') !== false)) { // we are in item $area = 'item'; // The record has been set. Check the record permissions. $permission = $user->authorise($action->name, 'com_' . $component . '.' . $view . '.' . (int) $record->id); // if no permission found, check edit own if (!$permission) { // With edit, if the created_by matches current user then dig deeper. if (($action->name === 'core.edit' || $action->name === $view . '.edit') && $record->created_by > 0 && ($record->created_by == $user->id)) { // the correct target $coreCheck = (array) explode('.', $action->name); // check that we have both local and global access if ($user->authorise($coreCheck[0] . '.edit.own', 'com_' . $component . '.' . $view . '.' . (int) $record->id) && $user->authorise($coreCheck[0] . '.edit.own', 'com_' . $component)) { // allow edit $result->set($action->name, true); // set not to use global default // because we already validated it $fallback = false; } else { // do not allow edit $result->set($action->name, false); $fallback = false; } } } elseif (UtilitiesStringHelper::check($views) && isset($record->catid) && $record->catid > 0) { // we are in item $area = 'category'; // set the core check $coreCheck = explode('.', $action->name); $core = $coreCheck[0]; // make sure we use the core. action check for the categories if (strpos($action->name, $view) !== false && strpos($action->name, 'core.') === false ) { $coreCheck[0] = 'core'; $categoryCheck = implode('.', $coreCheck); } else { $categoryCheck = $action->name; } // The record has a category. Check the category permissions. $catpermission = $user->authorise($categoryCheck, 'com_' . $component . '.' . $views . '.category.' . (int) $record->catid); if (!$catpermission && !is_null($catpermission)) { // With edit, if the created_by matches current user then dig deeper. if (($action->name === 'core.edit' || $action->name === $view . '.edit') && $record->created_by > 0 && ($record->created_by == $user->id)) { // check that we have both local and global access if ($user->authorise('core.edit.own', 'com_' . $component . '.' . $views . '.category.' . (int) $record->catid) && $user->authorise($core . '.edit.own', 'com_' . $component)) { // allow edit $result->set($action->name, true); // set not to use global default // because we already validated it $fallback = false; } else { // do not allow edit $result->set($action->name, false); $fallback = false; } } } } } // if allowed then fallback on component global settings if ($fallback) { // if item/category blocks access then don't fall back on global if ((($area === 'item') && !$permission) || (($area === 'category') && !$catpermission)) { // do not allow $result->set($action->name, false); } // Finally remember the global settings have the final say. (even if item allow) // The local item permissions can block, but it can't open and override of global permissions. // Since items are created by users and global permissions is set by system admin. else { $result->set($action->name, $user->authorise($action->name, 'com_' . $component)); } } } return $result; } /** * Filter the action permissions * * @param string $action The action to check * @param array $targets The array of target actions * * @return boolean true if action should be filtered out * */ protected static function filterActions(&$view, &$action, &$targets) { foreach ($targets as $target) { if (strpos($action, $view . '.' . $target) !== false || strpos($action, 'core.' . $target) !== false) { return false; break; } } return true; } /** * Get any component's model */ public static function getModel($name, $path = JPATH_COMPONENT_ADMINISTRATOR, $Component = 'Componentbuilder', $config = []) { // fix the name $name = UtilitiesStringHelper::safe($name); // full path to models $fullPathModels = $path . '/models'; // load the model file BaseDatabaseModel::addIncludePath($fullPathModels, $Component . 'Model'); // make sure the table path is loaded if (!isset($config['table_path']) || !UtilitiesStringHelper::check($config['table_path'])) { // This is the JCB default path to tables in Joomla 3.x $config['table_path'] = JPATH_ADMINISTRATOR . '/components/com_' . strtolower($Component) . '/tables'; } // get instance $model = BaseDatabaseModel::getInstance($name, $Component . 'Model', $config); // if model not found (strange) if ($model == false) { jimport('joomla.filesystem.file'); // get file path $filePath = $path . '/' . $name . '.php'; $fullPathModel = $fullPathModels . '/' . $name . '.php'; // check if it exists if (File::exists($filePath)) { // get the file require_once $filePath; } elseif (File::exists($fullPathModel)) { // get the file require_once $fullPathModel; } // build class names $modelClass = $Component . 'Model' . $name; if (class_exists($modelClass)) { // initialize the model return new $modelClass($config); } } return $model; } /** * Add to asset Table */ public static function setAsset($id, $table, $inherit = true) { $parent = Table::getInstance('Asset'); $parent->loadByName('com_componentbuilder'); $parentId = $parent->id; $name = 'com_componentbuilder.'.$table.'.'.$id; $title = ''; $asset = Table::getInstance('Asset'); $asset->loadByName($name); // Check for an error. $error = $asset->getError(); if ($error) { return false; } else { // Specify how a new or moved node asset is inserted into the tree. if ($asset->parent_id != $parentId) { $asset->setLocation($parentId, 'last-child'); } // Prepare the asset to be stored. $asset->parent_id = $parentId; $asset->name = $name; $asset->title = $title; // get the default asset rules $rules = self::getDefaultAssetRules('com_componentbuilder', $table, $inherit); if ($rules instanceof AccessRules) { $asset->rules = (string) $rules; } if (!$asset->check() || !$asset->store()) { Factory::getApplication()->enqueueMessage($asset->getError(), 'warning'); return false; } else { // Create an asset_id or heal one that is corrupted. $object = new stdClass(); // Must be a valid primary key value. $object->id = $id; $object->asset_id = (int) $asset->id; // Update their asset_id to link to the asset table. return Factory::getDbo()->updateObject('#__componentbuilder_'.$table, $object, 'id'); } } return false; } /** * Gets the default asset Rules for a component/view. */ protected static function getDefaultAssetRules($component, $view, $inherit = true) { // if new or inherited $assetId = 0; // Only get the actual item rules if not inheriting if (!$inherit) { // Need to find the asset id by the name of the component. $db = Factory::getDbo(); $query = $db->getQuery(true) ->select($db->quoteName('id')) ->from($db->quoteName('#__assets')) ->where($db->quoteName('name') . ' = ' . $db->quote($component)); $db->setQuery($query); $db->execute(); // check that there is a value if ($db->getNumRows()) { // asset already set so use saved rules $assetId = (int) $db->loadResult(); } } // get asset rules $result = Access::getAssetRules($assetId); if ($result instanceof AccessRules) { $_result = (string) $result; $_result = json_decode($_result); foreach ($_result as $name => &$rule) { $v = explode('.', $name); if ($view !== $v[0]) { // remove since it is not part of this view unset($_result->$name); } elseif ($inherit) { // clear the value since we inherit $rule = []; } } // check if there are any view values remaining if (count((array) $_result)) { $_result = json_encode($_result); $_result = array($_result); // Instantiate and return the AccessRules object for the asset rules. $rules = new AccessRules($_result); // return filtered rules return $rules; } } return $result; } /** * xmlAppend * * @param SimpleXMLElement $xml The XML element reference in which to inject a comment * @param mixed $node A SimpleXMLElement node to append to the XML element reference, or a stdClass object containing a comment attribute to be injected before the XML node and a fieldXML attribute containing a SimpleXMLElement * * @return void * @deprecated 3.3 Use FormHelper::append($xml, $node); */ public static function xmlAppend(&$xml, $node) { FormHelper::append($xml, $node); } /** * xmlComment * * @param SimpleXMLElement $xml The XML element reference in which to inject a comment * @param string $comment The comment to inject * * @return void * @deprecated 3.3 Use FormHelper::comment($xml, $comment); */ public static function xmlComment(&$xml, $comment) { FormHelper::comment($xml, $comment); } /** * xmlAddAttributes * * @param SimpleXMLElement $xml The XML element reference in which to inject a comment * @param array $attributes The attributes to apply to the XML element * * @return null * @deprecated 3.3 Use FormHelper::attributes($xml, $attributes); */ public static function xmlAddAttributes(&$xml, $attributes = []) { FormHelper::attributes($xml, $attributes); } /** * xmlAddOptions * * @param SimpleXMLElement $xml The XML element reference in which to inject a comment * @param array $options The options to apply to the XML element * * @return void * @deprecated 3.3 Use FormHelper::options($xml, $options); */ public static function xmlAddOptions(&$xml, $options = []) { FormHelper::options($xml, $options); } /** * get the field object * * @param array $attributes The array of attributes * @param string $default The default of the field * @param array $options The options to apply to the XML element * * @return object * @deprecated 3.3 Use FormHelper::field($attributes, $default, $options); */ public static function getFieldObject(&$attributes, $default = '', $options = null) { return FormHelper::field($attributes, $default, $options); } /** * get the field xml * * @param array $attributes The array of attributes * @param array $options The options to apply to the XML element * * @return object * @deprecated 3.3 Use FormHelper::xml($attributes, $options); */ public static function getFieldXML(&$attributes, $options = null) { return FormHelper::xml($attributes, $options); } /** * Render Bool Button * * @param array $args All the args for the button * 0) name * 1) additional (options class) // not used at this time * 2) default * 3) yes (name) * 4) no (name) * * @return string The input html of the button * */ public static function renderBoolButton() { $args = func_get_args(); // check if there is additional button class $additional = isset($args[1]) ? (string) $args[1] : ''; // not used at this time // button attributes $buttonAttributes = array( 'type' => 'radio', 'name' => isset($args[0]) ? UtilitiesStringHelper::html($args[0]) : 'bool_button', 'label' => isset($args[0]) ? UtilitiesStringHelper::safe(UtilitiesStringHelper::html($args[0]), 'Ww') : 'Bool Button', // not seen anyway 'class' => 'btn-group', 'filter' => 'INT', 'default' => isset($args[2]) ? (int) $args[2] : 0); // set the button options $buttonOptions = array( '1' => isset($args[3]) ? UtilitiesStringHelper::html($args[3]) : 'JYES', '0' => isset($args[4]) ? UtilitiesStringHelper::html($args[4]) : 'JNO'); // return the input return FormHelper::field($buttonAttributes, $buttonAttributes['default'], $buttonOptions)->input; } /** * Check if have an json string * * @input string The json string to check * * @returns bool true on success * @deprecated 3.3 Use JsonHelper::check($string); */ public static function checkJson($string) { return JsonHelper::check($string); } /** * Check if have an object with a length * * @input object The object to check * * @returns bool true on success * @deprecated 3.3 Use ObjectHelper::check($object); */ public static function checkObject($object) { return ObjectHelper::check($object); } /** * Check if have an array with a length * * @input array The array to check * * @returns bool/int number of items in array on success * @deprecated 3.3 Use UtilitiesArrayHelper::check($array, $removeEmptyString); */ public static function checkArray($array, $removeEmptyString = false) { return UtilitiesArrayHelper::check($array, $removeEmptyString); } /** * Check if have a string with a length * * @input string The string to check * * @returns bool true on success * @deprecated 3.3 Use UtilitiesStringHelper::check($string); */ public static function checkString($string) { return UtilitiesStringHelper::check($string); } /** * Check if we are connected * Thanks https://stackoverflow.com/a/4860432/1429677 * * @returns bool true on success */ public static function isConnected() { // If example.com is down, then probably the whole internet is down, since IANA maintains the domain. Right? $connected = @fsockopen("www.example.com", 80); // website, port (try 80 or 443) if ($connected) { //action when connected $is_conn = true; fclose($connected); } else { //action in connection failure $is_conn = false; } return $is_conn; } /** * Merge an array of array's * * @input array The arrays you would like to merge * * @returns array on success * @deprecated 3.3 Use UtilitiesArrayHelper::merge($arrays); */ public static function mergeArrays($arrays) { return UtilitiesArrayHelper::merge($arrays); } // typo sorry! public static function sorten($string, $length = 40, $addTip = true) { return self::shorten($string, $length, $addTip); } /** * Shorten a string * * @input string The you would like to shorten * * @returns string on success * @deprecated 3.3 Use UtilitiesStringHelper::shorten(...); */ public static function shorten($string, $length = 40, $addTip = true) { return UtilitiesStringHelper::shorten($string, $length, $addTip); } /** * Making strings safe (various ways) * * @input string The you would like to make safe * * @returns string on success * @deprecated 3.3 Use UtilitiesStringHelper::safe(...); */ public static function safeString($string, $type = 'L', $spacer = '_', $replaceNumbers = true, $keepOnlyCharacters = true) { return UtilitiesStringHelper::safe( $string, $type, $spacer, $replaceNumbers, $keepOnlyCharacters ); } /** * Convert none English strings to code usable string * * @input an string * * @returns a string * @deprecated 3.3 Use UtilitiesStringHelper::transliterate($string); */ public static function transliterate($string) { return UtilitiesStringHelper::transliterate($string); } /** * make sure a string is HTML save * * @input an html string * * @returns a string * @deprecated 3.3 Use UtilitiesStringHelper::html(...); */ public static function htmlEscape($var, $charset = 'UTF-8', $shorten = false, $length = 40) { return UtilitiesStringHelper::html( $var, $charset, $shorten, $length ); } /** * Convert all int in a string to an English word string * * @input an string with numbers * * @returns a string * @deprecated 3.3 Use UtilitiesStringHelper::numbers($string); */ public static function replaceNumbers($string) { return UtilitiesStringHelper::numbers($string); } /** * Convert an integer into an English word string * Thanks to Tom Nicholson * * @input an int * @returns a string * @deprecated 3.3 Use UtilitiesStringHelper::number($x); */ public static function numberToString($x) { return UtilitiesStringHelper::number($x); } /** * Random Key * * @returns a string * @deprecated 3.3 Use UtilitiesStringHelper::random($size); */ public static function randomkey($size) { return UtilitiesStringHelper::random($size); } /** * Get The Encryption Keys * * @param string $type The type of key * @param string/bool $default The return value if no key was found * * @return string On success * **/ public static function getCryptKey($type, $default = false) { // Get the global params $params = ComponentHelper::getParams('com_componentbuilder', true); // Basic Encryption Type if ('basic' === $type) { $basic_key = $params->get('basic_key', $default); if (UtilitiesStringHelper::check($basic_key)) { return $basic_key; } } return $default; } }