540 lines
16 KiB
PHP
540 lines
16 KiB
PHP
<?php
|
|
/*----------------------------------------------------------------------------------| io.vdm.dev |----/
|
|
Vast Development Method
|
|
/-------------------------------------------------------------------------------------------------------/
|
|
|
|
@package getBible.net
|
|
|
|
@created 3rd December, 2015
|
|
@author Llewellyn van der Merwe <https://getbible.net>
|
|
@git Get Bible <https://git.vdm.dev/getBible>
|
|
@github Get Bible <https://github.com/getBible>
|
|
@support Get Bible <https://git.vdm.dev/getBible/support>
|
|
@copyright Copyright (C) 2015. All Rights Reserved
|
|
@license GNU/GPL Version 2 or later - http://www.gnu.org/licenses/gpl-2.0.html
|
|
|
|
/------------------------------------------------------------------------------------------------------*/
|
|
namespace TrueChristianChurch\Component\Getbible\Site\Model;
|
|
|
|
use Joomla\CMS\Factory;
|
|
use Joomla\CMS\Language\Text;
|
|
use Joomla\CMS\Application\CMSApplicationInterface;
|
|
use Joomla\CMS\Component\ComponentHelper;
|
|
use Joomla\CMS\HTML\HTMLHelper as Html;
|
|
use Joomla\CMS\Layout\LayoutHelper;
|
|
use Joomla\CMS\MVC\Model\ListModel;
|
|
use Joomla\CMS\MVC\Factory\MVCFactoryInterface;
|
|
use Joomla\CMS\Plugin\PluginHelper;
|
|
use Joomla\CMS\User\User;
|
|
use Joomla\Utilities\ArrayHelper;
|
|
use Joomla\Input\Input;
|
|
use Joomla\CMS\Router\Route;
|
|
use Joomla\CMS\Session\Session;
|
|
use Joomla\CMS\Uri\Uri;
|
|
use Joomla\Registry\Registry;
|
|
use TrueChristianChurch\Component\Getbible\Administrator\Helper\GetbibleHelper;
|
|
use TrueChristianChurch\Joomla\GetBible\Openai;
|
|
use TrueChristianChurch\Joomla\GetBible\Factory as GetBibleFactory;
|
|
use TrueChristianChurch\Joomla\Utilities\JsonHelper;
|
|
use TrueChristianChurch\Joomla\Utilities\GuidHelper;
|
|
|
|
// No direct access to this file
|
|
\defined('_JEXEC') or die;
|
|
|
|
/**
|
|
* Getbible Ajax List Model
|
|
*
|
|
* @since 1.6
|
|
*/
|
|
class AjaxModel extends ListModel
|
|
{
|
|
/**
|
|
* The component params.
|
|
*
|
|
* @var Registry
|
|
* @since 3.2.0
|
|
*/
|
|
protected Registry $app_params;
|
|
|
|
/**
|
|
* The application object.
|
|
*
|
|
* @var CMSApplicationInterface The application instance.
|
|
* @since 3.2.0
|
|
*/
|
|
protected CMSApplicationInterface $app;
|
|
|
|
/**
|
|
* Constructor
|
|
*
|
|
* @param array $config An array of configuration options (name, state, dbo, table_path, ignore_request).
|
|
* @param ?MVCFactoryInterface $factory The factory.
|
|
*
|
|
* @since 1.6
|
|
* @throws \Exception
|
|
*/
|
|
public function __construct($config = [], MVCFactoryInterface $factory = null)
|
|
{
|
|
parent::__construct($config, $factory);
|
|
|
|
$this->app_params = ComponentHelper::getParams('com_getbible');
|
|
$this->app ??= Factory::getApplication();
|
|
}
|
|
|
|
// Used in app
|
|
/**
|
|
* Get share His Word URL
|
|
*
|
|
* @param string $linker The linker GUID value
|
|
* @param string $translation The translation abbreviation
|
|
* @param int $book The book number
|
|
* @param int $chapter The chapter number
|
|
*
|
|
* @return array|null
|
|
* @since 3.2.0
|
|
**/
|
|
public function getShareHisWordUrl(
|
|
string $linker,
|
|
string $translation,
|
|
int $book,
|
|
int $chapter): ?array
|
|
{
|
|
$linker = trim($linker);
|
|
// we check if this is a valid linker value
|
|
if (GetBibleFactory::_('GetBible.Linker')->valid($linker))
|
|
{
|
|
return ['url' => trim(trim(Uri::base(), '/') . Route::_('index.php?option=com_getbible&view=app&translation=' . $translation . '&Itemid=' . $this->app_params->get('app_menu', 0) . '&book=' . $book . '&chapter=' . $chapter . '&Share_His_Word=' . $linker))];
|
|
}
|
|
|
|
return ['error' => Text::_('COM_GETBIBLE_THIS_SESSION_KEY_IS_NOT_YET_ELIGIBLE_FOR_SHARING_AS_NO_ACTIONS_HAVE_BEEN_PERFORMED_WITHIN_IT')];
|
|
}
|
|
|
|
/**
|
|
* Check if the linker key is valid
|
|
*
|
|
* @param string $linker The linker GUID value
|
|
* @param string $oldLinker The old linker GUID value
|
|
*
|
|
* @return array|null
|
|
* @since 3.2.0
|
|
**/
|
|
public function checkValidLinker(
|
|
string $linker,
|
|
string $oldLinker): ?array
|
|
{
|
|
$linker = trim($linker);
|
|
// we check if this is a valid linker value
|
|
if (GetBibleFactory::_('GetBible.Linker')->valid($linker)
|
|
&& GetBibleFactory::_('GetBible.Linker')->set($linker))
|
|
{
|
|
return [
|
|
'success' => Text::_('COM_GETBIBLE_YOU_HAVE_ENTERED_A_VALID_SESSION_KEY'),
|
|
'old' => GetBibleFactory::_('GetBible.Linker')->valid($oldLinker)
|
|
];
|
|
}
|
|
|
|
return ['error' => Text::_('COM_GETBIBLE_THIS_IS_NOT_A_VALID_SESSION_KEY')];
|
|
}
|
|
|
|
/**
|
|
* Load the given chapter of the Bible into the database, or force an update
|
|
*
|
|
* @param string $translation The translation abbreviation
|
|
* @param int $book The book number
|
|
* @param int $chapter The chapter number
|
|
* @param int $force The switch to force an update
|
|
*
|
|
* @return array|null
|
|
* @since 3.2.0
|
|
**/
|
|
public function installBibleChapter(string $translation, int $book, int $chapter, int $force = 0): ?array
|
|
{
|
|
try
|
|
{
|
|
$_force = ($force == 1) ? true:false;
|
|
GetBibleFactory::_('GetBible.Watcher')->sync($translation, $book, $chapter, $_force);
|
|
}
|
|
catch(Exception $error)
|
|
{
|
|
return ['error' => $error->getMessage()];
|
|
}
|
|
|
|
return [
|
|
'success' => Text::sprintf('COM_GETBIBLE_THE_CHAPTERS_OF_BOOKS_WAS_SUCCESSFULLY_INSTALLED_FOR_S_TRANSLATION', $chapter, $book, $translation),
|
|
'total' => GetBibleFactory::_('GetBible.Watcher')->totalVerses($translation)
|
|
];
|
|
}
|
|
|
|
/**
|
|
* Get App URL
|
|
*
|
|
* @param string $translation The translation abbreviation
|
|
* @param string $book The book number
|
|
* @param int $chapter The chapter number
|
|
* @param int|null $verse The verse string
|
|
*
|
|
* @return array|null
|
|
* @since 3.2.0
|
|
**/
|
|
public function getAppUrl(
|
|
string $translation,
|
|
string $book,
|
|
int $chapter = 1,
|
|
?string $verse = ''): ?array
|
|
{
|
|
return ['url' => trim(trim(Uri::base(), '/') . Route::_('index.php?option=com_getbible&view=app&t=' . $translation . '&Itemid=' . $this->app_params->get('app_menu', 0) . '&ref=' . $book . '&c=' . $chapter . '&v=' . $verse))];
|
|
}
|
|
|
|
/**
|
|
* Set the session Linker
|
|
*
|
|
* @param string $linker The linker GUID value
|
|
*
|
|
* @return array
|
|
* @since 3.2.0
|
|
**/
|
|
public function setLinker(string $linker): array
|
|
{
|
|
if (GetBibleFactory::_('GetBible.Linker')->set(trim($linker)))
|
|
{
|
|
return ['success' => Text::_('COM_GETBIBLE_THE_SESSION_IS_SET')];
|
|
}
|
|
|
|
return ['error' => Text::_('COM_GETBIBLE_THERE_HAS_BEEN_AN_ERROR_PLEASE_TRY_AGAIN')];
|
|
}
|
|
|
|
/**
|
|
* Set the Linker Name
|
|
*
|
|
* @param string $name The linker name value
|
|
*
|
|
* @return array
|
|
* @since 3.2.0
|
|
**/
|
|
public function setLinkerName(string $name): array
|
|
{
|
|
$name = trim($name);
|
|
if (($result = GetBibleFactory::_('GetBible.Linker')->setName($name)) !== null)
|
|
{
|
|
return $result;
|
|
}
|
|
|
|
return ['error' => Text::_('COM_GETBIBLE_THERE_HAS_BEEN_AN_ERROR_PLEASE_TRY_AGAIN')];
|
|
}
|
|
|
|
/**
|
|
* Is the Linker Authenticated
|
|
*
|
|
* @param string $linker The linker GUID value
|
|
*
|
|
* @return array
|
|
* @since 3.2.0
|
|
**/
|
|
public function isLinkerAuthenticated(string $linker): array
|
|
{
|
|
if (($authenticated = GetBibleFactory::_('GetBible.Linker')->authenticated(trim($linker))) !== null)
|
|
{
|
|
return $authenticated;
|
|
}
|
|
|
|
return ['error' => Text::_('COM_GETBIBLE_THERE_HAS_BEEN_AN_ERROR_PLEASE_TRY_AGAIN')];
|
|
}
|
|
|
|
/**
|
|
* Set the Linker access
|
|
*
|
|
* @param string $linker The linker GUID value
|
|
* @param string $pass The linker pass value
|
|
* @param string|null $oldPass The linker old pass value
|
|
*
|
|
* @return array
|
|
* @since 3.2.0
|
|
**/
|
|
public function setLinkerAccess(string $linker, string $pass, ?string $oldPass): array
|
|
{
|
|
if (($access = GetBibleFactory::_('GetBible.Linker')->access(trim($linker), $pass, $oldPass)) !== null)
|
|
{
|
|
return $access;
|
|
}
|
|
|
|
return ['error' => Text::_('COM_GETBIBLE_THERE_HAS_BEEN_AN_ERROR_PLEASE_TRY_AGAIN')];
|
|
}
|
|
|
|
/**
|
|
* Revoke the Linker access
|
|
*
|
|
* @param string $linker The linker GUID value
|
|
*
|
|
* @return array
|
|
* @since 3.2.0
|
|
**/
|
|
public function revokeLinkerAccess(string $linker): array
|
|
{
|
|
if (($revoked = GetBibleFactory::_('GetBible.Linker')->revoke(trim($linker))) !== null)
|
|
{
|
|
return $revoked;
|
|
}
|
|
|
|
return ['error' => Text::_('COM_GETBIBLE_THERE_HAS_BEEN_AN_ERROR_PLEASE_TRY_AGAIN')];
|
|
}
|
|
|
|
/**
|
|
* Revoke the Linker session
|
|
*
|
|
* @param string $linker The linker GUID value
|
|
*
|
|
* @return array
|
|
* @since 3.2.0
|
|
**/
|
|
public function revokeLinkerSession(string $linker): array
|
|
{
|
|
if (($revoked = GetBibleFactory::_('GetBible.Linker')->revokeSession(trim($linker))) !== null)
|
|
{
|
|
return $revoked;
|
|
}
|
|
|
|
return ['error' => Text::_('COM_GETBIBLE_THERE_HAS_BEEN_AN_ERROR_PLEASE_TRY_AGAIN')];
|
|
}
|
|
|
|
/**
|
|
* Create a Tag
|
|
*
|
|
* @param string $name The tag name being created
|
|
* @param string|null $description The tag description being created
|
|
*
|
|
* @return array
|
|
* @since 3.2.0
|
|
**/
|
|
public function createTag(string $name, ?string $description): array
|
|
{
|
|
if (($tag = GetBibleFactory::_('GetBible.Tag')->create($name, $description)) !== null)
|
|
{
|
|
return $tag;
|
|
}
|
|
|
|
return ['error' => Text::_('COM_GETBIBLE_THERE_HAS_BEEN_AN_ERROR')];
|
|
}
|
|
|
|
/**
|
|
* Update a Tag
|
|
*
|
|
* @param string $tag The tag GUID value
|
|
* @param string $name The tag name being created
|
|
* @param string|null $description The tag description being created
|
|
*
|
|
* @return array
|
|
* @since 3.2.0
|
|
**/
|
|
public function updateTag(string $tag, string $name, ?string $description): array
|
|
{
|
|
if (($tag = GetBibleFactory::_('GetBible.Tag')->update($tag, $name, $description)) !== null)
|
|
{
|
|
return $tag;
|
|
}
|
|
|
|
return ['error' => Text::_('COM_GETBIBLE_THERE_HAS_BEEN_AN_ERROR')];
|
|
}
|
|
|
|
/**
|
|
* Delete a Tag
|
|
*
|
|
* @param string $tag The tag GUID value
|
|
*
|
|
* @return array
|
|
* @since 3.2.0
|
|
**/
|
|
public function deleteTag(string $tag): array
|
|
{
|
|
if (($result = GetBibleFactory::_('GetBible.Tag')->delete($tag)) !== null)
|
|
{
|
|
return $result;
|
|
}
|
|
|
|
return ['error' => Text::_('COM_GETBIBLE_THERE_HAS_BEEN_AN_ERROR')];
|
|
}
|
|
|
|
/**
|
|
* Set a Note
|
|
*
|
|
* @param int $book The book in which the note is made
|
|
* @param int $chapter The chapter in which the note is made
|
|
* @param int $verse The verse where the note is made
|
|
* @param string|null $note The note being made
|
|
*
|
|
* @return array
|
|
* @since 3.2.0
|
|
**/
|
|
public function setNote(
|
|
int $book,
|
|
int $chapter,
|
|
int $verse,
|
|
?string $note
|
|
): array
|
|
{
|
|
if (($note = GetBibleFactory::_('GetBible.Note')->set(
|
|
$book,
|
|
$chapter,
|
|
$verse,
|
|
$note
|
|
)) !== null)
|
|
{
|
|
return $note;
|
|
}
|
|
|
|
return ['error' => Text::_('COM_GETBIBLE_THERE_HAS_BEEN_AN_ERROR_PLEASE_TRY_AGAIN')];
|
|
}
|
|
|
|
/**
|
|
* Set a Tagged verse
|
|
*
|
|
* @param string $translation The translation in which the note is made
|
|
* @param int $book The book in which the note is made
|
|
* @param int $chapter The chapter in which the note is made
|
|
* @param int $verse The verse where the note is made
|
|
* @param string $tag The tag being added
|
|
*
|
|
* @return array
|
|
* @since 3.2.0
|
|
**/
|
|
public function tagVerse(
|
|
string $translation,
|
|
int $book,
|
|
int $chapter,
|
|
int $verse,
|
|
string $tag
|
|
): array
|
|
{
|
|
if (($tag = GetBibleFactory::_('GetBible.Tagged')->set(
|
|
$translation,
|
|
$book,
|
|
$chapter,
|
|
$verse,
|
|
$tag
|
|
)) !== null)
|
|
{
|
|
return $tag;
|
|
}
|
|
|
|
return ['error' => Text::_('COM_GETBIBLE_THERE_HAS_BEEN_AN_ERROR_PLEASE_TRY_AGAIN')];
|
|
}
|
|
|
|
/**
|
|
* Remove a Tag from a verse
|
|
*
|
|
* @param string $tag The tag GUID value
|
|
*
|
|
* @return array
|
|
* @since 3.2.0
|
|
**/
|
|
public function removeTagFromVerse(string $tag): array
|
|
{
|
|
if (($_tag = GetBibleFactory::_('GetBible.Tagged')->delete($tag)) !== null)
|
|
{
|
|
return $_tag;
|
|
}
|
|
|
|
return ['error' => Text::_('COM_GETBIBLE_THERE_HAS_BEEN_AN_ERROR')];
|
|
}
|
|
|
|
/**
|
|
* Return the build list of linkers
|
|
*
|
|
* @param string $linkers The json list of linker values
|
|
*
|
|
* @return array
|
|
* @since 3.2.0
|
|
**/
|
|
public function getLinkersDisplay(string $linkers): array
|
|
{
|
|
if (JsonHelper::check($linkers))
|
|
{
|
|
return ['display' => LayoutHelper::render('getbiblelinkers', json_decode($linkers))];
|
|
}
|
|
|
|
return ['display' => LayoutHelper::render('getbiblelinkers', null)];
|
|
}
|
|
|
|
// Used in search
|
|
/**
|
|
* Get Search URL
|
|
*
|
|
* @param string $translation The translation abbreviation
|
|
* @param int $words The words search behaviour
|
|
* @param int $match The match search behaviour
|
|
* @param int $case The case search behaviour
|
|
* @param int $target The target search behaviour
|
|
* @param string|null $search The search string
|
|
* @param int $targetBook The target book search behaviour
|
|
* @param int $book The book from which the search is started
|
|
* @param int $chapter The chapter from which the search is started
|
|
*
|
|
* @return array|null
|
|
* @since 3.2.0
|
|
**/
|
|
public function getSearchUrl(
|
|
string $translation,
|
|
int $words,
|
|
int $match,
|
|
int $case,
|
|
int $target,
|
|
?string $search,
|
|
int $targetBook = 0,
|
|
int $book = 0,
|
|
int $chapter = 0): ?array
|
|
{
|
|
if ($this->app_params->get('activate_search') == 1)
|
|
{
|
|
// set the return URL
|
|
$return = '';
|
|
if ($book > 0 && $chapter > 0)
|
|
{
|
|
$return = '&bibleurl=' . urlencode(base64_encode(trim(Uri::base(), '/') . Route::_('index.php?option=com_getbible&view=app&t=' . $translation . '&Itemid=' . $this->app_params->get('app_menu', 0) . '&book=' . $book . '&chapter=' . $chapter)));
|
|
}
|
|
|
|
return ['url' => trim(trim(Uri::base(), '/') . Route::_('index.php?option=com_getbible&view=search&Itemid=' . $this->app_params->get('app_menu', 0) . $return . '&t=' . $translation . '&words=' . $words . '&match=' . $match . '&case=' . $case . '&target=' . $target . '&search=' . $search ?? ''))];
|
|
}
|
|
|
|
return ['error' => 'The search feature has not been activated. Please contact the system administrator of this website to resolve this.'];
|
|
}
|
|
|
|
// Used in openai
|
|
/**
|
|
* Get Open AI URL
|
|
*
|
|
* @param string $words The words number
|
|
* @param string $verse The verse number
|
|
* @param int $chapter The chapter number
|
|
* @param int $book The book number
|
|
* @param string $translation The translation abbreviation
|
|
* @param string $guid The guid of the Prompt
|
|
*
|
|
* @return array|null
|
|
* @since 3.2.0
|
|
**/
|
|
public function getOpenaiURL(
|
|
string $words,
|
|
string $verse,
|
|
int $chapter,
|
|
int $book,
|
|
string $translation,
|
|
string $guid): ?array
|
|
{
|
|
if ($this->app_params->get('enable_open_ai') == 1 &&
|
|
($abbreviation = GuidHelper::item($guid, 'prompt', 'a.abbreviation', 'getbible')) !== null)
|
|
{
|
|
if ($abbreviation === 'all' || $abbreviation === $translation)
|
|
{
|
|
// set the return UR
|
|
$return = urlencode(base64_encode((string) Route::_('index.php?option=com_getbible&view=app&t=' . $translation . '&Itemid=' . $this->app_params->get('app_menu', 0) . '&book=' . $book . '&chapter=' . $chapter)));
|
|
|
|
// we return the AI url
|
|
return ['url' => trim(trim(Uri::base(), '/') . Route::_('index.php?option=com_getbible&view=openai&t=' . $translation . '&Itemid=' . $this->app_params->get('app_menu', 0) . '&bibleurl=' . $return . '&guid=' . $guid . '&book=' . $book . '&chapter=' . $chapter . '&verse=' . $verse . '&words=' . $words))];
|
|
}
|
|
|
|
return ['error' => 'There was an error please try again.'];
|
|
}
|
|
|
|
return ['error' => 'The Open AI feature has not been activated. Please contact the system administrator of this website to resolve this.'];
|
|
}
|
|
}
|