.
*/
namespace Fisharebest\Webtrees\Module;
use Fisharebest\Webtrees\Auth;
use Fisharebest\Webtrees\Database;
use Fisharebest\Webtrees\Filter;
use Fisharebest\Webtrees\Functions\FunctionsEdit;
use Fisharebest\Webtrees\Functions\FunctionsPrint;
use Fisharebest\Webtrees\GedcomRecord;
use Fisharebest\Webtrees\GedcomTag;
use Fisharebest\Webtrees\I18N;
use Fisharebest\Webtrees\Individual;
use Fisharebest\Webtrees\Theme;
use PDO;
use Rhumsaa\Uuid\Uuid;
/**
* Class FamilyTreeFavoritesModule
*
* Note that the user favorites module simply extends this module, so ensure that the
* logic works for both.
*/
class FamilyTreeFavoritesModule extends AbstractModule implements ModuleBlockInterface {
// How to update the database schema for this module
const SCHEMA_TARGET_VERSION = 4;
const SCHEMA_SETTING_NAME = 'FV_SCHEMA_VERSION';
const SCHEMA_MIGRATION_PREFIX = '\Fisharebest\Webtrees\Module\FamilyTreeFavorites\Schema';
/**
* Create a new module.
*
* @param string $directory Where is this module installed
*/
public function __construct($directory) {
parent::__construct($directory);
// Create/update the database tables.
// NOTE: if we want to set any module-settings, we'll need to move this.
Database::updateSchema(self::SCHEMA_MIGRATION_PREFIX, self::SCHEMA_SETTING_NAME, self::SCHEMA_TARGET_VERSION);
}
/**
* How should this module be labelled on tabs, menus, etc.?
*
* @return string
*/
public function getTitle() {
return /* I18N: Name of a module */ I18N::translate('Favorites');
}
/**
* A sentence describing what this module does.
*
* @return string
*/
public function getDescription() {
return /* I18N: Description of the “Favorites” module */ I18N::translate('Display and manage a family tree’s favorite pages.');
}
/**
* Generate the HTML content of this block.
*
* @param int $block_id
* @param bool $template
* @param string[] $cfg
*
* @return string
*/
public function getBlock($block_id, $template = true, $cfg = []) {
global $ctype, $controller, $WT_TREE;
$action = Filter::get('action');
switch ($action) {
case 'deletefav':
$favorite_id = Filter::getInteger('favorite_id');
if ($favorite_id) {
self::deleteFavorite($favorite_id);
}
break;
case 'addfav':
$gid = Filter::get('gid', WT_REGEX_XREF);
$favnote = Filter::get('favnote');
$url = Filter::getUrl('url');
$favtitle = Filter::get('favtitle');
if ($gid) {
$record = GedcomRecord::getInstance($gid, $WT_TREE);
if ($record && $record->canShow()) {
self::addFavorite([
'user_id' => $ctype === 'user' ? Auth::id() : null,
'gedcom_id' => $WT_TREE->getTreeId(),
'gid' => $record->getXref(),
'type' => $record::RECORD_TYPE,
'url' => null,
'note' => $favnote,
'title' => $favtitle,
]);
}
} elseif ($url) {
self::addFavorite([
'user_id' => $ctype === 'user' ? Auth::id() : null,
'gedcom_id' => $WT_TREE->getTreeId(),
'gid' => null,
'type' => 'URL',
'url' => $url,
'note' => $favnote,
'title' => $favtitle ? $favtitle : $url,
]);
}
break;
}
$block = $this->getBlockSetting($block_id, 'block', '0');
foreach (['block'] as $name) {
if (array_key_exists($name, $cfg)) {
$$name = $cfg[$name];
}
}
$userfavs = $this->getFavorites($ctype === 'user' ? Auth::id() : $WT_TREE->getTreeId());
if (!is_array($userfavs)) {
$userfavs = [];
}
$id = $this->getName() . $block_id;
$class = $this->getName() . '_block';
$title = $this->getTitle();
if (Auth::check()) {
$controller
->addExternalJavascript(WT_AUTOCOMPLETE_JS_URL)
->addInlineJavascript('autocomplete();');
}
$content = '';
if ($userfavs) {
foreach ($userfavs as $key => $favorite) {
if (isset($favorite['id'])) {
$key = $favorite['id'];
}
$removeFavourite = '' . I18N::translate('Remove') . ' ';
if ($favorite['type'] == 'URL') {
$content .= '';
if ($ctype == 'user' || Auth::isManager($WT_TREE)) {
$content .= $removeFavourite;
}
$content .= '
' . $favorite['title'] . '';
$content .= '
' . $favorite['note'];
$content .= '
';
if ($ctype == 'user' || Auth::isManager($WT_TREE)) {
$content .= $removeFavourite;
}
$content .= $record->formatList('span');
$content .= '
' . $favorite['note'];
$content .= '
';
}
}
}
}
}
if ($ctype == 'user' || Auth::isManager($WT_TREE)) {
$uniqueID = Uuid::uuid4(); // This block can theoretically appear multiple times, so use a unique ID.
$content .= '';
$content .= '';
}
if ($template) {
if ($block === '1') {
$class .= ' small_inner_block';
}
return Theme::theme()->formatBlock($id, $title, $class, $content);
} else {
return $content;
}
}
/**
* Should this block load asynchronously using AJAX?
*
* Simple blocks are faster in-line, more comples ones
* can be loaded later.
*
* @return bool
*/
public function loadAjax() {
return false;
}
/**
* Can this block be shown on the user’s home page?
*
* @return bool
*/
public function isUserBlock() {
return false;
}
/**
* Can this block be shown on the tree’s home page?
*
* @return bool
*/
public function isGedcomBlock() {
return true;
}
/**
* An HTML form to edit block settings
*
* @param int $block_id
*/
public function configureBlock($block_id) {
if (Filter::postBool('save') && Filter::checkCsrf()) {
$this->setBlockSetting($block_id, 'block', Filter::postBool('block'));
}
$block = $this->getBlockSetting($block_id, 'block', '0');
echo '| ';
echo /* I18N: label for a yes/no option */ I18N::translate('Add a scrollbar when block contents grow');
echo ' | ';
echo FunctionsEdit::editFieldYesNo('block', $block);
echo ' |
';
}
/**
* Delete a favorite from the database
*
* @param int $favorite_id
*
* @return bool
*/
public static function deleteFavorite($favorite_id) {
return (bool)
Database::prepare("DELETE FROM `##favorite` WHERE favorite_id=?")
->execute([$favorite_id]);
}
/**
* Store a new favorite in the database
*
* @param $favorite
*
* @return bool
*/
public static function addFavorite($favorite) {
// -- make sure a favorite is added
if (empty($favorite['gid']) && empty($favorite['url'])) {
return false;
}
//-- make sure this is not a duplicate entry
$sql = "SELECT SQL_NO_CACHE 1 FROM `##favorite` WHERE";
if (!empty($favorite['gid'])) {
$sql .= " xref=?";
$vars = [$favorite['gid']];
} else {
$sql .= " url=?";
$vars = [$favorite['url']];
}
$sql .= " AND gedcom_id=?";
$vars[] = $favorite['gedcom_id'];
if ($favorite['user_id']) {
$sql .= " AND user_id=?";
$vars[] = $favorite['user_id'];
} else {
$sql .= " AND user_id IS NULL";
}
if (Database::prepare($sql)->execute($vars)->fetchOne()) {
return false;
}
//-- add the favorite to the database
return (bool)
Database::prepare("INSERT INTO `##favorite` (user_id, gedcom_id, xref, favorite_type, url, title, note) VALUES (? ,? ,? ,? ,? ,? ,?)")
->execute([$favorite['user_id'], $favorite['gedcom_id'], $favorite['gid'], $favorite['type'], $favorite['url'], $favorite['title'], $favorite['note']]);
}
/**
* Get favorites for a user or family tree
*
* @param int $gedcom_id
*
* @return string[][]
*/
public static function getFavorites($gedcom_id) {
return
Database::prepare(
"SELECT SQL_CACHE favorite_id AS id, user_id, gedcom_id, xref AS gid, favorite_type AS type, title, note, url" .
" FROM `##favorite` WHERE gedcom_id=? AND user_id IS NULL")
->execute([$gedcom_id])
->fetchAll(PDO::FETCH_ASSOC);
}
}