- md5
- 79e744313ba82f5abc0140ca0e208923
- sha1
- 2c78c5d3531389e3cd95cef55e0ea24ceeffebcf
- sha256
- a5bccf94357263049c0b408dae922144c3ea0083da2ad915ccf5e743b6a629f4
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209
<?php
/**
* @package Joomla.Plugin
* @subpackage Extension.Finder
*
* @copyright (C) 2019 Open Source Matters, Inc. <https://www.joomla.org>
* @license GNU General Public License version 2 or later; see LICENSE.txt
*/
namespace Joomla\Plugin\Extension\Finder\Extension;
use Exception;
use Joomla\CMS\Installer\Installer;
use Joomla\CMS\Plugin\CMSPlugin;
use Joomla\Component\Finder\Administrator\Indexer\Helper;
use Joomla\Database\DatabaseAwareTrait;
use Joomla\Database\ParameterType;
use Joomla\String\StringHelper;
// phpcs:disable PSR1.Files.SideEffects
\defined('_JEXEC') or die;
// phpcs:enable PSR1.Files.SideEffects
/**
* Finder extension plugin
*
* @since 4.0.0
*/
final class Finder extends CMSPlugin
{
use DatabaseAwareTrait;
/**
* Add common words to finder after language got installed
*
* @param Installer $installer Installer object
* @param integer $eid Extension Identifier
*
* @return void
*
* @since 4.0.0
*/
public function onExtensionAfterInstall($installer, $eid)
{
if (!$eid) {
return;
}
$extension = $this->getLanguage($eid);
if ($extension) {
$this->addCommonWords($extension);
}
}
/**
* Add common words to finder after language got updated
*
* @param Installer $installer Installer object
* @param integer $eid Extension identifier
*
* @return void
*
* @since 4.0.0
*/
public function onExtensionAfterUpdate($installer, $eid)
{
$this->onExtensionAfterInstall($installer, $eid);
}
/**
* Remove common words to finder after language got uninstalled
*
* @param Installer $installer Installer instance
* @param integer $eid Extension id
* @param boolean $removed Installation result
*
* @return void
*
* @since 4.0.0
*/
public function onExtensionAfterUninstall($installer, $eid, $removed)
{
// Check that the language was successfully uninstalled.
if ($eid && $removed && $installer->extension->type === 'language') {
$this->removeCommonWords($installer->extension);
}
}
/**
* Get an object of information if the handled extension is a language
*
* @param integer $eid Extension id
*
* @return object
*
* @since 4.0.0
*/
protected function getLanguage($eid)
{
$db = $this->getDatabase();
$eid = (int) $eid;
$query = $db->getQuery(true)
->select($db->quoteName(['element', 'client_id']))
->from($db->quoteName('#__extensions'))
->where(
[
$db->quoteName('extension_id') . ' = :eid',
$db->quoteName('type') . ' = ' . $db->quote('language'),
]
)
->bind(':eid', $eid, ParameterType::INTEGER);
$db->setQuery($query);
$extension = $db->loadObject();
return $extension;
}
/**
* Add common words from a txt file to com_finder
*
* @param object $extension Extension object
*
* @return void
*
* @since 4.0.0
*/
protected function addCommonWords($extension)
{
if ($extension->client_id == 0) {
$path = JPATH_SITE . '/language/' . $extension->element . '/com_finder.commonwords.txt';
} else {
$path = JPATH_ADMINISTRATOR . '/language/' . $extension->element . '/com_finder.commonwords.txt';
}
if (!file_exists($path)) {
return;
}
$this->removeCommonWords($extension);
$file_content = file_get_contents($path);
$words = explode("\n", $file_content);
$words = array_map(
function ($word) {
// Remove comments
if (StringHelper::strpos($word, ';') !== false) {
$word = StringHelper::substr($word, 0, StringHelper::strpos($word, ';'));
}
return $word;
},
$words
);
$words = array_filter(array_map('trim', $words));
$db = $this->getDatabase();
$query = $db->getQuery(true);
$lang = Helper::getPrimaryLanguage($extension->element);
$query->insert($db->quoteName('#__finder_terms_common'))
->columns($db->quoteName(['term', 'language', 'custom']));
foreach ($words as $word) {
$bindNames = $query->bindArray([$word, $lang], ParameterType::STRING);
$query->values(implode(',', $bindNames) . ', 0');
}
try {
$db->setQuery($query);
$db->execute();
} catch (Exception $ex) {
// It would be nice if the common word is stored to the DB, but it isn't super important
}
}
/**
* Remove common words of a language from com_finder
*
* @param object $extension Extension object
*
* @return void
*
* @since 4.0.0
*/
protected function removeCommonWords($extension)
{
$db = $this->getDatabase();
$lang = Helper::getPrimaryLanguage($extension->element);
$query = $db->getQuery(true);
$query->delete($db->quoteName('#__finder_terms_common'))
->where(
[
$db->quoteName('language') . ' = :lang',
$db->quoteName('custom') . ' = 0',
]
)
->bind(':lang', $lang);
$db->setQuery($query);
$db->execute();
}
}
The same content is in 18 releases, Joomla 4.3.0-beta1 to 5.0.0-alpha1. See them all, or every version of this file.