New "Approval" extension
This commit is contained in:
Matthew Barbour
Rogue Ralsha
parent
016fb6be65
commit
c2d6f1a5fa
3 changed files with 265 additions and 0 deletions
20
ext/approval/info.php
Normal file
20
ext/approval/info.php
Normal file
|
|
@ -0,0 +1,20 @@
|
||||||
|
<?php
|
||||||
|
|
||||||
|
/*
|
||||||
|
* Name: Trash
|
||||||
|
* Author: Matthew Barbour <matthew@darkohlme.net>
|
||||||
|
* Description: Provides "Trash" or "Recycle Bin"-type functionality, storing delete images for later recovery
|
||||||
|
* Documentation:
|
||||||
|
*/
|
||||||
|
|
||||||
|
class ApprovalInfo extends ExtensionInfo
|
||||||
|
{
|
||||||
|
public const KEY = "approval";
|
||||||
|
|
||||||
|
public $key = self::KEY;
|
||||||
|
public $name = "Approval";
|
||||||
|
public $authors = ["Matthew Barbour"=>"matthew@darkholme.net"];
|
||||||
|
public $license = self::LICENSE_WTFPL;
|
||||||
|
public $description = "Adds an approval step to the upload/import process.";
|
||||||
|
public $db_support = [DatabaseDriver::MYSQL, DatabaseDriver::PGSQL];
|
||||||
|
}
|
||||||
204
ext/approval/main.php
Normal file
204
ext/approval/main.php
Normal file
|
|
@ -0,0 +1,204 @@
|
||||||
|
<?php
|
||||||
|
|
||||||
|
abstract class ApprovalConfig
|
||||||
|
{
|
||||||
|
const VERSION = "ext_approval_version";
|
||||||
|
const IMAGES = "approve_images";
|
||||||
|
const COMMENTS = "approve_comments";
|
||||||
|
}
|
||||||
|
|
||||||
|
class Approval extends Extension
|
||||||
|
{
|
||||||
|
public function onInitExt(InitExtEvent $event)
|
||||||
|
{
|
||||||
|
global $config;
|
||||||
|
|
||||||
|
$config->set_default_bool(ApprovalConfig::IMAGES, false);
|
||||||
|
$config->set_default_bool(ApprovalConfig::COMMENTS, false);
|
||||||
|
|
||||||
|
if ($config->get_int(ApprovalConfig::VERSION) < 1) {
|
||||||
|
$this->install();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
public function onPageRequest(PageRequestEvent $event)
|
||||||
|
{
|
||||||
|
global $page, $user;
|
||||||
|
|
||||||
|
if ($event->page_matches("approve_image") && $user->can(Permissions::APPROVE_IMAGE)) {
|
||||||
|
// Try to get the image ID
|
||||||
|
$image_id = int_escape($event->get_arg(0));
|
||||||
|
if (empty($image_id)) {
|
||||||
|
$image_id = isset($_POST['image_id']) ? $_POST['image_id'] : null;
|
||||||
|
}
|
||||||
|
if (empty($image_id)) {
|
||||||
|
throw new SCoreException("Can not approve image: No valid Image ID given.");
|
||||||
|
}
|
||||||
|
|
||||||
|
self::approve_image($image_id);
|
||||||
|
$page->set_mode(PageMode::REDIRECT);
|
||||||
|
$page->set_redirect(make_link("post/view/".$image_id));
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
public function onAdminBuilding(AdminBuildingEvent $event)
|
||||||
|
{
|
||||||
|
$this->theme->display_admin_form();
|
||||||
|
}
|
||||||
|
|
||||||
|
public function onAdminAction(AdminActionEvent $event)
|
||||||
|
{
|
||||||
|
global $database, $user;
|
||||||
|
|
||||||
|
$action = $event->action;
|
||||||
|
$event->redirect = true;
|
||||||
|
if($action==="approval") {
|
||||||
|
$approval_action = $_POST["approval_action"];
|
||||||
|
switch ($approval_action) {
|
||||||
|
case "approve_all":
|
||||||
|
$database->set_timeout(300000); // These updates can take a little bit
|
||||||
|
$database->execute($database->scoreql_to_sql(
|
||||||
|
"UPDATE images SET approved = SCORE_BOOL_Y, approved_by_id = :approved_by_id WHERE approved = SCORE_BOOL_N"),
|
||||||
|
["approved_by_id"=>$user->id]
|
||||||
|
);
|
||||||
|
break;
|
||||||
|
case "de_approve_all":
|
||||||
|
$database->set_timeout(300000); // These updates can take a little bit
|
||||||
|
$database->execute($database->scoreql_to_sql(
|
||||||
|
"UPDATE images SET approved = SCORE_BOOL_N, approved_by_id = NULL WHERE approved = SCORE_BOOL_Y"));
|
||||||
|
break;
|
||||||
|
default:
|
||||||
|
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
public function onDisplayingImage(DisplayingImageEvent $event)
|
||||||
|
{
|
||||||
|
global $user, $page;
|
||||||
|
|
||||||
|
if ($event->image->approved===false && !$user->can(Permissions::APPROVE_IMAGE)) {
|
||||||
|
$page->set_mode(PageMode::REDIRECT);
|
||||||
|
$page->set_redirect(make_link("post/list"));
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
public function onPageSubNavBuilding(PageSubNavBuildingEvent $event)
|
||||||
|
{
|
||||||
|
global $user;
|
||||||
|
if($event->parent=="posts") {
|
||||||
|
if($user->can(Permissions::APPROVE_IMAGE)) {
|
||||||
|
$event->add_nav_link("posts_unapproved", new Link('/post/list/approved%3Ano/1'), "Pending Approval",null, 60);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
const SEARCH_REGEXP = "/^approved:(yes|no)/";
|
||||||
|
public function onSearchTermParse(SearchTermParseEvent $event)
|
||||||
|
{
|
||||||
|
global $user, $database;
|
||||||
|
|
||||||
|
$matches = [];
|
||||||
|
|
||||||
|
if (is_null($event->term) && $this->no_approval_query($event->context)) {
|
||||||
|
$event->add_querylet(new Querylet($database->scoreql_to_sql("approved = SCORE_BOOL_Y ")));
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
if (preg_match(self::SEARCH_REGEXP, strtolower($event->term), $matches)) {
|
||||||
|
if ($user->can(Permissions::APPROVE_IMAGE)&&$matches[1]=="no") {
|
||||||
|
$event->add_querylet(new Querylet($database->scoreql_to_sql("approved = SCORE_BOOL_N ")));
|
||||||
|
} else {
|
||||||
|
$event->add_querylet(new Querylet($database->scoreql_to_sql("approved = SCORE_BOOL_Y ")));
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
public function onHelpPageBuilding(HelpPageBuildingEvent $event)
|
||||||
|
{
|
||||||
|
global $user;
|
||||||
|
if ($event->key===HelpPages::SEARCH) {
|
||||||
|
if ($user->can(Permissions::APPROVE_IMAGE)) {
|
||||||
|
$block = new Block();
|
||||||
|
$block->header = "Approval";
|
||||||
|
$block->body = $this->theme->get_help_html();
|
||||||
|
$event->add_block($block);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
private function no_approval_query(array $context): bool
|
||||||
|
{
|
||||||
|
foreach ($context as $term) {
|
||||||
|
if (preg_match(self::SEARCH_REGEXP, $term)) {
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
|
||||||
|
public static function approve_image($image_id)
|
||||||
|
{
|
||||||
|
global $database, $user;
|
||||||
|
|
||||||
|
$database->execute($database->scoreql_to_sql(
|
||||||
|
"UPDATE images SET approved = SCORE_BOOL_Y, approved_by_id = :approved_by_id WHERE id = :id AND approved = SCORE_BOOL_N"),
|
||||||
|
["approved_by_id"=>$user->id, "id"=>$image_id]
|
||||||
|
);
|
||||||
|
}
|
||||||
|
public function onImageAdminBlockBuilding(ImageAdminBlockBuildingEvent $event)
|
||||||
|
{
|
||||||
|
global $user;
|
||||||
|
if ($event->image->approved===false && $user->can(Permissions::APPROVE_IMAGE)) {
|
||||||
|
$event->add_part($this->theme->get_image_admin_html($event->image->id));
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
public function onBulkActionBlockBuilding(BulkActionBlockBuildingEvent $event)
|
||||||
|
{
|
||||||
|
global $user;
|
||||||
|
|
||||||
|
if ($user->can(Permissions::APPROVE_IMAGE)&&in_array("approved:no", $event->search_terms)) {
|
||||||
|
$event->add_action("bulk_approve_image", "Approve", "a");
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
public function onBulkAction(BulkActionEvent $event)
|
||||||
|
{
|
||||||
|
global $user;
|
||||||
|
|
||||||
|
switch ($event->action) {
|
||||||
|
case "bulk_approve_image":
|
||||||
|
if ($user->can(Permissions::APPROVE_IMAGE)) {
|
||||||
|
$total = 0;
|
||||||
|
foreach ($event->items as $image) {
|
||||||
|
self::approve_image($image->id);
|
||||||
|
$total++;
|
||||||
|
}
|
||||||
|
flash_message("Approved $total items");
|
||||||
|
}
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
private function install()
|
||||||
|
{
|
||||||
|
global $database, $config;
|
||||||
|
|
||||||
|
if ($config->get_int(ApprovalConfig::VERSION) < 1) {
|
||||||
|
$database->Execute($database->scoreql_to_sql(
|
||||||
|
"ALTER TABLE images ADD COLUMN approved SCORE_BOOL NOT NULL DEFAULT SCORE_BOOL_N"
|
||||||
|
));
|
||||||
|
$database->Execute($database->scoreql_to_sql(
|
||||||
|
"ALTER TABLE images ADD COLUMN approved_by_id INTEGER NULL"
|
||||||
|
));
|
||||||
|
|
||||||
|
$database->Execute("CREATE INDEX images_approved_idx ON images(approved)");
|
||||||
|
$config->set_int(ApprovalConfig::VERSION, 1);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
41
ext/approval/theme.php
Normal file
41
ext/approval/theme.php
Normal file
|
|
@ -0,0 +1,41 @@
|
||||||
|
<?php
|
||||||
|
|
||||||
|
class ApprovalTheme extends Themelet
|
||||||
|
{
|
||||||
|
public function get_image_admin_html(int $image_id)
|
||||||
|
{
|
||||||
|
$html = "
|
||||||
|
".make_form(make_link('approve_image/'.$image_id), 'POST')."
|
||||||
|
<input type='hidden' name='image_id' value='$image_id'>
|
||||||
|
<input type='submit' value='Approve'>
|
||||||
|
</form>
|
||||||
|
";
|
||||||
|
|
||||||
|
return $html;
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
public function get_help_html()
|
||||||
|
{
|
||||||
|
return '<p>Search for images that are approved/not approved.</p>
|
||||||
|
<div class="command_example">
|
||||||
|
<pre>approved:yes</pre>
|
||||||
|
<p>Returns images that have been approved.</p>
|
||||||
|
</div>
|
||||||
|
<div class="command_example">
|
||||||
|
<pre>approved:no</pre>
|
||||||
|
<p>Returns images that have not been approved.</p>
|
||||||
|
</div>
|
||||||
|
';
|
||||||
|
}
|
||||||
|
|
||||||
|
public function display_admin_form()
|
||||||
|
{
|
||||||
|
global $page;
|
||||||
|
$html = make_form(make_link("admin/approval"), "POST");
|
||||||
|
$html .= "<button name='approval_action' value='approve_all'>Approve All Images</button><br/>";
|
||||||
|
$html .= "<button name='approval_action' value='de_approve_all'>De-approve All Images</button>";
|
||||||
|
$html .= "</form>\n";
|
||||||
|
$page->add_block(new Block("Approval", $html));
|
||||||
|
}
|
||||||
|
}
|
||||||
Reference in a new issue