update Piwik to version 2.16 (fixes #91)
This commit is contained in:
oliver
parent
296343bf3b
commit
d885a4baa9
5833 changed files with 418860 additions and 226988 deletions
|
|
@ -1,6 +1,6 @@
|
|||
<?php
|
||||
/**
|
||||
* Piwik - Open source web analytics
|
||||
* Piwik - free/libre analytics platform
|
||||
*
|
||||
* @link http://piwik.org
|
||||
* @license http://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later
|
||||
|
|
@ -9,39 +9,232 @@
|
|||
|
||||
namespace Piwik\Plugins\CoreConsole\Commands;
|
||||
|
||||
|
||||
use Piwik\Development;
|
||||
use Piwik\Filesystem;
|
||||
use Piwik\Plugin\ConsoleCommand;
|
||||
use Piwik\Plugin\Dependency;
|
||||
use Piwik\Version;
|
||||
use Symfony\Component\Console\Input\InputInterface;
|
||||
use Symfony\Component\Console\Output\OutputInterface;
|
||||
|
||||
/**
|
||||
*/
|
||||
abstract class GeneratePluginBase extends ConsoleCommand
|
||||
{
|
||||
public function getPluginPath($pluginName)
|
||||
public function isEnabled()
|
||||
{
|
||||
return PIWIK_INCLUDE_PATH . '/plugins/' . ucfirst($pluginName);
|
||||
return Development::isEnabled();
|
||||
}
|
||||
|
||||
private function createFolderWithinPluginIfNotExists($pluginName, $folder)
|
||||
public function getPluginPath($pluginName)
|
||||
{
|
||||
$pluginPath = $this->getPluginPath($pluginName);
|
||||
return PIWIK_INCLUDE_PATH . $this->getRelativePluginPath($pluginName);
|
||||
}
|
||||
|
||||
if (!file_exists($pluginName . $folder)) {
|
||||
Filesystem::mkdir($pluginPath . $folder, true);
|
||||
private function getRelativePluginPath($pluginName)
|
||||
{
|
||||
return '/plugins/' . $pluginName;
|
||||
}
|
||||
|
||||
private function createFolderWithinPluginIfNotExists($pluginNameOrCore, $folder)
|
||||
{
|
||||
if ($pluginNameOrCore === 'core') {
|
||||
$pluginPath = $this->getPathToCore();
|
||||
} else {
|
||||
$pluginPath = $this->getPluginPath($pluginNameOrCore);
|
||||
}
|
||||
|
||||
if (!file_exists($pluginPath . $folder)) {
|
||||
Filesystem::mkdir($pluginPath . $folder);
|
||||
}
|
||||
}
|
||||
|
||||
protected function createFileWithinPluginIfNotExists($pluginName, $fileName, $content)
|
||||
protected function createFileWithinPluginIfNotExists($pluginNameOrCore, $fileName, $content)
|
||||
{
|
||||
$pluginPath = $this->getPluginPath($pluginName);
|
||||
if ($pluginNameOrCore === 'core') {
|
||||
$pluginPath = $this->getPathToCore();
|
||||
} else {
|
||||
$pluginPath = $this->getPluginPath($pluginNameOrCore);
|
||||
}
|
||||
|
||||
if (!file_exists($pluginPath . $fileName)) {
|
||||
file_put_contents($pluginPath . $fileName, $content);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Creates a lang/en.json within the plugin in case it does not exist yet and adds a translation for the given
|
||||
* text.
|
||||
*
|
||||
* @param $pluginName
|
||||
* @param $translatedText
|
||||
* @return string Either the generated translation key or the original text if a different translation for this
|
||||
* generated translation key already exists.
|
||||
*/
|
||||
protected function makeTranslationIfPossible($pluginName, $translatedText)
|
||||
{
|
||||
$defaultLang = array($pluginName => array());
|
||||
|
||||
$this->createFolderWithinPluginIfNotExists($pluginName, '/lang');
|
||||
$this->createFileWithinPluginIfNotExists($pluginName, '/lang/en.json', $this->toJson($defaultLang));
|
||||
|
||||
$langJsonPath = $this->getPluginPath($pluginName) . '/lang/en.json';
|
||||
$translations = file_get_contents($langJsonPath);
|
||||
$translations = json_decode($translations, true);
|
||||
|
||||
if (empty($translations[$pluginName])) {
|
||||
$translations[$pluginName] = array();
|
||||
}
|
||||
|
||||
$key = $this->buildTranslationKey($translatedText);
|
||||
|
||||
if (array_key_exists($key, $translations[$pluginName])) {
|
||||
// we do not want to overwrite any existing translations
|
||||
if ($translations[$pluginName][$key] === $translatedText) {
|
||||
return $pluginName . '_' . $key;
|
||||
}
|
||||
|
||||
return $translatedText;
|
||||
}
|
||||
|
||||
$translations[$pluginName][$key] = $this->removeNonJsonCompatibleCharacters($translatedText);
|
||||
|
||||
file_put_contents($langJsonPath, $this->toJson($translations));
|
||||
|
||||
return $pluginName . '_' . $key;
|
||||
}
|
||||
|
||||
protected function checkAndUpdateRequiredPiwikVersion($pluginName, OutputInterface $output)
|
||||
{
|
||||
$pluginJsonPath = $this->getPluginPath($pluginName) . '/plugin.json';
|
||||
$relativePluginJson = $this->getRelativePluginPath($pluginName) . '/plugin.json';
|
||||
|
||||
if (!file_exists($pluginJsonPath) || !is_writable($pluginJsonPath)) {
|
||||
return;
|
||||
}
|
||||
|
||||
$pluginJson = file_get_contents($pluginJsonPath);
|
||||
$pluginJson = json_decode($pluginJson, true);
|
||||
|
||||
if (empty($pluginJson)) {
|
||||
return;
|
||||
}
|
||||
|
||||
if (empty($pluginJson['require'])) {
|
||||
$pluginJson['require'] = array();
|
||||
}
|
||||
|
||||
$piwikVersion = Version::VERSION;
|
||||
$newRequiredVersion = '>=' . $piwikVersion;
|
||||
|
||||
if (!empty($pluginJson['require']['piwik'])) {
|
||||
$requiredVersion = $pluginJson['require']['piwik'];
|
||||
|
||||
if ($requiredVersion === $newRequiredVersion) {
|
||||
return;
|
||||
}
|
||||
|
||||
$dependency = new Dependency();
|
||||
$missingVersion = $dependency->getMissingVersions($piwikVersion, $requiredVersion);
|
||||
|
||||
if (!empty($missingVersion)) {
|
||||
$msg = sprintf('We cannot generate this component as the plugin "%s" requires the Piwik version "%s" in the file "%s". Generating this component requires "%s". If you know your plugin is compatible with your Piwik version remove the required Piwik version in "%s" and try to execute this command again.', $pluginName, $requiredVersion, $relativePluginJson, $newRequiredVersion, $relativePluginJson);
|
||||
|
||||
throw new \Exception($msg);
|
||||
}
|
||||
|
||||
$output->writeln('');
|
||||
$output->writeln(sprintf('<comment>We have updated the required Piwik version from "%s" to "%s" in "%s".</comment>', $requiredVersion, $newRequiredVersion, $relativePluginJson));
|
||||
} else {
|
||||
$output->writeln('');
|
||||
$output->writeln(sprintf('<comment>We have updated your "%s" to require the Piwik version "%s".</comment>', $relativePluginJson, $newRequiredVersion));
|
||||
}
|
||||
|
||||
$pluginJson['require']['piwik'] = $newRequiredVersion;
|
||||
file_put_contents($pluginJsonPath, $this->toJson($pluginJson));
|
||||
}
|
||||
|
||||
private function toJson($value)
|
||||
{
|
||||
if (defined('JSON_PRETTY_PRINT')) {
|
||||
|
||||
return json_encode($value, JSON_PRETTY_PRINT);
|
||||
}
|
||||
|
||||
return json_encode($value);
|
||||
}
|
||||
|
||||
private function buildTranslationKey($translatedText)
|
||||
{
|
||||
$translatedText = preg_replace('/(\s+)/', '', $translatedText);
|
||||
$translatedText = preg_replace("/[^A-Za-z0-9]/", '', $translatedText);
|
||||
$translatedText = trim($translatedText);
|
||||
|
||||
return $this->removeNonJsonCompatibleCharacters($translatedText);
|
||||
}
|
||||
|
||||
private function removeNonJsonCompatibleCharacters($text)
|
||||
{
|
||||
return preg_replace('/[^(\x00-\x7F)]*/', '', $text);
|
||||
}
|
||||
|
||||
/**
|
||||
* Copies the given method and all needed use statements into an existing class. The target class name will be
|
||||
* built based on the given $replace argument.
|
||||
* @param string $sourceClassName
|
||||
* @param string $methodName
|
||||
* @param array $replace
|
||||
*/
|
||||
protected function copyTemplateMethodToExisitingClass($sourceClassName, $methodName, $replace)
|
||||
{
|
||||
$targetClassName = $this->replaceContent($replace, $sourceClassName);
|
||||
|
||||
if (Development::methodExists($targetClassName, $methodName)) {
|
||||
// we do not want to add the same method twice
|
||||
return;
|
||||
}
|
||||
|
||||
Development::checkMethodExists($sourceClassName, $methodName, 'Cannot copy template method: ');
|
||||
|
||||
$targetClass = new \ReflectionClass($targetClassName);
|
||||
$file = new \SplFileObject($targetClass->getFileName());
|
||||
|
||||
$methodCode = Development::getMethodSourceCode($sourceClassName, $methodName);
|
||||
$methodCode = $this->replaceContent($replace, $methodCode);
|
||||
$methodLine = $targetClass->getEndLine() - 1;
|
||||
|
||||
$sourceUses = Development::getUseStatements($sourceClassName);
|
||||
$targetUses = Development::getUseStatements($targetClassName);
|
||||
$usesToAdd = array_diff($sourceUses, $targetUses);
|
||||
if (empty($usesToAdd)) {
|
||||
$useCode = '';
|
||||
} else {
|
||||
$useCode = "\nuse " . implode("\nuse ", $usesToAdd) . "\n";
|
||||
}
|
||||
|
||||
// search for namespace line before the class starts
|
||||
$useLine = 0;
|
||||
foreach (new \LimitIterator($file, 0, $targetClass->getStartLine()) as $index => $line) {
|
||||
if (0 === strpos(trim($line), 'namespace ')) {
|
||||
$useLine = $index + 1;
|
||||
break;
|
||||
}
|
||||
}
|
||||
|
||||
$newClassCode = '';
|
||||
foreach(new \LimitIterator($file) as $index => $line) {
|
||||
if ($index == $methodLine) {
|
||||
$newClassCode .= $methodCode;
|
||||
}
|
||||
|
||||
if (0 !== $useLine && $index == $useLine) {
|
||||
$newClassCode .= $useCode;
|
||||
}
|
||||
|
||||
$newClassCode .= $line;
|
||||
}
|
||||
|
||||
file_put_contents($targetClass->getFileName(), $newClassCode);
|
||||
}
|
||||
|
||||
/**
|
||||
* @param string $templateFolder full path like /home/...
|
||||
* @param string $pluginName
|
||||
|
|
@ -67,16 +260,13 @@ abstract class GeneratePluginBase extends ConsoleCommand
|
|||
}
|
||||
|
||||
if (is_dir($file)) {
|
||||
$fileNamePlugin = $this->replaceContent($replace, $fileNamePlugin);
|
||||
$this->createFolderWithinPluginIfNotExists($pluginName, $fileNamePlugin);
|
||||
} else {
|
||||
$template = file_get_contents($file);
|
||||
foreach ($replace as $key => $value) {
|
||||
$template = str_replace($key, $value, $template);
|
||||
}
|
||||
$template = $this->replaceContent($replace, $template);
|
||||
|
||||
foreach ($replace as $key => $value) {
|
||||
$fileNamePlugin = str_replace($key, $value, $fileNamePlugin);
|
||||
}
|
||||
$fileNamePlugin = $this->replaceContent($replace, $fileNamePlugin);
|
||||
|
||||
$this->createFileWithinPluginIfNotExists($pluginName, $fileNamePlugin, $template);
|
||||
}
|
||||
|
|
@ -114,7 +304,7 @@ abstract class GeneratePluginBase extends ConsoleCommand
|
|||
* @param InputInterface $input
|
||||
* @param OutputInterface $output
|
||||
* @return array
|
||||
* @throws \RunTimeException
|
||||
* @throws \RuntimeException
|
||||
*/
|
||||
protected function askPluginNameAndValidate(InputInterface $input, OutputInterface $output, $pluginNames, $invalidArgumentException)
|
||||
{
|
||||
|
|
@ -135,9 +325,22 @@ abstract class GeneratePluginBase extends ConsoleCommand
|
|||
$validate($pluginName);
|
||||
}
|
||||
|
||||
$pluginName = ucfirst($pluginName);
|
||||
|
||||
return $pluginName;
|
||||
}
|
||||
|
||||
private function getPathToCore()
|
||||
{
|
||||
$path = PIWIK_INCLUDE_PATH . '/core';
|
||||
return $path;
|
||||
}
|
||||
|
||||
private function replaceContent($replace, $contentToReplace)
|
||||
{
|
||||
foreach ((array) $replace as $key => $value) {
|
||||
$contentToReplace = str_replace($key, $value, $contentToReplace);
|
||||
}
|
||||
|
||||
return $contentToReplace;
|
||||
}
|
||||
|
||||
}
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue