LocaliseModelPackage - Code Metrics - joomla-projects/com_localise - Measure and Improve Code Quality continuously with Scrutinizer

LocaliseModelPackage F
last analyzed 2018-10-24 04:42 UTC

↳ Parent: Project
Complexity

Total Complexity
131
Size/Duplication

Total Lines	1184
Duplicated Lines	35.14 %
Coupling/Cohesion

Components	1
Dependencies	1
Importance

Changes
Metric	Value
dl	416
loc	1184
rs	0.864
c	0
b	0
f	0
wmc	131
lcom	1
cbo	1
10 Methods

Rating	Name	Duplication	Size	Complexity
A	populateState()	0	12	1
A	getTable()	0	4	1
A	getForm()	24	24	3
A	loadFormData()	16	16	2
A	getFormFtp()	20	20	3
C	getItem()	36	128	13
F	save()	110	300	29
F	download()	210	488	66
A	uploadFile()	0	36	3
C	uploadOtherFile()	0	65	10
How to fix Duplicated Code Complexity

Duplicated Code

Duplicate code is one of the most pungent code smells. A rule that is often used is to re-structure code once it is duplicated in three or more places.
Common duplication problems, and corresponding solutions are:
If you have the same expression in different places: Extract expression to a method
If you have the same method in different sub-classes: Extract method, and pull up field to the parent class
If you have the same code in unrelated classes: Consider extracting the code to a new class, and injecting that class
Complex Class

Tip: Before tackling complexity, make sure that you eliminate any duplication first. This often can reduce the size of classes significantly.
Complex classes like LocaliseModelPackage often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes. You can also have a look at the cohesion graph to spot any un-connected, or weakly-connected components.
Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.
While breaking up the class, it is a good idea to analyze how other classes use LocaliseModelPackage, and based on these observations, apply Extract Interface, too.
<?php
/**
 * @package     Com_Localise
 * @subpackage  model
 *
 * @copyright   Copyright (C) 2005 - 2015 Open Source Matters, Inc. All rights reserved.
 * @license     GNU General Public License version 2 or later; see LICENSE.txt
 */

defined('_JEXEC') or die;

jimport('joomla.filesystem.folder');
jimport('joomla.filesystem.file');
jimport('joomla.client.helper');

/**
 * Package Model class for the Localise component
 *
 * @package     Extensions.Components
 * @subpackage  Localise
 *
 * @since       1.0
 */
class LocaliseModelPackage extends JModelAdmin
{
	/**
	 * Method to auto-populate the model state.
	 *
	 * Note. Calling getState in this method will result in recursion.
	 *
	 * @param   string  $ordering   An optional ordering field.
	 * @param   string  $direction  An optional direction (asc|desc).
	 *
	 * @return  void
	 *
	 * @since   1.6
	 */
	protected function populateState($ordering = null, $direction = null)
	{
		// Get the application
		$app = JFactory::getApplication('administrator');

		// Load the User state.
		$name = $app->getUserState('com_localise.package.name');
		$this->setState('package.name', $name);

		$id = $app->getUserState('com_localise.edit.package.id');
		$this->setState('package.id', $id);
	}

	/**
	 * Returns a Table object, always creating it.
	 *
	 * @param   string  $type    The table type to instantiate
	 * @param   string  $prefix  A prefix for the table class name. Optional.
	 * @param   array   $config  Configuration array for model. Optional.
	 *
	 * @return  JTable  A database object
	 */
	public function getTable($type = 'Localise', $prefix = 'LocaliseTable', $config = array())
	{
		return JTable::getInstance($type, $prefix, $config);
	}

	/**
	 * Method to get the record form.
	 *
	 * @param   array    $data      Data for the form.
	 * @param   boolean  $loadData  True if the form is to load its own data (default case), false if not.
	 *
	 * @return  mixed  A JForm object on success, false on failure
	 */
	public function getForm($data = array(), $loadData = true)

	{
		// Get the form.
		$id   = $this->getState('package.id');
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}
		$name = $this->getState('package.name');
		$form = $this->loadForm('com_localise.package', 'package', array('control' => 'jform', 'load_data' => $loadData));

		if (empty($form))
		{
			return false;
		}

		$form->setFieldAttribute('translations', 'package', $name, 'translations');

		// Check for an error.
		if (JError::isError($form))
		{
			$this->setError($form->getMessage());

			return false;
		}

		return $form;
	}

	/**
	 * Method to get the data that should be injected in the form.
	 *
	 * @return   mixed  The data for the form.
	 */
	protected function loadFormData()

	{
		// Initialise variables.
		$app = JFactory::getApplication();

		// Check the session for previously entered form data.
		$data = $app->getUserState('com_localise.edit.package.data', array());

		// Get the package data.
		if (empty($data))
		{
			$data = $this->getItem();
		}

		return $data;
	}

	/**
	 * Method to get the ftp form.
	 *
	 * @return  mixed  A JForm object on success, false on failure or not ftp
	 */
	public function getFormFtp()

	{
		// Get the form.
		$form = $this->loadForm('com_localise.ftp', 'ftp');

		if (empty($form))
		{
			return false;
		}

		// Check for an error.
		if (JError::isError($form))
		{
			$this->setError($form->getMessage());

			return false;
		}

		return $form;
	}

	/**
	 * Method to get the package.
	 *
	 * @param   integer  $pk  The ID of the primary key.
	 *
	 * @return JObject the package
	 */
	public function getItem($pk = null)
	{
		$id = $this->getState('package.id');
		$id = is_array($id) ? (count($id) > 0 ? $id[0] : 0) : $id;
		$package = new JObject;
		$package->checked_out = 0;
		$package->standalone  = true;
		$package->manifest    = null;
		$package->title       = null;
		$package->description = null;
		$package->id          = $id;

		if (!empty($id))
		{
			// If the package exists get it
			$table = $this->getTable();

			if (is_array($id))
			{
				$id = $id[0];
			}

			$table->load($id);
			$package->setProperties($table->getProperties());

			// Get the manifest
			$xml = simplexml_load_file($table->path);

			if ($xml)
			{
				$manifest = (string) $xml->manifest;

				// $client   = (string) $xml->manifest->attributes()->client;
				// LocaliseHelper::loadLanguage($manifest, $client);

				// Set up basic information
				$name = basename($table->path);
				$name = substr($name, 0, strlen($name) - 4);

				$package->id          = $id;
				$package->name        = $name;
				$package->manifest    = $manifest;

				// $package->client      = $client;
				// $package->standalone  = substr($manifest, 0, 4) == 'fil_';

				$package->core           = ((string) $xml->attributes()->core) == 'true';
				$package->title          = (string) $xml->title;
				$package->version        = (string) $xml->version;
				$package->packversion    = (string) $xml->packversion;
				$package->description    = (string) $xml->description;
				$package->language       = (string) $xml->language;
				$package->blockuninstall = (string) $xml->blockuninstall;
				$package->license        = (string) $xml->license;
				$package->copyright      = (string) $xml->copyright;
				$package->author         = (string) $xml->author;
				$package->authoremail    = (string) $xml->authoremail;
				$package->authorurl      = (string) $xml->authorurl;
				$package->url            = (string) $xml->url;
				$package->packager       = (string) $xml->packager;
				$package->packagerurl    = (string) $xml->packagerurl;
				$package->servername     = (string) $xml->servername;
				$package->serverurl      = (string) $xml->serverurl;
				$package->writable       = LocaliseHelper::isWritable($package->path);

				$user = JFactory::getUser($table->checked_out);
				$package->setProperties($table->getProperties());

				if ($package->checked_out == JFactory::getUser()->id)
				{
					$package->checked_out = 0;
				}

				$package->editor = JText::sprintf('COM_LOCALISE_TEXT_PACKAGE_EDITOR', $user->name, $user->username);

				// Get the translations
				$package->translations  = array();
				$package->administrator = array();

				if ($xml->administrator)

				{
					foreach ($xml->administrator->children() as $file)
					{
						$data = (string) $file;

						if ($data)
						{
							$package->translations[] = "administrator_$data";
						}
						else
						{
							$package->translations[] = "administrator_joomla";
						}

						$package->administrator[] = $data;
					}
				}

				$package->site = array();

				if ($xml->site)

				{
					foreach ($xml->site->children() as $file)
					{
						$data = (string) $file;

						if ($data)
						{
							$package->translations[] = "site_$data";
						}
						else
						{
							$package->translations[] = "site_joomla";
						}

						$package->site[] = $data;
					}
				}
			}
			else
			{
				$package = null;
				$this->setError(JText::sprintf('COM_LOCALISE_ERROR_PACKAGE_FILEEDIT'), $table->path);
			}
		}

		return $package;
	}

	/**
	 * Method to save data
	 *
	 * @param   array  $data  the data to save
	 *
	 * @return  boolean  success or failure
	 */
	public function save($data)
	{
		// When editing a package, find the original path
		$app = JFactory::getApplication('administrator');
		$originalId = $app->getUserState('com_localise.edit.package.id');
		$oldpath = null;

		$originalId = is_array($originalId) && count($originalId) > 0 ?
						$originalId[0] : $originalId;

		if (!empty($originalId))

		{
			$db = JFactory::getDbo();
			$query = $db->getQuery(true)
				->select($db->quoteName('path'))
				->from($db->quoteName('#__localise'))
				->where($db->quoteName('id') . ' = ' . $originalId);
			$db->setQuery($query);

			$oldpath = $db->loadResult('path');
		}

		// Get the package name
		$name = $data['name'];

		// Get the package
		$package  = $this->getItem();
		$path     = JPATH_COMPONENT_ADMINISTRATOR . "/packages/$name.xml";
		$manifest = $name;

		// $client   = $package->client ? $package->client : 'site';

		if ($package->standalone)
		{
			$title = $name;
			$description = $data['description'];

			$dom = new DOMDocument('1.0', 'utf-8');

			// Create simple XML element and base package tag
			$packageXml = $dom->createElement('package');

			// Add main package information
			$titleElement = $dom->createElement('title', $title);
			$descriptionElement = $dom->createElement('description', $description);
			$manifestElement = $dom->createElement('manifest', $manifest);
			$versionElement = $dom->createElement('version', $data['version']);
			$packversionElement = $dom->createElement('packversion', $data['packversion']);
			$blockUninstallElement = $dom->createElement('blockuninstall', $data['blockuninstall']);
			$authorElement = $dom->createElement('author', $data['author']);
			$licenseElement = $dom->createElement('license', $data['license']);
			$authorEmailElement = $dom->createElement('authoremail', $data['authoremail']);
			$authorUrlElement = $dom->createElement('authorurl', $data['authorurl']);
			$languageElement = $dom->createElement('language', $data['language']);
			$copyrightElement = $dom->createElement('copyright', $data['copyright']);
			$urlElement = $dom->createElement('url', $data['url']);
			$packagerElement = $dom->createElement('packager', $data['packager']);
			$packagerUrlElement = $dom->createElement('packagerurl', $data['packagerurl']);
			$servernameElement = $dom->createElement('servername', $data['servername']);
			$serverurlElement = $dom->createElement('serverurl', $data['serverurl']);

			// Set the client attribute on the manifest element

			// $clientAttribute = $dom->createAttribute('client');

			// $clientAttribute->value = $client;
			// $manifestElement->appendChild($clientAttribute);

			// Set the core attribute as we only make packages for Core
			$coreAttribute = $dom->createAttribute('core');
			$coreAttribute->value = "true";
			$packageXml->appendChild($coreAttribute);

			// Add all the elements to the parent <package> tag
			$packageXml->appendChild($titleElement);
			$packageXml->appendChild($descriptionElement);
			$packageXml->appendChild($manifestElement);
			$packageXml->appendChild($versionElement);
			$packageXml->appendChild($packversionElement);
			$packageXml->appendChild($blockUninstallElement);
			$packageXml->appendChild($authorElement);
			$packageXml->appendChild($copyrightElement);
			$packageXml->appendChild($licenseElement);
			$packageXml->appendChild($authorEmailElement);
			$packageXml->appendChild($authorUrlElement);
			$packageXml->appendChild($languageElement);
			$packageXml->appendChild($copyrightElement);
			$packageXml->appendChild($urlElement);
			$packageXml->appendChild($packagerElement);
			$packageXml->appendChild($packagerUrlElement);
			$packageXml->appendChild($servernameElement);
			$packageXml->appendChild($serverurlElement);

			$administrator = array();
			$site          = array();

			foreach ($data['translations'] as $translation)

			{
				if (preg_match('/^site_(.*)$/', $translation, $matches))
				{
					$site[] = $matches[1];
				}

				if (preg_match('/^administrator_(.*)$/', $translation, $matches))
				{
					$administrator[] = $matches[1];
				}
			}

			// Add the site language files
			if (count($site))

			{
				$siteXml = $dom->createElement('site');

				foreach ($site as $translation)
				{
					$fileElement = $dom->createElement('filename', $translation . '.ini');
					$siteXml->appendChild($fileElement);
				}

				$packageXml->appendChild($siteXml);
			}

			// Add the administrator language files
			if (count($administrator))

			{
				$adminXml = $dom->createElement('administrator');

				foreach ($administrator as $translation)
				{
					$fileElement = $dom->createElement('filename', $translation . '.ini');
					$adminXml->appendChild($fileElement);
				}

				$packageXml->appendChild($adminXml);
			}

			$dom->appendChild($packageXml);

			// Set FTP credentials, if given.
			JClientHelper::setCredentialsFromRequest('ftp');
			$ftp = JClientHelper::getCredentials('ftp');

			// Try to make the file writeable.
			if (JFile::exists($path) && !$ftp['enabled'] && JPath::isOwner($path) && !JPath::setPermissions($path, '0644'))

			{
				$this->setError(JText::sprintf('COM_LOCALISE_ERROR_PACKAGE_WRITABLE', $path));

				return false;
			}

			// Make the XML look pretty
			$dom->formatOutput = true;
			$formattedXML = $dom->saveXML();

			$return = JFile::write($path, $formattedXML);

			// Try to make the file unwriteable.
			if (!$ftp['enabled'] && JPath::isOwner($path) && !JPath::setPermissions($path, '0444'))

			{
				$this->setError(JText::sprintf('COM_LOCALISE_ERROR_PACKAGE_UNWRITABLE', $path));

				return false;
			}
			elseif (!$return)
			{
				$this->setError(JText::sprintf('COM_LOCALISE_ERROR_PACKAGE_FILESAVE', $path));

				return false;
			}
		}

		// Save the title and the description in the language file

		/* @TODO Check ftp part
		$translation_path  = LocaliseHelper::findTranslationPath($client, JFactory::getLanguage()->getTag(), $manifest);
		$translation_id    = LocaliseHelper::getFileId($translation_path);
		$translation_model = JModelLegacy::getInstance('Translation', 'LocaliseModel', array('ignore_request' => true));

		if ($translation_model->checkout($translation_id))
		{
			$translation_model->setState('translation.path', $translation_path);
			$translation_model->setState('translation.client', $client);
			$translation = $translation_model->getItem();
			$sections    = LocaliseHelper::parseSections($translation_path);
		}
		else
		{
		}

		$text = '';
		$text .= strtoupper($title) . '="' . str_replace('"', '"_QQ_"', $data['title']) . "\"\n";
		$text .= strtoupper($description) . '="' . str_replace('"', '"_QQ_"', $data['description']) . "\"\n";
		$tag  = JFactory::getLanguage()->getTag();
		$languagePath = JPATH_SITE . "/language/$tag/$tag.$manifest.ini";
		 */

		// Try to make the file writeable.

		/*
		if (!$ftp['enabled'] && JPath::isOwner($languagePath) && !JPath::setPermissions($languagePath, '0644'))
		{
			$this->setError(JText::sprintf('COM_LOCALISE_ERROR_PACKAGE_WRITABLE', $languagePath));

			return false;
		}

		$return = JFile::write($languagePath, $text);
		*/

		// Try to make the file unwriteable.

		/*
		if (!$ftp['enabled'] && JPath::isOwner($languagePath) && !JPath::setPermissions($languagePath, '0444'))
		{
			$this->setError(JText::sprintf('COM_LOCALISE_ERROR_PACKAGE_UNWRITABLE', $languagePath));

			return false;
		}
		elseif (!$return)
		{
			$this->setError(JText::sprintf('COM_LOCALISE_ERROR_PACKAGE_FILESAVE', $languagePath));

			return false;
		}
		*/
		if ($path == $oldpath)

		{
			$id = LocaliseHelper::getFileId($path);
			$this->setState('package.id', $id);

			// Bind the rules.
			$table = $this->getTable();
			$table->load($id);
		}
		else
		{
			$table = $this->getTable();

			if (!$table->delete((int) $originalId))
			{
				$this->setError($table->getError());

				return false;
			}

			$table->store();

			$id = LocaliseHelper::getFileId($path);
			$this->setState('package.id', $id);
			$app->setUserState('com_localise.edit.package.id', $id);
		}

		if (isset($data['rules']))
		{
			$rules = new JAccessRules($data['rules']);
			$table->setRules($rules);
		}

		// Check the data.
		if (!$table->check())
		{
			$this->setError($table->getError());

			return false;
		}

		// Store the data.
		if (!$table->store())
		{
			$this->setError($table->getError());

			return false;
		}

		// Delete the older file and redirect
		if ($path !== $oldpath && file_exists($oldpath))

		{
			if (!JFile::delete($oldpath))
			{
				$app->enqueueMessage(JText::_('COM_LOCALISE_ERROR_OLDFILE_REMOVE'), 'notice');
			}

			$task = JFactory::getApplication()->input->get('task');

			if ($task == 'save')
			{
				$app->redirect(JRoute::_('index.php?option=com_localise&view=packages', false));
			}
			else
			{
				// Redirect to the new $id as name has changed
				$app->redirect(JRoute::_('index.php?option=com_localise&view=package&layout=edit&id=' . $this->getState('package.id'), false));
			}
		}

		$this->cleanCache();

		return true;
	}

	/**
	 * Method to generate and download a package
	 *
	 * @param   array  $data  the data to generate the package
	 *
	 * @return  boolean  success or failure
	 */
	public function download($data)
	{
		// The data could potentially be loaded from the file with $this->getItem() instead of using directly the data from the post
		$app = JFactory::getApplication();

		// Prevent generating and downloading Master package
		if (strpos($data['name'], 'master_') !== false)

		{
			$app->enqueueMessage(JText::sprintf('COM_LOCALISE_ERROR_MASTER_PACKAGE_DOWNLOAD_FORBIDDEN', $data['name']), 'warning');
			$app->redirect(JRoute::_('index.php?option=com_localise&view=package&layout=edit&id=' . $this->getState('package.id'), false));

			return false;
		}

		// Necessary variables if xx-XX.localise.php is not present in target language
		$params			= JComponentHelper::getParams('com_localise');
		$reftag			= $params->get('reference');
		$refclassname	= str_replace('-', '_', $reftag);
		$refclassname	= ucfirst($refclassname);
		$langclassname	= str_replace('-', '_', $data['language']);
		$langclassname	= ucfirst($langclassname);
		$msg = null;

		$administrator = array();
		$site          = array();
		$main_package_files = array();

		// Delete old files
		$delete = JFolder::files(JPATH_ROOT . '/tmp/', 'com_localise_', false, true);

		if (!empty($delete))

		{
			if (!JFile::delete($delete))
			{
				// JFile::delete throws an error
				$this->setError(JText::_('COM_LOCALISE_ERROR_EXPORT_ZIPDELETE'));

				return false;
			}
		}

		foreach ($data['translations'] as $translation)

		{
			if (preg_match('/^site_(.*)$/', $translation, $matches))
			{
				$site[] = $matches[1];
			}

			if (preg_match('/^administrator_(.*)$/', $translation, $matches))
			{
				$administrator[] = $matches[1];
			}
		}

		$parts = explode('.', $data['version']);
		$small_version = implode('.', array($parts[0],$parts[1]));

		// Prepare text to save for the xml package description
		$text = '';
		$text .= '<?xml version="1.0" encoding="UTF-8"?>' . "\n";
		$text .= '<extension type="package" version="' . $small_version . '" method="upgrade">' . "\n";
		$text .= "\t" . '<name>' . $data['name'] . '</name>' . "\n";
		$text .= "\t" . '<packagename>' . $data['language'] . '</packagename>' . "\n";
		$text .= "\t" . '<version>' . $data['version'] . '.' . $data['packversion'] . '</version>' . "\n";
		$text .= "\t" . '<creationDate>' . date('d/m/Y') . '</creationDate>' . "\n";
		$text .= "\t" . '<author>' . $data['author'] . '</author>' . "\n";
		$text .= "\t" . '<authorEmail>' . $data['authoremail'] . '</authorEmail>' . "\n";
		$text .= "\t" . '<authorUrl>' . $data['authorurl'] . '</authorUrl>' . "\n";
		$text .= "\t" . '<copyright>' . $data['copyright'] . '</copyright>' . "\n";
		$text .= "\t" . '<license>' . $data['license'] . '</license>' . "\n";
		$text .= "\t" . '<url>' . $data['url'] . '</url>' . "\n";
		$text .= "\t" . '<packager>' . $data['packager'] . '</packager>' . "\n";
		$text .= "\t" . '<packagerurl>' . $data['packagerurl'] . '</packagerurl>' . "\n";
		$text .= "\t" . '<description><![CDATA[' . $data['description'] . ']]></description>' . "\n";
		$text .= "\t" . '<blockChildUninstall>' . $data['blockuninstall'] . '</blockChildUninstall>' . "\n";
		$text .= "\t" . '<files>' . "\n";

		if (count($site))
		{
			$text .= "\t\t" . '<file type="language" client="site" id="' . $data['language'] . '">site_' . $data['language'] . '.zip</file>' . "\n";

			$path = JPATH_ROOT . '/language/' . $data['language'] . '/' . $data['language'] . '.xml';

			if (JFile::exists($path))
			{
				$xmldata = file_get_contents($path);

				// Fetch the language name for the install.xml
				if (!empty($xmldata))
				{
					$xml         = simplexml_load_file($path);
					$installName = (string) $xml->name;
				}
			}

			if (!JFile::exists($path) || empty($xmldata))

			{
				$app->enqueueMessage(JText::sprintf('COM_LOCALISE_ERROR_NO_XML', JText::_('JSITE'), $data['language'] . '.xml', 'error'));
				$app->redirect(JRoute::_('index.php?option=com_localise&view=package&layout=edit&id=' . $this->getState('package.id'), false));

				return false;
			}

			// Generate site package
			$site_package_files = array();

			$site_txt = '<?xml version="1.0" encoding="UTF-8"?>' . "\n";
			$site_txt .= '<extension version="' . $small_version . '" client="site" type="language" method="upgrade">' . "\n";
			$site_txt .= "\t" . '<name>' . $installName . '</name>' . "\n";
function myFunction($a) {
    switch ($a) {
        case 'foo':
            $x = 1;
            break;

        case 'bar':
            $x = 2;
            break;
    }

    // $x is potentially undefined here.
    echo $x;
}
			$site_txt .= "\t" . '<tag>' . $data['language'] . '</tag>' . "\n";
			$site_txt .= "\t" . '<version>' . $data['version'] . '.' . $data['packversion'] . '</version>' . "\n";
			$site_txt .= "\t" . '<creationDate>' . date('d/m/Y') . '</creationDate>' . "\n";
			$site_txt .= "\t" . '<author>' . $data['author'] . '</author>' . "\n";
			$site_txt .= "\t" . '<authorEmail>' . $data['authoremail'] . '</authorEmail>' . "\n";
			$site_txt .= "\t" . '<authorUrl>' . $data['authorurl'] . '</authorUrl>' . "\n";
			$site_txt .= "\t" . '<copyright>' . $data['copyright'] . '</copyright>' . "\n";
			$site_txt .= "\t" . '<license>' . $data['license'] . '</license>' . "\n";
			$site_txt .= "\t" . '<description>' . $data['language'] . ' - Site language</description>' . "\n";
			$site_txt .= "\t" . '<files>' . "\n";

			// As this is a core package, the main joomla file xx-XX.ini should be in the package
			$path = JPATH_ROOT . '/language/' . $data['language'] . '/' . $data['language'] . '.ini';

			if (JFile::exists($path))
			{
				$file_data = file_get_contents($path);
			}

			if (JFile::exists($path) && !empty($file_data))

			{
				$site = array_diff($site, array("joomla"));
				$site_txt .= "\t\t" . '<filename>' . $data['language'] . '.ini</filename>' . "\n";
				$site_package_files[] = array('name' => $data['language'] . '.ini','data' => $file_data);
			}
			else
			{
				$msg .= JText::sprintf('COM_LOCALISE_MAINFILE_NOT_TRANSLATED', $data['language'] . '.ini', JText::_('JSITE'));
			}

			foreach ($site as $translation)

			{
				$path = JPATH_ROOT . '/language/' . $data['language'] . '/' . $data['language'] . '.' . $translation . '.ini';

				if (JFile::exists($path))
				{
					$file_data = file_get_contents($path);
				}

				if (JFile::exists($path) && !empty($file_data))
				{
					$site_txt .= "\t\t" . '<filename>' . $data['language'] . '.' . $translation . '.ini</filename>' . "\n";
					$site_package_files[] = array('name' => $data['language'] . '.' . $translation . '.ini', 'data' => $file_data);
				}
				elseif ($translation != 'joomla')
				{
					$msg .= JText::sprintf('COM_LOCALISE_FILE_NOT_TRANSLATED', $data['language'] . '.' . $translation . '.ini', JText::_('JSITE'));
				}
			}

			$path = JPATH_ROOT . '/language/' . $data['language'] . '/' . $data['language'] . '.localise.php';

			if (JFile::exists($path))

			{
				$language_data = file_get_contents($path);
			}

			// Create a basic xx-XX.localise.php if not present in target language
			elseif (!JFile::exists($path) || empty($languagedata))

			{
				$language_data = file_get_contents(JPATH_ROOT . '/language/' . $reftag . '/' . $reftag . '.localise.php');
				$language_data = str_replace($reftag, $data['language'], $language_data);
				$language_data = str_replace($refclassname, $langclassname, $language_data);
			}

			$site_txt .= "\t\t" . '<filename>' . $data['language'] . '.localise.php</filename>' . "\n";
			$site_package_files[] = array('name' => $data['language'] . '.localise.php','data' => $language_data);
function myFunction($a) {
    switch ($a) {
        case 'foo':
            $x = 1;
            break;

        case 'bar':
            $x = 2;
            break;
    }

    // $x is potentially undefined here.
    echo $x;
}

			if ($msg)
''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
			{
				$msg .= '<p>...</p>';
			}

			$site_txt .= "\t\t" . '<filename file="meta">install.xml</filename>' . "\n";
			$site_txt .= "\t\t" . '<filename file="meta">' . $data['language'] . '.xml</filename>' . "\n";
			$site_txt .= "\t\t" . '<filename>index.html</filename>' . "\n";
			$site_txt .= "\t" . '</files>' . "\n";

			// Check if language has a custom calendar. The folder xx-XX should be present in the media folder
			if (JFolder::exists(JPATH_ROOT . '/media/' . $data['language']))
			{
				$site_txt .= "\n";
				$site_txt .= "\t" . '<media destination="' . $data['language'] . '">' . "\n";
				$site_txt .= "\t\t" . '<filename>index.html</filename>' . "\n";
				$path = JPATH_ROOT . '/media/' . $data['language'] . '/js/calendar-setup.js';

				if (JFile::exists($path))
				{
					$file_data = file_get_contents($path);
				}

				if (JFile::exists($path) && !empty($file_data))

				{
					$site_package_files[] = array('name' => 'js/calendar-setup.js','data' => $file_data);
					$site_txt .= "\t\t" . '<filename>js/calendar-setup.js</filename>' . "\n";
				}

				$path = JPATH_ROOT . '/media/' . $data['language'] . '/js/calendar-setup-uncompressed.js';

				if (JFile::exists($path))
				{
					$file_data = file_get_contents($path);
				}

				if (JFile::exists($path) && !empty($file_data))

				{
					$site_package_files[] = array('name' => 'js/calendar-setup-uncompressed.js','data' => $file_data);
					$site_txt .= "\t\t" . '<filename>js/calendar-setup-uncompressed</filename>' . "\n";
				}

				$path = JPATH_ROOT . '/media/' . $data['language'] . '/js/index.html';

				if (JFile::exists($path))
				{
					$file_data = file_get_contents($path);
				}

				if (JFile::exists($path) && !empty($file_data))

				{
					$site_package_files[] = array('name' => 'js/index.html','data' => $file_data);
					$site_txt .= "\t\t" . '<filename>js/index.html</filename>' . "\n";
				}

				$path = JPATH_ROOT . '/media/' . $data['language'] . '/js/calendar.js';

				if (JFile::exists($path))
				{
					$file_data = file_get_contents($path);
				}

				if (JFile::exists($path) && !empty($file_data))

				{
					$site_package_files[] = array('name' => 'js/calendar.js','data' => $file_data);
					$site_txt .= "\t\t" . '<filename>js/calendar.js</filename>' . "\n";
				}

				$path = JPATH_ROOT . '/media/' . $data['language'] . '/js/calendar-uncompressed.js';

				if (JFile::exists($path))
				{
					$file_data = file_get_contents($path);
				}

				if (JFile::exists($path) && !empty($file_data))

				{
					$site_package_files[] = array('name' => 'js/calendar-uncompressed.js','data' => $file_data);
					$site_txt .= "\t\t" . '<filename>js/calendar-uncompressed.js</filename>' . "\n";
				}

				$site_txt .= "\t" . '</media>' . "\n";
			}

			$site_txt .= "\t" . '<params />' . "\n";
			$site_txt .= '</extension>' . "\n";
			$site_package_files[] = array('name' => 'install.xml','data' => $site_txt);
			$language_data = file_get_contents(JPATH_ROOT . '/language/' . $data['language'] . '/' . $data['language'] . '.xml');
			$site_package_files[] = array('name' => $data['language'] . '.xml','data' => $language_data);

			$language_data = file_get_contents(JPATH_ROOT . '/administrator/components/com_localise/models/index.html');
			$site_package_files[] = array('name' => 'index.html','data' => $language_data);

			$site_zip_path = JPATH_ROOT . '/tmp/' . uniqid('com_localise_') . '.zip';

			if (!$packager = JArchive::getAdapter('zip'))

			{
				$this->setError(JText::_('COM_LOCALISE_ERROR_EXPORT_ADAPTER'));

				return false;
			}
			else
			{
				if (!$packager->create($site_zip_path, $site_package_files))
				{
					$this->setError(JText::_('COM_LOCALISE_ERROR_EXPORT_ZIPCREATE'));

					return false;
				}
			}

			$main_package_files[] = array('name' => 'site_' . $data['language'] . '.zip','data' => file_get_contents($site_zip_path));
		}

		if (count($administrator))
		{
			$text .= "\t\t" . '<file type="language" client="administrator" id="' . $data['language'] . '">admin_' . $data['language'] . '.zip</file>' . "\n";

			$path = JPATH_ROOT . '/administrator/language/' . $data['language'] . '/' . $data['language'] . '.xml';

			if (JFile::exists($path))
			{
				$xmldata = file_get_contents($path);
			}

			if (!JFile::exists($path) || empty($xmldata))

			{
				$app->enqueueMessage(JText::sprintf('COM_LOCALISE_ERROR_NO_XML', JText::_('JADMINISTRATOR'), $data['language'] . '.xml', 'error'));
				$app->redirect(JRoute::_('index.php?option=com_localise&view=package&layout=edit&id=' . $this->getState('package.id'), false));

				return false;
			}

			// Generate administrator package
			$admin_package_files = array();

			$admin_txt = '<?xml version="1.0" encoding="UTF-8"?>' . "\n";
			$admin_txt .= '<extension version="' . $small_version . '" client="administrator" type="language" method="upgrade">' . "\n";
			$admin_txt .= "\t" . '<name>' . $installName . '</name>' . "\n";
			$admin_txt .= "\t" . '<tag>' . $data['language'] . '</tag>' . "\n";
			$admin_txt .= "\t" . '<version>' . $data['version'] . '.' . $data['packversion'] . '</version>' . "\n";
			$admin_txt .= "\t" . '<creationDate>' . date('d/m/Y') . '</creationDate>' . "\n";
			$admin_txt .= "\t" . '<author>' . $data['author'] . '</author>' . "\n";
			$admin_txt .= "\t" . '<authorEmail>' . $data['authoremail'] . '</authorEmail>' . "\n";
			$admin_txt .= "\t" . '<authorUrl>' . $data['authorurl'] . '</authorUrl>' . "\n";
			$admin_txt .= "\t" . '<copyright>' . $data['copyright'] . '</copyright>' . "\n";
			$admin_txt .= "\t" . '<license>' . $data['license'] . '</license>' . "\n";
			$admin_txt .= "\t" . '<description>' . $data['language'] . ' - Administration language</description>' . "\n";
			$admin_txt .= "\t" . '<files>' . "\n";

			// As this is a core package, the main joomla file xx-XX.ini should be in the package
			$path = JPATH_ROOT . '/administrator/language/' . $data['language'] . '/' . $data['language'] . '.ini';

			if (JFile::exists($path))
			{
				$file_data = file_get_contents($path);
			}

			if (JFile::exists($path) && !empty($file_data))

			{
				$administrator = array_diff($administrator, array("joomla"));
				$admin_txt .= "\t\t" . '<filename>' . $data['language'] . '.ini</filename>' . "\n";
				$admin_package_files[] = array('name' => $data['language'] . '.ini','data' => $file_data);
			}
			else
			{
				$msg .= JText::sprintf('COM_LOCALISE_MAINFILE_NOT_TRANSLATED', $data['language'] . '.ini', JText::_('JADMINISTRATOR'));
			}

			foreach ($administrator as $translation)

			{
				$path = JPATH_ROOT . '/administrator/language/' . $data['language'] . '/' . $data['language'] . '.' . $translation . '.ini';

				if (JFile::exists($path))
				{
					$file_data = file_get_contents($path);
				}

				if (JFile::exists($path) && !empty($file_data))
				{
					$admin_txt .= "\t\t" . '<filename>' . $data['language'] . '.' . $translation . '.ini</filename>' . "\n";
					$admin_package_files[] = array('name' => $data['language'] . '.' . $translation . '.ini','data' => $file_data);
				}
				elseif ($translation != 'joomla')
				{
					$msg .= JText::sprintf('COM_LOCALISE_FILE_NOT_TRANSLATED', $data['language'] . '.' . $translation . '.ini', JText::_('JADMINISTRATOR'));
				}
			}

			$path = JPATH_ROOT . '/administrator/language/' . $data['language'] . '/' . $data['language'] . '.localise.php';

			if (JFile::exists($path))

			{
				$language_data = file_get_contents($path);
			}

			// Create a basic xx-XX.localise.php if not present in target language
			elseif (!JFile::exists($path) || empty($languagedata))
			{
				$language_data = file_get_contents(JPATH_ROOT . '/administrator/language/' . $reftag . '/' . $reftag . '.localise.php');
				$language_data = str_replace($reftag, $data['language'], $language_data);
				$language_data = str_replace($refclassname, $langclassname, $language_data);
			}

			$admin_txt .= "\t\t" . '<filename>' . $data['language'] . '.localise.php</filename>' . "\n";
			$admin_package_files[] = array('name' => $data['language'] . '.localise.php','data' => $language_data);

			// Add the css file if present
			$path = JPATH_ROOT . '/administrator/language/' . $data['language'] . '/' . $data['language'] . '.css';

			if (JFile::exists($path))
			{
				$css_data = file_get_contents($path);
			}

			if (JFile::exists($path) && !empty($css_data))
			{
				$admin_txt .= "\t\t" . '<filename>' . $data['language'] . '.css</filename>' . "\n";
				$admin_package_files[] = array('name' => $data['language'] . '.css','data' => $css_data);
			}

			if ($msg)
''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
			{
				$msg .= '<p>...</p>';
				$msg .= JText::_('COM_LOCALISE_UNTRANSLATED');
				$app->enqueueMessage($msg, 'error');
				$app->redirect(JRoute::_('index.php?option=com_localise&view=package&layout=edit&id=' . $this->getState('package.id'), false));

				return false;
			}

			$admin_txt .= "\t\t" . '<filename file="meta">install.xml</filename>' . "\n";
			$admin_txt .= "\t\t" . '<filename file="meta">' . $data['language'] . '.xml</filename>' . "\n";
			$admin_txt .= "\t\t" . '<filename>index.html</filename>' . "\n";
			$admin_txt .= "\t" . '</files>' . "\n";
			$admin_txt .= "\t" . '<params />' . "\n";
			$admin_txt .= '</extension>' . "\n";
			$admin_package_files[] = array('name' => 'install.xml','data' => $admin_txt);
			$language_data = file_get_contents(JPATH_ROOT . '/administrator/language/' . $data['language'] . '/' . $data['language'] . '.xml');
			$admin_package_files[] = array('name' => $data['language'] . '.xml','data' => $language_data);
			$language_data = file_get_contents(JPATH_ROOT . '/administrator/components/com_localise/models/index.html');
			$admin_package_files[] = array('name' => 'index.html','data' => $language_data);

			$admin_zip_path = JPATH_ROOT . '/tmp/' . uniqid('com_localise_') . '.zip';

			if (!$packager = JArchive::getAdapter('zip'))

			{
				$this->setError(JText::_('COM_LOCALISE_ERROR_EXPORT_ADAPTER'));

				return false;
			}
			else
			{
				if (!$packager->create($admin_zip_path, $admin_package_files))
				{
					$this->setError(JText::_('COM_LOCALISE_ERROR_EXPORT_ZIPCREATE'));

					return false;
				}
			}

			$main_package_files[] = array('name' => 'admin_' . $data['language'] . '.zip','data' => file_get_contents($admin_zip_path));
		}

		$text .= "\t" . '</files>' . "\n";

		if (!empty($data['serverurl']))

		{
			$text .= "\t" . '<updateservers>' . "\n";
			$text .= "\t\t" . '<server type="collection" priority="1" name="' . $data['servername'] . '">' . $data['serverurl'] . '</server>' . "\n";
			$text .= "\t" . '</updateservers>' . "\n";
		}

		$text .= '</extension>' . "\n";

		$main_package_files[] = array('name' => 'pkg_' . $data['language'] . '.xml', 'data' => $text);

		$ziproot = JPATH_ROOT . '/tmp/' . uniqid('com_localise_main_') . '.zip';

		// Run the packager
		if (!$packager = JArchive::getAdapter('zip'))

		{
			$this->setError(JText::_('COM_LOCALISE_ERROR_EXPORT_ADAPTER'));

			return false;
		}
		else
		{
			if (!$packager->create($ziproot, $main_package_files))
			{
				$this->setError(JText::_('COM_LOCALISE_ERROR_EXPORT_ZIPCREATE'));

				return false;
			}
		}

		ob_clean();
		$zipdata = file_get_contents($ziproot);
		header("Expires: 0");
		header("Last-Modified: " . gmdate("D, d M Y H:i:s") . " GMT");
		header('Content-Type: application/zip');
		header('Content-Disposition: attachment; filename="'
			. $data['language'] . '_joomla_lang_full_'
			. $data['version'] . 'v' . $data['packversion'] . '.zip"');
		header('Content-Length: ' . strlen($zipdata));
		header("Cache-Control: maxage=1");
		header("Pragma: public");
		header("Content-Transfer-Encoding: binary");
		echo $zipdata;
		exit;
	}

	/**
	 * Upload new file.
	 *
	 * @param   string  $file  The name of the file.
	 *
	 * @return  boolean  True if file uploaded successfully, false otherwise
	 *
	 * @since   3.0
	 */
	public function uploadFile($file)
	{
		jimport('joomla.filesystem.folder');

			$app      = JFactory::getApplication();
			$fileName = JFile::makeSafe($file['name']);

			try
			{
				$xmltree = new SimpleXMLElement(file_get_contents($file['tmp_name']));
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}
			}
			catch (Exception $e)
			{
				$app->enqueueMessage(JText::_('COM_LOCALISE_ERROR_PACKAGE_XML'), 'error');

				return false;
			}

			/* @TODO: get this in the js confirmation alert in views/packages/tmpl/defaul.php
			if (file_exists(JPath::clean(JPATH_COMPONENT_ADMINISTRATOR . '/packages/' . $file['name'])))
			{
				$app->enqueueMessage(JText::sprintf('COM_LOCALISE_FILE_EXISTS', $file['name']), 'error');

				return false;
			}
			*/

			if (!JFile::upload($file['tmp_name'], JPath::clean(JPATH_COMPONENT_ADMINISTRATOR . '/packages/' . $fileName)))
			{
				$app->enqueueMessage(JText::sprintf('COM_LOCALISE_FILE_UPLOAD_ERROR', $file['name']), 'error');

				return false;
			}

			return true;
	}

	/**
	 * Upload new css or php file in the language folders.
	 *
	 * @param   string  $file      The name of the file.
	 * @param   string  $location  The location for the file.
	 *
	 * @return  boolean  True if file uploaded successfully, false otherwise
	 *
	 * @since   3.0
	 */
	public function uploadOtherFile($file, $location)
	{
		jimport('joomla.filesystem.folder');

		$app	= JFactory::getApplication();
		$id		= $app->getUserState('com_localise.edit.package.id');

		if (is_array($id))
		{
			$id = $id[0];
		}

		$table = $this->getTable();
		$table->load($id);

		$xml = simplexml_load_file($table->path);

		if ($xml)
		{
			$tag = $xml->language;

		}

		if ($tag == '')
function myFunction($a) {
    switch ($a) {
        case 'foo':
            $x = 1;
            break;

        case 'bar':
            $x = 2;
            break;
    }

    // $x is potentially undefined here.
    echo $x;
}
		{
			$app->enqueueMessage(JText::_('COM_LOCALISE_FILE_TAG_ERROR'), 'error');

			return false;
		}

		$fileName = JFile::makeSafe($file['name']);
		$ext = JFile::getExt($fileName);

		// Prevent uploading some file types
		if (!($ext == "ini" || $fileName == $tag . '.css' || $fileName == $tag . '.localise.php'))
		{
			$app->enqueueMessage(JText::sprintf('COM_LOCALISE_FILE_TYPE_ERROR', $fileName), 'error');

			return false;
		}

		if ($fileName == $tag . '.css' && $location == LOCALISEPATH_SITE)
		{
			$app->enqueueMessage(JText::sprintf('COM_LOCALISE_FILE_CSS_ERROR', $fileName), 'error');

			return false;
		}

		/* @TODO: get this in the js confirmation alert in views/package/tmpl/edit.php
		 if (file_exists(JPath::clean($location . '/language/' . $tag . '/' . $file['name'])))
		 {
		$app->enqueueMessage(JText::sprintf('COM_LOCALISE_FILE_EXISTS', $file['name']), 'error');

		return false;
		}
		*/

		if (!JFile::upload($file['tmp_name'], JPath::clean($location . '/language/' . $tag . '/' . $fileName)))
		{
			$app->enqueueMessage(JText::sprintf('COM_LOCALISE_FILE_UPLOAD_ERROR', $file['name']), 'error');

			return false;
		}

		return true;
	}
}

GitHub Access Token became invalid

LocaliseModelPackage F
last analyzed 2018-10-24 04:42 UTC

Complexity

Size/Duplication

Coupling/Cohesion

Importance

10 Methods

How to fix Duplicated Code Complexity

Duplicated Code

Complex Class

Available Fixes

Available Fixes

Available Fixes

joomla-projects / com_localise

GitHub Access Token became invalid

LocaliseModelPackage F last analyzed 2018-10-24 04:42 UTC

Complexity

Size/Duplication

Coupling/Cohesion

Importance

10 Methods

How to fix Duplicated Code Complexity

Duplicated Code

Complex Class

Available Fixes

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like

LocaliseModelPackage F
last analyzed 2018-10-24 04:42 UTC
