This repository has been archived on 2024-09-05. You can view files and clone it, but cannot push or open issues or pull requests.
shimmie2/ext/pools/main.php

998 lines
37 KiB
PHP
Raw Normal View History

2021-12-14 18:32:47 +00:00
<?php
declare(strict_types=1);
2009-12-24 07:36:09 +00:00
namespace Shimmie2;
2024-02-10 18:35:55 +00:00
use function MicroHTML\{INPUT};
abstract class PoolsConfig
{
2021-12-14 18:32:47 +00:00
public const MAX_IMPORT_RESULTS = "poolsMaxImportResults";
public const IMAGES_PER_PAGE = "poolsImagesPerPage";
public const LISTS_PER_PAGE = "poolsListsPerPage";
public const UPDATED_PER_PAGE = "poolsUpdatedPerPage";
public const INFO_ON_VIEW_IMAGE = "poolsInfoOnViewImage";
public const ADDER_ON_VIEW_IMAGE = "poolsAdderOnViewImage";
public const SHOW_NAV_LINKS = "poolsShowNavLinks";
public const AUTO_INCREMENT_ORDER = "poolsAutoIncrementOrder";
}
class PoolAddPostsEvent extends Event
{
public int $pool_id;
/** @var int[] */
public array $posts = [];
/**
* @param int[] $posts
*/
public function __construct(int $pool_id, array $posts)
{
2020-01-26 13:19:35 +00:00
parent::__construct();
$this->pool_id = $pool_id;
$this->posts = $posts;
}
}
class PoolCreationEvent extends Event
{
public string $title;
public User $user;
public bool $public;
public string $description;
public int $new_id = -1;
2020-03-27 00:15:15 +00:00
public function __construct(
string $title,
?User $pool_user = null,
2020-03-27 00:15:15 +00:00
bool $public = false,
string $description = ""
2020-04-25 20:36:28 +00:00
) {
2020-01-26 13:19:35 +00:00
parent::__construct();
global $user;
$this->title = $title;
$this->user = $pool_user ?? $user;
$this->public = $public;
$this->description = $description;
}
}
2020-10-24 21:16:18 +00:00
class PoolDeletionEvent extends Event
{
public int $pool_id;
2020-10-24 17:55:07 +00:00
public function __construct(int $pool_id)
{
parent::__construct();
$this->pool_id = $pool_id;
}
}
2020-04-25 20:36:28 +00:00
class Pool
{
public int $id;
public int $user_id;
public ?string $user_name;
public bool $public;
public string $title;
public string $description;
public string $date;
public int $posts;
2020-03-27 00:15:15 +00:00
/**
* @param array<string,mixed> $row
*/
2020-03-27 00:15:15 +00:00
public function __construct(array $row)
{
$this->id = (int) $row['id'];
$this->user_id = (int) $row['user_id'];
2020-03-27 00:15:15 +00:00
$this->user_name = $row['user_name'] ?? null;
$this->public = bool_escape($row['public']);
$this->title = $row['title'];
$this->description = $row['description'];
$this->date = $row['date'];
$this->posts = (int) $row['posts'];
2020-03-27 00:15:15 +00:00
}
/**
* @param array<string,mixed> $row
*/
2020-04-25 20:36:28 +00:00
public static function makePool(array $row): Pool
{
2020-03-27 00:15:15 +00:00
return new Pool($row);
}
2023-11-07 21:01:03 +00:00
public static function get_pool_id_by_title(string $poolTitle): ?int
2023-11-07 21:01:03 +00:00
{
global $database;
2023-11-06 05:50:33 +00:00
$row = $database->get_row("SELECT * FROM pools WHERE title=:title", ["title" => $poolTitle]);
if ($row != null) {
2023-11-07 21:01:03 +00:00
return $row['id'];
} else {
return null;
}
}
2020-03-27 00:15:15 +00:00
}
function _image_to_id(Image $image): int
{
return $image->id;
}
class Pools extends Extension
{
2020-01-26 13:19:35 +00:00
/** @var PoolsTheme */
2023-06-27 14:56:49 +00:00
protected Themelet $theme;
2020-01-26 13:19:35 +00:00
public function onInitExt(InitExtEvent $event): void
2019-11-03 18:28:38 +00:00
{
global $config;
2024-02-11 18:36:33 +00:00
Image::$prop_types["image_order"] = ImagePropType::INT;
// Set the defaults for the pools extension
$config->set_default_int(PoolsConfig::MAX_IMPORT_RESULTS, 1000);
$config->set_default_int(PoolsConfig::IMAGES_PER_PAGE, 20);
$config->set_default_int(PoolsConfig::LISTS_PER_PAGE, 20);
$config->set_default_int(PoolsConfig::UPDATED_PER_PAGE, 20);
$config->set_default_bool(PoolsConfig::INFO_ON_VIEW_IMAGE, false);
$config->set_default_bool(PoolsConfig::ADDER_ON_VIEW_IMAGE, false);
$config->set_default_bool(PoolsConfig::SHOW_NAV_LINKS, false);
$config->set_default_bool(PoolsConfig::AUTO_INCREMENT_ORDER, false);
}
public function onDatabaseUpgrade(DatabaseUpgradeEvent $event): void
2019-11-03 18:28:38 +00:00
{
2020-01-26 13:19:35 +00:00
global $database;
// Create the database tables
2019-11-03 19:49:52 +00:00
if ($this->get_version("ext_pools_version") < 1) {
$database->create_table("pools", "
2009-12-25 23:05:57 +00:00
id SCORE_AIPK,
user_id INTEGER NOT NULL,
public BOOLEAN NOT NULL DEFAULT FALSE,
2023-08-18 21:23:40 +00:00
title VARCHAR(255) NOT NULL UNIQUE,
2009-12-25 23:05:57 +00:00
description TEXT,
2019-11-03 19:25:51 +00:00
date TIMESTAMP NOT NULL DEFAULT CURRENT_TIMESTAMP,
2023-08-18 21:23:40 +00:00
lastupdated TIMESTAMP NOT NULL DEFAULT CURRENT_TIMESTAMP,
2009-12-25 23:05:57 +00:00
posts INTEGER NOT NULL DEFAULT 0,
2012-03-11 02:13:25 +00:00
FOREIGN KEY (user_id) REFERENCES users(id) ON UPDATE CASCADE ON DELETE CASCADE
2009-12-25 23:05:57 +00:00
");
$database->create_table("pool_images", "
2009-12-25 23:05:57 +00:00
pool_id INTEGER NOT NULL,
image_id INTEGER NOT NULL,
2012-03-11 02:13:25 +00:00
image_order INTEGER NOT NULL DEFAULT 0,
FOREIGN KEY (pool_id) REFERENCES pools(id) ON UPDATE CASCADE ON DELETE CASCADE,
2012-03-11 02:17:16 +00:00
FOREIGN KEY (image_id) REFERENCES images(id) ON UPDATE CASCADE ON DELETE CASCADE
2009-12-25 23:05:57 +00:00
");
$database->create_table("pool_history", "
2009-12-25 23:05:57 +00:00
id SCORE_AIPK,
pool_id INTEGER NOT NULL,
user_id INTEGER NOT NULL,
action INTEGER NOT NULL,
images TEXT,
count INTEGER NOT NULL DEFAULT 0,
2019-11-03 19:25:51 +00:00
date TIMESTAMP NOT NULL DEFAULT CURRENT_TIMESTAMP,
2012-03-11 02:13:25 +00:00
FOREIGN KEY (pool_id) REFERENCES pools(id) ON UPDATE CASCADE ON DELETE CASCADE,
FOREIGN KEY (user_id) REFERENCES users(id) ON UPDATE CASCADE ON DELETE CASCADE
2009-12-25 23:05:57 +00:00
");
2020-10-26 19:50:28 +00:00
$this->set_version("ext_pools_version", 4);
log_info("pools", "extension installed");
}
2020-10-26 19:12:20 +00:00
if ($this->get_version("ext_pools_version") < 4) {
$database->standardise_boolean("pools", "public");
$this->set_version("ext_pools_version", 4);
}
if ($this->get_version("ext_pools_version") < 5) {
// earlier versions of the table-creation code added the lastupdated
// column non-deterministically, so let's check if it is there and
// add it if needed.
$cols = $database->raw_db()->describe("pools");
if (!array_key_exists("lastupdated", $cols)) {
$database->execute("ALTER TABLE pools ADD COLUMN lastupdated TIMESTAMP NOT NULL DEFAULT CURRENT_TIMESTAMP");
}
$this->set_version("ext_pools_version", 5);
}
}
// Add a block to the Board Config / Setup
public function onSetupBuilding(SetupBuildingEvent $event): void
{
$sb = $event->panel->create_new_block("Pools");
$sb->add_int_option(PoolsConfig::MAX_IMPORT_RESULTS, "Max results on import: ");
2020-10-26 15:22:13 +00:00
$sb->add_int_option(PoolsConfig::IMAGES_PER_PAGE, "<br>Posts per page: ");
$sb->add_int_option(PoolsConfig::LISTS_PER_PAGE, "<br>Index list items per page: ");
$sb->add_int_option(PoolsConfig::UPDATED_PER_PAGE, "<br>Updated list items per page: ");
$sb->add_bool_option(PoolsConfig::INFO_ON_VIEW_IMAGE, "<br>Show pool info on image: ");
$sb->add_bool_option(PoolsConfig::SHOW_NAV_LINKS, "<br>Show 'Prev' & 'Next' links when viewing pool images: ");
$sb->add_bool_option(PoolsConfig::AUTO_INCREMENT_ORDER, "<br>Autoincrement order when post is added to pool:");
//$sb->add_bool_option(PoolsConfig::ADDER_ON_VIEW_IMAGE, "<br>Show pool adder on image: ");
}
public function onPageNavBuilding(PageNavBuildingEvent $event): void
{
$event->add_nav_link("pool", new Link('pool/list'), "Pools");
}
public function onPageSubNavBuilding(PageSubNavBuildingEvent $event): void
{
2023-11-11 21:49:12 +00:00
if ($event->parent == "pool") {
$event->add_nav_link("pool_list", new Link('pool/list'), "List");
$event->add_nav_link("pool_new", new Link('pool/new'), "Create");
$event->add_nav_link("pool_updated", new Link('pool/updated'), "Changes");
$event->add_nav_link("pool_help", new Link('ext_doc/pools'), "Help");
}
}
public function onPageRequest(PageRequestEvent $event): void
{
2020-03-27 00:15:15 +00:00
global $config, $database, $page, $user;
2024-02-11 11:34:09 +00:00
if (
$event->page_matches("pool/list", paged: true)
|| $event->page_matches("pool/list/{search}", paged: true)
) { //index
2024-02-09 16:36:57 +00:00
if ($event->get_GET('search')) {
2023-11-07 21:01:03 +00:00
$page->set_mode(PageMode::REDIRECT);
2024-02-11 11:34:09 +00:00
$page->set_redirect(make_link('pool/list') . '/' . url_escape($event->get_GET('search')) . '/' . strval($event->page_num));
2023-11-07 21:01:03 +00:00
return;
}
2024-02-11 11:34:09 +00:00
$search = $event->get_arg('search', "");
$page_num = $event->get_iarg('page_num', 1) - 1;
2023-11-07 21:01:03 +00:00
$this->list_pools($page, $page_num, $search);
}
2024-02-10 23:32:50 +00:00
if ($event->page_matches("pool/new", method: "GET", permission: Permissions::POOLS_CREATE)) {
$this->theme->new_pool_composer($page);
}
2024-02-10 23:32:50 +00:00
if ($event->page_matches("pool/create", method: "POST", permission: Permissions::POOLS_CREATE)) {
2024-02-11 15:47:40 +00:00
$pce = send_event(
new PoolCreationEvent(
$event->req_POST("title"),
$user,
bool_escape($event->req_POST("public")),
$event->req_POST("description")
)
);
$page->set_mode(PageMode::REDIRECT);
$page->set_redirect(make_link("pool/view/" . $pce->new_id));
}
2024-02-11 18:53:31 +00:00
if ($event->page_matches("pool/view/{pool_id}", method: "GET", paged: true)) {
$pool_id = $event->get_iarg('pool_id');
$this->get_posts($event->get_iarg('page_num', 1) - 1, $pool_id);
}
2024-02-11 11:34:09 +00:00
if ($event->page_matches("pool/updated", paged: true)) {
$this->get_history($event->get_iarg('page_num', 1) - 1);
}
2024-02-11 18:53:31 +00:00
if ($event->page_matches("pool/revert/{history_id}", method: "POST", permission: Permissions::POOLS_UPDATE)) {
$history_id = $event->get_iarg('history_id');
$this->revert_history($history_id);
2024-02-10 23:32:50 +00:00
$page->set_mode(PageMode::REDIRECT);
$page->set_redirect(make_link("pool/updated"));
}
2024-02-11 18:53:31 +00:00
if ($event->page_matches("pool/edit/{pool_id}")) {
$pool_id = $event->get_iarg('pool_id');
$pool = $this->get_single_pool($pool_id);
$this->assert_permission($user, $pool);
$result = $database->execute("SELECT image_id FROM pool_images WHERE pool_id=:pid ORDER BY image_order ASC", ["pid" => $pool_id]);
$images = [];
while ($row = $result->fetch()) {
$images[] = Image::by_id_ex((int) $row["image_id"]);
}
$this->theme->edit_pool($page, $pool, $images);
}
2024-02-11 18:53:31 +00:00
if ($event->page_matches("pool/order/{pool_id}")) {
$pool_id = $event->get_iarg('pool_id');
$pool = $this->get_single_pool($pool_id);
$this->assert_permission($user, $pool);
2024-01-20 20:48:47 +00:00
2024-02-11 18:53:31 +00:00
$result = $database->execute(
"SELECT image_id FROM pool_images WHERE pool_id=:pid ORDER BY image_order ASC",
["pid" => $pool_id]
);
$images = [];
while ($row = $result->fetch()) {
$image = $database->get_row(
"
SELECT * FROM images AS i
INNER JOIN pool_images AS p ON i.id = p.image_id
WHERE pool_id=:pid AND i.id=:iid",
["pid" => $pool_id, "iid" => (int) $row['image_id']]
);
if ($image) {
$images[] = new Image($image);
}
2024-02-11 18:53:31 +00:00
}
2024-02-11 18:53:31 +00:00
$this->theme->edit_order($page, $pool, $images);
}
if ($event->page_matches("pool/save_order/{pool_id}", method: "POST")) {
$pool_id = $event->get_iarg('pool_id');
$pool = $this->get_single_pool($pool_id);
$this->assert_permission($user, $pool);
foreach ($event->POST as $key => $value) {
if (str_starts_with($key, "order_")) {
$imageID = (int) substr($key, 6);
$database->execute(
"
2024-02-11 18:53:31 +00:00
UPDATE pool_images
SET image_order = :ord
WHERE pool_id = :pid AND image_id = :iid",
["ord" => $value, "pid" => $pool_id, "iid" => $imageID]
);
}
}
2024-02-11 18:53:31 +00:00
$page->set_mode(PageMode::REDIRECT);
$page->set_redirect(make_link("pool/view/" . $pool_id));
2024-02-11 19:01:42 +00:00
}
2024-02-11 18:53:31 +00:00
if ($event->page_matches("pool/reverse/{pool_id}", method: "POST")) {
$pool_id = $event->get_iarg('pool_id');
$pool = $this->get_single_pool($pool_id);
$this->assert_permission($user, $pool);
$database->with_savepoint(function () use ($pool_id) {
global $database;
$result = $database->execute(
"SELECT image_id FROM pool_images WHERE pool_id=:pid ORDER BY image_order DESC",
["pid" => $pool_id]
);
$image_order = 1;
while ($row = $result->fetch()) {
$database->execute(
"
UPDATE pool_images
SET image_order=:ord
WHERE pool_id = :pid AND image_id = :iid",
["ord" => $image_order, "pid" => $pool_id, "iid" => (int) $row['image_id']]
);
$image_order = $image_order + 1;
}
});
$page->set_mode(PageMode::REDIRECT);
$page->set_redirect(make_link("pool/view/" . $pool_id));
}
2024-02-11 18:53:31 +00:00
if ($event->page_matches("pool/import/{pool_id}")) {
$pool_id = $event->get_iarg('pool_id');
$pool = $this->get_single_pool($pool_id);
$this->assert_permission($user, $pool);
$images = Search::find_images(
limit: $config->get_int(PoolsConfig::MAX_IMPORT_RESULTS, 1000),
tags: Tag::explode($event->req_POST("pool_tag"))
);
$this->theme->pool_result($page, $images, $pool);
}
2024-02-11 18:53:31 +00:00
if ($event->page_matches("pool/add_posts/{pool_id}")) {
$pool_id = $event->get_iarg('pool_id');
$pool = $this->get_single_pool($pool_id);
$this->assert_permission($user, $pool);
$image_ids = array_map('intval', $event->req_POST_array('check'));
send_event(new PoolAddPostsEvent($pool_id, $image_ids));
$page->set_mode(PageMode::REDIRECT);
$page->set_redirect(make_link("pool/view/" . $pool_id));
}
2024-02-11 18:53:31 +00:00
if ($event->page_matches("pool/remove_posts/{pool_id}")) {
$pool_id = $event->get_iarg('pool_id');
$pool = $this->get_single_pool($pool_id);
$this->assert_permission($user, $pool);
2024-01-20 20:48:47 +00:00
$images = "";
foreach ($event->req_POST_array('check') as $imageID) {
$database->execute(
"DELETE FROM pool_images WHERE pool_id = :pid AND image_id = :iid",
["pid" => $pool_id, "iid" => $imageID]
);
$images .= " " . $imageID;
}
$count = (int) $database->get_one(
"SELECT COUNT(*) FROM pool_images WHERE pool_id=:pid",
["pid" => $pool_id]
);
$this->add_history($pool_id, 0, $images, $count);
$page->set_mode(PageMode::REDIRECT);
$page->set_redirect(make_link("pool/view/" . $pool_id));
}
2024-02-11 18:53:31 +00:00
if ($event->page_matches("pool/edit_description/{pool_id}")) {
$pool_id = $event->get_iarg('pool_id');
$pool = $this->get_single_pool($pool_id);
$this->assert_permission($user, $pool);
$database->execute(
"UPDATE pools SET description=:dsc,lastupdated=CURRENT_TIMESTAMP WHERE id=:pid",
["dsc" => $event->req_POST('description'), "pid" => $pool_id]
);
$page->set_mode(PageMode::REDIRECT);
$page->set_redirect(make_link("pool/view/" . $pool_id));
}
2024-02-11 18:53:31 +00:00
if ($event->page_matches("pool/nuke/{pool_id}")) {
// Completely remove the given pool.
// -> Only admins and owners may do this
2024-02-11 18:53:31 +00:00
$pool_id = $event->get_iarg('pool_id');
$pool = $this->get_single_pool($pool_id);
if ($user->can(Permissions::POOLS_ADMIN) || $user->id == $pool->user_id) {
send_event(new PoolDeletionEvent($pool_id));
$page->set_mode(PageMode::REDIRECT);
$page->set_redirect(make_link("pool/list"));
} else {
2024-02-11 15:47:40 +00:00
throw new PermissionDenied("You do not have permission to access this page");
}
}
}
public function onUserBlockBuilding(UserBlockBuildingEvent $event): void
{
$event->add_link("Pools", make_link("pool/list"));
}
/**
* When displaying an image, optionally list all the pools that the
* image is currently a member of on a side panel, as well as a link
* to the Next image in the pool.
*/
public function onDisplayingImage(DisplayingImageEvent $event): void
{
global $config;
if ($config->get_bool(PoolsConfig::INFO_ON_VIEW_IMAGE)) {
$imageID = $event->image->id;
$poolsIDs = $this->get_pool_ids($imageID);
$show_nav = $config->get_bool(PoolsConfig::SHOW_NAV_LINKS, false);
$navInfo = [];
foreach ($poolsIDs as $poolID) {
$pool = $this->get_single_pool($poolID);
2020-03-27 00:15:15 +00:00
$navInfo[$pool->id] = [
"info" => $pool,
"nav" => $show_nav ? $this->get_nav_posts($pool, $imageID) : null,
];
}
$this->theme->pool_info($navInfo);
}
}
public function onImageAdminBlockBuilding(ImageAdminBlockBuildingEvent $event): void
{
global $config, $database, $user;
2024-02-10 23:32:50 +00:00
if ($config->get_bool(PoolsConfig::ADDER_ON_VIEW_IMAGE) && $user->can(Permissions::POOLS_UPDATE)) {
2023-06-25 23:49:19 +00:00
$pools = [];
2019-09-29 18:00:51 +00:00
if ($user->can(Permissions::POOLS_ADMIN)) {
2023-06-25 23:49:19 +00:00
$pools = $database->get_pairs("SELECT id,title FROM pools ORDER BY title");
} else {
2023-06-25 23:53:44 +00:00
$pools = $database->get_pairs("SELECT id,title FROM pools WHERE user_id=:id ORDER BY title", ["id" => $user->id]);
}
2023-06-25 23:49:19 +00:00
if (count($pools) > 0) {
2024-02-10 18:35:55 +00:00
$html = SHM_SIMPLE_FORM(
"pool/add_post",
SHM_SELECT("pool_id", $pools),
INPUT(["type" => "hidden", "name" => "image_id", "value" => $event->image->id]),
SHM_SUBMIT("Add Post to Pool")
);
$event->add_part($html);
}
}
}
public function onHelpPageBuilding(HelpPageBuildingEvent $event): void
{
2023-11-11 21:49:12 +00:00
if ($event->key === HelpPages::SEARCH) {
2023-07-05 00:23:11 +00:00
$event->add_block(new Block("Pools", $this->theme->get_help_html()));
}
}
public function onSearchTermParse(SearchTermParseEvent $event): void
{
2020-01-26 16:38:26 +00:00
if (is_null($event->term)) {
return;
}
2020-01-26 13:19:35 +00:00
$matches = [];
if (preg_match("/^pool[=|:]([0-9]+|any|none)$/i", $event->term, $matches)) {
$poolID = $matches[1];
if (preg_match("/^(any|none)$/", $poolID)) {
$not = ($poolID == "none" ? "NOT" : "");
$event->add_querylet(new Querylet("images.id $not IN (SELECT DISTINCT image_id FROM pool_images)"));
} else {
$event->add_querylet(new Querylet("images.id IN (SELECT DISTINCT image_id FROM pool_images WHERE pool_id = $poolID)"));
}
} elseif (preg_match("/^pool_by_name[=|:](.*)$/i", $event->term, $matches)) {
$poolTitle = str_replace("_", " ", $matches[1]);
$pool = $this->get_single_pool_from_title($poolTitle);
$poolID = 0;
if ($pool) {
$poolID = $pool->id;
}
$event->add_querylet(new Querylet("images.id IN (SELECT DISTINCT image_id FROM pool_images WHERE pool_id = $poolID)"));
2022-10-07 20:19:50 +00:00
} elseif (preg_match("/^pool_id[=|:](.*)$/i", $event->term, $matches)) {
$poolID = str_replace("_", " ", $matches[1]);
$event->add_querylet(new Querylet("images.id IN (SELECT DISTINCT image_id FROM pool_images WHERE pool_id = $poolID)"));
}
2023-11-07 21:01:03 +00:00
}
public function onTagTermCheck(TagTermCheckEvent $event): void
2020-01-29 20:22:50 +00:00
{
if (preg_match("/^pool[=|:]([^:]*|lastcreated):?([0-9]*)$/i", $event->term)) {
$event->metatag = true;
}
}
public function onTagTermParse(TagTermParseEvent $event): void
{
$matches = [];
if (preg_match("/^pool[=|:]([^:]*|lastcreated):?([0-9]*)$/i", $event->term, $matches)) {
global $user;
$poolTag = (string) str_replace("_", " ", $matches[1]);
$pool = null;
if ($poolTag == 'lastcreated') {
$pool = $this->get_last_userpool($user->id);
} elseif (ctype_digit($poolTag)) { //If only digits, assume PoolID
$pool = $this->get_single_pool((int) $poolTag);
} else { //assume PoolTitle
$pool = $this->get_single_pool_from_title($poolTag);
}
2020-03-27 00:15:15 +00:00
if ($pool && $this->have_permission($user, $pool)) {
$image_order = (int) ($matches[2] ?: 0);
$this->add_post($pool->id, $event->image_id, true, $image_order);
}
}
}
public function onBulkActionBlockBuilding(BulkActionBlockBuildingEvent $event): void
{
global $database, $user;
2024-08-31 16:05:18 +00:00
if (!$user->can(Permissions::POOLS_UPDATE)) {
$options = $database->get_pairs("SELECT id,title FROM pools ORDER BY title");
// TODO: Don't cast into strings, make BABBE accept HTMLElement instead.
$event->add_action("bulk_pool_add_existing", "Add To (P)ool", "p", "", (string) $this->theme->get_bulk_pool_selector($options));
$event->add_action("bulk_pool_add_new", "Create Pool", "", "", (string) $this->theme->get_bulk_pool_input($event->search_terms));
}
}
public function onBulkAction(BulkActionEvent $event): void
{
global $user;
switch ($event->action) {
case "bulk_pool_add_existing":
$pool_id = intval($event->params['bulk_pool_select']);
2020-03-27 00:15:15 +00:00
$pool = $this->get_single_pool($pool_id);
if ($this->have_permission($user, $pool)) {
send_event(
2023-01-11 11:15:26 +00:00
new PoolAddPostsEvent($pool_id, iterator_map_to_array("Shimmie2\_image_to_id", $event->items))
2019-09-29 13:30:55 +00:00
);
}
break;
case "bulk_pool_add_new":
$new_pool_title = $event->params['bulk_pool_new'];
2023-02-04 20:50:26 +00:00
$pce = send_event(new PoolCreationEvent($new_pool_title));
2023-01-11 11:15:26 +00:00
send_event(new PoolAddPostsEvent($pce->new_id, iterator_map_to_array("Shimmie2\_image_to_id", $event->items)));
break;
}
}
/* ------------------------------------------------- */
/* -------------- Private Functions -------------- */
/* ------------------------------------------------- */
/**
* Check if the given user has permission to edit/change the pool.
*
* TODO: Should the user variable be global?
*/
2020-03-27 00:15:15 +00:00
private function have_permission(User $user, Pool $pool): bool
{
// If the pool is public and user is logged
// OR if the user is admin
// OR if the pool is owned by the user.
return (
2024-02-10 23:32:50 +00:00
($pool->public && $user->can(Permissions::POOLS_UPDATE)) ||
2020-03-27 00:15:15 +00:00
$user->can(Permissions::POOLS_ADMIN) ||
$user->id == $pool->user_id
);
}
private function assert_permission(User $user, Pool $pool): void
{
if (!$this->have_permission($user, $pool)) {
2024-02-11 15:47:40 +00:00
throw new PermissionDenied("You do not have permission to access this pool");
}
}
2024-02-11 11:34:09 +00:00
private function list_pools(Page $page, int $pageNumber, string $search): void
{
global $config, $database;
$poolsPerPage = $config->get_int(PoolsConfig::LISTS_PER_PAGE);
$order_by = "";
$order = $page->get_cookie("ui-order-pool");
if ($order == "created" || is_null($order)) {
$order_by = "ORDER BY p.date DESC";
} elseif ($order == "updated") {
$order_by = "ORDER BY p.lastupdated DESC";
} elseif ($order == "name") {
$order_by = "ORDER BY p.title ASC";
} elseif ($order == "count") {
$order_by = "ORDER BY p.posts DESC";
}
2023-11-07 21:01:03 +00:00
$where_clause = "WHERE LOWER(title) like '%%'";
if ($search != null) {
$where_clause = "WHERE LOWER(title) like '%" . strtolower($search) . "%'";
2023-11-07 21:01:03 +00:00
}
2020-03-27 00:15:15 +00:00
$pools = array_map([Pool::class, "makePool"], $database->get_all("
SELECT p.*, u.name as user_name
2015-09-26 18:53:15 +00:00
FROM pools AS p
INNER JOIN users AS u
ON p.user_id = u.id
2023-11-06 05:50:33 +00:00
$where_clause
2015-09-26 18:53:15 +00:00
$order_by
LIMIT :l OFFSET :o
2020-03-27 00:15:15 +00:00
", ["l" => $poolsPerPage, "o" => $pageNumber * $poolsPerPage]));
$totalPages = (int) ceil((int) $database->get_one("SELECT COUNT(*) FROM pools " . $where_clause) / $poolsPerPage);
2023-11-06 05:50:33 +00:00
$this->theme->list_pools($page, $pools, $search, $pageNumber + 1, $totalPages);
}
public function onPoolCreation(PoolCreationEvent $event): void
{
global $user, $database;
2024-02-10 23:32:50 +00:00
if (!$user->can(Permissions::POOLS_UPDATE)) {
2024-02-11 15:47:40 +00:00
throw new PermissionDenied("You must be registered and logged in to add a image.");
}
if (empty($event->title)) {
2024-02-11 15:47:40 +00:00
throw new InvalidInput("Pool title is empty.");
}
if ($this->get_single_pool_from_title($event->title)) {
2024-02-11 15:47:40 +00:00
throw new InvalidInput("A pool using this title already exists.");
}
$database->execute(
"
2009-12-26 00:31:02 +00:00
INSERT INTO pools (user_id, public, title, description, date)
VALUES (:uid, :public, :title, :desc, now())",
2020-03-27 00:15:15 +00:00
["uid" => $event->user->id, "public" => $event->public, "title" => $event->title, "desc" => $event->description]
);
$poolID = $database->get_last_insert_id('pools_id_seq');
log_info("pools", "Pool {$poolID} created by {$user->name}");
$event->new_id = $poolID;
}
/**
* Retrieve information about a pool given a pool ID.
*/
2020-03-27 00:15:15 +00:00
private function get_single_pool(int $poolID): Pool
{
global $database;
2020-03-27 00:15:15 +00:00
return new Pool($database->get_row("SELECT * FROM pools WHERE id=:id", ["id" => $poolID]));
}
/**
* Retrieve information about a pool given a pool title.
*/
2020-03-27 00:15:15 +00:00
private function get_single_pool_from_title(string $poolTitle): ?Pool
{
global $database;
2020-03-27 00:15:15 +00:00
$row = $database->get_row("SELECT * FROM pools WHERE title=:title", ["title" => $poolTitle]);
return $row ? new Pool($row) : null;
}
/**
* Get all of the pool IDs that an image is in, given an image ID.
2024-01-06 21:28:06 +00:00
* @return int[]
*/
private function get_pool_ids(int $imageID): array
{
global $database;
2020-03-26 16:50:16 +00:00
$col = $database->get_col("SELECT pool_id FROM pool_images WHERE image_id=:iid", ["iid" => $imageID]);
$col = array_map('intval', $col);
return $col;
}
/**
* Retrieve information about the last pool the given userID created
*/
2020-03-27 00:15:15 +00:00
private function get_last_userpool(int $userID): Pool
{
global $database;
2020-03-27 00:15:15 +00:00
return new Pool($database->get_row("SELECT * FROM pools WHERE user_id=:uid ORDER BY id DESC", ["uid" => $userID]));
}
/**
* HERE WE ADD CHECKED IMAGES FROM POOL AND UPDATE THE HISTORY
*/
public function onPoolAddPosts(PoolAddPostsEvent $event): void
{
global $database, $user;
$pool = $this->get_single_pool($event->pool_id);
$this->assert_permission($user, $pool);
2009-12-25 23:05:57 +00:00
2024-01-15 13:40:18 +00:00
$images = [];
foreach ($event->posts as $post_id) {
if ($this->add_post($event->pool_id, $post_id, false)) {
2024-01-15 13:40:18 +00:00
$images[] = $post_id;
}
}
2009-12-25 23:05:57 +00:00
2024-01-15 13:40:18 +00:00
if (count($images) > 0) {
$count = (int) $database->get_one(
2020-03-27 00:15:15 +00:00
"SELECT COUNT(*) FROM pool_images WHERE pool_id=:pid",
["pid" => $event->pool_id]
);
2024-01-15 13:40:18 +00:00
$this->add_history($event->pool_id, 1, implode(" ", $images), $count);
}
}
/**
* Gets the previous and next successive images from a pool, given a pool ID and an image ID.
*
* @return array{prev:?int,next:?int} Array returning two elements (prev, next) in 1 dimension. Each returns ImageID or NULL if none.
*/
private function get_nav_posts(Pool $pool, int $imageID): array
{
global $database;
2020-03-27 00:15:15 +00:00
return $database->get_row(
"
SELECT (
SELECT image_id
FROM pool_images
WHERE pool_id = :pid
AND image_order < (
SELECT image_order
FROM pool_images
WHERE pool_id = :pid
AND image_id = :iid
LIMIT 1
)
ORDER BY image_order DESC LIMIT 1
) AS prev,
(
SELECT image_id
FROM pool_images
WHERE pool_id = :pid
AND image_order > (
SELECT image_order
FROM pool_images
WHERE pool_id = :pid
AND image_id = :iid
LIMIT 1
)
ORDER BY image_order ASC LIMIT 1
) AS next
LIMIT 1
",
2020-03-27 00:15:15 +00:00
["pid" => $pool->id, "iid" => $imageID]
);
}
/**
* Retrieve all the images in a pool, given a pool ID.
*/
private function get_posts(int $pageNumber, int $poolID): void
{
global $config, $user, $database;
2020-03-27 00:15:15 +00:00
$pool = $this->get_single_pool($poolID);
$imagesPerPage = $config->get_int(PoolsConfig::IMAGES_PER_PAGE);
$query = "
2020-03-27 00:15:15 +00:00
INNER JOIN images AS i ON i.id = p.image_id
WHERE p.pool_id = :pid
";
2020-10-26 23:32:56 +00:00
$params = [];
// WE CHECK IF THE EXTENSION RATING IS INSTALLED, WHICH VERSION AND IF IT
// WORKS TO SHOW/HIDE SAFE, QUESTIONABLE, EXPLICIT AND UNRATED IMAGES FROM USER
if (Extension::is_enabled(RatingsInfo::KEY)) {
$query .= "AND i.rating IN (" . Ratings::privs_to_sql(Ratings::get_user_class_privs($user)) . ")";
}
2019-09-29 13:30:55 +00:00
if (Extension::is_enabled(TrashInfo::KEY)) {
2020-10-26 23:26:49 +00:00
$query .= " AND trash != :true";
2020-10-26 23:32:56 +00:00
$params["true"] = true;
}
$result = $database->get_all(
"
SELECT p.image_id FROM pool_images p
$query
2009-12-26 00:31:02 +00:00
ORDER BY p.image_order ASC
2011-08-24 08:01:43 +00:00
LIMIT :l OFFSET :o",
2020-10-26 23:26:49 +00:00
[
"pid" => $poolID,
"l" => $imagesPerPage,
"o" => $pageNumber * $imagesPerPage,
2020-10-26 23:32:56 +00:00
] + $params
);
2009-12-26 00:31:02 +00:00
$totalPages = (int) ceil((int) $database->get_one(
2020-03-26 18:52:31 +00:00
"SELECT COUNT(*) FROM pool_images p $query",
2020-10-26 23:32:56 +00:00
["pid" => $poolID] + $params
2019-11-02 19:57:34 +00:00
) / $imagesPerPage);
$images = [];
foreach ($result as $singleResult) {
$images[] = Image::by_id_ex((int) $singleResult["image_id"]);
}
$this->theme->view_pool($pool, $images, $pageNumber + 1, $totalPages);
}
/**
* HERE WE NUKE ENTIRE POOL. WE REMOVE POOLS AND POSTS FROM REMOVED POOL AND HISTORIES ENTRIES FROM REMOVED POOL.
*/
public function onPoolDeletion(PoolDeletionEvent $event): void
{
global $user, $database;
2020-10-24 17:55:07 +00:00
$poolID = $event->pool_id;
$owner_id = (int) $database->get_one("SELECT user_id FROM pools WHERE id = :pid", ["pid" => $poolID]);
2020-10-24 17:55:07 +00:00
if ($owner_id == $user->id || $user->can(Permissions::POOLS_ADMIN)) {
$database->execute("DELETE FROM pool_history WHERE pool_id = :pid", ["pid" => $poolID]);
$database->execute("DELETE FROM pool_images WHERE pool_id = :pid", ["pid" => $poolID]);
$database->execute("DELETE FROM pools WHERE id = :pid", ["pid" => $poolID]);
}
}
/**
* HERE WE ADD A HISTORY ENTRY.
*
* $action Action=1 (one) MEANS ADDED, Action=0 (zero) MEANS REMOVED
*/
private function add_history(int $poolID, int $action, string $images, int $count): void
{
global $user, $database;
$database->execute(
"
2009-12-26 00:31:02 +00:00
INSERT INTO pool_history (pool_id, user_id, action, images, count, date)
2011-08-24 08:01:43 +00:00
VALUES (:pid, :uid, :act, :img, :count, now())",
["pid" => $poolID, "uid" => $user->id, "act" => $action, "img" => $images, "count" => $count]
);
}
private function get_history(int $pageNumber): void
{
global $config, $database;
$historiesPerPage = $config->get_int(PoolsConfig::UPDATED_PER_PAGE);
$history = $database->get_all("
2010-05-04 19:10:37 +00:00
SELECT h.id, h.pool_id, h.user_id, h.action, h.images,
h.count, h.date, u.name as user_name, p.title as title
FROM pool_history AS h
INNER JOIN pools AS p
ON p.id = h.pool_id
INNER JOIN users AS u
ON h.user_id = u.id
ORDER BY h.date DESC
2011-08-24 08:01:43 +00:00
LIMIT :l OFFSET :o
", ["l" => $historiesPerPage, "o" => $pageNumber * $historiesPerPage]);
$totalPages = (int) ceil((int) $database->get_one("SELECT COUNT(*) FROM pool_history") / $historiesPerPage);
$this->theme->show_history($history, $pageNumber + 1, $totalPages);
}
/**
* HERE GO BACK IN HISTORY AND ADD OR REMOVE POSTS TO POOL.
*/
private function revert_history(int $historyID): void
{
global $database;
$status = $database->get_all("SELECT * FROM pool_history WHERE id=:hid", ["hid" => $historyID]);
foreach ($status as $entry) {
$images = trim($entry['images']);
$images = explode(" ", $images);
$poolID = (int) $entry['pool_id'];
$imageArray = "";
$newAction = -1;
if ($entry['action'] == 0) {
// READ ENTRIES
2022-10-28 00:45:35 +00:00
foreach ($images as $imageID) {
$this->add_post($poolID, int_escape($imageID));
$imageArray .= " " . $imageID;
$newAction = 1;
}
} elseif ($entry['action'] == 1) {
// DELETE ENTRIES
2020-03-27 00:15:15 +00:00
foreach ($images as $imageID) {
$database->execute(
"DELETE FROM pool_images WHERE pool_id = :pid AND image_id = :iid",
["pid" => $poolID, "iid" => $imageID]
);
$imageArray .= " " . $imageID;
$newAction = 0;
}
2020-03-27 00:15:15 +00:00
$this->update_count($poolID);
} else {
// FIXME: should this throw an exception instead?
log_error("pools", "Invalid history action.");
continue; // go on to the next one.
}
$count = (int) $database->get_one("SELECT COUNT(*) FROM pool_images WHERE pool_id=:pid", ["pid" => $poolID]);
$this->add_history($poolID, $newAction, $imageArray, $count);
}
}
/**
* HERE WE ADD A SIMPLE POST FROM POOL.
* USED WITH FOREACH IN revert_history() & onTagTermParse().
*/
private function add_post(int $poolID, int $imageID, bool $history = false, int $imageOrder = 0): bool
{
global $database, $config;
$result = (int) $database->get_one(
2020-03-27 00:15:15 +00:00
"SELECT COUNT(*) FROM pool_images WHERE pool_id=:pid AND image_id=:iid",
["pid" => $poolID, "iid" => $imageID]
);
if ($result == 0) {
if ($config->get_bool(PoolsConfig::AUTO_INCREMENT_ORDER) && $imageOrder === 0) {
$imageOrder = (int) $database->get_one(
"
SELECT COALESCE(MAX(image_order),0) + 1
FROM pool_images
WHERE pool_id = :pid AND image_order IS NOT NULL",
["pid" => $poolID]
);
}
$database->execute(
"
INSERT INTO pool_images (pool_id, image_id, image_order)
VALUES (:pid, :iid, :ord)",
["pid" => $poolID, "iid" => $imageID, "ord" => $imageOrder]
);
} else {
// If the post is already added, there is nothing else to do
return false;
}
$this->update_count($poolID);
if ($history) {
$count = (int) $database->get_one("SELECT COUNT(*) FROM pool_images WHERE pool_id=:pid", ["pid" => $poolID]);
$this->add_history($poolID, 1, (string) $imageID, $count);
}
return true;
}
private function update_count(int $pool_id): void
{
global $database;
2020-03-27 00:15:15 +00:00
$database->execute(
2023-08-18 21:23:40 +00:00
"UPDATE pools SET posts=(SELECT COUNT(*) FROM pool_images WHERE pool_id=:pid),lastupdated=CURRENT_TIMESTAMP WHERE id=:pid",
2020-03-27 00:15:15 +00:00
["pid" => $pool_id]
);
}
2009-12-24 07:36:09 +00:00
}