584 lines
17 KiB
PHP
584 lines
17 KiB
PHP
<?php
|
|
/*
|
|
* Name: Image Ratings
|
|
* Author: Shish <webmaster@shishnet.org>
|
|
* Link: http://code.shishnet.org/shimmie2/
|
|
* License: GPLv2
|
|
* Description: Allow users to rate images "safe", "questionable" or "explicit"
|
|
* Documentation:
|
|
* This shimmie extension provides filter:
|
|
* <ul>
|
|
* <li>rating = (safe|questionable|explicit|unknown)
|
|
* <ul>
|
|
* <li>rating=s -- safe images
|
|
* <li>rating=q -- questionable images
|
|
* <li>rating=e -- explicit images
|
|
* <li>rating=u -- Unknown rating
|
|
* <li>rating=sq -- safe and questionable images
|
|
* </ul>
|
|
* </ul>
|
|
*/
|
|
|
|
/**
|
|
* @global Rating[] $_shm_ratings
|
|
*/
|
|
global $_shm_ratings;
|
|
$_shm_ratings = [];
|
|
|
|
class Rating {
|
|
/**
|
|
* @var string
|
|
*/
|
|
public $name = null;
|
|
|
|
/**
|
|
* @var string
|
|
*/
|
|
public $code = null;
|
|
|
|
/**
|
|
* @var string
|
|
*/
|
|
public $search_term = null;
|
|
|
|
/**
|
|
* @var int
|
|
*/
|
|
public $order = 0;
|
|
|
|
public function __construct( string $code, string $name, string $search_term, int $order)
|
|
{
|
|
if(strlen($code)!=1) {
|
|
throw new Exception("Rating code must be exactly one character");
|
|
}
|
|
|
|
$this->name = $name;
|
|
$this->code = $code;
|
|
$this->search_term = $search_term;
|
|
$this->order = $order;
|
|
|
|
}
|
|
}
|
|
|
|
function clear_ratings() {
|
|
global $_shm_ratings;
|
|
$keys = array_keys($_shm_ratings);
|
|
foreach ($keys as $key){
|
|
if($key=="?") {
|
|
continue;
|
|
}
|
|
unset($_shm_ratings[$key]);
|
|
}
|
|
}
|
|
|
|
function add_rating(Rating $rating) {
|
|
global $_shm_ratings;
|
|
|
|
if($rating->code=="?"&&array_key_exists("?",$_shm_ratings)) {
|
|
throw new Exception("? is a reserved rating code that cannot be overridden");
|
|
}
|
|
$_shm_ratings[$rating->code] = $rating;
|
|
}
|
|
|
|
add_rating(new Rating("?", "Unrated", "unrated", 99999));
|
|
|
|
add_rating(new Rating("s", "Safe", "safe", 0));
|
|
add_rating(new Rating("q", "Questionable", "questionable", 500));
|
|
add_rating(new Rating("e", "Explicit", "explicit", 1000));
|
|
@include_once "data/config/ratings.conf.php";
|
|
|
|
class RatingSetEvent extends Event
|
|
{
|
|
/** @var Image */
|
|
public $image;
|
|
/** @var string */
|
|
public $rating;
|
|
|
|
public function __construct(Image $image, string $rating)
|
|
{
|
|
global $_shm_ratings;
|
|
|
|
assert(in_array($rating, array_keys($_shm_ratings)));
|
|
|
|
$this->image = $image;
|
|
$this->rating = $rating;
|
|
}
|
|
}
|
|
|
|
abstract class RatingsConfig {
|
|
const VERSION = "ext_ratings2_version";
|
|
const USER_DEFAULTS = "ratings_default";
|
|
}
|
|
|
|
class Ratings extends Extension
|
|
{
|
|
protected $db_support = [DatabaseDriver::MYSQL, DatabaseDriver::PGSQL];
|
|
|
|
private $search_regexp;
|
|
|
|
|
|
public function __construct()
|
|
{
|
|
parent::__construct();
|
|
|
|
global $_shm_ratings;
|
|
|
|
$codes = implode("", array_keys($_shm_ratings));
|
|
$search_terms = [];
|
|
foreach ($_shm_ratings as $key => $rating) {
|
|
array_push($search_terms, $rating->search_term);
|
|
}
|
|
$this->search_regexp = "/^rating[=|:](?:(\*|[" . $codes . "]+)|(" .
|
|
implode("|", $search_terms) . "|unknown))$/D";
|
|
}
|
|
|
|
public function get_priority(): int
|
|
{
|
|
return 50;
|
|
}
|
|
|
|
public function onInitExt(InitExtEvent $event)
|
|
{
|
|
global $user, $config, $_shm_user_classes, $_shm_ratings;
|
|
|
|
if ($config->get_int(RatingsConfig::VERSION) < 4) {
|
|
$this->install();
|
|
}
|
|
|
|
foreach (array_keys($_shm_user_classes) as $key) {
|
|
if ($key == "base" || $key == "hellbanned") {
|
|
continue;
|
|
}
|
|
$config->set_default_array("ext_rating_" . $key . "_privs", array_keys($_shm_ratings));
|
|
}
|
|
}
|
|
|
|
public function onInitUserConfig(InitUserConfigEvent $event) {
|
|
$event->user_config->set_default_array(RatingsConfig::USER_DEFAULTS, self::get_user_class_privs($event->user));
|
|
}
|
|
|
|
public function onUserOptionsBuilding(UserOptionsBuildingEvent $event)
|
|
{
|
|
global $user, $user_config;
|
|
|
|
$event->add__html(
|
|
$this->theme->get_user_options($user,
|
|
self::get_user_default_ratings($user),
|
|
self::get_user_class_privs($user)));
|
|
}
|
|
|
|
public function onSetupBuilding(SetupBuildingEvent $event)
|
|
{
|
|
global $config, $_shm_user_classes, $_shm_ratings;
|
|
|
|
$ratings = self::get_sorted_ratings();
|
|
|
|
$options = [];
|
|
foreach ($ratings as $key => $rating) {
|
|
$options[$rating->name] = $rating->code;
|
|
}
|
|
|
|
$sb = new SetupBlock("Image Ratings");
|
|
$sb->start_table();
|
|
foreach (array_keys($_shm_user_classes) as $key) {
|
|
if ($key == "base" || $key == "hellbanned") {
|
|
continue;
|
|
}
|
|
$sb->add_multichoice_option("ext_rating_" . $key . "_privs", $options, $key, true);
|
|
}
|
|
$sb->end_table();
|
|
|
|
$event->panel->add_block($sb);
|
|
}
|
|
|
|
// public function onPostListBuilding(PostListBuildingEvent $event)
|
|
// {
|
|
// global $user;
|
|
// if ($user->is_admin() && !empty($event->search_terms)) {
|
|
// $this->theme->display_bulk_rater(Tag::implode($event->search_terms));
|
|
// }
|
|
// }
|
|
|
|
|
|
public function onDisplayingImage(DisplayingImageEvent $event)
|
|
{
|
|
global $user, $page;
|
|
/**
|
|
* Deny images upon insufficient permissions.
|
|
**/
|
|
$user_view_level = Ratings::get_user_class_privs($user);
|
|
if (!in_array($event->image->rating, $user_view_level)) {
|
|
$page->set_mode(PageMode::REDIRECT);
|
|
$page->set_redirect(make_link("post/list"));
|
|
}
|
|
}
|
|
|
|
public function onRatingSet(RatingSetEvent $event)
|
|
{
|
|
if (empty($event->image->rating)) {
|
|
$old_rating = "";
|
|
} else {
|
|
$old_rating = $event->image->rating;
|
|
}
|
|
$this->set_rating($event->image->id, $event->rating, $old_rating);
|
|
}
|
|
|
|
public function onImageInfoBoxBuilding(ImageInfoBoxBuildingEvent $event)
|
|
{
|
|
$event->add_part($this->theme->get_rater_html($event->image->id, $event->image->rating, $this->can_rate()), 80);
|
|
}
|
|
|
|
public function onImageInfoSet(ImageInfoSetEvent $event)
|
|
{
|
|
if ($this->can_rate() && isset($_POST["rating"])) {
|
|
$rating = $_POST["rating"];
|
|
if (Ratings::rating_is_valid($rating)) {
|
|
send_event(new RatingSetEvent($event->image, $rating));
|
|
}
|
|
}
|
|
}
|
|
|
|
public function onParseLinkTemplate(ParseLinkTemplateEvent $event)
|
|
{
|
|
$event->replace('$rating', $this->rating_to_human($event->image->rating));
|
|
}
|
|
|
|
public function onHelpPageBuilding(HelpPageBuildingEvent $event)
|
|
{
|
|
global $user;
|
|
|
|
if($event->key===HelpPages::SEARCH) {
|
|
$block = new Block();
|
|
$block->header = "Ratings";
|
|
|
|
$ratings = self::get_sorted_ratings();
|
|
|
|
$block->body = $this->theme->get_help_html($ratings);
|
|
$event->add_block($block);
|
|
}
|
|
}
|
|
|
|
public function onSearchTermParse(SearchTermParseEvent $event)
|
|
{
|
|
global $user, $_shm_ratings;
|
|
|
|
$matches = [];
|
|
if (is_null($event->term) && $this->no_rating_query($event->context)) {
|
|
$set = Ratings::privs_to_sql(Ratings::get_user_default_ratings($user));
|
|
$event->add_querylet(new Querylet("rating IN ($set)"));
|
|
}
|
|
|
|
|
|
if (preg_match($this->search_regexp, strtolower($event->term), $matches)) {
|
|
$ratings = $matches[1] ? $matches[1] : $matches[2][0];
|
|
|
|
if ($ratings == '*') {
|
|
$ratings = Ratings::get_user_class_privs($user);
|
|
} else {
|
|
$ratings = array_intersect(str_split($ratings), Ratings::get_user_class_privs($user));
|
|
}
|
|
|
|
$set = "'" . join("', '", $ratings) . "'";
|
|
$event->add_querylet(new Querylet("rating IN ($set)"));
|
|
}
|
|
}
|
|
|
|
public function onTagTermParse(TagTermParseEvent $event)
|
|
{
|
|
global $user;
|
|
$matches = [];
|
|
|
|
if (preg_match($this->search_regexp, strtolower($event->term), $matches) && $event->parse) {
|
|
$ratings = $matches[1] ? $matches[1] : $matches[2][0];
|
|
|
|
$ratings = array_intersect(str_split($ratings), Ratings::get_user_class_privs($user));
|
|
|
|
$rating = $ratings[0];
|
|
|
|
$image = Image::by_id($event->id);
|
|
|
|
$re = new RatingSetEvent($image, $rating);
|
|
|
|
send_event($re);
|
|
}
|
|
|
|
if (!empty($matches)) {
|
|
$event->metatag = true;
|
|
}
|
|
}
|
|
|
|
|
|
public function onAdminBuilding(AdminBuildingEvent $event)
|
|
{
|
|
global $database, $_shm_ratings;
|
|
|
|
$results = $database->get_col("SELECT DISTINCT rating FROM images ORDER BY rating");
|
|
$original_values = [];
|
|
foreach ($results as $result) {
|
|
if (array_key_exists($result, $_shm_ratings)) {
|
|
$original_values[$result] = $_shm_ratings[$result]->name;
|
|
} else {
|
|
$original_values[$result] = $result;
|
|
}
|
|
}
|
|
|
|
|
|
$this->theme->display_form($original_values, self::get_sorted_ratings());
|
|
}
|
|
|
|
public function onAdminAction(AdminActionEvent $event)
|
|
{
|
|
global $database, $user;
|
|
$action = $event->action;
|
|
switch ($action) {
|
|
case "update_ratings":
|
|
$event->redirect = true;
|
|
if(!array_key_exists("rating_old", $_POST) || empty($_POST["rating_old"])) {
|
|
return;
|
|
}
|
|
if(!array_key_exists("rating_new", $_POST) || empty($_POST["rating_new"])) {
|
|
return;
|
|
}
|
|
$old = $_POST["rating_old"];
|
|
$new = $_POST["rating_new"];
|
|
|
|
if($user->can("bulk_edit_image_rating")) {
|
|
$database->execute("UPDATE images SET rating = :new WHERE rating = :old", ["new"=>$new, "old"=>$old ]);
|
|
}
|
|
|
|
break;
|
|
}
|
|
}
|
|
|
|
|
|
public function onBulkActionBlockBuilding(BulkActionBlockBuildingEvent $event)
|
|
{
|
|
global $user;
|
|
|
|
if ($user->can(Permissions::BULK_EDIT_IMAGE_RATING)) {
|
|
$event->add_action("bulk_rate", "Set (R)ating", "r","", $this->theme->get_selection_rater_html(["?"]));
|
|
}
|
|
}
|
|
|
|
public function onBulkAction(BulkActionEvent $event)
|
|
{
|
|
global $user;
|
|
|
|
switch ($event->action) {
|
|
case "bulk_rate":
|
|
if (!isset($_POST['rating'])) {
|
|
return;
|
|
}
|
|
if ($user->can(Permissions::BULK_EDIT_IMAGE_RATING)) {
|
|
$rating = $_POST['rating'];
|
|
$total = 0;
|
|
foreach ($event->items as $image) {
|
|
send_event(new RatingSetEvent($image, $rating));
|
|
$total++;
|
|
}
|
|
flash_message("Rating set for $total items");
|
|
}
|
|
break;
|
|
}
|
|
}
|
|
|
|
public function onPageRequest(PageRequestEvent $event)
|
|
{
|
|
global $user, $page, $user_config;
|
|
|
|
if ($event->page_matches("admin/bulk_rate")) {
|
|
if (!$user->can(Permissions::BULK_EDIT_IMAGE_RATING)) {
|
|
throw new PermissionDeniedException();
|
|
} else {
|
|
$n = 0;
|
|
while (true) {
|
|
$images = Image::find_images($n, 100, Tag::explode($_POST["query"]));
|
|
if (count($images) == 0) {
|
|
break;
|
|
}
|
|
|
|
reset($images); // rewind to first element in array.
|
|
|
|
foreach ($images as $image) {
|
|
send_event(new RatingSetEvent($image, $_POST['rating']));
|
|
}
|
|
$n += 100;
|
|
}
|
|
#$database->execute("
|
|
# update images set rating=? where images.id in (
|
|
# select image_id from image_tags join tags
|
|
# on image_tags.tag_id = tags.id where tags.tag = ?);
|
|
# ", array($_POST["rating"], $_POST["tag"]));
|
|
$page->set_mode(PageMode::REDIRECT);
|
|
$page->set_redirect(make_link("post/list"));
|
|
}
|
|
}
|
|
|
|
if ($event->page_matches("user_admin")) {
|
|
if (!$user->check_auth_token()) {
|
|
return;
|
|
}
|
|
switch ($event->get_arg(0)) {
|
|
case "default_ratings":
|
|
if (!array_key_exists("id", $_POST) || empty($_POST["id"])) {
|
|
return;
|
|
}
|
|
if (!array_key_exists("rating", $_POST) || empty($_POST["rating"])) {
|
|
return;
|
|
}
|
|
$id = intval($_POST["id"]);
|
|
if ($id != $user->id) {
|
|
throw new SCoreException("Cannot change another user's settings");
|
|
}
|
|
$ratings = $_POST["rating"];
|
|
|
|
$user_config->set_array(RatingsConfig::USER_DEFAULTS, $ratings);
|
|
|
|
$page->set_mode(PageMode::REDIRECT);
|
|
$page->set_redirect(make_link("user"));
|
|
|
|
break;
|
|
}
|
|
}
|
|
|
|
}
|
|
|
|
public static function get_sorted_ratings(): array
|
|
{
|
|
global $_shm_ratings;
|
|
|
|
$ratings = array_values($_shm_ratings);
|
|
usort($ratings, function ($a, $b) {
|
|
return $a->order <=> $b->order;
|
|
});
|
|
return $ratings;
|
|
}
|
|
|
|
|
|
public static function get_user_class_privs(User $user): array
|
|
{
|
|
global $config;
|
|
|
|
return $config->get_array("ext_rating_".$user->class->name."_privs");
|
|
}
|
|
|
|
public static function get_user_default_ratings(User $user): array
|
|
{
|
|
global $user_config;
|
|
|
|
$available = self::get_user_class_privs($user);
|
|
$selected = $user_config->get_array(RatingsConfig::USER_DEFAULTS);
|
|
|
|
return array_intersect($available, $selected);
|
|
}
|
|
|
|
public static function privs_to_sql(array $privs): string
|
|
{
|
|
$arr = [];
|
|
foreach($privs as $i) {
|
|
$arr[] = "'" . $i . "'";
|
|
}
|
|
if(sizeof($arr)==0) {
|
|
return "' '";
|
|
}
|
|
$set = join(', ', $arr);
|
|
return $set;
|
|
}
|
|
|
|
public static function rating_to_human(string $rating): string
|
|
{
|
|
global $_shm_ratings;
|
|
|
|
if(array_key_exists($rating, $_shm_ratings)) {
|
|
return $_shm_ratings[$rating]->name;
|
|
}
|
|
return "Unknown";
|
|
}
|
|
|
|
public static function rating_is_valid(string $rating): bool
|
|
{
|
|
global $_shm_ratings;
|
|
|
|
return in_array($rating, array_keys($_shm_ratings));
|
|
}
|
|
|
|
/**
|
|
* FIXME: this is a bit ugly and guessey, should have proper options
|
|
*/
|
|
private function can_rate(): bool
|
|
{
|
|
global $config, $user;
|
|
if ($user->can("edit_image_rating")) {
|
|
return true;
|
|
}
|
|
return false;
|
|
}
|
|
|
|
/**
|
|
* #param string[] $context
|
|
*/
|
|
private function no_rating_query(array $context): bool
|
|
{
|
|
foreach ($context as $term) {
|
|
if (preg_match("/^rating[=|:]/", $term)) {
|
|
return false;
|
|
}
|
|
}
|
|
return true;
|
|
}
|
|
|
|
private function install()
|
|
{
|
|
global $database, $config;
|
|
|
|
if ($config->get_int(RatingsConfig::VERSION) < 1) {
|
|
$database->Execute("ALTER TABLE images ADD COLUMN rating CHAR(1) NOT NULL DEFAULT 'u'");
|
|
$database->Execute("CREATE INDEX images__rating ON images(rating)");
|
|
$config->set_int(RatingsConfig::VERSION, 3);
|
|
}
|
|
|
|
if ($config->get_int(RatingsConfig::VERSION) < 2) {
|
|
$database->Execute("CREATE INDEX images__rating ON images(rating)");
|
|
$config->set_int(RatingsConfig::VERSION, 2);
|
|
}
|
|
|
|
if($config->get_int(RatingsConfig::VERSION) < 3) {
|
|
$database->Execute("UPDATE images SET rating = 'u' WHERE rating is null");
|
|
switch ($database->get_driver_name()) {
|
|
case DatabaseDriver::MYSQL:
|
|
$database->Execute("ALTER TABLE images CHANGE rating rating CHAR(1) NOT NULL DEFAULT 'u'");
|
|
break;
|
|
case DatabaseDriver::PGSQL:
|
|
$database->Execute("ALTER TABLE images ALTER COLUMN rating SET DEFAULT 'u'");
|
|
$database->Execute("ALTER TABLE images ALTER COLUMN rating SET NOT NULL");
|
|
break;
|
|
}
|
|
$config->set_int(RatingsConfig::VERSION, 3);
|
|
}
|
|
|
|
if ($config->get_int(RatingsConfig::VERSION) < 4) {
|
|
$value = $config->get_string("ext_rating_anon_privs");
|
|
$config->set_array("ext_rating_anonymous_privs", str_split($value));
|
|
$value = $config->get_string("ext_rating_user_privs");
|
|
$config->set_array("ext_rating_user_privs", str_split($value));
|
|
$value = $config->get_string("ext_rating_admin_privs");
|
|
$config->set_array("ext_rating_admin_privs", str_split($value));
|
|
|
|
$config->set_int(RatingsConfig::VERSION, 4);
|
|
}
|
|
|
|
if ($config->get_int(RatingsConfig::VERSION) < 5) {
|
|
|
|
$config->set_int(RatingsConfig::VERSION, 5);
|
|
}
|
|
}
|
|
|
|
private function set_rating(int $image_id, string $rating, string $old_rating)
|
|
{
|
|
global $database;
|
|
if ($old_rating != $rating) {
|
|
$database->Execute("UPDATE images SET rating=? WHERE id=?", [$rating, $image_id]);
|
|
log_info("rating", "Rating for Image #{$image_id} set to: ".$this->rating_to_human($rating));
|
|
}
|
|
}
|
|
}
|