@copyright Copyright (C) 2015. All Rights Reserved @license GNU/GPL Version 2 or later - http://www.gnu.org/licenses/gpl-2.0.html ____ _____ _____ __ __ __ __ ___ _____ __ __ ____ _____ _ _ ____ _ _ ____ (_ _)( _ )( _ )( \/ )( ) /__\ / __)( _ )( \/ )( _ \( _ )( \( )( ___)( \( )(_ _) .-_)( )(_)( )(_)( ) ( )(__ /(__)\ ( (__ )(_)( ) ( )___/ )(_)( ) ( )__) ) ( )( \____) (_____)(_____)(_/\/\_)(____)(__)(__) \___)(_____)(_/\/\_)(__) (_____)(_)\_)(____)(_)\_) (__) /------------------------------------------------------------------------------------------------------*/ // No direct access to this file defined('_JEXEC') or die('Restricted access'); /** * Demo component helper */ abstract class DemoHelper {###SITE_GLOBAL_EVENT_HELPER### ###SITE_CUSTOM_HELPER_SCRIPT### public static function jsonToString($value) { // check if string is JSON $result = json_decode($value, true); if (json_last_error() === JSON_ERROR_NONE) { // is JSON if (self::checkArray($result)) { $value = ''; $counter = 0; foreach ($result as $string) { if ($counter) { $value .= ", ".$string; } else { $value .= $string; } $counter++; } } return json_decode($value); } return $value; } /** * Load the Component xml manifest. **/ public static function manifest() { $manifestUrl = JPATH_ADMINISTRATOR."/components/com_demo/demo.xml"; return simplexml_load_file($manifestUrl); } /** * Load the Contributors details. **/ public static function getContributors() { // get params $params = JComponentHelper::getParams('com_demo'); // start contributors array $contributors = array(); // get all Contributors (max 20) $searchArray = range('0','20'); foreach($searchArray as $nr) { if ((NULL !== $params->get("showContributor".$nr)) && ($params->get("showContributor".$nr) == 2 || $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'] = self::htmlEscape($params->get("titleContributor".$nr)); $contributors[$nr]['name'] = $link_front.self::htmlEscape($params->get("nameContributor".$nr)).$link_back; } } return $contributors; } /** * Load the Component Help URLs. **/ public static function getHelpUrl($view) { $user = JFactory::getUser(); $groups = $user->get('groups'); $db = JFactory::getDbo(); $query = $db->getQuery(true); $query->select(array('a.id','a.groups','a.target','a.type','a.article','a.url')); $query->from('#__demo_help_document AS a'); $query->where('a.site_view = '.$db->quote($view)); $query->where('a.location = 2'); $query->where('a.published = 1'); $db->setQuery($query); $db->execute(); if($db->getNumRows()) { $helps = $db->loadObjectList(); if (self::checkArray($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 JURI::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 = JSession::getFormToken(); return 'index.php?option=com_demo&task=help.getText&id=' . (int) $id . '&token=' . $token; } /** * Get any component's model **/ public static function getModel($name, $path = JPATH_COMPONENT_SITE, $component = 'demo') { // load some joomla helpers JLoader::import('joomla.application.component.model'); // load the model file JLoader::import( $name, $path . '/models' ); // return instance return JModelLegacy::getInstance( $name, $component.'Model' ); } /** * Add to asset Table */ public static function setAsset($id,$table) { $parent = JTable::getInstance('Asset'); $parent->loadByName('com_demo'); $parentId = $parent->id; $name = 'com_demo.'.$table.'.'.$id; $title = ''; $asset = JTable::getInstance('Asset'); $asset->loadByName($name); // Check for an error. $error = $asset->getError(); if ($error) { $this->setError($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_demo',$table); if ($rules instanceof JAccessRules) { $asset->rules = (string) $rules; } if (!$asset->check() || !$asset->store()) { JError::raiseWarning(500, $asset->getError()); 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 JFactory::getDbo()->updateObject('#__demo_'.$table, $object, 'id'); } } return false; } /** * Gets the default asset Rules for a component/view. */ protected static function getDefaultAssetRules($component,$view) { // Need to find the asset id by the name of the component. $db = JFactory::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(); if ($db->loadRowList()) { // asset alread set so use saved rules $assetId = (int) $db->loadResult(); $result = JAccess::getAssetRules($assetId); if ($result instanceof JAccessRules) { $_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); } else { // clear the value since we inherit $rule = array(); } } // check if there are any view values remaining if (count($_result)) { $_result = json_encode($_result); $_result = array($_result); // Instantiate and return the JAccessRules object for the asset rules. $rules = new JAccessRules($_result); return $rules; } return $result; } } return JAccess::getAssetRules(0); } public static function renderBoolButton() { $args = func_get_args(); // get the radio element $button = JFormHelper::loadFieldType('radio'); // setup the properties $name = self::htmlEscape($args[0]); $additional = isset($args[1]) ? (string) $args[1] : ''; $value = $args[2]; $yes = isset($args[3]) ? self::htmlEscape($args[3]) : 'JYES'; $no = isset($args[4]) ? self::htmlEscape($args[4]) : 'JNO'; // prepare the xml $element = new SimpleXMLElement(''); // run $button->setup($element, $value); return $button->input; } public static function getVar($table, $where = null, $whereString = 'user', $what = 'id', $operator = '=', $main = 'demo') { if(!$where) { $where = JFactory::getUser()->id; } // Get a db connection. $db = JFactory::getDbo(); // Create a new query object. $query = $db->getQuery(true); $query->select($db->quoteName(array($what))); $query->from($db->quoteName('#__'.$main.'_'.$table)); if (is_numeric($where)) { $query->where($db->quoteName($whereString) . ' '.$operator.' '.(int) $where); } elseif (is_string($where)) { $query->where($db->quoteName($whereString) . ' '.$operator.' '. $db->quote((string)$where)); } else { return false; } $db->setQuery($query); $db->execute(); if ($db->getNumRows()) { return $db->loadResult(); } return false; } public static function getVars($table, $where = null, $whereString = 'user', $what = 'id', $operator = 'IN', $main = 'demo', $unique = true) { if(!$where) { $where = JFactory::getUser()->id; } if (!self::checkArray($where) && $where > 0) { $where = array($where); } if (self::checkArray($where)) { // Get a db connection. $db = JFactory::getDbo(); // Create a new query object. $query = $db->getQuery(true); $query->select($db->quoteName(array($what))); $query->from($db->quoteName('#__'.$main.'_'.$table)); $query->where($db->quoteName($whereString) . ' '.$operator.' (' . implode(',',$where) . ')'); $db->setQuery($query); $db->execute(); if ($db->getNumRows()) { if ($unique) { return array_unique($db->loadColumn()); } return $db->loadColumn(); } } return false; } /** * Get the actions permissions **/ public static function getActions($view,&$record = null,$views = null) { jimport('joomla.access.access'); $user = JFactory::getUser(); $result = new JObject; $view = self::safeString($view); if (self::checkString($views)) { $views = self::safeString($views); } // get all actions from component $actions = JAccess::getActions('com_demo', 'component'); // set acctions only set in component settiongs $componentActions = array('core.admin','core.manage','core.options','core.export'); // loop the actions and set the permissions foreach ($actions as $action) { // set to use component default $allow = true; if (self::checkObject($record) && isset($record->id) && $record->id > 0 && !in_array($action->name,$componentActions)) { // The record has been set. Check the record permissions. $permission = $user->authorise($action->name, 'com_demo.'.$view.'.' . (int) $record->id); if (!$permission && !is_null($permission)) { if ($action->name == 'core.edit' || $action->name == $view.'.edit') { if ($user->authorise('core.edit.own', 'com_demo.'.$view.'.' . (int) $record->id)) { // If the owner matches 'me' then allow. if (isset($record->created_by) && $record->created_by > 0 && ($record->created_by == $user->id)) { $result->set($action->name, true); // set not to use component default $allow = false; } else { $result->set($action->name, false); // set not to use component default $allow = false; } } elseif ($user->authorise($view.'edit.own', 'com_demo.'.$view.'.' . (int) $record->id)) { // If the owner matches 'me' then allow. if (isset($record->created_by) && $record->created_by > 0 && ($record->created_by == $user->id)) { $result->set($action->name, true); // set not to use component default $allow = false; } else { $result->set($action->name, false); // set not to use component default $allow = false; } } elseif ($user->authorise('core.edit.own', 'com_demo')) { // If the owner matches 'me' then allow. if (isset($record->created_by) && $record->created_by > 0 && ($record->created_by == $user->id)) { $result->set($action->name, true); // set not to use component default $allow = false; } else { $result->set($action->name, false); // set not to use component default $allow = false; } } elseif ($user->authorise($view.'edit.own', 'com_demo')) { // If the owner matches 'me' then allow. if (isset($record->created_by) && $record->created_by > 0 && ($record->created_by == $user->id)) { $result->set($action->name, true); // set not to use component default $allow = false; } else { $result->set($action->name, false); // set not to use component default $allow = false; } } } } elseif (self::checkString($views) && isset($record->catid) && $record->catid > 0) { // make sure we use the core. action check for the categories if (strpos($action->name,$view) !== false && strpos($action->name,'core.') === false ) { $coreCheck = explode('.',$action->name); $coreCheck[0] = 'core'; $categoryCheck = implode('.',$coreCheck); } else { $categoryCheck = $action->name; } // The record has a category. Check the category permissions. $catpermission = $user->authorise($categoryCheck, 'com_demo.'.$views.'.category.' . (int) $record->catid); if (!$catpermission && !is_null($catpermission)) { if ($action->name == 'core.edit' || $action->name == $view.'.edit') { if ($user->authorise('core.edit.own', 'com_demo.'.$views.'.category.' . (int) $record->catid)) { // If the owner matches 'me' then allow. if (isset($record->created_by) && $record->created_by > 0 && ($record->created_by == $user->id)) { $result->set($action->name, true); // set not to use component default $allow = false; } else { $result->set($action->name, false); // set not to use component default $allow = false; } } elseif ($user->authorise($view.'edit.own', 'com_demo.'.$views.'.category.' . (int) $record->catid)) { // If the owner matches 'me' then allow. if (isset($record->created_by) && $record->created_by > 0 && ($record->created_by == $user->id)) { $result->set($action->name, true); // set not to use component default $allow = false; } else { $result->set($action->name, false); // set not to use component default $allow = false; } } elseif ($user->authorise('core.edit.own', 'com_demo')) { // If the owner matches 'me' then allow. if (isset($record->created_by) && $record->created_by > 0 && ($record->created_by == $user->id)) { $result->set($action->name, true); // set not to use component default $allow = false; } else { $result->set($action->name, false); // set not to use component default $allow = false; } } elseif ($user->authorise($view.'edit.own', 'com_demo')) { // If the owner matches 'me' then allow. if (isset($record->created_by) && $record->created_by > 0 && ($record->created_by == $user->id)) { $result->set($action->name, true); // set not to use component default $allow = false; } else { $result->set($action->name, false); // set not to use component default $allow = false; } } } } } } // if allowed then fall back on component global settings if ($allow) { $result->set($action->name, $user->authorise($action->name, 'com_demo')); } } return $result; } public static function checkObject($object) { if (isset($object) && is_object($object) && count($object) > 0) { return true; } return false; } public static function checkArray($array) { if (isset($array) && is_array($array) && count($array) > 0) { return true; } return false; } public static function checkString($string) { if (isset($string) && is_string($string) && strlen($string) > 0) { return true; } return false; } public static function mergeArrays($arrays) { if(self::checkArray($arrays)) { $arrayBuket = array(); foreach ($arrays as $array) { if (self::checkArray($array)) { $arrayBuket = array_merge($arrayBuket, $array); } } return $arrayBuket; } return false; } public static function sorten($string, $length = 40, $addTip = true) { if (self::checkString($string)) { $initial = strlen($string); $words = preg_split('/([\s\n\r]+)/', $string, null, PREG_SPLIT_DELIM_CAPTURE); $words_count = count($words); $word_length = 0; $last_word = 0; for (; $last_word < $words_count; ++$last_word) { $word_length += strlen($words[$last_word]); if ($word_length > $length) { break; } } $newString = implode(array_slice($words, 0, $last_word)); $final = strlen($newString); if ($initial != $final && $addTip) { $title = self::sorten($string, 400 , false); return ''.trim($newString).'...'; } elseif ($initial != $final && !$addTip) { return trim($newString).'...'; } } return $string; } public static function safeString($string, $type = 'L', $spacer = '_') { // remove all numbers and replace with english text version (works well only up to a thousand) $string = self::replaceNumbers($string); if (self::checkString($string)) { // remove all other characters $string = trim($string); $string = preg_replace('/'.$spacer.'+/', ' ', $string); $string = preg_replace('/\s+/', ' ', $string); $string = preg_replace("/[^A-Za-z ]/", '', $string); // return a string with all first letter of each word uppercase(no undersocre) if ($type == 'W') { return ucwords(strtolower($string)); } elseif ($type == 'w') { return strtolower($string); } elseif ($type == 'Ww') { return ucfirst(strtolower($string)); } elseif ($type == 'WW') { return strtoupper($string); } elseif ($type == 'U') { // replace white space with underscore $string = preg_replace('/\s+/', $spacer, $string); // return all upper return strtoupper($string); } elseif ($type == 'F') { // replace white space with underscore $string = preg_replace('/\s+/', $spacer, $string); // return with first caracter to upper return ucfirst(strtolower($string)); } elseif ($type == 'L') { // replace white space with underscore $string = preg_replace('/\s+/', $spacer, $string); // default is to return lower return strtolower($string); } // return string return $string; } // not a string return ''; } public static function htmlEscape($var, $charset = 'UTF-8', $sorten = false, $length = 40) { if (self::checkString($var)) { $filter = new JFilterInput(); $string = $filter->clean(html_entity_decode(htmlentities($var, ENT_COMPAT, $charset)), 'HTML'); if ($sorten) { return self::sorten($string,$length); } return $string; } else { return ''; } } public static function replaceNumbers($string) { // set numbers array $numbers = array(); // first get all numbers preg_match_all('!\d+!', $string, $numbers); // check if we have any numbers if (isset($numbers[0]) && self::checkArray($numbers[0])) { foreach ($numbers[0] as $number) { $searchReplace[$number] = self::numberToString((int)$number); } // now replace numbers in string $string = str_replace(array_keys($searchReplace), array_values($searchReplace),$string); // check if we missed any, strange if we did. return self::replaceNumbers($string); } // return the string with no numbers remaining. return $string; } /** * Convert an integer into an English word string * Thanks to Tom Nicholson * * @input an int * @returns a string **/ public static function numberToString($x) { $nwords = array( "zero", "one", "two", "three", "four", "five", "six", "seven", "eight", "nine", "ten", "eleven", "twelve", "thirteen", "fourteen", "fifteen", "sixteen", "seventeen", "eighteen", "nineteen", "twenty", 30 => "thirty", 40 => "forty", 50 => "fifty", 60 => "sixty", 70 => "seventy", 80 => "eighty", 90 => "ninety" ); if(!is_numeric($x)) { $w = $x; } elseif(fmod($x, 1) != 0) { $w = $x; } else { if($x < 0) { $w = 'minus '; $x = -$x; } else { $w = ''; // ... now $x is a non-negative integer. } if($x < 21) // 0 to 20 { $w .= $nwords[$x]; } elseif($x < 100) // 21 to 99 { $w .= $nwords[10 * floor($x/10)]; $r = fmod($x, 10); if($r > 0) { $w .= ' '. $nwords[$r]; } } elseif($x < 1000) // 100 to 999 { $w .= $nwords[floor($x/100)] .' hundred'; $r = fmod($x, 100); if($r > 0) { $w .= ' and '. self::numberToString($r); } } elseif($x < 1000000) // 1000 to 999999 { $w .= self::numberToString(floor($x/1000)) .' thousand'; $r = fmod($x, 1000); if($r > 0) { $w .= ' '; if($r < 100) { $w .= 'and '; } $w .= self::numberToString($r); } } else // millions { $w .= self::numberToString(floor($x/1000000)) .' million'; $r = fmod($x, 1000000); if($r > 0) { $w .= ' '; if($r < 100) { $word .= 'and '; } $w .= self::numberToString($r); } } } return $w; } /** * Random Key * * @returns a string **/ public static function randomkey($size) { $bag = "abcefghijknopqrstuwxyzABCDDEFGHIJKLLMMNOPQRSTUVVWXYZabcddefghijkllmmnopqrstuvvwxyzABCEFGHIJKNOPQRSTUWXYZ"; $key = array(); $bagsize = strlen($bag) - 1; for ($i = 0; $i < $size; $i++) { $get = rand(0, $bagsize); $key[] = $bag[$get]; } return implode($key); } }